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

// SPDX-License-Identifier: GPL-2.0-only
/*
 * 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>
#include "local.h"

static int codec_pm_lock(struct hdac_device *codec)
{
	return snd_hdac_keep_power_up(codec);
}

static void codec_pm_unlock(struct hdac_device *codec, int lock)
{
	if (lock == 1)
		snd_hdac_power_down_pm(codec);
}

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

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

	switch (verb) {
	case AC_VERB_GET_PROC_COEF:
		return !codec->cache_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);
	const unsigned int *v;
	int i;

	snd_array_for_each(&codec->vendor_verbs, i, v) {
		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 AC_VERB_GET_PROC_COEF:
		return codec->cache_coef;
	case 0xf00:
		break;
	default:
		return false;
	}

	switch (verb) {
	case AC_VERB_GET_CONNECT_SEL:
	case AC_VERB_GET_SDI_SELECT:
	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_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:
		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;
	/* below are basically writable, but disabled for reducing unnecessary
	 * writes at sync
	 */
	case AC_VERB_GET_CONFIG_DEFAULT: /* usually just read */
	case AC_VERB_GET_CONV: /* managed in PCM code */
	case AC_VERB_GET_CVT_CHAN_COUNT: /* managed in HDMI CA code */
		return true;
	}

	return hda_writeable_reg(dev, reg);
}

/*
 * Stereo amp pseudo register:
 * for making easier to handle the stereo volume control, we provide a
 * fake register to deal both left and right channels by a single
 * (pseudo) register access.  A verb consisting of SET_AMP_GAIN with
 * *both* SET_LEFT and SET_RIGHT bits takes a 16bit value, the lower 8bit
 * for the left and the upper 8bit for the right channel.
 */
static bool is_stereo_amp_verb(unsigned int reg)
{
	if (((reg >> 8) & 0x700) != AC_VERB_SET_AMP_GAIN_MUTE)
		return false;
	return (reg & (AC_AMP_SET_LEFT | AC_AMP_SET_RIGHT)) ==
		(AC_AMP_SET_LEFT | AC_AMP_SET_RIGHT);
}

/* read a pseudo stereo amp register (16bit left+right) */
static int hda_reg_read_stereo_amp(struct hdac_device *codec,
				   unsigned int reg, unsigned int *val)
{
	unsigned int left, right;
	int err;

	reg &= ~(AC_AMP_SET_LEFT | AC_AMP_SET_RIGHT);
	err = snd_hdac_exec_verb(codec, reg | AC_AMP_GET_LEFT, 0, &left);
	if (err < 0)
		return err;
	err = snd_hdac_exec_verb(codec, reg | AC_AMP_GET_RIGHT, 0, &right);
	if (err < 0)
		return err;
	*val = left | (right << 8);
	return 0;
}

/* write a pseudo stereo amp register (16bit left+right) */
static int hda_reg_write_stereo_amp(struct hdac_device *codec,
				    unsigned int reg, unsigned int val)
{
	int err;
	unsigned int verb, left, right;

	verb = AC_VERB_SET_AMP_GAIN_MUTE << 8;
	if (reg & AC_AMP_GET_OUTPUT)
		verb |= AC_AMP_SET_OUTPUT;
	else
		verb |= AC_AMP_SET_INPUT | ((reg & 0xf) << 8);
	reg = (reg & ~0xfffff) | verb;

	left = val & 0xff;
	right = (val >> 8) & 0xff;
	if (left == right) {
		reg |= AC_AMP_SET_LEFT | AC_AMP_SET_RIGHT;
		return snd_hdac_exec_verb(codec, reg | left, 0, NULL);
	}

	err = snd_hdac_exec_verb(codec, reg | AC_AMP_SET_LEFT | left, 0, NULL);
	if (err < 0)
		return err;
	err = snd_hdac_exec_verb(codec, reg | AC_AMP_SET_RIGHT | right, 0, NULL);
	if (err < 0)
		return err;
	return 0;
}

/* read a pseudo coef register (16bit) */
static int hda_reg_read_coef(struct hdac_device *codec, unsigned int reg,
			     unsigned int *val)
{
	unsigned int verb;
	int err;

	if (!codec->cache_coef)
		return -EINVAL;
	/* LSB 8bit = coef index */
	verb = (reg & ~0xfff00) | (AC_VERB_SET_COEF_INDEX << 8);
	err = snd_hdac_exec_verb(codec, verb, 0, NULL);
	if (err < 0)
		return err;
	verb = (reg & ~0xfffff) | (AC_VERB_GET_COEF_INDEX << 8);
	return snd_hdac_exec_verb(codec, verb, 0, val);
}

/* write a pseudo coef register (16bit) */
static int hda_reg_write_coef(struct hdac_device *codec, unsigned int reg,
			      unsigned int val)
{
	unsigned int verb;
	int err;

	if (!codec->cache_coef)
		return -EINVAL;
	/* LSB 8bit = coef index */
	verb = (reg & ~0xfff00) | (AC_VERB_SET_COEF_INDEX << 8);
	err = snd_hdac_exec_verb(codec, verb, 0, NULL);
	if (err < 0)
		return err;
	verb = (reg & ~0xfffff) | (AC_VERB_GET_COEF_INDEX << 8) |
		(val & 0xffff);
	return snd_hdac_exec_verb(codec, verb, 0, NULL);
}

static int hda_reg_read(void *context, unsigned int reg, unsigned int *val)
{
	struct hdac_device *codec = context;
	int verb = get_verb(reg);
	int err;
	int pm_lock = 0;

	if (verb != AC_VERB_GET_POWER_STATE) {
		pm_lock = codec_pm_lock(codec);
		if (pm_lock < 0)
			return -EAGAIN;
	}
	reg |= (codec->addr << 28);
	if (is_stereo_amp_verb(reg)) {
		err = hda_reg_read_stereo_amp(codec, reg, val);
		goto out;
	}
	if (verb == AC_VERB_GET_PROC_COEF) {
		err = hda_reg_read_coef(codec, reg, val);
		goto out;
	}
	if ((verb & 0x700) == AC_VERB_SET_AMP_GAIN_MUTE)
		reg &= ~AC_AMP_FAKE_MUTE;

	err = snd_hdac_exec_verb(codec, reg, 0, val);
	if (err < 0)
		goto out;
	/* special handling for asymmetric reads */
	if (verb == AC_VERB_GET_POWER_STATE) {
		if (*val & AC_PWRST_ERROR)
			*val = -1;
		else /* take only the actual state */
			*val = (*val >> 4) & 0x0f;
	}
 out:
	codec_pm_unlock(codec, pm_lock);
	return err;
}

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;
	int pm_lock = 0;

	if (codec->caps_overwriting)
		return 0;

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

	if (verb != AC_VERB_SET_POWER_STATE) {
		pm_lock = codec_pm_lock(codec);
		if (pm_lock < 0)
			return codec->lazy_cache ? 0 : -EAGAIN;
	}

	if (is_stereo_amp_verb(reg)) {
		err = hda_reg_write_stereo_amp(codec, reg, val);
		goto out;
	}

	if (verb == AC_VERB_SET_PROC_COEF) {
		err = hda_reg_write_coef(codec, reg, val);
		goto out;
	}

	switch (verb & 0xf00) {
	case AC_VERB_SET_AMP_GAIN_MUTE:
		if ((reg & AC_AMP_FAKE_MUTE) && (val & AC_AMP_MUTE))
			val = 0;
		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)
			goto out;
	}

 out:
	codec_pm_unlock(codec, pm_lock);
	return err;
}

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,
	.use_single_read = true,
	.use_single_write = true,
	.disable_locking = true,
};

/**
 * snd_hdac_regmap_init - Initialize regmap for HDA register accesses
 * @codec: the codec object
 *
 * Returns zero for success or a negative error code.
 */
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);

/**
 * snd_hdac_regmap_exit - Release the regmap from HDA codec
 * @codec: the codec object
 */
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 | 0x800; /* set GET bit */
	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)
{
	int err;

	mutex_lock(&codec->regmap_lock);
	if (!codec->regmap)
		err = hda_reg_write(codec, reg, val);
	else
		err = regmap_write(codec->regmap, reg, val);
	mutex_unlock(&codec->regmap_lock);
	return err;
}

/* a helper macro to call @func_call; retry with power-up if failed */
#define CALL_RAW_FUNC(codec, func_call)				\
	({							\
		int _err = func_call;				\
		if (_err == -EAGAIN) {				\
			_err = snd_hdac_power_up_pm(codec);	\
			if (_err >= 0)				\
				_err = func_call;		\
			snd_hdac_power_down_pm(codec);		\
		}						\
		_err;})

/**
 * 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)
{
	return CALL_RAW_FUNC(codec, reg_raw_write(codec, reg, val));
}
EXPORT_SYMBOL_GPL(snd_hdac_regmap_write_raw);

static int reg_raw_read(struct hdac_device *codec, unsigned int reg,
			unsigned int *val, bool uncached)
{
	int err;

	mutex_lock(&codec->regmap_lock);
	if (uncached || !codec->regmap)
		err = hda_reg_read(codec, reg, val);
	else
		err = regmap_read(codec->regmap, reg, val);
	mutex_unlock(&codec->regmap_lock);
	return err;
}

static int __snd_hdac_regmap_read_raw(struct hdac_device *codec,
				      unsigned int reg, unsigned int *val,
				      bool uncached)
{
	return CALL_RAW_FUNC(codec, reg_raw_read(codec, reg, val, uncached));
}

/**
 * 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)
{
	return __snd_hdac_regmap_read_raw(codec, reg, val, false);
}
EXPORT_SYMBOL_GPL(snd_hdac_regmap_read_raw);

/* Works like snd_hdac_regmap_read_raw(), but this doesn't read from the
 * cache but always via hda verbs.
 */
int snd_hdac_regmap_read_raw_uncached(struct hdac_device *codec,
				      unsigned int reg, unsigned int *val)
{
	return __snd_hdac_regmap_read_raw(codec, reg, val, true);
}

static int reg_raw_update(struct hdac_device *codec, unsigned int reg,
			  unsigned int mask, unsigned int val)
{
	unsigned int orig;
	bool change;
	int err;

	mutex_lock(&codec->regmap_lock);
	if (codec->regmap) {
		err = regmap_update_bits_check(codec->regmap, reg, mask, val,
					       &change);
		if (!err)
			err = change ? 1 : 0;
	} else {
		err = hda_reg_read(codec, reg, &orig);
		if (!err) {
			val &= mask;
			val |= orig & ~mask;
			if (val != orig) {
				err = hda_reg_write(codec, reg, val);
				if (!err)
					err = 1;
			}
		}
	}
	mutex_unlock(&codec->regmap_lock);
	return err;
}

/**
 * snd_hdac_regmap_update_raw - update a pseudo register with power mgmt
 * @codec: the codec object
 * @reg: pseudo register
 * @mask: bit mask to update
 * @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)
{
	return CALL_RAW_FUNC(codec, reg_raw_update(codec, reg, mask, val));
}
EXPORT_SYMBOL_GPL(snd_hdac_regmap_update_raw);

static int reg_raw_update_once(struct hdac_device *codec, unsigned int reg,
			       unsigned int mask, unsigned int val)
{
	unsigned int orig;
	int err;

	if (!codec->regmap)
		return reg_raw_update(codec, reg, mask, val);

	mutex_lock(&codec->regmap_lock);
	regcache_cache_only(codec->regmap, true);
	err = regmap_read(codec->regmap, reg, &orig);
	regcache_cache_only(codec->regmap, false);
	if (err < 0)
		err = regmap_update_bits(codec->regmap, reg, mask, val);
	mutex_unlock(&codec->regmap_lock);
	return err;
}

/**
 * snd_hdac_regmap_update_raw_once - initialize the register value only once
 * @codec: the codec object
 * @reg: pseudo register
 * @mask: bit mask to update
 * @val: value to update
 *
 * Performs the update of the register bits only once when the register
 * hasn't been initialized yet.  Used in HD-audio legacy driver.
 * Returns zero if successful or a negative error code
 */
int snd_hdac_regmap_update_raw_once(struct hdac_device *codec, unsigned int reg,
				    unsigned int mask, unsigned int val)
{
	return CALL_RAW_FUNC(codec, reg_raw_update_once(codec, reg, mask, val));
}
EXPORT_SYMBOL_GPL(snd_hdac_regmap_update_raw_once);

/**
 * snd_hdac_regmap_sync - sync out the cached values for PM resume
 * @codec: the codec object
 */
void snd_hdac_regmap_sync(struct hdac_device *codec)
{
	if (codec->regmap) {
		mutex_lock(&codec->regmap_lock);
		regcache_sync(codec->regmap);
		mutex_unlock(&codec->regmap_lock);
	}
}
EXPORT_SYMBOL_GPL(snd_hdac_regmap_sync);
Commit	Line	Data
457c8996	1	// SPDX-License-Identifier: GPL-2.0-only
4d75faa0 TI	2	/*
	3	* Regmap support for HD-audio verbs
	4	*
	5	* A virtual register is translated to one or more hda verbs for write,
	6	* vice versa for read.
	7	*
	8	* A few limitations:
	9	* - Provided for not all verbs but only subset standard non-volatile verbs.
	10	* - For reading, only AC_VERB_GET_* variants can be used.
	11	* - For writing, mapped to the corresponding AC_VERB_SET_* variants,
	12	* so can't handle asymmetric verbs for read and write
	13	*/
	14
	15	#include <linux/slab.h>
	16	#include <linux/device.h>
	17	#include <linux/regmap.h>
	18	#include <linux/export.h>
	19	#include <linux/pm.h>
	20	#include <linux/pm_runtime.h>
	21	#include <sound/core.h>
	22	#include <sound/hdaudio.h>
	23	#include <sound/hda_regmap.h>
ddf7cb83	24	#include "local.h"
4d75faa0	25
fc4f000b TI	26	static int codec_pm_lock(struct hdac_device *codec)
	27	{
	28	return snd_hdac_keep_power_up(codec);
	29	}
	30
	31	static void codec_pm_unlock(struct hdac_device *codec, int lock)
	32	{
	33	if (lock == 1)
	34	snd_hdac_power_down_pm(codec);
	35	}
4d75faa0 TI	36
	37	#define get_verb(reg) (((reg) >> 8) & 0xfff)
	38
	39	static bool hda_volatile_reg(struct device *dev, unsigned int reg)
	40	{
40ba66a7	41	struct hdac_device *codec = dev_to_hdac_dev(dev);
4d75faa0 TI	42	unsigned int verb = get_verb(reg);
	43
	44	switch (verb) {
	45	case AC_VERB_GET_PROC_COEF:
40ba66a7	46	return !codec->cache_coef;
4d75faa0 TI	47	case AC_VERB_GET_COEF_INDEX:
	48	case AC_VERB_GET_PROC_STATE:
	49	case AC_VERB_GET_POWER_STATE:
	50	case AC_VERB_GET_PIN_SENSE:
	51	case AC_VERB_GET_HDMI_DIP_SIZE:
	52	case AC_VERB_GET_HDMI_ELDD:
	53	case AC_VERB_GET_HDMI_DIP_INDEX:
	54	case AC_VERB_GET_HDMI_DIP_DATA:
	55	case AC_VERB_GET_HDMI_DIP_XMIT:
	56	case AC_VERB_GET_HDMI_CP_CTRL:
	57	case AC_VERB_GET_HDMI_CHAN_SLOT:
	58	case AC_VERB_GET_DEVICE_SEL:
	59	case AC_VERB_GET_DEVICE_LIST: /* read-only volatile */
	60	return true;
	61	}
	62
	63	return false;
	64	}
	65
	66	static bool hda_writeable_reg(struct device *dev, unsigned int reg)
	67	{
faa75f8a	68	struct hdac_device *codec = dev_to_hdac_dev(dev);
4d75faa0	69	unsigned int verb = get_verb(reg);
a9c2dfc8	70	const unsigned int *v;
5e56bcea TI	71	int i;
5e56bcea TI	72
a9c2dfc8	73	snd_array_for_each(&codec->vendor_verbs, i, v) {
5e56bcea TI	74	if (verb == *v)
	75	return true;
	76	}
4d75faa0	77
faa75f8a TI	78	if (codec->caps_overwriting)
	79	return true;
	80
4d75faa0 TI	81	switch (verb & 0xf00) {
	82	case AC_VERB_GET_STREAM_FORMAT:
	83	case AC_VERB_GET_AMP_GAIN_MUTE:
	84	return true;
40ba66a7 TI	85	case AC_VERB_GET_PROC_COEF:
40ba66a7 TI	86	return codec->cache_coef;
4d75faa0 TI	87	case 0xf00:
	88	break;
	89	default:
	90	return false;
	91	}
	92
	93	switch (verb) {
	94	case AC_VERB_GET_CONNECT_SEL:
	95	case AC_VERB_GET_SDI_SELECT:
4d75faa0 TI	96	case AC_VERB_GET_PIN_WIDGET_CONTROL:
	97	case AC_VERB_GET_UNSOLICITED_RESPONSE: /* only as SET_UNSOLICITED_ENABLE */
	98	case AC_VERB_GET_BEEP_CONTROL:
	99	case AC_VERB_GET_EAPD_BTLENABLE:
	100	case AC_VERB_GET_DIGI_CONVERT_1:
	101	case AC_VERB_GET_DIGI_CONVERT_2: /* only for beep control */
	102	case AC_VERB_GET_VOLUME_KNOB_CONTROL:
4d75faa0 TI	103	case AC_VERB_GET_GPIO_MASK:
	104	case AC_VERB_GET_GPIO_DIRECTION:
	105	case AC_VERB_GET_GPIO_DATA: /* not for volatile read */
	106	case AC_VERB_GET_GPIO_WAKE_MASK:
	107	case AC_VERB_GET_GPIO_UNSOLICITED_RSP_MASK:
	108	case AC_VERB_GET_GPIO_STICKY_MASK:
4d75faa0 TI	109	return true;
	110	}
	111
	112	return false;
	113	}
	114
	115	static bool hda_readable_reg(struct device *dev, unsigned int reg)
	116	{
faa75f8a	117	struct hdac_device *codec = dev_to_hdac_dev(dev);
4d75faa0 TI	118	unsigned int verb = get_verb(reg);
4d75faa0 TI	119
faa75f8a TI	120	if (codec->caps_overwriting)
	121	return true;
	122
4d75faa0 TI	123	switch (verb) {
	124	case AC_VERB_PARAMETERS:
	125	case AC_VERB_GET_CONNECT_LIST:
	126	case AC_VERB_GET_SUBSYSTEM_ID:
	127	return true;
8bc174e9 TI	128	/* below are basically writable, but disabled for reducing unnecessary
	129	* writes at sync
	130	*/
	131	case AC_VERB_GET_CONFIG_DEFAULT: /* usually just read */
	132	case AC_VERB_GET_CONV: /* managed in PCM code */
	133	case AC_VERB_GET_CVT_CHAN_COUNT: /* managed in HDMI CA code */
	134	return true;
4d75faa0 TI	135	}
	136
	137	return hda_writeable_reg(dev, reg);
	138	}
	139
d313e0a8 TI	140	/*
	141	* Stereo amp pseudo register:
	142	* for making easier to handle the stereo volume control, we provide a
	143	* fake register to deal both left and right channels by a single
	144	* (pseudo) register access. A verb consisting of SET_AMP_GAIN with
	145	* both SET_LEFT and SET_RIGHT bits takes a 16bit value, the lower 8bit
	146	* for the left and the upper 8bit for the right channel.
	147	*/
	148	static bool is_stereo_amp_verb(unsigned int reg)
	149	{
	150	if (((reg >> 8) & 0x700) != AC_VERB_SET_AMP_GAIN_MUTE)
	151	return false;
	152	return (reg & (AC_AMP_SET_LEFT \| AC_AMP_SET_RIGHT)) ==
	153	(AC_AMP_SET_LEFT \| AC_AMP_SET_RIGHT);
	154	}
	155
	156	/* read a pseudo stereo amp register (16bit left+right) */
	157	static int hda_reg_read_stereo_amp(struct hdac_device *codec,
	158	unsigned int reg, unsigned int *val)
	159	{
	160	unsigned int left, right;
	161	int err;
	162
	163	reg &= ~(AC_AMP_SET_LEFT \| AC_AMP_SET_RIGHT);
	164	err = snd_hdac_exec_verb(codec, reg \| AC_AMP_GET_LEFT, 0, &left);
	165	if (err < 0)
	166	return err;
	167	err = snd_hdac_exec_verb(codec, reg \| AC_AMP_GET_RIGHT, 0, &right);
	168	if (err < 0)
	169	return err;
	170	*val = left \| (right << 8);
	171	return 0;
	172	}
	173
	174	/* write a pseudo stereo amp register (16bit left+right) */
	175	static int hda_reg_write_stereo_amp(struct hdac_device *codec,
	176	unsigned int reg, unsigned int val)
	177	{
	178	int err;
	179	unsigned int verb, left, right;
	180
	181	verb = AC_VERB_SET_AMP_GAIN_MUTE << 8;
	182	if (reg & AC_AMP_GET_OUTPUT)
	183	verb \|= AC_AMP_SET_OUTPUT;
	184	else
	185	verb \|= AC_AMP_SET_INPUT \| ((reg & 0xf) << 8);
	186	reg = (reg & ~0xfffff) \| verb;
	187
	188	left = val & 0xff;
	189	right = (val >> 8) & 0xff;
	190	if (left == right) {
	191	reg \|= AC_AMP_SET_LEFT \| AC_AMP_SET_RIGHT;
	192	return snd_hdac_exec_verb(codec, reg \| left, 0, NULL);
	193	}
	194
	195	err = snd_hdac_exec_verb(codec, reg \| AC_AMP_SET_LEFT \| left, 0, NULL);
	196	if (err < 0)
	197	return err;
	198	err = snd_hdac_exec_verb(codec, reg \| AC_AMP_SET_RIGHT \| right, 0, NULL);
	199	if (err < 0)
	200	return err;
	201	return 0;
	202	}
	203
40ba66a7 TI	204	/* read a pseudo coef register (16bit) */
	205	static int hda_reg_read_coef(struct hdac_device *codec, unsigned int reg,
	206	unsigned int *val)
	207	{
	208	unsigned int verb;
	209	int err;
	210
	211	if (!codec->cache_coef)
	212	return -EINVAL;
	213	/* LSB 8bit = coef index */
	214	verb = (reg & ~0xfff00) \| (AC_VERB_SET_COEF_INDEX << 8);
	215	err = snd_hdac_exec_verb(codec, verb, 0, NULL);
	216	if (err < 0)
	217	return err;
	218	verb = (reg & ~0xfffff) \| (AC_VERB_GET_COEF_INDEX << 8);
	219	return snd_hdac_exec_verb(codec, verb, 0, val);
	220	}
	221
	222	/* write a pseudo coef register (16bit) */
	223	static int hda_reg_write_coef(struct hdac_device *codec, unsigned int reg,
	224	unsigned int val)
	225	{
	226	unsigned int verb;
	227	int err;
	228
	229	if (!codec->cache_coef)
	230	return -EINVAL;
	231	/* LSB 8bit = coef index */
	232	verb = (reg & ~0xfff00) \| (AC_VERB_SET_COEF_INDEX << 8);
	233	err = snd_hdac_exec_verb(codec, verb, 0, NULL);
	234	if (err < 0)
	235	return err;
	236	verb = (reg & ~0xfffff) \| (AC_VERB_GET_COEF_INDEX << 8) \|
	237	(val & 0xffff);
	238	return snd_hdac_exec_verb(codec, verb, 0, NULL);
	239	}
	240
4d75faa0 TI	241	static int hda_reg_read(void context, unsigned int reg, unsigned int val)
	242	{
	243	struct hdac_device *codec = context;
40ba66a7	244	int verb = get_verb(reg);
33f81940	245	int err;
fc4f000b	246	int pm_lock = 0;
4d75faa0	247
fc4f000b TI	248	if (verb != AC_VERB_GET_POWER_STATE) {
	249	pm_lock = codec_pm_lock(codec);
	250	if (pm_lock < 0)
	251	return -EAGAIN;
	252	}
4d75faa0	253	reg \|= (codec->addr << 28);
fc4f000b TI	254	if (is_stereo_amp_verb(reg)) {
	255	err = hda_reg_read_stereo_amp(codec, reg, val);
	256	goto out;
	257	}
	258	if (verb == AC_VERB_GET_PROC_COEF) {
	259	err = hda_reg_read_coef(codec, reg, val);
	260	goto out;
	261	}
a686ec4c TI	262	if ((verb & 0x700) == AC_VERB_SET_AMP_GAIN_MUTE)
	263	reg &= ~AC_AMP_FAKE_MUTE;
	264
33f81940 TI	265	err = snd_hdac_exec_verb(codec, reg, 0, val);
33f81940 TI	266	if (err < 0)
fc4f000b	267	goto out;
33f81940	268	/* special handling for asymmetric reads */
40ba66a7	269	if (verb == AC_VERB_GET_POWER_STATE) {
33f81940 TI	270	if (*val & AC_PWRST_ERROR)
	271	*val = -1;
	272	else /* take only the actual state */
	273	val = (val >> 4) & 0x0f;
	274	}
fc4f000b TI	275	out:
	276	codec_pm_unlock(codec, pm_lock);
	277	return err;
4d75faa0 TI	278	}
	279
	280	static int hda_reg_write(void *context, unsigned int reg, unsigned int val)
	281	{
	282	struct hdac_device *codec = context;
	283	unsigned int verb;
	284	int i, bytes, err;
fc4f000b	285	int pm_lock = 0;
4d75faa0	286
98a226ed TI	287	if (codec->caps_overwriting)
	288	return 0;
	289
4d75faa0 TI	290	reg &= ~0x00080000U; /* drop GET bit */
4d75faa0 TI	291	reg \|= (codec->addr << 28);
9efe2731 TI	292	verb = get_verb(reg);
9efe2731 TI	293
fc4f000b TI	294	if (verb != AC_VERB_SET_POWER_STATE) {
	295	pm_lock = codec_pm_lock(codec);
	296	if (pm_lock < 0)
	297	return codec->lazy_cache ? 0 : -EAGAIN;
	298	}
4d75faa0	299
fc4f000b TI	300	if (is_stereo_amp_verb(reg)) {
	301	err = hda_reg_write_stereo_amp(codec, reg, val);
	302	goto out;
	303	}
d313e0a8	304
fc4f000b TI	305	if (verb == AC_VERB_SET_PROC_COEF) {
	306	err = hda_reg_write_coef(codec, reg, val);
	307	goto out;
	308	}
40ba66a7	309
4d75faa0 TI	310	switch (verb & 0xf00) {
4d75faa0 TI	311	case AC_VERB_SET_AMP_GAIN_MUTE:
a686ec4c TI	312	if ((reg & AC_AMP_FAKE_MUTE) && (val & AC_AMP_MUTE))
a686ec4c TI	313	val = 0;
4d75faa0 TI	314	verb = AC_VERB_SET_AMP_GAIN_MUTE;
	315	if (reg & AC_AMP_GET_LEFT)
	316	verb \|= AC_AMP_SET_LEFT >> 8;
	317	else
	318	verb \|= AC_AMP_SET_RIGHT >> 8;
	319	if (reg & AC_AMP_GET_OUTPUT) {
	320	verb \|= AC_AMP_SET_OUTPUT >> 8;
	321	} else {
	322	verb \|= AC_AMP_SET_INPUT >> 8;
	323	verb \|= reg & 0xf;
	324	}
	325	break;
	326	}
	327
	328	switch (verb) {
	329	case AC_VERB_SET_DIGI_CONVERT_1:
	330	bytes = 2;
	331	break;
	332	case AC_VERB_SET_CONFIG_DEFAULT_BYTES_0:
	333	bytes = 4;
	334	break;
	335	default:
	336	bytes = 1;
	337	break;
	338	}
	339
	340	for (i = 0; i < bytes; i++) {
	341	reg &= ~0xfffff;
	342	reg \|= (verb + i) << 8 \| ((val >> (8 * i)) & 0xff);
	343	err = snd_hdac_exec_verb(codec, reg, 0, NULL);
	344	if (err < 0)
fc4f000b	345	goto out;
4d75faa0 TI	346	}
4d75faa0 TI	347
fc4f000b TI	348	out:
	349	codec_pm_unlock(codec, pm_lock);
	350	return err;
4d75faa0 TI	351	}
	352
	353	static const struct regmap_config hda_regmap_cfg = {
	354	.name = "hdaudio",
	355	.reg_bits = 32,
	356	.val_bits = 32,
	357	.max_register = 0xfffffff,
	358	.writeable_reg = hda_writeable_reg,
	359	.readable_reg = hda_readable_reg,
	360	.volatile_reg = hda_volatile_reg,
	361	.cache_type = REGCACHE_RBTREE,
	362	.reg_read = hda_reg_read,
	363	.reg_write = hda_reg_write,
1c96a2f6 DF	364	.use_single_read = true,
1c96a2f6 DF	365	.use_single_write = true,
1a462be5	366	.disable_locking = true,
4d75faa0 TI	367	};
4d75faa0 TI	368
78dd5e21 TI	369	/**
	370	* snd_hdac_regmap_init - Initialize regmap for HDA register accesses
	371	* @codec: the codec object
	372	*
	373	* Returns zero for success or a negative error code.
	374	*/
4d75faa0 TI	375	int snd_hdac_regmap_init(struct hdac_device *codec)
	376	{
	377	struct regmap *regmap;
	378
	379	regmap = regmap_init(&codec->dev, NULL, codec, &hda_regmap_cfg);
	380	if (IS_ERR(regmap))
	381	return PTR_ERR(regmap);
	382	codec->regmap = regmap;
5e56bcea	383	snd_array_init(&codec->vendor_verbs, sizeof(unsigned int), 8);
4d75faa0 TI	384	return 0;
	385	}
	386	EXPORT_SYMBOL_GPL(snd_hdac_regmap_init);
	387
78dd5e21	388	/**
3531ba21	389	* snd_hdac_regmap_exit - Release the regmap from HDA codec
78dd5e21 TI	390	* @codec: the codec object
78dd5e21 TI	391	*/
4d75faa0 TI	392	void snd_hdac_regmap_exit(struct hdac_device *codec)
	393	{
	394	if (codec->regmap) {
	395	regmap_exit(codec->regmap);
	396	codec->regmap = NULL;
5e56bcea	397	snd_array_free(&codec->vendor_verbs);
4d75faa0 TI	398	}
	399	}
	400	EXPORT_SYMBOL_GPL(snd_hdac_regmap_exit);
	401
5e56bcea TI	402	/**
	403	* snd_hdac_regmap_add_vendor_verb - add a vendor-specific verb to regmap
	404	* @codec: the codec object
	405	* @verb: verb to allow accessing via regmap
	406	*
	407	* Returns zero for success or a negative error code.
	408	*/
	409	int snd_hdac_regmap_add_vendor_verb(struct hdac_device *codec,
	410	unsigned int verb)
	411	{
	412	unsigned int *p = snd_array_new(&codec->vendor_verbs);
	413
	414	if (!p)
	415	return -ENOMEM;
d6eb9e3e	416	p = verb \| 0x800; / set GET bit */
5e56bcea TI	417	return 0;
	418	}
	419	EXPORT_SYMBOL_GPL(snd_hdac_regmap_add_vendor_verb);
	420
4d75faa0 TI	421	/*
	422	* helper functions
	423	*/
	424
	425	/* write a pseudo-register value (w/o power sequence) */
	426	static int reg_raw_write(struct hdac_device *codec, unsigned int reg,
	427	unsigned int val)
	428	{
1a462be5 TI	429	int err;
	430
	431	mutex_lock(&codec->regmap_lock);
4d75faa0	432	if (!codec->regmap)
1a462be5	433	err = hda_reg_write(codec, reg, val);
4d75faa0	434	else
1a462be5 TI	435	err = regmap_write(codec->regmap, reg, val);
	436	mutex_unlock(&codec->regmap_lock);
	437	return err;
4d75faa0 TI	438	}
4d75faa0 TI	439
1a462be5 TI	440	/* a helper macro to call @func_call; retry with power-up if failed */
	441	#define CALL_RAW_FUNC(codec, func_call) \
	442	({ \
	443	int _err = func_call; \
	444	if (_err == -EAGAIN) { \
	445	_err = snd_hdac_power_up_pm(codec); \
	446	if (_err >= 0) \
	447	_err = func_call; \
	448	snd_hdac_power_down_pm(codec); \
	449	} \
	450	_err;})
	451
4d75faa0 TI	452	/**
	453	* snd_hdac_regmap_write_raw - write a pseudo register with power mgmt
	454	* @codec: the codec object
	455	* @reg: pseudo register
	456	* @val: value to write
	457	*
	458	* Returns zero if successful or a negative error code.
	459	*/
	460	int snd_hdac_regmap_write_raw(struct hdac_device *codec, unsigned int reg,
	461	unsigned int val)
	462	{
1a462be5	463	return CALL_RAW_FUNC(codec, reg_raw_write(codec, reg, val));
4d75faa0 TI	464	}
	465	EXPORT_SYMBOL_GPL(snd_hdac_regmap_write_raw);
	466
	467	static int reg_raw_read(struct hdac_device *codec, unsigned int reg,
3194ed49	468	unsigned int *val, bool uncached)
4d75faa0	469	{
1a462be5 TI	470	int err;
	471
	472	mutex_lock(&codec->regmap_lock);
3194ed49	473	if (uncached \|\| !codec->regmap)
1a462be5	474	err = hda_reg_read(codec, reg, val);
4d75faa0	475	else
1a462be5 TI	476	err = regmap_read(codec->regmap, reg, val);
	477	mutex_unlock(&codec->regmap_lock);
	478	return err;
4d75faa0 TI	479	}
4d75faa0 TI	480
3194ed49 TI	481	static int __snd_hdac_regmap_read_raw(struct hdac_device *codec,
	482	unsigned int reg, unsigned int *val,
	483	bool uncached)
	484	{
1a462be5	485	return CALL_RAW_FUNC(codec, reg_raw_read(codec, reg, val, uncached));
3194ed49 TI	486	}
3194ed49 TI	487
4d75faa0 TI	488	/**
	489	* snd_hdac_regmap_read_raw - read a pseudo register with power mgmt
	490	* @codec: the codec object
	491	* @reg: pseudo register
	492	* @val: pointer to store the read value
	493	*
	494	* Returns zero if successful or a negative error code.
	495	*/
	496	int snd_hdac_regmap_read_raw(struct hdac_device *codec, unsigned int reg,
	497	unsigned int *val)
	498	{
3194ed49	499	return __snd_hdac_regmap_read_raw(codec, reg, val, false);
4d75faa0 TI	500	}
	501	EXPORT_SYMBOL_GPL(snd_hdac_regmap_read_raw);
	502
3194ed49 TI	503	/* Works like snd_hdac_regmap_read_raw(), but this doesn't read from the
	504	* cache but always via hda verbs.
	505	*/
	506	int snd_hdac_regmap_read_raw_uncached(struct hdac_device *codec,
	507	unsigned int reg, unsigned int *val)
	508	{
	509	return __snd_hdac_regmap_read_raw(codec, reg, val, true);
	510	}
	511
1a462be5 TI	512	static int reg_raw_update(struct hdac_device *codec, unsigned int reg,
	513	unsigned int mask, unsigned int val)
	514	{
	515	unsigned int orig;
	516	bool change;
	517	int err;
	518
	519	mutex_lock(&codec->regmap_lock);
	520	if (codec->regmap) {
	521	err = regmap_update_bits_check(codec->regmap, reg, mask, val,
	522	&change);
	523	if (!err)
	524	err = change ? 1 : 0;
	525	} else {
	526	err = hda_reg_read(codec, reg, &orig);
	527	if (!err) {
	528	val &= mask;
	529	val \|= orig & ~mask;
	530	if (val != orig) {
	531	err = hda_reg_write(codec, reg, val);
	532	if (!err)
	533	err = 1;
	534	}
	535	}
	536	}
	537	mutex_unlock(&codec->regmap_lock);
	538	return err;
	539	}
	540
4d75faa0 TI	541	/**
	542	* snd_hdac_regmap_update_raw - update a pseudo register with power mgmt
	543	* @codec: the codec object
	544	* @reg: pseudo register
1a0986c1	545	* @mask: bit mask to update
4d75faa0 TI	546	* @val: value to update
	547	*
	548	* Returns zero if successful or a negative error code.
	549	*/
	550	int snd_hdac_regmap_update_raw(struct hdac_device *codec, unsigned int reg,
	551	unsigned int mask, unsigned int val)
1a462be5 TI	552	{
	553	return CALL_RAW_FUNC(codec, reg_raw_update(codec, reg, mask, val));
	554	}
	555	EXPORT_SYMBOL_GPL(snd_hdac_regmap_update_raw);
	556
	557	static int reg_raw_update_once(struct hdac_device *codec, unsigned int reg,
	558	unsigned int mask, unsigned int val)
4d75faa0 TI	559	{
	560	unsigned int orig;
	561	int err;
	562
1a462be5 TI	563	if (!codec->regmap)
	564	return reg_raw_update(codec, reg, mask, val);
	565
	566	mutex_lock(&codec->regmap_lock);
	567	regcache_cache_only(codec->regmap, true);
	568	err = regmap_read(codec->regmap, reg, &orig);
	569	regcache_cache_only(codec->regmap, false);
4d75faa0	570	if (err < 0)
1a462be5 TI	571	err = regmap_update_bits(codec->regmap, reg, mask, val);
	572	mutex_unlock(&codec->regmap_lock);
	573	return err;
4d75faa0	574	}
1a462be5 TI	575
	576	/**
	577	* snd_hdac_regmap_update_raw_once - initialize the register value only once
	578	* @codec: the codec object
	579	* @reg: pseudo register
	580	* @mask: bit mask to update
	581	* @val: value to update
	582	*
	583	* Performs the update of the register bits only once when the register
	584	* hasn't been initialized yet. Used in HD-audio legacy driver.
	585	* Returns zero if successful or a negative error code
	586	*/
	587	int snd_hdac_regmap_update_raw_once(struct hdac_device *codec, unsigned int reg,
	588	unsigned int mask, unsigned int val)
	589	{
	590	return CALL_RAW_FUNC(codec, reg_raw_update_once(codec, reg, mask, val));
	591	}
	592	EXPORT_SYMBOL_GPL(snd_hdac_regmap_update_raw_once);
	593
	594	/**
	595	* snd_hdac_regmap_sync - sync out the cached values for PM resume
	596	* @codec: the codec object
	597	*/
	598	void snd_hdac_regmap_sync(struct hdac_device *codec)
	599	{
	600	if (codec->regmap) {
	601	mutex_lock(&codec->regmap_lock);
	602	regcache_sync(codec->regmap);
	603	mutex_unlock(&codec->regmap_lock);
	604	}
	605	}
	606	EXPORT_SYMBOL_GPL(snd_hdac_regmap_sync);