xref: /linux/sound/drivers/pcsp/pcsp.c (revision d34e4e00adbbc91ff9fc96ed9a4e4b65161868da)
19ab4d072SStas Sergeev /*
29ab4d072SStas Sergeev  * PC-Speaker driver for Linux
39ab4d072SStas Sergeev  *
49ab4d072SStas Sergeev  * Copyright (C) 1997-2001  David Woodhouse
59ab4d072SStas Sergeev  * Copyright (C) 2001-2008  Stas Sergeev
69ab4d072SStas Sergeev  */
79ab4d072SStas Sergeev 
89ab4d072SStas Sergeev #include <linux/init.h>
965a77217SPaul Gortmaker #include <linux/module.h>
109ab4d072SStas Sergeev #include <linux/platform_device.h>
119ab4d072SStas Sergeev #include <sound/core.h>
129ab4d072SStas Sergeev #include <sound/initval.h>
139ab4d072SStas Sergeev #include <sound/pcm.h>
149ab4d072SStas Sergeev #include <linux/input.h>
159ecaedaeSMariusz Kozlowski #include <linux/delay.h>
169ab4d072SStas Sergeev #include <asm/bitops.h>
179ab4d072SStas Sergeev #include "pcsp_input.h"
189ab4d072SStas Sergeev #include "pcsp.h"
199ab4d072SStas Sergeev 
209ab4d072SStas Sergeev MODULE_AUTHOR("Stas Sergeev <stsp@users.sourceforge.net>");
219ab4d072SStas Sergeev MODULE_DESCRIPTION("PC-Speaker driver");
229ab4d072SStas Sergeev MODULE_LICENSE("GPL");
239ab4d072SStas Sergeev MODULE_SUPPORTED_DEVICE("{{PC-Speaker, pcsp}}");
249ab4d072SStas Sergeev MODULE_ALIAS("platform:pcspkr");
259ab4d072SStas Sergeev 
269ab4d072SStas Sergeev static int index = SNDRV_DEFAULT_IDX1;	/* Index 0-MAX */
279ab4d072SStas Sergeev static char *id = SNDRV_DEFAULT_STR1;	/* ID for this card */
28a67ff6a5SRusty Russell static bool enable = SNDRV_DEFAULT_ENABLE1;	/* Enable this card */
29a67ff6a5SRusty Russell static bool nopcm;	/* Disable PCM capability of the driver */
309ab4d072SStas Sergeev 
319ab4d072SStas Sergeev module_param(index, int, 0444);
329ab4d072SStas Sergeev MODULE_PARM_DESC(index, "Index value for pcsp soundcard.");
339ab4d072SStas Sergeev module_param(id, charp, 0444);
349ab4d072SStas Sergeev MODULE_PARM_DESC(id, "ID string for pcsp soundcard.");
359ab4d072SStas Sergeev module_param(enable, bool, 0444);
3652337310SStas Sergeev MODULE_PARM_DESC(enable, "Enable PC-Speaker sound.");
37bcc2c6b7SStas Sergeev module_param(nopcm, bool, 0444);
38bcc2c6b7SStas Sergeev MODULE_PARM_DESC(nopcm, "Disable PC-Speaker PCM sound. Only beeps remain.");
399ab4d072SStas Sergeev 
409ab4d072SStas Sergeev struct snd_pcsp pcsp_chip;
419ab4d072SStas Sergeev 
429ab4d072SStas Sergeev static int __devinit snd_pcsp_create(struct snd_card *card)
439ab4d072SStas Sergeev {
449ab4d072SStas Sergeev 	static struct snd_device_ops ops = { };
459ab4d072SStas Sergeev 	struct timespec tp;
469ab4d072SStas Sergeev 	int err;
479ab4d072SStas Sergeev 	int div, min_div, order;
489ab4d072SStas Sergeev 
49bcc2c6b7SStas Sergeev 	if (!nopcm) {
509ab4d072SStas Sergeev 		hrtimer_get_res(CLOCK_MONOTONIC, &tp);
519ab4d072SStas Sergeev 		if (tp.tv_sec || tp.tv_nsec > PCSP_MAX_PERIOD_NS) {
529ab4d072SStas Sergeev 			printk(KERN_ERR "PCSP: Timer resolution is not sufficient "
539ab4d072SStas Sergeev 				"(%linS)\n", tp.tv_nsec);
549ab4d072SStas Sergeev 			printk(KERN_ERR "PCSP: Make sure you have HPET and ACPI "
559ab4d072SStas Sergeev 				"enabled.\n");
56bcc2c6b7SStas Sergeev 			printk(KERN_ERR "PCSP: Turned into nopcm mode.\n");
57bcc2c6b7SStas Sergeev 			nopcm = 1;
58bcc2c6b7SStas Sergeev 		}
599ab4d072SStas Sergeev 	}
609ab4d072SStas Sergeev 
619ab4d072SStas Sergeev 	if (loops_per_jiffy >= PCSP_MIN_LPJ && tp.tv_nsec <= PCSP_MIN_PERIOD_NS)
629ab4d072SStas Sergeev 		min_div = MIN_DIV;
639ab4d072SStas Sergeev 	else
649ab4d072SStas Sergeev 		min_div = MAX_DIV;
659ab4d072SStas Sergeev #if PCSP_DEBUG
6645203832STakashi Iwai 	printk(KERN_DEBUG "PCSP: lpj=%li, min_div=%i, res=%li\n",
679ab4d072SStas Sergeev 	       loops_per_jiffy, min_div, tp.tv_nsec);
689ab4d072SStas Sergeev #endif
699ab4d072SStas Sergeev 
709ab4d072SStas Sergeev 	div = MAX_DIV / min_div;
719ab4d072SStas Sergeev 	order = fls(div) - 1;
729ab4d072SStas Sergeev 
739ab4d072SStas Sergeev 	pcsp_chip.max_treble = min(order, PCSP_MAX_TREBLE);
749ab4d072SStas Sergeev 	pcsp_chip.treble = min(pcsp_chip.max_treble, PCSP_DEFAULT_TREBLE);
759ab4d072SStas Sergeev 	pcsp_chip.playback_ptr = 0;
769ab4d072SStas Sergeev 	pcsp_chip.period_ptr = 0;
779ab4d072SStas Sergeev 	atomic_set(&pcsp_chip.timer_active, 0);
789ab4d072SStas Sergeev 	pcsp_chip.enable = 1;
799ab4d072SStas Sergeev 	pcsp_chip.pcspkr = 1;
809ab4d072SStas Sergeev 
819ab4d072SStas Sergeev 	spin_lock_init(&pcsp_chip.substream_lock);
829ab4d072SStas Sergeev 
839ab4d072SStas Sergeev 	pcsp_chip.card = card;
849ab4d072SStas Sergeev 	pcsp_chip.port = 0x61;
859ab4d072SStas Sergeev 	pcsp_chip.irq = -1;
869ab4d072SStas Sergeev 	pcsp_chip.dma = -1;
879ab4d072SStas Sergeev 
889ab4d072SStas Sergeev 	/* Register device */
899ab4d072SStas Sergeev 	err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, &pcsp_chip, &ops);
909ab4d072SStas Sergeev 	if (err < 0)
919ab4d072SStas Sergeev 		return err;
929ab4d072SStas Sergeev 
939ab4d072SStas Sergeev 	return 0;
949ab4d072SStas Sergeev }
959ab4d072SStas Sergeev 
969ab4d072SStas Sergeev static int __devinit snd_card_pcsp_probe(int devnum, struct device *dev)
979ab4d072SStas Sergeev {
989ab4d072SStas Sergeev 	struct snd_card *card;
999ab4d072SStas Sergeev 	int err;
1009ab4d072SStas Sergeev 
1019ab4d072SStas Sergeev 	if (devnum != 0)
1029ab4d072SStas Sergeev 		return -EINVAL;
1039ab4d072SStas Sergeev 
1049ab4d072SStas Sergeev 	hrtimer_init(&pcsp_chip.timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
1059ab4d072SStas Sergeev 	pcsp_chip.timer.function = pcsp_do_timer;
1069ab4d072SStas Sergeev 
107bd7dd77cSTakashi Iwai 	err = snd_card_create(index, id, THIS_MODULE, 0, &card);
108bd7dd77cSTakashi Iwai 	if (err < 0)
109bd7dd77cSTakashi Iwai 		return err;
1109ab4d072SStas Sergeev 
1119ab4d072SStas Sergeev 	err = snd_pcsp_create(card);
1129ab4d072SStas Sergeev 	if (err < 0) {
1139ab4d072SStas Sergeev 		snd_card_free(card);
1149ab4d072SStas Sergeev 		return err;
1159ab4d072SStas Sergeev 	}
116bcc2c6b7SStas Sergeev 	if (!nopcm) {
1179ab4d072SStas Sergeev 		err = snd_pcsp_new_pcm(&pcsp_chip);
1189ab4d072SStas Sergeev 		if (err < 0) {
1199ab4d072SStas Sergeev 			snd_card_free(card);
1209ab4d072SStas Sergeev 			return err;
1219ab4d072SStas Sergeev 		}
122bcc2c6b7SStas Sergeev 	}
123bcc2c6b7SStas Sergeev 	err = snd_pcsp_new_mixer(&pcsp_chip, nopcm);
1249ab4d072SStas Sergeev 	if (err < 0) {
1259ab4d072SStas Sergeev 		snd_card_free(card);
1269ab4d072SStas Sergeev 		return err;
1279ab4d072SStas Sergeev 	}
1289ab4d072SStas Sergeev 
1299ab4d072SStas Sergeev 	snd_card_set_dev(pcsp_chip.card, dev);
1309ab4d072SStas Sergeev 
1319ab4d072SStas Sergeev 	strcpy(card->driver, "PC-Speaker");
1329ab4d072SStas Sergeev 	strcpy(card->shortname, "pcsp");
1339ab4d072SStas Sergeev 	sprintf(card->longname, "Internal PC-Speaker at port 0x%x",
1349ab4d072SStas Sergeev 		pcsp_chip.port);
1359ab4d072SStas Sergeev 
1369ab4d072SStas Sergeev 	err = snd_card_register(card);
1379ab4d072SStas Sergeev 	if (err < 0) {
1389ab4d072SStas Sergeev 		snd_card_free(card);
1399ab4d072SStas Sergeev 		return err;
1409ab4d072SStas Sergeev 	}
1419ab4d072SStas Sergeev 
1429ab4d072SStas Sergeev 	return 0;
1439ab4d072SStas Sergeev }
1449ab4d072SStas Sergeev 
1459ab4d072SStas Sergeev static int __devinit alsa_card_pcsp_init(struct device *dev)
1469ab4d072SStas Sergeev {
14752337310SStas Sergeev 	int err;
14852337310SStas Sergeev 
14952337310SStas Sergeev 	err = snd_card_pcsp_probe(0, dev);
15052337310SStas Sergeev 	if (err) {
15152337310SStas Sergeev 		printk(KERN_ERR "PC-Speaker initialization failed.\n");
15252337310SStas Sergeev 		return err;
15352337310SStas Sergeev 	}
1549ab4d072SStas Sergeev 
1559ab4d072SStas Sergeev #ifdef CONFIG_DEBUG_PAGEALLOC
1569ab4d072SStas Sergeev 	/* Well, CONFIG_DEBUG_PAGEALLOC makes the sound horrible. Lets alert */
157efd89d9dSStas Sergeev 	printk(KERN_WARNING "PCSP: CONFIG_DEBUG_PAGEALLOC is enabled, "
158efd89d9dSStas Sergeev 	       "which may make the sound noisy.\n");
1599ab4d072SStas Sergeev #endif
1609ab4d072SStas Sergeev 
1619ab4d072SStas Sergeev 	return 0;
1629ab4d072SStas Sergeev }
1639ab4d072SStas Sergeev 
1649ab4d072SStas Sergeev static void __devexit alsa_card_pcsp_exit(struct snd_pcsp *chip)
1659ab4d072SStas Sergeev {
1669ab4d072SStas Sergeev 	snd_card_free(chip->card);
1679ab4d072SStas Sergeev }
1689ab4d072SStas Sergeev 
1699ab4d072SStas Sergeev static int __devinit pcsp_probe(struct platform_device *dev)
1709ab4d072SStas Sergeev {
1719ab4d072SStas Sergeev 	int err;
17252337310SStas Sergeev 
1739ab4d072SStas Sergeev 	err = pcspkr_input_init(&pcsp_chip.input_dev, &dev->dev);
1749ab4d072SStas Sergeev 	if (err < 0)
1759ab4d072SStas Sergeev 		return err;
1769ab4d072SStas Sergeev 
1779ab4d072SStas Sergeev 	err = alsa_card_pcsp_init(&dev->dev);
1789ab4d072SStas Sergeev 	if (err < 0) {
1799ab4d072SStas Sergeev 		pcspkr_input_remove(pcsp_chip.input_dev);
1809ab4d072SStas Sergeev 		return err;
1819ab4d072SStas Sergeev 	}
1829ab4d072SStas Sergeev 
1839ab4d072SStas Sergeev 	platform_set_drvdata(dev, &pcsp_chip);
1849ab4d072SStas Sergeev 	return 0;
1859ab4d072SStas Sergeev }
1869ab4d072SStas Sergeev 
1879ab4d072SStas Sergeev static int __devexit pcsp_remove(struct platform_device *dev)
1889ab4d072SStas Sergeev {
1899ab4d072SStas Sergeev 	struct snd_pcsp *chip = platform_get_drvdata(dev);
1909ab4d072SStas Sergeev 	alsa_card_pcsp_exit(chip);
1919ab4d072SStas Sergeev 	pcspkr_input_remove(chip->input_dev);
1929ab4d072SStas Sergeev 	platform_set_drvdata(dev, NULL);
1939ab4d072SStas Sergeev 	return 0;
1949ab4d072SStas Sergeev }
1959ab4d072SStas Sergeev 
1969ab4d072SStas Sergeev static void pcsp_stop_beep(struct snd_pcsp *chip)
1979ab4d072SStas Sergeev {
19896c7d478STakashi Iwai 	pcsp_sync_stop(chip);
1999ab4d072SStas Sergeev 	pcspkr_stop_sound();
2009ab4d072SStas Sergeev }
2019ab4d072SStas Sergeev 
202*d34e4e00STakashi Iwai #ifdef CONFIG_PM_SLEEP
203284e7ca7STakashi Iwai static int pcsp_suspend(struct device *dev)
2049ab4d072SStas Sergeev {
205284e7ca7STakashi Iwai 	struct snd_pcsp *chip = dev_get_drvdata(dev);
2069ab4d072SStas Sergeev 	pcsp_stop_beep(chip);
2079ab4d072SStas Sergeev 	snd_pcm_suspend_all(chip->pcm);
2089ab4d072SStas Sergeev 	return 0;
2099ab4d072SStas Sergeev }
210284e7ca7STakashi Iwai 
211284e7ca7STakashi Iwai static SIMPLE_DEV_PM_OPS(pcsp_pm, pcsp_suspend, NULL);
212284e7ca7STakashi Iwai #define PCSP_PM_OPS	&pcsp_pm
213983e0972SJohann Felix Soden #else
214284e7ca7STakashi Iwai #define PCSP_PM_OPS	NULL
215*d34e4e00STakashi Iwai #endif	/* CONFIG_PM_SLEEP */
2169ab4d072SStas Sergeev 
2179ab4d072SStas Sergeev static void pcsp_shutdown(struct platform_device *dev)
2189ab4d072SStas Sergeev {
2199ab4d072SStas Sergeev 	struct snd_pcsp *chip = platform_get_drvdata(dev);
2209ab4d072SStas Sergeev 	pcsp_stop_beep(chip);
2219ab4d072SStas Sergeev }
2229ab4d072SStas Sergeev 
2239ab4d072SStas Sergeev static struct platform_driver pcsp_platform_driver = {
2249ab4d072SStas Sergeev 	.driver		= {
2259ab4d072SStas Sergeev 		.name	= "pcspkr",
2269ab4d072SStas Sergeev 		.owner	= THIS_MODULE,
227284e7ca7STakashi Iwai 		.pm	= PCSP_PM_OPS,
2289ab4d072SStas Sergeev 	},
2299ab4d072SStas Sergeev 	.probe		= pcsp_probe,
2309ab4d072SStas Sergeev 	.remove		= __devexit_p(pcsp_remove),
2319ab4d072SStas Sergeev 	.shutdown	= pcsp_shutdown,
2329ab4d072SStas Sergeev };
2339ab4d072SStas Sergeev 
2349ab4d072SStas Sergeev static int __init pcsp_init(void)
2359ab4d072SStas Sergeev {
23652337310SStas Sergeev 	if (!enable)
23752337310SStas Sergeev 		return -ENODEV;
2389ab4d072SStas Sergeev 	return platform_driver_register(&pcsp_platform_driver);
2399ab4d072SStas Sergeev }
2409ab4d072SStas Sergeev 
2419ab4d072SStas Sergeev static void __exit pcsp_exit(void)
2429ab4d072SStas Sergeev {
2439ab4d072SStas Sergeev 	platform_driver_unregister(&pcsp_platform_driver);
2449ab4d072SStas Sergeev }
2459ab4d072SStas Sergeev 
2469ab4d072SStas Sergeev module_init(pcsp_init);
2479ab4d072SStas Sergeev module_exit(pcsp_exit);
248