ALSA: hda: enable regmap internal locking
[linux-2.6-block.git] / sound / hda / hdac_regmap.c
CommitLineData
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
26static int codec_pm_lock(struct hdac_device *codec)
27{
28 return snd_hdac_keep_power_up(codec);
29}
30
31static 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
39static 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
66static 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;
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:
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
115static 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);
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 */
148static 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) */
157static 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) */
175static 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) */
205static 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) */
223static 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
241static 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);
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
280static 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 */
291 reg |= (codec->addr << 28);
9efe2731
TI
292 verb = get_verb(reg);
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) {
311 case AC_VERB_SET_AMP_GAIN_MUTE:
a686ec4c
TI
312 if ((reg & AC_AMP_FAKE_MUTE) && (val & AC_AMP_MUTE))
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 }
347
fc4f000b
TI
348 out:
349 codec_pm_unlock(codec, pm_lock);
350 return err;
4d75faa0
TI
351}
352
353static 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,
365 .use_single_write = true,
4d75faa0
TI
366};
367
78dd5e21
TI
368/**
369 * snd_hdac_regmap_init - Initialize regmap for HDA register accesses
370 * @codec: the codec object
371 *
372 * Returns zero for success or a negative error code.
373 */
4d75faa0
TI
374int snd_hdac_regmap_init(struct hdac_device *codec)
375{
376 struct regmap *regmap;
377
378 regmap = regmap_init(&codec->dev, NULL, codec, &hda_regmap_cfg);
379 if (IS_ERR(regmap))
380 return PTR_ERR(regmap);
381 codec->regmap = regmap;
5e56bcea 382 snd_array_init(&codec->vendor_verbs, sizeof(unsigned int), 8);
4d75faa0
TI
383 return 0;
384}
385EXPORT_SYMBOL_GPL(snd_hdac_regmap_init);
386
78dd5e21
TI
387/**
388 * snd_hdac_regmap_init - Release the regmap from HDA codec
389 * @codec: the codec object
390 */
4d75faa0
TI
391void snd_hdac_regmap_exit(struct hdac_device *codec)
392{
393 if (codec->regmap) {
394 regmap_exit(codec->regmap);
395 codec->regmap = NULL;
5e56bcea 396 snd_array_free(&codec->vendor_verbs);
4d75faa0
TI
397 }
398}
399EXPORT_SYMBOL_GPL(snd_hdac_regmap_exit);
400
5e56bcea
TI
401/**
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
405 *
406 * Returns zero for success or a negative error code.
407 */
408int snd_hdac_regmap_add_vendor_verb(struct hdac_device *codec,
409 unsigned int verb)
410{
411 unsigned int *p = snd_array_new(&codec->vendor_verbs);
412
413 if (!p)
414 return -ENOMEM;
d6eb9e3e 415 *p = verb | 0x800; /* set GET bit */
5e56bcea
TI
416 return 0;
417}
418EXPORT_SYMBOL_GPL(snd_hdac_regmap_add_vendor_verb);
419
4d75faa0
TI
420/*
421 * helper functions
422 */
423
424/* write a pseudo-register value (w/o power sequence) */
425static int reg_raw_write(struct hdac_device *codec, unsigned int reg,
426 unsigned int val)
427{
428 if (!codec->regmap)
429 return hda_reg_write(codec, reg, val);
430 else
431 return regmap_write(codec->regmap, reg, val);
432}
433
434/**
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
439 *
440 * Returns zero if successful or a negative error code.
441 */
442int snd_hdac_regmap_write_raw(struct hdac_device *codec, unsigned int reg,
443 unsigned int val)
444{
445 int err;
446
447 err = reg_raw_write(codec, reg, val);
448 if (err == -EAGAIN) {
fbce23a0 449 err = snd_hdac_power_up_pm(codec);
8198868f 450 if (err >= 0)
fbce23a0 451 err = reg_raw_write(codec, reg, val);
664c7155 452 snd_hdac_power_down_pm(codec);
4d75faa0
TI
453 }
454 return err;
455}
456EXPORT_SYMBOL_GPL(snd_hdac_regmap_write_raw);
457
458static int reg_raw_read(struct hdac_device *codec, unsigned int reg,
3194ed49 459 unsigned int *val, bool uncached)
4d75faa0 460{
3194ed49 461 if (uncached || !codec->regmap)
4d75faa0
TI
462 return hda_reg_read(codec, reg, val);
463 else
464 return regmap_read(codec->regmap, reg, val);
465}
466
3194ed49
TI
467static int __snd_hdac_regmap_read_raw(struct hdac_device *codec,
468 unsigned int reg, unsigned int *val,
469 bool uncached)
470{
471 int err;
472
473 err = reg_raw_read(codec, reg, val, uncached);
474 if (err == -EAGAIN) {
475 err = snd_hdac_power_up_pm(codec);
8198868f 476 if (err >= 0)
3194ed49
TI
477 err = reg_raw_read(codec, reg, val, uncached);
478 snd_hdac_power_down_pm(codec);
479 }
480 return err;
481}
482
4d75faa0
TI
483/**
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
488 *
489 * Returns zero if successful or a negative error code.
490 */
491int snd_hdac_regmap_read_raw(struct hdac_device *codec, unsigned int reg,
492 unsigned int *val)
493{
3194ed49 494 return __snd_hdac_regmap_read_raw(codec, reg, val, false);
4d75faa0
TI
495}
496EXPORT_SYMBOL_GPL(snd_hdac_regmap_read_raw);
497
3194ed49
TI
498/* Works like snd_hdac_regmap_read_raw(), but this doesn't read from the
499 * cache but always via hda verbs.
500 */
501int snd_hdac_regmap_read_raw_uncached(struct hdac_device *codec,
502 unsigned int reg, unsigned int *val)
503{
504 return __snd_hdac_regmap_read_raw(codec, reg, val, true);
505}
506
4d75faa0
TI
507/**
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 udpate
512 * @val: value to update
513 *
514 * Returns zero if successful or a negative error code.
515 */
516int snd_hdac_regmap_update_raw(struct hdac_device *codec, unsigned int reg,
517 unsigned int mask, unsigned int val)
518{
519 unsigned int orig;
520 int err;
521
522 val &= mask;
523 err = snd_hdac_regmap_read_raw(codec, reg, &orig);
524 if (err < 0)
525 return err;
526 val |= orig & ~mask;
527 if (val == orig)
528 return 0;
529 err = snd_hdac_regmap_write_raw(codec, reg, val);
530 if (err < 0)
531 return err;
532 return 1;
533}
534EXPORT_SYMBOL_GPL(snd_hdac_regmap_update_raw);