[mirror_ubuntu-bionic-kernel.git] / sound / pci / hda / hda_beep.c

/*
 * Digital Beep Input Interface for HD-audio codec
 *
 * Author: Matthew Ranostay <mranostay@embeddedalley.com>
 * Copyright (c) 2008 Embedded Alley Solutions Inc
 *
 *  This driver is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This driver is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 */

#include <linux/input.h>
#include <linux/slab.h>
#include <linux/workqueue.h>
#include <linux/export.h>
#include <sound/core.h>
#include "hda_beep.h"
#include "hda_local.h"

enum {
	DIGBEEP_HZ_STEP = 46875,	/* 46.875 Hz */
	DIGBEEP_HZ_MIN = 93750,		/* 93.750 Hz */
	DIGBEEP_HZ_MAX = 12000000,	/* 12 KHz */
};

static void snd_hda_generate_beep(struct work_struct *work)
{
	struct hda_beep *beep =
		container_of(work, struct hda_beep, beep_work);
	struct hda_codec *codec = beep->codec;
	int tone;

	if (!beep->enabled)
		return;

	tone = beep->tone;
	if (tone && !beep->playing) {
		snd_hda_power_up(codec);
		beep->playing = 1;
	}
	/* generate tone */
	snd_hda_codec_write(codec, beep->nid, 0,
			    AC_VERB_SET_BEEP_CONTROL, tone);
	if (!tone && beep->playing) {
		beep->playing = 0;
		snd_hda_power_down(codec);
	}
}

/* (non-standard) Linear beep tone calculation for IDT/STAC codecs 
 *
 * The tone frequency of beep generator on IDT/STAC codecs is
 * defined from the 8bit tone parameter, in Hz,
 *    freq = 48000 * (257 - tone) / 1024
 * that is from 12kHz to 93.75Hz in steps of 46.875 Hz
 */
static int beep_linear_tone(struct hda_beep *beep, int hz)
{
	if (hz <= 0)
		return 0;
	hz *= 1000; /* fixed point */
	hz = hz - DIGBEEP_HZ_MIN
		+ DIGBEEP_HZ_STEP / 2; /* round to nearest step */
	if (hz < 0)
		hz = 0; /* turn off PC beep*/
	else if (hz >= (DIGBEEP_HZ_MAX - DIGBEEP_HZ_MIN))
		hz = 1; /* max frequency */
	else {
		hz /= DIGBEEP_HZ_STEP;
		hz = 255 - hz;
	}
	return hz;
}

/* HD-audio standard beep tone parameter calculation
 *
 * The tone frequency in Hz is calculated as
 *   freq = 48000 / (tone * 4)
 * from 47Hz to 12kHz
 */
static int beep_standard_tone(struct hda_beep *beep, int hz)
{
	if (hz <= 0)
		return 0; /* disabled */
	hz = 12000 / hz;
	if (hz > 0xff)
		return 0xff;
	if (hz <= 0)
		return 1;
	return hz;
}

static int snd_hda_beep_event(struct input_dev *dev, unsigned int type,
				unsigned int code, int hz)
{
	struct hda_beep *beep = input_get_drvdata(dev);

	switch (code) {
	case SND_BELL:
		if (hz)
			hz = 1000;
		/* fallthru */
	case SND_TONE:
		if (beep->linear_tone)
			beep->tone = beep_linear_tone(beep, hz);
		else
			beep->tone = beep_standard_tone(beep, hz);
		break;
	default:
		return -1;
	}

	/* schedule beep event */
	schedule_work(&beep->beep_work);
	return 0;
}

static void turn_off_beep(struct hda_beep *beep)
{
	cancel_work_sync(&beep->beep_work);
	if (beep->playing) {
		/* turn off beep */
		snd_hda_codec_write(beep->codec, beep->nid, 0,
				    AC_VERB_SET_BEEP_CONTROL, 0);
		beep->playing = 0;
		snd_hda_power_down(beep->codec);
	}
}

static void snd_hda_do_detach(struct hda_beep *beep)
{
	if (beep->registered)
		input_unregister_device(beep->dev);
	else
		input_free_device(beep->dev);
	beep->dev = NULL;
	turn_off_beep(beep);
}

static int snd_hda_do_attach(struct hda_beep *beep)
{
	struct input_dev *input_dev;
	struct hda_codec *codec = beep->codec;

	input_dev = input_allocate_device();
	if (!input_dev)
		return -ENOMEM;

	/* setup digital beep device */
	input_dev->name = "HDA Digital PCBeep";
	input_dev->phys = beep->phys;
	input_dev->id.bustype = BUS_PCI;

	input_dev->id.vendor = codec->vendor_id >> 16;
	input_dev->id.product = codec->vendor_id & 0xffff;
	input_dev->id.version = 0x01;

	input_dev->evbit[0] = BIT_MASK(EV_SND);
	input_dev->sndbit[0] = BIT_MASK(SND_BELL) | BIT_MASK(SND_TONE);
	input_dev->event = snd_hda_beep_event;
	input_dev->dev.parent = &codec->dev;
	input_set_drvdata(input_dev, beep);

	beep->dev = input_dev;
	return 0;
}

int snd_hda_enable_beep_device(struct hda_codec *codec, int enable)
{
	struct hda_beep *beep = codec->beep;
	if (!beep)
		return 0;
	enable = !!enable;
	if (beep->enabled != enable) {
		beep->enabled = enable;
		if (!enable)
			turn_off_beep(beep);
		return 1;
	}
	return 0;
}
EXPORT_SYMBOL_GPL(snd_hda_enable_beep_device);

int snd_hda_attach_beep_device(struct hda_codec *codec, int nid)
{
	struct hda_beep *beep;
	int err;

	if (!snd_hda_get_bool_hint(codec, "beep"))
		return 0; /* disabled explicitly by hints */
	if (codec->beep_mode == HDA_BEEP_MODE_OFF)
		return 0; /* disabled by module option */

	beep = kzalloc(sizeof(*beep), GFP_KERNEL);
	if (beep == NULL)
		return -ENOMEM;
	snprintf(beep->phys, sizeof(beep->phys),
		"card%d/codec#%d/beep0", codec->bus->card->number, codec->addr);
	/* enable linear scale */
	snd_hda_codec_write_cache(codec, nid, 0,
		AC_VERB_SET_DIGI_CONVERT_2, 0x01);

	beep->nid = nid;
	beep->codec = codec;
	codec->beep = beep;

	INIT_WORK(&beep->beep_work, &snd_hda_generate_beep);
	mutex_init(&beep->mutex);

	err = snd_hda_do_attach(beep);
	if (err < 0) {
		kfree(beep);
		codec->beep = NULL;
		return err;
	}

	return 0;
}
EXPORT_SYMBOL_GPL(snd_hda_attach_beep_device);

void snd_hda_detach_beep_device(struct hda_codec *codec)
{
	struct hda_beep *beep = codec->beep;
	if (beep) {
		if (beep->dev)
			snd_hda_do_detach(beep);
		codec->beep = NULL;
		kfree(beep);
	}
}
EXPORT_SYMBOL_GPL(snd_hda_detach_beep_device);

int snd_hda_register_beep_device(struct hda_codec *codec)
{
	struct hda_beep *beep = codec->beep;
	int err;

	if (!beep || !beep->dev)
		return 0;

	err = input_register_device(beep->dev);
	if (err < 0) {
		codec_err(codec, "hda_beep: unable to register input device\n");
		input_free_device(beep->dev);
		codec->beep = NULL;
		kfree(beep);
		return err;
	}
	beep->registered = true;
	return 0;
}
EXPORT_SYMBOL_GPL(snd_hda_register_beep_device);

static bool ctl_has_mute(struct snd_kcontrol *kcontrol)
{
	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
	return query_amp_caps(codec, get_amp_nid(kcontrol),
			      get_amp_direction(kcontrol)) & AC_AMPCAP_MUTE;
}

/* get/put callbacks for beep mute mixer switches */
int snd_hda_mixer_amp_switch_get_beep(struct snd_kcontrol *kcontrol,
				      struct snd_ctl_elem_value *ucontrol)
{
	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
	struct hda_beep *beep = codec->beep;
	if (beep && (!beep->enabled || !ctl_has_mute(kcontrol))) {
		ucontrol->value.integer.value[0] =
			ucontrol->value.integer.value[1] = beep->enabled;
		return 0;
	}
	return snd_hda_mixer_amp_switch_get(kcontrol, ucontrol);
}
EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_switch_get_beep);

int snd_hda_mixer_amp_switch_put_beep(struct snd_kcontrol *kcontrol,
				      struct snd_ctl_elem_value *ucontrol)
{
	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
	struct hda_beep *beep = codec->beep;
	if (beep) {
		u8 chs = get_amp_channels(kcontrol);
		int enable = 0;
		long *valp = ucontrol->value.integer.value;
		if (chs & 1) {
			enable |= *valp;
			valp++;
		}
		if (chs & 2)
			enable |= *valp;
		snd_hda_enable_beep_device(codec, enable);
	}
	if (!ctl_has_mute(kcontrol))
		return 0;
	return snd_hda_mixer_amp_switch_put(kcontrol, ucontrol);
}
EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_switch_put_beep);
Commit	Line	Data
1cd2224c MR	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>
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>
1cd2224c MR	27	#include "hda_beep.h"
b7b51141	28	#include "hda_local.h"
1cd2224c MR	29
	30	enum {
	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
	36	static void snd_hda_generate_beep(struct work_struct *work)
	37	{
	38	struct hda_beep *beep =
	39	container_of(work, struct hda_beep, beep_work);
	40	struct hda_codec *codec = beep->codec;
e914b25e	41	int tone;
1cd2224c	42
4d4e9bb3 TI	43	if (!beep->enabled)
	44	return;
	45
e914b25e TI	46	tone = beep->tone;
	47	if (tone && !beep->playing) {
	48	snd_hda_power_up(codec);
	49	beep->playing = 1;
	50	}
1cd2224c	51	/* generate tone */
411fe85c	52	snd_hda_codec_write(codec, beep->nid, 0,
e914b25e TI	53	AC_VERB_SET_BEEP_CONTROL, tone);
	54	if (!tone && beep->playing) {
	55	beep->playing = 0;
	56	snd_hda_power_down(codec);
	57	}
1cd2224c MR	58	}
1cd2224c MR	59
fa797966 TI	60	/* (non-standard) Linear beep tone calculation for IDT/STAC codecs
	61	*
	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
369693dc	65	* that is from 12kHz to 93.75Hz in steps of 46.875 Hz
fa797966 TI	66	*/
	67	static int beep_linear_tone(struct hda_beep *beep, int hz)
	68	{
369693dc PV	69	if (hz <= 0)
369693dc PV	70	return 0;
fa797966	71	hz = 1000; / fixed point */
369693dc PV	72	hz = hz - DIGBEEP_HZ_MIN
369693dc PV	73	+ DIGBEEP_HZ_STEP / 2; /* round to nearest step */
fa797966 TI	74	if (hz < 0)
	75	hz = 0; /* turn off PC beep*/
	76	else if (hz >= (DIGBEEP_HZ_MAX - DIGBEEP_HZ_MIN))
369693dc	77	hz = 1; /* max frequency */
fa797966 TI	78	else {
fa797966 TI	79	hz /= DIGBEEP_HZ_STEP;
369693dc	80	hz = 255 - hz;
fa797966 TI	81	}
	82	return hz;
	83	}
	84
	85	/* HD-audio standard beep tone parameter calculation
	86	*
	87	* The tone frequency in Hz is calculated as
	88	* freq = 48000 / (tone * 4)
	89	* from 47Hz to 12kHz
	90	*/
	91	static int beep_standard_tone(struct hda_beep *beep, int hz)
	92	{
	93	if (hz <= 0)
	94	return 0; /* disabled */
	95	hz = 12000 / hz;
	96	if (hz > 0xff)
	97	return 0xff;
	98	if (hz <= 0)
	99	return 1;
	100	return hz;
	101	}
	102
1cd2224c MR	103	static int snd_hda_beep_event(struct input_dev *dev, unsigned int type,
	104	unsigned int code, int hz)
	105	{
	106	struct hda_beep *beep = input_get_drvdata(dev);
	107
	108	switch (code) {
	109	case SND_BELL:
	110	if (hz)
	111	hz = 1000;
57d8ff61	112	/* fallthru */
1cd2224c	113	case SND_TONE:
fa797966 TI	114	if (beep->linear_tone)
	115	beep->tone = beep_linear_tone(beep, hz);
	116	else
	117	beep->tone = beep_standard_tone(beep, hz);
1cd2224c MR	118	break;
	119	default:
	120	return -1;
	121	}
1cd2224c MR	122
	123	/* schedule beep event */
	124	schedule_work(&beep->beep_work);
	125	return 0;
	126	}
	127
e914b25e TI	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
123c07ae JK	140	static void snd_hda_do_detach(struct hda_beep *beep)
123c07ae JK	141	{
d604b399 TI	142	if (beep->registered)
	143	input_unregister_device(beep->dev);
	144	else
	145	input_free_device(beep->dev);
123c07ae	146	beep->dev = NULL;
e914b25e	147	turn_off_beep(beep);
123c07ae JK	148	}
	149
	150	static int snd_hda_do_attach(struct hda_beep *beep)
1cd2224c MR	151	{
1cd2224c MR	152	struct input_dev *input_dev;
123c07ae	153	struct hda_codec *codec = beep->codec;
1cd2224c	154
1cd2224c	155	input_dev = input_allocate_device();
b7baa9a0	156	if (!input_dev)
6a12afb5	157	return -ENOMEM;
1cd2224c MR	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;
f2606a80	171	input_dev->dev.parent = &codec->dev;
1cd2224c MR	172	input_set_drvdata(input_dev, beep);
1cd2224c MR	173
123c07ae JK	174	beep->dev = input_dev;
	175	return 0;
	176	}
	177
123c07ae JK	178	int snd_hda_enable_beep_device(struct hda_codec *codec, int enable)
	179	{
	180	struct hda_beep *beep = codec->beep;
3fd877d3	181	if (!beep)
13dab080	182	return 0;
3fd877d3	183	enable = !!enable;
13dab080 JK	184	if (beep->enabled != enable) {
13dab080 JK	185	beep->enabled = enable;
e914b25e TI	186	if (!enable)
e914b25e TI	187	turn_off_beep(beep);
123c07ae JK	188	return 1;
	189	}
	190	return 0;
	191	}
2698ea98	192	EXPORT_SYMBOL_GPL(snd_hda_enable_beep_device);
123c07ae JK	193
	194	int snd_hda_attach_beep_device(struct hda_codec *codec, int nid)
	195	{
	196	struct hda_beep *beep;
257dfb41	197	int err;
123c07ae JK	198
123c07ae JK	199	if (!snd_hda_get_bool_hint(codec, "beep"))
9bb1fe39 TI	200	return 0; /* disabled explicitly by hints */
	201	if (codec->beep_mode == HDA_BEEP_MODE_OFF)
	202	return 0; /* disabled by module option */
1cd2224c	203
123c07ae JK	204	beep = kzalloc(sizeof(*beep), GFP_KERNEL);
	205	if (beep == NULL)
	206	return -ENOMEM;
	207	snprintf(beep->phys, sizeof(beep->phys),
	208	"card%d/codec#%d/beep0", codec->bus->card->number, codec->addr);
1cd2224c	209	/* enable linear scale */
8bc0a846	210	snd_hda_codec_write_cache(codec, nid, 0,
1cd2224c MR	211	AC_VERB_SET_DIGI_CONVERT_2, 0x01);
	212
	213	beep->nid = nid;
1cd2224c MR	214	beep->codec = codec;
	215	codec->beep = beep;
	216
	217	INIT_WORK(&beep->beep_work, &snd_hda_generate_beep);
123c07ae JK	218	mutex_init(&beep->mutex);
123c07ae JK	219
257dfb41 TI	220	err = snd_hda_do_attach(beep);
	221	if (err < 0) {
	222	kfree(beep);
	223	codec->beep = NULL;
	224	return err;
2dca0bba JK	225	}
2dca0bba JK	226
1cd2224c MR	227	return 0;
1cd2224c MR	228	}
2698ea98	229	EXPORT_SYMBOL_GPL(snd_hda_attach_beep_device);
1cd2224c MR	230
	231	void snd_hda_detach_beep_device(struct hda_codec *codec)
	232	{
	233	struct hda_beep *beep = codec->beep;
	234	if (beep) {
54f7190b	235	if (beep->dev)
123c07ae	236	snd_hda_do_detach(beep);
c44765b8	237	codec->beep = NULL;
123c07ae	238	kfree(beep);
1cd2224c MR	239	}
1cd2224c MR	240	}
2698ea98	241	EXPORT_SYMBOL_GPL(snd_hda_detach_beep_device);
0401e854	242
d604b399 TI	243	int snd_hda_register_beep_device(struct hda_codec *codec)
	244	{
	245	struct hda_beep *beep = codec->beep;
	246	int err;
	247
	248	if (!beep \|\| !beep->dev)
	249	return 0;
	250
	251	err = input_register_device(beep->dev);
	252	if (err < 0) {
	253	codec_err(codec, "hda_beep: unable to register input device\n");
	254	input_free_device(beep->dev);
	255	codec->beep = NULL;
	256	kfree(beep);
	257	return err;
	258	}
	259	beep->registered = true;
	260	return 0;
	261	}
	262	EXPORT_SYMBOL_GPL(snd_hda_register_beep_device);
	263
265d931a DH	264	static bool ctl_has_mute(struct snd_kcontrol *kcontrol)
	265	{
	266	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
	267	return query_amp_caps(codec, get_amp_nid(kcontrol),
	268	get_amp_direction(kcontrol)) & AC_AMPCAP_MUTE;
	269	}
	270
0401e854 TI	271	/* get/put callbacks for beep mute mixer switches */
	272	int snd_hda_mixer_amp_switch_get_beep(struct snd_kcontrol *kcontrol,
	273	struct snd_ctl_elem_value *ucontrol)
	274	{
	275	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
	276	struct hda_beep *beep = codec->beep;
265d931a	277	if (beep && (!beep->enabled \|\| !ctl_has_mute(kcontrol))) {
0401e854	278	ucontrol->value.integer.value[0] =
265d931a	279	ucontrol->value.integer.value[1] = beep->enabled;
0401e854 TI	280	return 0;
	281	}
	282	return snd_hda_mixer_amp_switch_get(kcontrol, ucontrol);
	283	}
2698ea98	284	EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_switch_get_beep);
0401e854 TI	285
	286	int snd_hda_mixer_amp_switch_put_beep(struct snd_kcontrol *kcontrol,
	287	struct snd_ctl_elem_value *ucontrol)
	288	{
	289	struct hda_codec *codec = snd_kcontrol_chip(kcontrol);
	290	struct hda_beep *beep = codec->beep;
14bc9c6d DH	291	if (beep) {
	292	u8 chs = get_amp_channels(kcontrol);
	293	int enable = 0;
	294	long *valp = ucontrol->value.integer.value;
	295	if (chs & 1) {
	296	enable \|= *valp;
	297	valp++;
	298	}
	299	if (chs & 2)
	300	enable \|= *valp;
	301	snd_hda_enable_beep_device(codec, enable);
	302	}
265d931a DH	303	if (!ctl_has_mute(kcontrol))
265d931a DH	304	return 0;
0401e854 TI	305	return snd_hda_mixer_amp_switch_put(kcontrol, ucontrol);
0401e854 TI	306	}
2698ea98	307	EXPORT_SYMBOL_GPL(snd_hda_mixer_amp_switch_put_beep);