1 /* 2 * Copyright (c) 2018 Fuzhou Rockchip Electronics Co., Ltd 3 * 4 * SPDX-License-Identifier: GPL-2.0 5 */ 6 7 #ifndef _SFC_NOR_H 8 #define _SFC_NOR_H 9 10 #include "sfc.h" 11 12 #define NOR_PAGE_SIZE 256 13 #define NOR_BLOCK_SIZE (64 * 1024) 14 #define NOR_SECS_BLK (NOR_BLOCK_SIZE / 512) 15 #define NOR_SECS_PAGE 8 16 17 #define FEA_READ_STATUE_MASK (0x3 << 0) 18 #define FEA_STATUE_MODE1 0 19 #define FEA_STATUE_MODE2 1 20 #define FEA_4BIT_READ BIT(2) 21 #define FEA_4BIT_PROG BIT(3) 22 #define FEA_4BYTE_ADDR BIT(4) 23 #define FEA_4BYTE_ADDR_MODE BIT(5) 24 25 /*Command Set*/ 26 #define CMD_READ_JEDECID (0x9F) 27 #define CMD_READ_DATA (0x03) 28 #define CMD_READ_STATUS (0x05) 29 #define CMD_WRITE_STATUS (0x01) 30 #define CMD_PAGE_PROG (0x02) 31 #define CMD_SECTOR_ERASE (0x20) 32 #define CMD_BLK64K_ERASE (0xD8) 33 #define CMD_BLK32K_ERASE (0x52) 34 #define CMD_CHIP_ERASE (0xC7) 35 #define CMD_WRITE_EN (0x06) 36 #define CMD_WRITE_DIS (0x04) 37 #define CMD_PAGE_READ (0x13) 38 #define CMD_GET_FEATURE (0x0F) 39 #define CMD_SET_FEATURE (0x1F) 40 #define CMD_PROG_LOAD (0x02) 41 #define CMD_PROG_EXEC (0x10) 42 #define CMD_BLOCK_ERASE (0xD8) 43 #define CMD_READ_DATA_X2 (0x3B) 44 #define CMD_READ_DATA_X4 (0x6B) 45 #define CMD_PROG_LOAD_X4 (0x32) 46 #define CMD_READ_STATUS2 (0x35) 47 #define CMD_READ_STATUS3 (0x15) 48 #define CMD_WRITE_STATUS2 (0x31) 49 #define CMD_WRITE_STATUS3 (0x11) 50 /* X1 cmd, X1 addr, X1 data */ 51 #define CMD_FAST_READ_X1 (0x0B) 52 /* X1 cmd, X1 addr, X2 data */ 53 #define CMD_FAST_READ_X2 (0x3B) 54 /* X1 cmd, X1 addr, X4 data SUPPORT GD MARCONIX WINBOND */ 55 #define CMD_FAST_READ_X4 (0x6B) 56 /* X1 cmd, X1 addr, X4 data SUPPORT GD MARCONIX WINBOND */ 57 #define CMD_FAST_4READ_X4 (0x6C) 58 /* X1 cmd, X4 addr, X4 data SUPPORT EON GD MARCONIX WINBOND */ 59 #define CMD_FAST_READ_A4 (0xEB) 60 /* X1 cmd, X1 addr, X4 data, SUPPORT GD WINBOND */ 61 #define CMD_PAGE_PROG_X4 (0x32) 62 /* X1 cmd, X4 addr, X4 data, SUPPORT MARCONIX */ 63 #define CMD_PAGE_PROG_A4 (0x38) 64 /* X1 cmd, X4 addr, X4 data, SUPPORT MARCONIX */ 65 #define CMD_PAGE_PROG_4PP (0x3E) 66 #define CMD_RESET_NAND (0xFF) 67 #define CMD_ENTER_4BYTE_MODE (0xB7) 68 #define CMD_EXIT_4BYTE_MODE (0xE9) 69 #define CMD_ENABLE_RESER (0x66) 70 #define CMD_RESET_DEVICE (0x99) 71 #define CMD_READ_PARAMETER (0x5A) 72 73 enum NOR_ERASE_TYPE { 74 ERASE_SECTOR = 0, 75 ERASE_BLOCK64K, 76 ERASE_CHIP 77 }; 78 79 enum SNOR_IO_MODE { 80 IO_MODE_SPI = 0, 81 IO_MODE_QPI 82 }; 83 84 enum SNOR_READ_MODE { 85 READ_MODE_NOMAL = 0, 86 READ_MODE_FAST 87 }; 88 89 enum SNOR_ADDR_MODE { 90 ADDR_MODE_3BYTE = 0, 91 ADDR_MODE_4BYTE 92 }; 93 94 typedef int (*SNOR_WRITE_STATUS)(u32 reg_index, u8 status); 95 96 struct SFNOR_DEV { 97 u32 capacity; 98 u8 manufacturer; 99 u8 mem_type; 100 u16 page_size; 101 u32 blk_size; 102 103 u8 read_cmd; 104 u8 prog_cmd; 105 u8 sec_erase_cmd; 106 u8 blk_erase_cmd; 107 u8 QE_bits; 108 109 enum SNOR_READ_MODE read_mode; 110 enum SNOR_ADDR_MODE addr_mode; 111 enum SNOR_IO_MODE io_mode; 112 113 enum SFC_DATA_LINES read_lines; 114 enum SFC_DATA_LINES prog_lines; 115 enum SFC_DATA_LINES prog_addr_lines; 116 117 SNOR_WRITE_STATUS write_status; 118 u32 max_iosize; 119 }; 120 121 struct flash_info { 122 u32 id; 123 124 u8 block_size; 125 u8 sector_size; 126 u8 read_cmd; 127 u8 prog_cmd; 128 129 u8 read_cmd_4; 130 u8 prog_cmd_4; 131 u8 sector_erase_cmd; 132 u8 block_erase_cmd; 133 134 u8 feature; 135 u8 density; /* (1 << density) sectors*/ 136 u8 QE_bits; 137 u8 reserved2; 138 }; 139 140 /* flash table packet for easy boot */ 141 #define SNOR_INFO_PACKET_ID 0x464E494E 142 #define SNOR_INFO_PACKET_HEAD_LEN 14 143 144 #define SNOR_INFO_PACKET_SPI_MODE_RATE_SHIFT 25 145 146 struct snor_info_packet { 147 u32 id; 148 u32 head_hash; /*hash for head, check by bootrom.*/ 149 u16 head_len; /*320 - 16 bytes*/ 150 u16 version; 151 u8 read_cmd; 152 u8 prog_cmd; 153 u8 read_cmd_4; 154 u8 prog_cmd_4; 155 156 u8 sector_erase_cmd; 157 u8 block_erase_cmd; 158 u8 feature; 159 u8 QE_bits; 160 161 u32 spi_mode; 162 }; 163 164 int snor_init(struct SFNOR_DEV *p_dev); 165 u32 snor_get_capacity(struct SFNOR_DEV *p_dev); 166 int snor_read(struct SFNOR_DEV *p_dev, u32 sec, u32 n_sec, void *p_data); 167 int snor_write(struct SFNOR_DEV *p_dev, u32 sec, u32 n_sec, void *p_data); 168 int snor_erase(struct SFNOR_DEV *p_dev, 169 u32 addr, 170 enum NOR_ERASE_TYPE erase_type); 171 int snor_read_id(u8 *data); 172 int snor_prog_page(struct SFNOR_DEV *p_dev, u32 addr, void *p_data, u32 size); 173 int snor_read_data(struct SFNOR_DEV *p_dev, u32 addr, void *p_data, u32 size); 174 int snor_reset_device(void); 175 int snor_disable_QE(struct SFNOR_DEV *p_dev); 176 int snor_reinit_from_table_packet(struct SFNOR_DEV *p_dev, 177 struct snor_info_packet *packet); 178 #endif 179