Loading...
1// SPDX-License-Identifier: GPL-2.0
2// Copyright (c) 2019 Nuvoton Technology corporation.
3
4#include <linux/bits.h>
5#include <linux/init.h>
6#include <linux/kernel.h>
7#include <linux/device.h>
8#include <linux/module.h>
9#include <linux/ioport.h>
10#include <linux/clk.h>
11#include <linux/platform_device.h>
12#include <linux/io.h>
13#include <linux/vmalloc.h>
14#include <linux/regmap.h>
15#include <linux/of.h>
16#include <linux/spi/spi-mem.h>
17#include <linux/mfd/syscon.h>
18
19/* NPCM7xx GCR module */
20#define NPCM7XX_INTCR3_OFFSET 0x9C
21#define NPCM7XX_INTCR3_FIU_FIX BIT(6)
22
23/* Flash Interface Unit (FIU) Registers */
24#define NPCM_FIU_DRD_CFG 0x00
25#define NPCM_FIU_DWR_CFG 0x04
26#define NPCM_FIU_UMA_CFG 0x08
27#define NPCM_FIU_UMA_CTS 0x0C
28#define NPCM_FIU_UMA_CMD 0x10
29#define NPCM_FIU_UMA_ADDR 0x14
30#define NPCM_FIU_PRT_CFG 0x18
31#define NPCM_FIU_UMA_DW0 0x20
32#define NPCM_FIU_UMA_DW1 0x24
33#define NPCM_FIU_UMA_DW2 0x28
34#define NPCM_FIU_UMA_DW3 0x2C
35#define NPCM_FIU_UMA_DR0 0x30
36#define NPCM_FIU_UMA_DR1 0x34
37#define NPCM_FIU_UMA_DR2 0x38
38#define NPCM_FIU_UMA_DR3 0x3C
39#define NPCM_FIU_CFG 0x78
40#define NPCM_FIU_MAX_REG_LIMIT 0x80
41
42/* FIU Direct Read Configuration Register */
43#define NPCM_FIU_DRD_CFG_LCK BIT(31)
44#define NPCM_FIU_DRD_CFG_R_BURST GENMASK(25, 24)
45#define NPCM_FIU_DRD_CFG_ADDSIZ GENMASK(17, 16)
46#define NPCM_FIU_DRD_CFG_DBW GENMASK(13, 12)
47#define NPCM_FIU_DRD_CFG_ACCTYPE GENMASK(9, 8)
48#define NPCM_FIU_DRD_CFG_RDCMD GENMASK(7, 0)
49#define NPCM_FIU_DRD_ADDSIZ_SHIFT 16
50#define NPCM_FIU_DRD_DBW_SHIFT 12
51#define NPCM_FIU_DRD_ACCTYPE_SHIFT 8
52
53/* FIU Direct Write Configuration Register */
54#define NPCM_FIU_DWR_CFG_LCK BIT(31)
55#define NPCM_FIU_DWR_CFG_W_BURST GENMASK(25, 24)
56#define NPCM_FIU_DWR_CFG_ADDSIZ GENMASK(17, 16)
57#define NPCM_FIU_DWR_CFG_ABPCK GENMASK(11, 10)
58#define NPCM_FIU_DWR_CFG_DBPCK GENMASK(9, 8)
59#define NPCM_FIU_DWR_CFG_WRCMD GENMASK(7, 0)
60#define NPCM_FIU_DWR_ADDSIZ_SHIFT 16
61#define NPCM_FIU_DWR_ABPCK_SHIFT 10
62#define NPCM_FIU_DWR_DBPCK_SHIFT 8
63
64/* FIU UMA Configuration Register */
65#define NPCM_FIU_UMA_CFG_LCK BIT(31)
66#define NPCM_FIU_UMA_CFG_CMMLCK BIT(30)
67#define NPCM_FIU_UMA_CFG_RDATSIZ GENMASK(28, 24)
68#define NPCM_FIU_UMA_CFG_DBSIZ GENMASK(23, 21)
69#define NPCM_FIU_UMA_CFG_WDATSIZ GENMASK(20, 16)
70#define NPCM_FIU_UMA_CFG_ADDSIZ GENMASK(13, 11)
71#define NPCM_FIU_UMA_CFG_CMDSIZ BIT(10)
72#define NPCM_FIU_UMA_CFG_RDBPCK GENMASK(9, 8)
73#define NPCM_FIU_UMA_CFG_DBPCK GENMASK(7, 6)
74#define NPCM_FIU_UMA_CFG_WDBPCK GENMASK(5, 4)
75#define NPCM_FIU_UMA_CFG_ADBPCK GENMASK(3, 2)
76#define NPCM_FIU_UMA_CFG_CMBPCK GENMASK(1, 0)
77#define NPCM_FIU_UMA_CFG_ADBPCK_SHIFT 2
78#define NPCM_FIU_UMA_CFG_WDBPCK_SHIFT 4
79#define NPCM_FIU_UMA_CFG_DBPCK_SHIFT 6
80#define NPCM_FIU_UMA_CFG_RDBPCK_SHIFT 8
81#define NPCM_FIU_UMA_CFG_ADDSIZ_SHIFT 11
82#define NPCM_FIU_UMA_CFG_WDATSIZ_SHIFT 16
83#define NPCM_FIU_UMA_CFG_DBSIZ_SHIFT 21
84#define NPCM_FIU_UMA_CFG_RDATSIZ_SHIFT 24
85
86/* FIU UMA Control and Status Register */
87#define NPCM_FIU_UMA_CTS_RDYIE BIT(25)
88#define NPCM_FIU_UMA_CTS_RDYST BIT(24)
89#define NPCM_FIU_UMA_CTS_SW_CS BIT(16)
90#define NPCM_FIU_UMA_CTS_DEV_NUM GENMASK(9, 8)
91#define NPCM_FIU_UMA_CTS_EXEC_DONE BIT(0)
92#define NPCM_FIU_UMA_CTS_DEV_NUM_SHIFT 8
93
94/* FIU UMA Command Register */
95#define NPCM_FIU_UMA_CMD_DUM3 GENMASK(31, 24)
96#define NPCM_FIU_UMA_CMD_DUM2 GENMASK(23, 16)
97#define NPCM_FIU_UMA_CMD_DUM1 GENMASK(15, 8)
98#define NPCM_FIU_UMA_CMD_CMD GENMASK(7, 0)
99
100/* FIU UMA Address Register */
101#define NPCM_FIU_UMA_ADDR_UMA_ADDR GENMASK(31, 0)
102#define NPCM_FIU_UMA_ADDR_AB3 GENMASK(31, 24)
103#define NPCM_FIU_UMA_ADDR_AB2 GENMASK(23, 16)
104#define NPCM_FIU_UMA_ADDR_AB1 GENMASK(15, 8)
105#define NPCM_FIU_UMA_ADDR_AB0 GENMASK(7, 0)
106
107/* FIU UMA Write Data Bytes 0-3 Register */
108#define NPCM_FIU_UMA_DW0_WB3 GENMASK(31, 24)
109#define NPCM_FIU_UMA_DW0_WB2 GENMASK(23, 16)
110#define NPCM_FIU_UMA_DW0_WB1 GENMASK(15, 8)
111#define NPCM_FIU_UMA_DW0_WB0 GENMASK(7, 0)
112
113/* FIU UMA Write Data Bytes 4-7 Register */
114#define NPCM_FIU_UMA_DW1_WB7 GENMASK(31, 24)
115#define NPCM_FIU_UMA_DW1_WB6 GENMASK(23, 16)
116#define NPCM_FIU_UMA_DW1_WB5 GENMASK(15, 8)
117#define NPCM_FIU_UMA_DW1_WB4 GENMASK(7, 0)
118
119/* FIU UMA Write Data Bytes 8-11 Register */
120#define NPCM_FIU_UMA_DW2_WB11 GENMASK(31, 24)
121#define NPCM_FIU_UMA_DW2_WB10 GENMASK(23, 16)
122#define NPCM_FIU_UMA_DW2_WB9 GENMASK(15, 8)
123#define NPCM_FIU_UMA_DW2_WB8 GENMASK(7, 0)
124
125/* FIU UMA Write Data Bytes 12-15 Register */
126#define NPCM_FIU_UMA_DW3_WB15 GENMASK(31, 24)
127#define NPCM_FIU_UMA_DW3_WB14 GENMASK(23, 16)
128#define NPCM_FIU_UMA_DW3_WB13 GENMASK(15, 8)
129#define NPCM_FIU_UMA_DW3_WB12 GENMASK(7, 0)
130
131/* FIU UMA Read Data Bytes 0-3 Register */
132#define NPCM_FIU_UMA_DR0_RB3 GENMASK(31, 24)
133#define NPCM_FIU_UMA_DR0_RB2 GENMASK(23, 16)
134#define NPCM_FIU_UMA_DR0_RB1 GENMASK(15, 8)
135#define NPCM_FIU_UMA_DR0_RB0 GENMASK(7, 0)
136
137/* FIU UMA Read Data Bytes 4-7 Register */
138#define NPCM_FIU_UMA_DR1_RB15 GENMASK(31, 24)
139#define NPCM_FIU_UMA_DR1_RB14 GENMASK(23, 16)
140#define NPCM_FIU_UMA_DR1_RB13 GENMASK(15, 8)
141#define NPCM_FIU_UMA_DR1_RB12 GENMASK(7, 0)
142
143/* FIU UMA Read Data Bytes 8-11 Register */
144#define NPCM_FIU_UMA_DR2_RB15 GENMASK(31, 24)
145#define NPCM_FIU_UMA_DR2_RB14 GENMASK(23, 16)
146#define NPCM_FIU_UMA_DR2_RB13 GENMASK(15, 8)
147#define NPCM_FIU_UMA_DR2_RB12 GENMASK(7, 0)
148
149/* FIU UMA Read Data Bytes 12-15 Register */
150#define NPCM_FIU_UMA_DR3_RB15 GENMASK(31, 24)
151#define NPCM_FIU_UMA_DR3_RB14 GENMASK(23, 16)
152#define NPCM_FIU_UMA_DR3_RB13 GENMASK(15, 8)
153#define NPCM_FIU_UMA_DR3_RB12 GENMASK(7, 0)
154
155/* FIU Configuration Register */
156#define NPCM_FIU_CFG_FIU_FIX BIT(31)
157
158/* FIU Read Mode */
159enum {
160 DRD_SINGLE_WIRE_MODE = 0,
161 DRD_DUAL_IO_MODE = 1,
162 DRD_QUAD_IO_MODE = 2,
163 DRD_SPI_X_MODE = 3,
164};
165
166enum {
167 DWR_ABPCK_BIT_PER_CLK = 0,
168 DWR_ABPCK_2_BIT_PER_CLK = 1,
169 DWR_ABPCK_4_BIT_PER_CLK = 2,
170};
171
172enum {
173 DWR_DBPCK_BIT_PER_CLK = 0,
174 DWR_DBPCK_2_BIT_PER_CLK = 1,
175 DWR_DBPCK_4_BIT_PER_CLK = 2,
176};
177
178#define NPCM_FIU_DRD_16_BYTE_BURST 0x3000000
179#define NPCM_FIU_DWR_16_BYTE_BURST 0x3000000
180
181#define MAP_SIZE_128MB 0x8000000
182#define MAP_SIZE_16MB 0x1000000
183#define MAP_SIZE_8MB 0x800000
184
185#define FIU_DRD_MAX_DUMMY_NUMBER 3
186#define NPCM_MAX_CHIP_NUM 4
187#define CHUNK_SIZE 16
188#define UMA_MICRO_SEC_TIMEOUT 150
189
190enum {
191 FIU0 = 0,
192 FIU3,
193 FIUX,
194 FIU1,
195};
196
197struct npcm_fiu_info {
198 char *name;
199 u32 fiu_id;
200 u32 max_map_size;
201 u32 max_cs;
202};
203
204struct fiu_data {
205 const struct npcm_fiu_info *npcm_fiu_data_info;
206 int fiu_max;
207};
208
209static const struct npcm_fiu_info npcm7xx_fiu_info[] = {
210 {.name = "FIU0", .fiu_id = FIU0,
211 .max_map_size = MAP_SIZE_128MB, .max_cs = 2},
212 {.name = "FIU3", .fiu_id = FIU3,
213 .max_map_size = MAP_SIZE_128MB, .max_cs = 4},
214 {.name = "FIUX", .fiu_id = FIUX,
215 .max_map_size = MAP_SIZE_16MB, .max_cs = 2} };
216
217static const struct fiu_data npcm7xx_fiu_data = {
218 .npcm_fiu_data_info = npcm7xx_fiu_info,
219 .fiu_max = 3,
220};
221
222static const struct npcm_fiu_info npxm8xx_fiu_info[] = {
223 {.name = "FIU0", .fiu_id = FIU0,
224 .max_map_size = MAP_SIZE_128MB, .max_cs = 2},
225 {.name = "FIU3", .fiu_id = FIU3,
226 .max_map_size = MAP_SIZE_128MB, .max_cs = 4},
227 {.name = "FIUX", .fiu_id = FIUX,
228 .max_map_size = MAP_SIZE_16MB, .max_cs = 2},
229 {.name = "FIU1", .fiu_id = FIU1,
230 .max_map_size = MAP_SIZE_16MB, .max_cs = 4} };
231
232static const struct fiu_data npxm8xx_fiu_data = {
233 .npcm_fiu_data_info = npxm8xx_fiu_info,
234 .fiu_max = 4,
235};
236
237struct npcm_fiu_spi;
238
239struct npcm_fiu_chip {
240 void __iomem *flash_region_mapped_ptr;
241 struct npcm_fiu_spi *fiu;
242 unsigned long clkrate;
243 u32 chipselect;
244};
245
246struct npcm_fiu_spi {
247 struct npcm_fiu_chip chip[NPCM_MAX_CHIP_NUM];
248 const struct npcm_fiu_info *info;
249 struct spi_mem_op drd_op;
250 struct resource *res_mem;
251 struct regmap *regmap;
252 unsigned long clkrate;
253 struct device *dev;
254 struct clk *clk;
255 bool spix_mode;
256};
257
258static const struct regmap_config npcm_mtd_regmap_config = {
259 .reg_bits = 32,
260 .val_bits = 32,
261 .reg_stride = 4,
262 .max_register = NPCM_FIU_MAX_REG_LIMIT,
263};
264
265static void npcm_fiu_set_drd(struct npcm_fiu_spi *fiu,
266 const struct spi_mem_op *op)
267{
268 regmap_update_bits(fiu->regmap, NPCM_FIU_DRD_CFG,
269 NPCM_FIU_DRD_CFG_ACCTYPE,
270 ilog2(op->addr.buswidth) <<
271 NPCM_FIU_DRD_ACCTYPE_SHIFT);
272 fiu->drd_op.addr.buswidth = op->addr.buswidth;
273 regmap_update_bits(fiu->regmap, NPCM_FIU_DRD_CFG,
274 NPCM_FIU_DRD_CFG_DBW,
275 op->dummy.nbytes << NPCM_FIU_DRD_DBW_SHIFT);
276 fiu->drd_op.dummy.nbytes = op->dummy.nbytes;
277 regmap_update_bits(fiu->regmap, NPCM_FIU_DRD_CFG,
278 NPCM_FIU_DRD_CFG_RDCMD, op->cmd.opcode);
279 fiu->drd_op.cmd.opcode = op->cmd.opcode;
280 regmap_update_bits(fiu->regmap, NPCM_FIU_DRD_CFG,
281 NPCM_FIU_DRD_CFG_ADDSIZ,
282 (op->addr.nbytes - 3) << NPCM_FIU_DRD_ADDSIZ_SHIFT);
283 fiu->drd_op.addr.nbytes = op->addr.nbytes;
284}
285
286static ssize_t npcm_fiu_direct_read(struct spi_mem_dirmap_desc *desc,
287 u64 offs, size_t len, void *buf)
288{
289 struct npcm_fiu_spi *fiu =
290 spi_controller_get_devdata(desc->mem->spi->controller);
291 struct npcm_fiu_chip *chip = &fiu->chip[spi_get_chipselect(desc->mem->spi, 0)];
292 void __iomem *src = (void __iomem *)(chip->flash_region_mapped_ptr +
293 offs);
294 u8 *buf_rx = buf;
295 u32 i;
296
297 if (fiu->spix_mode) {
298 for (i = 0 ; i < len ; i++)
299 *(buf_rx + i) = ioread8(src + i);
300 } else {
301 if (desc->info.op_tmpl.addr.buswidth != fiu->drd_op.addr.buswidth ||
302 desc->info.op_tmpl.dummy.nbytes != fiu->drd_op.dummy.nbytes ||
303 desc->info.op_tmpl.cmd.opcode != fiu->drd_op.cmd.opcode ||
304 desc->info.op_tmpl.addr.nbytes != fiu->drd_op.addr.nbytes)
305 npcm_fiu_set_drd(fiu, &desc->info.op_tmpl);
306
307 memcpy_fromio(buf_rx, src, len);
308 }
309
310 return len;
311}
312
313static ssize_t npcm_fiu_direct_write(struct spi_mem_dirmap_desc *desc,
314 u64 offs, size_t len, const void *buf)
315{
316 struct npcm_fiu_spi *fiu =
317 spi_controller_get_devdata(desc->mem->spi->controller);
318 struct npcm_fiu_chip *chip = &fiu->chip[spi_get_chipselect(desc->mem->spi, 0)];
319 void __iomem *dst = (void __iomem *)(chip->flash_region_mapped_ptr +
320 offs);
321 const u8 *buf_tx = buf;
322 u32 i;
323
324 if (fiu->spix_mode)
325 for (i = 0 ; i < len ; i++)
326 iowrite8(*(buf_tx + i), dst + i);
327 else
328 memcpy_toio(dst, buf_tx, len);
329
330 return len;
331}
332
333static int npcm_fiu_uma_read(struct spi_mem *mem,
334 const struct spi_mem_op *op, u32 addr,
335 bool is_address_size, u8 *data, u32 data_size)
336{
337 struct npcm_fiu_spi *fiu =
338 spi_controller_get_devdata(mem->spi->controller);
339 u32 uma_cfg = BIT(10);
340 u32 data_reg[4];
341 int ret;
342 u32 val;
343 u32 i;
344
345 regmap_update_bits(fiu->regmap, NPCM_FIU_UMA_CTS,
346 NPCM_FIU_UMA_CTS_DEV_NUM,
347 (spi_get_chipselect(mem->spi, 0) <<
348 NPCM_FIU_UMA_CTS_DEV_NUM_SHIFT));
349 regmap_update_bits(fiu->regmap, NPCM_FIU_UMA_CMD,
350 NPCM_FIU_UMA_CMD_CMD, op->cmd.opcode);
351
352 if (is_address_size) {
353 uma_cfg |= ilog2(op->cmd.buswidth);
354 uma_cfg |= ilog2(op->addr.buswidth)
355 << NPCM_FIU_UMA_CFG_ADBPCK_SHIFT;
356 if (op->dummy.nbytes)
357 uma_cfg |= ilog2(op->dummy.buswidth)
358 << NPCM_FIU_UMA_CFG_DBPCK_SHIFT;
359 uma_cfg |= ilog2(op->data.buswidth)
360 << NPCM_FIU_UMA_CFG_RDBPCK_SHIFT;
361 uma_cfg |= op->dummy.nbytes << NPCM_FIU_UMA_CFG_DBSIZ_SHIFT;
362 uma_cfg |= op->addr.nbytes << NPCM_FIU_UMA_CFG_ADDSIZ_SHIFT;
363 regmap_write(fiu->regmap, NPCM_FIU_UMA_ADDR, addr);
364 } else {
365 regmap_write(fiu->regmap, NPCM_FIU_UMA_ADDR, 0x0);
366 }
367
368 uma_cfg |= data_size << NPCM_FIU_UMA_CFG_RDATSIZ_SHIFT;
369 regmap_write(fiu->regmap, NPCM_FIU_UMA_CFG, uma_cfg);
370 regmap_write_bits(fiu->regmap, NPCM_FIU_UMA_CTS,
371 NPCM_FIU_UMA_CTS_EXEC_DONE,
372 NPCM_FIU_UMA_CTS_EXEC_DONE);
373 ret = regmap_read_poll_timeout(fiu->regmap, NPCM_FIU_UMA_CTS, val,
374 (!(val & NPCM_FIU_UMA_CTS_EXEC_DONE)), 0,
375 UMA_MICRO_SEC_TIMEOUT);
376 if (ret)
377 return ret;
378
379 if (data_size) {
380 for (i = 0; i < DIV_ROUND_UP(data_size, 4); i++)
381 regmap_read(fiu->regmap, NPCM_FIU_UMA_DR0 + (i * 4),
382 &data_reg[i]);
383 memcpy(data, data_reg, data_size);
384 }
385
386 return 0;
387}
388
389static int npcm_fiu_uma_write(struct spi_mem *mem,
390 const struct spi_mem_op *op, u8 cmd,
391 bool is_address_size, u8 *data, u32 data_size)
392{
393 struct npcm_fiu_spi *fiu =
394 spi_controller_get_devdata(mem->spi->controller);
395 u32 uma_cfg = BIT(10);
396 u32 data_reg[4] = {0};
397 u32 val;
398 u32 i;
399
400 regmap_update_bits(fiu->regmap, NPCM_FIU_UMA_CTS,
401 NPCM_FIU_UMA_CTS_DEV_NUM,
402 (spi_get_chipselect(mem->spi, 0) <<
403 NPCM_FIU_UMA_CTS_DEV_NUM_SHIFT));
404
405 regmap_update_bits(fiu->regmap, NPCM_FIU_UMA_CMD,
406 NPCM_FIU_UMA_CMD_CMD, cmd);
407
408 if (data_size) {
409 memcpy(data_reg, data, data_size);
410 for (i = 0; i < DIV_ROUND_UP(data_size, 4); i++)
411 regmap_write(fiu->regmap, NPCM_FIU_UMA_DW0 + (i * 4),
412 data_reg[i]);
413 }
414
415 if (is_address_size) {
416 uma_cfg |= ilog2(op->cmd.buswidth);
417 uma_cfg |= ilog2(op->addr.buswidth) <<
418 NPCM_FIU_UMA_CFG_ADBPCK_SHIFT;
419 uma_cfg |= ilog2(op->data.buswidth) <<
420 NPCM_FIU_UMA_CFG_WDBPCK_SHIFT;
421 uma_cfg |= op->addr.nbytes << NPCM_FIU_UMA_CFG_ADDSIZ_SHIFT;
422 regmap_write(fiu->regmap, NPCM_FIU_UMA_ADDR, op->addr.val);
423 } else {
424 regmap_write(fiu->regmap, NPCM_FIU_UMA_ADDR, 0x0);
425 }
426
427 uma_cfg |= (data_size << NPCM_FIU_UMA_CFG_WDATSIZ_SHIFT);
428 regmap_write(fiu->regmap, NPCM_FIU_UMA_CFG, uma_cfg);
429
430 regmap_write_bits(fiu->regmap, NPCM_FIU_UMA_CTS,
431 NPCM_FIU_UMA_CTS_EXEC_DONE,
432 NPCM_FIU_UMA_CTS_EXEC_DONE);
433
434 return regmap_read_poll_timeout(fiu->regmap, NPCM_FIU_UMA_CTS, val,
435 (!(val & NPCM_FIU_UMA_CTS_EXEC_DONE)), 0,
436 UMA_MICRO_SEC_TIMEOUT);
437}
438
439static int npcm_fiu_manualwrite(struct spi_mem *mem,
440 const struct spi_mem_op *op)
441{
442 struct npcm_fiu_spi *fiu =
443 spi_controller_get_devdata(mem->spi->controller);
444 u8 *data = (u8 *)op->data.buf.out;
445 u32 num_data_chunks;
446 u32 remain_data;
447 u32 idx = 0;
448 int ret;
449
450 num_data_chunks = op->data.nbytes / CHUNK_SIZE;
451 remain_data = op->data.nbytes % CHUNK_SIZE;
452
453 regmap_update_bits(fiu->regmap, NPCM_FIU_UMA_CTS,
454 NPCM_FIU_UMA_CTS_DEV_NUM,
455 (spi_get_chipselect(mem->spi, 0) <<
456 NPCM_FIU_UMA_CTS_DEV_NUM_SHIFT));
457 regmap_update_bits(fiu->regmap, NPCM_FIU_UMA_CTS,
458 NPCM_FIU_UMA_CTS_SW_CS, 0);
459
460 ret = npcm_fiu_uma_write(mem, op, op->cmd.opcode, true, NULL, 0);
461 if (ret)
462 return ret;
463
464 /* Starting the data writing loop in multiples of 8 */
465 for (idx = 0; idx < num_data_chunks; ++idx) {
466 ret = npcm_fiu_uma_write(mem, op, data[0], false,
467 &data[1], CHUNK_SIZE - 1);
468 if (ret)
469 return ret;
470
471 data += CHUNK_SIZE;
472 }
473
474 /* Handling chunk remains */
475 if (remain_data > 0) {
476 ret = npcm_fiu_uma_write(mem, op, data[0], false,
477 &data[1], remain_data - 1);
478 if (ret)
479 return ret;
480 }
481
482 regmap_update_bits(fiu->regmap, NPCM_FIU_UMA_CTS,
483 NPCM_FIU_UMA_CTS_SW_CS, NPCM_FIU_UMA_CTS_SW_CS);
484
485 return 0;
486}
487
488static int npcm_fiu_read(struct spi_mem *mem, const struct spi_mem_op *op)
489{
490 u8 *data = op->data.buf.in;
491 int i, readlen, currlen;
492 u8 *buf_ptr;
493 u32 addr;
494 int ret;
495
496 i = 0;
497 currlen = op->data.nbytes;
498
499 do {
500 addr = ((u32)op->addr.val + i);
501 if (currlen < 16)
502 readlen = currlen;
503 else
504 readlen = 16;
505
506 buf_ptr = data + i;
507 ret = npcm_fiu_uma_read(mem, op, addr, true, buf_ptr,
508 readlen);
509 if (ret)
510 return ret;
511
512 i += readlen;
513 currlen -= 16;
514 } while (currlen > 0);
515
516 return 0;
517}
518
519static void npcm_fiux_set_direct_wr(struct npcm_fiu_spi *fiu)
520{
521 regmap_write(fiu->regmap, NPCM_FIU_DWR_CFG,
522 NPCM_FIU_DWR_16_BYTE_BURST);
523 regmap_update_bits(fiu->regmap, NPCM_FIU_DWR_CFG,
524 NPCM_FIU_DWR_CFG_ABPCK,
525 DWR_ABPCK_4_BIT_PER_CLK << NPCM_FIU_DWR_ABPCK_SHIFT);
526 regmap_update_bits(fiu->regmap, NPCM_FIU_DWR_CFG,
527 NPCM_FIU_DWR_CFG_DBPCK,
528 DWR_DBPCK_4_BIT_PER_CLK << NPCM_FIU_DWR_DBPCK_SHIFT);
529}
530
531static void npcm_fiux_set_direct_rd(struct npcm_fiu_spi *fiu)
532{
533 u32 rx_dummy = 0;
534
535 regmap_write(fiu->regmap, NPCM_FIU_DRD_CFG,
536 NPCM_FIU_DRD_16_BYTE_BURST);
537 regmap_update_bits(fiu->regmap, NPCM_FIU_DRD_CFG,
538 NPCM_FIU_DRD_CFG_ACCTYPE,
539 DRD_SPI_X_MODE << NPCM_FIU_DRD_ACCTYPE_SHIFT);
540 regmap_update_bits(fiu->regmap, NPCM_FIU_DRD_CFG,
541 NPCM_FIU_DRD_CFG_DBW,
542 rx_dummy << NPCM_FIU_DRD_DBW_SHIFT);
543}
544
545static int npcm_fiu_exec_op(struct spi_mem *mem, const struct spi_mem_op *op)
546{
547 struct npcm_fiu_spi *fiu =
548 spi_controller_get_devdata(mem->spi->controller);
549 struct npcm_fiu_chip *chip = &fiu->chip[spi_get_chipselect(mem->spi, 0)];
550 int ret = 0;
551 u8 *buf;
552
553 dev_dbg(fiu->dev, "cmd:%#x mode:%d.%d.%d.%d addr:%#llx len:%#x\n",
554 op->cmd.opcode, op->cmd.buswidth, op->addr.buswidth,
555 op->dummy.buswidth, op->data.buswidth, op->addr.val,
556 op->data.nbytes);
557
558 if (fiu->spix_mode || op->addr.nbytes > 4)
559 return -EOPNOTSUPP;
560
561 if (fiu->clkrate != chip->clkrate) {
562 ret = clk_set_rate(fiu->clk, chip->clkrate);
563 if (ret < 0)
564 dev_warn(fiu->dev, "Failed setting %lu frequency, stay at %lu frequency\n",
565 chip->clkrate, fiu->clkrate);
566 else
567 fiu->clkrate = chip->clkrate;
568 }
569
570 if (op->data.dir == SPI_MEM_DATA_IN) {
571 if (!op->addr.nbytes) {
572 buf = op->data.buf.in;
573 ret = npcm_fiu_uma_read(mem, op, op->addr.val, false,
574 buf, op->data.nbytes);
575 } else {
576 ret = npcm_fiu_read(mem, op);
577 }
578 } else {
579 if (!op->addr.nbytes && !op->data.nbytes)
580 ret = npcm_fiu_uma_write(mem, op, op->cmd.opcode, false,
581 NULL, 0);
582 if (op->addr.nbytes && !op->data.nbytes) {
583 int i;
584 u8 buf_addr[4];
585 u32 addr = op->addr.val;
586
587 for (i = op->addr.nbytes - 1; i >= 0; i--) {
588 buf_addr[i] = addr & 0xff;
589 addr >>= 8;
590 }
591 ret = npcm_fiu_uma_write(mem, op, op->cmd.opcode, false,
592 buf_addr, op->addr.nbytes);
593 }
594 if (!op->addr.nbytes && op->data.nbytes)
595 ret = npcm_fiu_uma_write(mem, op, op->cmd.opcode, false,
596 (u8 *)op->data.buf.out,
597 op->data.nbytes);
598 if (op->addr.nbytes && op->data.nbytes)
599 ret = npcm_fiu_manualwrite(mem, op);
600 }
601
602 return ret;
603}
604
605static int npcm_fiu_dirmap_create(struct spi_mem_dirmap_desc *desc)
606{
607 struct npcm_fiu_spi *fiu =
608 spi_controller_get_devdata(desc->mem->spi->controller);
609 struct npcm_fiu_chip *chip = &fiu->chip[spi_get_chipselect(desc->mem->spi, 0)];
610 struct regmap *gcr_regmap;
611
612 if (!fiu->res_mem) {
613 dev_warn(fiu->dev, "Reserved memory not defined, direct read disabled\n");
614 desc->nodirmap = true;
615 return 0;
616 }
617
618 if (!fiu->spix_mode &&
619 desc->info.op_tmpl.data.dir == SPI_MEM_DATA_OUT) {
620 desc->nodirmap = true;
621 return 0;
622 }
623
624 if (!chip->flash_region_mapped_ptr) {
625 chip->flash_region_mapped_ptr =
626 devm_ioremap(fiu->dev, (fiu->res_mem->start +
627 (fiu->info->max_map_size *
628 spi_get_chipselect(desc->mem->spi, 0))),
629 (u32)desc->info.length);
630 if (!chip->flash_region_mapped_ptr) {
631 dev_warn(fiu->dev, "Error mapping memory region, direct read disabled\n");
632 desc->nodirmap = true;
633 return 0;
634 }
635 }
636
637 if (of_device_is_compatible(fiu->dev->of_node, "nuvoton,npcm750-fiu")) {
638 gcr_regmap =
639 syscon_regmap_lookup_by_compatible("nuvoton,npcm750-gcr");
640 if (IS_ERR(gcr_regmap)) {
641 dev_warn(fiu->dev, "Didn't find nuvoton,npcm750-gcr, direct read disabled\n");
642 desc->nodirmap = true;
643 return 0;
644 }
645 regmap_update_bits(gcr_regmap, NPCM7XX_INTCR3_OFFSET,
646 NPCM7XX_INTCR3_FIU_FIX,
647 NPCM7XX_INTCR3_FIU_FIX);
648 } else {
649 regmap_update_bits(fiu->regmap, NPCM_FIU_CFG,
650 NPCM_FIU_CFG_FIU_FIX,
651 NPCM_FIU_CFG_FIU_FIX);
652 }
653
654 if (desc->info.op_tmpl.data.dir == SPI_MEM_DATA_IN) {
655 if (!fiu->spix_mode)
656 npcm_fiu_set_drd(fiu, &desc->info.op_tmpl);
657 else
658 npcm_fiux_set_direct_rd(fiu);
659
660 } else {
661 npcm_fiux_set_direct_wr(fiu);
662 }
663
664 return 0;
665}
666
667static int npcm_fiu_setup(struct spi_device *spi)
668{
669 struct spi_controller *ctrl = spi->controller;
670 struct npcm_fiu_spi *fiu = spi_controller_get_devdata(ctrl);
671 struct npcm_fiu_chip *chip;
672
673 chip = &fiu->chip[spi_get_chipselect(spi, 0)];
674 chip->fiu = fiu;
675 chip->chipselect = spi_get_chipselect(spi, 0);
676 chip->clkrate = spi->max_speed_hz;
677
678 fiu->clkrate = clk_get_rate(fiu->clk);
679
680 return 0;
681}
682
683static const struct spi_controller_mem_ops npcm_fiu_mem_ops = {
684 .exec_op = npcm_fiu_exec_op,
685 .dirmap_create = npcm_fiu_dirmap_create,
686 .dirmap_read = npcm_fiu_direct_read,
687 .dirmap_write = npcm_fiu_direct_write,
688};
689
690static const struct of_device_id npcm_fiu_dt_ids[] = {
691 { .compatible = "nuvoton,npcm750-fiu", .data = &npcm7xx_fiu_data },
692 { .compatible = "nuvoton,npcm845-fiu", .data = &npxm8xx_fiu_data },
693 { /* sentinel */ }
694};
695
696static int npcm_fiu_probe(struct platform_device *pdev)
697{
698 const struct fiu_data *fiu_data_match;
699 struct device *dev = &pdev->dev;
700 struct spi_controller *ctrl;
701 struct npcm_fiu_spi *fiu;
702 void __iomem *regbase;
703 int id;
704
705 ctrl = devm_spi_alloc_host(dev, sizeof(*fiu));
706 if (!ctrl)
707 return -ENOMEM;
708
709 fiu = spi_controller_get_devdata(ctrl);
710
711 fiu_data_match = of_device_get_match_data(dev);
712 if (!fiu_data_match) {
713 dev_err(dev, "No compatible OF match\n");
714 return -ENODEV;
715 }
716
717 id = of_alias_get_id(dev->of_node, "fiu");
718 if (id < 0 || id >= fiu_data_match->fiu_max) {
719 dev_err(dev, "Invalid platform device id: %d\n", id);
720 return -EINVAL;
721 }
722
723 fiu->info = &fiu_data_match->npcm_fiu_data_info[id];
724
725 platform_set_drvdata(pdev, fiu);
726 fiu->dev = dev;
727
728 regbase = devm_platform_ioremap_resource_byname(pdev, "control");
729 if (IS_ERR(regbase))
730 return PTR_ERR(regbase);
731
732 fiu->regmap = devm_regmap_init_mmio(dev, regbase,
733 &npcm_mtd_regmap_config);
734 if (IS_ERR(fiu->regmap)) {
735 dev_err(dev, "Failed to create regmap\n");
736 return PTR_ERR(fiu->regmap);
737 }
738
739 fiu->res_mem = platform_get_resource_byname(pdev, IORESOURCE_MEM,
740 "memory");
741 fiu->clk = devm_clk_get_enabled(dev, NULL);
742 if (IS_ERR(fiu->clk))
743 return PTR_ERR(fiu->clk);
744
745 fiu->spix_mode = of_property_read_bool(dev->of_node,
746 "nuvoton,spix-mode");
747
748 platform_set_drvdata(pdev, fiu);
749
750 ctrl->mode_bits = SPI_RX_DUAL | SPI_RX_QUAD
751 | SPI_TX_DUAL | SPI_TX_QUAD;
752 ctrl->setup = npcm_fiu_setup;
753 ctrl->bus_num = -1;
754 ctrl->mem_ops = &npcm_fiu_mem_ops;
755 ctrl->num_chipselect = fiu->info->max_cs;
756 ctrl->dev.of_node = dev->of_node;
757
758 return devm_spi_register_controller(dev, ctrl);
759}
760
761static void npcm_fiu_remove(struct platform_device *pdev)
762{
763}
764
765MODULE_DEVICE_TABLE(of, npcm_fiu_dt_ids);
766
767static struct platform_driver npcm_fiu_driver = {
768 .driver = {
769 .name = "NPCM-FIU",
770 .bus = &platform_bus_type,
771 .of_match_table = npcm_fiu_dt_ids,
772 },
773 .probe = npcm_fiu_probe,
774 .remove = npcm_fiu_remove,
775};
776module_platform_driver(npcm_fiu_driver);
777
778MODULE_DESCRIPTION("Nuvoton FLASH Interface Unit SPI Controller Driver");
779MODULE_AUTHOR("Tomer Maimon <tomer.maimon@nuvoton.com>");
780MODULE_LICENSE("GPL v2");
1// SPDX-License-Identifier: GPL-2.0
2// Copyright (c) 2019 Nuvoton Technology corporation.
3
4#include <linux/bits.h>
5#include <linux/init.h>
6#include <linux/kernel.h>
7#include <linux/device.h>
8#include <linux/module.h>
9#include <linux/ioport.h>
10#include <linux/clk.h>
11#include <linux/platform_device.h>
12#include <linux/io.h>
13#include <linux/vmalloc.h>
14#include <linux/regmap.h>
15#include <linux/of_device.h>
16#include <linux/spi/spi-mem.h>
17#include <linux/mfd/syscon.h>
18
19/* NPCM7xx GCR module */
20#define NPCM7XX_INTCR3_OFFSET 0x9C
21#define NPCM7XX_INTCR3_FIU_FIX BIT(6)
22
23/* Flash Interface Unit (FIU) Registers */
24#define NPCM_FIU_DRD_CFG 0x00
25#define NPCM_FIU_DWR_CFG 0x04
26#define NPCM_FIU_UMA_CFG 0x08
27#define NPCM_FIU_UMA_CTS 0x0C
28#define NPCM_FIU_UMA_CMD 0x10
29#define NPCM_FIU_UMA_ADDR 0x14
30#define NPCM_FIU_PRT_CFG 0x18
31#define NPCM_FIU_UMA_DW0 0x20
32#define NPCM_FIU_UMA_DW1 0x24
33#define NPCM_FIU_UMA_DW2 0x28
34#define NPCM_FIU_UMA_DW3 0x2C
35#define NPCM_FIU_UMA_DR0 0x30
36#define NPCM_FIU_UMA_DR1 0x34
37#define NPCM_FIU_UMA_DR2 0x38
38#define NPCM_FIU_UMA_DR3 0x3C
39#define NPCM_FIU_MAX_REG_LIMIT 0x80
40
41/* FIU Direct Read Configuration Register */
42#define NPCM_FIU_DRD_CFG_LCK BIT(31)
43#define NPCM_FIU_DRD_CFG_R_BURST GENMASK(25, 24)
44#define NPCM_FIU_DRD_CFG_ADDSIZ GENMASK(17, 16)
45#define NPCM_FIU_DRD_CFG_DBW GENMASK(13, 12)
46#define NPCM_FIU_DRD_CFG_ACCTYPE GENMASK(9, 8)
47#define NPCM_FIU_DRD_CFG_RDCMD GENMASK(7, 0)
48#define NPCM_FIU_DRD_ADDSIZ_SHIFT 16
49#define NPCM_FIU_DRD_DBW_SHIFT 12
50#define NPCM_FIU_DRD_ACCTYPE_SHIFT 8
51
52/* FIU Direct Write Configuration Register */
53#define NPCM_FIU_DWR_CFG_LCK BIT(31)
54#define NPCM_FIU_DWR_CFG_W_BURST GENMASK(25, 24)
55#define NPCM_FIU_DWR_CFG_ADDSIZ GENMASK(17, 16)
56#define NPCM_FIU_DWR_CFG_ABPCK GENMASK(11, 10)
57#define NPCM_FIU_DWR_CFG_DBPCK GENMASK(9, 8)
58#define NPCM_FIU_DWR_CFG_WRCMD GENMASK(7, 0)
59#define NPCM_FIU_DWR_ADDSIZ_SHIFT 16
60#define NPCM_FIU_DWR_ABPCK_SHIFT 10
61#define NPCM_FIU_DWR_DBPCK_SHIFT 8
62
63/* FIU UMA Configuration Register */
64#define NPCM_FIU_UMA_CFG_LCK BIT(31)
65#define NPCM_FIU_UMA_CFG_CMMLCK BIT(30)
66#define NPCM_FIU_UMA_CFG_RDATSIZ GENMASK(28, 24)
67#define NPCM_FIU_UMA_CFG_DBSIZ GENMASK(23, 21)
68#define NPCM_FIU_UMA_CFG_WDATSIZ GENMASK(20, 16)
69#define NPCM_FIU_UMA_CFG_ADDSIZ GENMASK(13, 11)
70#define NPCM_FIU_UMA_CFG_CMDSIZ BIT(10)
71#define NPCM_FIU_UMA_CFG_RDBPCK GENMASK(9, 8)
72#define NPCM_FIU_UMA_CFG_DBPCK GENMASK(7, 6)
73#define NPCM_FIU_UMA_CFG_WDBPCK GENMASK(5, 4)
74#define NPCM_FIU_UMA_CFG_ADBPCK GENMASK(3, 2)
75#define NPCM_FIU_UMA_CFG_CMBPCK GENMASK(1, 0)
76#define NPCM_FIU_UMA_CFG_ADBPCK_SHIFT 2
77#define NPCM_FIU_UMA_CFG_WDBPCK_SHIFT 4
78#define NPCM_FIU_UMA_CFG_DBPCK_SHIFT 6
79#define NPCM_FIU_UMA_CFG_RDBPCK_SHIFT 8
80#define NPCM_FIU_UMA_CFG_ADDSIZ_SHIFT 11
81#define NPCM_FIU_UMA_CFG_WDATSIZ_SHIFT 16
82#define NPCM_FIU_UMA_CFG_DBSIZ_SHIFT 21
83#define NPCM_FIU_UMA_CFG_RDATSIZ_SHIFT 24
84
85/* FIU UMA Control and Status Register */
86#define NPCM_FIU_UMA_CTS_RDYIE BIT(25)
87#define NPCM_FIU_UMA_CTS_RDYST BIT(24)
88#define NPCM_FIU_UMA_CTS_SW_CS BIT(16)
89#define NPCM_FIU_UMA_CTS_DEV_NUM GENMASK(9, 8)
90#define NPCM_FIU_UMA_CTS_EXEC_DONE BIT(0)
91#define NPCM_FIU_UMA_CTS_DEV_NUM_SHIFT 8
92
93/* FIU UMA Command Register */
94#define NPCM_FIU_UMA_CMD_DUM3 GENMASK(31, 24)
95#define NPCM_FIU_UMA_CMD_DUM2 GENMASK(23, 16)
96#define NPCM_FIU_UMA_CMD_DUM1 GENMASK(15, 8)
97#define NPCM_FIU_UMA_CMD_CMD GENMASK(7, 0)
98
99/* FIU UMA Address Register */
100#define NPCM_FIU_UMA_ADDR_UMA_ADDR GENMASK(31, 0)
101#define NPCM_FIU_UMA_ADDR_AB3 GENMASK(31, 24)
102#define NPCM_FIU_UMA_ADDR_AB2 GENMASK(23, 16)
103#define NPCM_FIU_UMA_ADDR_AB1 GENMASK(15, 8)
104#define NPCM_FIU_UMA_ADDR_AB0 GENMASK(7, 0)
105
106/* FIU UMA Write Data Bytes 0-3 Register */
107#define NPCM_FIU_UMA_DW0_WB3 GENMASK(31, 24)
108#define NPCM_FIU_UMA_DW0_WB2 GENMASK(23, 16)
109#define NPCM_FIU_UMA_DW0_WB1 GENMASK(15, 8)
110#define NPCM_FIU_UMA_DW0_WB0 GENMASK(7, 0)
111
112/* FIU UMA Write Data Bytes 4-7 Register */
113#define NPCM_FIU_UMA_DW1_WB7 GENMASK(31, 24)
114#define NPCM_FIU_UMA_DW1_WB6 GENMASK(23, 16)
115#define NPCM_FIU_UMA_DW1_WB5 GENMASK(15, 8)
116#define NPCM_FIU_UMA_DW1_WB4 GENMASK(7, 0)
117
118/* FIU UMA Write Data Bytes 8-11 Register */
119#define NPCM_FIU_UMA_DW2_WB11 GENMASK(31, 24)
120#define NPCM_FIU_UMA_DW2_WB10 GENMASK(23, 16)
121#define NPCM_FIU_UMA_DW2_WB9 GENMASK(15, 8)
122#define NPCM_FIU_UMA_DW2_WB8 GENMASK(7, 0)
123
124/* FIU UMA Write Data Bytes 12-15 Register */
125#define NPCM_FIU_UMA_DW3_WB15 GENMASK(31, 24)
126#define NPCM_FIU_UMA_DW3_WB14 GENMASK(23, 16)
127#define NPCM_FIU_UMA_DW3_WB13 GENMASK(15, 8)
128#define NPCM_FIU_UMA_DW3_WB12 GENMASK(7, 0)
129
130/* FIU UMA Read Data Bytes 0-3 Register */
131#define NPCM_FIU_UMA_DR0_RB3 GENMASK(31, 24)
132#define NPCM_FIU_UMA_DR0_RB2 GENMASK(23, 16)
133#define NPCM_FIU_UMA_DR0_RB1 GENMASK(15, 8)
134#define NPCM_FIU_UMA_DR0_RB0 GENMASK(7, 0)
135
136/* FIU UMA Read Data Bytes 4-7 Register */
137#define NPCM_FIU_UMA_DR1_RB15 GENMASK(31, 24)
138#define NPCM_FIU_UMA_DR1_RB14 GENMASK(23, 16)
139#define NPCM_FIU_UMA_DR1_RB13 GENMASK(15, 8)
140#define NPCM_FIU_UMA_DR1_RB12 GENMASK(7, 0)
141
142/* FIU UMA Read Data Bytes 8-11 Register */
143#define NPCM_FIU_UMA_DR2_RB15 GENMASK(31, 24)
144#define NPCM_FIU_UMA_DR2_RB14 GENMASK(23, 16)
145#define NPCM_FIU_UMA_DR2_RB13 GENMASK(15, 8)
146#define NPCM_FIU_UMA_DR2_RB12 GENMASK(7, 0)
147
148/* FIU UMA Read Data Bytes 12-15 Register */
149#define NPCM_FIU_UMA_DR3_RB15 GENMASK(31, 24)
150#define NPCM_FIU_UMA_DR3_RB14 GENMASK(23, 16)
151#define NPCM_FIU_UMA_DR3_RB13 GENMASK(15, 8)
152#define NPCM_FIU_UMA_DR3_RB12 GENMASK(7, 0)
153
154/* FIU Read Mode */
155enum {
156 DRD_SINGLE_WIRE_MODE = 0,
157 DRD_DUAL_IO_MODE = 1,
158 DRD_QUAD_IO_MODE = 2,
159 DRD_SPI_X_MODE = 3,
160};
161
162enum {
163 DWR_ABPCK_BIT_PER_CLK = 0,
164 DWR_ABPCK_2_BIT_PER_CLK = 1,
165 DWR_ABPCK_4_BIT_PER_CLK = 2,
166};
167
168enum {
169 DWR_DBPCK_BIT_PER_CLK = 0,
170 DWR_DBPCK_2_BIT_PER_CLK = 1,
171 DWR_DBPCK_4_BIT_PER_CLK = 2,
172};
173
174#define NPCM_FIU_DRD_16_BYTE_BURST 0x3000000
175#define NPCM_FIU_DWR_16_BYTE_BURST 0x3000000
176
177#define MAP_SIZE_128MB 0x8000000
178#define MAP_SIZE_16MB 0x1000000
179#define MAP_SIZE_8MB 0x800000
180
181#define FIU_DRD_MAX_DUMMY_NUMBER 3
182#define NPCM_MAX_CHIP_NUM 4
183#define CHUNK_SIZE 16
184#define UMA_MICRO_SEC_TIMEOUT 150
185
186enum {
187 FIU0 = 0,
188 FIU3,
189 FIUX,
190};
191
192struct npcm_fiu_info {
193 char *name;
194 u32 fiu_id;
195 u32 max_map_size;
196 u32 max_cs;
197};
198
199struct fiu_data {
200 const struct npcm_fiu_info *npcm_fiu_data_info;
201 int fiu_max;
202};
203
204static const struct npcm_fiu_info npxm7xx_fiu_info[] = {
205 {.name = "FIU0", .fiu_id = FIU0,
206 .max_map_size = MAP_SIZE_128MB, .max_cs = 2},
207 {.name = "FIU3", .fiu_id = FIU3,
208 .max_map_size = MAP_SIZE_128MB, .max_cs = 4},
209 {.name = "FIUX", .fiu_id = FIUX,
210 .max_map_size = MAP_SIZE_16MB, .max_cs = 2} };
211
212static const struct fiu_data npxm7xx_fiu_data = {
213 .npcm_fiu_data_info = npxm7xx_fiu_info,
214 .fiu_max = 3,
215};
216
217struct npcm_fiu_spi;
218
219struct npcm_fiu_chip {
220 void __iomem *flash_region_mapped_ptr;
221 struct npcm_fiu_spi *fiu;
222 unsigned long clkrate;
223 u32 chipselect;
224};
225
226struct npcm_fiu_spi {
227 struct npcm_fiu_chip chip[NPCM_MAX_CHIP_NUM];
228 const struct npcm_fiu_info *info;
229 struct spi_mem_op drd_op;
230 struct resource *res_mem;
231 struct regmap *regmap;
232 unsigned long clkrate;
233 struct device *dev;
234 struct clk *clk;
235 bool spix_mode;
236};
237
238static const struct regmap_config npcm_mtd_regmap_config = {
239 .reg_bits = 32,
240 .val_bits = 32,
241 .reg_stride = 4,
242 .max_register = NPCM_FIU_MAX_REG_LIMIT,
243};
244
245static void npcm_fiu_set_drd(struct npcm_fiu_spi *fiu,
246 const struct spi_mem_op *op)
247{
248 regmap_update_bits(fiu->regmap, NPCM_FIU_DRD_CFG,
249 NPCM_FIU_DRD_CFG_ACCTYPE,
250 ilog2(op->addr.buswidth) <<
251 NPCM_FIU_DRD_ACCTYPE_SHIFT);
252 fiu->drd_op.addr.buswidth = op->addr.buswidth;
253 regmap_update_bits(fiu->regmap, NPCM_FIU_DRD_CFG,
254 NPCM_FIU_DRD_CFG_DBW,
255 ((op->dummy.nbytes * ilog2(op->addr.buswidth)) / BITS_PER_BYTE)
256 << NPCM_FIU_DRD_DBW_SHIFT);
257 fiu->drd_op.dummy.nbytes = op->dummy.nbytes;
258 regmap_update_bits(fiu->regmap, NPCM_FIU_DRD_CFG,
259 NPCM_FIU_DRD_CFG_RDCMD, op->cmd.opcode);
260 fiu->drd_op.cmd.opcode = op->cmd.opcode;
261 regmap_update_bits(fiu->regmap, NPCM_FIU_DRD_CFG,
262 NPCM_FIU_DRD_CFG_ADDSIZ,
263 (op->addr.nbytes - 3) << NPCM_FIU_DRD_ADDSIZ_SHIFT);
264 fiu->drd_op.addr.nbytes = op->addr.nbytes;
265}
266
267static ssize_t npcm_fiu_direct_read(struct spi_mem_dirmap_desc *desc,
268 u64 offs, size_t len, void *buf)
269{
270 struct npcm_fiu_spi *fiu =
271 spi_controller_get_devdata(desc->mem->spi->master);
272 struct npcm_fiu_chip *chip = &fiu->chip[desc->mem->spi->chip_select];
273 void __iomem *src = (void __iomem *)(chip->flash_region_mapped_ptr +
274 offs);
275 u8 *buf_rx = buf;
276 u32 i;
277
278 if (fiu->spix_mode) {
279 for (i = 0 ; i < len ; i++)
280 *(buf_rx + i) = ioread8(src + i);
281 } else {
282 if (desc->info.op_tmpl.addr.buswidth != fiu->drd_op.addr.buswidth ||
283 desc->info.op_tmpl.dummy.nbytes != fiu->drd_op.dummy.nbytes ||
284 desc->info.op_tmpl.cmd.opcode != fiu->drd_op.cmd.opcode ||
285 desc->info.op_tmpl.addr.nbytes != fiu->drd_op.addr.nbytes)
286 npcm_fiu_set_drd(fiu, &desc->info.op_tmpl);
287
288 memcpy_fromio(buf_rx, src, len);
289 }
290
291 return len;
292}
293
294static ssize_t npcm_fiu_direct_write(struct spi_mem_dirmap_desc *desc,
295 u64 offs, size_t len, const void *buf)
296{
297 struct npcm_fiu_spi *fiu =
298 spi_controller_get_devdata(desc->mem->spi->master);
299 struct npcm_fiu_chip *chip = &fiu->chip[desc->mem->spi->chip_select];
300 void __iomem *dst = (void __iomem *)(chip->flash_region_mapped_ptr +
301 offs);
302 const u8 *buf_tx = buf;
303 u32 i;
304
305 if (fiu->spix_mode)
306 for (i = 0 ; i < len ; i++)
307 iowrite8(*(buf_tx + i), dst + i);
308 else
309 memcpy_toio(dst, buf_tx, len);
310
311 return len;
312}
313
314static int npcm_fiu_uma_read(struct spi_mem *mem,
315 const struct spi_mem_op *op, u32 addr,
316 bool is_address_size, u8 *data, u32 data_size)
317{
318 struct npcm_fiu_spi *fiu =
319 spi_controller_get_devdata(mem->spi->master);
320 u32 uma_cfg = BIT(10);
321 u32 data_reg[4];
322 int ret;
323 u32 val;
324 u32 i;
325
326 regmap_update_bits(fiu->regmap, NPCM_FIU_UMA_CTS,
327 NPCM_FIU_UMA_CTS_DEV_NUM,
328 (mem->spi->chip_select <<
329 NPCM_FIU_UMA_CTS_DEV_NUM_SHIFT));
330 regmap_update_bits(fiu->regmap, NPCM_FIU_UMA_CMD,
331 NPCM_FIU_UMA_CMD_CMD, op->cmd.opcode);
332
333 if (is_address_size) {
334 uma_cfg |= ilog2(op->cmd.buswidth);
335 uma_cfg |= ilog2(op->addr.buswidth)
336 << NPCM_FIU_UMA_CFG_ADBPCK_SHIFT;
337 uma_cfg |= ilog2(op->dummy.buswidth)
338 << NPCM_FIU_UMA_CFG_DBPCK_SHIFT;
339 uma_cfg |= ilog2(op->data.buswidth)
340 << NPCM_FIU_UMA_CFG_RDBPCK_SHIFT;
341 uma_cfg |= op->dummy.nbytes << NPCM_FIU_UMA_CFG_DBSIZ_SHIFT;
342 uma_cfg |= op->addr.nbytes << NPCM_FIU_UMA_CFG_ADDSIZ_SHIFT;
343 regmap_write(fiu->regmap, NPCM_FIU_UMA_ADDR, addr);
344 } else {
345 regmap_write(fiu->regmap, NPCM_FIU_UMA_ADDR, 0x0);
346 }
347
348 uma_cfg |= data_size << NPCM_FIU_UMA_CFG_RDATSIZ_SHIFT;
349 regmap_write(fiu->regmap, NPCM_FIU_UMA_CFG, uma_cfg);
350 regmap_write_bits(fiu->regmap, NPCM_FIU_UMA_CTS,
351 NPCM_FIU_UMA_CTS_EXEC_DONE,
352 NPCM_FIU_UMA_CTS_EXEC_DONE);
353 ret = regmap_read_poll_timeout(fiu->regmap, NPCM_FIU_UMA_CTS, val,
354 (!(val & NPCM_FIU_UMA_CTS_EXEC_DONE)), 0,
355 UMA_MICRO_SEC_TIMEOUT);
356 if (ret)
357 return ret;
358
359 if (data_size) {
360 for (i = 0; i < DIV_ROUND_UP(data_size, 4); i++)
361 regmap_read(fiu->regmap, NPCM_FIU_UMA_DR0 + (i * 4),
362 &data_reg[i]);
363 memcpy(data, data_reg, data_size);
364 }
365
366 return 0;
367}
368
369static int npcm_fiu_uma_write(struct spi_mem *mem,
370 const struct spi_mem_op *op, u8 cmd,
371 bool is_address_size, u8 *data, u32 data_size)
372{
373 struct npcm_fiu_spi *fiu =
374 spi_controller_get_devdata(mem->spi->master);
375 u32 uma_cfg = BIT(10);
376 u32 data_reg[4] = {0};
377 u32 val;
378 u32 i;
379
380 regmap_update_bits(fiu->regmap, NPCM_FIU_UMA_CTS,
381 NPCM_FIU_UMA_CTS_DEV_NUM,
382 (mem->spi->chip_select <<
383 NPCM_FIU_UMA_CTS_DEV_NUM_SHIFT));
384
385 regmap_update_bits(fiu->regmap, NPCM_FIU_UMA_CMD,
386 NPCM_FIU_UMA_CMD_CMD, cmd);
387
388 if (data_size) {
389 memcpy(data_reg, data, data_size);
390 for (i = 0; i < DIV_ROUND_UP(data_size, 4); i++)
391 regmap_write(fiu->regmap, NPCM_FIU_UMA_DW0 + (i * 4),
392 data_reg[i]);
393 }
394
395 if (is_address_size) {
396 uma_cfg |= ilog2(op->cmd.buswidth);
397 uma_cfg |= ilog2(op->addr.buswidth) <<
398 NPCM_FIU_UMA_CFG_ADBPCK_SHIFT;
399 uma_cfg |= ilog2(op->data.buswidth) <<
400 NPCM_FIU_UMA_CFG_WDBPCK_SHIFT;
401 uma_cfg |= op->addr.nbytes << NPCM_FIU_UMA_CFG_ADDSIZ_SHIFT;
402 regmap_write(fiu->regmap, NPCM_FIU_UMA_ADDR, op->addr.val);
403 } else {
404 regmap_write(fiu->regmap, NPCM_FIU_UMA_ADDR, 0x0);
405 }
406
407 uma_cfg |= (data_size << NPCM_FIU_UMA_CFG_WDATSIZ_SHIFT);
408 regmap_write(fiu->regmap, NPCM_FIU_UMA_CFG, uma_cfg);
409
410 regmap_write_bits(fiu->regmap, NPCM_FIU_UMA_CTS,
411 NPCM_FIU_UMA_CTS_EXEC_DONE,
412 NPCM_FIU_UMA_CTS_EXEC_DONE);
413
414 return regmap_read_poll_timeout(fiu->regmap, NPCM_FIU_UMA_CTS, val,
415 (!(val & NPCM_FIU_UMA_CTS_EXEC_DONE)), 0,
416 UMA_MICRO_SEC_TIMEOUT);
417}
418
419static int npcm_fiu_manualwrite(struct spi_mem *mem,
420 const struct spi_mem_op *op)
421{
422 struct npcm_fiu_spi *fiu =
423 spi_controller_get_devdata(mem->spi->master);
424 u8 *data = (u8 *)op->data.buf.out;
425 u32 num_data_chunks;
426 u32 remain_data;
427 u32 idx = 0;
428 int ret;
429
430 num_data_chunks = op->data.nbytes / CHUNK_SIZE;
431 remain_data = op->data.nbytes % CHUNK_SIZE;
432
433 regmap_update_bits(fiu->regmap, NPCM_FIU_UMA_CTS,
434 NPCM_FIU_UMA_CTS_DEV_NUM,
435 (mem->spi->chip_select <<
436 NPCM_FIU_UMA_CTS_DEV_NUM_SHIFT));
437 regmap_update_bits(fiu->regmap, NPCM_FIU_UMA_CTS,
438 NPCM_FIU_UMA_CTS_SW_CS, 0);
439
440 ret = npcm_fiu_uma_write(mem, op, op->cmd.opcode, true, NULL, 0);
441 if (ret)
442 return ret;
443
444 /* Starting the data writing loop in multiples of 8 */
445 for (idx = 0; idx < num_data_chunks; ++idx) {
446 ret = npcm_fiu_uma_write(mem, op, data[0], false,
447 &data[1], CHUNK_SIZE - 1);
448 if (ret)
449 return ret;
450
451 data += CHUNK_SIZE;
452 }
453
454 /* Handling chunk remains */
455 if (remain_data > 0) {
456 ret = npcm_fiu_uma_write(mem, op, data[0], false,
457 &data[1], remain_data - 1);
458 if (ret)
459 return ret;
460 }
461
462 regmap_update_bits(fiu->regmap, NPCM_FIU_UMA_CTS,
463 NPCM_FIU_UMA_CTS_SW_CS, NPCM_FIU_UMA_CTS_SW_CS);
464
465 return 0;
466}
467
468static int npcm_fiu_read(struct spi_mem *mem, const struct spi_mem_op *op)
469{
470 u8 *data = op->data.buf.in;
471 int i, readlen, currlen;
472 u8 *buf_ptr;
473 u32 addr;
474 int ret;
475
476 i = 0;
477 currlen = op->data.nbytes;
478
479 do {
480 addr = ((u32)op->addr.val + i);
481 if (currlen < 16)
482 readlen = currlen;
483 else
484 readlen = 16;
485
486 buf_ptr = data + i;
487 ret = npcm_fiu_uma_read(mem, op, addr, true, buf_ptr,
488 readlen);
489 if (ret)
490 return ret;
491
492 i += readlen;
493 currlen -= 16;
494 } while (currlen > 0);
495
496 return 0;
497}
498
499static void npcm_fiux_set_direct_wr(struct npcm_fiu_spi *fiu)
500{
501 regmap_write(fiu->regmap, NPCM_FIU_DWR_CFG,
502 NPCM_FIU_DWR_16_BYTE_BURST);
503 regmap_update_bits(fiu->regmap, NPCM_FIU_DWR_CFG,
504 NPCM_FIU_DWR_CFG_ABPCK,
505 DWR_ABPCK_4_BIT_PER_CLK << NPCM_FIU_DWR_ABPCK_SHIFT);
506 regmap_update_bits(fiu->regmap, NPCM_FIU_DWR_CFG,
507 NPCM_FIU_DWR_CFG_DBPCK,
508 DWR_DBPCK_4_BIT_PER_CLK << NPCM_FIU_DWR_DBPCK_SHIFT);
509}
510
511static void npcm_fiux_set_direct_rd(struct npcm_fiu_spi *fiu)
512{
513 u32 rx_dummy = 0;
514
515 regmap_write(fiu->regmap, NPCM_FIU_DRD_CFG,
516 NPCM_FIU_DRD_16_BYTE_BURST);
517 regmap_update_bits(fiu->regmap, NPCM_FIU_DRD_CFG,
518 NPCM_FIU_DRD_CFG_ACCTYPE,
519 DRD_SPI_X_MODE << NPCM_FIU_DRD_ACCTYPE_SHIFT);
520 regmap_update_bits(fiu->regmap, NPCM_FIU_DRD_CFG,
521 NPCM_FIU_DRD_CFG_DBW,
522 rx_dummy << NPCM_FIU_DRD_DBW_SHIFT);
523}
524
525static int npcm_fiu_exec_op(struct spi_mem *mem, const struct spi_mem_op *op)
526{
527 struct npcm_fiu_spi *fiu =
528 spi_controller_get_devdata(mem->spi->master);
529 struct npcm_fiu_chip *chip = &fiu->chip[mem->spi->chip_select];
530 int ret = 0;
531 u8 *buf;
532
533 dev_dbg(fiu->dev, "cmd:%#x mode:%d.%d.%d.%d addr:%#llx len:%#x\n",
534 op->cmd.opcode, op->cmd.buswidth, op->addr.buswidth,
535 op->dummy.buswidth, op->data.buswidth, op->addr.val,
536 op->data.nbytes);
537
538 if (fiu->spix_mode || op->addr.nbytes > 4)
539 return -ENOTSUPP;
540
541 if (fiu->clkrate != chip->clkrate) {
542 ret = clk_set_rate(fiu->clk, chip->clkrate);
543 if (ret < 0)
544 dev_warn(fiu->dev, "Failed setting %lu frequency, stay at %lu frequency\n",
545 chip->clkrate, fiu->clkrate);
546 else
547 fiu->clkrate = chip->clkrate;
548 }
549
550 if (op->data.dir == SPI_MEM_DATA_IN) {
551 if (!op->addr.nbytes) {
552 buf = op->data.buf.in;
553 ret = npcm_fiu_uma_read(mem, op, op->addr.val, false,
554 buf, op->data.nbytes);
555 } else {
556 ret = npcm_fiu_read(mem, op);
557 }
558 } else {
559 if (!op->addr.nbytes && !op->data.nbytes)
560 ret = npcm_fiu_uma_write(mem, op, op->cmd.opcode, false,
561 NULL, 0);
562 if (op->addr.nbytes && !op->data.nbytes) {
563 int i;
564 u8 buf_addr[4];
565 u32 addr = op->addr.val;
566
567 for (i = op->addr.nbytes - 1; i >= 0; i--) {
568 buf_addr[i] = addr & 0xff;
569 addr >>= 8;
570 }
571 ret = npcm_fiu_uma_write(mem, op, op->cmd.opcode, false,
572 buf_addr, op->addr.nbytes);
573 }
574 if (!op->addr.nbytes && op->data.nbytes)
575 ret = npcm_fiu_uma_write(mem, op, op->cmd.opcode, false,
576 (u8 *)op->data.buf.out,
577 op->data.nbytes);
578 if (op->addr.nbytes && op->data.nbytes)
579 ret = npcm_fiu_manualwrite(mem, op);
580 }
581
582 return ret;
583}
584
585static int npcm_fiu_dirmap_create(struct spi_mem_dirmap_desc *desc)
586{
587 struct npcm_fiu_spi *fiu =
588 spi_controller_get_devdata(desc->mem->spi->master);
589 struct npcm_fiu_chip *chip = &fiu->chip[desc->mem->spi->chip_select];
590 struct regmap *gcr_regmap;
591
592 if (!fiu->res_mem) {
593 dev_warn(fiu->dev, "Reserved memory not defined, direct read disabled\n");
594 desc->nodirmap = true;
595 return 0;
596 }
597
598 if (!fiu->spix_mode &&
599 desc->info.op_tmpl.data.dir == SPI_MEM_DATA_OUT) {
600 desc->nodirmap = true;
601 return 0;
602 }
603
604 if (!chip->flash_region_mapped_ptr) {
605 chip->flash_region_mapped_ptr =
606 devm_ioremap(fiu->dev, (fiu->res_mem->start +
607 (fiu->info->max_map_size *
608 desc->mem->spi->chip_select)),
609 (u32)desc->info.length);
610 if (!chip->flash_region_mapped_ptr) {
611 dev_warn(fiu->dev, "Error mapping memory region, direct read disabled\n");
612 desc->nodirmap = true;
613 return 0;
614 }
615 }
616
617 if (of_device_is_compatible(fiu->dev->of_node, "nuvoton,npcm750-fiu")) {
618 gcr_regmap =
619 syscon_regmap_lookup_by_compatible("nuvoton,npcm750-gcr");
620 if (IS_ERR(gcr_regmap)) {
621 dev_warn(fiu->dev, "Didn't find nuvoton,npcm750-gcr, direct read disabled\n");
622 desc->nodirmap = true;
623 return 0;
624 }
625 regmap_update_bits(gcr_regmap, NPCM7XX_INTCR3_OFFSET,
626 NPCM7XX_INTCR3_FIU_FIX,
627 NPCM7XX_INTCR3_FIU_FIX);
628 }
629
630 if (desc->info.op_tmpl.data.dir == SPI_MEM_DATA_IN) {
631 if (!fiu->spix_mode)
632 npcm_fiu_set_drd(fiu, &desc->info.op_tmpl);
633 else
634 npcm_fiux_set_direct_rd(fiu);
635
636 } else {
637 npcm_fiux_set_direct_wr(fiu);
638 }
639
640 return 0;
641}
642
643static int npcm_fiu_setup(struct spi_device *spi)
644{
645 struct spi_controller *ctrl = spi->master;
646 struct npcm_fiu_spi *fiu = spi_controller_get_devdata(ctrl);
647 struct npcm_fiu_chip *chip;
648
649 chip = &fiu->chip[spi->chip_select];
650 chip->fiu = fiu;
651 chip->chipselect = spi->chip_select;
652 chip->clkrate = spi->max_speed_hz;
653
654 fiu->clkrate = clk_get_rate(fiu->clk);
655
656 return 0;
657}
658
659static const struct spi_controller_mem_ops npcm_fiu_mem_ops = {
660 .exec_op = npcm_fiu_exec_op,
661 .dirmap_create = npcm_fiu_dirmap_create,
662 .dirmap_read = npcm_fiu_direct_read,
663 .dirmap_write = npcm_fiu_direct_write,
664};
665
666static const struct of_device_id npcm_fiu_dt_ids[] = {
667 { .compatible = "nuvoton,npcm750-fiu", .data = &npxm7xx_fiu_data },
668 { /* sentinel */ }
669};
670
671static int npcm_fiu_probe(struct platform_device *pdev)
672{
673 const struct fiu_data *fiu_data_match;
674 const struct of_device_id *match;
675 struct device *dev = &pdev->dev;
676 struct spi_controller *ctrl;
677 struct npcm_fiu_spi *fiu;
678 void __iomem *regbase;
679 struct resource *res;
680 int ret;
681 int id;
682
683 ctrl = spi_alloc_master(dev, sizeof(*fiu));
684 if (!ctrl)
685 return -ENOMEM;
686
687 fiu = spi_controller_get_devdata(ctrl);
688
689 match = of_match_device(npcm_fiu_dt_ids, dev);
690 if (!match || !match->data) {
691 dev_err(dev, "No compatible OF match\n");
692 return -ENODEV;
693 }
694
695 fiu_data_match = match->data;
696 id = of_alias_get_id(dev->of_node, "fiu");
697 if (id < 0 || id >= fiu_data_match->fiu_max) {
698 dev_err(dev, "Invalid platform device id: %d\n", id);
699 return -EINVAL;
700 }
701
702 fiu->info = &fiu_data_match->npcm_fiu_data_info[id];
703
704 platform_set_drvdata(pdev, fiu);
705 fiu->dev = dev;
706
707 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "control");
708 regbase = devm_ioremap_resource(dev, res);
709 if (IS_ERR(regbase))
710 return PTR_ERR(regbase);
711
712 fiu->regmap = devm_regmap_init_mmio(dev, regbase,
713 &npcm_mtd_regmap_config);
714 if (IS_ERR(fiu->regmap)) {
715 dev_err(dev, "Failed to create regmap\n");
716 return PTR_ERR(fiu->regmap);
717 }
718
719 fiu->res_mem = platform_get_resource_byname(pdev, IORESOURCE_MEM,
720 "memory");
721 fiu->clk = devm_clk_get(dev, NULL);
722 if (IS_ERR(fiu->clk))
723 return PTR_ERR(fiu->clk);
724
725 fiu->spix_mode = of_property_read_bool(dev->of_node,
726 "nuvoton,spix-mode");
727
728 platform_set_drvdata(pdev, fiu);
729 clk_prepare_enable(fiu->clk);
730
731 ctrl->mode_bits = SPI_RX_DUAL | SPI_RX_QUAD
732 | SPI_TX_DUAL | SPI_TX_QUAD;
733 ctrl->setup = npcm_fiu_setup;
734 ctrl->bus_num = -1;
735 ctrl->mem_ops = &npcm_fiu_mem_ops;
736 ctrl->num_chipselect = fiu->info->max_cs;
737 ctrl->dev.of_node = dev->of_node;
738
739 ret = devm_spi_register_master(dev, ctrl);
740 if (ret)
741 return ret;
742
743 return 0;
744}
745
746static int npcm_fiu_remove(struct platform_device *pdev)
747{
748 struct npcm_fiu_spi *fiu = platform_get_drvdata(pdev);
749
750 clk_disable_unprepare(fiu->clk);
751 return 0;
752}
753
754MODULE_DEVICE_TABLE(of, npcm_fiu_dt_ids);
755
756static struct platform_driver npcm_fiu_driver = {
757 .driver = {
758 .name = "NPCM-FIU",
759 .bus = &platform_bus_type,
760 .of_match_table = npcm_fiu_dt_ids,
761 },
762 .probe = npcm_fiu_probe,
763 .remove = npcm_fiu_remove,
764};
765module_platform_driver(npcm_fiu_driver);
766
767MODULE_DESCRIPTION("Nuvoton FLASH Interface Unit SPI Controller Driver");
768MODULE_AUTHOR("Tomer Maimon <tomer.maimon@nuvoton.com>");
769MODULE_LICENSE("GPL v2");