drivers/pcmcia/at91_cf.c

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