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