arch/arm/mach-omap2/gpmc.c

   1 /*
   2  * GPMC support functions
   3  *
   4  * Copyright (C) 2005-2006 Nokia Corporation
   5  *
   6  * Author: Juha Yrjola
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  */
  12 #undef DEBUG
  13
  14 #include <linux/kernel.h>
  15 #include <linux/init.h>
  16 #include <linux/err.h>
  17 #include <linux/clk.h>
  18 #include <linux/ioport.h>
  19 #include <linux/spinlock.h>
  20 #include <linux/module.h>
  21 #include <linux/io.h>
  22
  23 #include <asm/mach-types.h>
  24 #include <asm/arch/gpmc.h>
  25
  26 #include "memory.h"
  27
  28 /* GPMC register offsets */
  29 #define GPMC_REVISION           0x00
  30 #define GPMC_SYSCONFIG          0x10
  31 #define GPMC_SYSSTATUS          0x14
  32 #define GPMC_IRQSTATUS          0x18
  33 #define GPMC_IRQENABLE          0x1c
  34 #define GPMC_TIMEOUT_CONTROL    0x40
  35 #define GPMC_ERR_ADDRESS        0x44
  36 #define GPMC_ERR_TYPE           0x48
  37 #define GPMC_CONFIG             0x50
  38 #define GPMC_STATUS             0x54
  39 #define GPMC_PREFETCH_CONFIG1   0x1e0
  40 #define GPMC_PREFETCH_CONFIG2   0x1e4
  41 #define GPMC_PREFETCH_CONTROL   0x1ec
  42 #define GPMC_PREFETCH_STATUS    0x1f0
  43 #define GPMC_ECC_CONFIG         0x1f4
  44 #define GPMC_ECC_CONTROL        0x1f8
  45 #define GPMC_ECC_SIZE_CONFIG    0x1fc
  46
  47 #define GPMC_CS0                0x60
  48 #define GPMC_CS_SIZE            0x30
  49
  50 #define GPMC_MEM_START          0x00000000
  51 #define GPMC_MEM_END            0x3FFFFFFF
  52 #define BOOT_ROM_SPACE          0x100000        /* 1MB */
  53
  54 #define GPMC_CHUNK_SHIFT        24              /* 16 MB */
  55 #define GPMC_SECTION_SHIFT      28              /* 128 MB */
  56
  57 static struct resource  gpmc_mem_root;
  58 static struct resource  gpmc_cs_mem[GPMC_CS_NUM];
  59 static DEFINE_SPINLOCK(gpmc_mem_lock);
  60 static unsigned         gpmc_cs_map;
  61
  62 static u32 gpmc_base;
  63
  64 static struct clk *gpmc_l3_clk;
  65
  66 static void gpmc_write_reg(int idx, u32 val)
  67 {
  68         __raw_writel(val, gpmc_base + idx);
  69 }
  70
  71 static u32 gpmc_read_reg(int idx)
  72 {
  73         return __raw_readl(gpmc_base + idx);
  74 }
  75
  76 void gpmc_cs_write_reg(int cs, int idx, u32 val)
  77 {
  78         u32 reg_addr;
  79
  80         reg_addr = gpmc_base + GPMC_CS0 + (cs * GPMC_CS_SIZE) + idx;
  81         __raw_writel(val, reg_addr);
  82 }
  83
  84 u32 gpmc_cs_read_reg(int cs, int idx)
  85 {
  86         return __raw_readl(gpmc_base + GPMC_CS0 + (cs * GPMC_CS_SIZE) + idx);
  87 }
  88
  89 /* TODO: Add support for gpmc_fck to clock framework and use it */
  90 unsigned long gpmc_get_fclk_period(void)
  91 {
  92         unsigned long rate = clk_get_rate(gpmc_l3_clk);
  93
  94         if (rate == 0) {
  95                 printk(KERN_WARNING "gpmc_l3_clk no enabled\n");
  96                 return 0;
  97         }
  98
  99         rate /= 1000;
 100         rate = 1000000000 / rate;       /* In picoseconds */
 101
 102         return rate;
 103 }
 104
 105 unsigned int gpmc_ns_to_ticks(unsigned int time_ns)
 106 {
 107         unsigned long tick_ps;
 108
 109         /* Calculate in picosecs to yield more exact results */
 110         tick_ps = gpmc_get_fclk_period();
 111
 112         return (time_ns * 1000 + tick_ps - 1) / tick_ps;
 113 }
 114
 115 unsigned int gpmc_ticks_to_ns(unsigned int ticks)
 116 {
 117         return ticks * gpmc_get_fclk_period() / 1000;
 118 }
 119
 120 unsigned int gpmc_round_ns_to_ticks(unsigned int time_ns)
 121 {
 122         unsigned long ticks = gpmc_ns_to_ticks(time_ns);
 123
 124         return ticks * gpmc_get_fclk_period() / 1000;
 125 }
 126
 127 #ifdef DEBUG
 128 static int set_gpmc_timing_reg(int cs, int reg, int st_bit, int end_bit,
 129                                int time, const char *name)
 130 #else
 131 static int set_gpmc_timing_reg(int cs, int reg, int st_bit, int end_bit,
 132                                int time)
 133 #endif
 134 {
 135         u32 l;
 136         int ticks, mask, nr_bits;
 137
 138         if (time == 0)
 139                 ticks = 0;
 140         else
 141                 ticks = gpmc_ns_to_ticks(time);
 142         nr_bits = end_bit - st_bit + 1;
 143         if (ticks >= 1 << nr_bits) {
 144 #ifdef DEBUG
 145                 printk(KERN_INFO "GPMC CS%d: %-10s* %3d ns, %3d ticks >= %d\n",
 146                                 cs, name, time, ticks, 1 << nr_bits);
 147 #endif
 148                 return -1;
 149         }
 150
 151         mask = (1 << nr_bits) - 1;
 152         l = gpmc_cs_read_reg(cs, reg);
 153 #ifdef DEBUG
 154         printk(KERN_INFO
 155                 "GPMC CS%d: %-10s: %3d ticks, %3lu ns (was %3i ticks) %3d ns\n",
 156                cs, name, ticks, gpmc_get_fclk_period() * ticks / 1000,
 157                         (l >> st_bit) & mask, time);
 158 #endif
 159         l &= ~(mask << st_bit);
 160         l |= ticks << st_bit;
 161         gpmc_cs_write_reg(cs, reg, l);
 162
 163         return 0;
 164 }
 165
 166 #ifdef DEBUG
 167 #define GPMC_SET_ONE(reg, st, end, field) \
 168         if (set_gpmc_timing_reg(cs, (reg), (st), (end),         \
 169                         t->field, #field) < 0)                  \
 170                 return -1
 171 #else
 172 #define GPMC_SET_ONE(reg, st, end, field) \
 173         if (set_gpmc_timing_reg(cs, (reg), (st), (end), t->field) < 0) \
 174                 return -1
 175 #endif
 176
 177 int gpmc_cs_calc_divider(int cs, unsigned int sync_clk)
 178 {
 179         int div;
 180         u32 l;
 181
 182         l = sync_clk * 1000 + (gpmc_get_fclk_period() - 1);
 183         div = l / gpmc_get_fclk_period();
 184         if (div > 4)
 185                 return -1;
 186         if (div <= 0)
 187                 div = 1;
 188
 189         return div;
 190 }
 191
 192 int gpmc_cs_set_timings(int cs, const struct gpmc_timings *t)
 193 {
 194         int div;
 195         u32 l;
 196
 197         div = gpmc_cs_calc_divider(cs, t->sync_clk);
 198         if (div < 0)
 199                 return -1;
 200
 201         GPMC_SET_ONE(GPMC_CS_CONFIG2,  0,  3, cs_on);
 202         GPMC_SET_ONE(GPMC_CS_CONFIG2,  8, 12, cs_rd_off);
 203         GPMC_SET_ONE(GPMC_CS_CONFIG2, 16, 20, cs_wr_off);
 204
 205         GPMC_SET_ONE(GPMC_CS_CONFIG3,  0,  3, adv_on);
 206         GPMC_SET_ONE(GPMC_CS_CONFIG3,  8, 12, adv_rd_off);
 207         GPMC_SET_ONE(GPMC_CS_CONFIG3, 16, 20, adv_wr_off);
 208
 209         GPMC_SET_ONE(GPMC_CS_CONFIG4,  0,  3, oe_on);
 210         GPMC_SET_ONE(GPMC_CS_CONFIG4,  8, 12, oe_off);
 211         GPMC_SET_ONE(GPMC_CS_CONFIG4, 16, 19, we_on);
 212         GPMC_SET_ONE(GPMC_CS_CONFIG4, 24, 28, we_off);
 213
 214         GPMC_SET_ONE(GPMC_CS_CONFIG5,  0,  4, rd_cycle);
 215         GPMC_SET_ONE(GPMC_CS_CONFIG5,  8, 12, wr_cycle);
 216         GPMC_SET_ONE(GPMC_CS_CONFIG5, 16, 20, access);
 217
 218         GPMC_SET_ONE(GPMC_CS_CONFIG5, 24, 27, page_burst_access);
 219
 220         /* caller is expected to have initialized CONFIG1 to cover
 221          * at least sync vs async
 222          */
 223         l = gpmc_cs_read_reg(cs, GPMC_CS_CONFIG1);
 224         if (l & (GPMC_CONFIG1_READTYPE_SYNC | GPMC_CONFIG1_WRITETYPE_SYNC)) {
 225 #ifdef DEBUG
 226                 printk(KERN_INFO "GPMC CS%d CLK period is %lu ns (div %d)\n",
 227                                 cs, (div * gpmc_get_fclk_period()) / 1000, div);
 228 #endif
 229                 l &= ~0x03;
 230                 l |= (div - 1);
 231                 gpmc_cs_write_reg(cs, GPMC_CS_CONFIG1, l);
 232         }
 233
 234         return 0;
 235 }
 236
 237 static void gpmc_cs_enable_mem(int cs, u32 base, u32 size)
 238 {
 239         u32 l;
 240         u32 mask;
 241
 242         mask = (1 << GPMC_SECTION_SHIFT) - size;
 243         l = gpmc_cs_read_reg(cs, GPMC_CS_CONFIG7);
 244         l &= ~0x3f;
 245         l = (base >> GPMC_CHUNK_SHIFT) & 0x3f;
 246         l &= ~(0x0f << 8);
 247         l |= ((mask >> GPMC_CHUNK_SHIFT) & 0x0f) << 8;
 248         l |= 1 << 6;            /* CSVALID */
 249         gpmc_cs_write_reg(cs, GPMC_CS_CONFIG7, l);
 250 }
 251
 252 static void gpmc_cs_disable_mem(int cs)
 253 {
 254         u32 l;
 255
 256         l = gpmc_cs_read_reg(cs, GPMC_CS_CONFIG7);
 257         l &= ~(1 << 6);         /* CSVALID */
 258         gpmc_cs_write_reg(cs, GPMC_CS_CONFIG7, l);
 259 }
 260
 261 static void gpmc_cs_get_memconf(int cs, u32 *base, u32 *size)
 262 {
 263         u32 l;
 264         u32 mask;
 265
 266         l = gpmc_cs_read_reg(cs, GPMC_CS_CONFIG7);
 267         *base = (l & 0x3f) << GPMC_CHUNK_SHIFT;
 268         mask = (l >> 8) & 0x0f;
 269         *size = (1 << GPMC_SECTION_SHIFT) - (mask << GPMC_CHUNK_SHIFT);
 270 }
 271
 272 static int gpmc_cs_mem_enabled(int cs)
 273 {
 274         u32 l;
 275
 276         l = gpmc_cs_read_reg(cs, GPMC_CS_CONFIG7);
 277         return l & (1 << 6);
 278 }
 279
 280 int gpmc_cs_set_reserved(int cs, int reserved)
 281 {
 282         if (cs > GPMC_CS_NUM)
 283                 return -ENODEV;
 284
 285         gpmc_cs_map &= ~(1 << cs);
 286         gpmc_cs_map |= (reserved ? 1 : 0) << cs;
 287
 288         return 0;
 289 }
 290
 291 int gpmc_cs_reserved(int cs)
 292 {
 293         if (cs > GPMC_CS_NUM)
 294                 return -ENODEV;
 295
 296         return gpmc_cs_map & (1 << cs);
 297 }
 298
 299 static unsigned long gpmc_mem_align(unsigned long size)
 300 {
 301         int order;
 302
 303         size = (size - 1) >> (GPMC_CHUNK_SHIFT - 1);
 304         order = GPMC_CHUNK_SHIFT - 1;
 305         do {
 306                 size >>= 1;
 307                 order++;
 308         } while (size);
 309         size = 1 << order;
 310         return size;
 311 }
 312
 313 static int gpmc_cs_insert_mem(int cs, unsigned long base, unsigned long size)
 314 {
 315         struct resource *res = &gpmc_cs_mem[cs];
 316         int r;
 317
 318         size = gpmc_mem_align(size);
 319         spin_lock(&gpmc_mem_lock);
 320         res->start = base;
 321         res->end = base + size - 1;
 322         r = request_resource(&gpmc_mem_root, res);
 323         spin_unlock(&gpmc_mem_lock);
 324
 325         return r;
 326 }
 327
 328 int gpmc_cs_request(int cs, unsigned long size, unsigned long *base)
 329 {
 330         struct resource *res = &gpmc_cs_mem[cs];
 331         int r = -1;
 332
 333         if (cs > GPMC_CS_NUM)
 334                 return -ENODEV;
 335
 336         size = gpmc_mem_align(size);
 337         if (size > (1 << GPMC_SECTION_SHIFT))
 338                 return -ENOMEM;
 339
 340         spin_lock(&gpmc_mem_lock);
 341         if (gpmc_cs_reserved(cs)) {
 342                 r = -EBUSY;
 343                 goto out;
 344         }
 345         if (gpmc_cs_mem_enabled(cs))
 346                 r = adjust_resource(res, res->start & ~(size - 1), size);
 347         if (r < 0)
 348                 r = allocate_resource(&gpmc_mem_root, res, size, 0, ~0,
 349                                       size, NULL, NULL);
 350         if (r < 0)
 351                 goto out;
 352
 353         gpmc_cs_enable_mem(cs, res->start, res->end - res->start + 1);
 354         *base = res->start;
 355         gpmc_cs_set_reserved(cs, 1);
 356 out:
 357         spin_unlock(&gpmc_mem_lock);
 358         return r;
 359 }
 360 EXPORT_SYMBOL(gpmc_cs_request);
 361
 362 void gpmc_cs_free(int cs)
 363 {
 364         spin_lock(&gpmc_mem_lock);
 365         if (cs >= GPMC_CS_NUM || !gpmc_cs_reserved(cs)) {
 366                 printk(KERN_ERR "Trying to free non-reserved GPMC CS%d\n", cs);
 367                 BUG();
 368                 spin_unlock(&gpmc_mem_lock);
 369                 return;
 370         }
 371         gpmc_cs_disable_mem(cs);
 372         release_resource(&gpmc_cs_mem[cs]);
 373         gpmc_cs_set_reserved(cs, 0);
 374         spin_unlock(&gpmc_mem_lock);
 375 }
 376 EXPORT_SYMBOL(gpmc_cs_free);
 377
 378 static void __init gpmc_mem_init(void)
 379 {
 380         int cs;
 381         unsigned long boot_rom_space = 0;
 382
 383         /* never allocate the first page, to facilitate bug detection;
 384          * even if we didn't boot from ROM.
 385          */
 386         boot_rom_space = BOOT_ROM_SPACE;
 387         /* In apollon the CS0 is mapped as 0x0000 0000 */
 388         if (machine_is_omap_apollon())
 389                 boot_rom_space = 0;
 390         gpmc_mem_root.start = GPMC_MEM_START + boot_rom_space;
 391         gpmc_mem_root.end = GPMC_MEM_END;
 392
 393         /* Reserve all regions that has been set up by bootloader */
 394         for (cs = 0; cs < GPMC_CS_NUM; cs++) {
 395                 u32 base, size;
 396
 397                 if (!gpmc_cs_mem_enabled(cs))
 398                         continue;
 399                 gpmc_cs_get_memconf(cs, &base, &size);
 400                 if (gpmc_cs_insert_mem(cs, base, size) < 0)
 401                         BUG();
 402         }
 403 }
 404
 405 void __init gpmc_init(void)
 406 {
 407         u32 l;
 408
 409         if (cpu_is_omap24xx()) {
 410                 gpmc_l3_clk = clk_get(NULL, "core_l3_ck");
 411                 if (cpu_is_omap2420())
 412                         gpmc_base = io_p2v(OMAP2420_GPMC_BASE);
 413                 else if (cpu_is_omap2430())
 414                         gpmc_base = io_p2v(OMAP243X_GPMC_BASE);
 415         } else if (cpu_is_omap34xx()) {
 416                 gpmc_l3_clk = clk_get(NULL, "gpmc_fck");
 417                 gpmc_base = io_p2v(OMAP34XX_GPMC_BASE);
 418         }
 419
 420         BUG_ON(IS_ERR(gpmc_l3_clk));
 421
 422         l = gpmc_read_reg(GPMC_REVISION);
 423         printk(KERN_INFO "GPMC revision %d.%d\n", (l >> 4) & 0x0f, l & 0x0f);
 424         /* Set smart idle mode and automatic L3 clock gating */
 425         l = gpmc_read_reg(GPMC_SYSCONFIG);
 426         l &= 0x03 << 3;
 427         l |= (0x02 << 3) | (1 << 0);
 428         gpmc_write_reg(GPMC_SYSCONFIG, l);
 429
 430         gpmc_mem_init();
 431 }