1 // SPDX-License-Identifier: GPL-2.0+
3 * Digital Beep Input Interface for HD-audio codec
5 * Author: Matt Ranostay <matt.ranostay@konsulko.com>
6 * Copyright (c) 2008 Embedded Alley Solutions Inc
9 #include <linux/input.h>
10 #include <linux/slab.h>
11 #include <linux/workqueue.h>
12 #include <linux/export.h>
13 #include <sound/core.h>
15 #include "hda_local.h"
18 DIGBEEP_HZ_STEP = 46875, /* 46.875 Hz */
19 DIGBEEP_HZ_MIN = 93750, /* 93.750 Hz */
20 DIGBEEP_HZ_MAX = 12000000, /* 12 KHz */
23 /* generate or stop tone */
24 static void generate_tone(struct hda_beep *beep, int tone)
26 struct hda_codec *codec = beep->codec;
28 if (tone && !beep->playing) {
29 snd_hda_power_up(codec);
31 beep->power_hook(beep, true);
34 snd_hda_codec_write(codec, beep->nid, 0,
35 AC_VERB_SET_BEEP_CONTROL, tone);
36 if (!tone && beep->playing) {
39 beep->power_hook(beep, false);
40 snd_hda_power_down(codec);
44 static void snd_hda_generate_beep(struct work_struct *work)
46 struct hda_beep *beep =
47 container_of(work, struct hda_beep, beep_work);
50 generate_tone(beep, beep->tone);
53 /* (non-standard) Linear beep tone calculation for IDT/STAC codecs
55 * The tone frequency of beep generator on IDT/STAC codecs is
56 * defined from the 8bit tone parameter, in Hz,
57 * freq = 48000 * (257 - tone) / 1024
58 * that is from 12kHz to 93.75Hz in steps of 46.875 Hz
60 static int beep_linear_tone(struct hda_beep *beep, int hz)
64 hz *= 1000; /* fixed point */
65 hz = hz - DIGBEEP_HZ_MIN
66 + DIGBEEP_HZ_STEP / 2; /* round to nearest step */
68 hz = 0; /* turn off PC beep*/
69 else if (hz >= (DIGBEEP_HZ_MAX - DIGBEEP_HZ_MIN))
70 hz = 1; /* max frequency */
72 hz /= DIGBEEP_HZ_STEP;
78 /* HD-audio standard beep tone parameter calculation
80 * The tone frequency in Hz is calculated as
81 * freq = 48000 / (tone * 4)
84 static int beep_standard_tone(struct hda_beep *beep, int hz)
87 return 0; /* disabled */
96 static int snd_hda_beep_event(struct input_dev *dev, unsigned int type,
97 unsigned int code, int hz)
99 struct hda_beep *beep = input_get_drvdata(dev);
107 if (beep->linear_tone)
108 beep->tone = beep_linear_tone(beep, hz);
110 beep->tone = beep_standard_tone(beep, hz);
116 /* schedule beep event */
117 schedule_work(&beep->beep_work);
121 static void turn_off_beep(struct hda_beep *beep)
123 cancel_work_sync(&beep->beep_work);
126 generate_tone(beep, 0);
130 static void snd_hda_do_detach(struct hda_beep *beep)
132 if (beep->registered)
133 input_unregister_device(beep->dev);
135 input_free_device(beep->dev);
140 static int snd_hda_do_attach(struct hda_beep *beep)
142 struct input_dev *input_dev;
143 struct hda_codec *codec = beep->codec;
145 input_dev = input_allocate_device();
149 /* setup digital beep device */
150 input_dev->name = "HDA Digital PCBeep";
151 input_dev->phys = beep->phys;
152 input_dev->id.bustype = BUS_PCI;
153 input_dev->dev.parent = &codec->card->card_dev;
155 input_dev->id.vendor = codec->core.vendor_id >> 16;
156 input_dev->id.product = codec->core.vendor_id & 0xffff;
157 input_dev->id.version = 0x01;
159 input_dev->evbit[0] = BIT_MASK(EV_SND);
160 input_dev->sndbit[0] = BIT_MASK(SND_BELL) | BIT_MASK(SND_TONE);
161 input_dev->event = snd_hda_beep_event;
162 input_set_drvdata(input_dev, beep);
164 beep->dev = input_dev;
169 * snd_hda_enable_beep_device - Turn on/off beep sound
170 * @codec: the HDA codec
171 * @enable: flag to turn on/off
173 int snd_hda_enable_beep_device(struct hda_codec *codec, int enable)
175 struct hda_beep *beep = codec->beep;
179 if (beep->enabled != enable) {
180 beep->enabled = enable;
187 EXPORT_SYMBOL_GPL(snd_hda_enable_beep_device);
190 * snd_hda_attach_beep_device - Attach a beep input device
191 * @codec: the HDA codec
194 * Attach a beep object to the given widget. If beep hint is turned off
195 * explicitly or beep_mode of the codec is turned off, this doesn't nothing.
197 * The attached beep device has to be registered via
198 * snd_hda_register_beep_device() and released via snd_hda_detach_beep_device()
201 * Currently, only one beep device is allowed to each codec.
203 int snd_hda_attach_beep_device(struct hda_codec *codec, int nid)
205 struct hda_beep *beep;
208 if (!snd_hda_get_bool_hint(codec, "beep"))
209 return 0; /* disabled explicitly by hints */
210 if (codec->beep_mode == HDA_BEEP_MODE_OFF)
211 return 0; /* disabled by module option */
213 beep = kzalloc(sizeof(*beep), GFP_KERNEL);
216 snprintf(beep->phys, sizeof(beep->phys),
217 "card%d/codec#%d/beep0", codec->card->number, codec->addr);
218 /* enable linear scale */
219 snd_hda_codec_write_cache(codec, nid, 0,
220 AC_VERB_SET_DIGI_CONVERT_2, 0x01);
226 INIT_WORK(&beep->beep_work, &snd_hda_generate_beep);
227 mutex_init(&beep->mutex);
229 err = snd_hda_do_attach(beep);
238 EXPORT_SYMBOL_GPL(snd_hda_attach_beep_device);
241 * snd_hda_detach_beep_device - Detach the beep device
242 * @codec: the HDA codec
244 void snd_hda_detach_beep_device(struct hda_codec *codec)
246 struct hda_beep *beep = codec->beep;
249 snd_hda_do_detach(beep);
254 EXPORT_SYMBOL_GPL(snd_hda_detach_beep_device);
257 * snd_hda_register_beep_device - Register the beep device
258 * @codec: the HDA codec
260 int snd_hda_register_beep_device(struct hda_codec *codec)
262 struct hda_beep *beep = codec->beep;
265 if (!beep || !beep->dev)
268 err = input_register_device(beep->dev);
270 codec_err(codec, "hda_beep: unable to register input device\n");
271 input_free_device(beep->dev);
276 beep->registered = true;
279 EXPORT_SYMBOL_GPL(snd_hda_register_beep_device);
281 static bool ctl_has_mute(struct snd_kcontrol *kcontrol)
283 struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
284 return query_amp_caps(codec, get_amp_nid(kcontrol),
285 get_amp_direction(kcontrol)) & AC_AMPCAP_MUTE;
288 /* get/put callbacks for beep mute mixer switches */
291 * snd_hda_mixer_amp_switch_get_beep - Get callback for beep controls
292 * @kcontrol: ctl element
293 * @ucontrol: pointer to get/store the data
295 int snd_hda_mixer_amp_switch_get_beep(struct snd_kcontrol *kcontrol,
296 struct snd_ctl_elem_value *ucontrol)
298 struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
299 struct hda_beep *beep = codec->beep;
300 int chs = get_amp_channels(kcontrol);
302 if (beep && (!beep->enabled || !ctl_has_mute(kcontrol))) {
304 ucontrol->value.integer.value[0] = beep->enabled;
306 ucontrol->value.integer.value[1] = beep->enabled;
309 return snd_hda_mixer_amp_switch_get(kcontrol, ucontrol);
311 EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_switch_get_beep);
314 * snd_hda_mixer_amp_switch_put_beep - Put callback for beep controls
315 * @kcontrol: ctl element
316 * @ucontrol: pointer to get/store the data
318 int snd_hda_mixer_amp_switch_put_beep(struct snd_kcontrol *kcontrol,
319 struct snd_ctl_elem_value *ucontrol)
321 struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
322 struct hda_beep *beep = codec->beep;
324 u8 chs = get_amp_channels(kcontrol);
326 long *valp = ucontrol->value.integer.value;
333 snd_hda_enable_beep_device(codec, enable);
335 if (!ctl_has_mute(kcontrol))
337 return snd_hda_mixer_amp_switch_put(kcontrol, ucontrol);
339 EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_switch_put_beep);