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 <linux/pm_runtime.h>
21 #include <sound/core.h>
22 #include <sound/hdaudio.h>
23 #include <sound/hda_regmap.h>
26 static int codec_pm_lock(struct hdac_device
*codec
)
28 return snd_hdac_keep_power_up(codec
);
31 static void codec_pm_unlock(struct hdac_device
*codec
, int lock
)
34 snd_hdac_power_down_pm(codec
);
37 #define get_verb(reg) (((reg) >> 8) & 0xfff)
39 static bool hda_volatile_reg(struct device
*dev
, unsigned int reg
)
41 struct hdac_device
*codec
= dev_to_hdac_dev(dev
);
42 unsigned int verb
= get_verb(reg
);
45 case AC_VERB_GET_PROC_COEF
:
46 return !codec
->cache_coef
;
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 */
66 static bool hda_writeable_reg(struct device
*dev
, unsigned int reg
)
68 struct hdac_device
*codec
= dev_to_hdac_dev(dev
);
69 unsigned int verb
= get_verb(reg
);
70 const unsigned int *v
;
73 snd_array_for_each(&codec
->vendor_verbs
, i
, v
) {
78 if (codec
->caps_overwriting
)
81 switch (verb
& 0xf00) {
82 case AC_VERB_GET_STREAM_FORMAT
:
83 case AC_VERB_GET_AMP_GAIN_MUTE
:
85 case AC_VERB_GET_PROC_COEF
:
86 return codec
->cache_coef
;
94 case AC_VERB_GET_CONNECT_SEL
:
95 case AC_VERB_GET_SDI_SELECT
:
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
:
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
:
115 static bool hda_readable_reg(struct device
*dev
, unsigned int reg
)
117 struct hdac_device
*codec
= dev_to_hdac_dev(dev
);
118 unsigned int verb
= get_verb(reg
);
120 if (codec
->caps_overwriting
)
124 case AC_VERB_PARAMETERS
:
125 case AC_VERB_GET_CONNECT_LIST
:
126 case AC_VERB_GET_SUBSYSTEM_ID
:
128 /* below are basically writable, but disabled for reducing unnecessary
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 */
137 return hda_writeable_reg(dev
, reg
);
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.
148 static bool is_stereo_amp_verb(unsigned int reg
)
150 if (((reg
>> 8) & 0x700) != AC_VERB_SET_AMP_GAIN_MUTE
)
152 return (reg
& (AC_AMP_SET_LEFT
| AC_AMP_SET_RIGHT
)) ==
153 (AC_AMP_SET_LEFT
| AC_AMP_SET_RIGHT
);
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
)
160 unsigned int left
, right
;
163 reg
&= ~(AC_AMP_SET_LEFT
| AC_AMP_SET_RIGHT
);
164 err
= snd_hdac_exec_verb(codec
, reg
| AC_AMP_GET_LEFT
, 0, &left
);
167 err
= snd_hdac_exec_verb(codec
, reg
| AC_AMP_GET_RIGHT
, 0, &right
);
170 *val
= left
| (right
<< 8);
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
)
179 unsigned int verb
, left
, right
;
181 verb
= AC_VERB_SET_AMP_GAIN_MUTE
<< 8;
182 if (reg
& AC_AMP_GET_OUTPUT
)
183 verb
|= AC_AMP_SET_OUTPUT
;
185 verb
|= AC_AMP_SET_INPUT
| ((reg
& 0xf) << 8);
186 reg
= (reg
& ~0xfffff) | verb
;
189 right
= (val
>> 8) & 0xff;
191 reg
|= AC_AMP_SET_LEFT
| AC_AMP_SET_RIGHT
;
192 return snd_hdac_exec_verb(codec
, reg
| left
, 0, NULL
);
195 err
= snd_hdac_exec_verb(codec
, reg
| AC_AMP_SET_LEFT
| left
, 0, NULL
);
198 err
= snd_hdac_exec_verb(codec
, reg
| AC_AMP_SET_RIGHT
| right
, 0, NULL
);
204 /* read a pseudo coef register (16bit) */
205 static int hda_reg_read_coef(struct hdac_device
*codec
, unsigned int reg
,
211 if (!codec
->cache_coef
)
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
);
218 verb
= (reg
& ~0xfffff) | (AC_VERB_GET_COEF_INDEX
<< 8);
219 return snd_hdac_exec_verb(codec
, verb
, 0, val
);
222 /* write a pseudo coef register (16bit) */
223 static int hda_reg_write_coef(struct hdac_device
*codec
, unsigned int reg
,
229 if (!codec
->cache_coef
)
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
);
236 verb
= (reg
& ~0xfffff) | (AC_VERB_GET_COEF_INDEX
<< 8) |
238 return snd_hdac_exec_verb(codec
, verb
, 0, NULL
);
241 static int hda_reg_read(void *context
, unsigned int reg
, unsigned int *val
)
243 struct hdac_device
*codec
= context
;
244 int verb
= get_verb(reg
);
248 if (verb
!= AC_VERB_GET_POWER_STATE
) {
249 pm_lock
= codec_pm_lock(codec
);
253 reg
|= (codec
->addr
<< 28);
254 if (is_stereo_amp_verb(reg
)) {
255 err
= hda_reg_read_stereo_amp(codec
, reg
, val
);
258 if (verb
== AC_VERB_GET_PROC_COEF
) {
259 err
= hda_reg_read_coef(codec
, reg
, val
);
262 if ((verb
& 0x700) == AC_VERB_SET_AMP_GAIN_MUTE
)
263 reg
&= ~AC_AMP_FAKE_MUTE
;
265 err
= snd_hdac_exec_verb(codec
, reg
, 0, val
);
268 /* special handling for asymmetric reads */
269 if (verb
== AC_VERB_GET_POWER_STATE
) {
270 if (*val
& AC_PWRST_ERROR
)
272 else /* take only the actual state */
273 *val
= (*val
>> 4) & 0x0f;
276 codec_pm_unlock(codec
, pm_lock
);
280 static int hda_reg_write(void *context
, unsigned int reg
, unsigned int val
)
282 struct hdac_device
*codec
= context
;
287 if (codec
->caps_overwriting
)
290 reg
&= ~0x00080000U
; /* drop GET bit */
291 reg
|= (codec
->addr
<< 28);
292 verb
= get_verb(reg
);
294 if (verb
!= AC_VERB_SET_POWER_STATE
) {
295 pm_lock
= codec_pm_lock(codec
);
297 return codec
->lazy_cache
? 0 : -EAGAIN
;
300 if (is_stereo_amp_verb(reg
)) {
301 err
= hda_reg_write_stereo_amp(codec
, reg
, val
);
305 if (verb
== AC_VERB_SET_PROC_COEF
) {
306 err
= hda_reg_write_coef(codec
, reg
, val
);
310 switch (verb
& 0xf00) {
311 case AC_VERB_SET_AMP_GAIN_MUTE
:
312 if ((reg
& AC_AMP_FAKE_MUTE
) && (val
& AC_AMP_MUTE
))
314 verb
= AC_VERB_SET_AMP_GAIN_MUTE
;
315 if (reg
& AC_AMP_GET_LEFT
)
316 verb
|= AC_AMP_SET_LEFT
>> 8;
318 verb
|= AC_AMP_SET_RIGHT
>> 8;
319 if (reg
& AC_AMP_GET_OUTPUT
) {
320 verb
|= AC_AMP_SET_OUTPUT
>> 8;
322 verb
|= AC_AMP_SET_INPUT
>> 8;
329 case AC_VERB_SET_DIGI_CONVERT_1
:
332 case AC_VERB_SET_CONFIG_DEFAULT_BYTES_0
:
340 for (i
= 0; i
< bytes
; i
++) {
342 reg
|= (verb
+ i
) << 8 | ((val
>> (8 * i
)) & 0xff);
343 err
= snd_hdac_exec_verb(codec
, reg
, 0, NULL
);
349 codec_pm_unlock(codec
, pm_lock
);
353 static const struct regmap_config hda_regmap_cfg
= {
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
,
364 .use_single_read
= true,
365 .use_single_write
= 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_init - 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
,
429 return hda_reg_write(codec
, reg
, val
);
431 return regmap_write(codec
->regmap
, reg
, val
);
435 * snd_hdac_regmap_write_raw - write a pseudo register with power mgmt
436 * @codec: the codec object
437 * @reg: pseudo register
438 * @val: value to write
440 * Returns zero if successful or a negative error code.
442 int snd_hdac_regmap_write_raw(struct hdac_device
*codec
, unsigned int reg
,
447 err
= reg_raw_write(codec
, reg
, val
);
448 if (err
== -EAGAIN
) {
449 err
= snd_hdac_power_up_pm(codec
);
451 err
= reg_raw_write(codec
, reg
, val
);
452 snd_hdac_power_down_pm(codec
);
456 EXPORT_SYMBOL_GPL(snd_hdac_regmap_write_raw
);
458 static int reg_raw_read(struct hdac_device
*codec
, unsigned int reg
,
459 unsigned int *val
, bool uncached
)
461 if (uncached
|| !codec
->regmap
)
462 return hda_reg_read(codec
, reg
, val
);
464 return regmap_read(codec
->regmap
, reg
, val
);
467 static int __snd_hdac_regmap_read_raw(struct hdac_device
*codec
,
468 unsigned int reg
, unsigned int *val
,
473 err
= reg_raw_read(codec
, reg
, val
, uncached
);
474 if (err
== -EAGAIN
) {
475 err
= snd_hdac_power_up_pm(codec
);
477 err
= reg_raw_read(codec
, reg
, val
, uncached
);
478 snd_hdac_power_down_pm(codec
);
484 * snd_hdac_regmap_read_raw - read a pseudo register with power mgmt
485 * @codec: the codec object
486 * @reg: pseudo register
487 * @val: pointer to store the read value
489 * Returns zero if successful or a negative error code.
491 int snd_hdac_regmap_read_raw(struct hdac_device
*codec
, unsigned int reg
,
494 return __snd_hdac_regmap_read_raw(codec
, reg
, val
, false);
496 EXPORT_SYMBOL_GPL(snd_hdac_regmap_read_raw
);
498 /* Works like snd_hdac_regmap_read_raw(), but this doesn't read from the
499 * cache but always via hda verbs.
501 int snd_hdac_regmap_read_raw_uncached(struct hdac_device
*codec
,
502 unsigned int reg
, unsigned int *val
)
504 return __snd_hdac_regmap_read_raw(codec
, reg
, val
, true);
508 * snd_hdac_regmap_update_raw - update a pseudo register with power mgmt
509 * @codec: the codec object
510 * @reg: pseudo register
511 * @mask: bit mask to update
512 * @val: value to update
514 * Returns zero if successful or a negative error code.
516 int snd_hdac_regmap_update_raw(struct hdac_device
*codec
, unsigned int reg
,
517 unsigned int mask
, unsigned int val
)
523 err
= snd_hdac_regmap_read_raw(codec
, reg
, &orig
);
529 err
= snd_hdac_regmap_write_raw(codec
, reg
, val
);
534 EXPORT_SYMBOL_GPL(snd_hdac_regmap_update_raw
);