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