1 /* 2 * Digital Beep Input Interface for HD-audio codec 3 * 4 * Author: Matthew Ranostay <mranostay@embeddedalley.com> 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> 23 #include <linux/pci.h> 24 #include <linux/slab.h> 25 #include <linux/workqueue.h> 26 #include <linux/export.h> 27 #include <sound/core.h> 28 #include "hda_beep.h" 29 #include "hda_local.h" 30 31 enum { 32 DIGBEEP_HZ_STEP = 46875, /* 46.875 Hz */ 33 DIGBEEP_HZ_MIN = 93750, /* 93.750 Hz */ 34 DIGBEEP_HZ_MAX = 12000000, /* 12 KHz */ 35 }; 36 37 static void snd_hda_generate_beep(struct work_struct *work) 38 { 39 struct hda_beep *beep = 40 container_of(work, struct hda_beep, beep_work); 41 struct hda_codec *codec = beep->codec; 42 int tone; 43 44 if (!beep->enabled) 45 return; 46 47 tone = beep->tone; 48 if (tone && !beep->playing) { 49 snd_hda_power_up(codec); 50 beep->playing = 1; 51 } 52 /* generate tone */ 53 snd_hda_codec_write(codec, beep->nid, 0, 54 AC_VERB_SET_BEEP_CONTROL, tone); 55 if (!tone && beep->playing) { 56 beep->playing = 0; 57 snd_hda_power_down(codec); 58 } 59 } 60 61 /* (non-standard) Linear beep tone calculation for IDT/STAC codecs 62 * 63 * The tone frequency of beep generator on IDT/STAC codecs is 64 * defined from the 8bit tone parameter, in Hz, 65 * freq = 48000 * (257 - tone) / 1024 66 * that is from 12kHz to 93.75Hz in steps of 46.875 Hz 67 */ 68 static int beep_linear_tone(struct hda_beep *beep, int hz) 69 { 70 if (hz <= 0) 71 return 0; 72 hz *= 1000; /* fixed point */ 73 hz = hz - DIGBEEP_HZ_MIN 74 + DIGBEEP_HZ_STEP / 2; /* round to nearest step */ 75 if (hz < 0) 76 hz = 0; /* turn off PC beep*/ 77 else if (hz >= (DIGBEEP_HZ_MAX - DIGBEEP_HZ_MIN)) 78 hz = 1; /* max frequency */ 79 else { 80 hz /= DIGBEEP_HZ_STEP; 81 hz = 255 - hz; 82 } 83 return hz; 84 } 85 86 /* HD-audio standard beep tone parameter calculation 87 * 88 * The tone frequency in Hz is calculated as 89 * freq = 48000 / (tone * 4) 90 * from 47Hz to 12kHz 91 */ 92 static int beep_standard_tone(struct hda_beep *beep, int hz) 93 { 94 if (hz <= 0) 95 return 0; /* disabled */ 96 hz = 12000 / hz; 97 if (hz > 0xff) 98 return 0xff; 99 if (hz <= 0) 100 return 1; 101 return hz; 102 } 103 104 static int snd_hda_beep_event(struct input_dev *dev, unsigned int type, 105 unsigned int code, int hz) 106 { 107 struct hda_beep *beep = input_get_drvdata(dev); 108 109 switch (code) { 110 case SND_BELL: 111 if (hz) 112 hz = 1000; 113 case SND_TONE: 114 if (beep->linear_tone) 115 beep->tone = beep_linear_tone(beep, hz); 116 else 117 beep->tone = beep_standard_tone(beep, hz); 118 break; 119 default: 120 return -1; 121 } 122 123 /* schedule beep event */ 124 schedule_work(&beep->beep_work); 125 return 0; 126 } 127 128 static void turn_off_beep(struct hda_beep *beep) 129 { 130 cancel_work_sync(&beep->beep_work); 131 if (beep->playing) { 132 /* turn off beep */ 133 snd_hda_codec_write(beep->codec, beep->nid, 0, 134 AC_VERB_SET_BEEP_CONTROL, 0); 135 beep->playing = 0; 136 snd_hda_power_down(beep->codec); 137 } 138 } 139 140 static void snd_hda_do_detach(struct hda_beep *beep) 141 { 142 input_unregister_device(beep->dev); 143 beep->dev = NULL; 144 turn_off_beep(beep); 145 } 146 147 static int snd_hda_do_attach(struct hda_beep *beep) 148 { 149 struct input_dev *input_dev; 150 struct hda_codec *codec = beep->codec; 151 int err; 152 153 input_dev = input_allocate_device(); 154 if (!input_dev) { 155 printk(KERN_INFO "hda_beep: unable to allocate input device\n"); 156 return -ENOMEM; 157 } 158 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 164 input_dev->id.vendor = codec->vendor_id >> 16; 165 input_dev->id.product = codec->vendor_id & 0xffff; 166 input_dev->id.version = 0x01; 167 168 input_dev->evbit[0] = BIT_MASK(EV_SND); 169 input_dev->sndbit[0] = BIT_MASK(SND_BELL) | BIT_MASK(SND_TONE); 170 input_dev->event = snd_hda_beep_event; 171 input_dev->dev.parent = &codec->bus->pci->dev; 172 input_set_drvdata(input_dev, beep); 173 174 err = input_register_device(input_dev); 175 if (err < 0) { 176 input_free_device(input_dev); 177 printk(KERN_INFO "hda_beep: unable to register input device\n"); 178 return err; 179 } 180 beep->dev = input_dev; 181 return 0; 182 } 183 184 int snd_hda_enable_beep_device(struct hda_codec *codec, int enable) 185 { 186 struct hda_beep *beep = codec->beep; 187 if (!beep) 188 return 0; 189 enable = !!enable; 190 if (beep->enabled != enable) { 191 beep->enabled = enable; 192 if (!enable) 193 turn_off_beep(beep); 194 return 1; 195 } 196 return 0; 197 } 198 EXPORT_SYMBOL_HDA(snd_hda_enable_beep_device); 199 200 int snd_hda_attach_beep_device(struct hda_codec *codec, int nid) 201 { 202 struct hda_beep *beep; 203 int err; 204 205 if (!snd_hda_get_bool_hint(codec, "beep")) 206 return 0; /* disabled explicitly by hints */ 207 if (codec->beep_mode == HDA_BEEP_MODE_OFF) 208 return 0; /* disabled by module option */ 209 210 beep = kzalloc(sizeof(*beep), GFP_KERNEL); 211 if (beep == NULL) 212 return -ENOMEM; 213 snprintf(beep->phys, sizeof(beep->phys), 214 "card%d/codec#%d/beep0", codec->bus->card->number, codec->addr); 215 /* enable linear scale */ 216 snd_hda_codec_write_cache(codec, nid, 0, 217 AC_VERB_SET_DIGI_CONVERT_2, 0x01); 218 219 beep->nid = nid; 220 beep->codec = codec; 221 codec->beep = beep; 222 223 INIT_WORK(&beep->beep_work, &snd_hda_generate_beep); 224 mutex_init(&beep->mutex); 225 226 err = snd_hda_do_attach(beep); 227 if (err < 0) { 228 kfree(beep); 229 codec->beep = NULL; 230 return err; 231 } 232 233 return 0; 234 } 235 EXPORT_SYMBOL_HDA(snd_hda_attach_beep_device); 236 237 void snd_hda_detach_beep_device(struct hda_codec *codec) 238 { 239 struct hda_beep *beep = codec->beep; 240 if (beep) { 241 if (beep->dev) 242 snd_hda_do_detach(beep); 243 codec->beep = NULL; 244 kfree(beep); 245 } 246 } 247 EXPORT_SYMBOL_HDA(snd_hda_detach_beep_device); 248 249 static bool ctl_has_mute(struct snd_kcontrol *kcontrol) 250 { 251 struct hda_codec *codec = snd_kcontrol_chip(kcontrol); 252 return query_amp_caps(codec, get_amp_nid(kcontrol), 253 get_amp_direction(kcontrol)) & AC_AMPCAP_MUTE; 254 } 255 256 /* get/put callbacks for beep mute mixer switches */ 257 int snd_hda_mixer_amp_switch_get_beep(struct snd_kcontrol *kcontrol, 258 struct snd_ctl_elem_value *ucontrol) 259 { 260 struct hda_codec *codec = snd_kcontrol_chip(kcontrol); 261 struct hda_beep *beep = codec->beep; 262 if (beep && (!beep->enabled || !ctl_has_mute(kcontrol))) { 263 ucontrol->value.integer.value[0] = 264 ucontrol->value.integer.value[1] = beep->enabled; 265 return 0; 266 } 267 return snd_hda_mixer_amp_switch_get(kcontrol, ucontrol); 268 } 269 EXPORT_SYMBOL_HDA(snd_hda_mixer_amp_switch_get_beep); 270 271 int snd_hda_mixer_amp_switch_put_beep(struct snd_kcontrol *kcontrol, 272 struct snd_ctl_elem_value *ucontrol) 273 { 274 struct hda_codec *codec = snd_kcontrol_chip(kcontrol); 275 struct hda_beep *beep = codec->beep; 276 if (beep) { 277 u8 chs = get_amp_channels(kcontrol); 278 int enable = 0; 279 long *valp = ucontrol->value.integer.value; 280 if (chs & 1) { 281 enable |= *valp; 282 valp++; 283 } 284 if (chs & 2) 285 enable |= *valp; 286 snd_hda_enable_beep_device(codec, enable); 287 } 288 if (!ctl_has_mute(kcontrol)) 289 return 0; 290 return snd_hda_mixer_amp_switch_put(kcontrol, ucontrol); 291 } 292 EXPORT_SYMBOL_HDA(snd_hda_mixer_amp_switch_put_beep); 293