sound/drivers/mpu401/mpu401.c

   1 /*
   2  *  Driver for generic MPU-401 boards (UART mode only)
   3  *  Copyright (c) by Jaroslav Kysela <perex@suse.cz>
   4  *
   5  *  ACPI PnP Copyright (c) 2004 by Clemens Ladisch <clemens@ladisch.de>
   6  *  based on 8250_acpi.c
   7  *  Copyright (c) 2002-2003 Matthew Wilcox for Hewlett-Packard
   8  *  Copyright (C) 2004 Hewlett-Packard Co
   9  *       Bjorn Helgaas <bjorn.helgaas@hp.com>
  10  *
  11  *
  12  *   This program is free software; you can redistribute it and/or modify
  13  *   it under the terms of the GNU General Public License as published by
  14  *   the Free Software Foundation; either version 2 of the License, or
  15  *   (at your option) any later version.
  16  *
  17  *   This program is distributed in the hope that it will be useful,
  18  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  *   GNU General Public License for more details.
  21  *
  22  *   You should have received a copy of the GNU General Public License
  23  *   along with this program; if not, write to the Free Software
  24  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  25  *
  26  */
  27
  28 #include <sound/driver.h>
  29 #include <linux/init.h>
  30 #ifdef CONFIG_ACPI_BUS
  31 #include <acpi/acpi_bus.h>
  32 #endif
  33 #include <linux/moduleparam.h>
  34 #include <sound/core.h>
  35 #include <sound/mpu401.h>
  36 #include <sound/initval.h>
  37
  38 #ifdef CONFIG_ACPI_BUS
  39 #define USE_ACPI_PNP
  40 #endif
  41
  42 MODULE_AUTHOR("Jaroslav Kysela <perex@suse.cz>");
  43 MODULE_DESCRIPTION("MPU-401 UART");
  44 MODULE_LICENSE("GPL");
  45 MODULE_CLASSES("{sound}");
  46
  47 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;      /* Index 0-MAX */
  48 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;       /* ID for this card */
  49 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE;  /* Enable this card */
  50 #ifdef USE_ACPI_PNP
  51 static int acpipnp[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = 1 };
  52 #endif
  53 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;     /* MPU-401 port number */
  54 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;        /* MPU-401 IRQ */
  55 static int boot_devs;
  56
  57 module_param_array(index, int, boot_devs, 0444);
  58 MODULE_PARM_DESC(index, "Index value for MPU-401 device.");
  59 MODULE_PARM_SYNTAX(index, SNDRV_INDEX_DESC);
  60 module_param_array(id, charp, boot_devs, 0444);
  61 MODULE_PARM_DESC(id, "ID string for MPU-401 device.");
  62 MODULE_PARM_SYNTAX(id, SNDRV_ID_DESC);
  63 module_param_array(enable, bool, boot_devs, 0444);
  64 MODULE_PARM_DESC(enable, "Enable MPU-401 device.");
  65 MODULE_PARM_SYNTAX(enable, SNDRV_ENABLE_DESC);
  66 #ifdef USE_ACPI_PNP
  67 module_param_array(acpipnp, bool, boot_devs, 0444);
  68 MODULE_PARM_DESC(acpipnp, "ACPI PnP detection for MPU-401 device.");
  69 MODULE_PARM_SYNTAX(acpipnp, SNDRV_ENABLED "," SNDRV_BOOLEAN_TRUE_DESC);
  70 #endif
  71 module_param_array(port, long, boot_devs, 0444);
  72 MODULE_PARM_DESC(port, "Port # for MPU-401 device.");
  73 MODULE_PARM_SYNTAX(port, SNDRV_PORT12_DESC);
  74 module_param_array(irq, int, boot_devs, 0444);
  75 MODULE_PARM_DESC(irq, "IRQ # for MPU-401 device.");
  76 MODULE_PARM_SYNTAX(irq, SNDRV_IRQ_DESC);
  77
  78 #ifndef CONFIG_ACPI_BUS
  79 struct acpi_device;
  80 #endif
  81
  82 static snd_card_t *snd_mpu401_legacy_cards[SNDRV_CARDS] = SNDRV_DEFAULT_PTR;
  83 static int cards;
  84
  85 #ifdef USE_ACPI_PNP
  86
  87 static int acpi_driver_registered;
  88
  89 struct mpu401_resources {
  90         unsigned long port;
  91         int irq;
  92 };
  93
  94 static acpi_status __devinit snd_mpu401_acpi_resource(struct acpi_resource *res,
  95                                                       void *data)
  96 {
  97         struct mpu401_resources *resources = (struct mpu401_resources *)data;
  98
  99         if (res->id == ACPI_RSTYPE_IRQ) {
 100                 if (res->data.irq.number_of_interrupts > 0) {
 101 #ifdef CONFIG_IA64
 102                         resources->irq = acpi_register_irq(res->data.irq.interrupts[0],
 103                                                            res->data.irq.active_high_low,
 104                                                            res->data.irq.edge_level);
 105 #else
 106                         resources->irq = res->data.irq.interrupts[0];
 107 #endif
 108                 }
 109         } else if (res->id == ACPI_RSTYPE_IO) {
 110                 if (res->data.io.range_length >= 2) {
 111                         resources->port = res->data.io.min_base_address;
 112                 }
 113         }
 114         return AE_OK;
 115 }
 116
 117 static int __devinit snd_mpu401_acpi_pnp(int dev, struct acpi_device *device)
 118 {
 119         struct mpu401_resources res;
 120         acpi_status status;
 121
 122         res.port = SNDRV_AUTO_PORT;
 123         res.irq = SNDRV_AUTO_IRQ;
 124         status = acpi_walk_resources(device->handle, METHOD_NAME__CRS,
 125                                      snd_mpu401_acpi_resource, &res);
 126         if (ACPI_FAILURE(status))
 127                 return -ENODEV;
 128         if (res.port == SNDRV_AUTO_PORT || res.irq == SNDRV_AUTO_IRQ) {
 129                 snd_printk(KERN_ERR "no port or irq in %s _CRS\n",
 130                            acpi_device_bid(device));
 131                 return -ENODEV;
 132         }
 133         port[dev] = res.port;
 134         irq[dev] = res.irq;
 135         return 0;
 136 }
 137
 138 #endif /* USE_ACPI_PNP */
 139
 140 static int __devinit snd_card_mpu401_probe(int dev, struct acpi_device *device)
 141 {
 142         snd_card_t *card;
 143         int err;
 144
 145 #ifdef USE_ACPI_PNP
 146         if (!device) {
 147 #endif
 148                 if (port[dev] == SNDRV_AUTO_PORT) {
 149                         snd_printk(KERN_ERR "specify port\n");
 150                         return -EINVAL;
 151                 }
 152                 if (irq[dev] == SNDRV_AUTO_IRQ) {
 153                         snd_printk(KERN_ERR "specify or disable IRQ port\n");
 154                         return -EINVAL;
 155                 }
 156 #ifdef USE_ACPI_PNP
 157         }
 158 #endif
 159
 160 #ifdef USE_ACPI_PNP
 161         if (device && (err = snd_mpu401_acpi_pnp(dev, device)) < 0)
 162                 return err;
 163 #endif
 164
 165         card = snd_card_new(index[dev], id[dev], THIS_MODULE, 0);
 166         if (card == NULL)
 167                 return -ENOMEM;
 168         strcpy(card->driver, "MPU-401 UART");
 169         strcpy(card->shortname, card->driver);
 170         sprintf(card->longname, "%s at 0x%lx, ", card->shortname, port[dev]);
 171         if (irq[dev] >= 0) {
 172                 sprintf(card->longname + strlen(card->longname), "IRQ %d", irq[dev]);
 173         } else {
 174                 strcat(card->longname, "polled");
 175         }
 176 #ifdef USE_ACPI_PNP
 177         if (device) {
 178                 strcat(card->longname, ", bus id ");
 179                 strlcat(card->longname, acpi_device_bid(device), sizeof(card->longname));
 180         }
 181 #endif
 182         if (snd_mpu401_uart_new(card, 0,
 183                                 MPU401_HW_MPU401,
 184                                 port[dev], 0,
 185                                 irq[dev], irq[dev] >= 0 ? SA_INTERRUPT : 0, NULL) < 0) {
 186                 printk(KERN_ERR "MPU401 not detected at 0x%lx\n", port[dev]);
 187                 snd_card_free(card);
 188                 return -ENODEV;
 189         }
 190         if ((err = snd_card_register(card)) < 0) {
 191                 snd_card_free(card);
 192                 return err;
 193         }
 194 #ifdef USE_ACPI_PNP
 195         if (device)
 196                 acpi_driver_data(device) = card;
 197         else
 198 #endif
 199                 snd_mpu401_legacy_cards[dev] = card;
 200         ++cards;
 201         return 0;
 202 }
 203
 204 #ifdef USE_ACPI_PNP
 205
 206 static int __devinit snd_mpu401_acpi_add(struct acpi_device *device)
 207 {
 208         static int dev;
 209         int err;
 210
 211         for ( ; dev < SNDRV_CARDS; ++dev) {
 212                 if (!enable[dev] || !acpipnp[dev])
 213                         continue;
 214                 err = snd_card_mpu401_probe(dev, device);
 215                 if (err < 0)
 216                         return err;
 217                 ++dev;
 218                 return 0;
 219         }
 220         return -ENODEV;
 221 }
 222
 223 static int __devexit snd_mpu401_acpi_remove(struct acpi_device *device,
 224                                             int type)
 225 {
 226         snd_card_t *card;
 227
 228         if (!device)
 229                 return -EINVAL;
 230         card = (snd_card_t *)acpi_driver_data(device);
 231         if (!card)
 232                 return -EINVAL;
 233
 234         snd_card_disconnect(card);
 235         snd_card_free_in_thread(card);
 236         acpi_driver_data(device) = NULL;
 237         return 0;
 238 }
 239
 240 static struct acpi_driver snd_mpu401_acpi_driver = {
 241         .name = "MPU-401 Driver",
 242         .class = "mpu401",
 243         .ids = "PNPB006",
 244         .ops = {
 245                 .add = snd_mpu401_acpi_add,
 246                 .remove = __devexit_p(snd_mpu401_acpi_remove),
 247         },
 248 };
 249
 250 #endif /* USE_ACPI_PNP */
 251
 252 static int __init alsa_card_mpu401_init(void)
 253 {
 254         int dev;
 255
 256 #ifdef USE_ACPI_PNP
 257         if (acpi_bus_register_driver(&snd_mpu401_acpi_driver) >= 0)
 258                 acpi_driver_registered = 1;
 259 #endif
 260         for (dev = 0; dev < SNDRV_CARDS; dev++) {
 261                 if (!enable[dev])
 262                         continue;
 263 #ifdef USE_ACPI_PNP
 264                 if (acpipnp[dev] && acpi_driver_registered)
 265                         continue;
 266 #endif
 267                 snd_card_mpu401_probe(dev, NULL);
 268         }
 269         if (!cards) {
 270 #ifdef MODULE
 271                 printk(KERN_ERR "MPU-401 device not found or device busy\n");
 272 #endif
 273 #ifdef USE_ACPI_PNP
 274                 if (acpi_driver_registered)
 275                         acpi_bus_unregister_driver(&snd_mpu401_acpi_driver);
 276 #endif
 277                 return -ENODEV;
 278         }
 279         return 0;
 280 }
 281
 282 static void __exit alsa_card_mpu401_exit(void)
 283 {
 284         int idx;
 285
 286 #ifdef USE_ACPI_PNP
 287         if (acpi_driver_registered)
 288                 acpi_bus_unregister_driver(&snd_mpu401_acpi_driver);
 289 #endif
 290         for (idx = 0; idx < SNDRV_CARDS; idx++)
 291                 snd_card_free(snd_mpu401_legacy_cards[idx]);
 292 }
 293
 294 module_init(alsa_card_mpu401_init)
 295 module_exit(alsa_card_mpu401_exit)