1 /* 2 * Copyright (c) 2018 Savoir-Faire Linux. 3 * 4 * SPDX-License-Identifier: Apache-2.0 5 */ 6 7 #ifndef __SPI_NOR_H__ 8 #define __SPI_NOR_H__ 9 10 #include <zephyr/sys/util.h> 11 12 #define SPI_NOR_MAX_ID_LEN 3 13 14 /* Status register bits */ 15 #define SPI_NOR_WIP_BIT BIT(0) /* Write in progress */ 16 #define SPI_NOR_WEL_BIT BIT(1) /* Write enable latch */ 17 18 /* Flash opcodes */ 19 #define SPI_NOR_CMD_WRSR 0x01 /* Write status register */ 20 #define SPI_NOR_CMD_RDSR 0x05 /* Read status register */ 21 #define SPI_NOR_CMD_WRSR2 0x31 /* Write status register 2 */ 22 #define SPI_NOR_CMD_RDSR2 0x35 /* Read status register 2 */ 23 #define SPI_NOR_CMD_RDSR3 0x15 /* Read status register 3 */ 24 #define SPI_NOR_CMD_WRSR3 0x11 /* Write status register 3 */ 25 #define SPI_NOR_CMD_READ 0x03 /* Read data */ 26 #define SPI_NOR_CMD_READ_FAST 0x0B /* Read data */ 27 #define SPI_NOR_CMD_DREAD 0x3B /* Read data (1-1-2) */ 28 #define SPI_NOR_CMD_2READ 0xBB /* Read data (1-2-2) */ 29 #define SPI_NOR_CMD_QREAD 0x6B /* Read data (1-1-4) */ 30 #define SPI_NOR_CMD_4READ 0xEB /* Read data (1-4-4) */ 31 #define SPI_NOR_CMD_WREN 0x06 /* Write enable */ 32 #define SPI_NOR_CMD_WRDI 0x04 /* Write disable */ 33 #define SPI_NOR_CMD_PP 0x02 /* Page program */ 34 #define SPI_NOR_CMD_PP_1_1_2 0xA2 /* Dual Page program (1-1-2) */ 35 #define SPI_NOR_CMD_PP_1_1_4 0x32 /* Quad Page program (1-1-4) */ 36 #define SPI_NOR_CMD_PP_1_4_4 0x38 /* Quad Page program (1-4-4) */ 37 #define SPI_NOR_CMD_RDCR 0x15 /* Read control register */ 38 #define SPI_NOR_CMD_SE 0x20 /* Sector erase */ 39 #define SPI_NOR_CMD_SE_4B 0x21 /* Sector erase 4 byte address*/ 40 #define SPI_NOR_CMD_BE_32K 0x52 /* Block erase 32KB */ 41 #define SPI_NOR_CMD_BE 0xD8 /* Block erase */ 42 #define SPI_NOR_CMD_CE 0xC7 /* Chip erase */ 43 #define SPI_NOR_CMD_RDID 0x9F /* Read JEDEC ID */ 44 #define SPI_NOR_CMD_ULBPR 0x98 /* Global Block Protection Unlock */ 45 #define SPI_NOR_CMD_4BA 0xB7 /* Enter 4-Byte Address Mode */ 46 #define SPI_NOR_CMD_DPD 0xB9 /* Deep Power Down */ 47 #define SPI_NOR_CMD_RDPD 0xAB /* Release from Deep Power Down */ 48 #define SPI_NOR_CMD_WR_CFGREG2 0x72 /* Write config register 2 */ 49 #define SPI_NOR_CMD_RD_CFGREG2 0x71 /* Read config register 2 */ 50 #define SPI_NOR_CMD_RESET_EN 0x66 /* Reset Enable */ 51 #define SPI_NOR_CMD_RESET_MEM 0x99 /* Reset Memory */ 52 #define SPI_NOR_CMD_BULKE 0x60 /* Bulk Erase */ 53 #define SPI_NOR_CMD_READ_4B 0x13 /* Read data 4 Byte Address */ 54 #define SPI_NOR_CMD_READ_FAST_4B 0x0C /* Fast Read 4 Byte Address */ 55 #define SPI_NOR_CMD_DREAD_4B 0x3C /* Read data (1-1-2) 4 Byte Address */ 56 #define SPI_NOR_CMD_2READ_4B 0xBC /* Read data (1-2-2) 4 Byte Address */ 57 #define SPI_NOR_CMD_QREAD_4B 0x6C /* Read data (1-1-4) 4 Byte Address */ 58 #define SPI_NOR_CMD_4READ_4B 0xEC /* Read data (1-4-4) 4 Byte Address */ 59 #define SPI_NOR_CMD_PP_4B 0x12 /* Page Program 4 Byte Address */ 60 #define SPI_NOR_CMD_PP_1_1_4_4B 0x34 /* Quad Page program (1-1-4) 4 Byte Address */ 61 #define SPI_NOR_CMD_PP_1_4_4_4B 0x3e /* Quad Page program (1-4-4) 4 Byte Address */ 62 63 /* Flash octal opcodes */ 64 #define SPI_NOR_OCMD_SE 0x21DE /* Octal Sector erase */ 65 #define SPI_NOR_OCMD_CE 0xC738 /* Octal Chip erase */ 66 #define SPI_NOR_OCMD_RDSR 0x05FA /* Octal Read status register */ 67 #define SPI_NOR_OCMD_DTR_RD 0xEE11 /* Octal IO DTR read command */ 68 #define SPI_NOR_OCMD_RD 0xEC13 /* Octal IO read command */ 69 #define SPI_NOR_OCMD_PAGE_PRG 0x12ED /* Octal Page Prog */ 70 #define SPI_NOR_OCMD_WREN 0x06F9 /* Octal Write enable */ 71 #define SPI_NOR_OCMD_NOP 0x00FF /* Octal No operation */ 72 #define SPI_NOR_OCMD_RESET_EN 0x6699 /* Octal Reset Enable */ 73 #define SPI_NOR_OCMD_RESET_MEM 0x9966 /* Octal Reset Memory */ 74 #define SPI_NOR_OCMD_WR_CFGREG2 0x728D /* Octal Write configuration Register2 */ 75 #define SPI_NOR_OCMD_RD_CFGREG2 0x718E /* Octal Read configuration Register2 */ 76 #define SPI_NOR_OCMD_BULKE 0x609F /* Octa Bulk Erase */ 77 78 /* Page, sector, and block size are standard, not configurable. */ 79 #define SPI_NOR_PAGE_SIZE 0x0100U 80 #define SPI_NOR_SECTOR_SIZE 0x1000U 81 #define SPI_NOR_BLOCK_SIZE 0x10000U 82 83 /* Flash Auto-polling values */ 84 #define SPI_NOR_WREN_MATCH 0x02 85 #define SPI_NOR_WREN_MASK 0x02 86 87 #define SPI_NOR_WEL_MATCH 0x00 88 #define SPI_NOR_WEL_MASK 0x02 89 90 #define SPI_NOR_MEM_RDY_MATCH 0x00 91 #define SPI_NOR_MEM_RDY_MASK 0x01 92 93 #define SPI_NOR_AUTO_POLLING_INTERVAL 0x10 94 95 /* Flash Dummy Cycles values */ 96 #define SPI_NOR_DUMMY_RD 8U 97 #define SPI_NOR_DUMMY_RD_OCTAL 6U 98 #define SPI_NOR_DUMMY_RD_OCTAL_DTR 6U 99 #define SPI_NOR_DUMMY_REG_OCTAL 4U 100 #define SPI_NOR_DUMMY_REG_OCTAL_DTR 5U 101 102 103 /* Memory registers address */ 104 #define SPI_NOR_REG2_ADDR1 0x0000000 105 #define SPI_NOR_CR2_STR_OPI_EN 0x01 106 #define SPI_NOR_CR2_DTR_OPI_EN 0x02 107 #define SPI_NOR_REG2_ADDR3 0x00000300 108 #define SPI_NOR_CR2_DUMMY_CYCLES_66MHZ 0x07 109 110 /* Test whether offset is aligned to a given number of bits. */ 111 #define SPI_NOR_IS_ALIGNED(_ofs, _bits) (((_ofs) & BIT_MASK(_bits)) == 0) 112 #define SPI_NOR_IS_SECTOR_ALIGNED(_ofs) SPI_NOR_IS_ALIGNED(_ofs, 12) 113 114 #endif /*__SPI_NOR_H__*/ 115
