1 /* SPDX-License-Identifier: GPL-2.0-only */
2
3 #include <assert.h>
4 #include <console/console.h>
5 #include <device/mmio.h>
6 #include <soc/flash_controller_common.h>
7 #include <soc/symbols.h>
8 #include <spi_flash.h>
9 #include <spi-generic.h>
10 #include <string.h>
11 #include <symbols.h>
12 #include <timer.h>
13 #include <types.h>
14
15 static struct mtk_nor_regs *const mtk_nor = (void *)SFLASH_REG_BASE;
16
17 #define GET_NTH_BYTE(d, n) ((d >> (8 * n)) & 0xff)
18
polling_cmd(u32 val)19 static int polling_cmd(u32 val)
20 {
21 struct stopwatch sw;
22
23 stopwatch_init_usecs_expire(&sw, SFLASH_POLLINGREG_US);
24
25 while ((read32(&mtk_nor->cmd) & val) != 0) {
26 if (stopwatch_expired(&sw))
27 return -1;
28 }
29
30 return 0;
31 }
32
mtk_nor_execute_cmd(u8 cmdval)33 static int mtk_nor_execute_cmd(u8 cmdval)
34 {
35 u8 val = cmdval & ~SFLASH_AUTOINC;
36
37 write8(&mtk_nor->cmd, cmdval);
38 return polling_cmd(val);
39 }
40
sflashhw_read_flash_status(u8 * value)41 static int sflashhw_read_flash_status(u8 *value)
42 {
43 if (mtk_nor_execute_cmd(SFLASH_READSTATUS))
44 return -1;
45
46 *value = read8(&mtk_nor->rdsr);
47 return 0;
48 }
49
wait_for_write_done(void)50 static int wait_for_write_done(void)
51 {
52 struct stopwatch sw;
53 u8 reg;
54
55 stopwatch_init_usecs_expire(&sw, SFLASH_POLLINGREG_US);
56
57 while (sflashhw_read_flash_status(®) == 0) {
58 if (!(reg & SFLASH_WRITE_IN_PROGRESS))
59 return 0;
60 if (stopwatch_expired(&sw))
61 return -1;
62 }
63
64 return -1;
65 }
66
67 /* set serial flash program address */
set_sfpaddr(u32 addr)68 static void set_sfpaddr(u32 addr)
69 {
70 write8(&mtk_nor->radr[2], GET_NTH_BYTE(addr, 2));
71 write8(&mtk_nor->radr[1], GET_NTH_BYTE(addr, 1));
72 write8(&mtk_nor->radr[0], GET_NTH_BYTE(addr, 0));
73 }
74
sector_erase(int offset)75 static int sector_erase(int offset)
76 {
77 if (wait_for_write_done())
78 return -1;
79
80 write8(&mtk_nor->prgdata[5], SFLASH_OP_WREN);
81 write8(&mtk_nor->cnt, 8);
82 mtk_nor_execute_cmd(SFLASH_PRG_CMD);
83
84 write8(&mtk_nor->prgdata[5], SECTOR_ERASE_CMD);
85 write8(&mtk_nor->prgdata[4], GET_NTH_BYTE(offset, 2));
86 write8(&mtk_nor->prgdata[3], GET_NTH_BYTE(offset, 1));
87 write8(&mtk_nor->prgdata[2], GET_NTH_BYTE(offset, 0));
88 write8(&mtk_nor->cnt, 32);
89 mtk_nor_execute_cmd(SFLASH_PRG_CMD);
90
91 if (wait_for_write_done())
92 return -1;
93
94 return 0;
95 }
96
dma_read(u32 addr,uintptr_t dma_buf,u32 len)97 static int dma_read(u32 addr, uintptr_t dma_buf, u32 len)
98 {
99 struct stopwatch sw;
100
101 assert(IS_ALIGNED((uintptr_t)addr, SFLASH_DMA_ALIGN) &&
102 IS_ALIGNED(len, SFLASH_DMA_ALIGN));
103
104 /* do dma reset */
105 write32(&mtk_nor->fdma_ctl, SFLASH_DMA_SW_RESET);
106 write32(&mtk_nor->fdma_ctl, SFLASH_DMA_WDLE_EN);
107 /* flash source address and dram dest address */
108 write32(&mtk_nor->fdma_fadr, addr);
109 write32(&mtk_nor->fdma_dadr, dma_buf);
110 write32(&mtk_nor->fdma_end_dadr, (dma_buf + len));
111 /* start dma */
112 write32(&mtk_nor->fdma_ctl, SFLASH_DMA_TRIGGER | SFLASH_DMA_WDLE_EN);
113
114 stopwatch_init_usecs_expire(&sw, SFLASH_POLLINGREG_US);
115 while ((read32(&mtk_nor->fdma_ctl) & SFLASH_DMA_TRIGGER) != 0) {
116 if (stopwatch_expired(&sw)) {
117 printk(BIOS_WARNING, "dma read timeout!\n");
118 return -1;
119 }
120 }
121
122 return 0;
123 }
124
nor_read(const struct spi_flash * flash,u32 addr,size_t len,void * buf)125 static int nor_read(const struct spi_flash *flash, u32 addr, size_t len,
126 void *buf)
127 {
128 uintptr_t dma_buf = (uintptr_t)_dma_coherent;
129 size_t dma_buf_len = REGION_SIZE(dma_coherent);
130 u32 start = ALIGN_DOWN(addr, SFLASH_DMA_ALIGN);
131 u32 skip = addr - start;
132 u32 total = ALIGN_UP(skip + len, SFLASH_DMA_ALIGN);
133 u32 drop = total - skip - len;
134 u32 done, read_len, copy_len;
135 uint8_t *dest = (uint8_t *)buf;
136
137 /* Refer to CB:13989 for the hardware limitation on mt8173. */
138 if (CONFIG(SOC_MEDIATEK_MT8173)) {
139 if (!ENV_BOOTBLOCK && !ENV_SEPARATE_VERSTAGE) {
140 dma_buf = (uintptr_t)_dram_dma;
141 dma_buf_len = REGION_SIZE(dram_dma);
142 }
143 }
144
145 if (CONFIG(FLASH_DUAL_IO_READ)) {
146 setbits8(&mtk_nor->read_dual, SFLASH_READ_DUAL_EN);
147 write8(&mtk_nor->prgdata[3], SFLASH_1_1_2_READ);
148 }
149
150 /* DMA: start [ skip | len | drop ] = total end */
151 for (done = 0; done < total; dest += copy_len) {
152 read_len = MIN(dma_buf_len, total - done);
153 if (dma_read(start + done, dma_buf, read_len))
154 return -1;
155
156 done += read_len;
157 /* decide the range to copy into buffer */
158 if (done == total)
159 read_len -= drop; /* Only drop in last iteration */
160
161 copy_len = read_len - skip;
162 memcpy(dest, (uint8_t *)dma_buf + skip, copy_len);
163 if (skip)
164 skip = 0; /* Only apply skip in first iteration. */
165 }
166 return 0;
167 }
168
nor_write(const struct spi_flash * flash,u32 addr,size_t len,const void * buf)169 static int nor_write(const struct spi_flash *flash, u32 addr, size_t len,
170 const void *buf)
171 {
172 const u8 *buffer = (const u8 *)buf;
173
174 set_sfpaddr(addr);
175 while (len) {
176 write8(&mtk_nor->wdata, *buffer);
177 if (mtk_nor_execute_cmd(SFLASH_WR_TRIGGER | SFLASH_AUTOINC))
178 return -1;
179
180 if (wait_for_write_done())
181 return -1;
182 buffer++;
183 len--;
184 }
185 return 0;
186 }
187
nor_erase(const struct spi_flash * flash,u32 offset,size_t len)188 static int nor_erase(const struct spi_flash *flash, u32 offset, size_t len)
189 {
190 int sector_start = offset;
191 int sector_num = (u32)len / flash->sector_size;
192
193 while (sector_num) {
194 if (!sector_erase(sector_start)) {
195 sector_start += flash->sector_size;
196 sector_num--;
197 } else {
198 printk(BIOS_WARNING, "Erase failed at %#x!\n",
199 sector_start);
200 return -1;
201 }
202 }
203 return 0;
204 }
205
206 const struct spi_flash_ops spi_flash_ops = {
207 .read = nor_read,
208 .write = nor_write,
209 .erase = nor_erase,
210 };
211
mtk_spi_flash_probe(const struct spi_slave * spi,struct spi_flash * flash)212 int mtk_spi_flash_probe(const struct spi_slave *spi,
213 struct spi_flash *flash)
214 {
215 write32(&mtk_nor->wrprot, SFLASH_COMMAND_ENABLE);
216 memcpy(&flash->spi, spi, sizeof(*spi));
217
218 flash->sector_size = 0x1000;
219 flash->erase_cmd = SECTOR_ERASE_CMD;
220 flash->size = CONFIG_ROM_SIZE;
221
222 flash->ops = &spi_flash_ops;
223
224 return 0;
225 }
226