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