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