xref: /linux/sound/pcmcia/vx/vxpocket.c (revision f24e9f586b377749dff37554696cf3a105540c94)
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(struct pcmcia_device *link)
63 {
64 	pcmcia_disable_device(link);
65 }
66 
67 /*
68  * destructor, called from snd_card_free_when_closed()
69  */
70 static int snd_vxpocket_dev_free(struct snd_device *device)
71 {
72 	struct vx_core *chip = device->device_data;
73 
74 	snd_vx_free_firmware(chip);
75 	kfree(chip);
76 	return 0;
77 }
78 
79 
80 /*
81  * Hardware information
82  */
83 
84 /* VX-pocket V2
85  *
86  * 1 DSP, 1 sync UER
87  * 1 programmable clock (NIY)
88  * 1 stereo analog input (line/micro)
89  * 1 stereo analog output
90  * Only output levels can be modified
91  */
92 
93 static struct snd_vx_hardware vxpocket_hw = {
94 	.name = "VXPocket",
95 	.type = VX_TYPE_VXPOCKET,
96 
97 	/* hardware specs */
98 	.num_codecs = 1,
99 	.num_ins = 1,
100 	.num_outs = 1,
101 	.output_level_max = VX_ANALOG_OUT_LEVEL_MAX,
102 };
103 
104 /* VX-pocket 440
105  *
106  * 1 DSP, 1 sync UER, 1 sync World Clock (NIY)
107  * SMPTE (NIY)
108  * 2 stereo analog input (line/micro)
109  * 2 stereo analog output
110  * Only output levels can be modified
111  * UER, but only for the first two inputs and outputs.
112  */
113 
114 static struct snd_vx_hardware vxp440_hw = {
115 	.name = "VXPocket440",
116 	.type = VX_TYPE_VXP440,
117 
118 	/* hardware specs */
119 	.num_codecs = 2,
120 	.num_ins = 2,
121 	.num_outs = 2,
122 	.output_level_max = VX_ANALOG_OUT_LEVEL_MAX,
123 };
124 
125 
126 /*
127  * create vxpocket instance
128  */
129 static struct snd_vxpocket *snd_vxpocket_new(struct snd_card *card, int ibl,
130 					     struct pcmcia_device *link)
131 {
132 	struct vx_core *chip;
133 	struct snd_vxpocket *vxp;
134 	static struct snd_device_ops ops = {
135 		.dev_free =	snd_vxpocket_dev_free,
136 	};
137 
138 	chip = snd_vx_create(card, &vxpocket_hw, &snd_vxpocket_ops,
139 			     sizeof(struct snd_vxpocket) - sizeof(struct vx_core));
140 	if (! chip)
141 		return NULL;
142 
143 	if (snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops) < 0) {
144 		kfree(chip);
145 		return NULL;
146 	}
147 	chip->ibl.size = ibl;
148 
149 	vxp = (struct snd_vxpocket *)chip;
150 
151 	vxp->p_dev = link;
152 	link->priv = chip;
153 
154 	link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
155 	link->io.NumPorts1 = 16;
156 
157 	link->irq.Attributes = IRQ_TYPE_EXCLUSIVE | IRQ_HANDLE_PRESENT;
158 
159 	link->irq.IRQInfo1 = IRQ_LEVEL_ID;
160 	link->irq.Handler = &snd_vx_irq_handler;
161 	link->irq.Instance = chip;
162 
163 	link->conf.Attributes = CONF_ENABLE_IRQ;
164 	link->conf.IntType = INT_MEMORY_AND_IO;
165 	link->conf.ConfigIndex = 1;
166 	link->conf.Present = PRESENT_OPTION;
167 
168 	return vxp;
169 }
170 
171 
172 /**
173  * snd_vxpocket_assign_resources - initialize the hardware and card instance.
174  * @port: i/o port for the card
175  * @irq: irq number for the card
176  *
177  * this function assigns the specified port and irq, boot the card,
178  * create pcm and control instances, and initialize the rest hardware.
179  *
180  * returns 0 if successful, or a negative error code.
181  */
182 static int snd_vxpocket_assign_resources(struct vx_core *chip, int port, int irq)
183 {
184 	int err;
185 	struct snd_card *card = chip->card;
186 	struct snd_vxpocket *vxp = (struct snd_vxpocket *)chip;
187 
188 	snd_printdd(KERN_DEBUG "vxpocket assign resources: port = 0x%x, irq = %d\n", port, irq);
189 	vxp->port = port;
190 
191 	sprintf(card->shortname, "Digigram %s", card->driver);
192 	sprintf(card->longname, "%s at 0x%x, irq %i",
193 		card->shortname, port, irq);
194 
195 	chip->irq = irq;
196 
197 	if ((err = snd_vx_setup_firmware(chip)) < 0)
198 		return err;
199 
200 	return 0;
201 }
202 
203 
204 /*
205  * configuration callback
206  */
207 
208 #define CS_CHECK(fn, ret) \
209 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
210 
211 static int vxpocket_config(struct pcmcia_device *link)
212 {
213 	struct vx_core *chip = link->priv;
214 	struct snd_vxpocket *vxp = (struct snd_vxpocket *)chip;
215 	tuple_t tuple;
216 	cisparse_t *parse;
217 	u_short buf[32];
218 	int last_fn, last_ret;
219 
220 	snd_printdd(KERN_DEBUG "vxpocket_config called\n");
221 	parse = kmalloc(sizeof(*parse), GFP_KERNEL);
222 	if (! parse) {
223 		snd_printk(KERN_ERR "vx: cannot allocate\n");
224 		return -ENOMEM;
225 	}
226 	tuple.Attributes = 0;
227 	tuple.TupleData = (cisdata_t *)buf;
228 	tuple.TupleDataMax = sizeof(buf);
229 	tuple.TupleOffset = 0;
230 	tuple.DesiredTuple = CISTPL_CONFIG;
231 	CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(link, &tuple));
232 	CS_CHECK(GetTupleData, pcmcia_get_tuple_data(link, &tuple));
233 	CS_CHECK(ParseTuple, pcmcia_parse_tuple(link, &tuple, parse));
234 	link->conf.ConfigBase = parse->config.base;
235 	link->conf.Present = parse->config.rmask[0];
236 
237 	/* redefine hardware record according to the VERSION1 string */
238 	tuple.DesiredTuple = CISTPL_VERS_1;
239 	CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(link, &tuple));
240 	CS_CHECK(GetTupleData, pcmcia_get_tuple_data(link, &tuple));
241 	CS_CHECK(ParseTuple, pcmcia_parse_tuple(link, &tuple, parse));
242 	if (! strcmp(parse->version_1.str + parse->version_1.ofs[1], "VX-POCKET")) {
243 		snd_printdd("VX-pocket is detected\n");
244 	} else {
245 		snd_printdd("VX-pocket 440 is detected\n");
246 		/* overwrite the hardware information */
247 		chip->hw = &vxp440_hw;
248 		chip->type = vxp440_hw.type;
249 		strcpy(chip->card->driver, vxp440_hw.name);
250 	}
251 
252 	CS_CHECK(RequestIO, pcmcia_request_io(link, &link->io));
253 	CS_CHECK(RequestIRQ, pcmcia_request_irq(link, &link->irq));
254 	CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link, &link->conf));
255 
256 	chip->dev = &handle_to_dev(link);
257 	snd_card_set_dev(chip->card, chip->dev);
258 
259 	if (snd_vxpocket_assign_resources(chip, link->io.BasePort1, link->irq.AssignedIRQ) < 0)
260 		goto failed;
261 
262 	link->dev_node = &vxp->node;
263 	kfree(parse);
264 	return 0;
265 
266 cs_failed:
267 	cs_error(link, last_fn, last_ret);
268 failed:
269 	pcmcia_disable_device(link);
270 	kfree(parse);
271 	return -ENODEV;
272 }
273 
274 #ifdef CONFIG_PM
275 
276 static int vxp_suspend(struct pcmcia_device *link)
277 {
278 	struct vx_core *chip = link->priv;
279 
280 	snd_printdd(KERN_DEBUG "SUSPEND\n");
281 	if (chip) {
282 		snd_printdd(KERN_DEBUG "snd_vx_suspend calling\n");
283 		snd_vx_suspend(chip, PMSG_SUSPEND);
284 	}
285 
286 	return 0;
287 }
288 
289 static int vxp_resume(struct pcmcia_device *link)
290 {
291 	struct vx_core *chip = link->priv;
292 
293 	snd_printdd(KERN_DEBUG "RESUME\n");
294 	if (pcmcia_dev_present(link)) {
295 		//struct snd_vxpocket *vxp = (struct snd_vxpocket *)chip;
296 		if (chip) {
297 			snd_printdd(KERN_DEBUG "calling snd_vx_resume\n");
298 			snd_vx_resume(chip);
299 		}
300 	}
301 	snd_printdd(KERN_DEBUG "resume done!\n");
302 
303 	return 0;
304 }
305 
306 #endif
307 
308 
309 /*
310  */
311 static int vxpocket_probe(struct pcmcia_device *p_dev)
312 {
313 	struct snd_card *card;
314 	struct snd_vxpocket *vxp;
315 	int i;
316 
317 	/* find an empty slot from the card list */
318 	for (i = 0; i < SNDRV_CARDS; i++) {
319 		if (! card_alloc & (1 << i))
320 			break;
321 	}
322 	if (i >= SNDRV_CARDS) {
323 		snd_printk(KERN_ERR "vxpocket: too many cards found\n");
324 		return -EINVAL;
325 	}
326 	if (! enable[i])
327 		return -ENODEV; /* disabled explicitly */
328 
329 	/* ok, create a card instance */
330 	card = snd_card_new(index[i], id[i], THIS_MODULE, 0);
331 	if (card == NULL) {
332 		snd_printk(KERN_ERR "vxpocket: cannot create a card instance\n");
333 		return -ENOMEM;
334 	}
335 
336 	vxp = snd_vxpocket_new(card, ibl[i], p_dev);
337 	if (! vxp) {
338 		snd_card_free(card);
339 		return -ENODEV;
340 	}
341 	card->private_data = vxp;
342 
343 	vxp->index = i;
344 	card_alloc |= 1 << i;
345 
346 	vxp->p_dev = p_dev;
347 
348 	return vxpocket_config(p_dev);
349 }
350 
351 static void vxpocket_detach(struct pcmcia_device *link)
352 {
353 	struct snd_vxpocket *vxp;
354 	struct vx_core *chip;
355 
356 	if (! link)
357 		return;
358 
359 	vxp = link->priv;
360 	chip = (struct vx_core *)vxp;
361 	card_alloc &= ~(1 << vxp->index);
362 
363 	chip->chip_status |= VX_STAT_IS_STALE; /* to be sure */
364 	snd_card_disconnect(chip->card);
365 	vxpocket_release(link);
366 	snd_card_free_when_closed(chip->card);
367 }
368 
369 /*
370  * Module entry points
371  */
372 
373 static struct pcmcia_device_id vxp_ids[] = {
374 	PCMCIA_DEVICE_MANF_CARD(0x01f1, 0x0100),
375 	PCMCIA_DEVICE_NULL
376 };
377 MODULE_DEVICE_TABLE(pcmcia, vxp_ids);
378 
379 static struct pcmcia_driver vxp_cs_driver = {
380 	.owner		= THIS_MODULE,
381 	.drv		= {
382 		.name	= "snd-vxpocket",
383 	},
384 	.probe		= vxpocket_probe,
385 	.remove		= vxpocket_detach,
386 	.id_table	= vxp_ids,
387 #ifdef CONFIG_PM
388 	.suspend	= vxp_suspend,
389 	.resume		= vxp_resume,
390 #endif
391 };
392 
393 static int __init init_vxpocket(void)
394 {
395 	return pcmcia_register_driver(&vxp_cs_driver);
396 }
397 
398 static void __exit exit_vxpocket(void)
399 {
400 	pcmcia_unregister_driver(&vxp_cs_driver);
401 }
402 
403 module_init(init_vxpocket);
404 module_exit(exit_vxpocket);
405