[linux-2.6-block.git] / sound / hda / hdac_regmap.c

/*
 * Regmap support for HD-audio verbs
 *
 * A virtual register is translated to one or more hda verbs for write,
 * vice versa for read.
 *
 * A few limitations:
 * - Provided for not all verbs but only subset standard non-volatile verbs.
 * - For reading, only AC_VERB_GET_* variants can be used.
 * - For writing, mapped to the *corresponding* AC_VERB_SET_* variants,
 *   so can't handle asymmetric verbs for read and write
 */

#include <linux/slab.h>
#include <linux/device.h>
#include <linux/regmap.h>
#include <linux/export.h>
#include <linux/pm.h>
#include <linux/pm_runtime.h>
#include <sound/core.h>
#include <sound/hdaudio.h>
#include <sound/hda_regmap.h>

#ifdef CONFIG_PM
#define codec_is_running(codec)				\
	(atomic_read(&(codec)->in_pm) ||		\
	 !pm_runtime_suspended(&(codec)->dev))
#else
#define codec_is_running(codec)		true
#endif

#define get_verb(reg)	(((reg) >> 8) & 0xfff)

static bool hda_volatile_reg(struct device *dev, unsigned int reg)
{
	unsigned int verb = get_verb(reg);

	switch (verb) {
	case AC_VERB_GET_PROC_COEF:
	case AC_VERB_GET_COEF_INDEX:
	case AC_VERB_GET_PROC_STATE:
	case AC_VERB_GET_POWER_STATE:
	case AC_VERB_GET_PIN_SENSE:
	case AC_VERB_GET_HDMI_DIP_SIZE:
	case AC_VERB_GET_HDMI_ELDD:
	case AC_VERB_GET_HDMI_DIP_INDEX:
	case AC_VERB_GET_HDMI_DIP_DATA:
	case AC_VERB_GET_HDMI_DIP_XMIT:
	case AC_VERB_GET_HDMI_CP_CTRL:
	case AC_VERB_GET_HDMI_CHAN_SLOT:
	case AC_VERB_GET_DEVICE_SEL:
	case AC_VERB_GET_DEVICE_LIST:	/* read-only volatile */
		return true;
	}

	return false;
}

static bool hda_writeable_reg(struct device *dev, unsigned int reg)
{
	struct hdac_device *codec = dev_to_hdac_dev(dev);
	unsigned int verb = get_verb(reg);
	int i;

	for (i = 0; i < codec->vendor_verbs.used; i++) {
		unsigned int *v = snd_array_elem(&codec->vendor_verbs, i);
		if (verb == *v)
			return true;
	}

	if (codec->caps_overwriting)
		return true;

	switch (verb & 0xf00) {
	case AC_VERB_GET_STREAM_FORMAT:
	case AC_VERB_GET_AMP_GAIN_MUTE:
		return true;
	case 0xf00:
		break;
	default:
		return false;
	}

	switch (verb) {
	case AC_VERB_GET_CONNECT_SEL:
	case AC_VERB_GET_SDI_SELECT:
	case AC_VERB_GET_CONV:
	case AC_VERB_GET_PIN_WIDGET_CONTROL:
	case AC_VERB_GET_UNSOLICITED_RESPONSE: /* only as SET_UNSOLICITED_ENABLE */
	case AC_VERB_GET_BEEP_CONTROL:
	case AC_VERB_GET_EAPD_BTLENABLE:
	case AC_VERB_GET_DIGI_CONVERT_1:
	case AC_VERB_GET_DIGI_CONVERT_2: /* only for beep control */
	case AC_VERB_GET_VOLUME_KNOB_CONTROL:
	case AC_VERB_GET_CONFIG_DEFAULT:
	case AC_VERB_GET_GPIO_MASK:
	case AC_VERB_GET_GPIO_DIRECTION:
	case AC_VERB_GET_GPIO_DATA: /* not for volatile read */
	case AC_VERB_GET_GPIO_WAKE_MASK:
	case AC_VERB_GET_GPIO_UNSOLICITED_RSP_MASK:
	case AC_VERB_GET_GPIO_STICKY_MASK:
	case AC_VERB_GET_CVT_CHAN_COUNT:
		return true;
	}

	return false;
}

static bool hda_readable_reg(struct device *dev, unsigned int reg)
{
	struct hdac_device *codec = dev_to_hdac_dev(dev);
	unsigned int verb = get_verb(reg);

	if (codec->caps_overwriting)
		return true;

	switch (verb) {
	case AC_VERB_PARAMETERS:
	case AC_VERB_GET_CONNECT_LIST:
	case AC_VERB_GET_SUBSYSTEM_ID:
		return true;
	}

	return hda_writeable_reg(dev, reg);
}

static int hda_reg_read(void *context, unsigned int reg, unsigned int *val)
{
	struct hdac_device *codec = context;

	if (!codec_is_running(codec))
		return -EAGAIN;
	reg |= (codec->addr << 28);
	return snd_hdac_exec_verb(codec, reg, 0, val);
}

static int hda_reg_write(void *context, unsigned int reg, unsigned int val)
{
	struct hdac_device *codec = context;
	unsigned int verb;
	int i, bytes, err;

	if (!codec_is_running(codec))
		return codec->lazy_cache ? 0 : -EAGAIN;

	reg &= ~0x00080000U; /* drop GET bit */
	reg |= (codec->addr << 28);
	verb = get_verb(reg);

	switch (verb & 0xf00) {
	case AC_VERB_SET_AMP_GAIN_MUTE:
		verb = AC_VERB_SET_AMP_GAIN_MUTE;
		if (reg & AC_AMP_GET_LEFT)
			verb |= AC_AMP_SET_LEFT >> 8;
		else
			verb |= AC_AMP_SET_RIGHT >> 8;
		if (reg & AC_AMP_GET_OUTPUT) {
			verb |= AC_AMP_SET_OUTPUT >> 8;
		} else {
			verb |= AC_AMP_SET_INPUT >> 8;
			verb |= reg & 0xf;
		}
		break;
	}

	switch (verb) {
	case AC_VERB_SET_DIGI_CONVERT_1:
		bytes = 2;
		break;
	case AC_VERB_SET_CONFIG_DEFAULT_BYTES_0:
		bytes = 4;
		break;
	default:
		bytes = 1;
		break;
	}

	for (i = 0; i < bytes; i++) {
		reg &= ~0xfffff;
		reg |= (verb + i) << 8 | ((val >> (8 * i)) & 0xff);
		err = snd_hdac_exec_verb(codec, reg, 0, NULL);
		if (err < 0)
			return err;
	}

	return 0;
}

static const struct regmap_config hda_regmap_cfg = {
	.name = "hdaudio",
	.reg_bits = 32,
	.val_bits = 32,
	.max_register = 0xfffffff,
	.writeable_reg = hda_writeable_reg,
	.readable_reg = hda_readable_reg,
	.volatile_reg = hda_volatile_reg,
	.cache_type = REGCACHE_RBTREE,
	.reg_read = hda_reg_read,
	.reg_write = hda_reg_write,
};

int snd_hdac_regmap_init(struct hdac_device *codec)
{
	struct regmap *regmap;

	regmap = regmap_init(&codec->dev, NULL, codec, &hda_regmap_cfg);
	if (IS_ERR(regmap))
		return PTR_ERR(regmap);
	codec->regmap = regmap;
	snd_array_init(&codec->vendor_verbs, sizeof(unsigned int), 8);
	return 0;
}
EXPORT_SYMBOL_GPL(snd_hdac_regmap_init);

void snd_hdac_regmap_exit(struct hdac_device *codec)
{
	if (codec->regmap) {
		regmap_exit(codec->regmap);
		codec->regmap = NULL;
		snd_array_free(&codec->vendor_verbs);
	}
}
EXPORT_SYMBOL_GPL(snd_hdac_regmap_exit);

/**
 * snd_hdac_regmap_add_vendor_verb - add a vendor-specific verb to regmap
 * @codec: the codec object
 * @verb: verb to allow accessing via regmap
 *
 * Returns zero for success or a negative error code.
 */
int snd_hdac_regmap_add_vendor_verb(struct hdac_device *codec,
				    unsigned int verb)
{
	unsigned int *p = snd_array_new(&codec->vendor_verbs);

	if (!p)
		return -ENOMEM;
	*p = verb;
	return 0;
}
EXPORT_SYMBOL_GPL(snd_hdac_regmap_add_vendor_verb);

/*
 * helper functions
 */

/* write a pseudo-register value (w/o power sequence) */
static int reg_raw_write(struct hdac_device *codec, unsigned int reg,
			 unsigned int val)
{
	if (!codec->regmap)
		return hda_reg_write(codec, reg, val);
	else
		return regmap_write(codec->regmap, reg, val);
}

/**
 * snd_hdac_regmap_write_raw - write a pseudo register with power mgmt
 * @codec: the codec object
 * @reg: pseudo register
 * @val: value to write
 *
 * Returns zero if successful or a negative error code.
 */
int snd_hdac_regmap_write_raw(struct hdac_device *codec, unsigned int reg,
			      unsigned int val)
{
	int err;

	err = reg_raw_write(codec, reg, val);
	if (err == -EAGAIN) {
		snd_hdac_power_up(codec);
		err = reg_raw_write(codec, reg, val);
		snd_hdac_power_down(codec);
	}
	return err;
}
EXPORT_SYMBOL_GPL(snd_hdac_regmap_write_raw);

static int reg_raw_read(struct hdac_device *codec, unsigned int reg,
			unsigned int *val)
{
	if (!codec->regmap)
		return hda_reg_read(codec, reg, val);
	else
		return regmap_read(codec->regmap, reg, val);
}

/**
 * snd_hdac_regmap_read_raw - read a pseudo register with power mgmt
 * @codec: the codec object
 * @reg: pseudo register
 * @val: pointer to store the read value
 *
 * Returns zero if successful or a negative error code.
 */
int snd_hdac_regmap_read_raw(struct hdac_device *codec, unsigned int reg,
			     unsigned int *val)
{
	int err;

	err = reg_raw_read(codec, reg, val);
	if (err == -EAGAIN) {
		snd_hdac_power_up(codec);
		err = reg_raw_read(codec, reg, val);
		snd_hdac_power_down(codec);
	}
	return err;
}
EXPORT_SYMBOL_GPL(snd_hdac_regmap_read_raw);

/**
 * snd_hdac_regmap_update_raw - update a pseudo register with power mgmt
 * @codec: the codec object
 * @reg: pseudo register
 * @mask: bit mask to udpate
 * @val: value to update
 *
 * Returns zero if successful or a negative error code.
 */
int snd_hdac_regmap_update_raw(struct hdac_device *codec, unsigned int reg,
			       unsigned int mask, unsigned int val)
{
	unsigned int orig;
	int err;

	val &= mask;
	err = snd_hdac_regmap_read_raw(codec, reg, &orig);
	if (err < 0)
		return err;
	val |= orig & ~mask;
	if (val == orig)
		return 0;
	err = snd_hdac_regmap_write_raw(codec, reg, val);
	if (err < 0)
		return err;
	return 1;
}
EXPORT_SYMBOL_GPL(snd_hdac_regmap_update_raw);
Commit	Line	Data
4d75faa0 TI	1	/*
	2	* Regmap support for HD-audio verbs
	3	*
	4	* A virtual register is translated to one or more hda verbs for write,
	5	* vice versa for read.
	6	*
	7	* A few limitations:
	8	* - Provided for not all verbs but only subset standard non-volatile verbs.
	9	* - For reading, only AC_VERB_GET_* variants can be used.
	10	* - For writing, mapped to the corresponding AC_VERB_SET_* variants,
	11	* so can't handle asymmetric verbs for read and write
	12	*/
	13
	14	#include <linux/slab.h>
	15	#include <linux/device.h>
	16	#include <linux/regmap.h>
	17	#include <linux/export.h>
	18	#include <linux/pm.h>
	19	#include <linux/pm_runtime.h>
	20	#include <sound/core.h>
	21	#include <sound/hdaudio.h>
	22	#include <sound/hda_regmap.h>
	23
	24	#ifdef CONFIG_PM
	25	#define codec_is_running(codec) \
	26	(atomic_read(&(codec)->in_pm) \|\| \
	27	!pm_runtime_suspended(&(codec)->dev))
	28	#else
	29	#define codec_is_running(codec) true
	30	#endif
	31
	32	#define get_verb(reg) (((reg) >> 8) & 0xfff)
	33
	34	static bool hda_volatile_reg(struct device *dev, unsigned int reg)
	35	{
	36	unsigned int verb = get_verb(reg);
	37
	38	switch (verb) {
	39	case AC_VERB_GET_PROC_COEF:
	40	case AC_VERB_GET_COEF_INDEX:
	41	case AC_VERB_GET_PROC_STATE:
	42	case AC_VERB_GET_POWER_STATE:
	43	case AC_VERB_GET_PIN_SENSE:
	44	case AC_VERB_GET_HDMI_DIP_SIZE:
	45	case AC_VERB_GET_HDMI_ELDD:
	46	case AC_VERB_GET_HDMI_DIP_INDEX:
	47	case AC_VERB_GET_HDMI_DIP_DATA:
	48	case AC_VERB_GET_HDMI_DIP_XMIT:
	49	case AC_VERB_GET_HDMI_CP_CTRL:
	50	case AC_VERB_GET_HDMI_CHAN_SLOT:
	51	case AC_VERB_GET_DEVICE_SEL:
	52	case AC_VERB_GET_DEVICE_LIST: /* read-only volatile */
	53	return true;
	54	}
	55
	56	return false;
	57	}
	58
	59	static bool hda_writeable_reg(struct device *dev, unsigned int reg)
	60	{
faa75f8a	61	struct hdac_device *codec = dev_to_hdac_dev(dev);
4d75faa0	62	unsigned int verb = get_verb(reg);
5e56bcea TI	63	int i;
	64
	65	for (i = 0; i < codec->vendor_verbs.used; i++) {
	66	unsigned int *v = snd_array_elem(&codec->vendor_verbs, i);
	67	if (verb == *v)
	68	return true;
	69	}
4d75faa0	70
faa75f8a TI	71	if (codec->caps_overwriting)
	72	return true;
	73
4d75faa0 TI	74	switch (verb & 0xf00) {
	75	case AC_VERB_GET_STREAM_FORMAT:
	76	case AC_VERB_GET_AMP_GAIN_MUTE:
	77	return true;
	78	case 0xf00:
	79	break;
	80	default:
	81	return false;
	82	}
	83
	84	switch (verb) {
	85	case AC_VERB_GET_CONNECT_SEL:
	86	case AC_VERB_GET_SDI_SELECT:
	87	case AC_VERB_GET_CONV:
	88	case AC_VERB_GET_PIN_WIDGET_CONTROL:
	89	case AC_VERB_GET_UNSOLICITED_RESPONSE: /* only as SET_UNSOLICITED_ENABLE */
	90	case AC_VERB_GET_BEEP_CONTROL:
	91	case AC_VERB_GET_EAPD_BTLENABLE:
	92	case AC_VERB_GET_DIGI_CONVERT_1:
	93	case AC_VERB_GET_DIGI_CONVERT_2: /* only for beep control */
	94	case AC_VERB_GET_VOLUME_KNOB_CONTROL:
	95	case AC_VERB_GET_CONFIG_DEFAULT:
	96	case AC_VERB_GET_GPIO_MASK:
	97	case AC_VERB_GET_GPIO_DIRECTION:
	98	case AC_VERB_GET_GPIO_DATA: /* not for volatile read */
	99	case AC_VERB_GET_GPIO_WAKE_MASK:
	100	case AC_VERB_GET_GPIO_UNSOLICITED_RSP_MASK:
	101	case AC_VERB_GET_GPIO_STICKY_MASK:
	102	case AC_VERB_GET_CVT_CHAN_COUNT:
	103	return true;
	104	}
	105
	106	return false;
	107	}
	108
	109	static bool hda_readable_reg(struct device *dev, unsigned int reg)
	110	{
faa75f8a	111	struct hdac_device *codec = dev_to_hdac_dev(dev);
4d75faa0 TI	112	unsigned int verb = get_verb(reg);
4d75faa0 TI	113
faa75f8a TI	114	if (codec->caps_overwriting)
	115	return true;
	116
4d75faa0 TI	117	switch (verb) {
	118	case AC_VERB_PARAMETERS:
	119	case AC_VERB_GET_CONNECT_LIST:
	120	case AC_VERB_GET_SUBSYSTEM_ID:
	121	return true;
	122	}
	123
	124	return hda_writeable_reg(dev, reg);
	125	}
	126
	127	static int hda_reg_read(void context, unsigned int reg, unsigned int val)
	128	{
	129	struct hdac_device *codec = context;
	130
	131	if (!codec_is_running(codec))
	132	return -EAGAIN;
	133	reg \|= (codec->addr << 28);
	134	return snd_hdac_exec_verb(codec, reg, 0, val);
	135	}
	136
	137	static int hda_reg_write(void *context, unsigned int reg, unsigned int val)
	138	{
	139	struct hdac_device *codec = context;
	140	unsigned int verb;
	141	int i, bytes, err;
	142
	143	if (!codec_is_running(codec))
	144	return codec->lazy_cache ? 0 : -EAGAIN;
	145
	146	reg &= ~0x00080000U; /* drop GET bit */
	147	reg \|= (codec->addr << 28);
	148	verb = get_verb(reg);
	149
	150	switch (verb & 0xf00) {
	151	case AC_VERB_SET_AMP_GAIN_MUTE:
	152	verb = AC_VERB_SET_AMP_GAIN_MUTE;
	153	if (reg & AC_AMP_GET_LEFT)
	154	verb \|= AC_AMP_SET_LEFT >> 8;
	155	else
	156	verb \|= AC_AMP_SET_RIGHT >> 8;
	157	if (reg & AC_AMP_GET_OUTPUT) {
	158	verb \|= AC_AMP_SET_OUTPUT >> 8;
	159	} else {
	160	verb \|= AC_AMP_SET_INPUT >> 8;
	161	verb \|= reg & 0xf;
	162	}
	163	break;
	164	}
	165
	166	switch (verb) {
	167	case AC_VERB_SET_DIGI_CONVERT_1:
	168	bytes = 2;
	169	break;
	170	case AC_VERB_SET_CONFIG_DEFAULT_BYTES_0:
	171	bytes = 4;
	172	break;
	173	default:
	174	bytes = 1;
	175	break;
	176	}
	177
	178	for (i = 0; i < bytes; i++) {
	179	reg &= ~0xfffff;
	180	reg \|= (verb + i) << 8 \| ((val >> (8 * i)) & 0xff);
181	err = snd_hdac_exec_verb(codec, reg, 0, NULL);
182	if (err < 0)
183	return err;
184	}
185
186	return 0;
187	}
188
189	static const struct regmap_config hda_regmap_cfg = {
190	.name = "hdaudio",
191	.reg_bits = 32,
192	.val_bits = 32,
193	.max_register = 0xfffffff,
194	.writeable_reg = hda_writeable_reg,
195	.readable_reg = hda_readable_reg,
196	.volatile_reg = hda_volatile_reg,
197	.cache_type = REGCACHE_RBTREE,
198	.reg_read = hda_reg_read,
199	.reg_write = hda_reg_write,
200	};
201
202	int snd_hdac_regmap_init(struct hdac_device *codec)
203	{
204	struct regmap *regmap;
205
206	regmap = regmap_init(&codec->dev, NULL, codec, &hda_regmap_cfg);
207	if (IS_ERR(regmap))
208	return PTR_ERR(regmap);
209	codec->regmap = regmap;
5e56bcea	210	snd_array_init(&codec->vendor_verbs, sizeof(unsigned int), 8);
4d75faa0 TI	211	return 0;
	212	}
	213	EXPORT_SYMBOL_GPL(snd_hdac_regmap_init);
	214
	215	void snd_hdac_regmap_exit(struct hdac_device *codec)
	216	{
	217	if (codec->regmap) {
	218	regmap_exit(codec->regmap);
	219	codec->regmap = NULL;
5e56bcea	220	snd_array_free(&codec->vendor_verbs);
4d75faa0 TI	221	}
	222	}
	223	EXPORT_SYMBOL_GPL(snd_hdac_regmap_exit);
	224
5e56bcea TI	225	/**
	226	* snd_hdac_regmap_add_vendor_verb - add a vendor-specific verb to regmap
	227	* @codec: the codec object
	228	* @verb: verb to allow accessing via regmap
	229	*
	230	* Returns zero for success or a negative error code.
	231	*/
	232	int snd_hdac_regmap_add_vendor_verb(struct hdac_device *codec,
	233	unsigned int verb)
	234	{
	235	unsigned int *p = snd_array_new(&codec->vendor_verbs);
	236
	237	if (!p)
	238	return -ENOMEM;
	239	*p = verb;
	240	return 0;
	241	}
	242	EXPORT_SYMBOL_GPL(snd_hdac_regmap_add_vendor_verb);
	243
4d75faa0 TI	244	/*
	245	* helper functions
	246	*/
	247
	248	/* write a pseudo-register value (w/o power sequence) */
	249	static int reg_raw_write(struct hdac_device *codec, unsigned int reg,
	250	unsigned int val)
	251	{
	252	if (!codec->regmap)
	253	return hda_reg_write(codec, reg, val);
	254	else
	255	return regmap_write(codec->regmap, reg, val);
	256	}
	257
	258	/**
	259	* snd_hdac_regmap_write_raw - write a pseudo register with power mgmt
	260	* @codec: the codec object
	261	* @reg: pseudo register
	262	* @val: value to write
	263	*
	264	* Returns zero if successful or a negative error code.
	265	*/
	266	int snd_hdac_regmap_write_raw(struct hdac_device *codec, unsigned int reg,
	267	unsigned int val)
	268	{
	269	int err;
	270
	271	err = reg_raw_write(codec, reg, val);
	272	if (err == -EAGAIN) {
	273	snd_hdac_power_up(codec);
	274	err = reg_raw_write(codec, reg, val);
	275	snd_hdac_power_down(codec);
	276	}
	277	return err;
	278	}
	279	EXPORT_SYMBOL_GPL(snd_hdac_regmap_write_raw);
	280
	281	static int reg_raw_read(struct hdac_device *codec, unsigned int reg,
	282	unsigned int *val)
	283	{
	284	if (!codec->regmap)
	285	return hda_reg_read(codec, reg, val);
	286	else
	287	return regmap_read(codec->regmap, reg, val);
	288	}
	289
	290	/**
	291	* snd_hdac_regmap_read_raw - read a pseudo register with power mgmt
	292	* @codec: the codec object
	293	* @reg: pseudo register
	294	* @val: pointer to store the read value
	295	*
	296	* Returns zero if successful or a negative error code.
	297	*/
	298	int snd_hdac_regmap_read_raw(struct hdac_device *codec, unsigned int reg,
	299	unsigned int *val)
	300	{
	301	int err;
	302
	303	err = reg_raw_read(codec, reg, val);
	304	if (err == -EAGAIN) {
	305	snd_hdac_power_up(codec);
	306	err = reg_raw_read(codec, reg, val);
	307	snd_hdac_power_down(codec);
308	}
309	return err;
310	}
311	EXPORT_SYMBOL_GPL(snd_hdac_regmap_read_raw);
312
313	/**
314	* snd_hdac_regmap_update_raw - update a pseudo register with power mgmt
315	* @codec: the codec object
316	* @reg: pseudo register
317	* @mask: bit mask to udpate
318	* @val: value to update
319	*
320	* Returns zero if successful or a negative error code.
321	*/
322	int snd_hdac_regmap_update_raw(struct hdac_device *codec, unsigned int reg,
323	unsigned int mask, unsigned int val)
324	{
325	unsigned int orig;
326	int err;
327
328	val &= mask;
329	err = snd_hdac_regmap_read_raw(codec, reg, &orig);
330	if (err < 0)
331	return err;
332	val \|= orig & ~mask;
333	if (val == orig)
334	return 0;
335	err = snd_hdac_regmap_write_raw(codec, reg, val);
336	if (err < 0)
337	return err;
338	return 1;
339	}
340	EXPORT_SYMBOL_GPL(snd_hdac_regmap_update_raw);