drivers/usb/host/sl811_cs.c

   1 /*
   2  * PCMCIA driver for SL811HS (as found in REX-CFU1U)
   3  * Filename: sl811_cs.c
   4  * Author:   Yukio Yamamoto
   5  *
   6  *  Port to sl811-hcd and 2.6.x by
   7  *    Botond Botyanszki <boti@rocketmail.com>
   8  *    Simon Pickering
   9  *
  10  *  Last update: 2005-05-12
  11  */
  12
  13 #include <linux/kernel.h>
  14 #include <linux/module.h>
  15 #include <linux/init.h>
  16 #include <linux/sched.h>
  17 #include <linux/ptrace.h>
  18 #include <linux/slab.h>
  19 #include <linux/string.h>
  20 #include <linux/timer.h>
  21 #include <linux/ioport.h>
  22 #include <linux/platform_device.h>
  23
  24 #include <pcmcia/cs_types.h>
  25 #include <pcmcia/cs.h>
  26 #include <pcmcia/cistpl.h>
  27 #include <pcmcia/cisreg.h>
  28 #include <pcmcia/ds.h>
  29
  30 #include <linux/usb_sl811.h>
  31
  32 MODULE_AUTHOR("Botond Botyanszki");
  33 MODULE_DESCRIPTION("REX-CFU1U PCMCIA driver for 2.6");
  34 MODULE_LICENSE("GPL");
  35
  36
  37 /*====================================================================*/
  38 /* MACROS                                                             */
  39 /*====================================================================*/
  40
  41 #if defined(DEBUG) || defined(PCMCIA_DEBUG)
  42
  43 static int pc_debug = 0;
  44 module_param(pc_debug, int, 0644);
  45
  46 #define DBG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG "sl811_cs: " args)
  47
  48 #else
  49 #define DBG(n, args...) do{}while(0)
  50 #endif  /* no debugging */
  51
  52 #define INFO(args...) printk(KERN_INFO "sl811_cs: " args)
  53
  54 #define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0444)
  55
  56 #define CS_CHECK(fn, ret) \
  57         do { \
  58                 last_fn = (fn); \
  59                 if ((last_ret = (ret)) != 0) \
  60                         goto cs_failed; \
  61         } while (0)
  62
  63 /*====================================================================*/
  64 /* VARIABLES                                                          */
  65 /*====================================================================*/
  66
  67 static const char driver_name[DEV_NAME_LEN]  = "sl811_cs";
  68
  69 static dev_link_t *dev_list = NULL;
  70
  71 typedef struct local_info_t {
  72         dev_link_t              link;
  73         dev_node_t              node;
  74 } local_info_t;
  75
  76 /*====================================================================*/
  77
  78 static void release_platform_dev(struct device * dev)
  79 {
  80         DBG(0, "sl811_cs platform_dev release\n");
  81         dev->parent = NULL;
  82 }
  83
  84 static struct sl811_platform_data platform_data = {
  85         .potpg          = 100,
  86         .power          = 50,           /* == 100mA */
  87         // .reset       = ... FIXME:  invoke CF reset on the card
  88 };
  89
  90 static struct resource resources[] = {
  91         [0] = {
  92                 .flags  = IORESOURCE_IRQ,
  93         },
  94         [1] = {
  95                 // .name   = "address",
  96                 .flags  = IORESOURCE_IO,
  97         },
  98         [2] = {
  99                 // .name   = "data",
 100                 .flags  = IORESOURCE_IO,
 101         },
 102 };
 103
 104 extern struct device_driver sl811h_driver;
 105
 106 static struct platform_device platform_dev = {
 107         .id                     = -1,
 108         .dev = {
 109                 .platform_data = &platform_data,
 110                 .release       = release_platform_dev,
 111         },
 112         .resource               = resources,
 113         .num_resources          = ARRAY_SIZE(resources),
 114 };
 115
 116 static int sl811_hc_init(struct device *parent, ioaddr_t base_addr, int irq)
 117 {
 118         if (platform_dev.dev.parent)
 119                 return -EBUSY;
 120         platform_dev.dev.parent = parent;
 121
 122         /* finish seting up the platform device */
 123         resources[0].start = irq;
 124
 125         resources[1].start = base_addr;
 126         resources[1].end = base_addr;
 127
 128         resources[2].start = base_addr + 1;
 129         resources[2].end   = base_addr + 1;
 130
 131         /* The driver core will probe for us.  We know sl811-hcd has been
 132          * initialized already because of the link order dependency created
 133          * by referencing "sl811h_driver".
 134          */
 135         platform_dev.name = sl811h_driver.name;
 136         return platform_device_register(&platform_dev);
 137 }
 138
 139 /*====================================================================*/
 140
 141 static void sl811_cs_detach(dev_link_t *link)
 142 {
 143         dev_link_t **linkp;
 144
 145         DBG(0, "sl811_cs_detach(0x%p)\n", link);
 146
 147         /* Locate device structure */
 148         for (linkp = &dev_list; *linkp; linkp = &(*linkp)->next) {
 149                 if (*linkp == link)
 150                         break;
 151         }
 152         if (*linkp == NULL)
 153                 return;
 154
 155         /* Break the link with Card Services */
 156         if (link->handle)
 157                 pcmcia_deregister_client(link->handle);
 158
 159         /* Unlink device structure, and free it */
 160         *linkp = link->next;
 161         /* This points to the parent local_info_t struct */
 162         kfree(link->priv);
 163 }
 164
 165 static void sl811_cs_release(dev_link_t * link)
 166 {
 167
 168         DBG(0, "sl811_cs_release(0x%p)\n", link);
 169
 170         if (link->open) {
 171                 DBG(1, "sl811_cs: release postponed, '%s' still open\n",
 172                     link->dev->dev_name);
 173                 link->state |= DEV_STALE_CONFIG;
 174                 return;
 175         }
 176
 177         /* Unlink the device chain */
 178         link->dev = NULL;
 179
 180         platform_device_unregister(&platform_dev);
 181         pcmcia_release_configuration(link->handle);
 182         if (link->io.NumPorts1)
 183                 pcmcia_release_io(link->handle, &link->io);
 184         if (link->irq.AssignedIRQ)
 185                 pcmcia_release_irq(link->handle, &link->irq);
 186         link->state &= ~DEV_CONFIG;
 187
 188         if (link->state & DEV_STALE_LINK)
 189                 sl811_cs_detach(link);
 190 }
 191
 192 static void sl811_cs_config(dev_link_t *link)
 193 {
 194         client_handle_t         handle = link->handle;
 195         struct device           *parent = &handle_to_dev(handle);
 196         local_info_t            *dev = link->priv;
 197         tuple_t                 tuple;
 198         cisparse_t              parse;
 199         int                     last_fn, last_ret;
 200         u_char                  buf[64];
 201         config_info_t           conf;
 202         cistpl_cftable_entry_t  dflt = { 0 };
 203
 204         DBG(0, "sl811_cs_config(0x%p)\n", link);
 205
 206         tuple.DesiredTuple = CISTPL_CONFIG;
 207         tuple.Attributes = 0;
 208         tuple.TupleData = buf;
 209         tuple.TupleDataMax = sizeof(buf);
 210         tuple.TupleOffset = 0;
 211         CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
 212         CS_CHECK(GetTupleData, pcmcia_get_tuple_data(handle, &tuple));
 213         CS_CHECK(ParseTuple, pcmcia_parse_tuple(handle, &tuple, &parse));
 214         link->conf.ConfigBase = parse.config.base;
 215         link->conf.Present = parse.config.rmask[0];
 216
 217         /* Configure card */
 218         link->state |= DEV_CONFIG;
 219
 220         /* Look up the current Vcc */
 221         CS_CHECK(GetConfigurationInfo,
 222                         pcmcia_get_configuration_info(handle, &conf));
 223         link->conf.Vcc = conf.Vcc;
 224
 225         tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
 226         CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
 227         while (1) {
 228                 cistpl_cftable_entry_t  *cfg = &(parse.cftable_entry);
 229
 230                 if (pcmcia_get_tuple_data(handle, &tuple) != 0
 231                                 || pcmcia_parse_tuple(handle, &tuple, &parse)
 232                                                 != 0)
 233                         goto next_entry;
 234
 235                 if (cfg->flags & CISTPL_CFTABLE_DEFAULT) {
 236                         dflt = *cfg;
 237                 }
 238
 239                 if (cfg->index == 0)
 240                         goto next_entry;
 241
 242                 link->conf.ConfigIndex = cfg->index;
 243
 244                 /* Use power settings for Vcc and Vpp if present */
 245                 /*  Note that the CIS values need to be rescaled */
 246                 if (cfg->vcc.present & (1<<CISTPL_POWER_VNOM)) {
 247                         if (cfg->vcc.param[CISTPL_POWER_VNOM]/10000
 248                                         != conf.Vcc)
 249                                 goto next_entry;
 250                 } else if (dflt.vcc.present & (1<<CISTPL_POWER_VNOM)) {
 251                         if (dflt.vcc.param[CISTPL_POWER_VNOM]/10000
 252                                         != conf.Vcc)
 253                                 goto next_entry;
 254                 }
 255
 256                 if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
 257                         link->conf.Vpp1 = link->conf.Vpp2 =
 258                                 cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
 259                 else if (dflt.vpp1.present & (1<<CISTPL_POWER_VNOM))
 260                         link->conf.Vpp1 = link->conf.Vpp2 =
 261                                 dflt.vpp1.param[CISTPL_POWER_VNOM]/10000;
 262
 263                 /* we need an interrupt */
 264                 if (cfg->irq.IRQInfo1 || dflt.irq.IRQInfo1)
 265                         link->conf.Attributes |= CONF_ENABLE_IRQ;
 266
 267                 /* IO window settings */
 268                 link->io.NumPorts1 = link->io.NumPorts2 = 0;
 269                 if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
 270                         cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt.io;
 271
 272                         link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 273                         link->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
 274                         link->io.BasePort1 = io->win[0].base;
 275                         link->io.NumPorts1 = io->win[0].len;
 276
 277                         if (pcmcia_request_io(link->handle, &link->io) != 0)
 278                                 goto next_entry;
 279                 }
 280                 break;
 281
 282 next_entry:
 283                 if (link->io.NumPorts1)
 284                         pcmcia_release_io(link->handle, &link->io);
 285                 last_ret = pcmcia_get_next_tuple(handle, &tuple);
 286         }
 287
 288         /* require an IRQ and two registers */
 289         if (!link->io.NumPorts1 || link->io.NumPorts1 < 2)
 290                 goto cs_failed;
 291         if (link->conf.Attributes & CONF_ENABLE_IRQ)
 292                 CS_CHECK(RequestIRQ,
 293                         pcmcia_request_irq(link->handle, &link->irq));
 294         else
 295                 goto cs_failed;
 296
 297         CS_CHECK(RequestConfiguration,
 298                 pcmcia_request_configuration(link->handle, &link->conf));
 299
 300         sprintf(dev->node.dev_name, driver_name);
 301         dev->node.major = dev->node.minor = 0;
 302         link->dev = &dev->node;
 303
 304         printk(KERN_INFO "%s: index 0x%02x: Vcc %d.%d",
 305                dev->node.dev_name, link->conf.ConfigIndex,
 306                link->conf.Vcc/10, link->conf.Vcc%10);
 307         if (link->conf.Vpp1)
 308                 printk(", Vpp %d.%d", link->conf.Vpp1/10, link->conf.Vpp1%10);
 309         printk(", irq %d", link->irq.AssignedIRQ);
 310         printk(", io 0x%04x-0x%04x", link->io.BasePort1,
 311                link->io.BasePort1+link->io.NumPorts1-1);
 312         printk("\n");
 313
 314         link->state &= ~DEV_CONFIG_PENDING;
 315
 316         if (sl811_hc_init(parent, link->io.BasePort1, link->irq.AssignedIRQ)
 317                         < 0) {
 318 cs_failed:
 319                 printk("sl811_cs_config failed\n");
 320                 cs_error(link->handle, last_fn, last_ret);
 321                 sl811_cs_release(link);
 322                 link->state &= ~DEV_CONFIG_PENDING;
 323         }
 324 }
 325
 326 static int sl811_suspend(struct pcmcia_device *dev)
 327 {
 328         dev_link_t *link = dev_to_instance(dev);
 329
 330         link->state |= DEV_SUSPEND;
 331         if (link->state & DEV_CONFIG)
 332                 pcmcia_release_configuration(link->handle);
 333
 334         return 0;
 335 }
 336
 337 static int sl811_resume(struct pcmcia_device *dev)
 338 {
 339         dev_link_t *link = dev_to_instance(dev);
 340
 341         link->state &= ~DEV_SUSPEND;
 342         if (link->state & DEV_CONFIG)
 343                 pcmcia_request_configuration(link->handle, &link->conf);
 344
 345         return 0;
 346 }
 347
 348 static int
 349 sl811_cs_event(event_t event, int priority, event_callback_args_t *args)
 350 {
 351         dev_link_t *link = args->client_data;
 352
 353         DBG(1, "sl811_cs_event(0x%06x)\n", event);
 354
 355         switch (event) {
 356         case CS_EVENT_CARD_REMOVAL:
 357                 link->state &= ~DEV_PRESENT;
 358                 if (link->state & DEV_CONFIG)
 359                         sl811_cs_release(link);
 360                 break;
 361
 362         case CS_EVENT_CARD_INSERTION:
 363                 link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
 364                 sl811_cs_config(link);
 365                 break;
 366         }
 367         return 0;
 368 }
 369
 370 static dev_link_t *sl811_cs_attach(void)
 371 {
 372         local_info_t *local;
 373         dev_link_t *link;
 374         client_reg_t client_reg;
 375         int ret;
 376
 377         local = kmalloc(sizeof(local_info_t), GFP_KERNEL);
 378         if (!local)
 379                 return NULL;
 380         memset(local, 0, sizeof(local_info_t));
 381         link = &local->link;
 382         link->priv = local;
 383
 384         /* Initialize */
 385         link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
 386         link->irq.IRQInfo1 = IRQ_INFO2_VALID|IRQ_LEVEL_ID;
 387         link->irq.Handler = NULL;
 388
 389         link->conf.Attributes = 0;
 390         link->conf.Vcc = 33;
 391         link->conf.IntType = INT_MEMORY_AND_IO;
 392
 393         /* Register with Card Services */
 394         link->next = dev_list;
 395         dev_list = link;
 396         client_reg.dev_info = (dev_info_t *) &driver_name;
 397         client_reg.Attributes = INFO_IO_CLIENT | INFO_CARD_SHARE;
 398         client_reg.Version = 0x0210;
 399         client_reg.event_callback_args.client_data = link;
 400         ret = pcmcia_register_client(&link->handle, &client_reg);
 401         if (ret != CS_SUCCESS) {
 402                 cs_error(link->handle, RegisterClient, ret);
 403                 sl811_cs_detach(link);
 404                 return NULL;
 405         }
 406
 407         return link;
 408 }
 409
 410 static struct pcmcia_device_id sl811_ids[] = {
 411         PCMCIA_DEVICE_MANF_CARD(0xc015, 0x0001), /* RATOC USB HOST CF+ Card */
 412         PCMCIA_DEVICE_NULL,
 413 };
 414 MODULE_DEVICE_TABLE(pcmcia, sl811_ids);
 415
 416 static struct pcmcia_driver sl811_cs_driver = {
 417         .owner          = THIS_MODULE,
 418         .drv            = {
 419                 .name   = (char *)driver_name,
 420         },
 421         .attach         = sl811_cs_attach,
 422         .event          = sl811_cs_event,
 423         .detach         = sl811_cs_detach,
 424         .id_table       = sl811_ids,
 425         .suspend        = sl811_suspend,
 426         .resume         = sl811_resume,
 427 };
 428
 429 /*====================================================================*/
 430
 431 static int __init init_sl811_cs(void)
 432 {
 433         return pcmcia_register_driver(&sl811_cs_driver);
 434 }
 435 module_init(init_sl811_cs);
 436
 437 static void __exit exit_sl811_cs(void)
 438 {
 439         pcmcia_unregister_driver(&sl811_cs_driver);
 440 }
 441 module_exit(exit_sl811_cs);