RaspberrPi project source code
view | history | commit | commitdiff
Guo Wenxue
2024-04-11 1dab8d0c424af912c01eea9337e82250c5ef648f
commit | author | age
8df7c2 1 /*********************************************************************************
d973d6 2  *      Copyright:  (C) 2023 LingYun IoT System Studio
G 3  *                  All rights reserved.
4  *
5  *       Filename:  at24c.c
6  *    Description:  This file is AT24Cxx EEPROM code
7  *
8  *        Version:  1.0.0(10/08/23)
8df7c2 9  *         Author:  Guo Wenxue <guowenxue@gmail.com>
d973d6 10  *      ChangeLog:  1, Release initial version on "10/08/23 17:52:00"
8df7c2 11  *
d973d6 12  * Pin connection:
G 13  *                 W25QXX       Raspberry Pi 40Pin
14  *                   VCC   <--->   Pin#1 (3.3V)
15  *                   CS    <--->   Pin#24(CS)
16  *                   DO    <--->   Pin#21(MISO)
17  *                   GND   <--->   Pin#9 (GND)
18  *                   CLK   <--->   Pin#23(SCLK)
19  *                   DI    <--->   Pin#19(MOSI)
8df7c2 20  *
d973d6 21  * /boot/config.txt:
G 22  *                  dtparam=spi=on
8df7c2 23  *
G 24  ********************************************************************************/
25
26 #ifndef _W25QFLASH_H
27 #define _W25QFLASH_H
28
29 #include <stdbool.h>
30
31 #define _W25QXX_DEBUG                   1
32
33 /* Flash opcodes. Refer to <<W25Q256JV.pdf>> P26 Table 8.1.2 Instruction Set Table */
34 #define SPINOR_OP_RDID          0x9f    /* Read JEDEC ID */
35 #define SPINOR_OP_RDUID         0x4b    /* Read unique ID */
36 #define SPINOR_OP_WRSR1         0x01    /* Write status register-1 */
37 #define SPINOR_OP_WRSR2         0x31    /* Write status register-2 */
38 #define SPINOR_OP_WRSR3         0x11    /* Write status register-3 */
39 #define SPINOR_OP_BP            0x02    /* Byte program */
40 #define SPINOR_OP_READ          0x03    /* Read data bytes (low frequency) */
41 #define SPINOR_OP_WRDI          0x04    /* Write disable */
42 #define SPINOR_OP_RDSR1         0x05    /* Read status register-1 */
43 #define SPINOR_OP_RDSR2         0x35    /* Read status register-2 */
44 #define SPINOR_OP_RDSR3         0x15    /* Read status register-3 */
45 #define SPINOR_OP_WREN          0x06    /* Write enable */
46 #define SPINOR_OP_READ_FAST     0x0b    /* Read data bytes (high frequency) */
47 #define SPINOR_OP_READ_FAST_4B  0x0c    /* Read data bytes (high frequency) */
48
49 #define SPINOR_OP_CHIP_ERASE    0xc7    /* Erase whole flash chip */
50 #define SPINOR_OP_BE_4K_4B      0xdc    /* Block erase (64KiB) with 4-Byte Address */
51 #define SPINOR_OP_BE_4K         0xd8    /* Block erase (64KiB) */
52 #define SPINOR_OP_SE_4B         0x21    /* Sector erase (4KiB) with 4-Byte Address */
53 #define SPINOR_OP_SE            0x20    /* Sector erase (4KiB)  */
54 #define SPINOR_OP_PP_4B         0x12    /* Page Program (up to 256 bytes) with 4-Byte Address */
55 #define SPINOR_OP_PP            0x02    /* Page program (up to 256 bytes) */
56 #define SPINOR_OP_SRSTEN        0x66    /* Software Reset Enable */
57 #define SPINOR_OP_SRST          0x99    /* Software Reset */
58
59 typedef struct spi_info
60 {
61     int  hspi;      /* SPI device description */
62
63     void (*select)(struct spi_info *spi);   /* CS enable function  */
64     void (*deselect)(struct spi_info *spi); /* CS disable function */
65     void (*xcmd)(struct spi_info *spi, uint8_t command); /* Send a byte command */
66     void (*xfer)(struct spi_info *spi, uint8_t *send_buf, uint8_t *recv_buf, int bytes); /* Transmit and Receive N byte */
67 } spi_info_t;
68
69 typedef struct flash_info
70 {
71     char            *name;          /* Chip name */
72     uint32_t         jedec_id;      /* JEDEC ID, 3 bytes */
73     uint64_t         capacity;      /* Chip   size in bytes */
74     uint32_t         block_size;    /* Block  size in bytes */
75     uint32_t         sector_size;   /* Sector size in bytes */
76     uint32_t         page_size;     /* Page   size in bytes */
77     uint32_t         n_blocks;      /* Number of blocks */
78     uint32_t         n_sectors;     /* Number of sectors */
79     uint32_t         n_pages;       /* Number of pages */
80 } flash_info_t;
81
82
83 typedef struct spinor_info
84 {
85     spi_info_t      *spi;
86     flash_info_t    *flash;
87     uint8_t          lock;
88 } spinor_info_t;
89
90
91 /* Status registers */
92 enum
93 {
94     REG_STATUS1,
95     REG_STATUS2,
96     REG_STATUS3,
97     REG_STATUS_MAX,
98 };
99
100 /*+-------------------------------+
101  *|   SPI Norflash HighLevel API  |
102  *+-------------------------------+*/
103
104 /* SPI Norflash API test function */
105 extern void spinor_test(void);
106
107 /* Initial SPI and detect the flash chip */
108 extern int spinor_init(struct spinor_info *spinor);
109
110 /* Description:  Erase whole flash chip.
111  * Reference  :  P60, 8.2.32 Chip Erase (C7h / 60h)
112  */
113 extern int spinor_erase_chip(struct spinor_info *spinor);
114
115 /* Description:  Erase blocks by 64KiB,
116  * Reference  :  P59, 8.2.31 64KB Block Erase with 4-Byte Address (DCh)
117  *  @address is the erase start physical address, which can be not block alignment such as 0x10001.
118  *  @size is the erase size, which can be larger than a block such as 4097, and it will erase 2 blocks;
119  */
120 extern int spinor_erase_block(struct spinor_info *spinor, uint32_t address, uint32_t size);
121
122 /* Description:  Erase sectors by 4KiB
123  * Reference  :  P56, 8.2.28 Sector Erase with 4-Byte Address (21h)
124  *  @address is the erase start physical address, which can be not sector alignment such as 0x1001.
125  *  @size is the erase size, which can be larger than a sector such as 4097, and it will erase 2 sectors;
126  */
127 extern int spinor_erase_sector(struct spinor_info *spinor, uint32_t address, uint32_t size);
128
129 /* Description:  Page random write by 256B
130  *  @addr is the write start physical address, which can be not page alignment such as 0x101.
131  *  @size is the write size, which can be larger than a page such as 257, and it will write 2 pages;
132  */
133 extern int spinor_write(struct spinor_info *spinor, uint32_t address, uint8_t *data, uint32_t bytes);
134
135 /* Description:  The Fast Read instruction can read the entire memory chip.
136  * Reference  :  P41, 8.2.13 Fast Read with 4-Byte Address (0Ch)
137  *  @address is the read start physical address, which can be not page alignment such as 0x101.
138  *  @size is the read size, which can be larger than a page such as 257, and it will read 2 pages;
139  */
140 extern int spinor_read(struct spinor_info *spinor, uint32_t address, uint8_t *buf, uint32_t bytes);
141
142 /*+-------------------------------+
143  *|   SPI Norflash LowLevel API   |
144  *+-------------------------------+*/
145
146 /* Detect the norflash by JEDEC ID */
147 int spinor_detect_by_jedec(struct spinor_info *spinor);
148
149 /* Description:  Read the chipset UNIQUE ID.
150  * Reference  :  P68, 8.2.40 Read Unique ID Number (4Bh)
151  */
152 int spinor_read_uniqid(struct spi_info *spi, uint8_t *uniq_id);
153
154 /* Description:  Read the chipset JEDEC ID.
155  * Reference  :  P69, 8.2.41 Read JEDEC ID (9Fh)
156  */
157 uint32_t spinor_read_jedecid(struct spi_info *spi);
158
159 /* Description:  Write Enable
160  * Reference  :  P31, 8.2.1 Write Enable (06h)
161  */
162 void spinor_write_enable(struct spi_info *spi);
163
164 /* Description:  Write Disable
165  * Reference  :  P32, 8.2.3 Write Disable (04h)
166  */
167 void spinor_write_disable(struct spi_info *spi);
168
169 /* Description:  Read Status Register
170  * Reference  :  P32, 8.2.4 Read Status Register-1 (05h), Status Register-2 (35h) & Status Register-3 (15h)
171  */
172 uint8_t spinor_read_status_reg(struct spi_info *spi, uint8_t reg);
173
174 /* Description:  Write Status Register
175  * Reference  :  P33, 8.2.5 Write Status Register-1 (01h), Status Register-2 (31h) & Status Register-3 (11h)
176  */
177 void spinor_write_status_reg(struct spi_info *spi, uint8_t reg, uint8_t value);
178
179 /* Description:  Wait flash program/erase finished by read Status Register for BUSY bit
180  * Reference  :  P15, 7.1 Status Registers
181  */
182 void spinor_WaitForWriteEnd(struct spi_info *spi);
183
184 #endif