sound/pci/hda/hda_beep.c

   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                 /* fallthru */
 114         case SND_TONE:
 115                 if (beep->linear_tone)
 116                         beep->tone = beep_linear_tone(beep, hz);
 117                 else
 118                         beep->tone = beep_standard_tone(beep, hz);
 119                 break;
 120         default:
 121                 return -1;
 122         }
 123
 124         /* schedule beep event */
 125         schedule_work(&beep->beep_work);
 126         return 0;
 127 }
 128
 129 static void turn_off_beep(struct hda_beep *beep)
 130 {
 131         cancel_work_sync(&beep->beep_work);
 132         if (beep->playing) {
 133                 /* turn off beep */
 134                 snd_hda_codec_write(beep->codec, beep->nid, 0,
 135                                     AC_VERB_SET_BEEP_CONTROL, 0);
 136                 beep->playing = 0;
 137                 snd_hda_power_down(beep->codec);
 138         }
 139 }
 140
 141 static void snd_hda_do_detach(struct hda_beep *beep)
 142 {
 143         input_unregister_device(beep->dev);
 144         beep->dev = NULL;
 145         turn_off_beep(beep);
 146 }
 147
 148 static int snd_hda_do_attach(struct hda_beep *beep)
 149 {
 150         struct input_dev *input_dev;
 151         struct hda_codec *codec = beep->codec;
 152         int err;
 153
 154         input_dev = input_allocate_device();
 155         if (!input_dev)
 156                 return -ENOMEM;
 157
 158         /* setup digital beep device */
 159         input_dev->name = "HDA Digital PCBeep";
 160         input_dev->phys = beep->phys;
 161         input_dev->id.bustype = BUS_PCI;
 162
 163         input_dev->id.vendor = codec->vendor_id >> 16;
 164         input_dev->id.product = codec->vendor_id & 0xffff;
 165         input_dev->id.version = 0x01;
 166
 167         input_dev->evbit[0] = BIT_MASK(EV_SND);
 168         input_dev->sndbit[0] = BIT_MASK(SND_BELL) | BIT_MASK(SND_TONE);
 169         input_dev->event = snd_hda_beep_event;
 170         input_dev->dev.parent = &codec->bus->pci->dev;
 171         input_set_drvdata(input_dev, beep);
 172
 173         err = input_register_device(input_dev);
 174         if (err < 0) {
 175                 input_free_device(input_dev);
 176                 printk(KERN_INFO "hda_beep: unable to register input device\n");
 177                 return err;
 178         }
 179         beep->dev = input_dev;
 180         return 0;
 181 }
 182
 183 int snd_hda_enable_beep_device(struct hda_codec *codec, int enable)
 184 {
 185         struct hda_beep *beep = codec->beep;
 186         if (!beep)
 187                 return 0;
 188         enable = !!enable;
 189         if (beep->enabled != enable) {
 190                 beep->enabled = enable;
 191                 if (!enable)
 192                         turn_off_beep(beep);
 193                 return 1;
 194         }
 195         return 0;
 196 }
 197 EXPORT_SYMBOL_GPL(snd_hda_enable_beep_device);
 198
 199 int snd_hda_attach_beep_device(struct hda_codec *codec, int nid)
 200 {
 201         struct hda_beep *beep;
 202         int err;
 203
 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 */
 208
 209         beep = kzalloc(sizeof(*beep), GFP_KERNEL);
 210         if (beep == NULL)
 211                 return -ENOMEM;
 212         snprintf(beep->phys, sizeof(beep->phys),
 213                 "card%d/codec#%d/beep0", codec->bus->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);
 217
 218         beep->nid = nid;
 219         beep->codec = codec;
 220         codec->beep = beep;
 221
 222         INIT_WORK(&beep->beep_work, &snd_hda_generate_beep);
 223         mutex_init(&beep->mutex);
 224
 225         err = snd_hda_do_attach(beep);
 226         if (err < 0) {
 227                 kfree(beep);
 228                 codec->beep = NULL;
 229                 return err;
 230         }
 231
 232         return 0;
 233 }
 234 EXPORT_SYMBOL_GPL(snd_hda_attach_beep_device);
 235
 236 void snd_hda_detach_beep_device(struct hda_codec *codec)
 237 {
 238         struct hda_beep *beep = codec->beep;
 239         if (beep) {
 240                 if (beep->dev)
 241                         snd_hda_do_detach(beep);
 242                 codec->beep = NULL;
 243                 kfree(beep);
 244         }
 245 }
 246 EXPORT_SYMBOL_GPL(snd_hda_detach_beep_device);
 247
 248 static bool ctl_has_mute(struct snd_kcontrol *kcontrol)
 249 {
 250         struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
 251         return query_amp_caps(codec, get_amp_nid(kcontrol),
 252                               get_amp_direction(kcontrol)) & AC_AMPCAP_MUTE;
 253 }
 254
 255 /* get/put callbacks for beep mute mixer switches */
 256 int snd_hda_mixer_amp_switch_get_beep(struct snd_kcontrol *kcontrol,
 257                                       struct snd_ctl_elem_value *ucontrol)
 258 {
 259         struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
 260         struct hda_beep *beep = codec->beep;
 261         if (beep && (!beep->enabled || !ctl_has_mute(kcontrol))) {
 262                 ucontrol->value.integer.value[0] =
 263                         ucontrol->value.integer.value[1] = beep->enabled;
 264                 return 0;
 265         }
 266         return snd_hda_mixer_amp_switch_get(kcontrol, ucontrol);
 267 }
 268 EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_switch_get_beep);
 269
 270 int snd_hda_mixer_amp_switch_put_beep(struct snd_kcontrol *kcontrol,
 271                                       struct snd_ctl_elem_value *ucontrol)
 272 {
 273         struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
 274         struct hda_beep *beep = codec->beep;
 275         if (beep) {
 276                 u8 chs = get_amp_channels(kcontrol);
 277                 int enable = 0;
 278                 long *valp = ucontrol->value.integer.value;
 279                 if (chs & 1) {
 280                         enable |= *valp;
 281                         valp++;
 282                 }
 283                 if (chs & 2)
 284                         enable |= *valp;
 285                 snd_hda_enable_beep_device(codec, enable);
 286         }
 287         if (!ctl_has_mute(kcontrol))
 288                 return 0;
 289         return snd_hda_mixer_amp_switch_put(kcontrol, ucontrol);
 290 }
 291 EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_switch_put_beep);