hdac_regmap.c 15 KB

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