1 // SPDX-License-Identifier: GPL-2.0-only
3 * Regmap support for HD-audio verbs
5 * A virtual register is translated to one or more hda verbs for write,
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
15 #include <linux/slab.h>
16 #include <linux/device.h>
17 #include <linux/regmap.h>
18 #include <linux/export.h>
20 #include <sound/core.h>
21 #include <sound/hdaudio.h>
22 #include <sound/hda_regmap.h>
25 static int codec_pm_lock(struct hdac_device *codec)
27 return snd_hdac_keep_power_up(codec);
30 static void codec_pm_unlock(struct hdac_device *codec, int lock)
33 snd_hdac_power_down_pm(codec);
36 #define get_verb(reg) (((reg) >> 8) & 0xfff)
38 static bool hda_volatile_reg(struct device *dev, unsigned int reg)
40 struct hdac_device *codec = dev_to_hdac_dev(dev);
41 unsigned int verb = get_verb(reg);
44 case AC_VERB_GET_PROC_COEF:
45 return !codec->cache_coef;
46 case AC_VERB_GET_COEF_INDEX:
47 case AC_VERB_GET_PROC_STATE:
48 case AC_VERB_GET_POWER_STATE:
49 case AC_VERB_GET_PIN_SENSE:
50 case AC_VERB_GET_HDMI_DIP_SIZE:
51 case AC_VERB_GET_HDMI_ELDD:
52 case AC_VERB_GET_HDMI_DIP_INDEX:
53 case AC_VERB_GET_HDMI_DIP_DATA:
54 case AC_VERB_GET_HDMI_DIP_XMIT:
55 case AC_VERB_GET_HDMI_CP_CTRL:
56 case AC_VERB_GET_HDMI_CHAN_SLOT:
57 case AC_VERB_GET_DEVICE_SEL:
58 case AC_VERB_GET_DEVICE_LIST: /* read-only volatile */
65 static bool hda_writeable_reg(struct device *dev, unsigned int reg)
67 struct hdac_device *codec = dev_to_hdac_dev(dev);
68 unsigned int verb = get_verb(reg);
69 const unsigned int *v;
72 snd_array_for_each(&codec->vendor_verbs, i, v) {
77 if (codec->caps_overwriting)
80 switch (verb & 0xf00) {
81 case AC_VERB_GET_STREAM_FORMAT:
82 case AC_VERB_GET_AMP_GAIN_MUTE:
84 case AC_VERB_GET_PROC_COEF:
85 return codec->cache_coef;
93 case AC_VERB_GET_CONNECT_SEL:
94 case AC_VERB_GET_SDI_SELECT:
95 case AC_VERB_GET_PIN_WIDGET_CONTROL:
96 case AC_VERB_GET_UNSOLICITED_RESPONSE: /* only as SET_UNSOLICITED_ENABLE */
97 case AC_VERB_GET_BEEP_CONTROL:
98 case AC_VERB_GET_EAPD_BTLENABLE:
99 case AC_VERB_GET_DIGI_CONVERT_1:
100 case AC_VERB_GET_DIGI_CONVERT_2: /* only for beep control */
101 case AC_VERB_GET_VOLUME_KNOB_CONTROL:
102 case AC_VERB_GET_GPIO_MASK:
103 case AC_VERB_GET_GPIO_DIRECTION:
104 case AC_VERB_GET_GPIO_DATA: /* not for volatile read */
105 case AC_VERB_GET_GPIO_WAKE_MASK:
106 case AC_VERB_GET_GPIO_UNSOLICITED_RSP_MASK:
107 case AC_VERB_GET_GPIO_STICKY_MASK:
114 static bool hda_readable_reg(struct device *dev, unsigned int reg)
116 struct hdac_device *codec = dev_to_hdac_dev(dev);
117 unsigned int verb = get_verb(reg);
119 if (codec->caps_overwriting)
123 case AC_VERB_PARAMETERS:
124 case AC_VERB_GET_CONNECT_LIST:
125 case AC_VERB_GET_SUBSYSTEM_ID:
127 /* below are basically writable, but disabled for reducing unnecessary
130 case AC_VERB_GET_CONFIG_DEFAULT: /* usually just read */
131 case AC_VERB_GET_CONV: /* managed in PCM code */
132 case AC_VERB_GET_CVT_CHAN_COUNT: /* managed in HDMI CA code */
136 return hda_writeable_reg(dev, reg);
140 * Stereo amp pseudo register:
141 * for making easier to handle the stereo volume control, we provide a
142 * fake register to deal both left and right channels by a single
143 * (pseudo) register access. A verb consisting of SET_AMP_GAIN with
144 * *both* SET_LEFT and SET_RIGHT bits takes a 16bit value, the lower 8bit
145 * for the left and the upper 8bit for the right channel.
147 static bool is_stereo_amp_verb(unsigned int reg)
149 if (((reg >> 8) & 0x700) != AC_VERB_SET_AMP_GAIN_MUTE)
151 return (reg & (AC_AMP_SET_LEFT | AC_AMP_SET_RIGHT)) ==
152 (AC_AMP_SET_LEFT | AC_AMP_SET_RIGHT);
155 /* read a pseudo stereo amp register (16bit left+right) */
156 static int hda_reg_read_stereo_amp(struct hdac_device *codec,
157 unsigned int reg, unsigned int *val)
159 unsigned int left, right;
162 reg &= ~(AC_AMP_SET_LEFT | AC_AMP_SET_RIGHT);
163 err = snd_hdac_exec_verb(codec, reg | AC_AMP_GET_LEFT, 0, &left);
166 err = snd_hdac_exec_verb(codec, reg | AC_AMP_GET_RIGHT, 0, &right);
169 *val = left | (right << 8);
173 /* write a pseudo stereo amp register (16bit left+right) */
174 static int hda_reg_write_stereo_amp(struct hdac_device *codec,
175 unsigned int reg, unsigned int val)
178 unsigned int verb, left, right;
180 verb = AC_VERB_SET_AMP_GAIN_MUTE << 8;
181 if (reg & AC_AMP_GET_OUTPUT)
182 verb |= AC_AMP_SET_OUTPUT;
184 verb |= AC_AMP_SET_INPUT | ((reg & 0xf) << 8);
185 reg = (reg & ~0xfffff) | verb;
188 right = (val >> 8) & 0xff;
190 reg |= AC_AMP_SET_LEFT | AC_AMP_SET_RIGHT;
191 return snd_hdac_exec_verb(codec, reg | left, 0, NULL);
194 err = snd_hdac_exec_verb(codec, reg | AC_AMP_SET_LEFT | left, 0, NULL);
197 err = snd_hdac_exec_verb(codec, reg | AC_AMP_SET_RIGHT | right, 0, NULL);
203 /* read a pseudo coef register (16bit) */
204 static int hda_reg_read_coef(struct hdac_device *codec, unsigned int reg,
210 if (!codec->cache_coef)
212 /* LSB 8bit = coef index */
213 verb = (reg & ~0xfff00) | (AC_VERB_SET_COEF_INDEX << 8);
214 err = snd_hdac_exec_verb(codec, verb, 0, NULL);
217 verb = (reg & ~0xfffff) | (AC_VERB_GET_COEF_INDEX << 8);
218 return snd_hdac_exec_verb(codec, verb, 0, val);
221 /* write a pseudo coef register (16bit) */
222 static int hda_reg_write_coef(struct hdac_device *codec, unsigned int reg,
228 if (!codec->cache_coef)
230 /* LSB 8bit = coef index */
231 verb = (reg & ~0xfff00) | (AC_VERB_SET_COEF_INDEX << 8);
232 err = snd_hdac_exec_verb(codec, verb, 0, NULL);
235 verb = (reg & ~0xfffff) | (AC_VERB_GET_COEF_INDEX << 8) |
237 return snd_hdac_exec_verb(codec, verb, 0, NULL);
240 static int hda_reg_read(void *context, unsigned int reg, unsigned int *val)
242 struct hdac_device *codec = context;
243 int verb = get_verb(reg);
247 if (verb != AC_VERB_GET_POWER_STATE) {
248 pm_lock = codec_pm_lock(codec);
252 reg |= (codec->addr << 28);
253 if (is_stereo_amp_verb(reg)) {
254 err = hda_reg_read_stereo_amp(codec, reg, val);
257 if (verb == AC_VERB_GET_PROC_COEF) {
258 err = hda_reg_read_coef(codec, reg, val);
261 if ((verb & 0x700) == AC_VERB_SET_AMP_GAIN_MUTE)
262 reg &= ~AC_AMP_FAKE_MUTE;
264 err = snd_hdac_exec_verb(codec, reg, 0, val);
267 /* special handling for asymmetric reads */
268 if (verb == AC_VERB_GET_POWER_STATE) {
269 if (*val & AC_PWRST_ERROR)
271 else /* take only the actual state */
272 *val = (*val >> 4) & 0x0f;
275 codec_pm_unlock(codec, pm_lock);
279 static int hda_reg_write(void *context, unsigned int reg, unsigned int val)
281 struct hdac_device *codec = context;
286 if (codec->caps_overwriting)
289 reg &= ~0x00080000U; /* drop GET bit */
290 reg |= (codec->addr << 28);
291 verb = get_verb(reg);
293 if (verb != AC_VERB_SET_POWER_STATE) {
294 pm_lock = codec_pm_lock(codec);
296 return codec->lazy_cache ? 0 : -EAGAIN;
299 if (is_stereo_amp_verb(reg)) {
300 err = hda_reg_write_stereo_amp(codec, reg, val);
304 if (verb == AC_VERB_SET_PROC_COEF) {
305 err = hda_reg_write_coef(codec, reg, val);
309 switch (verb & 0xf00) {
310 case AC_VERB_SET_AMP_GAIN_MUTE:
311 if ((reg & AC_AMP_FAKE_MUTE) && (val & AC_AMP_MUTE))
313 verb = AC_VERB_SET_AMP_GAIN_MUTE;
314 if (reg & AC_AMP_GET_LEFT)
315 verb |= AC_AMP_SET_LEFT >> 8;
317 verb |= AC_AMP_SET_RIGHT >> 8;
318 if (reg & AC_AMP_GET_OUTPUT) {
319 verb |= AC_AMP_SET_OUTPUT >> 8;
321 verb |= AC_AMP_SET_INPUT >> 8;
328 case AC_VERB_SET_DIGI_CONVERT_1:
331 case AC_VERB_SET_CONFIG_DEFAULT_BYTES_0:
339 for (i = 0; i < bytes; i++) {
341 reg |= (verb + i) << 8 | ((val >> (8 * i)) & 0xff);
342 err = snd_hdac_exec_verb(codec, reg, 0, NULL);
348 codec_pm_unlock(codec, pm_lock);
352 static const struct regmap_config hda_regmap_cfg = {
356 .max_register = 0xfffffff,
357 .writeable_reg = hda_writeable_reg,
358 .readable_reg = hda_readable_reg,
359 .volatile_reg = hda_volatile_reg,
360 .cache_type = REGCACHE_MAPLE,
361 .reg_read = hda_reg_read,
362 .reg_write = hda_reg_write,
363 .use_single_read = true,
364 .use_single_write = true,
365 .disable_locking = true,
369 * snd_hdac_regmap_init - Initialize regmap for HDA register accesses
370 * @codec: the codec object
372 * Returns zero for success or a negative error code.
374 int snd_hdac_regmap_init(struct hdac_device *codec)
376 struct regmap *regmap;
378 regmap = regmap_init(&codec->dev, NULL, codec, &hda_regmap_cfg);
380 return PTR_ERR(regmap);
381 codec->regmap = regmap;
382 snd_array_init(&codec->vendor_verbs, sizeof(unsigned int), 8);
385 EXPORT_SYMBOL_GPL(snd_hdac_regmap_init);
388 * snd_hdac_regmap_exit - Release the regmap from HDA codec
389 * @codec: the codec object
391 void snd_hdac_regmap_exit(struct hdac_device *codec)
394 regmap_exit(codec->regmap);
395 codec->regmap = NULL;
396 snd_array_free(&codec->vendor_verbs);
399 EXPORT_SYMBOL_GPL(snd_hdac_regmap_exit);
402 * snd_hdac_regmap_add_vendor_verb - add a vendor-specific verb to regmap
403 * @codec: the codec object
404 * @verb: verb to allow accessing via regmap
406 * Returns zero for success or a negative error code.
408 int snd_hdac_regmap_add_vendor_verb(struct hdac_device *codec,
411 unsigned int *p = snd_array_new(&codec->vendor_verbs);
415 *p = verb | 0x800; /* set GET bit */
418 EXPORT_SYMBOL_GPL(snd_hdac_regmap_add_vendor_verb);
424 /* write a pseudo-register value (w/o power sequence) */
425 static int reg_raw_write(struct hdac_device *codec, unsigned int reg,
430 mutex_lock(&codec->regmap_lock);
432 err = hda_reg_write(codec, reg, val);
434 err = regmap_write(codec->regmap, reg, val);
435 mutex_unlock(&codec->regmap_lock);
439 /* a helper macro to call @func_call; retry with power-up if failed */
440 #define CALL_RAW_FUNC(codec, func_call) \
442 int _err = func_call; \
443 if (_err == -EAGAIN) { \
444 _err = snd_hdac_power_up_pm(codec); \
447 snd_hdac_power_down_pm(codec); \
452 * snd_hdac_regmap_write_raw - write a pseudo register with power mgmt
453 * @codec: the codec object
454 * @reg: pseudo register
455 * @val: value to write
457 * Returns zero if successful or a negative error code.
459 int snd_hdac_regmap_write_raw(struct hdac_device *codec, unsigned int reg,
462 return CALL_RAW_FUNC(codec, reg_raw_write(codec, reg, val));
464 EXPORT_SYMBOL_GPL(snd_hdac_regmap_write_raw);
466 static int reg_raw_read(struct hdac_device *codec, unsigned int reg,
467 unsigned int *val, bool uncached)
471 mutex_lock(&codec->regmap_lock);
472 if (uncached || !codec->regmap)
473 err = hda_reg_read(codec, reg, val);
475 err = regmap_read(codec->regmap, reg, val);
476 mutex_unlock(&codec->regmap_lock);
480 static int __snd_hdac_regmap_read_raw(struct hdac_device *codec,
481 unsigned int reg, unsigned int *val,
484 return CALL_RAW_FUNC(codec, reg_raw_read(codec, reg, val, uncached));
488 * snd_hdac_regmap_read_raw - read a pseudo register with power mgmt
489 * @codec: the codec object
490 * @reg: pseudo register
491 * @val: pointer to store the read value
493 * Returns zero if successful or a negative error code.
495 int snd_hdac_regmap_read_raw(struct hdac_device *codec, unsigned int reg,
498 return __snd_hdac_regmap_read_raw(codec, reg, val, false);
500 EXPORT_SYMBOL_GPL(snd_hdac_regmap_read_raw);
502 /* Works like snd_hdac_regmap_read_raw(), but this doesn't read from the
503 * cache but always via hda verbs.
505 int snd_hdac_regmap_read_raw_uncached(struct hdac_device *codec,
506 unsigned int reg, unsigned int *val)
508 return __snd_hdac_regmap_read_raw(codec, reg, val, true);
511 static int reg_raw_update(struct hdac_device *codec, unsigned int reg,
512 unsigned int mask, unsigned int val)
518 mutex_lock(&codec->regmap_lock);
520 err = regmap_update_bits_check(codec->regmap, reg, mask, val,
523 err = change ? 1 : 0;
525 err = hda_reg_read(codec, reg, &orig);
530 err = hda_reg_write(codec, reg, val);
536 mutex_unlock(&codec->regmap_lock);
541 * snd_hdac_regmap_update_raw - update a pseudo register with power mgmt
542 * @codec: the codec object
543 * @reg: pseudo register
544 * @mask: bit mask to update
545 * @val: value to update
547 * Returns zero if successful or a negative error code.
549 int snd_hdac_regmap_update_raw(struct hdac_device *codec, unsigned int reg,
550 unsigned int mask, unsigned int val)
552 return CALL_RAW_FUNC(codec, reg_raw_update(codec, reg, mask, val));
554 EXPORT_SYMBOL_GPL(snd_hdac_regmap_update_raw);
556 static int reg_raw_update_once(struct hdac_device *codec, unsigned int reg,
557 unsigned int mask, unsigned int val)
563 return reg_raw_update(codec, reg, mask, val);
565 mutex_lock(&codec->regmap_lock);
566 regcache_cache_only(codec->regmap, true);
567 err = regmap_read(codec->regmap, reg, &orig);
568 regcache_cache_only(codec->regmap, false);
570 err = regmap_update_bits(codec->regmap, reg, mask, val);
571 mutex_unlock(&codec->regmap_lock);
576 * snd_hdac_regmap_update_raw_once - initialize the register value only once
577 * @codec: the codec object
578 * @reg: pseudo register
579 * @mask: bit mask to update
580 * @val: value to update
582 * Performs the update of the register bits only once when the register
583 * hasn't been initialized yet. Used in HD-audio legacy driver.
584 * Returns zero if successful or a negative error code
586 int snd_hdac_regmap_update_raw_once(struct hdac_device *codec, unsigned int reg,
587 unsigned int mask, unsigned int val)
589 return CALL_RAW_FUNC(codec, reg_raw_update_once(codec, reg, mask, val));
591 EXPORT_SYMBOL_GPL(snd_hdac_regmap_update_raw_once);
594 * snd_hdac_regmap_sync - sync out the cached values for PM resume
595 * @codec: the codec object
597 void snd_hdac_regmap_sync(struct hdac_device *codec)
599 mutex_lock(&codec->regmap_lock);
601 regcache_sync(codec->regmap);
602 mutex_unlock(&codec->regmap_lock);
604 EXPORT_SYMBOL_GPL(snd_hdac_regmap_sync);