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);
131 * snd_hda_enable_beep_device - Turn on/off beep sound
132 * @codec: the HDA codec
133 * @enable: flag to turn on/off
135 int snd_hda_enable_beep_device(struct hda_codec *codec, int enable)
137 struct hda_beep *beep = codec->beep;
141 if (beep->enabled != enable) {
142 beep->enabled = enable;
149 EXPORT_SYMBOL_GPL(snd_hda_enable_beep_device);
151 static int beep_dev_register(struct snd_device *device)
153 struct hda_beep *beep = device->device_data;
156 err = input_register_device(beep->dev);
158 beep->registered = true;
162 static int beep_dev_disconnect(struct snd_device *device)
164 struct hda_beep *beep = device->device_data;
166 if (beep->registered)
167 input_unregister_device(beep->dev);
169 input_free_device(beep->dev);
174 static int beep_dev_free(struct snd_device *device)
176 struct hda_beep *beep = device->device_data;
178 beep->codec->beep = NULL;
184 * snd_hda_attach_beep_device - Attach a beep input device
185 * @codec: the HDA codec
188 * Attach a beep object to the given widget. If beep hint is turned off
189 * explicitly or beep_mode of the codec is turned off, this doesn't nothing.
191 * Currently, only one beep device is allowed to each codec.
193 int snd_hda_attach_beep_device(struct hda_codec *codec, int nid)
195 static const struct snd_device_ops ops = {
196 .dev_register = beep_dev_register,
197 .dev_disconnect = beep_dev_disconnect,
198 .dev_free = beep_dev_free,
200 struct input_dev *input_dev;
201 struct hda_beep *beep;
204 if (!snd_hda_get_bool_hint(codec, "beep"))
205 return 0; /* disabled explicitly by hints */
206 if (codec->beep_mode == HDA_BEEP_MODE_OFF)
207 return 0; /* disabled by module option */
209 beep = kzalloc(sizeof(*beep), GFP_KERNEL);
212 snprintf(beep->phys, sizeof(beep->phys),
213 "card%d/codec#%d/beep0", codec->card->number, codec->addr);
214 /* enable linear scale */
215 snd_hda_codec_write_cache(codec, nid, 0,
216 AC_VERB_SET_DIGI_CONVERT_2, 0x01);
222 INIT_WORK(&beep->beep_work, &snd_hda_generate_beep);
223 mutex_init(&beep->mutex);
225 input_dev = input_allocate_device();
231 /* setup digital beep device */
232 input_dev->name = "HDA Digital PCBeep";
233 input_dev->phys = beep->phys;
234 input_dev->id.bustype = BUS_PCI;
235 input_dev->dev.parent = &codec->card->card_dev;
237 input_dev->id.vendor = codec->core.vendor_id >> 16;
238 input_dev->id.product = codec->core.vendor_id & 0xffff;
239 input_dev->id.version = 0x01;
241 input_dev->evbit[0] = BIT_MASK(EV_SND);
242 input_dev->sndbit[0] = BIT_MASK(SND_BELL) | BIT_MASK(SND_TONE);
243 input_dev->event = snd_hda_beep_event;
244 input_set_drvdata(input_dev, beep);
246 beep->dev = input_dev;
248 err = snd_device_new(codec->card, SNDRV_DEV_JACK, beep, &ops);
255 input_free_device(beep->dev);
261 EXPORT_SYMBOL_GPL(snd_hda_attach_beep_device);
264 * snd_hda_detach_beep_device - Detach the beep device
265 * @codec: the HDA codec
267 void snd_hda_detach_beep_device(struct hda_codec *codec)
269 if (!codec->bus->shutdown && codec->beep)
270 snd_device_free(codec->card, codec->beep);
272 EXPORT_SYMBOL_GPL(snd_hda_detach_beep_device);
274 static bool ctl_has_mute(struct snd_kcontrol *kcontrol)
276 struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
277 return query_amp_caps(codec, get_amp_nid(kcontrol),
278 get_amp_direction(kcontrol)) & AC_AMPCAP_MUTE;
281 /* get/put callbacks for beep mute mixer switches */
284 * snd_hda_mixer_amp_switch_get_beep - Get callback for beep controls
285 * @kcontrol: ctl element
286 * @ucontrol: pointer to get/store the data
288 int snd_hda_mixer_amp_switch_get_beep(struct snd_kcontrol *kcontrol,
289 struct snd_ctl_elem_value *ucontrol)
291 struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
292 struct hda_beep *beep = codec->beep;
293 int chs = get_amp_channels(kcontrol);
295 if (beep && (!beep->enabled || !ctl_has_mute(kcontrol))) {
297 ucontrol->value.integer.value[0] = beep->enabled;
299 ucontrol->value.integer.value[1] = beep->enabled;
302 return snd_hda_mixer_amp_switch_get(kcontrol, ucontrol);
304 EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_switch_get_beep);
307 * snd_hda_mixer_amp_switch_put_beep - Put callback for beep controls
308 * @kcontrol: ctl element
309 * @ucontrol: pointer to get/store the data
311 int snd_hda_mixer_amp_switch_put_beep(struct snd_kcontrol *kcontrol,
312 struct snd_ctl_elem_value *ucontrol)
314 struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
315 struct hda_beep *beep = codec->beep;
317 u8 chs = get_amp_channels(kcontrol);
319 long *valp = ucontrol->value.integer.value;
326 snd_hda_enable_beep_device(codec, enable);
328 if (!ctl_has_mute(kcontrol))
330 return snd_hda_mixer_amp_switch_put(kcontrol, ucontrol);
332 EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_switch_put_beep);