drivers/pcmcia/at91_cf.c

   1 /*
   2  * at91_cf.c -- AT91 CompactFlash controller driver
   3  *
   4  * Copyright (C) 2005 David Brownell
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  */
  11
  12 #include <linux/module.h>
  13 #include <linux/kernel.h>
  14 #include <linux/sched.h>
  15 #include <linux/platform_device.h>
  16 #include <linux/errno.h>
  17 #include <linux/init.h>
  18 #include <linux/interrupt.h>
  19
  20 #include <pcmcia/ss.h>
  21
  22 #include <asm/hardware.h>
  23 #include <asm/io.h>
  24 #include <asm/sizes.h>
  25
  26 #include <asm/arch/at91rm9200.h>
  27 #include <asm/arch/board.h>
  28 #include <asm/arch/gpio.h>
  29
  30
  31 /*
  32  * A0..A10 work in each range; A23 indicates I/O space;  A25 is CFRNW;
  33  * some other bit in {A24,A22..A11} is nREG to flag memory access
  34  * (vs attributes).  So more than 2KB/region would just be waste.
  35  * Note: These are offsets from the physical base address.
  36  */
  37 #define CF_ATTR_PHYS    (0)
  38 #define CF_IO_PHYS      (1 << 23)
  39 #define CF_MEM_PHYS     (0x017ff800)
  40
  41 /*--------------------------------------------------------------------------*/
  42
  43 static const char driver_name[] = "at91_cf";
  44
  45 struct at91_cf_socket {
  46         struct pcmcia_socket    socket;
  47
  48         unsigned                present:1;
  49
  50         struct platform_device  *pdev;
  51         struct at91_cf_data     *board;
  52
  53         unsigned long           phys_baseaddr;
  54 };
  55
  56 #define SZ_2K                   (2 * SZ_1K)
  57
  58 static inline int at91_cf_present(struct at91_cf_socket *cf)
  59 {
  60         return !at91_get_gpio_value(cf->board->det_pin);
  61 }
  62
  63 /*--------------------------------------------------------------------------*/
  64
  65 static int at91_cf_ss_init(struct pcmcia_socket *s)
  66 {
  67         return 0;
  68 }
  69
  70 static irqreturn_t at91_cf_irq(int irq, void *_cf)
  71 {
  72         struct at91_cf_socket *cf = _cf;
  73
  74         if (irq == cf->board->det_pin) {
  75                 unsigned present = at91_cf_present(cf);
  76
  77                 /* kick pccard as needed */
  78                 if (present != cf->present) {
  79                         cf->present = present;
  80                         pr_debug("%s: card %s\n", driver_name,
  81                                         present ? "present" : "gone");
  82                         pcmcia_parse_events(&cf->socket, SS_DETECT);
  83                 }
  84         }
  85
  86         return IRQ_HANDLED;
  87 }
  88
  89 static int at91_cf_get_status(struct pcmcia_socket *s, u_int *sp)
  90 {
  91         struct at91_cf_socket   *cf;
  92
  93         if (!sp)
  94                 return -EINVAL;
  95
  96         cf = container_of(s, struct at91_cf_socket, socket);
  97
  98         /* NOTE: CF is always 3VCARD */
  99         if (at91_cf_present(cf)) {
 100                 int rdy = cf->board->irq_pin;   /* RDY/nIRQ */
 101                 int vcc = cf->board->vcc_pin;
 102
 103                 *sp = SS_DETECT | SS_3VCARD;
 104                 if (!rdy || at91_get_gpio_value(rdy))
 105                         *sp |= SS_READY;
 106                 if (!vcc || at91_get_gpio_value(vcc))
 107                         *sp |= SS_POWERON;
 108         } else
 109                 *sp = 0;
 110
 111         return 0;
 112 }
 113
 114 static int
 115 at91_cf_set_socket(struct pcmcia_socket *sock, struct socket_state_t *s)
 116 {
 117         struct at91_cf_socket   *cf;
 118
 119         cf = container_of(sock, struct at91_cf_socket, socket);
 120
 121         /* switch Vcc if needed and possible */
 122         if (cf->board->vcc_pin) {
 123                 switch (s->Vcc) {
 124                         case 0:
 125                                 at91_set_gpio_value(cf->board->vcc_pin, 0);
 126                                 break;
 127                         case 33:
 128                                 at91_set_gpio_value(cf->board->vcc_pin, 1);
 129                                 break;
 130                         default:
 131                                 return -EINVAL;
 132                 }
 133         }
 134
 135         /* toggle reset if needed */
 136         at91_set_gpio_value(cf->board->rst_pin, s->flags & SS_RESET);
 137
 138         pr_debug("%s: Vcc %d, io_irq %d, flags %04x csc %04x\n",
 139                 driver_name, s->Vcc, s->io_irq, s->flags, s->csc_mask);
 140
 141         return 0;
 142 }
 143
 144 static int at91_cf_ss_suspend(struct pcmcia_socket *s)
 145 {
 146         return at91_cf_set_socket(s, &dead_socket);
 147 }
 148
 149 /* we already mapped the I/O region */
 150 static int at91_cf_set_io_map(struct pcmcia_socket *s, struct pccard_io_map *io)
 151 {
 152         struct at91_cf_socket   *cf;
 153         u32                     csr;
 154
 155         cf = container_of(s, struct at91_cf_socket, socket);
 156         io->flags &= (MAP_ACTIVE | MAP_16BIT | MAP_AUTOSZ);
 157
 158         /*
 159          * Use 16 bit accesses unless/until we need 8-bit i/o space.
 160          * Always set CSR4 ... PCMCIA won't always unmap things.
 161          */
 162         csr = at91_sys_read(AT91_SMC_CSR(4)) & ~AT91_SMC_DBW;
 163
 164         /*
 165          * NOTE: this CF controller ignores IOIS16, so we can't really do
 166          * MAP_AUTOSZ.  The 16bit mode allows single byte access on either
 167          * D0-D7 (even addr) or D8-D15 (odd), so it's close enough for many
 168          * purposes (and handles ide-cs).
 169          *
 170          * The 8bit mode is needed for odd byte access on D0-D7.  It seems
 171          * some cards only like that way to get at the odd byte, despite
 172          * CF 3.0 spec table 35 also giving the D8-D15 option.
 173          */
 174         if (!(io->flags & (MAP_16BIT | MAP_AUTOSZ))) {
 175                 csr |= AT91_SMC_DBW_8;
 176                 pr_debug("%s: 8bit i/o bus\n", driver_name);
 177         } else {
 178                 csr |= AT91_SMC_DBW_16;
 179                 pr_debug("%s: 16bit i/o bus\n", driver_name);
 180         }
 181         at91_sys_write(AT91_SMC_CSR(4), csr);
 182
 183         io->start = cf->socket.io_offset;
 184         io->stop = io->start + SZ_2K - 1;
 185
 186         return 0;
 187 }
 188
 189 /* pcmcia layer maps/unmaps mem regions */
 190 static int
 191 at91_cf_set_mem_map(struct pcmcia_socket *s, struct pccard_mem_map *map)
 192 {
 193         struct at91_cf_socket   *cf;
 194
 195         if (map->card_start)
 196                 return -EINVAL;
 197
 198         cf = container_of(s, struct at91_cf_socket, socket);
 199
 200         map->flags &= (MAP_ACTIVE | MAP_ATTRIB | MAP_16BIT);
 201         if (map->flags & MAP_ATTRIB)
 202                 map->static_start = cf->phys_baseaddr + CF_ATTR_PHYS;
 203         else
 204                 map->static_start = cf->phys_baseaddr + CF_MEM_PHYS;
 205
 206         return 0;
 207 }
 208
 209 static struct pccard_operations at91_cf_ops = {
 210         .init                   = at91_cf_ss_init,
 211         .suspend                = at91_cf_ss_suspend,
 212         .get_status             = at91_cf_get_status,
 213         .set_socket             = at91_cf_set_socket,
 214         .set_io_map             = at91_cf_set_io_map,
 215         .set_mem_map            = at91_cf_set_mem_map,
 216 };
 217
 218 /*--------------------------------------------------------------------------*/
 219
 220 static int __init at91_cf_probe(struct platform_device *pdev)
 221 {
 222         struct at91_cf_socket   *cf;
 223         struct at91_cf_data     *board = pdev->dev.platform_data;
 224         struct resource         *io;
 225         unsigned int            csa;
 226         int                     status;
 227
 228         if (!board || !board->det_pin || !board->rst_pin)
 229                 return -ENODEV;
 230
 231         io = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 232         if (!io)
 233                 return -ENODEV;
 234
 235         cf = kcalloc(1, sizeof *cf, GFP_KERNEL);
 236         if (!cf)
 237                 return -ENOMEM;
 238
 239         cf->board = board;
 240         cf->pdev = pdev;
 241         cf->phys_baseaddr = io->start;
 242         platform_set_drvdata(pdev, cf);
 243
 244         /* CF takes over CS4, CS5, CS6 */
 245         csa = at91_sys_read(AT91_EBI_CSA);
 246         at91_sys_write(AT91_EBI_CSA, csa | AT91_EBI_CS4A_SMC_COMPACTFLASH);
 247
 248         /* nWAIT is _not_ a default setting */
 249         (void) at91_set_A_periph(AT91_PIN_PC6, 1);      /*  nWAIT */
 250
 251         /*
 252          * Static memory controller timing adjustments.
 253          * REVISIT:  these timings are in terms of MCK cycles, so
 254          * when MCK changes (cpufreq etc) so must these values...
 255          */
 256         at91_sys_write(AT91_SMC_CSR(4),
 257                                   AT91_SMC_ACSS_STD
 258                                 | AT91_SMC_DBW_16
 259                                 | AT91_SMC_BAT
 260                                 | AT91_SMC_WSEN
 261                                 | AT91_SMC_NWS_(32)     /* wait states */
 262                                 | AT91_SMC_RWSETUP_(6)  /* setup time */
 263                                 | AT91_SMC_RWHOLD_(4)   /* hold time */
 264         );
 265
 266         /* must be a GPIO; ergo must trigger on both edges */
 267         status = request_irq(board->det_pin, at91_cf_irq, 0, driver_name, cf);
 268         if (status < 0)
 269                 goto fail0;
 270         device_init_wakeup(&pdev->dev, 1);
 271
 272         /*
 273          * The card driver will request this irq later as needed.
 274          * but it causes lots of "irqNN: nobody cared" messages
 275          * unless we report that we handle everything (sigh).
 276          * (Note:  DK board doesn't wire the IRQ pin...)
 277          */
 278         if (board->irq_pin) {
 279                 status = request_irq(board->irq_pin, at91_cf_irq,
 280                                 IRQF_SHARED, driver_name, cf);
 281                 if (status < 0)
 282                         goto fail0a;
 283                 cf->socket.pci_irq = board->irq_pin;
 284         } else
 285                 cf->socket.pci_irq = NR_IRQS + 1;
 286
 287         /* pcmcia layer only remaps "real" memory not iospace */
 288         cf->socket.io_offset = (unsigned long) ioremap(cf->phys_baseaddr + CF_IO_PHYS, SZ_2K);
 289         if (!cf->socket.io_offset) {
 290                 status = -ENXIO;
 291                 goto fail1;
 292         }
 293
 294         /* reserve CS4, CS5, and CS6 regions; but use just CS4 */
 295         if (!request_mem_region(io->start, io->end + 1 - io->start,
 296                                 driver_name)) {
 297                 status = -ENXIO;
 298                 goto fail1;
 299         }
 300
 301         pr_info("%s: irqs det #%d, io #%d\n", driver_name,
 302                 board->det_pin, board->irq_pin);
 303
 304         cf->socket.owner = THIS_MODULE;
 305         cf->socket.dev.dev = &pdev->dev;
 306         cf->socket.ops = &at91_cf_ops;
 307         cf->socket.resource_ops = &pccard_static_ops;
 308         cf->socket.features = SS_CAP_PCCARD | SS_CAP_STATIC_MAP
 309                                 | SS_CAP_MEM_ALIGN;
 310         cf->socket.map_size = SZ_2K;
 311         cf->socket.io[0].res = io;
 312
 313         status = pcmcia_register_socket(&cf->socket);
 314         if (status < 0)
 315                 goto fail2;
 316
 317         return 0;
 318
 319 fail2:
 320         release_mem_region(io->start, io->end + 1 - io->start);
 321 fail1:
 322         if (cf->socket.io_offset)
 323                 iounmap((void __iomem *) cf->socket.io_offset);
 324         if (board->irq_pin)
 325                 free_irq(board->irq_pin, cf);
 326 fail0a:
 327         device_init_wakeup(&pdev->dev, 0);
 328         free_irq(board->det_pin, cf);
 329 fail0:
 330         at91_sys_write(AT91_EBI_CSA, csa);
 331         kfree(cf);
 332         return status;
 333 }
 334
 335 static int __exit at91_cf_remove(struct platform_device *pdev)
 336 {
 337         struct at91_cf_socket   *cf = platform_get_drvdata(pdev);
 338         struct at91_cf_data     *board = cf->board;
 339         struct resource         *io = cf->socket.io[0].res;
 340         unsigned int            csa;
 341
 342         pcmcia_unregister_socket(&cf->socket);
 343         if (board->irq_pin)
 344                 free_irq(board->irq_pin, cf);
 345         device_init_wakeup(&pdev->dev, 0);
 346         free_irq(board->det_pin, cf);
 347         iounmap((void __iomem *) cf->socket.io_offset);
 348         release_mem_region(io->start, io->end + 1 - io->start);
 349
 350         csa = at91_sys_read(AT91_EBI_CSA);
 351         at91_sys_write(AT91_EBI_CSA, csa & ~AT91_EBI_CS4A);
 352
 353         kfree(cf);
 354         return 0;
 355 }
 356
 357 #ifdef  CONFIG_PM
 358
 359 static int at91_cf_suspend(struct platform_device *pdev, pm_message_t mesg)
 360 {
 361         struct at91_cf_socket   *cf = platform_get_drvdata(pdev);
 362         struct at91_cf_data     *board = cf->board;
 363
 364         pcmcia_socket_dev_suspend(&pdev->dev, mesg);
 365         if (device_may_wakeup(&pdev->dev)) {
 366                 enable_irq_wake(board->det_pin);
 367                 if (board->irq_pin)
 368                         enable_irq_wake(board->irq_pin);
 369         } else {
 370                 disable_irq_wake(board->det_pin);
 371                 if (board->irq_pin)
 372                         disable_irq_wake(board->irq_pin);
 373         }
 374         return 0;
 375 }
 376
 377 static int at91_cf_resume(struct platform_device *pdev)
 378 {
 379         pcmcia_socket_dev_resume(&pdev->dev);
 380         return 0;
 381 }
 382
 383 #else
 384 #define at91_cf_suspend         NULL
 385 #define at91_cf_resume          NULL
 386 #endif
 387
 388 static struct platform_driver at91_cf_driver = {
 389         .driver = {
 390                 .name           = (char *) driver_name,
 391                 .owner          = THIS_MODULE,
 392         },
 393         .probe          = at91_cf_probe,
 394         .remove         = __exit_p(at91_cf_remove),
 395         .suspend        = at91_cf_suspend,
 396         .resume         = at91_cf_resume,
 397 };
 398
 399 /*--------------------------------------------------------------------------*/
 400
 401 static int __init at91_cf_init(void)
 402 {
 403         return platform_driver_register(&at91_cf_driver);
 404 }
 405 module_init(at91_cf_init);
 406
 407 static void __exit at91_cf_exit(void)
 408 {
 409         platform_driver_unregister(&at91_cf_driver);
 410 }
 411 module_exit(at91_cf_exit);
 412
 413 MODULE_DESCRIPTION("AT91 Compact Flash Driver");
 414 MODULE_AUTHOR("David Brownell");
 415 MODULE_LICENSE("GPL");