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