2 * Digital Beep Input Interface for HD-audio codec
4 * Author: Matthew Ranostay <mranostay@embeddedalley.com>
5 * Copyright (c) 2008 Embedded Alley Solutions Inc
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.
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.
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
22 #include <linux/input.h>
23 #include <linux/slab.h>
24 #include <linux/workqueue.h>
25 #include <linux/export.h>
26 #include <sound/core.h>
28 #include "hda_local.h"
31 DIGBEEP_HZ_STEP
= 46875, /* 46.875 Hz */
32 DIGBEEP_HZ_MIN
= 93750, /* 93.750 Hz */
33 DIGBEEP_HZ_MAX
= 12000000, /* 12 KHz */
36 static void snd_hda_generate_beep(struct work_struct
*work
)
38 struct hda_beep
*beep
=
39 container_of(work
, struct hda_beep
, beep_work
);
40 struct hda_codec
*codec
= beep
->codec
;
47 if (tone
&& !beep
->playing
) {
48 snd_hda_power_up(codec
);
52 snd_hda_codec_write(codec
, beep
->nid
, 0,
53 AC_VERB_SET_BEEP_CONTROL
, tone
);
54 if (!tone
&& beep
->playing
) {
56 snd_hda_power_down(codec
);
60 /* (non-standard) Linear beep tone calculation for IDT/STAC codecs
62 * The tone frequency of beep generator on IDT/STAC codecs is
63 * defined from the 8bit tone parameter, in Hz,
64 * freq = 48000 * (257 - tone) / 1024
65 * that is from 12kHz to 93.75Hz in steps of 46.875 Hz
67 static int beep_linear_tone(struct hda_beep
*beep
, int hz
)
71 hz
*= 1000; /* fixed point */
72 hz
= hz
- DIGBEEP_HZ_MIN
73 + DIGBEEP_HZ_STEP
/ 2; /* round to nearest step */
75 hz
= 0; /* turn off PC beep*/
76 else if (hz
>= (DIGBEEP_HZ_MAX
- DIGBEEP_HZ_MIN
))
77 hz
= 1; /* max frequency */
79 hz
/= DIGBEEP_HZ_STEP
;
85 /* HD-audio standard beep tone parameter calculation
87 * The tone frequency in Hz is calculated as
88 * freq = 48000 / (tone * 4)
91 static int beep_standard_tone(struct hda_beep
*beep
, int hz
)
94 return 0; /* disabled */
103 static int snd_hda_beep_event(struct input_dev
*dev
, unsigned int type
,
104 unsigned int code
, int hz
)
106 struct hda_beep
*beep
= input_get_drvdata(dev
);
114 if (beep
->linear_tone
)
115 beep
->tone
= beep_linear_tone(beep
, hz
);
117 beep
->tone
= beep_standard_tone(beep
, hz
);
123 /* schedule beep event */
124 schedule_work(&beep
->beep_work
);
128 static void turn_off_beep(struct hda_beep
*beep
)
130 cancel_work_sync(&beep
->beep_work
);
133 snd_hda_codec_write(beep
->codec
, beep
->nid
, 0,
134 AC_VERB_SET_BEEP_CONTROL
, 0);
136 snd_hda_power_down(beep
->codec
);
140 static void snd_hda_do_detach(struct hda_beep
*beep
)
142 if (beep
->registered
)
143 input_unregister_device(beep
->dev
);
145 input_free_device(beep
->dev
);
150 static int snd_hda_do_attach(struct hda_beep
*beep
)
152 struct input_dev
*input_dev
;
153 struct hda_codec
*codec
= beep
->codec
;
155 input_dev
= input_allocate_device();
159 /* setup digital beep device */
160 input_dev
->name
= "HDA Digital PCBeep";
161 input_dev
->phys
= beep
->phys
;
162 input_dev
->id
.bustype
= BUS_PCI
;
163 input_dev
->dev
.parent
= &codec
->bus
->card
->card_dev
;
165 input_dev
->id
.vendor
= codec
->vendor_id
>> 16;
166 input_dev
->id
.product
= codec
->vendor_id
& 0xffff;
167 input_dev
->id
.version
= 0x01;
169 input_dev
->evbit
[0] = BIT_MASK(EV_SND
);
170 input_dev
->sndbit
[0] = BIT_MASK(SND_BELL
) | BIT_MASK(SND_TONE
);
171 input_dev
->event
= snd_hda_beep_event
;
172 input_set_drvdata(input_dev
, beep
);
174 beep
->dev
= input_dev
;
179 * snd_hda_enable_beep_device - Turn on/off beep sound
180 * @codec: the HDA codec
181 * @enable: flag to turn on/off
183 int snd_hda_enable_beep_device(struct hda_codec
*codec
, int enable
)
185 struct hda_beep
*beep
= codec
->beep
;
189 if (beep
->enabled
!= enable
) {
190 beep
->enabled
= enable
;
197 EXPORT_SYMBOL_GPL(snd_hda_enable_beep_device
);
200 * snd_hda_attach_beep_device - Attach a beep input device
201 * @codec: the HDA codec
204 * Attach a beep object to the given widget. If beep hint is turned off
205 * explicitly or beep_mode of the codec is turned off, this doesn't nothing.
207 * The attached beep device has to be registered via
208 * snd_hda_register_beep_device() and released via snd_hda_detach_beep_device()
211 * Currently, only one beep device is allowed to each codec.
213 int snd_hda_attach_beep_device(struct hda_codec
*codec
, int nid
)
215 struct hda_beep
*beep
;
218 if (!snd_hda_get_bool_hint(codec
, "beep"))
219 return 0; /* disabled explicitly by hints */
220 if (codec
->beep_mode
== HDA_BEEP_MODE_OFF
)
221 return 0; /* disabled by module option */
223 beep
= kzalloc(sizeof(*beep
), GFP_KERNEL
);
226 snprintf(beep
->phys
, sizeof(beep
->phys
),
227 "card%d/codec#%d/beep0", codec
->bus
->card
->number
, codec
->addr
);
228 /* enable linear scale */
229 snd_hda_codec_write_cache(codec
, nid
, 0,
230 AC_VERB_SET_DIGI_CONVERT_2
, 0x01);
236 INIT_WORK(&beep
->beep_work
, &snd_hda_generate_beep
);
237 mutex_init(&beep
->mutex
);
239 err
= snd_hda_do_attach(beep
);
248 EXPORT_SYMBOL_GPL(snd_hda_attach_beep_device
);
251 * snd_hda_detach_beep_device - Detach the beep device
252 * @codec: the HDA codec
254 void snd_hda_detach_beep_device(struct hda_codec
*codec
)
256 struct hda_beep
*beep
= codec
->beep
;
259 snd_hda_do_detach(beep
);
264 EXPORT_SYMBOL_GPL(snd_hda_detach_beep_device
);
267 * snd_hda_register_beep_device - Register the beep device
268 * @codec: the HDA codec
270 int snd_hda_register_beep_device(struct hda_codec
*codec
)
272 struct hda_beep
*beep
= codec
->beep
;
275 if (!beep
|| !beep
->dev
)
278 err
= input_register_device(beep
->dev
);
280 codec_err(codec
, "hda_beep: unable to register input device\n");
281 input_free_device(beep
->dev
);
286 beep
->registered
= true;
289 EXPORT_SYMBOL_GPL(snd_hda_register_beep_device
);
291 static bool ctl_has_mute(struct snd_kcontrol
*kcontrol
)
293 struct hda_codec
*codec
= snd_kcontrol_chip(kcontrol
);
294 return query_amp_caps(codec
, get_amp_nid(kcontrol
),
295 get_amp_direction(kcontrol
)) & AC_AMPCAP_MUTE
;
298 /* get/put callbacks for beep mute mixer switches */
301 * snd_hda_mixer_amp_switch_get_beep - Get callback for beep controls
302 * @kcontrol: ctl element
303 * @ucontrol: pointer to get/store the data
305 int snd_hda_mixer_amp_switch_get_beep(struct snd_kcontrol
*kcontrol
,
306 struct snd_ctl_elem_value
*ucontrol
)
308 struct hda_codec
*codec
= snd_kcontrol_chip(kcontrol
);
309 struct hda_beep
*beep
= codec
->beep
;
310 if (beep
&& (!beep
->enabled
|| !ctl_has_mute(kcontrol
))) {
311 ucontrol
->value
.integer
.value
[0] =
312 ucontrol
->value
.integer
.value
[1] = beep
->enabled
;
315 return snd_hda_mixer_amp_switch_get(kcontrol
, ucontrol
);
317 EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_switch_get_beep
);
320 * snd_hda_mixer_amp_switch_put_beep - Put callback for beep controls
321 * @kcontrol: ctl element
322 * @ucontrol: pointer to get/store the data
324 int snd_hda_mixer_amp_switch_put_beep(struct snd_kcontrol
*kcontrol
,
325 struct snd_ctl_elem_value
*ucontrol
)
327 struct hda_codec
*codec
= snd_kcontrol_chip(kcontrol
);
328 struct hda_beep
*beep
= codec
->beep
;
330 u8 chs
= get_amp_channels(kcontrol
);
332 long *valp
= ucontrol
->value
.integer
.value
;
339 snd_hda_enable_beep_device(codec
, enable
);
341 if (!ctl_has_mute(kcontrol
))
343 return snd_hda_mixer_amp_switch_put(kcontrol
, ucontrol
);
345 EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_switch_put_beep
);