ALSA: hda - Check "beep" hint
[pandora-kernel.git] / 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/workqueue.h>
25 #include <sound/core.h>
26 #include "hda_beep.h"
27 #include "hda_local.h"
28
29 enum {
30         DIGBEEP_HZ_STEP = 46875,        /* 46.875 Hz */
31         DIGBEEP_HZ_MIN = 93750,         /* 93.750 Hz */
32         DIGBEEP_HZ_MAX = 12000000,      /* 12 KHz */
33 };
34
35 static void snd_hda_generate_beep(struct work_struct *work)
36 {
37         struct hda_beep *beep =
38                 container_of(work, struct hda_beep, beep_work);
39         struct hda_codec *codec = beep->codec;
40
41         if (!beep->enabled)
42                 return;
43
44         /* generate tone */
45         snd_hda_codec_write_cache(codec, beep->nid, 0,
46                         AC_VERB_SET_BEEP_CONTROL, beep->tone);
47 }
48
49 /* (non-standard) Linear beep tone calculation for IDT/STAC codecs 
50  *
51  * The tone frequency of beep generator on IDT/STAC codecs is
52  * defined from the 8bit tone parameter, in Hz,
53  *    freq = 48000 * (257 - tone) / 1024
54  * that is from 12kHz to 93.75kHz in step of 46.875 hz
55  */
56 static int beep_linear_tone(struct hda_beep *beep, int hz)
57 {
58         hz *= 1000; /* fixed point */
59         hz = hz - DIGBEEP_HZ_MIN;
60         if (hz < 0)
61                 hz = 0; /* turn off PC beep*/
62         else if (hz >= (DIGBEEP_HZ_MAX - DIGBEEP_HZ_MIN))
63                 hz = 0xff;
64         else {
65                 hz /= DIGBEEP_HZ_STEP;
66                 hz++;
67         }
68         return hz;
69 }
70
71 /* HD-audio standard beep tone parameter calculation
72  *
73  * The tone frequency in Hz is calculated as
74  *   freq = 48000 / (tone * 4)
75  * from 47Hz to 12kHz
76  */
77 static int beep_standard_tone(struct hda_beep *beep, int hz)
78 {
79         if (hz <= 0)
80                 return 0; /* disabled */
81         hz = 12000 / hz;
82         if (hz > 0xff)
83                 return 0xff;
84         if (hz <= 0)
85                 return 1;
86         return hz;
87 }
88
89 static int snd_hda_beep_event(struct input_dev *dev, unsigned int type,
90                                 unsigned int code, int hz)
91 {
92         struct hda_beep *beep = input_get_drvdata(dev);
93
94         switch (code) {
95         case SND_BELL:
96                 if (hz)
97                         hz = 1000;
98         case SND_TONE:
99                 if (beep->linear_tone)
100                         beep->tone = beep_linear_tone(beep, hz);
101                 else
102                         beep->tone = beep_standard_tone(beep, hz);
103                 break;
104         default:
105                 return -1;
106         }
107
108         /* schedule beep event */
109         schedule_work(&beep->beep_work);
110         return 0;
111 }
112
113 int snd_hda_attach_beep_device(struct hda_codec *codec, int nid)
114 {
115         struct input_dev *input_dev;
116         struct hda_beep *beep;
117         int err;
118
119         if (!snd_hda_get_bool_hint(codec, "beep"))
120                 return 0; /* disabled explicitly */
121
122         beep = kzalloc(sizeof(*beep), GFP_KERNEL);
123         if (beep == NULL)
124                 return -ENOMEM;
125         snprintf(beep->phys, sizeof(beep->phys),
126                 "card%d/codec#%d/beep0", codec->bus->card->number, codec->addr);
127         input_dev = input_allocate_device();
128         if (!input_dev) {
129                 kfree(beep);
130                 return -ENOMEM;
131         }
132
133         /* setup digital beep device */
134         input_dev->name = "HDA Digital PCBeep";
135         input_dev->phys = beep->phys;
136         input_dev->id.bustype = BUS_PCI;
137
138         input_dev->id.vendor = codec->vendor_id >> 16;
139         input_dev->id.product = codec->vendor_id & 0xffff;
140         input_dev->id.version = 0x01;
141
142         input_dev->evbit[0] = BIT_MASK(EV_SND);
143         input_dev->sndbit[0] = BIT_MASK(SND_BELL) | BIT_MASK(SND_TONE);
144         input_dev->event = snd_hda_beep_event;
145         input_dev->dev.parent = &codec->bus->pci->dev;
146         input_set_drvdata(input_dev, beep);
147
148         err = input_register_device(input_dev);
149         if (err < 0) {
150                 input_free_device(input_dev);
151                 kfree(beep);
152                 return err;
153         }
154
155         /* enable linear scale */
156         snd_hda_codec_write(codec, nid, 0,
157                 AC_VERB_SET_DIGI_CONVERT_2, 0x01);
158
159         beep->nid = nid;
160         beep->dev = input_dev;
161         beep->codec = codec;
162         beep->enabled = 1;
163         codec->beep = beep;
164
165         INIT_WORK(&beep->beep_work, &snd_hda_generate_beep);
166         return 0;
167 }
168 EXPORT_SYMBOL_HDA(snd_hda_attach_beep_device);
169
170 void snd_hda_detach_beep_device(struct hda_codec *codec)
171 {
172         struct hda_beep *beep = codec->beep;
173         if (beep) {
174                 cancel_work_sync(&beep->beep_work);
175
176                 input_unregister_device(beep->dev);
177                 kfree(beep);
178                 codec->beep = NULL;
179         }
180 }
181 EXPORT_SYMBOL_HDA(snd_hda_detach_beep_device);