Merge tag 'linux-kselftest-4.8-rc1-fixes' of git://git.kernel.org/pub/scm/linux/kerne...
[linux-2.6-block.git] / sound / pci / hda / hda_beep.c
CommitLineData
1cd2224c
MR
1/*
2 * Digital Beep Input Interface for HD-audio codec
3 *
70a3887a 4 * Author: Matt Ranostay <mranostay@gmail.com>
1cd2224c
MR
5 * Copyright (c) 2008 Embedded Alley Solutions Inc
6 *
7 * This driver is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This driver is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 */
21
22#include <linux/input.h>
5a0e3ad6 23#include <linux/slab.h>
1cd2224c 24#include <linux/workqueue.h>
d81a6d71 25#include <linux/export.h>
1cd2224c
MR
26#include <sound/core.h>
27#include "hda_beep.h"
b7b51141 28#include "hda_local.h"
1cd2224c
MR
29
30enum {
31 DIGBEEP_HZ_STEP = 46875, /* 46.875 Hz */
32 DIGBEEP_HZ_MIN = 93750, /* 93.750 Hz */
33 DIGBEEP_HZ_MAX = 12000000, /* 12 KHz */
34};
35
5ccf835c
TI
36/* generate or stop tone */
37static void generate_tone(struct hda_beep *beep, int tone)
1cd2224c 38{
1cd2224c
MR
39 struct hda_codec *codec = beep->codec;
40
e914b25e
TI
41 if (tone && !beep->playing) {
42 snd_hda_power_up(codec);
5ccf835c
TI
43 if (beep->power_hook)
44 beep->power_hook(beep, true);
e914b25e
TI
45 beep->playing = 1;
46 }
411fe85c 47 snd_hda_codec_write(codec, beep->nid, 0,
e914b25e
TI
48 AC_VERB_SET_BEEP_CONTROL, tone);
49 if (!tone && beep->playing) {
50 beep->playing = 0;
5ccf835c
TI
51 if (beep->power_hook)
52 beep->power_hook(beep, false);
e914b25e
TI
53 snd_hda_power_down(codec);
54 }
1cd2224c
MR
55}
56
5ccf835c
TI
57static void snd_hda_generate_beep(struct work_struct *work)
58{
59 struct hda_beep *beep =
60 container_of(work, struct hda_beep, beep_work);
61
62 if (beep->enabled)
63 generate_tone(beep, beep->tone);
64}
65
fa797966
TI
66/* (non-standard) Linear beep tone calculation for IDT/STAC codecs
67 *
68 * The tone frequency of beep generator on IDT/STAC codecs is
69 * defined from the 8bit tone parameter, in Hz,
70 * freq = 48000 * (257 - tone) / 1024
369693dc 71 * that is from 12kHz to 93.75Hz in steps of 46.875 Hz
fa797966
TI
72 */
73static int beep_linear_tone(struct hda_beep *beep, int hz)
74{
369693dc
PV
75 if (hz <= 0)
76 return 0;
fa797966 77 hz *= 1000; /* fixed point */
369693dc
PV
78 hz = hz - DIGBEEP_HZ_MIN
79 + DIGBEEP_HZ_STEP / 2; /* round to nearest step */
fa797966
TI
80 if (hz < 0)
81 hz = 0; /* turn off PC beep*/
82 else if (hz >= (DIGBEEP_HZ_MAX - DIGBEEP_HZ_MIN))
369693dc 83 hz = 1; /* max frequency */
fa797966
TI
84 else {
85 hz /= DIGBEEP_HZ_STEP;
369693dc 86 hz = 255 - hz;
fa797966
TI
87 }
88 return hz;
89}
90
91/* HD-audio standard beep tone parameter calculation
92 *
93 * The tone frequency in Hz is calculated as
94 * freq = 48000 / (tone * 4)
95 * from 47Hz to 12kHz
96 */
97static int beep_standard_tone(struct hda_beep *beep, int hz)
98{
99 if (hz <= 0)
100 return 0; /* disabled */
101 hz = 12000 / hz;
102 if (hz > 0xff)
103 return 0xff;
104 if (hz <= 0)
105 return 1;
106 return hz;
107}
108
1cd2224c
MR
109static int snd_hda_beep_event(struct input_dev *dev, unsigned int type,
110 unsigned int code, int hz)
111{
112 struct hda_beep *beep = input_get_drvdata(dev);
113
114 switch (code) {
115 case SND_BELL:
116 if (hz)
117 hz = 1000;
57d8ff61 118 /* fallthru */
1cd2224c 119 case SND_TONE:
fa797966
TI
120 if (beep->linear_tone)
121 beep->tone = beep_linear_tone(beep, hz);
122 else
123 beep->tone = beep_standard_tone(beep, hz);
1cd2224c
MR
124 break;
125 default:
126 return -1;
127 }
1cd2224c
MR
128
129 /* schedule beep event */
130 schedule_work(&beep->beep_work);
131 return 0;
132}
133
e914b25e
TI
134static void turn_off_beep(struct hda_beep *beep)
135{
136 cancel_work_sync(&beep->beep_work);
137 if (beep->playing) {
138 /* turn off beep */
5ccf835c 139 generate_tone(beep, 0);
e914b25e
TI
140 }
141}
142
123c07ae
JK
143static void snd_hda_do_detach(struct hda_beep *beep)
144{
d604b399
TI
145 if (beep->registered)
146 input_unregister_device(beep->dev);
147 else
148 input_free_device(beep->dev);
123c07ae 149 beep->dev = NULL;
e914b25e 150 turn_off_beep(beep);
123c07ae
JK
151}
152
153static int snd_hda_do_attach(struct hda_beep *beep)
1cd2224c
MR
154{
155 struct input_dev *input_dev;
123c07ae 156 struct hda_codec *codec = beep->codec;
1cd2224c 157
1cd2224c 158 input_dev = input_allocate_device();
b7baa9a0 159 if (!input_dev)
6a12afb5 160 return -ENOMEM;
1cd2224c
MR
161
162 /* setup digital beep device */
163 input_dev->name = "HDA Digital PCBeep";
164 input_dev->phys = beep->phys;
165 input_dev->id.bustype = BUS_PCI;
6efdd851 166 input_dev->dev.parent = &codec->card->card_dev;
1cd2224c 167
7639a06c
TI
168 input_dev->id.vendor = codec->core.vendor_id >> 16;
169 input_dev->id.product = codec->core.vendor_id & 0xffff;
1cd2224c
MR
170 input_dev->id.version = 0x01;
171
172 input_dev->evbit[0] = BIT_MASK(EV_SND);
173 input_dev->sndbit[0] = BIT_MASK(SND_BELL) | BIT_MASK(SND_TONE);
174 input_dev->event = snd_hda_beep_event;
1cd2224c
MR
175 input_set_drvdata(input_dev, beep);
176
123c07ae
JK
177 beep->dev = input_dev;
178 return 0;
179}
180
95a962c3
TI
181/**
182 * snd_hda_enable_beep_device - Turn on/off beep sound
183 * @codec: the HDA codec
184 * @enable: flag to turn on/off
185 */
123c07ae
JK
186int snd_hda_enable_beep_device(struct hda_codec *codec, int enable)
187{
188 struct hda_beep *beep = codec->beep;
3fd877d3 189 if (!beep)
13dab080 190 return 0;
3fd877d3 191 enable = !!enable;
13dab080
JK
192 if (beep->enabled != enable) {
193 beep->enabled = enable;
e914b25e
TI
194 if (!enable)
195 turn_off_beep(beep);
123c07ae
JK
196 return 1;
197 }
198 return 0;
199}
2698ea98 200EXPORT_SYMBOL_GPL(snd_hda_enable_beep_device);
123c07ae 201
95a962c3
TI
202/**
203 * snd_hda_attach_beep_device - Attach a beep input device
204 * @codec: the HDA codec
205 * @nid: beep NID
206 *
207 * Attach a beep object to the given widget. If beep hint is turned off
208 * explicitly or beep_mode of the codec is turned off, this doesn't nothing.
209 *
210 * The attached beep device has to be registered via
211 * snd_hda_register_beep_device() and released via snd_hda_detach_beep_device()
212 * appropriately.
213 *
214 * Currently, only one beep device is allowed to each codec.
215 */
123c07ae
JK
216int snd_hda_attach_beep_device(struct hda_codec *codec, int nid)
217{
218 struct hda_beep *beep;
257dfb41 219 int err;
123c07ae
JK
220
221 if (!snd_hda_get_bool_hint(codec, "beep"))
9bb1fe39
TI
222 return 0; /* disabled explicitly by hints */
223 if (codec->beep_mode == HDA_BEEP_MODE_OFF)
224 return 0; /* disabled by module option */
1cd2224c 225
123c07ae
JK
226 beep = kzalloc(sizeof(*beep), GFP_KERNEL);
227 if (beep == NULL)
228 return -ENOMEM;
229 snprintf(beep->phys, sizeof(beep->phys),
6efdd851 230 "card%d/codec#%d/beep0", codec->card->number, codec->addr);
1cd2224c 231 /* enable linear scale */
8bc0a846 232 snd_hda_codec_write_cache(codec, nid, 0,
1cd2224c
MR
233 AC_VERB_SET_DIGI_CONVERT_2, 0x01);
234
235 beep->nid = nid;
1cd2224c
MR
236 beep->codec = codec;
237 codec->beep = beep;
238
239 INIT_WORK(&beep->beep_work, &snd_hda_generate_beep);
123c07ae
JK
240 mutex_init(&beep->mutex);
241
257dfb41
TI
242 err = snd_hda_do_attach(beep);
243 if (err < 0) {
244 kfree(beep);
245 codec->beep = NULL;
246 return err;
2dca0bba
JK
247 }
248
1cd2224c
MR
249 return 0;
250}
2698ea98 251EXPORT_SYMBOL_GPL(snd_hda_attach_beep_device);
1cd2224c 252
95a962c3
TI
253/**
254 * snd_hda_detach_beep_device - Detach the beep device
255 * @codec: the HDA codec
256 */
1cd2224c
MR
257void snd_hda_detach_beep_device(struct hda_codec *codec)
258{
259 struct hda_beep *beep = codec->beep;
260 if (beep) {
54f7190b 261 if (beep->dev)
123c07ae 262 snd_hda_do_detach(beep);
c44765b8 263 codec->beep = NULL;
123c07ae 264 kfree(beep);
1cd2224c
MR
265 }
266}
2698ea98 267EXPORT_SYMBOL_GPL(snd_hda_detach_beep_device);
0401e854 268
95a962c3
TI
269/**
270 * snd_hda_register_beep_device - Register the beep device
271 * @codec: the HDA codec
272 */
d604b399
TI
273int snd_hda_register_beep_device(struct hda_codec *codec)
274{
275 struct hda_beep *beep = codec->beep;
276 int err;
277
278 if (!beep || !beep->dev)
279 return 0;
280
281 err = input_register_device(beep->dev);
282 if (err < 0) {
283 codec_err(codec, "hda_beep: unable to register input device\n");
284 input_free_device(beep->dev);
285 codec->beep = NULL;
286 kfree(beep);
287 return err;
288 }
289 beep->registered = true;
290 return 0;
291}
292EXPORT_SYMBOL_GPL(snd_hda_register_beep_device);
293
265d931a
DH
294static bool ctl_has_mute(struct snd_kcontrol *kcontrol)
295{
296 struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
297 return query_amp_caps(codec, get_amp_nid(kcontrol),
298 get_amp_direction(kcontrol)) & AC_AMPCAP_MUTE;
299}
300
0401e854 301/* get/put callbacks for beep mute mixer switches */
95a962c3
TI
302
303/**
304 * snd_hda_mixer_amp_switch_get_beep - Get callback for beep controls
305 * @kcontrol: ctl element
306 * @ucontrol: pointer to get/store the data
307 */
0401e854
TI
308int snd_hda_mixer_amp_switch_get_beep(struct snd_kcontrol *kcontrol,
309 struct snd_ctl_elem_value *ucontrol)
310{
311 struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
312 struct hda_beep *beep = codec->beep;
265d931a 313 if (beep && (!beep->enabled || !ctl_has_mute(kcontrol))) {
0401e854 314 ucontrol->value.integer.value[0] =
265d931a 315 ucontrol->value.integer.value[1] = beep->enabled;
0401e854
TI
316 return 0;
317 }
318 return snd_hda_mixer_amp_switch_get(kcontrol, ucontrol);
319}
2698ea98 320EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_switch_get_beep);
0401e854 321
95a962c3
TI
322/**
323 * snd_hda_mixer_amp_switch_put_beep - Put callback for beep controls
324 * @kcontrol: ctl element
325 * @ucontrol: pointer to get/store the data
326 */
0401e854
TI
327int snd_hda_mixer_amp_switch_put_beep(struct snd_kcontrol *kcontrol,
328 struct snd_ctl_elem_value *ucontrol)
329{
330 struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
331 struct hda_beep *beep = codec->beep;
14bc9c6d
DH
332 if (beep) {
333 u8 chs = get_amp_channels(kcontrol);
334 int enable = 0;
335 long *valp = ucontrol->value.integer.value;
336 if (chs & 1) {
337 enable |= *valp;
338 valp++;
339 }
340 if (chs & 2)
341 enable |= *valp;
342 snd_hda_enable_beep_device(codec, enable);
343 }
265d931a
DH
344 if (!ctl_has_mute(kcontrol))
345 return 0;
0401e854
TI
346 return snd_hda_mixer_amp_switch_put(kcontrol, ucontrol);
347}
2698ea98 348EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_switch_put_beep);