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