xref: /openbmc/linux/drivers/input/misc/sparcspkr.c (revision aaf9128a)
1 /*
2  *  Driver for PC-speaker like devices found on various Sparc systems.
3  *
4  *  Copyright (c) 2002 Vojtech Pavlik
5  *  Copyright (c) 2002, 2006, 2008 David S. Miller (davem@davemloft.net)
6  */
7 #include <linux/kernel.h>
8 #include <linux/module.h>
9 #include <linux/init.h>
10 #include <linux/input.h>
11 #include <linux/of_device.h>
12 #include <linux/slab.h>
13 
14 #include <asm/io.h>
15 
16 MODULE_AUTHOR("David S. Miller <davem@davemloft.net>");
17 MODULE_DESCRIPTION("Sparc Speaker beeper driver");
18 MODULE_LICENSE("GPL");
19 
20 struct grover_beep_info {
21 	void __iomem	*freq_regs;
22 	void __iomem	*enable_reg;
23 };
24 
25 struct bbc_beep_info {
26 	u32		clock_freq;
27 	void __iomem	*regs;
28 };
29 
30 struct sparcspkr_state {
31 	const char		*name;
32 	int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value);
33 	spinlock_t		lock;
34 	struct input_dev	*input_dev;
35 	union {
36 		struct grover_beep_info grover;
37 		struct bbc_beep_info bbc;
38 	} u;
39 };
40 
41 static u32 bbc_count_to_reg(struct bbc_beep_info *info, unsigned int count)
42 {
43 	u32 val, clock_freq = info->clock_freq;
44 	int i;
45 
46 	if (!count)
47 		return 0;
48 
49 	if (count <= clock_freq >> 20)
50 		return 1 << 18;
51 
52 	if (count >= clock_freq >> 12)
53 		return 1 << 10;
54 
55 	val = 1 << 18;
56 	for (i = 19; i >= 11; i--) {
57 		val >>= 1;
58 		if (count <= clock_freq >> i)
59 			break;
60 	}
61 
62 	return val;
63 }
64 
65 static int bbc_spkr_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
66 {
67 	struct sparcspkr_state *state = dev_get_drvdata(dev->dev.parent);
68 	struct bbc_beep_info *info = &state->u.bbc;
69 	unsigned int count = 0;
70 	unsigned long flags;
71 
72 	if (type != EV_SND)
73 		return -1;
74 
75 	switch (code) {
76 		case SND_BELL: if (value) value = 1000;
77 		case SND_TONE: break;
78 		default: return -1;
79 	}
80 
81 	if (value > 20 && value < 32767)
82 		count = 1193182 / value;
83 
84 	count = bbc_count_to_reg(info, count);
85 
86 	spin_lock_irqsave(&state->lock, flags);
87 
88 	if (count) {
89 		sbus_writeb(0x01,                 info->regs + 0);
90 		sbus_writeb(0x00,                 info->regs + 2);
91 		sbus_writeb((count >> 16) & 0xff, info->regs + 3);
92 		sbus_writeb((count >>  8) & 0xff, info->regs + 4);
93 		sbus_writeb(0x00,                 info->regs + 5);
94 	} else {
95 		sbus_writeb(0x00,                 info->regs + 0);
96 	}
97 
98 	spin_unlock_irqrestore(&state->lock, flags);
99 
100 	return 0;
101 }
102 
103 static int grover_spkr_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
104 {
105 	struct sparcspkr_state *state = dev_get_drvdata(dev->dev.parent);
106 	struct grover_beep_info *info = &state->u.grover;
107 	unsigned int count = 0;
108 	unsigned long flags;
109 
110 	if (type != EV_SND)
111 		return -1;
112 
113 	switch (code) {
114 		case SND_BELL: if (value) value = 1000;
115 		case SND_TONE: break;
116 		default: return -1;
117 	}
118 
119 	if (value > 20 && value < 32767)
120 		count = 1193182 / value;
121 
122 	spin_lock_irqsave(&state->lock, flags);
123 
124 	if (count) {
125 		/* enable counter 2 */
126 		sbus_writeb(sbus_readb(info->enable_reg) | 3, info->enable_reg);
127 		/* set command for counter 2, 2 byte write */
128 		sbus_writeb(0xB6, info->freq_regs + 1);
129 		/* select desired HZ */
130 		sbus_writeb(count & 0xff, info->freq_regs + 0);
131 		sbus_writeb((count >> 8) & 0xff, info->freq_regs + 0);
132 	} else {
133 		/* disable counter 2 */
134 		sbus_writeb(sbus_readb(info->enable_reg) & 0xFC, info->enable_reg);
135 	}
136 
137 	spin_unlock_irqrestore(&state->lock, flags);
138 
139 	return 0;
140 }
141 
142 static int sparcspkr_probe(struct device *dev)
143 {
144 	struct sparcspkr_state *state = dev_get_drvdata(dev);
145 	struct input_dev *input_dev;
146 	int error;
147 
148 	input_dev = input_allocate_device();
149 	if (!input_dev)
150 		return -ENOMEM;
151 
152 	input_dev->name = state->name;
153 	input_dev->phys = "sparc/input0";
154 	input_dev->id.bustype = BUS_ISA;
155 	input_dev->id.vendor = 0x001f;
156 	input_dev->id.product = 0x0001;
157 	input_dev->id.version = 0x0100;
158 	input_dev->dev.parent = dev;
159 
160 	input_dev->evbit[0] = BIT_MASK(EV_SND);
161 	input_dev->sndbit[0] = BIT_MASK(SND_BELL) | BIT_MASK(SND_TONE);
162 
163 	input_dev->event = state->event;
164 
165 	error = input_register_device(input_dev);
166 	if (error) {
167 		input_free_device(input_dev);
168 		return error;
169 	}
170 
171 	state->input_dev = input_dev;
172 
173 	return 0;
174 }
175 
176 static void sparcspkr_shutdown(struct platform_device *dev)
177 {
178 	struct sparcspkr_state *state = platform_get_drvdata(dev);
179 	struct input_dev *input_dev = state->input_dev;
180 
181 	/* turn off the speaker */
182 	state->event(input_dev, EV_SND, SND_BELL, 0);
183 }
184 
185 static int bbc_beep_probe(struct platform_device *op)
186 {
187 	struct sparcspkr_state *state;
188 	struct bbc_beep_info *info;
189 	struct device_node *dp;
190 	int err = -ENOMEM;
191 
192 	state = kzalloc(sizeof(*state), GFP_KERNEL);
193 	if (!state)
194 		goto out_err;
195 
196 	state->name = "Sparc BBC Speaker";
197 	state->event = bbc_spkr_event;
198 	spin_lock_init(&state->lock);
199 
200 	dp = of_find_node_by_path("/");
201 	err = -ENODEV;
202 	if (!dp)
203 		goto out_free;
204 
205 	info = &state->u.bbc;
206 	info->clock_freq = of_getintprop_default(dp, "clock-frequency", 0);
207 	if (!info->clock_freq)
208 		goto out_free;
209 
210 	info->regs = of_ioremap(&op->resource[0], 0, 6, "bbc beep");
211 	if (!info->regs)
212 		goto out_free;
213 
214 	platform_set_drvdata(op, state);
215 
216 	err = sparcspkr_probe(&op->dev);
217 	if (err)
218 		goto out_clear_drvdata;
219 
220 	return 0;
221 
222 out_clear_drvdata:
223 	of_iounmap(&op->resource[0], info->regs, 6);
224 
225 out_free:
226 	kfree(state);
227 out_err:
228 	return err;
229 }
230 
231 static int bbc_remove(struct platform_device *op)
232 {
233 	struct sparcspkr_state *state = platform_get_drvdata(op);
234 	struct input_dev *input_dev = state->input_dev;
235 	struct bbc_beep_info *info = &state->u.bbc;
236 
237 	/* turn off the speaker */
238 	state->event(input_dev, EV_SND, SND_BELL, 0);
239 
240 	input_unregister_device(input_dev);
241 
242 	of_iounmap(&op->resource[0], info->regs, 6);
243 
244 	kfree(state);
245 
246 	return 0;
247 }
248 
249 static const struct of_device_id bbc_beep_match[] = {
250 	{
251 		.name = "beep",
252 		.compatible = "SUNW,bbc-beep",
253 	},
254 	{},
255 };
256 MODULE_DEVICE_TABLE(of, bbc_beep_match);
257 
258 static struct platform_driver bbc_beep_driver = {
259 	.driver = {
260 		.name = "bbcbeep",
261 		.of_match_table = bbc_beep_match,
262 	},
263 	.probe		= bbc_beep_probe,
264 	.remove		= bbc_remove,
265 	.shutdown	= sparcspkr_shutdown,
266 };
267 
268 static int grover_beep_probe(struct platform_device *op)
269 {
270 	struct sparcspkr_state *state;
271 	struct grover_beep_info *info;
272 	int err = -ENOMEM;
273 
274 	state = kzalloc(sizeof(*state), GFP_KERNEL);
275 	if (!state)
276 		goto out_err;
277 
278 	state->name = "Sparc Grover Speaker";
279 	state->event = grover_spkr_event;
280 	spin_lock_init(&state->lock);
281 
282 	info = &state->u.grover;
283 	info->freq_regs = of_ioremap(&op->resource[2], 0, 2, "grover beep freq");
284 	if (!info->freq_regs)
285 		goto out_free;
286 
287 	info->enable_reg = of_ioremap(&op->resource[3], 0, 1, "grover beep enable");
288 	if (!info->enable_reg)
289 		goto out_unmap_freq_regs;
290 
291 	platform_set_drvdata(op, state);
292 
293 	err = sparcspkr_probe(&op->dev);
294 	if (err)
295 		goto out_clear_drvdata;
296 
297 	return 0;
298 
299 out_clear_drvdata:
300 	of_iounmap(&op->resource[3], info->enable_reg, 1);
301 
302 out_unmap_freq_regs:
303 	of_iounmap(&op->resource[2], info->freq_regs, 2);
304 out_free:
305 	kfree(state);
306 out_err:
307 	return err;
308 }
309 
310 static int grover_remove(struct platform_device *op)
311 {
312 	struct sparcspkr_state *state = platform_get_drvdata(op);
313 	struct grover_beep_info *info = &state->u.grover;
314 	struct input_dev *input_dev = state->input_dev;
315 
316 	/* turn off the speaker */
317 	state->event(input_dev, EV_SND, SND_BELL, 0);
318 
319 	input_unregister_device(input_dev);
320 
321 	of_iounmap(&op->resource[3], info->enable_reg, 1);
322 	of_iounmap(&op->resource[2], info->freq_regs, 2);
323 
324 	kfree(state);
325 
326 	return 0;
327 }
328 
329 static const struct of_device_id grover_beep_match[] = {
330 	{
331 		.name = "beep",
332 		.compatible = "SUNW,smbus-beep",
333 	},
334 	{},
335 };
336 MODULE_DEVICE_TABLE(of, grover_beep_match);
337 
338 static struct platform_driver grover_beep_driver = {
339 	.driver = {
340 		.name = "groverbeep",
341 		.of_match_table = grover_beep_match,
342 	},
343 	.probe		= grover_beep_probe,
344 	.remove		= grover_remove,
345 	.shutdown	= sparcspkr_shutdown,
346 };
347 
348 static struct platform_driver * const drivers[] = {
349 	&bbc_beep_driver,
350 	&grover_beep_driver,
351 };
352 
353 static int __init sparcspkr_init(void)
354 {
355 	return platform_register_drivers(drivers, ARRAY_SIZE(drivers));
356 }
357 
358 static void __exit sparcspkr_exit(void)
359 {
360 	platform_unregister_drivers(drivers, ARRAY_SIZE(drivers));
361 }
362 
363 module_init(sparcspkr_init);
364 module_exit(sparcspkr_exit);
365