1/*
2 *  The driver for the Yamaha's DS1/DS1E cards
3 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
4 *
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/pci.h>
24#include <linux/time.h>
25#include <linux/module.h>
26#include <sound/core.h>
27#include "ymfpci.h"
28#include <sound/mpu401.h>
29#include <sound/opl3.h>
30#include <sound/initval.h>
31
32MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
33MODULE_DESCRIPTION("Yamaha DS-1 PCI");
34MODULE_LICENSE("GPL");
35MODULE_SUPPORTED_DEVICE("{{Yamaha,YMF724},"
36		"{Yamaha,YMF724F},"
37		"{Yamaha,YMF740},"
38		"{Yamaha,YMF740C},"
39		"{Yamaha,YMF744},"
40		"{Yamaha,YMF754}}");
41
42static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;	/* Index 0-MAX */
43static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;	/* ID for this card */
44static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;	/* Enable this card */
45static long fm_port[SNDRV_CARDS];
46static long mpu_port[SNDRV_CARDS];
47#ifdef SUPPORT_JOYSTICK
48static long joystick_port[SNDRV_CARDS];
49#endif
50static bool rear_switch[SNDRV_CARDS];
51
52module_param_array(index, int, NULL, 0444);
53MODULE_PARM_DESC(index, "Index value for the Yamaha DS-1 PCI soundcard.");
54module_param_array(id, charp, NULL, 0444);
55MODULE_PARM_DESC(id, "ID string for the Yamaha DS-1 PCI soundcard.");
56module_param_array(enable, bool, NULL, 0444);
57MODULE_PARM_DESC(enable, "Enable Yamaha DS-1 soundcard.");
58module_param_array(mpu_port, long, NULL, 0444);
59MODULE_PARM_DESC(mpu_port, "MPU-401 Port.");
60module_param_array(fm_port, long, NULL, 0444);
61MODULE_PARM_DESC(fm_port, "FM OPL-3 Port.");
62#ifdef SUPPORT_JOYSTICK
63module_param_array(joystick_port, long, NULL, 0444);
64MODULE_PARM_DESC(joystick_port, "Joystick port address");
65#endif
66module_param_array(rear_switch, bool, NULL, 0444);
67MODULE_PARM_DESC(rear_switch, "Enable shared rear/line-in switch");
68
69static const struct pci_device_id snd_ymfpci_ids[] = {
70	{ PCI_VDEVICE(YAMAHA, 0x0004), 0, },   /* YMF724 */
71	{ PCI_VDEVICE(YAMAHA, 0x000d), 0, },   /* YMF724F */
72	{ PCI_VDEVICE(YAMAHA, 0x000a), 0, },   /* YMF740 */
73	{ PCI_VDEVICE(YAMAHA, 0x000c), 0, },   /* YMF740C */
74	{ PCI_VDEVICE(YAMAHA, 0x0010), 0, },   /* YMF744 */
75	{ PCI_VDEVICE(YAMAHA, 0x0012), 0, },   /* YMF754 */
76	{ 0, }
77};
78
79MODULE_DEVICE_TABLE(pci, snd_ymfpci_ids);
80
81#ifdef SUPPORT_JOYSTICK
82static int snd_ymfpci_create_gameport(struct snd_ymfpci *chip, int dev,
83				      int legacy_ctrl, int legacy_ctrl2)
84{
85	struct gameport *gp;
86	struct resource *r = NULL;
87	int io_port = joystick_port[dev];
88
89	if (!io_port)
90		return -ENODEV;
91
92	if (chip->pci->device >= 0x0010) { /* YMF 744/754 */
93
94		if (io_port == 1) {
95			/* auto-detect */
96			if (!(io_port = pci_resource_start(chip->pci, 2)))
97				return -ENODEV;
98		}
99	} else {
100		if (io_port == 1) {
101			/* auto-detect */
102			for (io_port = 0x201; io_port <= 0x205; io_port++) {
103				if (io_port == 0x203)
104					continue;
105				if ((r = request_region(io_port, 1, "YMFPCI gameport")) != NULL)
106					break;
107			}
108			if (!r) {
109				dev_err(chip->card->dev,
110					"no gameport ports available\n");
111				return -EBUSY;
112			}
113		}
114		switch (io_port) {
115		case 0x201: legacy_ctrl2 |= 0 << 6; break;
116		case 0x202: legacy_ctrl2 |= 1 << 6; break;
117		case 0x204: legacy_ctrl2 |= 2 << 6; break;
118		case 0x205: legacy_ctrl2 |= 3 << 6; break;
119		default:
120			dev_err(chip->card->dev,
121				"invalid joystick port %#x", io_port);
122			return -EINVAL;
123		}
124	}
125
126	if (!r && !(r = request_region(io_port, 1, "YMFPCI gameport"))) {
127		dev_err(chip->card->dev,
128			"joystick port %#x is in use.\n", io_port);
129		return -EBUSY;
130	}
131
132	chip->gameport = gp = gameport_allocate_port();
133	if (!gp) {
134		dev_err(chip->card->dev,
135			"cannot allocate memory for gameport\n");
136		release_and_free_resource(r);
137		return -ENOMEM;
138	}
139
140
141	gameport_set_name(gp, "Yamaha YMF Gameport");
142	gameport_set_phys(gp, "pci%s/gameport0", pci_name(chip->pci));
143	gameport_set_dev_parent(gp, &chip->pci->dev);
144	gp->io = io_port;
145	gameport_set_port_data(gp, r);
146
147	if (chip->pci->device >= 0x0010) /* YMF 744/754 */
148		pci_write_config_word(chip->pci, PCIR_DSXG_JOYBASE, io_port);
149
150	pci_write_config_word(chip->pci, PCIR_DSXG_LEGACY, legacy_ctrl | YMFPCI_LEGACY_JPEN);
151	pci_write_config_word(chip->pci, PCIR_DSXG_ELEGACY, legacy_ctrl2);
152
153	gameport_register_port(chip->gameport);
154
155	return 0;
156}
157
158void snd_ymfpci_free_gameport(struct snd_ymfpci *chip)
159{
160	if (chip->gameport) {
161		struct resource *r = gameport_get_port_data(chip->gameport);
162
163		gameport_unregister_port(chip->gameport);
164		chip->gameport = NULL;
165
166		release_and_free_resource(r);
167	}
168}
169#else
170static inline int snd_ymfpci_create_gameport(struct snd_ymfpci *chip, int dev, int l, int l2) { return -ENOSYS; }
171void snd_ymfpci_free_gameport(struct snd_ymfpci *chip) { }
172#endif /* SUPPORT_JOYSTICK */
173
174static int snd_card_ymfpci_probe(struct pci_dev *pci,
175				 const struct pci_device_id *pci_id)
176{
177	static int dev;
178	struct snd_card *card;
179	struct resource *fm_res = NULL;
180	struct resource *mpu_res = NULL;
181	struct snd_ymfpci *chip;
182	struct snd_opl3 *opl3;
183	const char *str, *model;
184	int err;
185	u16 legacy_ctrl, legacy_ctrl2, old_legacy_ctrl;
186
187	if (dev >= SNDRV_CARDS)
188		return -ENODEV;
189	if (!enable[dev]) {
190		dev++;
191		return -ENOENT;
192	}
193
194	err = snd_card_new(&pci->dev, index[dev], id[dev], THIS_MODULE,
195			   0, &card);
196	if (err < 0)
197		return err;
198
199	switch (pci_id->device) {
200	case 0x0004: str = "YMF724";  model = "DS-1"; break;
201	case 0x000d: str = "YMF724F"; model = "DS-1"; break;
202	case 0x000a: str = "YMF740";  model = "DS-1L"; break;
203	case 0x000c: str = "YMF740C"; model = "DS-1L"; break;
204	case 0x0010: str = "YMF744";  model = "DS-1S"; break;
205	case 0x0012: str = "YMF754";  model = "DS-1E"; break;
206	default: model = str = "???"; break;
207	}
208
209	legacy_ctrl = 0;
210	legacy_ctrl2 = 0x0800;	/* SBEN = 0, SMOD = 01, LAD = 0 */
211
212	if (pci_id->device >= 0x0010) { /* YMF 744/754 */
213		if (fm_port[dev] == 1) {
214			/* auto-detect */
215			fm_port[dev] = pci_resource_start(pci, 1);
216		}
217		if (fm_port[dev] > 0 &&
218		    (fm_res = request_region(fm_port[dev], 4, "YMFPCI OPL3")) != NULL) {
219			legacy_ctrl |= YMFPCI_LEGACY_FMEN;
220			pci_write_config_word(pci, PCIR_DSXG_FMBASE, fm_port[dev]);
221		}
222		if (mpu_port[dev] == 1) {
223			/* auto-detect */
224			mpu_port[dev] = pci_resource_start(pci, 1) + 0x20;
225		}
226		if (mpu_port[dev] > 0 &&
227		    (mpu_res = request_region(mpu_port[dev], 2, "YMFPCI MPU401")) != NULL) {
228			legacy_ctrl |= YMFPCI_LEGACY_MEN;
229			pci_write_config_word(pci, PCIR_DSXG_MPU401BASE, mpu_port[dev]);
230		}
231	} else {
232		switch (fm_port[dev]) {
233		case 0x388: legacy_ctrl2 |= 0; break;
234		case 0x398: legacy_ctrl2 |= 1; break;
235		case 0x3a0: legacy_ctrl2 |= 2; break;
236		case 0x3a8: legacy_ctrl2 |= 3; break;
237		default: fm_port[dev] = 0; break;
238		}
239		if (fm_port[dev] > 0 &&
240		    (fm_res = request_region(fm_port[dev], 4, "YMFPCI OPL3")) != NULL) {
241			legacy_ctrl |= YMFPCI_LEGACY_FMEN;
242		} else {
243			legacy_ctrl2 &= ~YMFPCI_LEGACY2_FMIO;
244			fm_port[dev] = 0;
245		}
246		switch (mpu_port[dev]) {
247		case 0x330: legacy_ctrl2 |= 0 << 4; break;
248		case 0x300: legacy_ctrl2 |= 1 << 4; break;
249		case 0x332: legacy_ctrl2 |= 2 << 4; break;
250		case 0x334: legacy_ctrl2 |= 3 << 4; break;
251		default: mpu_port[dev] = 0; break;
252		}
253		if (mpu_port[dev] > 0 &&
254		    (mpu_res = request_region(mpu_port[dev], 2, "YMFPCI MPU401")) != NULL) {
255			legacy_ctrl |= YMFPCI_LEGACY_MEN;
256		} else {
257			legacy_ctrl2 &= ~YMFPCI_LEGACY2_MPUIO;
258			mpu_port[dev] = 0;
259		}
260	}
261	if (mpu_res) {
262		legacy_ctrl |= YMFPCI_LEGACY_MIEN;
263		legacy_ctrl2 |= YMFPCI_LEGACY2_IMOD;
264	}
265	pci_read_config_word(pci, PCIR_DSXG_LEGACY, &old_legacy_ctrl);
266	pci_write_config_word(pci, PCIR_DSXG_LEGACY, legacy_ctrl);
267	pci_write_config_word(pci, PCIR_DSXG_ELEGACY, legacy_ctrl2);
268	if ((err = snd_ymfpci_create(card, pci,
269				     old_legacy_ctrl,
270			 	     &chip)) < 0) {
271		snd_card_free(card);
272		release_and_free_resource(mpu_res);
273		release_and_free_resource(fm_res);
274		return err;
275	}
276	chip->fm_res = fm_res;
277	chip->mpu_res = mpu_res;
278	card->private_data = chip;
279
280	strcpy(card->driver, str);
281	sprintf(card->shortname, "Yamaha %s (%s)", model, str);
282	sprintf(card->longname, "%s at 0x%lx, irq %i",
283		card->shortname,
284		chip->reg_area_phys,
285		chip->irq);
286	if ((err = snd_ymfpci_pcm(chip, 0)) < 0) {
287		snd_card_free(card);
288		return err;
289	}
290	if ((err = snd_ymfpci_pcm_spdif(chip, 1)) < 0) {
291		snd_card_free(card);
292		return err;
293	}
294	err = snd_ymfpci_mixer(chip, rear_switch[dev]);
295	if (err < 0) {
296		snd_card_free(card);
297		return err;
298	}
299	if (chip->ac97->ext_id & AC97_EI_SDAC) {
300		err = snd_ymfpci_pcm_4ch(chip, 2);
301		if (err < 0) {
302			snd_card_free(card);
303			return err;
304		}
305		err = snd_ymfpci_pcm2(chip, 3);
306		if (err < 0) {
307			snd_card_free(card);
308			return err;
309		}
310	}
311	if ((err = snd_ymfpci_timer(chip, 0)) < 0) {
312		snd_card_free(card);
313		return err;
314	}
315	if (chip->mpu_res) {
316		if ((err = snd_mpu401_uart_new(card, 0, MPU401_HW_YMFPCI,
317					       mpu_port[dev],
318					       MPU401_INFO_INTEGRATED |
319					       MPU401_INFO_IRQ_HOOK,
320					       -1, &chip->rawmidi)) < 0) {
321			dev_warn(card->dev,
322				 "cannot initialize MPU401 at 0x%lx, skipping...\n",
323				 mpu_port[dev]);
324			legacy_ctrl &= ~YMFPCI_LEGACY_MIEN; /* disable MPU401 irq */
325			pci_write_config_word(pci, PCIR_DSXG_LEGACY, legacy_ctrl);
326		}
327	}
328	if (chip->fm_res) {
329		if ((err = snd_opl3_create(card,
330					   fm_port[dev],
331					   fm_port[dev] + 2,
332					   OPL3_HW_OPL3, 1, &opl3)) < 0) {
333			dev_warn(card->dev,
334				 "cannot initialize FM OPL3 at 0x%lx, skipping...\n",
335				 fm_port[dev]);
336			legacy_ctrl &= ~YMFPCI_LEGACY_FMEN;
337			pci_write_config_word(pci, PCIR_DSXG_LEGACY, legacy_ctrl);
338		} else if ((err = snd_opl3_hwdep_new(opl3, 0, 1, NULL)) < 0) {
339			snd_card_free(card);
340			dev_err(card->dev, "cannot create opl3 hwdep\n");
341			return err;
342		}
343	}
344
345	snd_ymfpci_create_gameport(chip, dev, legacy_ctrl, legacy_ctrl2);
346
347	if ((err = snd_card_register(card)) < 0) {
348		snd_card_free(card);
349		return err;
350	}
351	pci_set_drvdata(pci, card);
352	dev++;
353	return 0;
354}
355
356static void snd_card_ymfpci_remove(struct pci_dev *pci)
357{
358	snd_card_free(pci_get_drvdata(pci));
359}
360
361static struct pci_driver ymfpci_driver = {
362	.name = KBUILD_MODNAME,
363	.id_table = snd_ymfpci_ids,
364	.probe = snd_card_ymfpci_probe,
365	.remove = snd_card_ymfpci_remove,
366#ifdef CONFIG_PM_SLEEP
367	.driver = {
368		.pm = &snd_ymfpci_pm,
369	},
370#endif
371};
372
373module_pci_driver(ymfpci_driver);
374