drivers/pcmcia/omap_cf.c

0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*
0003  * omap_cf.c -- OMAP 16xx CompactFlash controller driver
0004  *
0005  * Copyright (c) 2005 David Brownell
0006  */
0007
0008 #include <linux/module.h>
0009 #include <linux/kernel.h>
0010 #include <linux/platform_device.h>
0011 #include <linux/errno.h>
0012 #include <linux/init.h>
0013 #include <linux/delay.h>
0014 #include <linux/interrupt.h>
0015 #include <linux/slab.h>
0016
0017 #include <pcmcia/ss.h>
0018
0019 #include <asm/io.h>
0020 #include <linux/sizes.h>
0021
0022 #include <linux/soc/ti/omap1-io.h>
0023 #include <linux/soc/ti/omap1-soc.h>
0024 #include <linux/soc/ti/omap1-mux.h>
0025
0026 /* NOTE:  don't expect this to support many I/O cards.  The 16xx chips have
0027  * hard-wired timings to support Compact Flash memory cards; they won't work
0028  * with various other devices (like WLAN adapters) without some external
0029  * logic to help out.
0030  *
0031  * NOTE:  CF controller docs disagree with address space docs as to where
0032  * CF_BASE really lives; this is a doc erratum.
0033  */
0034 #define CF_BASE 0xfffe2800
0035
0036 /* status; read after IRQ */
0037 #define CF_STATUS           (CF_BASE + 0x00)
0038 #   define  CF_STATUS_BAD_READ  (1 << 2)
0039 #   define  CF_STATUS_BAD_WRITE (1 << 1)
0040 #   define  CF_STATUS_CARD_DETECT   (1 << 0)
0041
0042 /* which chipselect (CS0..CS3) is used for CF (active low) */
0043 #define CF_CFG              (CF_BASE + 0x02)
0044
0045 /* card reset */
0046 #define CF_CONTROL          (CF_BASE + 0x04)
0047 #   define  CF_CONTROL_RESET    (1 << 0)
0048
0049 #define omap_cf_present() (!(omap_readw(CF_STATUS) & CF_STATUS_CARD_DETECT))
0050
0051 /*--------------------------------------------------------------------------*/
0052
0053 static const char driver_name[] = "omap_cf";
0054
0055 struct omap_cf_socket {
0056     struct pcmcia_socket    socket;
0057
0058     struct timer_list   timer;
0059     unsigned        present:1;
0060     unsigned        active:1;
0061
0062     struct platform_device  *pdev;
0063     unsigned long       phys_cf;
0064     u_int           irq;
0065     struct resource     iomem;
0066 };
0067
0068 #define POLL_INTERVAL       (2 * HZ)
0069
0070 /*--------------------------------------------------------------------------*/
0071
0072 static int omap_cf_ss_init(struct pcmcia_socket *s)
0073 {
0074     return 0;
0075 }
0076
0077 /* the timer is primarily to kick this socket's pccardd */
0078 static void omap_cf_timer(struct timer_list *t)
0079 {
0080     struct omap_cf_socket   *cf = from_timer(cf, t, timer);
0081     unsigned        present = omap_cf_present();
0082
0083     if (present != cf->present) {
0084         cf->present = present;
0085         pr_debug("%s: card %s\n", driver_name,
0086             present ? "present" : "gone");
0087         pcmcia_parse_events(&cf->socket, SS_DETECT);
0088     }
0089
0090     if (cf->active)
0091         mod_timer(&cf->timer, jiffies + POLL_INTERVAL);
0092 }
0093
0094 /* This irq handler prevents "irqNNN: nobody cared" messages as drivers
0095  * claim the card's IRQ.  It may also detect some card insertions, but
0096  * not removals; it can't always eliminate timer irqs.
0097  */
0098 static irqreturn_t omap_cf_irq(int irq, void *_cf)
0099 {
0100     struct omap_cf_socket *cf = (struct omap_cf_socket *)_cf;
0101
0102     omap_cf_timer(&cf->timer);
0103     return IRQ_HANDLED;
0104 }
0105
0106 static int omap_cf_get_status(struct pcmcia_socket *s, u_int *sp)
0107 {
0108     if (!sp)
0109         return -EINVAL;
0110
0111     /* NOTE CF is always 3VCARD */
0112     if (omap_cf_present()) {
0113         struct omap_cf_socket   *cf;
0114
0115         *sp = SS_READY | SS_DETECT | SS_POWERON | SS_3VCARD;
0116         cf = container_of(s, struct omap_cf_socket, socket);
0117         s->pcmcia_irq = 0;
0118         s->pci_irq = cf->irq;
0119     } else
0120         *sp = 0;
0121     return 0;
0122 }
0123
0124 static int
0125 omap_cf_set_socket(struct pcmcia_socket *sock, struct socket_state_t *s)
0126 {
0127     u16     control;
0128
0129     /* REVISIT some non-OSK boards may support power switching */
0130     switch (s->Vcc) {
0131     case 0:
0132     case 33:
0133         break;
0134     default:
0135         return -EINVAL;
0136     }
0137
0138     control = omap_readw(CF_CONTROL);
0139     if (s->flags & SS_RESET)
0140         omap_writew(CF_CONTROL_RESET, CF_CONTROL);
0141     else
0142         omap_writew(0, CF_CONTROL);
0143
0144     pr_debug("%s: Vcc %d, io_irq %d, flags %04x csc %04x\n",
0145         driver_name, s->Vcc, s->io_irq, s->flags, s->csc_mask);
0146
0147     return 0;
0148 }
0149
0150 static int omap_cf_ss_suspend(struct pcmcia_socket *s)
0151 {
0152     pr_debug("%s: %s\n", driver_name, __func__);
0153     return omap_cf_set_socket(s, &dead_socket);
0154 }
0155
0156 /* regions are 2K each:  mem, attrib, io (and reserved-for-ide) */
0157
0158 static int
0159 omap_cf_set_io_map(struct pcmcia_socket *s, struct pccard_io_map *io)
0160 {
0161     struct omap_cf_socket   *cf;
0162
0163     cf = container_of(s, struct omap_cf_socket, socket);
0164     io->flags &= MAP_ACTIVE|MAP_ATTRIB|MAP_16BIT;
0165     io->start = cf->phys_cf + SZ_4K;
0166     io->stop = io->start + SZ_2K - 1;
0167     return 0;
0168 }
0169
0170 static int
0171 omap_cf_set_mem_map(struct pcmcia_socket *s, struct pccard_mem_map *map)
0172 {
0173     struct omap_cf_socket   *cf;
0174
0175     if (map->card_start)
0176         return -EINVAL;
0177     cf = container_of(s, struct omap_cf_socket, socket);
0178     map->static_start = cf->phys_cf;
0179     map->flags &= MAP_ACTIVE|MAP_ATTRIB|MAP_16BIT;
0180     if (map->flags & MAP_ATTRIB)
0181         map->static_start += SZ_2K;
0182     return 0;
0183 }
0184
0185 static struct pccard_operations omap_cf_ops = {
0186     .init           = omap_cf_ss_init,
0187     .suspend        = omap_cf_ss_suspend,
0188     .get_status     = omap_cf_get_status,
0189     .set_socket     = omap_cf_set_socket,
0190     .set_io_map     = omap_cf_set_io_map,
0191     .set_mem_map        = omap_cf_set_mem_map,
0192 };
0193
0194 /*--------------------------------------------------------------------------*/
0195
0196 /*
0197  * NOTE:  right now the only board-specific platform_data is
0198  * "what chipselect is used".  Boards could want more.
0199  */
0200
0201 static int __init omap_cf_probe(struct platform_device *pdev)
0202 {
0203     unsigned        seg;
0204     struct omap_cf_socket   *cf;
0205     int         irq;
0206     int         status;
0207     struct resource     *res;
0208     struct resource     iospace = DEFINE_RES_IO(SZ_64, SZ_4K);
0209
0210     seg = (int) pdev->dev.platform_data;
0211     if (seg == 0 || seg > 3)
0212         return -ENODEV;
0213
0214     /* either CFLASH.IREQ (INT_1610_CF) or some GPIO */
0215     irq = platform_get_irq(pdev, 0);
0216     if (irq < 0)
0217         return -EINVAL;
0218
0219     res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
0220
0221     cf = kzalloc(sizeof *cf, GFP_KERNEL);
0222     if (!cf)
0223         return -ENOMEM;
0224     timer_setup(&cf->timer, omap_cf_timer, 0);
0225
0226     cf->pdev = pdev;
0227     platform_set_drvdata(pdev, cf);
0228
0229     /* this primarily just shuts up irq handling noise */
0230     status = request_irq(irq, omap_cf_irq, IRQF_SHARED,
0231             driver_name, cf);
0232     if (status < 0)
0233         goto fail0;
0234     cf->irq = irq;
0235     cf->socket.pci_irq = irq;
0236     cf->phys_cf = res->start;
0237
0238     /* pcmcia layer only remaps "real" memory */
0239     cf->socket.io_offset = iospace.start;
0240     status = pci_remap_iospace(&iospace, cf->phys_cf + SZ_4K);
0241     if (status) {
0242         status = -ENOMEM;
0243         goto fail1;
0244     }
0245
0246     if (!request_mem_region(cf->phys_cf, SZ_8K, driver_name)) {
0247         status = -ENXIO;
0248         goto fail1;
0249     }
0250
0251     /* NOTE:  CF conflicts with MMC1 */
0252     omap_cfg_reg(W11_1610_CF_CD1);
0253     omap_cfg_reg(P11_1610_CF_CD2);
0254     omap_cfg_reg(R11_1610_CF_IOIS16);
0255     omap_cfg_reg(V10_1610_CF_IREQ);
0256     omap_cfg_reg(W10_1610_CF_RESET);
0257
0258     omap_writew(~(1 << seg), CF_CFG);
0259
0260     pr_info("%s: cs%d on irq %d\n", driver_name, seg, irq);
0261
0262     /* CF uses armxor_ck, which is "always" available */
0263
0264     pr_debug("%s: sts %04x cfg %04x control %04x %s\n", driver_name,
0265         omap_readw(CF_STATUS), omap_readw(CF_CFG),
0266         omap_readw(CF_CONTROL),
0267         omap_cf_present() ? "present" : "(not present)");
0268
0269     cf->socket.owner = THIS_MODULE;
0270     cf->socket.dev.parent = &pdev->dev;
0271     cf->socket.ops = &omap_cf_ops;
0272     cf->socket.resource_ops = &pccard_static_ops;
0273     cf->socket.features = SS_CAP_PCCARD | SS_CAP_STATIC_MAP
0274                 | SS_CAP_MEM_ALIGN;
0275     cf->socket.map_size = SZ_2K;
0276     cf->socket.io[0].res = &cf->iomem;
0277
0278     status = pcmcia_register_socket(&cf->socket);
0279     if (status < 0)
0280         goto fail2;
0281
0282     cf->active = 1;
0283     mod_timer(&cf->timer, jiffies + POLL_INTERVAL);
0284     return 0;
0285
0286 fail2:
0287     release_mem_region(cf->phys_cf, SZ_8K);
0288 fail1:
0289     free_irq(irq, cf);
0290 fail0:
0291     kfree(cf);
0292     return status;
0293 }
0294
0295 static int __exit omap_cf_remove(struct platform_device *pdev)
0296 {
0297     struct omap_cf_socket *cf = platform_get_drvdata(pdev);
0298
0299     cf->active = 0;
0300     pcmcia_unregister_socket(&cf->socket);
0301     del_timer_sync(&cf->timer);
0302     release_mem_region(cf->phys_cf, SZ_8K);
0303     free_irq(cf->irq, cf);
0304     kfree(cf);
0305     return 0;
0306 }
0307
0308 static struct platform_driver omap_cf_driver = {
0309     .driver = {
0310         .name   = driver_name,
0311     },
0312     .remove     = __exit_p(omap_cf_remove),
0313 };
0314
0315 static int __init omap_cf_init(void)
0316 {
0317     if (cpu_is_omap16xx())
0318         return platform_driver_probe(&omap_cf_driver, omap_cf_probe);
0319     return -ENODEV;
0320 }
0321
0322 static void __exit omap_cf_exit(void)
0323 {
0324     if (cpu_is_omap16xx())
0325         platform_driver_unregister(&omap_cf_driver);
0326 }
0327
0328 module_init(omap_cf_init);
0329 module_exit(omap_cf_exit);
0330
0331 MODULE_DESCRIPTION("OMAP CF Driver");
0332 MODULE_LICENSE("GPL");
0333 MODULE_ALIAS("platform:omap_cf");