66900d20a42f37c88b9e6c9a4c7e185a46ccc077
[linux-2.6.git] / sound / pcmcia / vx / vxpocket.c
1 /*
2  * Driver for Digigram VXpocket V2/440 soundcards
3  *
4  * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
5  *
6  *   This program is free software; you can redistribute it and/or modify
7  *   it under the terms of the GNU General Public License as published by
8  *   the Free Software Foundation; either version 2 of the License, or
9  *   (at your option) any later version.
10  *
11  *   This program is distributed in the hope that it will be useful,
12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *   GNU General Public License for more details.
15  *
16  *   You should have received a copy of the GNU General Public License
17  *   along with this program; if not, write to the Free Software
18  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19  */
20
21
22 #include <sound/driver.h>
23 #include <linux/init.h>
24 #include <linux/moduleparam.h>
25 #include <sound/core.h>
26 #include "vxpocket.h"
27 #include <pcmcia/ciscode.h>
28 #include <pcmcia/cisreg.h>
29 #include <sound/initval.h>
30
31 /*
32  */
33
34 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
35 MODULE_DESCRIPTION("Digigram VXPocket");
36 MODULE_LICENSE("GPL");
37 MODULE_SUPPORTED_DEVICE("{{Digigram,VXPocket},{Digigram,VXPocket440}}");
38
39 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;      /* Index 0-MAX */
40 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;       /* ID for this card */
41 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;      /* Enable switches */
42 static int ibl[SNDRV_CARDS];
43
44 module_param_array(index, int, NULL, 0444);
45 MODULE_PARM_DESC(index, "Index value for VXPocket soundcard.");
46 module_param_array(id, charp, NULL, 0444);
47 MODULE_PARM_DESC(id, "ID string for VXPocket soundcard.");
48 module_param_array(enable, bool, NULL, 0444);
49 MODULE_PARM_DESC(enable, "Enable VXPocket soundcard.");
50 module_param_array(ibl, int, NULL, 0444);
51 MODULE_PARM_DESC(ibl, "Capture IBL size for VXPocket soundcard.");
52  
53
54 /*
55  */
56
57 static unsigned int card_alloc;
58
59
60 /*
61  */
62 static void vxpocket_release(dev_link_t *link)
63 {
64         if (link->state & DEV_CONFIG) {
65                 /* release cs resources */
66                 pcmcia_release_configuration(link->handle);
67                 pcmcia_release_io(link->handle, &link->io);
68                 pcmcia_release_irq(link->handle, &link->irq);
69                 link->state &= ~DEV_CONFIG;
70         }
71 }
72
73 /*
74  * destructor, called from snd_card_free_in_thread()
75  */
76 static int snd_vxpocket_dev_free(struct snd_device *device)
77 {
78         struct vx_core *chip = device->device_data;
79
80         snd_vx_free_firmware(chip);
81         kfree(chip);
82         return 0;
83 }
84
85
86 /*
87  * Hardware information
88  */
89
90 /* VX-pocket V2
91  *
92  * 1 DSP, 1 sync UER
93  * 1 programmable clock (NIY)
94  * 1 stereo analog input (line/micro)
95  * 1 stereo analog output
96  * Only output levels can be modified
97  */
98
99 static struct snd_vx_hardware vxpocket_hw = {
100         .name = "VXPocket",
101         .type = VX_TYPE_VXPOCKET,
102
103         /* hardware specs */
104         .num_codecs = 1,
105         .num_ins = 1,
106         .num_outs = 1,
107         .output_level_max = VX_ANALOG_OUT_LEVEL_MAX,
108 };      
109
110 /* VX-pocket 440
111  *
112  * 1 DSP, 1 sync UER, 1 sync World Clock (NIY)
113  * SMPTE (NIY)
114  * 2 stereo analog input (line/micro)
115  * 2 stereo analog output
116  * Only output levels can be modified
117  * UER, but only for the first two inputs and outputs.
118  */
119
120 static struct snd_vx_hardware vxp440_hw = {
121         .name = "VXPocket440",
122         .type = VX_TYPE_VXP440,
123
124         /* hardware specs */
125         .num_codecs = 2,
126         .num_ins = 2,
127         .num_outs = 2,
128         .output_level_max = VX_ANALOG_OUT_LEVEL_MAX,
129 };      
130
131
132 /*
133  * create vxpocket instance
134  */
135 static struct snd_vxpocket *snd_vxpocket_new(struct snd_card *card, int ibl)
136 {
137         dev_link_t *link;               /* Info for cardmgr */
138         struct vx_core *chip;
139         struct snd_vxpocket *vxp;
140         static struct snd_device_ops ops = {
141                 .dev_free =     snd_vxpocket_dev_free,
142         };
143
144         chip = snd_vx_create(card, &vxpocket_hw, &snd_vxpocket_ops,
145                              sizeof(struct snd_vxpocket) - sizeof(struct vx_core));
146         if (! chip)
147                 return NULL;
148
149         if (snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops) < 0) {
150                 kfree(chip);
151                 return NULL;
152         }
153         chip->ibl.size = ibl;
154
155         vxp = (struct snd_vxpocket *)chip;
156
157         link = &vxp->link;
158         link->priv = chip;
159
160         link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
161         link->io.NumPorts1 = 16;
162
163         link->irq.Attributes = IRQ_TYPE_EXCLUSIVE | IRQ_HANDLE_PRESENT;
164
165         link->irq.IRQInfo1 = IRQ_LEVEL_ID;
166         link->irq.Handler = &snd_vx_irq_handler;
167         link->irq.Instance = chip;
168
169         link->conf.Attributes = CONF_ENABLE_IRQ;
170         link->conf.Vcc = 50;
171         link->conf.IntType = INT_MEMORY_AND_IO;
172         link->conf.ConfigIndex = 1;
173         link->conf.Present = PRESENT_OPTION;
174
175         return vxp;
176 }
177
178
179 /**
180  * snd_vxpocket_assign_resources - initialize the hardware and card instance.
181  * @port: i/o port for the card
182  * @irq: irq number for the card
183  *
184  * this function assigns the specified port and irq, boot the card,
185  * create pcm and control instances, and initialize the rest hardware.
186  *
187  * returns 0 if successful, or a negative error code.
188  */
189 static int snd_vxpocket_assign_resources(struct vx_core *chip, int port, int irq)
190 {
191         int err;
192         struct snd_card *card = chip->card;
193         struct snd_vxpocket *vxp = (struct snd_vxpocket *)chip;
194
195         snd_printdd(KERN_DEBUG "vxpocket assign resources: port = 0x%x, irq = %d\n", port, irq);
196         vxp->port = port;
197
198         sprintf(card->shortname, "Digigram %s", card->driver);
199         sprintf(card->longname, "%s at 0x%x, irq %i",
200                 card->shortname, port, irq);
201
202         chip->irq = irq;
203
204         if ((err = snd_vx_setup_firmware(chip)) < 0)
205                 return err;
206
207         return 0;
208 }
209
210
211 /*
212  * configuration callback
213  */
214
215 #define CS_CHECK(fn, ret) \
216 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
217
218 static void vxpocket_config(dev_link_t *link)
219 {
220         client_handle_t handle = link->handle;
221         struct vx_core *chip = link->priv;
222         struct snd_vxpocket *vxp = (struct snd_vxpocket *)chip;
223         tuple_t tuple;
224         cisparse_t *parse;
225         u_short buf[32];
226         int last_fn, last_ret;
227
228         snd_printdd(KERN_DEBUG "vxpocket_config called\n");
229         parse = kmalloc(sizeof(*parse), GFP_KERNEL);
230         if (! parse) {
231                 snd_printk(KERN_ERR "vx: cannot allocate\n");
232                 return;
233         }
234         tuple.Attributes = 0;
235         tuple.TupleData = (cisdata_t *)buf;
236         tuple.TupleDataMax = sizeof(buf);
237         tuple.TupleOffset = 0;
238         tuple.DesiredTuple = CISTPL_CONFIG;
239         CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
240         CS_CHECK(GetTupleData, pcmcia_get_tuple_data(handle, &tuple));
241         CS_CHECK(ParseTuple, pcmcia_parse_tuple(handle, &tuple, parse));
242         link->conf.ConfigBase = parse->config.base;
243         link->conf.Present = parse->config.rmask[0];
244
245         /* redefine hardware record according to the VERSION1 string */
246         tuple.DesiredTuple = CISTPL_VERS_1;
247         CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
248         CS_CHECK(GetTupleData, pcmcia_get_tuple_data(handle, &tuple));
249         CS_CHECK(ParseTuple, pcmcia_parse_tuple(handle, &tuple, parse));
250         if (! strcmp(parse->version_1.str + parse->version_1.ofs[1], "VX-POCKET")) {
251                 snd_printdd("VX-pocket is detected\n");
252         } else {
253                 snd_printdd("VX-pocket 440 is detected\n");
254                 /* overwrite the hardware information */
255                 chip->hw = &vxp440_hw;
256                 chip->type = vxp440_hw.type;
257                 strcpy(chip->card->driver, vxp440_hw.name);
258         }
259
260         /* Configure card */
261         link->state |= DEV_CONFIG;
262
263         CS_CHECK(RequestIO, pcmcia_request_io(handle, &link->io));
264         CS_CHECK(RequestIRQ, pcmcia_request_irq(link->handle, &link->irq));
265         CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link->handle, &link->conf));
266
267         chip->dev = &handle_to_dev(link->handle);
268         snd_card_set_dev(chip->card, chip->dev);
269
270         if (snd_vxpocket_assign_resources(chip, link->io.BasePort1, link->irq.AssignedIRQ) < 0)
271                 goto failed;
272
273         link->dev = &vxp->node;
274         link->state &= ~DEV_CONFIG_PENDING;
275         kfree(parse);
276         return;
277
278 cs_failed:
279         cs_error(link->handle, last_fn, last_ret);
280 failed:
281         pcmcia_release_configuration(link->handle);
282         pcmcia_release_io(link->handle, &link->io);
283         pcmcia_release_irq(link->handle, &link->irq);
284         link->state &= ~DEV_CONFIG;
285         kfree(parse);
286 }
287
288 #ifdef CONFIG_PM
289
290 static int vxp_suspend(struct pcmcia_device *dev)
291 {
292         dev_link_t *link = dev_to_instance(dev);
293         struct vx_core *chip = link->priv;
294
295         snd_printdd(KERN_DEBUG "SUSPEND\n");
296         link->state |= DEV_SUSPEND;
297         if (chip) {
298                 snd_printdd(KERN_DEBUG "snd_vx_suspend calling\n");
299                 snd_vx_suspend(chip, PMSG_SUSPEND);
300         }
301         snd_printdd(KERN_DEBUG "RESET_PHYSICAL\n");
302         if (link->state & DEV_CONFIG)
303                 pcmcia_release_configuration(link->handle);
304
305         return 0;
306 }
307
308 static int vxp_resume(struct pcmcia_device *dev)
309 {
310         dev_link_t *link = dev_to_instance(dev);
311         struct vx_core *chip = link->priv;
312
313         snd_printdd(KERN_DEBUG "RESUME\n");
314         link->state &= ~DEV_SUSPEND;
315
316         snd_printdd(KERN_DEBUG "CARD_RESET\n");
317         if (DEV_OK(link)) {
318                 //struct snd_vxpocket *vxp = (struct snd_vxpocket *)chip;
319                 snd_printdd(KERN_DEBUG "requestconfig...\n");
320                 pcmcia_request_configuration(link->handle, &link->conf);
321                 if (chip) {
322                         snd_printdd(KERN_DEBUG "calling snd_vx_resume\n");
323                         snd_vx_resume(chip);
324                 }
325         }
326         snd_printdd(KERN_DEBUG "resume done!\n");
327
328         return 0;
329 }
330
331 #endif
332
333
334 /*
335  */
336 static int vxpocket_attach(struct pcmcia_device *p_dev)
337 {
338         struct snd_card *card;
339         struct snd_vxpocket *vxp;
340         int i;
341
342         /* find an empty slot from the card list */
343         for (i = 0; i < SNDRV_CARDS; i++) {
344                 if (! card_alloc & (1 << i))
345                         break;
346         }
347         if (i >= SNDRV_CARDS) {
348                 snd_printk(KERN_ERR "vxpocket: too many cards found\n");
349                 return -EINVAL;
350         }
351         if (! enable[i])
352                 return -ENODEV; /* disabled explicitly */
353
354         /* ok, create a card instance */
355         card = snd_card_new(index[i], id[i], THIS_MODULE, 0);
356         if (card == NULL) {
357                 snd_printk(KERN_ERR "vxpocket: cannot create a card instance\n");
358                 return -ENOMEM;
359         }
360
361         vxp = snd_vxpocket_new(card, ibl[i]);
362         if (! vxp) {
363                 snd_card_free(card);
364                 return -ENODEV;
365         }
366         card->private_data = vxp;
367
368         vxp->index = i;
369         card_alloc |= 1 << i;
370
371         /* Chain drivers */
372         vxp->link.next = NULL;
373
374         vxp->link.handle = p_dev;
375         vxp->link.state |= DEV_PRESENT | DEV_CONFIG_PENDING;
376         p_dev->instance = &vxp->link;
377         vxpocket_config(&vxp->link);
378
379         return 0;
380 }
381
382 static void vxpocket_detach(struct pcmcia_device *p_dev)
383 {
384         dev_link_t *link = dev_to_instance(p_dev);
385         struct snd_vxpocket *vxp;
386         struct vx_core *chip;
387
388         if (! link)
389                 return;
390
391         vxp = link->priv;
392         chip = (struct vx_core *)vxp;
393         card_alloc &= ~(1 << vxp->index);
394
395         chip->chip_status |= VX_STAT_IS_STALE; /* to be sure */
396         snd_card_disconnect(chip->card);
397         vxpocket_release(link);
398         snd_card_free_in_thread(chip->card);
399 }
400
401 /*
402  * Module entry points
403  */
404
405 static struct pcmcia_device_id vxp_ids[] = {
406         PCMCIA_DEVICE_MANF_CARD(0x01f1, 0x0100),
407         PCMCIA_DEVICE_NULL
408 };
409 MODULE_DEVICE_TABLE(pcmcia, vxp_ids);
410
411 static struct pcmcia_driver vxp_cs_driver = {
412         .owner          = THIS_MODULE,
413         .drv            = {
414                 .name   = "snd-vxpocket",
415         },
416         .probe          = vxpocket_attach,
417         .remove         = vxpocket_detach,
418         .id_table       = vxp_ids,
419 #ifdef CONFIG_PM
420         .suspend        = vxp_suspend,
421         .resume         = vxp_resume,
422 #endif
423 };
424
425 static int __init init_vxpocket(void)
426 {
427         return pcmcia_register_driver(&vxp_cs_driver);
428 }
429
430 static void __exit exit_vxpocket(void)
431 {
432         pcmcia_unregister_driver(&vxp_cs_driver);
433 }
434
435 module_init(init_vxpocket);
436 module_exit(exit_vxpocket);