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