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