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