xref: /openbmc/linux/sound/drivers/pcsp/pcsp.c (revision 8fdff1dc)
1 /*
2  * PC-Speaker driver for Linux
3  *
4  * Copyright (C) 1997-2001  David Woodhouse
5  * Copyright (C) 2001-2008  Stas Sergeev
6  */
7 
8 #include <linux/init.h>
9 #include <linux/module.h>
10 #include <linux/platform_device.h>
11 #include <sound/core.h>
12 #include <sound/initval.h>
13 #include <sound/pcm.h>
14 #include <linux/input.h>
15 #include <linux/delay.h>
16 #include <asm/bitops.h>
17 #include "pcsp_input.h"
18 #include "pcsp.h"
19 
20 MODULE_AUTHOR("Stas Sergeev <stsp@users.sourceforge.net>");
21 MODULE_DESCRIPTION("PC-Speaker driver");
22 MODULE_LICENSE("GPL");
23 MODULE_SUPPORTED_DEVICE("{{PC-Speaker, pcsp}}");
24 MODULE_ALIAS("platform:pcspkr");
25 
26 static int index = SNDRV_DEFAULT_IDX1;	/* Index 0-MAX */
27 static char *id = SNDRV_DEFAULT_STR1;	/* ID for this card */
28 static bool enable = SNDRV_DEFAULT_ENABLE1;	/* Enable this card */
29 static bool nopcm;	/* Disable PCM capability of the driver */
30 
31 module_param(index, int, 0444);
32 MODULE_PARM_DESC(index, "Index value for pcsp soundcard.");
33 module_param(id, charp, 0444);
34 MODULE_PARM_DESC(id, "ID string for pcsp soundcard.");
35 module_param(enable, bool, 0444);
36 MODULE_PARM_DESC(enable, "Enable PC-Speaker sound.");
37 module_param(nopcm, bool, 0444);
38 MODULE_PARM_DESC(nopcm, "Disable PC-Speaker PCM sound. Only beeps remain.");
39 
40 struct snd_pcsp pcsp_chip;
41 
42 static int snd_pcsp_create(struct snd_card *card)
43 {
44 	static struct snd_device_ops ops = { };
45 	struct timespec tp;
46 	int err;
47 	int div, min_div, order;
48 
49 	if (!nopcm) {
50 		hrtimer_get_res(CLOCK_MONOTONIC, &tp);
51 		if (tp.tv_sec || tp.tv_nsec > PCSP_MAX_PERIOD_NS) {
52 			printk(KERN_ERR "PCSP: Timer resolution is not sufficient "
53 				"(%linS)\n", tp.tv_nsec);
54 			printk(KERN_ERR "PCSP: Make sure you have HPET and ACPI "
55 				"enabled.\n");
56 			printk(KERN_ERR "PCSP: Turned into nopcm mode.\n");
57 			nopcm = 1;
58 		}
59 	}
60 
61 	if (loops_per_jiffy >= PCSP_MIN_LPJ && tp.tv_nsec <= PCSP_MIN_PERIOD_NS)
62 		min_div = MIN_DIV;
63 	else
64 		min_div = MAX_DIV;
65 #if PCSP_DEBUG
66 	printk(KERN_DEBUG "PCSP: lpj=%li, min_div=%i, res=%li\n",
67 	       loops_per_jiffy, min_div, tp.tv_nsec);
68 #endif
69 
70 	div = MAX_DIV / min_div;
71 	order = fls(div) - 1;
72 
73 	pcsp_chip.max_treble = min(order, PCSP_MAX_TREBLE);
74 	pcsp_chip.treble = min(pcsp_chip.max_treble, PCSP_DEFAULT_TREBLE);
75 	pcsp_chip.playback_ptr = 0;
76 	pcsp_chip.period_ptr = 0;
77 	atomic_set(&pcsp_chip.timer_active, 0);
78 	pcsp_chip.enable = 1;
79 	pcsp_chip.pcspkr = 1;
80 
81 	spin_lock_init(&pcsp_chip.substream_lock);
82 
83 	pcsp_chip.card = card;
84 	pcsp_chip.port = 0x61;
85 	pcsp_chip.irq = -1;
86 	pcsp_chip.dma = -1;
87 
88 	/* Register device */
89 	err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, &pcsp_chip, &ops);
90 	if (err < 0)
91 		return err;
92 
93 	return 0;
94 }
95 
96 static int snd_card_pcsp_probe(int devnum, struct device *dev)
97 {
98 	struct snd_card *card;
99 	int err;
100 
101 	if (devnum != 0)
102 		return -EINVAL;
103 
104 	hrtimer_init(&pcsp_chip.timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
105 	pcsp_chip.timer.function = pcsp_do_timer;
106 
107 	err = snd_card_create(index, id, THIS_MODULE, 0, &card);
108 	if (err < 0)
109 		return err;
110 
111 	err = snd_pcsp_create(card);
112 	if (err < 0) {
113 		snd_card_free(card);
114 		return err;
115 	}
116 	if (!nopcm) {
117 		err = snd_pcsp_new_pcm(&pcsp_chip);
118 		if (err < 0) {
119 			snd_card_free(card);
120 			return err;
121 		}
122 	}
123 	err = snd_pcsp_new_mixer(&pcsp_chip, nopcm);
124 	if (err < 0) {
125 		snd_card_free(card);
126 		return err;
127 	}
128 
129 	snd_card_set_dev(pcsp_chip.card, dev);
130 
131 	strcpy(card->driver, "PC-Speaker");
132 	strcpy(card->shortname, "pcsp");
133 	sprintf(card->longname, "Internal PC-Speaker at port 0x%x",
134 		pcsp_chip.port);
135 
136 	err = snd_card_register(card);
137 	if (err < 0) {
138 		snd_card_free(card);
139 		return err;
140 	}
141 
142 	return 0;
143 }
144 
145 static int alsa_card_pcsp_init(struct device *dev)
146 {
147 	int err;
148 
149 	err = snd_card_pcsp_probe(0, dev);
150 	if (err) {
151 		printk(KERN_ERR "PC-Speaker initialization failed.\n");
152 		return err;
153 	}
154 
155 #ifdef CONFIG_DEBUG_PAGEALLOC
156 	/* Well, CONFIG_DEBUG_PAGEALLOC makes the sound horrible. Lets alert */
157 	printk(KERN_WARNING "PCSP: CONFIG_DEBUG_PAGEALLOC is enabled, "
158 	       "which may make the sound noisy.\n");
159 #endif
160 
161 	return 0;
162 }
163 
164 static void alsa_card_pcsp_exit(struct snd_pcsp *chip)
165 {
166 	snd_card_free(chip->card);
167 }
168 
169 static int pcsp_probe(struct platform_device *dev)
170 {
171 	int err;
172 
173 	err = pcspkr_input_init(&pcsp_chip.input_dev, &dev->dev);
174 	if (err < 0)
175 		return err;
176 
177 	err = alsa_card_pcsp_init(&dev->dev);
178 	if (err < 0) {
179 		pcspkr_input_remove(pcsp_chip.input_dev);
180 		return err;
181 	}
182 
183 	platform_set_drvdata(dev, &pcsp_chip);
184 	return 0;
185 }
186 
187 static int pcsp_remove(struct platform_device *dev)
188 {
189 	struct snd_pcsp *chip = platform_get_drvdata(dev);
190 	alsa_card_pcsp_exit(chip);
191 	pcspkr_input_remove(chip->input_dev);
192 	platform_set_drvdata(dev, NULL);
193 	return 0;
194 }
195 
196 static void pcsp_stop_beep(struct snd_pcsp *chip)
197 {
198 	pcsp_sync_stop(chip);
199 	pcspkr_stop_sound();
200 }
201 
202 #ifdef CONFIG_PM_SLEEP
203 static int pcsp_suspend(struct device *dev)
204 {
205 	struct snd_pcsp *chip = dev_get_drvdata(dev);
206 	pcsp_stop_beep(chip);
207 	snd_pcm_suspend_all(chip->pcm);
208 	return 0;
209 }
210 
211 static SIMPLE_DEV_PM_OPS(pcsp_pm, pcsp_suspend, NULL);
212 #define PCSP_PM_OPS	&pcsp_pm
213 #else
214 #define PCSP_PM_OPS	NULL
215 #endif	/* CONFIG_PM_SLEEP */
216 
217 static void pcsp_shutdown(struct platform_device *dev)
218 {
219 	struct snd_pcsp *chip = platform_get_drvdata(dev);
220 	pcsp_stop_beep(chip);
221 }
222 
223 static struct platform_driver pcsp_platform_driver = {
224 	.driver		= {
225 		.name	= "pcspkr",
226 		.owner	= THIS_MODULE,
227 		.pm	= PCSP_PM_OPS,
228 	},
229 	.probe		= pcsp_probe,
230 	.remove		= pcsp_remove,
231 	.shutdown	= pcsp_shutdown,
232 };
233 
234 static int __init pcsp_init(void)
235 {
236 	if (!enable)
237 		return -ENODEV;
238 	return platform_driver_register(&pcsp_platform_driver);
239 }
240 
241 static void __exit pcsp_exit(void)
242 {
243 	platform_driver_unregister(&pcsp_platform_driver);
244 }
245 
246 module_init(pcsp_init);
247 module_exit(pcsp_exit);
248