1 // SPDX-License-Identifier: GPL-2.0-only
3 * GPMC support functions
5 * Copyright (C) 2005-2006 Nokia Corporation
9 * Copyright (C) 2009 Texas Instruments
10 * Added OMAP4 support - Santosh Shilimkar <santosh.shilimkar@ti.com>
12 #include <linux/irq.h>
13 #include <linux/kernel.h>
14 #include <linux/init.h>
15 #include <linux/err.h>
16 #include <linux/clk.h>
17 #include <linux/ioport.h>
18 #include <linux/spinlock.h>
20 #include <linux/gpio/driver.h>
21 #include <linux/gpio/consumer.h> /* GPIO descriptor enum */
22 #include <linux/gpio/machine.h>
23 #include <linux/interrupt.h>
24 #include <linux/irqdomain.h>
25 #include <linux/platform_device.h>
27 #include <linux/of_address.h>
28 #include <linux/of_device.h>
29 #include <linux/of_platform.h>
30 #include <linux/omap-gpmc.h>
31 #include <linux/pm_runtime.h>
32 #include <linux/sizes.h>
34 #include <linux/platform_data/mtd-nand-omap2.h>
36 #include <asm/mach-types.h>
38 #define DEVICE_NAME "omap-gpmc"
40 /* GPMC register offsets */
41 #define GPMC_REVISION 0x00
42 #define GPMC_SYSCONFIG 0x10
43 #define GPMC_SYSSTATUS 0x14
44 #define GPMC_IRQSTATUS 0x18
45 #define GPMC_IRQENABLE 0x1c
46 #define GPMC_TIMEOUT_CONTROL 0x40
47 #define GPMC_ERR_ADDRESS 0x44
48 #define GPMC_ERR_TYPE 0x48
49 #define GPMC_CONFIG 0x50
50 #define GPMC_STATUS 0x54
51 #define GPMC_PREFETCH_CONFIG1 0x1e0
52 #define GPMC_PREFETCH_CONFIG2 0x1e4
53 #define GPMC_PREFETCH_CONTROL 0x1ec
54 #define GPMC_PREFETCH_STATUS 0x1f0
55 #define GPMC_ECC_CONFIG 0x1f4
56 #define GPMC_ECC_CONTROL 0x1f8
57 #define GPMC_ECC_SIZE_CONFIG 0x1fc
58 #define GPMC_ECC1_RESULT 0x200
59 #define GPMC_ECC_BCH_RESULT_0 0x240 /* not available on OMAP2 */
60 #define GPMC_ECC_BCH_RESULT_1 0x244 /* not available on OMAP2 */
61 #define GPMC_ECC_BCH_RESULT_2 0x248 /* not available on OMAP2 */
62 #define GPMC_ECC_BCH_RESULT_3 0x24c /* not available on OMAP2 */
63 #define GPMC_ECC_BCH_RESULT_4 0x300 /* not available on OMAP2 */
64 #define GPMC_ECC_BCH_RESULT_5 0x304 /* not available on OMAP2 */
65 #define GPMC_ECC_BCH_RESULT_6 0x308 /* not available on OMAP2 */
67 /* GPMC ECC control settings */
68 #define GPMC_ECC_CTRL_ECCCLEAR 0x100
69 #define GPMC_ECC_CTRL_ECCDISABLE 0x000
70 #define GPMC_ECC_CTRL_ECCREG1 0x001
71 #define GPMC_ECC_CTRL_ECCREG2 0x002
72 #define GPMC_ECC_CTRL_ECCREG3 0x003
73 #define GPMC_ECC_CTRL_ECCREG4 0x004
74 #define GPMC_ECC_CTRL_ECCREG5 0x005
75 #define GPMC_ECC_CTRL_ECCREG6 0x006
76 #define GPMC_ECC_CTRL_ECCREG7 0x007
77 #define GPMC_ECC_CTRL_ECCREG8 0x008
78 #define GPMC_ECC_CTRL_ECCREG9 0x009
80 #define GPMC_CONFIG_LIMITEDADDRESS BIT(1)
82 #define GPMC_STATUS_EMPTYWRITEBUFFERSTATUS BIT(0)
84 #define GPMC_CONFIG2_CSEXTRADELAY BIT(7)
85 #define GPMC_CONFIG3_ADVEXTRADELAY BIT(7)
86 #define GPMC_CONFIG4_OEEXTRADELAY BIT(7)
87 #define GPMC_CONFIG4_WEEXTRADELAY BIT(23)
88 #define GPMC_CONFIG6_CYCLE2CYCLEDIFFCSEN BIT(6)
89 #define GPMC_CONFIG6_CYCLE2CYCLESAMECSEN BIT(7)
91 #define GPMC_CS0_OFFSET 0x60
92 #define GPMC_CS_SIZE 0x30
93 #define GPMC_BCH_SIZE 0x10
96 * The first 1MB of GPMC address space is typically mapped to
97 * the internal ROM. Never allocate the first page, to
98 * facilitate bug detection; even if we didn't boot from ROM.
99 * As GPMC minimum partition size is 16MB we can only start from
102 #define GPMC_MEM_START 0x1000000
103 #define GPMC_MEM_END 0x3FFFFFFF
105 #define GPMC_CHUNK_SHIFT 24 /* 16 MB */
106 #define GPMC_SECTION_SHIFT 28 /* 128 MB */
108 #define CS_NUM_SHIFT 24
109 #define ENABLE_PREFETCH (0x1 << 7)
110 #define DMA_MPU_MODE 2
112 #define GPMC_REVISION_MAJOR(l) (((l) >> 4) & 0xf)
113 #define GPMC_REVISION_MINOR(l) ((l) & 0xf)
115 #define GPMC_HAS_WR_ACCESS 0x1
116 #define GPMC_HAS_WR_DATA_MUX_BUS 0x2
117 #define GPMC_HAS_MUX_AAD 0x4
119 #define GPMC_NR_WAITPINS 4
121 #define GPMC_CS_CONFIG1 0x00
122 #define GPMC_CS_CONFIG2 0x04
123 #define GPMC_CS_CONFIG3 0x08
124 #define GPMC_CS_CONFIG4 0x0c
125 #define GPMC_CS_CONFIG5 0x10
126 #define GPMC_CS_CONFIG6 0x14
127 #define GPMC_CS_CONFIG7 0x18
128 #define GPMC_CS_NAND_COMMAND 0x1c
129 #define GPMC_CS_NAND_ADDRESS 0x20
130 #define GPMC_CS_NAND_DATA 0x24
132 /* Control Commands */
133 #define GPMC_CONFIG_RDY_BSY 0x00000001
134 #define GPMC_CONFIG_DEV_SIZE 0x00000002
135 #define GPMC_CONFIG_DEV_TYPE 0x00000003
137 #define GPMC_CONFIG1_WRAPBURST_SUPP (1 << 31)
138 #define GPMC_CONFIG1_READMULTIPLE_SUPP (1 << 30)
139 #define GPMC_CONFIG1_READTYPE_ASYNC (0 << 29)
140 #define GPMC_CONFIG1_READTYPE_SYNC (1 << 29)
141 #define GPMC_CONFIG1_WRITEMULTIPLE_SUPP (1 << 28)
142 #define GPMC_CONFIG1_WRITETYPE_ASYNC (0 << 27)
143 #define GPMC_CONFIG1_WRITETYPE_SYNC (1 << 27)
144 #define GPMC_CONFIG1_CLKACTIVATIONTIME(val) (((val) & 3) << 25)
145 /** CLKACTIVATIONTIME Max Ticks */
146 #define GPMC_CONFIG1_CLKACTIVATIONTIME_MAX 2
147 #define GPMC_CONFIG1_PAGE_LEN(val) (((val) & 3) << 23)
148 /** ATTACHEDDEVICEPAGELENGTH Max Value */
149 #define GPMC_CONFIG1_ATTACHEDDEVICEPAGELENGTH_MAX 2
150 #define GPMC_CONFIG1_WAIT_READ_MON (1 << 22)
151 #define GPMC_CONFIG1_WAIT_WRITE_MON (1 << 21)
152 #define GPMC_CONFIG1_WAIT_MON_TIME(val) (((val) & 3) << 18)
153 /** WAITMONITORINGTIME Max Ticks */
154 #define GPMC_CONFIG1_WAITMONITORINGTIME_MAX 2
155 #define GPMC_CONFIG1_WAIT_PIN_SEL(val) (((val) & 3) << 16)
156 #define GPMC_CONFIG1_DEVICESIZE(val) (((val) & 3) << 12)
157 #define GPMC_CONFIG1_DEVICESIZE_16 GPMC_CONFIG1_DEVICESIZE(1)
158 /** DEVICESIZE Max Value */
159 #define GPMC_CONFIG1_DEVICESIZE_MAX 1
160 #define GPMC_CONFIG1_DEVICETYPE(val) (((val) & 3) << 10)
161 #define GPMC_CONFIG1_DEVICETYPE_NOR GPMC_CONFIG1_DEVICETYPE(0)
162 #define GPMC_CONFIG1_MUXTYPE(val) (((val) & 3) << 8)
163 #define GPMC_CONFIG1_TIME_PARA_GRAN (1 << 4)
164 #define GPMC_CONFIG1_FCLK_DIV(val) ((val) & 3)
165 #define GPMC_CONFIG1_FCLK_DIV2 (GPMC_CONFIG1_FCLK_DIV(1))
166 #define GPMC_CONFIG1_FCLK_DIV3 (GPMC_CONFIG1_FCLK_DIV(2))
167 #define GPMC_CONFIG1_FCLK_DIV4 (GPMC_CONFIG1_FCLK_DIV(3))
168 #define GPMC_CONFIG7_CSVALID (1 << 6)
170 #define GPMC_CONFIG7_BASEADDRESS_MASK 0x3f
171 #define GPMC_CONFIG7_CSVALID_MASK BIT(6)
172 #define GPMC_CONFIG7_MASKADDRESS_OFFSET 8
173 #define GPMC_CONFIG7_MASKADDRESS_MASK (0xf << GPMC_CONFIG7_MASKADDRESS_OFFSET)
174 /* All CONFIG7 bits except reserved bits */
175 #define GPMC_CONFIG7_MASK (GPMC_CONFIG7_BASEADDRESS_MASK | \
176 GPMC_CONFIG7_CSVALID_MASK | \
177 GPMC_CONFIG7_MASKADDRESS_MASK)
179 #define GPMC_DEVICETYPE_NOR 0
180 #define GPMC_DEVICETYPE_NAND 2
181 #define GPMC_CONFIG_WRITEPROTECT 0x00000010
182 #define WR_RD_PIN_MONITORING 0x00600000
185 #define GPMC_ECC_READ 0 /* Reset Hardware ECC for read */
186 #define GPMC_ECC_WRITE 1 /* Reset Hardware ECC for write */
187 #define GPMC_ECC_READSYN 2 /* Reset before syndrom is read back */
189 #define GPMC_NR_NAND_IRQS 2 /* number of NAND specific IRQs */
191 enum gpmc_clk_domain {
196 struct gpmc_cs_data {
199 #define GPMC_CS_RESERVED (1 << 0)
205 /* Structure to save gpmc cs context */
206 struct gpmc_cs_config {
218 * Structure to save/restore gpmc context
219 * to support core off on OMAP3
221 struct omap3_gpmc_regs {
226 u32 prefetch_config1;
227 u32 prefetch_config2;
228 u32 prefetch_control;
229 struct gpmc_cs_config cs_context[GPMC_CS_NUM];
235 struct irq_chip irq_chip;
236 struct gpio_chip gpio_chip;
240 static struct irq_domain *gpmc_irq_domain;
242 static struct resource gpmc_mem_root;
243 static struct gpmc_cs_data gpmc_cs[GPMC_CS_NUM];
244 static DEFINE_SPINLOCK(gpmc_mem_lock);
245 /* Define chip-selects as reserved by default until probe completes */
246 static unsigned int gpmc_cs_num = GPMC_CS_NUM;
247 static unsigned int gpmc_nr_waitpins;
248 static resource_size_t phys_base, mem_size;
249 static unsigned int gpmc_capability;
250 static void __iomem *gpmc_base;
252 static struct clk *gpmc_l3_clk;
254 static irqreturn_t gpmc_handle_irq(int irq, void *dev);
256 static void gpmc_write_reg(int idx, u32 val)
258 writel_relaxed(val, gpmc_base + idx);
261 static u32 gpmc_read_reg(int idx)
263 return readl_relaxed(gpmc_base + idx);
266 void gpmc_cs_write_reg(int cs, int idx, u32 val)
268 void __iomem *reg_addr;
270 reg_addr = gpmc_base + GPMC_CS0_OFFSET + (cs * GPMC_CS_SIZE) + idx;
271 writel_relaxed(val, reg_addr);
274 static u32 gpmc_cs_read_reg(int cs, int idx)
276 void __iomem *reg_addr;
278 reg_addr = gpmc_base + GPMC_CS0_OFFSET + (cs * GPMC_CS_SIZE) + idx;
279 return readl_relaxed(reg_addr);
282 /* TODO: Add support for gpmc_fck to clock framework and use it */
283 static unsigned long gpmc_get_fclk_period(void)
285 unsigned long rate = clk_get_rate(gpmc_l3_clk);
288 rate = 1000000000 / rate; /* In picoseconds */
294 * gpmc_get_clk_period - get period of selected clock domain in ps
295 * @cs: Chip Select Region.
298 * GPMC_CS_CONFIG1 GPMCFCLKDIVIDER for cs has to be setup
299 * prior to calling this function with GPMC_CD_CLK.
301 static unsigned long gpmc_get_clk_period(int cs, enum gpmc_clk_domain cd)
303 unsigned long tick_ps = gpmc_get_fclk_period();
309 /* get current clk divider */
310 l = gpmc_cs_read_reg(cs, GPMC_CS_CONFIG1);
311 div = (l & 0x03) + 1;
312 /* get GPMC_CLK period */
323 static unsigned int gpmc_ns_to_clk_ticks(unsigned int time_ns, int cs,
324 enum gpmc_clk_domain cd)
326 unsigned long tick_ps;
328 /* Calculate in picosecs to yield more exact results */
329 tick_ps = gpmc_get_clk_period(cs, cd);
331 return (time_ns * 1000 + tick_ps - 1) / tick_ps;
334 static unsigned int gpmc_ns_to_ticks(unsigned int time_ns)
336 return gpmc_ns_to_clk_ticks(time_ns, /* any CS */ 0, GPMC_CD_FCLK);
339 static unsigned int gpmc_ps_to_ticks(unsigned int time_ps)
341 unsigned long tick_ps;
343 /* Calculate in picosecs to yield more exact results */
344 tick_ps = gpmc_get_fclk_period();
346 return (time_ps + tick_ps - 1) / tick_ps;
349 static unsigned int gpmc_clk_ticks_to_ns(unsigned int ticks, int cs,
350 enum gpmc_clk_domain cd)
352 return ticks * gpmc_get_clk_period(cs, cd) / 1000;
355 unsigned int gpmc_ticks_to_ns(unsigned int ticks)
357 return gpmc_clk_ticks_to_ns(ticks, /* any CS */ 0, GPMC_CD_FCLK);
360 static unsigned int gpmc_ticks_to_ps(unsigned int ticks)
362 return ticks * gpmc_get_fclk_period();
365 static unsigned int gpmc_round_ps_to_ticks(unsigned int time_ps)
367 unsigned long ticks = gpmc_ps_to_ticks(time_ps);
369 return ticks * gpmc_get_fclk_period();
372 static inline void gpmc_cs_modify_reg(int cs, int reg, u32 mask, bool value)
376 l = gpmc_cs_read_reg(cs, reg);
381 gpmc_cs_write_reg(cs, reg, l);
384 static void gpmc_cs_bool_timings(int cs, const struct gpmc_bool_timings *p)
386 gpmc_cs_modify_reg(cs, GPMC_CS_CONFIG1,
387 GPMC_CONFIG1_TIME_PARA_GRAN,
388 p->time_para_granularity);
389 gpmc_cs_modify_reg(cs, GPMC_CS_CONFIG2,
390 GPMC_CONFIG2_CSEXTRADELAY, p->cs_extra_delay);
391 gpmc_cs_modify_reg(cs, GPMC_CS_CONFIG3,
392 GPMC_CONFIG3_ADVEXTRADELAY, p->adv_extra_delay);
393 gpmc_cs_modify_reg(cs, GPMC_CS_CONFIG4,
394 GPMC_CONFIG4_OEEXTRADELAY, p->oe_extra_delay);
395 gpmc_cs_modify_reg(cs, GPMC_CS_CONFIG4,
396 GPMC_CONFIG4_WEEXTRADELAY, p->we_extra_delay);
397 gpmc_cs_modify_reg(cs, GPMC_CS_CONFIG6,
398 GPMC_CONFIG6_CYCLE2CYCLESAMECSEN,
399 p->cycle2cyclesamecsen);
400 gpmc_cs_modify_reg(cs, GPMC_CS_CONFIG6,
401 GPMC_CONFIG6_CYCLE2CYCLEDIFFCSEN,
402 p->cycle2cyclediffcsen);
405 #ifdef CONFIG_OMAP_GPMC_DEBUG
407 * get_gpmc_timing_reg - read a timing parameter and print DTS settings for it.
408 * @cs: Chip Select Region
409 * @reg: GPMC_CS_CONFIGn register offset.
411 * @end_bit: End Bit. Must be >= @st_bit.
412 * @max: Maximum parameter value (before optional @shift).
413 * If 0, maximum is as high as @st_bit and @end_bit allow.
414 * @name: DTS node name, w/o "gpmc,"
415 * @cd: Clock Domain of timing parameter.
416 * @shift: Parameter value left shifts @shift, which is then printed instead of value.
417 * @raw: Raw Format Option.
418 * raw format: gpmc,name = <value>
419 * tick format: gpmc,name = <value> /‍* x ns -- y ns; x ticks *‍/
420 * Where x ns -- y ns result in the same tick value.
421 * When @max is exceeded, "invalid" is printed inside comment.
422 * @noval: Parameter values equal to 0 are not printed.
423 * @return: Specified timing parameter (after optional @shift).
426 static int get_gpmc_timing_reg(
427 /* timing specifiers */
428 int cs, int reg, int st_bit, int end_bit, int max,
429 const char *name, const enum gpmc_clk_domain cd,
430 /* value transform */
432 /* format specifiers */
433 bool raw, bool noval)
440 l = gpmc_cs_read_reg(cs, reg);
441 nr_bits = end_bit - st_bit + 1;
442 mask = (1 << nr_bits) - 1;
443 l = (l >> st_bit) & mask;
449 if (noval && (l == 0))
452 /* DTS tick format for timings in ns */
453 unsigned int time_ns;
454 unsigned int time_ns_min = 0;
457 time_ns_min = gpmc_clk_ticks_to_ns(l - 1, cs, cd) + 1;
458 time_ns = gpmc_clk_ticks_to_ns(l, cs, cd);
459 pr_info("gpmc,%s = <%u>; /* %u ns - %u ns; %i ticks%s*/\n",
460 name, time_ns, time_ns_min, time_ns, l,
461 invalid ? "; invalid " : " ");
464 pr_info("gpmc,%s = <%u>;%s\n", name, l,
465 invalid ? " /* invalid */" : "");
471 #define GPMC_PRINT_CONFIG(cs, config) \
472 pr_info("cs%i %s: 0x%08x\n", cs, #config, \
473 gpmc_cs_read_reg(cs, config))
474 #define GPMC_GET_RAW(reg, st, end, field) \
475 get_gpmc_timing_reg(cs, (reg), (st), (end), 0, field, GPMC_CD_FCLK, 0, 1, 0)
476 #define GPMC_GET_RAW_MAX(reg, st, end, max, field) \
477 get_gpmc_timing_reg(cs, (reg), (st), (end), (max), field, GPMC_CD_FCLK, 0, 1, 0)
478 #define GPMC_GET_RAW_BOOL(reg, st, end, field) \
479 get_gpmc_timing_reg(cs, (reg), (st), (end), 0, field, GPMC_CD_FCLK, 0, 1, 1)
480 #define GPMC_GET_RAW_SHIFT_MAX(reg, st, end, shift, max, field) \
481 get_gpmc_timing_reg(cs, (reg), (st), (end), (max), field, GPMC_CD_FCLK, (shift), 1, 1)
482 #define GPMC_GET_TICKS(reg, st, end, field) \
483 get_gpmc_timing_reg(cs, (reg), (st), (end), 0, field, GPMC_CD_FCLK, 0, 0, 0)
484 #define GPMC_GET_TICKS_CD(reg, st, end, field, cd) \
485 get_gpmc_timing_reg(cs, (reg), (st), (end), 0, field, (cd), 0, 0, 0)
486 #define GPMC_GET_TICKS_CD_MAX(reg, st, end, max, field, cd) \
487 get_gpmc_timing_reg(cs, (reg), (st), (end), (max), field, (cd), 0, 0, 0)
489 static void gpmc_show_regs(int cs, const char *desc)
491 pr_info("gpmc cs%i %s:\n", cs, desc);
492 GPMC_PRINT_CONFIG(cs, GPMC_CS_CONFIG1);
493 GPMC_PRINT_CONFIG(cs, GPMC_CS_CONFIG2);
494 GPMC_PRINT_CONFIG(cs, GPMC_CS_CONFIG3);
495 GPMC_PRINT_CONFIG(cs, GPMC_CS_CONFIG4);
496 GPMC_PRINT_CONFIG(cs, GPMC_CS_CONFIG5);
497 GPMC_PRINT_CONFIG(cs, GPMC_CS_CONFIG6);
501 * Note that gpmc,wait-pin handing wrongly assumes bit 8 is available,
502 * see commit c9fb809.
504 static void gpmc_cs_show_timings(int cs, const char *desc)
506 gpmc_show_regs(cs, desc);
508 pr_info("gpmc cs%i access configuration:\n", cs);
509 GPMC_GET_RAW_BOOL(GPMC_CS_CONFIG1, 4, 4, "time-para-granularity");
510 GPMC_GET_RAW(GPMC_CS_CONFIG1, 8, 9, "mux-add-data");
511 GPMC_GET_RAW_SHIFT_MAX(GPMC_CS_CONFIG1, 12, 13, 1,
512 GPMC_CONFIG1_DEVICESIZE_MAX, "device-width");
513 GPMC_GET_RAW(GPMC_CS_CONFIG1, 16, 17, "wait-pin");
514 GPMC_GET_RAW_BOOL(GPMC_CS_CONFIG1, 21, 21, "wait-on-write");
515 GPMC_GET_RAW_BOOL(GPMC_CS_CONFIG1, 22, 22, "wait-on-read");
516 GPMC_GET_RAW_SHIFT_MAX(GPMC_CS_CONFIG1, 23, 24, 4,
517 GPMC_CONFIG1_ATTACHEDDEVICEPAGELENGTH_MAX,
519 GPMC_GET_RAW_BOOL(GPMC_CS_CONFIG1, 27, 27, "sync-write");
520 GPMC_GET_RAW_BOOL(GPMC_CS_CONFIG1, 28, 28, "burst-write");
521 GPMC_GET_RAW_BOOL(GPMC_CS_CONFIG1, 29, 29, "gpmc,sync-read");
522 GPMC_GET_RAW_BOOL(GPMC_CS_CONFIG1, 30, 30, "burst-read");
523 GPMC_GET_RAW_BOOL(GPMC_CS_CONFIG1, 31, 31, "burst-wrap");
525 GPMC_GET_RAW_BOOL(GPMC_CS_CONFIG2, 7, 7, "cs-extra-delay");
527 GPMC_GET_RAW_BOOL(GPMC_CS_CONFIG3, 7, 7, "adv-extra-delay");
529 GPMC_GET_RAW_BOOL(GPMC_CS_CONFIG4, 23, 23, "we-extra-delay");
530 GPMC_GET_RAW_BOOL(GPMC_CS_CONFIG4, 7, 7, "oe-extra-delay");
532 GPMC_GET_RAW_BOOL(GPMC_CS_CONFIG6, 7, 7, "cycle2cycle-samecsen");
533 GPMC_GET_RAW_BOOL(GPMC_CS_CONFIG6, 6, 6, "cycle2cycle-diffcsen");
535 pr_info("gpmc cs%i timings configuration:\n", cs);
536 GPMC_GET_TICKS(GPMC_CS_CONFIG2, 0, 3, "cs-on-ns");
537 GPMC_GET_TICKS(GPMC_CS_CONFIG2, 8, 12, "cs-rd-off-ns");
538 GPMC_GET_TICKS(GPMC_CS_CONFIG2, 16, 20, "cs-wr-off-ns");
540 GPMC_GET_TICKS(GPMC_CS_CONFIG3, 0, 3, "adv-on-ns");
541 GPMC_GET_TICKS(GPMC_CS_CONFIG3, 8, 12, "adv-rd-off-ns");
542 GPMC_GET_TICKS(GPMC_CS_CONFIG3, 16, 20, "adv-wr-off-ns");
543 if (gpmc_capability & GPMC_HAS_MUX_AAD) {
544 GPMC_GET_TICKS(GPMC_CS_CONFIG3, 4, 6, "adv-aad-mux-on-ns");
545 GPMC_GET_TICKS(GPMC_CS_CONFIG3, 24, 26,
546 "adv-aad-mux-rd-off-ns");
547 GPMC_GET_TICKS(GPMC_CS_CONFIG3, 28, 30,
548 "adv-aad-mux-wr-off-ns");
551 GPMC_GET_TICKS(GPMC_CS_CONFIG4, 0, 3, "oe-on-ns");
552 GPMC_GET_TICKS(GPMC_CS_CONFIG4, 8, 12, "oe-off-ns");
553 if (gpmc_capability & GPMC_HAS_MUX_AAD) {
554 GPMC_GET_TICKS(GPMC_CS_CONFIG4, 4, 6, "oe-aad-mux-on-ns");
555 GPMC_GET_TICKS(GPMC_CS_CONFIG4, 13, 15, "oe-aad-mux-off-ns");
557 GPMC_GET_TICKS(GPMC_CS_CONFIG4, 16, 19, "we-on-ns");
558 GPMC_GET_TICKS(GPMC_CS_CONFIG4, 24, 28, "we-off-ns");
560 GPMC_GET_TICKS(GPMC_CS_CONFIG5, 0, 4, "rd-cycle-ns");
561 GPMC_GET_TICKS(GPMC_CS_CONFIG5, 8, 12, "wr-cycle-ns");
562 GPMC_GET_TICKS(GPMC_CS_CONFIG5, 16, 20, "access-ns");
564 GPMC_GET_TICKS(GPMC_CS_CONFIG5, 24, 27, "page-burst-access-ns");
566 GPMC_GET_TICKS(GPMC_CS_CONFIG6, 0, 3, "bus-turnaround-ns");
567 GPMC_GET_TICKS(GPMC_CS_CONFIG6, 8, 11, "cycle2cycle-delay-ns");
569 GPMC_GET_TICKS_CD_MAX(GPMC_CS_CONFIG1, 18, 19,
570 GPMC_CONFIG1_WAITMONITORINGTIME_MAX,
571 "wait-monitoring-ns", GPMC_CD_CLK);
572 GPMC_GET_TICKS_CD_MAX(GPMC_CS_CONFIG1, 25, 26,
573 GPMC_CONFIG1_CLKACTIVATIONTIME_MAX,
574 "clk-activation-ns", GPMC_CD_FCLK);
576 GPMC_GET_TICKS(GPMC_CS_CONFIG6, 16, 19, "wr-data-mux-bus-ns");
577 GPMC_GET_TICKS(GPMC_CS_CONFIG6, 24, 28, "wr-access-ns");
580 static inline void gpmc_cs_show_timings(int cs, const char *desc)
586 * set_gpmc_timing_reg - set a single timing parameter for Chip Select Region.
587 * Caller is expected to have initialized CONFIG1 GPMCFCLKDIVIDER
588 * prior to calling this function with @cd equal to GPMC_CD_CLK.
590 * @cs: Chip Select Region.
591 * @reg: GPMC_CS_CONFIGn register offset.
593 * @end_bit: End Bit. Must be >= @st_bit.
594 * @max: Maximum parameter value.
595 * If 0, maximum is as high as @st_bit and @end_bit allow.
596 * @time: Timing parameter in ns.
597 * @cd: Timing parameter clock domain.
598 * @name: Timing parameter name.
599 * @return: 0 on success, -1 on error.
601 static int set_gpmc_timing_reg(int cs, int reg, int st_bit, int end_bit, int max,
602 int time, enum gpmc_clk_domain cd, const char *name)
605 int ticks, mask, nr_bits;
610 ticks = gpmc_ns_to_clk_ticks(time, cs, cd);
611 nr_bits = end_bit - st_bit + 1;
612 mask = (1 << nr_bits) - 1;
618 pr_err("%s: GPMC CS%d: %s %d ns, %d ticks > %d ticks\n",
619 __func__, cs, name, time, ticks, max);
624 l = gpmc_cs_read_reg(cs, reg);
625 #ifdef CONFIG_OMAP_GPMC_DEBUG
626 pr_info("GPMC CS%d: %-17s: %3d ticks, %3lu ns (was %3i ticks) %3d ns\n",
627 cs, name, ticks, gpmc_get_clk_period(cs, cd) * ticks / 1000,
628 (l >> st_bit) & mask, time);
630 l &= ~(mask << st_bit);
631 l |= ticks << st_bit;
632 gpmc_cs_write_reg(cs, reg, l);
637 #define GPMC_SET_ONE_CD_MAX(reg, st, end, max, field, cd) \
638 if (set_gpmc_timing_reg(cs, (reg), (st), (end), (max), \
639 t->field, (cd), #field) < 0) \
642 #define GPMC_SET_ONE(reg, st, end, field) \
643 GPMC_SET_ONE_CD_MAX(reg, st, end, 0, field, GPMC_CD_FCLK)
646 * gpmc_calc_waitmonitoring_divider - calculate proper GPMCFCLKDIVIDER based on WAITMONITORINGTIME
647 * WAITMONITORINGTIME will be _at least_ as long as desired, i.e.
648 * read --> don't sample bus too early
649 * write --> data is longer on bus
652 * gpmc_clk_div + 1 = ceil(ceil(waitmonitoringtime_ns / gpmc_fclk_ns)
653 * / waitmonitoring_ticks)
654 * WAITMONITORINGTIME resulting in 0 or 1 tick with div = 1 are caught by
657 * @wait_monitoring: WAITMONITORINGTIME in ns.
658 * @return: -1 on failure to scale, else proper divider > 0.
660 static int gpmc_calc_waitmonitoring_divider(unsigned int wait_monitoring)
662 int div = gpmc_ns_to_ticks(wait_monitoring);
664 div += GPMC_CONFIG1_WAITMONITORINGTIME_MAX - 1;
665 div /= GPMC_CONFIG1_WAITMONITORINGTIME_MAX;
676 * gpmc_calc_divider - calculate GPMC_FCLK divider for sync_clk GPMC_CLK period.
677 * @sync_clk: GPMC_CLK period in ps.
678 * @return: Returns at least 1 if GPMC_FCLK can be divided to GPMC_CLK.
681 int gpmc_calc_divider(unsigned int sync_clk)
683 int div = gpmc_ps_to_ticks(sync_clk);
694 * gpmc_cs_set_timings - program timing parameters for Chip Select Region.
695 * @cs: Chip Select Region.
696 * @t: GPMC timing parameters.
697 * @s: GPMC timing settings.
698 * @return: 0 on success, -1 on error.
700 int gpmc_cs_set_timings(int cs, const struct gpmc_timings *t,
701 const struct gpmc_settings *s)
706 div = gpmc_calc_divider(t->sync_clk);
711 * See if we need to change the divider for waitmonitoringtime.
713 * Calculate GPMCFCLKDIVIDER independent of gpmc,sync-clk-ps in DT for
714 * pure asynchronous accesses, i.e. both read and write asynchronous.
715 * However, only do so if WAITMONITORINGTIME is actually used, i.e.
716 * either WAITREADMONITORING or WAITWRITEMONITORING is set.
718 * This statement must not change div to scale async WAITMONITORINGTIME
719 * to protect mixed synchronous and asynchronous accesses.
721 * We raise an error later if WAITMONITORINGTIME does not fit.
723 if (!s->sync_read && !s->sync_write &&
724 (s->wait_on_read || s->wait_on_write)
726 div = gpmc_calc_waitmonitoring_divider(t->wait_monitoring);
728 pr_err("%s: waitmonitoringtime %3d ns too large for greatest gpmcfclkdivider.\n",
736 GPMC_SET_ONE(GPMC_CS_CONFIG2, 0, 3, cs_on);
737 GPMC_SET_ONE(GPMC_CS_CONFIG2, 8, 12, cs_rd_off);
738 GPMC_SET_ONE(GPMC_CS_CONFIG2, 16, 20, cs_wr_off);
740 GPMC_SET_ONE(GPMC_CS_CONFIG3, 0, 3, adv_on);
741 GPMC_SET_ONE(GPMC_CS_CONFIG3, 8, 12, adv_rd_off);
742 GPMC_SET_ONE(GPMC_CS_CONFIG3, 16, 20, adv_wr_off);
743 if (gpmc_capability & GPMC_HAS_MUX_AAD) {
744 GPMC_SET_ONE(GPMC_CS_CONFIG3, 4, 6, adv_aad_mux_on);
745 GPMC_SET_ONE(GPMC_CS_CONFIG3, 24, 26, adv_aad_mux_rd_off);
746 GPMC_SET_ONE(GPMC_CS_CONFIG3, 28, 30, adv_aad_mux_wr_off);
749 GPMC_SET_ONE(GPMC_CS_CONFIG4, 0, 3, oe_on);
750 GPMC_SET_ONE(GPMC_CS_CONFIG4, 8, 12, oe_off);
751 if (gpmc_capability & GPMC_HAS_MUX_AAD) {
752 GPMC_SET_ONE(GPMC_CS_CONFIG4, 4, 6, oe_aad_mux_on);
753 GPMC_SET_ONE(GPMC_CS_CONFIG4, 13, 15, oe_aad_mux_off);
755 GPMC_SET_ONE(GPMC_CS_CONFIG4, 16, 19, we_on);
756 GPMC_SET_ONE(GPMC_CS_CONFIG4, 24, 28, we_off);
758 GPMC_SET_ONE(GPMC_CS_CONFIG5, 0, 4, rd_cycle);
759 GPMC_SET_ONE(GPMC_CS_CONFIG5, 8, 12, wr_cycle);
760 GPMC_SET_ONE(GPMC_CS_CONFIG5, 16, 20, access);
762 GPMC_SET_ONE(GPMC_CS_CONFIG5, 24, 27, page_burst_access);
764 GPMC_SET_ONE(GPMC_CS_CONFIG6, 0, 3, bus_turnaround);
765 GPMC_SET_ONE(GPMC_CS_CONFIG6, 8, 11, cycle2cycle_delay);
767 if (gpmc_capability & GPMC_HAS_WR_DATA_MUX_BUS)
768 GPMC_SET_ONE(GPMC_CS_CONFIG6, 16, 19, wr_data_mux_bus);
769 if (gpmc_capability & GPMC_HAS_WR_ACCESS)
770 GPMC_SET_ONE(GPMC_CS_CONFIG6, 24, 28, wr_access);
772 l = gpmc_cs_read_reg(cs, GPMC_CS_CONFIG1);
775 gpmc_cs_write_reg(cs, GPMC_CS_CONFIG1, l);
777 GPMC_SET_ONE_CD_MAX(GPMC_CS_CONFIG1, 18, 19,
778 GPMC_CONFIG1_WAITMONITORINGTIME_MAX,
779 wait_monitoring, GPMC_CD_CLK);
780 GPMC_SET_ONE_CD_MAX(GPMC_CS_CONFIG1, 25, 26,
781 GPMC_CONFIG1_CLKACTIVATIONTIME_MAX,
782 clk_activation, GPMC_CD_FCLK);
784 #ifdef CONFIG_OMAP_GPMC_DEBUG
785 pr_info("GPMC CS%d CLK period is %lu ns (div %d)\n",
786 cs, (div * gpmc_get_fclk_period()) / 1000, div);
789 gpmc_cs_bool_timings(cs, &t->bool_timings);
790 gpmc_cs_show_timings(cs, "after gpmc_cs_set_timings");
795 static int gpmc_cs_set_memconf(int cs, u32 base, u32 size)
801 * Ensure that base address is aligned on a
802 * boundary equal to or greater than size.
804 if (base & (size - 1))
807 base >>= GPMC_CHUNK_SHIFT;
808 mask = (1 << GPMC_SECTION_SHIFT) - size;
809 mask >>= GPMC_CHUNK_SHIFT;
810 mask <<= GPMC_CONFIG7_MASKADDRESS_OFFSET;
812 l = gpmc_cs_read_reg(cs, GPMC_CS_CONFIG7);
813 l &= ~GPMC_CONFIG7_MASK;
814 l |= base & GPMC_CONFIG7_BASEADDRESS_MASK;
815 l |= mask & GPMC_CONFIG7_MASKADDRESS_MASK;
816 l |= GPMC_CONFIG7_CSVALID;
817 gpmc_cs_write_reg(cs, GPMC_CS_CONFIG7, l);
822 static void gpmc_cs_enable_mem(int cs)
826 l = gpmc_cs_read_reg(cs, GPMC_CS_CONFIG7);
827 l |= GPMC_CONFIG7_CSVALID;
828 gpmc_cs_write_reg(cs, GPMC_CS_CONFIG7, l);
831 static void gpmc_cs_disable_mem(int cs)
835 l = gpmc_cs_read_reg(cs, GPMC_CS_CONFIG7);
836 l &= ~GPMC_CONFIG7_CSVALID;
837 gpmc_cs_write_reg(cs, GPMC_CS_CONFIG7, l);
840 static void gpmc_cs_get_memconf(int cs, u32 *base, u32 *size)
845 l = gpmc_cs_read_reg(cs, GPMC_CS_CONFIG7);
846 *base = (l & 0x3f) << GPMC_CHUNK_SHIFT;
847 mask = (l >> 8) & 0x0f;
848 *size = (1 << GPMC_SECTION_SHIFT) - (mask << GPMC_CHUNK_SHIFT);
851 static int gpmc_cs_mem_enabled(int cs)
855 l = gpmc_cs_read_reg(cs, GPMC_CS_CONFIG7);
856 return l & GPMC_CONFIG7_CSVALID;
859 static void gpmc_cs_set_reserved(int cs, int reserved)
861 struct gpmc_cs_data *gpmc = &gpmc_cs[cs];
863 gpmc->flags |= GPMC_CS_RESERVED;
866 static bool gpmc_cs_reserved(int cs)
868 struct gpmc_cs_data *gpmc = &gpmc_cs[cs];
870 return gpmc->flags & GPMC_CS_RESERVED;
873 static void gpmc_cs_set_name(int cs, const char *name)
875 struct gpmc_cs_data *gpmc = &gpmc_cs[cs];
880 static const char *gpmc_cs_get_name(int cs)
882 struct gpmc_cs_data *gpmc = &gpmc_cs[cs];
887 static unsigned long gpmc_mem_align(unsigned long size)
891 size = (size - 1) >> (GPMC_CHUNK_SHIFT - 1);
892 order = GPMC_CHUNK_SHIFT - 1;
901 static int gpmc_cs_insert_mem(int cs, unsigned long base, unsigned long size)
903 struct gpmc_cs_data *gpmc = &gpmc_cs[cs];
904 struct resource *res = &gpmc->mem;
907 size = gpmc_mem_align(size);
908 spin_lock(&gpmc_mem_lock);
910 res->end = base + size - 1;
911 r = request_resource(&gpmc_mem_root, res);
912 spin_unlock(&gpmc_mem_lock);
917 static int gpmc_cs_delete_mem(int cs)
919 struct gpmc_cs_data *gpmc = &gpmc_cs[cs];
920 struct resource *res = &gpmc->mem;
923 spin_lock(&gpmc_mem_lock);
924 r = release_resource(res);
927 spin_unlock(&gpmc_mem_lock);
933 * gpmc_cs_remap - remaps a chip-select physical base address
934 * @cs: chip-select to remap
935 * @base: physical base address to re-map chip-select to
937 * Re-maps a chip-select to a new physical base address specified by
938 * "base". Returns 0 on success and appropriate negative error code
941 static int gpmc_cs_remap(int cs, u32 base)
946 if (cs > gpmc_cs_num) {
947 pr_err("%s: requested chip-select is disabled\n", __func__);
952 * Make sure we ignore any device offsets from the GPMC partition
953 * allocated for the chip select and that the new base confirms
954 * to the GPMC 16MB minimum granularity.
956 base &= ~(SZ_16M - 1);
958 gpmc_cs_get_memconf(cs, &old_base, &size);
959 if (base == old_base)
962 ret = gpmc_cs_delete_mem(cs);
966 ret = gpmc_cs_insert_mem(cs, base, size);
970 ret = gpmc_cs_set_memconf(cs, base, size);
975 int gpmc_cs_request(int cs, unsigned long size, unsigned long *base)
977 struct gpmc_cs_data *gpmc = &gpmc_cs[cs];
978 struct resource *res = &gpmc->mem;
981 if (cs > gpmc_cs_num) {
982 pr_err("%s: requested chip-select is disabled\n", __func__);
985 size = gpmc_mem_align(size);
986 if (size > (1 << GPMC_SECTION_SHIFT))
989 spin_lock(&gpmc_mem_lock);
990 if (gpmc_cs_reserved(cs)) {
994 if (gpmc_cs_mem_enabled(cs))
995 r = adjust_resource(res, res->start & ~(size - 1), size);
997 r = allocate_resource(&gpmc_mem_root, res, size, 0, ~0,
1002 /* Disable CS while changing base address and size mask */
1003 gpmc_cs_disable_mem(cs);
1005 r = gpmc_cs_set_memconf(cs, res->start, resource_size(res));
1007 release_resource(res);
1012 gpmc_cs_enable_mem(cs);
1014 gpmc_cs_set_reserved(cs, 1);
1016 spin_unlock(&gpmc_mem_lock);
1019 EXPORT_SYMBOL(gpmc_cs_request);
1021 void gpmc_cs_free(int cs)
1023 struct gpmc_cs_data *gpmc = &gpmc_cs[cs];
1024 struct resource *res = &gpmc->mem;
1026 spin_lock(&gpmc_mem_lock);
1027 if (cs >= gpmc_cs_num || cs < 0 || !gpmc_cs_reserved(cs)) {
1028 printk(KERN_ERR "Trying to free non-reserved GPMC CS%d\n", cs);
1030 spin_unlock(&gpmc_mem_lock);
1033 gpmc_cs_disable_mem(cs);
1035 release_resource(res);
1036 gpmc_cs_set_reserved(cs, 0);
1037 spin_unlock(&gpmc_mem_lock);
1039 EXPORT_SYMBOL(gpmc_cs_free);
1042 * gpmc_configure - write request to configure gpmc
1043 * @cmd: command type
1044 * @wval: value to write
1045 * @return status of the operation
1047 int gpmc_configure(int cmd, int wval)
1052 case GPMC_CONFIG_WP:
1053 regval = gpmc_read_reg(GPMC_CONFIG);
1055 regval &= ~GPMC_CONFIG_WRITEPROTECT; /* WP is ON */
1057 regval |= GPMC_CONFIG_WRITEPROTECT; /* WP is OFF */
1058 gpmc_write_reg(GPMC_CONFIG, regval);
1062 pr_err("%s: command not supported\n", __func__);
1068 EXPORT_SYMBOL(gpmc_configure);
1070 static bool gpmc_nand_writebuffer_empty(void)
1072 if (gpmc_read_reg(GPMC_STATUS) & GPMC_STATUS_EMPTYWRITEBUFFERSTATUS)
1078 static struct gpmc_nand_ops nand_ops = {
1079 .nand_writebuffer_empty = gpmc_nand_writebuffer_empty,
1083 * gpmc_omap_get_nand_ops - Get the GPMC NAND interface
1084 * @reg: the GPMC NAND register map exclusive for NAND use.
1085 * @cs: GPMC chip select number on which the NAND sits. The
1086 * register map returned will be specific to this chip select.
1088 * Returns NULL on error e.g. invalid cs.
1090 struct gpmc_nand_ops *gpmc_omap_get_nand_ops(struct gpmc_nand_regs *reg, int cs)
1094 if (cs >= gpmc_cs_num)
1097 reg->gpmc_nand_command = gpmc_base + GPMC_CS0_OFFSET +
1098 GPMC_CS_NAND_COMMAND + GPMC_CS_SIZE * cs;
1099 reg->gpmc_nand_address = gpmc_base + GPMC_CS0_OFFSET +
1100 GPMC_CS_NAND_ADDRESS + GPMC_CS_SIZE * cs;
1101 reg->gpmc_nand_data = gpmc_base + GPMC_CS0_OFFSET +
1102 GPMC_CS_NAND_DATA + GPMC_CS_SIZE * cs;
1103 reg->gpmc_prefetch_config1 = gpmc_base + GPMC_PREFETCH_CONFIG1;
1104 reg->gpmc_prefetch_config2 = gpmc_base + GPMC_PREFETCH_CONFIG2;
1105 reg->gpmc_prefetch_control = gpmc_base + GPMC_PREFETCH_CONTROL;
1106 reg->gpmc_prefetch_status = gpmc_base + GPMC_PREFETCH_STATUS;
1107 reg->gpmc_ecc_config = gpmc_base + GPMC_ECC_CONFIG;
1108 reg->gpmc_ecc_control = gpmc_base + GPMC_ECC_CONTROL;
1109 reg->gpmc_ecc_size_config = gpmc_base + GPMC_ECC_SIZE_CONFIG;
1110 reg->gpmc_ecc1_result = gpmc_base + GPMC_ECC1_RESULT;
1112 for (i = 0; i < GPMC_BCH_NUM_REMAINDER; i++) {
1113 reg->gpmc_bch_result0[i] = gpmc_base + GPMC_ECC_BCH_RESULT_0 +
1115 reg->gpmc_bch_result1[i] = gpmc_base + GPMC_ECC_BCH_RESULT_1 +
1117 reg->gpmc_bch_result2[i] = gpmc_base + GPMC_ECC_BCH_RESULT_2 +
1119 reg->gpmc_bch_result3[i] = gpmc_base + GPMC_ECC_BCH_RESULT_3 +
1121 reg->gpmc_bch_result4[i] = gpmc_base + GPMC_ECC_BCH_RESULT_4 +
1123 reg->gpmc_bch_result5[i] = gpmc_base + GPMC_ECC_BCH_RESULT_5 +
1125 reg->gpmc_bch_result6[i] = gpmc_base + GPMC_ECC_BCH_RESULT_6 +
1131 EXPORT_SYMBOL_GPL(gpmc_omap_get_nand_ops);
1133 static void gpmc_omap_onenand_calc_sync_timings(struct gpmc_timings *t,
1134 struct gpmc_settings *s,
1135 int freq, int latency)
1137 struct gpmc_device_timings dev_t;
1138 const int t_cer = 15;
1139 const int t_avdp = 12;
1140 const int t_cez = 20; /* max of t_cez, t_oez */
1141 const int t_wpl = 40;
1142 const int t_wph = 30;
1143 int min_gpmc_clk_period, t_ces, t_avds, t_avdh, t_ach, t_aavdh, t_rdyo;
1147 min_gpmc_clk_period = 9600; /* 104 MHz */
1156 min_gpmc_clk_period = 12000; /* 83 MHz */
1165 min_gpmc_clk_period = 15000; /* 66 MHz */
1174 min_gpmc_clk_period = 18500; /* 54 MHz */
1184 /* Set synchronous read timings */
1185 memset(&dev_t, 0, sizeof(dev_t));
1187 if (!s->sync_write) {
1188 dev_t.t_avdp_w = max(t_avdp, t_cer) * 1000;
1189 dev_t.t_wpl = t_wpl * 1000;
1190 dev_t.t_wph = t_wph * 1000;
1191 dev_t.t_aavdh = t_aavdh * 1000;
1193 dev_t.ce_xdelay = true;
1194 dev_t.avd_xdelay = true;
1195 dev_t.oe_xdelay = true;
1196 dev_t.we_xdelay = true;
1197 dev_t.clk = min_gpmc_clk_period;
1198 dev_t.t_bacc = dev_t.clk;
1199 dev_t.t_ces = t_ces * 1000;
1200 dev_t.t_avds = t_avds * 1000;
1201 dev_t.t_avdh = t_avdh * 1000;
1202 dev_t.t_ach = t_ach * 1000;
1203 dev_t.cyc_iaa = (latency + 1);
1204 dev_t.t_cez_r = t_cez * 1000;
1205 dev_t.t_cez_w = dev_t.t_cez_r;
1206 dev_t.cyc_aavdh_oe = 1;
1207 dev_t.t_rdyo = t_rdyo * 1000 + min_gpmc_clk_period;
1209 gpmc_calc_timings(t, s, &dev_t);
1212 int gpmc_omap_onenand_set_timings(struct device *dev, int cs, int freq,
1214 struct gpmc_onenand_info *info)
1217 struct gpmc_timings gpmc_t;
1218 struct gpmc_settings gpmc_s;
1220 gpmc_read_settings_dt(dev->of_node, &gpmc_s);
1222 info->sync_read = gpmc_s.sync_read;
1223 info->sync_write = gpmc_s.sync_write;
1224 info->burst_len = gpmc_s.burst_len;
1226 if (!gpmc_s.sync_read && !gpmc_s.sync_write)
1229 gpmc_omap_onenand_calc_sync_timings(&gpmc_t, &gpmc_s, freq, latency);
1231 ret = gpmc_cs_program_settings(cs, &gpmc_s);
1235 return gpmc_cs_set_timings(cs, &gpmc_t, &gpmc_s);
1237 EXPORT_SYMBOL_GPL(gpmc_omap_onenand_set_timings);
1239 int gpmc_get_client_irq(unsigned int irq_config)
1241 if (!gpmc_irq_domain) {
1242 pr_warn("%s called before GPMC IRQ domain available\n",
1247 /* we restrict this to NAND IRQs only */
1248 if (irq_config >= GPMC_NR_NAND_IRQS)
1251 return irq_create_mapping(gpmc_irq_domain, irq_config);
1254 static int gpmc_irq_endis(unsigned long hwirq, bool endis)
1258 /* bits GPMC_NR_NAND_IRQS to 8 are reserved */
1259 if (hwirq >= GPMC_NR_NAND_IRQS)
1260 hwirq += 8 - GPMC_NR_NAND_IRQS;
1262 regval = gpmc_read_reg(GPMC_IRQENABLE);
1264 regval |= BIT(hwirq);
1266 regval &= ~BIT(hwirq);
1267 gpmc_write_reg(GPMC_IRQENABLE, regval);
1272 static void gpmc_irq_disable(struct irq_data *p)
1274 gpmc_irq_endis(p->hwirq, false);
1277 static void gpmc_irq_enable(struct irq_data *p)
1279 gpmc_irq_endis(p->hwirq, true);
1282 static void gpmc_irq_mask(struct irq_data *d)
1284 gpmc_irq_endis(d->hwirq, false);
1287 static void gpmc_irq_unmask(struct irq_data *d)
1289 gpmc_irq_endis(d->hwirq, true);
1292 static void gpmc_irq_edge_config(unsigned long hwirq, bool rising_edge)
1296 /* NAND IRQs polarity is not configurable */
1297 if (hwirq < GPMC_NR_NAND_IRQS)
1300 /* WAITPIN starts at BIT 8 */
1301 hwirq += 8 - GPMC_NR_NAND_IRQS;
1303 regval = gpmc_read_reg(GPMC_CONFIG);
1305 regval &= ~BIT(hwirq);
1307 regval |= BIT(hwirq);
1309 gpmc_write_reg(GPMC_CONFIG, regval);
1312 static void gpmc_irq_ack(struct irq_data *d)
1314 unsigned int hwirq = d->hwirq;
1316 /* skip reserved bits */
1317 if (hwirq >= GPMC_NR_NAND_IRQS)
1318 hwirq += 8 - GPMC_NR_NAND_IRQS;
1320 /* Setting bit to 1 clears (or Acks) the interrupt */
1321 gpmc_write_reg(GPMC_IRQSTATUS, BIT(hwirq));
1324 static int gpmc_irq_set_type(struct irq_data *d, unsigned int trigger)
1326 /* can't set type for NAND IRQs */
1327 if (d->hwirq < GPMC_NR_NAND_IRQS)
1330 /* We can support either rising or falling edge at a time */
1331 if (trigger == IRQ_TYPE_EDGE_FALLING)
1332 gpmc_irq_edge_config(d->hwirq, false);
1333 else if (trigger == IRQ_TYPE_EDGE_RISING)
1334 gpmc_irq_edge_config(d->hwirq, true);
1341 static int gpmc_irq_map(struct irq_domain *d, unsigned int virq,
1344 struct gpmc_device *gpmc = d->host_data;
1346 irq_set_chip_data(virq, gpmc);
1347 if (hw < GPMC_NR_NAND_IRQS) {
1348 irq_modify_status(virq, IRQ_NOREQUEST, IRQ_NOAUTOEN);
1349 irq_set_chip_and_handler(virq, &gpmc->irq_chip,
1352 irq_set_chip_and_handler(virq, &gpmc->irq_chip,
1359 static const struct irq_domain_ops gpmc_irq_domain_ops = {
1360 .map = gpmc_irq_map,
1361 .xlate = irq_domain_xlate_twocell,
1364 static irqreturn_t gpmc_handle_irq(int irq, void *data)
1367 u32 regval, regvalx;
1368 struct gpmc_device *gpmc = data;
1370 regval = gpmc_read_reg(GPMC_IRQSTATUS);
1376 for (hwirq = 0; hwirq < gpmc->nirqs; hwirq++) {
1377 /* skip reserved status bits */
1378 if (hwirq == GPMC_NR_NAND_IRQS)
1379 regvalx >>= 8 - GPMC_NR_NAND_IRQS;
1381 if (regvalx & BIT(hwirq)) {
1382 virq = irq_find_mapping(gpmc_irq_domain, hwirq);
1385 "spurious irq detected hwirq %d, virq %d\n",
1389 generic_handle_irq(virq);
1393 gpmc_write_reg(GPMC_IRQSTATUS, regval);
1398 static int gpmc_setup_irq(struct gpmc_device *gpmc)
1403 /* Disable interrupts */
1404 gpmc_write_reg(GPMC_IRQENABLE, 0);
1406 /* clear interrupts */
1407 regval = gpmc_read_reg(GPMC_IRQSTATUS);
1408 gpmc_write_reg(GPMC_IRQSTATUS, regval);
1410 gpmc->irq_chip.name = "gpmc";
1411 gpmc->irq_chip.irq_enable = gpmc_irq_enable;
1412 gpmc->irq_chip.irq_disable = gpmc_irq_disable;
1413 gpmc->irq_chip.irq_ack = gpmc_irq_ack;
1414 gpmc->irq_chip.irq_mask = gpmc_irq_mask;
1415 gpmc->irq_chip.irq_unmask = gpmc_irq_unmask;
1416 gpmc->irq_chip.irq_set_type = gpmc_irq_set_type;
1418 gpmc_irq_domain = irq_domain_add_linear(gpmc->dev->of_node,
1420 &gpmc_irq_domain_ops,
1422 if (!gpmc_irq_domain) {
1423 dev_err(gpmc->dev, "IRQ domain add failed\n");
1427 rc = request_irq(gpmc->irq, gpmc_handle_irq, 0, "gpmc", gpmc);
1429 dev_err(gpmc->dev, "failed to request irq %d: %d\n",
1431 irq_domain_remove(gpmc_irq_domain);
1432 gpmc_irq_domain = NULL;
1438 static int gpmc_free_irq(struct gpmc_device *gpmc)
1442 free_irq(gpmc->irq, gpmc);
1444 for (hwirq = 0; hwirq < gpmc->nirqs; hwirq++)
1445 irq_dispose_mapping(irq_find_mapping(gpmc_irq_domain, hwirq));
1447 irq_domain_remove(gpmc_irq_domain);
1448 gpmc_irq_domain = NULL;
1453 static void gpmc_mem_exit(void)
1457 for (cs = 0; cs < gpmc_cs_num; cs++) {
1458 if (!gpmc_cs_mem_enabled(cs))
1460 gpmc_cs_delete_mem(cs);
1464 static void gpmc_mem_init(void)
1468 gpmc_mem_root.start = GPMC_MEM_START;
1469 gpmc_mem_root.end = GPMC_MEM_END;
1471 /* Reserve all regions that has been set up by bootloader */
1472 for (cs = 0; cs < gpmc_cs_num; cs++) {
1475 if (!gpmc_cs_mem_enabled(cs))
1477 gpmc_cs_get_memconf(cs, &base, &size);
1478 if (gpmc_cs_insert_mem(cs, base, size)) {
1479 pr_warn("%s: disabling cs %d mapped at 0x%x-0x%x\n",
1480 __func__, cs, base, base + size);
1481 gpmc_cs_disable_mem(cs);
1486 static u32 gpmc_round_ps_to_sync_clk(u32 time_ps, u32 sync_clk)
1491 div = gpmc_calc_divider(sync_clk);
1492 temp = gpmc_ps_to_ticks(time_ps);
1493 temp = (temp + div - 1) / div;
1494 return gpmc_ticks_to_ps(temp * div);
1497 /* XXX: can the cycles be avoided ? */
1498 static int gpmc_calc_sync_read_timings(struct gpmc_timings *gpmc_t,
1499 struct gpmc_device_timings *dev_t,
1505 temp = dev_t->t_avdp_r;
1506 /* XXX: mux check required ? */
1508 /* XXX: t_avdp not to be required for sync, only added for tusb
1509 * this indirectly necessitates requirement of t_avdp_r and
1510 * t_avdp_w instead of having a single t_avdp
1512 temp = max_t(u32, temp, gpmc_t->clk_activation + dev_t->t_avdh);
1513 temp = max_t(u32, gpmc_t->adv_on + gpmc_ticks_to_ps(1), temp);
1515 gpmc_t->adv_rd_off = gpmc_round_ps_to_ticks(temp);
1518 temp = dev_t->t_oeasu; /* XXX: remove this ? */
1520 temp = max_t(u32, temp, gpmc_t->clk_activation + dev_t->t_ach);
1521 temp = max_t(u32, temp, gpmc_t->adv_rd_off +
1522 gpmc_ticks_to_ps(dev_t->cyc_aavdh_oe));
1524 gpmc_t->oe_on = gpmc_round_ps_to_ticks(temp);
1527 /* XXX: any scope for improvement ?, by combining oe_on
1528 * and clk_activation, need to check whether
1529 * access = clk_activation + round to sync clk ?
1531 temp = max_t(u32, dev_t->t_iaa, dev_t->cyc_iaa * gpmc_t->sync_clk);
1532 temp += gpmc_t->clk_activation;
1534 temp = max_t(u32, temp, gpmc_t->oe_on +
1535 gpmc_ticks_to_ps(dev_t->cyc_oe));
1536 gpmc_t->access = gpmc_round_ps_to_ticks(temp);
1538 gpmc_t->oe_off = gpmc_t->access + gpmc_ticks_to_ps(1);
1539 gpmc_t->cs_rd_off = gpmc_t->oe_off;
1542 temp = max_t(u32, dev_t->t_cez_r, dev_t->t_oez);
1543 temp = gpmc_round_ps_to_sync_clk(temp, gpmc_t->sync_clk) +
1545 /* XXX: barter t_ce_rdyz with t_cez_r ? */
1546 if (dev_t->t_ce_rdyz)
1547 temp = max_t(u32, temp, gpmc_t->cs_rd_off + dev_t->t_ce_rdyz);
1548 gpmc_t->rd_cycle = gpmc_round_ps_to_ticks(temp);
1553 static int gpmc_calc_sync_write_timings(struct gpmc_timings *gpmc_t,
1554 struct gpmc_device_timings *dev_t,
1560 temp = dev_t->t_avdp_w;
1562 temp = max_t(u32, temp,
1563 gpmc_t->clk_activation + dev_t->t_avdh);
1564 temp = max_t(u32, gpmc_t->adv_on + gpmc_ticks_to_ps(1), temp);
1566 gpmc_t->adv_wr_off = gpmc_round_ps_to_ticks(temp);
1568 /* wr_data_mux_bus */
1569 temp = max_t(u32, dev_t->t_weasu,
1570 gpmc_t->clk_activation + dev_t->t_rdyo);
1571 /* XXX: shouldn't mux be kept as a whole for wr_data_mux_bus ?,
1572 * and in that case remember to handle we_on properly
1575 temp = max_t(u32, temp,
1576 gpmc_t->adv_wr_off + dev_t->t_aavdh);
1577 temp = max_t(u32, temp, gpmc_t->adv_wr_off +
1578 gpmc_ticks_to_ps(dev_t->cyc_aavdh_we));
1580 gpmc_t->wr_data_mux_bus = gpmc_round_ps_to_ticks(temp);
1583 if (gpmc_capability & GPMC_HAS_WR_DATA_MUX_BUS)
1584 gpmc_t->we_on = gpmc_round_ps_to_ticks(dev_t->t_weasu);
1586 gpmc_t->we_on = gpmc_t->wr_data_mux_bus;
1589 /* XXX: gpmc_capability check reqd ? , even if not, will not harm */
1590 gpmc_t->wr_access = gpmc_t->access;
1593 temp = gpmc_t->we_on + dev_t->t_wpl;
1594 temp = max_t(u32, temp,
1595 gpmc_t->wr_access + gpmc_ticks_to_ps(1));
1596 temp = max_t(u32, temp,
1597 gpmc_t->we_on + gpmc_ticks_to_ps(dev_t->cyc_wpl));
1598 gpmc_t->we_off = gpmc_round_ps_to_ticks(temp);
1600 gpmc_t->cs_wr_off = gpmc_round_ps_to_ticks(gpmc_t->we_off +
1604 temp = gpmc_round_ps_to_sync_clk(dev_t->t_cez_w, gpmc_t->sync_clk);
1605 temp += gpmc_t->wr_access;
1606 /* XXX: barter t_ce_rdyz with t_cez_w ? */
1607 if (dev_t->t_ce_rdyz)
1608 temp = max_t(u32, temp,
1609 gpmc_t->cs_wr_off + dev_t->t_ce_rdyz);
1610 gpmc_t->wr_cycle = gpmc_round_ps_to_ticks(temp);
1615 static int gpmc_calc_async_read_timings(struct gpmc_timings *gpmc_t,
1616 struct gpmc_device_timings *dev_t,
1622 temp = dev_t->t_avdp_r;
1624 temp = max_t(u32, gpmc_t->adv_on + gpmc_ticks_to_ps(1), temp);
1625 gpmc_t->adv_rd_off = gpmc_round_ps_to_ticks(temp);
1628 temp = dev_t->t_oeasu;
1630 temp = max_t(u32, temp, gpmc_t->adv_rd_off + dev_t->t_aavdh);
1631 gpmc_t->oe_on = gpmc_round_ps_to_ticks(temp);
1634 temp = max_t(u32, dev_t->t_iaa, /* XXX: remove t_iaa in async ? */
1635 gpmc_t->oe_on + dev_t->t_oe);
1636 temp = max_t(u32, temp, gpmc_t->cs_on + dev_t->t_ce);
1637 temp = max_t(u32, temp, gpmc_t->adv_on + dev_t->t_aa);
1638 gpmc_t->access = gpmc_round_ps_to_ticks(temp);
1640 gpmc_t->oe_off = gpmc_t->access + gpmc_ticks_to_ps(1);
1641 gpmc_t->cs_rd_off = gpmc_t->oe_off;
1644 temp = max_t(u32, dev_t->t_rd_cycle,
1645 gpmc_t->cs_rd_off + dev_t->t_cez_r);
1646 temp = max_t(u32, temp, gpmc_t->oe_off + dev_t->t_oez);
1647 gpmc_t->rd_cycle = gpmc_round_ps_to_ticks(temp);
1652 static int gpmc_calc_async_write_timings(struct gpmc_timings *gpmc_t,
1653 struct gpmc_device_timings *dev_t,
1659 temp = dev_t->t_avdp_w;
1661 temp = max_t(u32, gpmc_t->adv_on + gpmc_ticks_to_ps(1), temp);
1662 gpmc_t->adv_wr_off = gpmc_round_ps_to_ticks(temp);
1664 /* wr_data_mux_bus */
1665 temp = dev_t->t_weasu;
1667 temp = max_t(u32, temp, gpmc_t->adv_wr_off + dev_t->t_aavdh);
1668 temp = max_t(u32, temp, gpmc_t->adv_wr_off +
1669 gpmc_ticks_to_ps(dev_t->cyc_aavdh_we));
1671 gpmc_t->wr_data_mux_bus = gpmc_round_ps_to_ticks(temp);
1674 if (gpmc_capability & GPMC_HAS_WR_DATA_MUX_BUS)
1675 gpmc_t->we_on = gpmc_round_ps_to_ticks(dev_t->t_weasu);
1677 gpmc_t->we_on = gpmc_t->wr_data_mux_bus;
1680 temp = gpmc_t->we_on + dev_t->t_wpl;
1681 gpmc_t->we_off = gpmc_round_ps_to_ticks(temp);
1683 gpmc_t->cs_wr_off = gpmc_round_ps_to_ticks(gpmc_t->we_off +
1687 temp = max_t(u32, dev_t->t_wr_cycle,
1688 gpmc_t->cs_wr_off + dev_t->t_cez_w);
1689 gpmc_t->wr_cycle = gpmc_round_ps_to_ticks(temp);
1694 static int gpmc_calc_sync_common_timings(struct gpmc_timings *gpmc_t,
1695 struct gpmc_device_timings *dev_t)
1699 gpmc_t->sync_clk = gpmc_calc_divider(dev_t->clk) *
1700 gpmc_get_fclk_period();
1702 gpmc_t->page_burst_access = gpmc_round_ps_to_sync_clk(
1706 temp = max_t(u32, dev_t->t_ces, dev_t->t_avds);
1707 gpmc_t->clk_activation = gpmc_round_ps_to_ticks(temp);
1709 if (gpmc_calc_divider(gpmc_t->sync_clk) != 1)
1712 if (dev_t->ce_xdelay)
1713 gpmc_t->bool_timings.cs_extra_delay = true;
1714 if (dev_t->avd_xdelay)
1715 gpmc_t->bool_timings.adv_extra_delay = true;
1716 if (dev_t->oe_xdelay)
1717 gpmc_t->bool_timings.oe_extra_delay = true;
1718 if (dev_t->we_xdelay)
1719 gpmc_t->bool_timings.we_extra_delay = true;
1724 static int gpmc_calc_common_timings(struct gpmc_timings *gpmc_t,
1725 struct gpmc_device_timings *dev_t,
1731 gpmc_t->cs_on = gpmc_round_ps_to_ticks(dev_t->t_ceasu);
1734 temp = dev_t->t_avdasu;
1735 if (dev_t->t_ce_avd)
1736 temp = max_t(u32, temp,
1737 gpmc_t->cs_on + dev_t->t_ce_avd);
1738 gpmc_t->adv_on = gpmc_round_ps_to_ticks(temp);
1741 gpmc_calc_sync_common_timings(gpmc_t, dev_t);
1747 * TODO: remove this function once all peripherals are confirmed to
1748 * work with generic timing. Simultaneously gpmc_cs_set_timings()
1749 * has to be modified to handle timings in ps instead of ns
1751 static void gpmc_convert_ps_to_ns(struct gpmc_timings *t)
1754 t->cs_rd_off /= 1000;
1755 t->cs_wr_off /= 1000;
1757 t->adv_rd_off /= 1000;
1758 t->adv_wr_off /= 1000;
1763 t->page_burst_access /= 1000;
1765 t->rd_cycle /= 1000;
1766 t->wr_cycle /= 1000;
1767 t->bus_turnaround /= 1000;
1768 t->cycle2cycle_delay /= 1000;
1769 t->wait_monitoring /= 1000;
1770 t->clk_activation /= 1000;
1771 t->wr_access /= 1000;
1772 t->wr_data_mux_bus /= 1000;
1775 int gpmc_calc_timings(struct gpmc_timings *gpmc_t,
1776 struct gpmc_settings *gpmc_s,
1777 struct gpmc_device_timings *dev_t)
1779 bool mux = false, sync = false;
1782 mux = gpmc_s->mux_add_data ? true : false;
1783 sync = (gpmc_s->sync_read || gpmc_s->sync_write);
1786 memset(gpmc_t, 0, sizeof(*gpmc_t));
1788 gpmc_calc_common_timings(gpmc_t, dev_t, sync);
1790 if (gpmc_s && gpmc_s->sync_read)
1791 gpmc_calc_sync_read_timings(gpmc_t, dev_t, mux);
1793 gpmc_calc_async_read_timings(gpmc_t, dev_t, mux);
1795 if (gpmc_s && gpmc_s->sync_write)
1796 gpmc_calc_sync_write_timings(gpmc_t, dev_t, mux);
1798 gpmc_calc_async_write_timings(gpmc_t, dev_t, mux);
1800 /* TODO: remove, see function definition */
1801 gpmc_convert_ps_to_ns(gpmc_t);
1807 * gpmc_cs_program_settings - programs non-timing related settings
1808 * @cs: GPMC chip-select to program
1809 * @p: pointer to GPMC settings structure
1811 * Programs non-timing related settings for a GPMC chip-select, such as
1812 * bus-width, burst configuration, etc. Function should be called once
1813 * for each chip-select that is being used and must be called before
1814 * calling gpmc_cs_set_timings() as timing parameters in the CONFIG1
1815 * register will be initialised to zero by this function. Returns 0 on
1816 * success and appropriate negative error code on failure.
1818 int gpmc_cs_program_settings(int cs, struct gpmc_settings *p)
1822 if ((!p->device_width) || (p->device_width > GPMC_DEVWIDTH_16BIT)) {
1823 pr_err("%s: invalid width %d!", __func__, p->device_width);
1827 /* Address-data multiplexing not supported for NAND devices */
1828 if (p->device_nand && p->mux_add_data) {
1829 pr_err("%s: invalid configuration!\n", __func__);
1833 if ((p->mux_add_data > GPMC_MUX_AD) ||
1834 ((p->mux_add_data == GPMC_MUX_AAD) &&
1835 !(gpmc_capability & GPMC_HAS_MUX_AAD))) {
1836 pr_err("%s: invalid multiplex configuration!\n", __func__);
1840 /* Page/burst mode supports lengths of 4, 8 and 16 bytes */
1841 if (p->burst_read || p->burst_write) {
1842 switch (p->burst_len) {
1848 pr_err("%s: invalid page/burst-length (%d)\n",
1849 __func__, p->burst_len);
1854 if (p->wait_pin > gpmc_nr_waitpins) {
1855 pr_err("%s: invalid wait-pin (%d)\n", __func__, p->wait_pin);
1859 config1 = GPMC_CONFIG1_DEVICESIZE((p->device_width - 1));
1862 config1 |= GPMC_CONFIG1_READTYPE_SYNC;
1864 config1 |= GPMC_CONFIG1_WRITETYPE_SYNC;
1865 if (p->wait_on_read)
1866 config1 |= GPMC_CONFIG1_WAIT_READ_MON;
1867 if (p->wait_on_write)
1868 config1 |= GPMC_CONFIG1_WAIT_WRITE_MON;
1869 if (p->wait_on_read || p->wait_on_write)
1870 config1 |= GPMC_CONFIG1_WAIT_PIN_SEL(p->wait_pin);
1872 config1 |= GPMC_CONFIG1_DEVICETYPE(GPMC_DEVICETYPE_NAND);
1873 if (p->mux_add_data)
1874 config1 |= GPMC_CONFIG1_MUXTYPE(p->mux_add_data);
1876 config1 |= GPMC_CONFIG1_READMULTIPLE_SUPP;
1878 config1 |= GPMC_CONFIG1_WRITEMULTIPLE_SUPP;
1879 if (p->burst_read || p->burst_write) {
1880 config1 |= GPMC_CONFIG1_PAGE_LEN(p->burst_len >> 3);
1881 config1 |= p->burst_wrap ? GPMC_CONFIG1_WRAPBURST_SUPP : 0;
1884 gpmc_cs_write_reg(cs, GPMC_CS_CONFIG1, config1);
1890 static const struct of_device_id gpmc_dt_ids[] = {
1891 { .compatible = "ti,omap2420-gpmc" },
1892 { .compatible = "ti,omap2430-gpmc" },
1893 { .compatible = "ti,omap3430-gpmc" }, /* omap3430 & omap3630 */
1894 { .compatible = "ti,omap4430-gpmc" }, /* omap4430 & omap4460 & omap543x */
1895 { .compatible = "ti,am3352-gpmc" }, /* am335x devices */
1900 * gpmc_read_settings_dt - read gpmc settings from device-tree
1901 * @np: pointer to device-tree node for a gpmc child device
1902 * @p: pointer to gpmc settings structure
1904 * Reads the GPMC settings for a GPMC child device from device-tree and
1905 * stores them in the GPMC settings structure passed. The GPMC settings
1906 * structure is initialised to zero by this function and so any
1907 * previously stored settings will be cleared.
1909 void gpmc_read_settings_dt(struct device_node *np, struct gpmc_settings *p)
1911 memset(p, 0, sizeof(struct gpmc_settings));
1913 p->sync_read = of_property_read_bool(np, "gpmc,sync-read");
1914 p->sync_write = of_property_read_bool(np, "gpmc,sync-write");
1915 of_property_read_u32(np, "gpmc,device-width", &p->device_width);
1916 of_property_read_u32(np, "gpmc,mux-add-data", &p->mux_add_data);
1918 if (!of_property_read_u32(np, "gpmc,burst-length", &p->burst_len)) {
1919 p->burst_wrap = of_property_read_bool(np, "gpmc,burst-wrap");
1920 p->burst_read = of_property_read_bool(np, "gpmc,burst-read");
1921 p->burst_write = of_property_read_bool(np, "gpmc,burst-write");
1922 if (!p->burst_read && !p->burst_write)
1923 pr_warn("%s: page/burst-length set but not used!\n",
1927 if (!of_property_read_u32(np, "gpmc,wait-pin", &p->wait_pin)) {
1928 p->wait_on_read = of_property_read_bool(np,
1929 "gpmc,wait-on-read");
1930 p->wait_on_write = of_property_read_bool(np,
1931 "gpmc,wait-on-write");
1932 if (!p->wait_on_read && !p->wait_on_write)
1933 pr_debug("%s: rd/wr wait monitoring not enabled!\n",
1938 static void __maybe_unused gpmc_read_timings_dt(struct device_node *np,
1939 struct gpmc_timings *gpmc_t)
1941 struct gpmc_bool_timings *p;
1946 memset(gpmc_t, 0, sizeof(*gpmc_t));
1948 /* minimum clock period for syncronous mode */
1949 of_property_read_u32(np, "gpmc,sync-clk-ps", &gpmc_t->sync_clk);
1951 /* chip select timtings */
1952 of_property_read_u32(np, "gpmc,cs-on-ns", &gpmc_t->cs_on);
1953 of_property_read_u32(np, "gpmc,cs-rd-off-ns", &gpmc_t->cs_rd_off);
1954 of_property_read_u32(np, "gpmc,cs-wr-off-ns", &gpmc_t->cs_wr_off);
1956 /* ADV signal timings */
1957 of_property_read_u32(np, "gpmc,adv-on-ns", &gpmc_t->adv_on);
1958 of_property_read_u32(np, "gpmc,adv-rd-off-ns", &gpmc_t->adv_rd_off);
1959 of_property_read_u32(np, "gpmc,adv-wr-off-ns", &gpmc_t->adv_wr_off);
1960 of_property_read_u32(np, "gpmc,adv-aad-mux-on-ns",
1961 &gpmc_t->adv_aad_mux_on);
1962 of_property_read_u32(np, "gpmc,adv-aad-mux-rd-off-ns",
1963 &gpmc_t->adv_aad_mux_rd_off);
1964 of_property_read_u32(np, "gpmc,adv-aad-mux-wr-off-ns",
1965 &gpmc_t->adv_aad_mux_wr_off);
1967 /* WE signal timings */
1968 of_property_read_u32(np, "gpmc,we-on-ns", &gpmc_t->we_on);
1969 of_property_read_u32(np, "gpmc,we-off-ns", &gpmc_t->we_off);
1971 /* OE signal timings */
1972 of_property_read_u32(np, "gpmc,oe-on-ns", &gpmc_t->oe_on);
1973 of_property_read_u32(np, "gpmc,oe-off-ns", &gpmc_t->oe_off);
1974 of_property_read_u32(np, "gpmc,oe-aad-mux-on-ns",
1975 &gpmc_t->oe_aad_mux_on);
1976 of_property_read_u32(np, "gpmc,oe-aad-mux-off-ns",
1977 &gpmc_t->oe_aad_mux_off);
1979 /* access and cycle timings */
1980 of_property_read_u32(np, "gpmc,page-burst-access-ns",
1981 &gpmc_t->page_burst_access);
1982 of_property_read_u32(np, "gpmc,access-ns", &gpmc_t->access);
1983 of_property_read_u32(np, "gpmc,rd-cycle-ns", &gpmc_t->rd_cycle);
1984 of_property_read_u32(np, "gpmc,wr-cycle-ns", &gpmc_t->wr_cycle);
1985 of_property_read_u32(np, "gpmc,bus-turnaround-ns",
1986 &gpmc_t->bus_turnaround);
1987 of_property_read_u32(np, "gpmc,cycle2cycle-delay-ns",
1988 &gpmc_t->cycle2cycle_delay);
1989 of_property_read_u32(np, "gpmc,wait-monitoring-ns",
1990 &gpmc_t->wait_monitoring);
1991 of_property_read_u32(np, "gpmc,clk-activation-ns",
1992 &gpmc_t->clk_activation);
1994 /* only applicable to OMAP3+ */
1995 of_property_read_u32(np, "gpmc,wr-access-ns", &gpmc_t->wr_access);
1996 of_property_read_u32(np, "gpmc,wr-data-mux-bus-ns",
1997 &gpmc_t->wr_data_mux_bus);
1999 /* bool timing parameters */
2000 p = &gpmc_t->bool_timings;
2002 p->cycle2cyclediffcsen =
2003 of_property_read_bool(np, "gpmc,cycle2cycle-diffcsen");
2004 p->cycle2cyclesamecsen =
2005 of_property_read_bool(np, "gpmc,cycle2cycle-samecsen");
2006 p->we_extra_delay = of_property_read_bool(np, "gpmc,we-extra-delay");
2007 p->oe_extra_delay = of_property_read_bool(np, "gpmc,oe-extra-delay");
2008 p->adv_extra_delay = of_property_read_bool(np, "gpmc,adv-extra-delay");
2009 p->cs_extra_delay = of_property_read_bool(np, "gpmc,cs-extra-delay");
2010 p->time_para_granularity =
2011 of_property_read_bool(np, "gpmc,time-para-granularity");
2015 * gpmc_probe_generic_child - configures the gpmc for a child device
2016 * @pdev: pointer to gpmc platform device
2017 * @child: pointer to device-tree node for child device
2019 * Allocates and configures a GPMC chip-select for a child device.
2020 * Returns 0 on success and appropriate negative error code on failure.
2022 static int gpmc_probe_generic_child(struct platform_device *pdev,
2023 struct device_node *child)
2025 struct gpmc_settings gpmc_s;
2026 struct gpmc_timings gpmc_t;
2027 struct resource res;
2032 struct gpio_desc *waitpin_desc = NULL;
2033 struct gpmc_device *gpmc = platform_get_drvdata(pdev);
2035 if (of_property_read_u32(child, "reg", &cs) < 0) {
2036 dev_err(&pdev->dev, "%pOF has no 'reg' property\n",
2041 if (of_address_to_resource(child, 0, &res) < 0) {
2042 dev_err(&pdev->dev, "%pOF has malformed 'reg' property\n",
2048 * Check if we have multiple instances of the same device
2049 * on a single chip select. If so, use the already initialized
2052 name = gpmc_cs_get_name(cs);
2053 if (name && of_node_name_eq(child, name))
2056 ret = gpmc_cs_request(cs, resource_size(&res), &base);
2058 dev_err(&pdev->dev, "cannot request GPMC CS %d\n", cs);
2061 gpmc_cs_set_name(cs, child->full_name);
2063 gpmc_read_settings_dt(child, &gpmc_s);
2064 gpmc_read_timings_dt(child, &gpmc_t);
2067 * For some GPMC devices we still need to rely on the bootloader
2068 * timings because the devices can be connected via FPGA.
2069 * REVISIT: Add timing support from slls644g.pdf.
2071 if (!gpmc_t.cs_rd_off) {
2072 WARN(1, "enable GPMC debug to configure .dts timings for CS%i\n",
2074 gpmc_cs_show_timings(cs,
2075 "please add GPMC bootloader timings to .dts");
2079 /* CS must be disabled while making changes to gpmc configuration */
2080 gpmc_cs_disable_mem(cs);
2083 * FIXME: gpmc_cs_request() will map the CS to an arbitrary
2084 * location in the gpmc address space. When booting with
2085 * device-tree we want the NOR flash to be mapped to the
2086 * location specified in the device-tree blob. So remap the
2087 * CS to this location. Once DT migration is complete should
2088 * just make gpmc_cs_request() map a specific address.
2090 ret = gpmc_cs_remap(cs, res.start);
2092 dev_err(&pdev->dev, "cannot remap GPMC CS %d to %pa\n",
2094 if (res.start < GPMC_MEM_START) {
2095 dev_info(&pdev->dev,
2096 "GPMC CS %d start cannot be lesser than 0x%x\n",
2097 cs, GPMC_MEM_START);
2098 } else if (res.end > GPMC_MEM_END) {
2099 dev_info(&pdev->dev,
2100 "GPMC CS %d end cannot be greater than 0x%x\n",
2106 if (of_node_name_eq(child, "nand")) {
2107 /* Warn about older DT blobs with no compatible property */
2108 if (!of_property_read_bool(child, "compatible")) {
2109 dev_warn(&pdev->dev,
2110 "Incompatible NAND node: missing compatible");
2116 if (of_node_name_eq(child, "onenand")) {
2117 /* Warn about older DT blobs with no compatible property */
2118 if (!of_property_read_bool(child, "compatible")) {
2119 dev_warn(&pdev->dev,
2120 "Incompatible OneNAND node: missing compatible");
2126 if (of_device_is_compatible(child, "ti,omap2-nand")) {
2127 /* NAND specific setup */
2129 of_property_read_u32(child, "nand-bus-width", &val);
2132 gpmc_s.device_width = GPMC_DEVWIDTH_8BIT;
2135 gpmc_s.device_width = GPMC_DEVWIDTH_16BIT;
2138 dev_err(&pdev->dev, "%pOFn: invalid 'nand-bus-width'\n",
2144 /* disable write protect */
2145 gpmc_configure(GPMC_CONFIG_WP, 0);
2146 gpmc_s.device_nand = true;
2148 ret = of_property_read_u32(child, "bank-width",
2149 &gpmc_s.device_width);
2150 if (ret < 0 && !gpmc_s.device_width) {
2152 "%pOF has no 'gpmc,device-width' property\n",
2158 /* Reserve wait pin if it is required and valid */
2159 if (gpmc_s.wait_on_read || gpmc_s.wait_on_write) {
2160 unsigned int wait_pin = gpmc_s.wait_pin;
2162 waitpin_desc = gpiochip_request_own_desc(&gpmc->gpio_chip,
2163 wait_pin, "WAITPIN",
2166 if (IS_ERR(waitpin_desc)) {
2167 dev_err(&pdev->dev, "invalid wait-pin: %d\n", wait_pin);
2168 ret = PTR_ERR(waitpin_desc);
2173 gpmc_cs_show_timings(cs, "before gpmc_cs_program_settings");
2175 ret = gpmc_cs_program_settings(cs, &gpmc_s);
2179 ret = gpmc_cs_set_timings(cs, &gpmc_t, &gpmc_s);
2181 dev_err(&pdev->dev, "failed to set gpmc timings for: %pOFn\n",
2186 /* Clear limited address i.e. enable A26-A11 */
2187 val = gpmc_read_reg(GPMC_CONFIG);
2188 val &= ~GPMC_CONFIG_LIMITEDADDRESS;
2189 gpmc_write_reg(GPMC_CONFIG, val);
2191 /* Enable CS region */
2192 gpmc_cs_enable_mem(cs);
2196 /* create platform device, NULL on error or when disabled */
2197 if (!of_platform_device_create(child, NULL, &pdev->dev))
2198 goto err_child_fail;
2200 /* is child a common bus? */
2201 if (of_match_node(of_default_bus_match_table, child))
2202 /* create children and other common bus children */
2203 if (of_platform_default_populate(child, NULL, &pdev->dev))
2204 goto err_child_fail;
2210 dev_err(&pdev->dev, "failed to create gpmc child %pOFn\n", child);
2214 gpiochip_free_own_desc(waitpin_desc);
2221 static int gpmc_probe_dt(struct platform_device *pdev)
2224 const struct of_device_id *of_id =
2225 of_match_device(gpmc_dt_ids, &pdev->dev);
2230 ret = of_property_read_u32(pdev->dev.of_node, "gpmc,num-cs",
2233 pr_err("%s: number of chip-selects not defined\n", __func__);
2235 } else if (gpmc_cs_num < 1) {
2236 pr_err("%s: all chip-selects are disabled\n", __func__);
2238 } else if (gpmc_cs_num > GPMC_CS_NUM) {
2239 pr_err("%s: number of supported chip-selects cannot be > %d\n",
2240 __func__, GPMC_CS_NUM);
2244 ret = of_property_read_u32(pdev->dev.of_node, "gpmc,num-waitpins",
2247 pr_err("%s: number of wait pins not found!\n", __func__);
2254 static void gpmc_probe_dt_children(struct platform_device *pdev)
2257 struct device_node *child;
2259 for_each_available_child_of_node(pdev->dev.of_node, child) {
2260 ret = gpmc_probe_generic_child(pdev, child);
2262 dev_err(&pdev->dev, "failed to probe DT child '%pOFn': %d\n",
2268 static int gpmc_probe_dt(struct platform_device *pdev)
2273 static void gpmc_probe_dt_children(struct platform_device *pdev)
2276 #endif /* CONFIG_OF */
2278 static int gpmc_gpio_get_direction(struct gpio_chip *chip, unsigned int offset)
2280 return 1; /* we're input only */
2283 static int gpmc_gpio_direction_input(struct gpio_chip *chip,
2284 unsigned int offset)
2286 return 0; /* we're input only */
2289 static int gpmc_gpio_direction_output(struct gpio_chip *chip,
2290 unsigned int offset, int value)
2292 return -EINVAL; /* we're input only */
2295 static void gpmc_gpio_set(struct gpio_chip *chip, unsigned int offset,
2300 static int gpmc_gpio_get(struct gpio_chip *chip, unsigned int offset)
2306 reg = gpmc_read_reg(GPMC_STATUS) & BIT(offset);
2311 static int gpmc_gpio_init(struct gpmc_device *gpmc)
2315 gpmc->gpio_chip.parent = gpmc->dev;
2316 gpmc->gpio_chip.owner = THIS_MODULE;
2317 gpmc->gpio_chip.label = DEVICE_NAME;
2318 gpmc->gpio_chip.ngpio = gpmc_nr_waitpins;
2319 gpmc->gpio_chip.get_direction = gpmc_gpio_get_direction;
2320 gpmc->gpio_chip.direction_input = gpmc_gpio_direction_input;
2321 gpmc->gpio_chip.direction_output = gpmc_gpio_direction_output;
2322 gpmc->gpio_chip.set = gpmc_gpio_set;
2323 gpmc->gpio_chip.get = gpmc_gpio_get;
2324 gpmc->gpio_chip.base = -1;
2326 ret = devm_gpiochip_add_data(gpmc->dev, &gpmc->gpio_chip, NULL);
2328 dev_err(gpmc->dev, "could not register gpio chip: %d\n", ret);
2335 static int gpmc_probe(struct platform_device *pdev)
2339 struct resource *res;
2340 struct gpmc_device *gpmc;
2342 gpmc = devm_kzalloc(&pdev->dev, sizeof(*gpmc), GFP_KERNEL);
2346 gpmc->dev = &pdev->dev;
2347 platform_set_drvdata(pdev, gpmc);
2349 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
2353 phys_base = res->start;
2354 mem_size = resource_size(res);
2356 gpmc_base = devm_ioremap_resource(&pdev->dev, res);
2357 if (IS_ERR(gpmc_base))
2358 return PTR_ERR(gpmc_base);
2360 res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
2362 dev_err(&pdev->dev, "Failed to get resource: irq\n");
2366 gpmc->irq = res->start;
2368 gpmc_l3_clk = devm_clk_get(&pdev->dev, "fck");
2369 if (IS_ERR(gpmc_l3_clk)) {
2370 dev_err(&pdev->dev, "Failed to get GPMC fck\n");
2371 return PTR_ERR(gpmc_l3_clk);
2374 if (!clk_get_rate(gpmc_l3_clk)) {
2375 dev_err(&pdev->dev, "Invalid GPMC fck clock rate\n");
2379 if (pdev->dev.of_node) {
2380 rc = gpmc_probe_dt(pdev);
2384 gpmc_cs_num = GPMC_CS_NUM;
2385 gpmc_nr_waitpins = GPMC_NR_WAITPINS;
2388 pm_runtime_enable(&pdev->dev);
2389 pm_runtime_get_sync(&pdev->dev);
2391 l = gpmc_read_reg(GPMC_REVISION);
2394 * FIXME: Once device-tree migration is complete the below flags
2395 * should be populated based upon the device-tree compatible
2396 * string. For now just use the IP revision. OMAP3+ devices have
2397 * the wr_access and wr_data_mux_bus register fields. OMAP4+
2398 * devices support the addr-addr-data multiplex protocol.
2400 * GPMC IP revisions:
2403 * - OMAP44xx/54xx/AM335x = 6.0
2405 if (GPMC_REVISION_MAJOR(l) > 0x4)
2406 gpmc_capability = GPMC_HAS_WR_ACCESS | GPMC_HAS_WR_DATA_MUX_BUS;
2407 if (GPMC_REVISION_MAJOR(l) > 0x5)
2408 gpmc_capability |= GPMC_HAS_MUX_AAD;
2409 dev_info(gpmc->dev, "GPMC revision %d.%d\n", GPMC_REVISION_MAJOR(l),
2410 GPMC_REVISION_MINOR(l));
2413 rc = gpmc_gpio_init(gpmc);
2415 goto gpio_init_failed;
2417 gpmc->nirqs = GPMC_NR_NAND_IRQS + gpmc_nr_waitpins;
2418 rc = gpmc_setup_irq(gpmc);
2420 dev_err(gpmc->dev, "gpmc_setup_irq failed\n");
2421 goto gpio_init_failed;
2424 gpmc_probe_dt_children(pdev);
2430 pm_runtime_put_sync(&pdev->dev);
2431 pm_runtime_disable(&pdev->dev);
2436 static int gpmc_remove(struct platform_device *pdev)
2438 struct gpmc_device *gpmc = platform_get_drvdata(pdev);
2440 gpmc_free_irq(gpmc);
2442 pm_runtime_put_sync(&pdev->dev);
2443 pm_runtime_disable(&pdev->dev);
2448 #ifdef CONFIG_PM_SLEEP
2449 static int gpmc_suspend(struct device *dev)
2451 omap3_gpmc_save_context();
2452 pm_runtime_put_sync(dev);
2456 static int gpmc_resume(struct device *dev)
2458 pm_runtime_get_sync(dev);
2459 omap3_gpmc_restore_context();
2464 static SIMPLE_DEV_PM_OPS(gpmc_pm_ops, gpmc_suspend, gpmc_resume);
2466 static struct platform_driver gpmc_driver = {
2467 .probe = gpmc_probe,
2468 .remove = gpmc_remove,
2470 .name = DEVICE_NAME,
2471 .of_match_table = of_match_ptr(gpmc_dt_ids),
2476 static __init int gpmc_init(void)
2478 return platform_driver_register(&gpmc_driver);
2480 postcore_initcall(gpmc_init);
2482 static struct omap3_gpmc_regs gpmc_context;
2484 void omap3_gpmc_save_context(void)
2491 gpmc_context.sysconfig = gpmc_read_reg(GPMC_SYSCONFIG);
2492 gpmc_context.irqenable = gpmc_read_reg(GPMC_IRQENABLE);
2493 gpmc_context.timeout_ctrl = gpmc_read_reg(GPMC_TIMEOUT_CONTROL);
2494 gpmc_context.config = gpmc_read_reg(GPMC_CONFIG);
2495 gpmc_context.prefetch_config1 = gpmc_read_reg(GPMC_PREFETCH_CONFIG1);
2496 gpmc_context.prefetch_config2 = gpmc_read_reg(GPMC_PREFETCH_CONFIG2);
2497 gpmc_context.prefetch_control = gpmc_read_reg(GPMC_PREFETCH_CONTROL);
2498 for (i = 0; i < gpmc_cs_num; i++) {
2499 gpmc_context.cs_context[i].is_valid = gpmc_cs_mem_enabled(i);
2500 if (gpmc_context.cs_context[i].is_valid) {
2501 gpmc_context.cs_context[i].config1 =
2502 gpmc_cs_read_reg(i, GPMC_CS_CONFIG1);
2503 gpmc_context.cs_context[i].config2 =
2504 gpmc_cs_read_reg(i, GPMC_CS_CONFIG2);
2505 gpmc_context.cs_context[i].config3 =
2506 gpmc_cs_read_reg(i, GPMC_CS_CONFIG3);
2507 gpmc_context.cs_context[i].config4 =
2508 gpmc_cs_read_reg(i, GPMC_CS_CONFIG4);
2509 gpmc_context.cs_context[i].config5 =
2510 gpmc_cs_read_reg(i, GPMC_CS_CONFIG5);
2511 gpmc_context.cs_context[i].config6 =
2512 gpmc_cs_read_reg(i, GPMC_CS_CONFIG6);
2513 gpmc_context.cs_context[i].config7 =
2514 gpmc_cs_read_reg(i, GPMC_CS_CONFIG7);
2519 void omap3_gpmc_restore_context(void)
2526 gpmc_write_reg(GPMC_SYSCONFIG, gpmc_context.sysconfig);
2527 gpmc_write_reg(GPMC_IRQENABLE, gpmc_context.irqenable);
2528 gpmc_write_reg(GPMC_TIMEOUT_CONTROL, gpmc_context.timeout_ctrl);
2529 gpmc_write_reg(GPMC_CONFIG, gpmc_context.config);
2530 gpmc_write_reg(GPMC_PREFETCH_CONFIG1, gpmc_context.prefetch_config1);
2531 gpmc_write_reg(GPMC_PREFETCH_CONFIG2, gpmc_context.prefetch_config2);
2532 gpmc_write_reg(GPMC_PREFETCH_CONTROL, gpmc_context.prefetch_control);
2533 for (i = 0; i < gpmc_cs_num; i++) {
2534 if (gpmc_context.cs_context[i].is_valid) {
2535 gpmc_cs_write_reg(i, GPMC_CS_CONFIG1,
2536 gpmc_context.cs_context[i].config1);
2537 gpmc_cs_write_reg(i, GPMC_CS_CONFIG2,
2538 gpmc_context.cs_context[i].config2);
2539 gpmc_cs_write_reg(i, GPMC_CS_CONFIG3,
2540 gpmc_context.cs_context[i].config3);
2541 gpmc_cs_write_reg(i, GPMC_CS_CONFIG4,
2542 gpmc_context.cs_context[i].config4);
2543 gpmc_cs_write_reg(i, GPMC_CS_CONFIG5,
2544 gpmc_context.cs_context[i].config5);
2545 gpmc_cs_write_reg(i, GPMC_CS_CONFIG6,
2546 gpmc_context.cs_context[i].config6);
2547 gpmc_cs_write_reg(i, GPMC_CS_CONFIG7,
2548 gpmc_context.cs_context[i].config7);