First Support on Ginger and OMAP TI
[linux-ginger.git] / arch / arm / mach-omap2 / gpmc.c
blob7d687845f391a3a8e0818c04b1eb4de051526ff1
1 /*
2 * GPMC support functions
4 * Copyright (C) 2005-2006 Nokia Corporation
6 * Author: Juha Yrjola
8 * Copyright (C) 2009 Texas Instruments
9 * Added OMAP4 support - Santosh Shilimkar <santosh.shilimkar@ti.com>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2 as
13 * published by the Free Software Foundation.
15 #undef DEBUG
17 #include <linux/kernel.h>
18 #include <linux/init.h>
19 #include <linux/err.h>
20 #include <linux/clk.h>
21 #include <linux/ioport.h>
22 #include <linux/spinlock.h>
23 #include <linux/io.h>
24 #include <linux/module.h>
26 #include <asm/mach-types.h>
27 #include <plat/gpmc.h>
29 #include <plat/sdrc.h>
31 /* GPMC register offsets */
32 #define GPMC_REVISION 0x00
33 #define GPMC_SYSCONFIG 0x10
34 #define GPMC_SYSSTATUS 0x14
35 #define GPMC_IRQSTATUS 0x18
36 #define GPMC_IRQENABLE 0x1c
37 #define GPMC_TIMEOUT_CONTROL 0x40
38 #define GPMC_ERR_ADDRESS 0x44
39 #define GPMC_ERR_TYPE 0x48
40 #define GPMC_CONFIG 0x50
41 #define GPMC_STATUS 0x54
42 #define GPMC_PREFETCH_CONFIG1 0x1e0
43 #define GPMC_PREFETCH_CONFIG2 0x1e4
44 #define GPMC_PREFETCH_CONTROL 0x1ec
45 #define GPMC_PREFETCH_STATUS 0x1f0
46 #define GPMC_ECC_CONFIG 0x1f4
47 #define GPMC_ECC_CONTROL 0x1f8
48 #define GPMC_ECC_SIZE_CONFIG 0x1fc
50 #define GPMC_CS0 0x60
51 #define GPMC_CS_SIZE 0x30
53 #define GPMC_MEM_START 0x00000000
54 #define GPMC_MEM_END 0x3FFFFFFF
55 #define BOOT_ROM_SPACE 0x100000 /* 1MB */
57 #define GPMC_CHUNK_SHIFT 24 /* 16 MB */
58 #define GPMC_SECTION_SHIFT 28 /* 128 MB */
60 #define PREFETCH_FIFOTHRESHOLD (0x40 << 8)
61 #define CS_NUM_SHIFT 24
62 #define ENABLE_PREFETCH (0x1 << 7)
63 #define DMA_MPU_MODE 2
65 /* Structure to save gpmc cs context */
66 struct gpmc_cs_config {
67 u32 config1;
68 u32 config2;
69 u32 config3;
70 u32 config4;
71 u32 config5;
72 u32 config6;
73 u32 config7;
74 int is_valid;
78 * Structure to save/restore gpmc context
79 * to support core off on OMAP3
81 struct omap3_gpmc_regs {
82 u32 sysconfig;
83 u32 irqenable;
84 u32 timeout_ctrl;
85 u32 config;
86 u32 prefetch_config1;
87 u32 prefetch_config2;
88 u32 prefetch_control;
89 struct gpmc_cs_config cs_context[GPMC_CS_NUM];
92 static struct resource gpmc_mem_root;
93 static struct resource gpmc_cs_mem[GPMC_CS_NUM];
94 static DEFINE_SPINLOCK(gpmc_mem_lock);
95 static unsigned gpmc_cs_map;
97 static void __iomem *gpmc_base;
99 static struct clk *gpmc_l3_clk;
101 static void gpmc_write_reg(int idx, u32 val)
103 __raw_writel(val, gpmc_base + idx);
106 static u32 gpmc_read_reg(int idx)
108 return __raw_readl(gpmc_base + idx);
111 void gpmc_cs_write_reg(int cs, int idx, u32 val)
113 void __iomem *reg_addr;
115 reg_addr = gpmc_base + GPMC_CS0 + (cs * GPMC_CS_SIZE) + idx;
116 __raw_writel(val, reg_addr);
119 u32 gpmc_cs_read_reg(int cs, int idx)
121 void __iomem *reg_addr;
123 reg_addr = gpmc_base + GPMC_CS0 + (cs * GPMC_CS_SIZE) + idx;
124 return __raw_readl(reg_addr);
127 /* TODO: Add support for gpmc_fck to clock framework and use it */
128 unsigned long gpmc_get_fclk_period(void)
130 unsigned long rate = clk_get_rate(gpmc_l3_clk);
132 if (rate == 0) {
133 printk(KERN_WARNING "gpmc_l3_clk not enabled\n");
134 return 0;
137 rate /= 1000;
138 rate = 1000000000 / rate; /* In picoseconds */
140 return rate;
143 unsigned int gpmc_ns_to_ticks(unsigned int time_ns)
145 unsigned long tick_ps;
147 /* Calculate in picosecs to yield more exact results */
148 tick_ps = gpmc_get_fclk_period();
150 return (time_ns * 1000 + tick_ps - 1) / tick_ps;
153 unsigned int gpmc_ticks_to_ns(unsigned int ticks)
155 return ticks * gpmc_get_fclk_period() / 1000;
158 unsigned int gpmc_round_ns_to_ticks(unsigned int time_ns)
160 unsigned long ticks = gpmc_ns_to_ticks(time_ns);
162 return ticks * gpmc_get_fclk_period() / 1000;
165 #ifdef DEBUG
166 static int set_gpmc_timing_reg(int cs, int reg, int st_bit, int end_bit,
167 int time, const char *name)
168 #else
169 static int set_gpmc_timing_reg(int cs, int reg, int st_bit, int end_bit,
170 int time)
171 #endif
173 u32 l;
174 int ticks, mask, nr_bits;
176 if (time == 0)
177 ticks = 0;
178 else
179 ticks = gpmc_ns_to_ticks(time);
180 nr_bits = end_bit - st_bit + 1;
181 if (ticks >= 1 << nr_bits) {
182 #ifdef DEBUG
183 printk(KERN_INFO "GPMC CS%d: %-10s* %3d ns, %3d ticks >= %d\n",
184 cs, name, time, ticks, 1 << nr_bits);
185 #endif
186 return -1;
189 mask = (1 << nr_bits) - 1;
190 l = gpmc_cs_read_reg(cs, reg);
191 #ifdef DEBUG
192 printk(KERN_INFO
193 "GPMC CS%d: %-10s: %3d ticks, %3lu ns (was %3i ticks) %3d ns\n",
194 cs, name, ticks, gpmc_get_fclk_period() * ticks / 1000,
195 (l >> st_bit) & mask, time);
196 #endif
197 l &= ~(mask << st_bit);
198 l |= ticks << st_bit;
199 gpmc_cs_write_reg(cs, reg, l);
201 return 0;
204 #ifdef DEBUG
205 #define GPMC_SET_ONE(reg, st, end, field) \
206 if (set_gpmc_timing_reg(cs, (reg), (st), (end), \
207 t->field, #field) < 0) \
208 return -1
209 #else
210 #define GPMC_SET_ONE(reg, st, end, field) \
211 if (set_gpmc_timing_reg(cs, (reg), (st), (end), t->field) < 0) \
212 return -1
213 #endif
215 int gpmc_cs_calc_divider(int cs, unsigned int sync_clk)
217 int div;
218 u32 l;
220 l = sync_clk * 1000 + (gpmc_get_fclk_period() - 1);
221 div = l / gpmc_get_fclk_period();
222 if (div > 4)
223 return -1;
224 if (div <= 0)
225 div = 1;
227 return div;
230 int gpmc_cs_set_timings(int cs, const struct gpmc_timings *t)
232 int div;
233 u32 l;
235 div = gpmc_cs_calc_divider(cs, t->sync_clk);
236 if (div < 0)
237 return -1;
239 GPMC_SET_ONE(GPMC_CS_CONFIG2, 0, 3, cs_on);
240 GPMC_SET_ONE(GPMC_CS_CONFIG2, 8, 12, cs_rd_off);
241 GPMC_SET_ONE(GPMC_CS_CONFIG2, 16, 20, cs_wr_off);
243 GPMC_SET_ONE(GPMC_CS_CONFIG3, 0, 3, adv_on);
244 GPMC_SET_ONE(GPMC_CS_CONFIG3, 8, 12, adv_rd_off);
245 GPMC_SET_ONE(GPMC_CS_CONFIG3, 16, 20, adv_wr_off);
247 GPMC_SET_ONE(GPMC_CS_CONFIG4, 0, 3, oe_on);
248 GPMC_SET_ONE(GPMC_CS_CONFIG4, 8, 12, oe_off);
249 GPMC_SET_ONE(GPMC_CS_CONFIG4, 16, 19, we_on);
250 GPMC_SET_ONE(GPMC_CS_CONFIG4, 24, 28, we_off);
252 GPMC_SET_ONE(GPMC_CS_CONFIG5, 0, 4, rd_cycle);
253 GPMC_SET_ONE(GPMC_CS_CONFIG5, 8, 12, wr_cycle);
254 GPMC_SET_ONE(GPMC_CS_CONFIG5, 16, 20, access);
256 GPMC_SET_ONE(GPMC_CS_CONFIG5, 24, 27, page_burst_access);
258 if (cpu_is_omap34xx()) {
259 GPMC_SET_ONE(GPMC_CS_CONFIG6, 16, 19, wr_data_mux_bus);
260 GPMC_SET_ONE(GPMC_CS_CONFIG6, 24, 28, wr_access);
263 /* caller is expected to have initialized CONFIG1 to cover
264 * at least sync vs async
266 l = gpmc_cs_read_reg(cs, GPMC_CS_CONFIG1);
267 if (l & (GPMC_CONFIG1_READTYPE_SYNC | GPMC_CONFIG1_WRITETYPE_SYNC)) {
268 #ifdef DEBUG
269 printk(KERN_INFO "GPMC CS%d CLK period is %lu ns (div %d)\n",
270 cs, (div * gpmc_get_fclk_period()) / 1000, div);
271 #endif
272 l &= ~0x03;
273 l |= (div - 1);
274 gpmc_cs_write_reg(cs, GPMC_CS_CONFIG1, l);
277 return 0;
280 static void gpmc_cs_enable_mem(int cs, u32 base, u32 size)
282 u32 l;
283 u32 mask;
285 mask = (1 << GPMC_SECTION_SHIFT) - size;
286 l = gpmc_cs_read_reg(cs, GPMC_CS_CONFIG7);
287 l &= ~0x3f;
288 l = (base >> GPMC_CHUNK_SHIFT) & 0x3f;
289 l &= ~(0x0f << 8);
290 l |= ((mask >> GPMC_CHUNK_SHIFT) & 0x0f) << 8;
291 l |= GPMC_CONFIG7_CSVALID;
292 gpmc_cs_write_reg(cs, GPMC_CS_CONFIG7, l);
295 static void gpmc_cs_disable_mem(int cs)
297 u32 l;
299 l = gpmc_cs_read_reg(cs, GPMC_CS_CONFIG7);
300 l &= ~GPMC_CONFIG7_CSVALID;
301 gpmc_cs_write_reg(cs, GPMC_CS_CONFIG7, l);
304 static void gpmc_cs_get_memconf(int cs, u32 *base, u32 *size)
306 u32 l;
307 u32 mask;
309 l = gpmc_cs_read_reg(cs, GPMC_CS_CONFIG7);
310 *base = (l & 0x3f) << GPMC_CHUNK_SHIFT;
311 mask = (l >> 8) & 0x0f;
312 *size = (1 << GPMC_SECTION_SHIFT) - (mask << GPMC_CHUNK_SHIFT);
315 static int gpmc_cs_mem_enabled(int cs)
317 u32 l;
319 l = gpmc_cs_read_reg(cs, GPMC_CS_CONFIG7);
320 return l & GPMC_CONFIG7_CSVALID;
323 int gpmc_cs_set_reserved(int cs, int reserved)
325 if (cs > GPMC_CS_NUM)
326 return -ENODEV;
328 gpmc_cs_map &= ~(1 << cs);
329 gpmc_cs_map |= (reserved ? 1 : 0) << cs;
331 return 0;
334 int gpmc_cs_reserved(int cs)
336 if (cs > GPMC_CS_NUM)
337 return -ENODEV;
339 return gpmc_cs_map & (1 << cs);
342 static unsigned long gpmc_mem_align(unsigned long size)
344 int order;
346 size = (size - 1) >> (GPMC_CHUNK_SHIFT - 1);
347 order = GPMC_CHUNK_SHIFT - 1;
348 do {
349 size >>= 1;
350 order++;
351 } while (size);
352 size = 1 << order;
353 return size;
356 static int gpmc_cs_insert_mem(int cs, unsigned long base, unsigned long size)
358 struct resource *res = &gpmc_cs_mem[cs];
359 int r;
361 size = gpmc_mem_align(size);
362 spin_lock(&gpmc_mem_lock);
363 res->start = base;
364 res->end = base + size - 1;
365 r = request_resource(&gpmc_mem_root, res);
366 spin_unlock(&gpmc_mem_lock);
368 return r;
371 int gpmc_cs_request(int cs, unsigned long size, unsigned long *base)
373 struct resource *res = &gpmc_cs_mem[cs];
374 int r = -1;
376 if (cs > GPMC_CS_NUM)
377 return -ENODEV;
379 size = gpmc_mem_align(size);
380 if (size > (1 << GPMC_SECTION_SHIFT))
381 return -ENOMEM;
383 spin_lock(&gpmc_mem_lock);
384 if (gpmc_cs_reserved(cs)) {
385 r = -EBUSY;
386 goto out;
388 if (gpmc_cs_mem_enabled(cs))
389 r = adjust_resource(res, res->start & ~(size - 1), size);
390 if (r < 0)
391 r = allocate_resource(&gpmc_mem_root, res, size, 0, ~0,
392 size, NULL, NULL);
393 if (r < 0)
394 goto out;
396 gpmc_cs_enable_mem(cs, res->start, res->end - res->start + 1);
397 *base = res->start;
398 gpmc_cs_set_reserved(cs, 1);
399 out:
400 spin_unlock(&gpmc_mem_lock);
401 return r;
403 EXPORT_SYMBOL(gpmc_cs_request);
405 void gpmc_cs_free(int cs)
407 spin_lock(&gpmc_mem_lock);
408 if (cs >= GPMC_CS_NUM || !gpmc_cs_reserved(cs)) {
409 printk(KERN_ERR "Trying to free non-reserved GPMC CS%d\n", cs);
410 BUG();
411 spin_unlock(&gpmc_mem_lock);
412 return;
414 gpmc_cs_disable_mem(cs);
415 release_resource(&gpmc_cs_mem[cs]);
416 gpmc_cs_set_reserved(cs, 0);
417 spin_unlock(&gpmc_mem_lock);
419 EXPORT_SYMBOL(gpmc_cs_free);
422 * gpmc_prefetch_enable - configures and starts prefetch transfer
423 * @cs: nand cs (chip select) number
424 * @dma_mode: dma mode enable (1) or disable (0)
425 * @u32_count: number of bytes to be transferred
426 * @is_write: prefetch read(0) or write post(1) mode
428 int gpmc_prefetch_enable(int cs, int dma_mode,
429 unsigned int u32_count, int is_write)
431 uint32_t prefetch_config1;
433 if (!(gpmc_read_reg(GPMC_PREFETCH_CONTROL))) {
434 /* Set the amount of bytes to be prefetched */
435 gpmc_write_reg(GPMC_PREFETCH_CONFIG2, u32_count);
437 /* Set dma/mpu mode, the prefetch read / post write and
438 * enable the engine. Set which cs is has requested for.
440 prefetch_config1 = ((cs << CS_NUM_SHIFT) |
441 PREFETCH_FIFOTHRESHOLD |
442 ENABLE_PREFETCH |
443 (dma_mode << DMA_MPU_MODE) |
444 (0x1 & is_write));
445 gpmc_write_reg(GPMC_PREFETCH_CONFIG1, prefetch_config1);
446 } else {
447 return -EBUSY;
449 /* Start the prefetch engine */
450 gpmc_write_reg(GPMC_PREFETCH_CONTROL, 0x1);
452 return 0;
454 EXPORT_SYMBOL(gpmc_prefetch_enable);
457 * gpmc_prefetch_reset - disables and stops the prefetch engine
459 void gpmc_prefetch_reset(void)
461 /* Stop the PFPW engine */
462 gpmc_write_reg(GPMC_PREFETCH_CONTROL, 0x0);
464 /* Reset/disable the PFPW engine */
465 gpmc_write_reg(GPMC_PREFETCH_CONFIG1, 0x0);
467 EXPORT_SYMBOL(gpmc_prefetch_reset);
470 * gpmc_prefetch_status - reads prefetch status of engine
472 int gpmc_prefetch_status(void)
474 return gpmc_read_reg(GPMC_PREFETCH_STATUS);
476 EXPORT_SYMBOL(gpmc_prefetch_status);
478 static void __init gpmc_mem_init(void)
480 int cs;
481 unsigned long boot_rom_space = 0;
483 /* never allocate the first page, to facilitate bug detection;
484 * even if we didn't boot from ROM.
486 boot_rom_space = BOOT_ROM_SPACE;
487 /* In apollon the CS0 is mapped as 0x0000 0000 */
488 if (machine_is_omap_apollon())
489 boot_rom_space = 0;
490 gpmc_mem_root.start = GPMC_MEM_START + boot_rom_space;
491 gpmc_mem_root.end = GPMC_MEM_END;
493 /* Reserve all regions that has been set up by bootloader */
494 for (cs = 0; cs < GPMC_CS_NUM; cs++) {
495 u32 base, size;
497 if (!gpmc_cs_mem_enabled(cs))
498 continue;
499 gpmc_cs_get_memconf(cs, &base, &size);
500 if (gpmc_cs_insert_mem(cs, base, size) < 0)
501 BUG();
505 void __init gpmc_init(void)
507 u32 l;
508 char *ck;
510 if (cpu_is_omap24xx()) {
511 ck = "core_l3_ck";
512 if (cpu_is_omap2420())
513 l = OMAP2420_GPMC_BASE;
514 else
515 l = OMAP34XX_GPMC_BASE;
516 } else if (cpu_is_omap34xx()) {
517 ck = "gpmc_fck";
518 l = OMAP34XX_GPMC_BASE;
519 } else if (cpu_is_omap44xx()) {
520 ck = "gpmc_fck";
521 l = OMAP44XX_GPMC_BASE;
524 gpmc_l3_clk = clk_get(NULL, ck);
525 if (IS_ERR(gpmc_l3_clk)) {
526 printk(KERN_ERR "Could not get GPMC clock %s\n", ck);
527 BUG();
530 gpmc_base = ioremap(l, SZ_4K);
531 if (!gpmc_base) {
532 clk_put(gpmc_l3_clk);
533 printk(KERN_ERR "Could not get GPMC register memory\n");
534 BUG();
537 l = gpmc_read_reg(GPMC_REVISION);
538 printk(KERN_INFO "GPMC revision %d.%d\n", (l >> 4) & 0x0f, l & 0x0f);
539 /* Set smart idle mode and automatic L3 clock gating */
540 l = gpmc_read_reg(GPMC_SYSCONFIG);
541 l &= 0x03 << 3;
542 l |= (0x02 << 3) | (1 << 0);
543 gpmc_write_reg(GPMC_SYSCONFIG, l);
544 gpmc_mem_init();
547 #ifdef CONFIG_ARCH_OMAP3
548 static struct omap3_gpmc_regs gpmc_context;
550 void omap3_gpmc_save_context()
552 int i;
553 gpmc_context.sysconfig = gpmc_read_reg(GPMC_SYSCONFIG);
554 gpmc_context.irqenable = gpmc_read_reg(GPMC_IRQENABLE);
555 gpmc_context.timeout_ctrl = gpmc_read_reg(GPMC_TIMEOUT_CONTROL);
556 gpmc_context.config = gpmc_read_reg(GPMC_CONFIG);
557 gpmc_context.prefetch_config1 = gpmc_read_reg(GPMC_PREFETCH_CONFIG1);
558 gpmc_context.prefetch_config2 = gpmc_read_reg(GPMC_PREFETCH_CONFIG2);
559 gpmc_context.prefetch_control = gpmc_read_reg(GPMC_PREFETCH_CONTROL);
560 for (i = 0; i < GPMC_CS_NUM; i++) {
561 gpmc_context.cs_context[i].is_valid = gpmc_cs_mem_enabled(i);
562 if (gpmc_context.cs_context[i].is_valid) {
563 gpmc_context.cs_context[i].config1 =
564 gpmc_cs_read_reg(i, GPMC_CS_CONFIG1);
565 gpmc_context.cs_context[i].config2 =
566 gpmc_cs_read_reg(i, GPMC_CS_CONFIG2);
567 gpmc_context.cs_context[i].config3 =
568 gpmc_cs_read_reg(i, GPMC_CS_CONFIG3);
569 gpmc_context.cs_context[i].config4 =
570 gpmc_cs_read_reg(i, GPMC_CS_CONFIG4);
571 gpmc_context.cs_context[i].config5 =
572 gpmc_cs_read_reg(i, GPMC_CS_CONFIG5);
573 gpmc_context.cs_context[i].config6 =
574 gpmc_cs_read_reg(i, GPMC_CS_CONFIG6);
575 gpmc_context.cs_context[i].config7 =
576 gpmc_cs_read_reg(i, GPMC_CS_CONFIG7);
581 void omap3_gpmc_restore_context()
583 int i;
584 gpmc_write_reg(GPMC_SYSCONFIG, gpmc_context.sysconfig);
585 gpmc_write_reg(GPMC_IRQENABLE, gpmc_context.irqenable);
586 gpmc_write_reg(GPMC_TIMEOUT_CONTROL, gpmc_context.timeout_ctrl);
587 gpmc_write_reg(GPMC_CONFIG, gpmc_context.config);
588 gpmc_write_reg(GPMC_PREFETCH_CONFIG1, gpmc_context.prefetch_config1);
589 gpmc_write_reg(GPMC_PREFETCH_CONFIG2, gpmc_context.prefetch_config2);
590 gpmc_write_reg(GPMC_PREFETCH_CONTROL, gpmc_context.prefetch_control);
591 for (i = 0; i < GPMC_CS_NUM; i++) {
592 if (gpmc_context.cs_context[i].is_valid) {
593 gpmc_cs_write_reg(i, GPMC_CS_CONFIG1,
594 gpmc_context.cs_context[i].config1);
595 gpmc_cs_write_reg(i, GPMC_CS_CONFIG2,
596 gpmc_context.cs_context[i].config2);
597 gpmc_cs_write_reg(i, GPMC_CS_CONFIG3,
598 gpmc_context.cs_context[i].config3);
599 gpmc_cs_write_reg(i, GPMC_CS_CONFIG4,
600 gpmc_context.cs_context[i].config4);
601 gpmc_cs_write_reg(i, GPMC_CS_CONFIG5,
602 gpmc_context.cs_context[i].config5);
603 gpmc_cs_write_reg(i, GPMC_CS_CONFIG6,
604 gpmc_context.cs_context[i].config6);
605 gpmc_cs_write_reg(i, GPMC_CS_CONFIG7,
606 gpmc_context.cs_context[i].config7);
610 #endif /* CONFIG_ARCH_OMAP3 */