wm8400-core.c 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421
  1. /*
  2. * Core driver for WM8400.
  3. *
  4. * Copyright 2008 Wolfson Microelectronics PLC.
  5. *
  6. * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
  7. *
  8. * This program is free software; you can redistribute it and/or
  9. * modify it under the terms of the GNU General Public License as
  10. * published by the Free Software Foundation; either version 2 of the
  11. * License, or (at your option) any later version.
  12. *
  13. */
  14. #include <linux/module.h>
  15. #include <linux/bug.h>
  16. #include <linux/err.h>
  17. #include <linux/i2c.h>
  18. #include <linux/kernel.h>
  19. #include <linux/mfd/core.h>
  20. #include <linux/mfd/wm8400-private.h>
  21. #include <linux/mfd/wm8400-audio.h>
  22. #include <linux/regmap.h>
  23. #include <linux/slab.h>
  24. static struct {
  25. u16 readable; /* Mask of readable bits */
  26. u16 writable; /* Mask of writable bits */
  27. u16 vol; /* Mask of volatile bits */
  28. int is_codec; /* Register controlled by codec reset */
  29. u16 default_val; /* Value on reset */
  30. } reg_data[] = {
  31. { 0xFFFF, 0xFFFF, 0x0000, 0, 0x6172 }, /* R0 */
  32. { 0x7000, 0x0000, 0x8000, 0, 0x0000 }, /* R1 */
  33. { 0xFF17, 0xFF17, 0x0000, 0, 0x0000 }, /* R2 */
  34. { 0xEBF3, 0xEBF3, 0x0000, 1, 0x6000 }, /* R3 */
  35. { 0x3CF3, 0x3CF3, 0x0000, 1, 0x0000 }, /* R4 */
  36. { 0xF1F8, 0xF1F8, 0x0000, 1, 0x4050 }, /* R5 */
  37. { 0xFC1F, 0xFC1F, 0x0000, 1, 0x4000 }, /* R6 */
  38. { 0xDFDE, 0xDFDE, 0x0000, 1, 0x01C8 }, /* R7 */
  39. { 0xFCFC, 0xFCFC, 0x0000, 1, 0x0000 }, /* R8 */
  40. { 0xEFFF, 0xEFFF, 0x0000, 1, 0x0040 }, /* R9 */
  41. { 0xEFFF, 0xEFFF, 0x0000, 1, 0x0040 }, /* R10 */
  42. { 0x27F7, 0x27F7, 0x0000, 1, 0x0004 }, /* R11 */
  43. { 0x01FF, 0x01FF, 0x0000, 1, 0x00C0 }, /* R12 */
  44. { 0x01FF, 0x01FF, 0x0000, 1, 0x00C0 }, /* R13 */
  45. { 0x1FEF, 0x1FEF, 0x0000, 1, 0x0000 }, /* R14 */
  46. { 0x0163, 0x0163, 0x0000, 1, 0x0100 }, /* R15 */
  47. { 0x01FF, 0x01FF, 0x0000, 1, 0x00C0 }, /* R16 */
  48. { 0x01FF, 0x01FF, 0x0000, 1, 0x00C0 }, /* R17 */
  49. { 0x1FFF, 0x0FFF, 0x0000, 1, 0x0000 }, /* R18 */
  50. { 0xFFFF, 0xFFFF, 0x0000, 1, 0x1000 }, /* R19 */
  51. { 0xFFFF, 0xFFFF, 0x0000, 1, 0x1010 }, /* R20 */
  52. { 0xFFFF, 0xFFFF, 0x0000, 1, 0x1010 }, /* R21 */
  53. { 0x0FDD, 0x0FDD, 0x0000, 1, 0x8000 }, /* R22 */
  54. { 0x1FFF, 0x1FFF, 0x0000, 1, 0x0800 }, /* R23 */
  55. { 0x0000, 0x01DF, 0x0000, 1, 0x008B }, /* R24 */
  56. { 0x0000, 0x01DF, 0x0000, 1, 0x008B }, /* R25 */
  57. { 0x0000, 0x01DF, 0x0000, 1, 0x008B }, /* R26 */
  58. { 0x0000, 0x01DF, 0x0000, 1, 0x008B }, /* R27 */
  59. { 0x0000, 0x01FF, 0x0000, 1, 0x0000 }, /* R28 */
  60. { 0x0000, 0x01FF, 0x0000, 1, 0x0000 }, /* R29 */
  61. { 0x0000, 0x0077, 0x0000, 1, 0x0066 }, /* R30 */
  62. { 0x0000, 0x0033, 0x0000, 1, 0x0022 }, /* R31 */
  63. { 0x0000, 0x01FF, 0x0000, 1, 0x0079 }, /* R32 */
  64. { 0x0000, 0x01FF, 0x0000, 1, 0x0079 }, /* R33 */
  65. { 0x0000, 0x0003, 0x0000, 1, 0x0003 }, /* R34 */
  66. { 0x0000, 0x01FF, 0x0000, 1, 0x0003 }, /* R35 */
  67. { 0x0000, 0x0000, 0x0000, 0, 0x0000 }, /* R36 */
  68. { 0x0000, 0x003F, 0x0000, 1, 0x0100 }, /* R37 */
  69. { 0x0000, 0x0000, 0x0000, 0, 0x0000 }, /* R38 */
  70. { 0x0000, 0x000F, 0x0000, 0, 0x0000 }, /* R39 */
  71. { 0x0000, 0x00FF, 0x0000, 1, 0x0000 }, /* R40 */
  72. { 0x0000, 0x01B7, 0x0000, 1, 0x0000 }, /* R41 */
  73. { 0x0000, 0x01B7, 0x0000, 1, 0x0000 }, /* R42 */
  74. { 0x0000, 0x01FF, 0x0000, 1, 0x0000 }, /* R43 */
  75. { 0x0000, 0x01FF, 0x0000, 1, 0x0000 }, /* R44 */
  76. { 0x0000, 0x00FD, 0x0000, 1, 0x0000 }, /* R45 */
  77. { 0x0000, 0x00FD, 0x0000, 1, 0x0000 }, /* R46 */
  78. { 0x0000, 0x01FF, 0x0000, 1, 0x0000 }, /* R47 */
  79. { 0x0000, 0x01FF, 0x0000, 1, 0x0000 }, /* R48 */
  80. { 0x0000, 0x01FF, 0x0000, 1, 0x0000 }, /* R49 */
  81. { 0x0000, 0x01FF, 0x0000, 1, 0x0000 }, /* R50 */
  82. { 0x0000, 0x01B3, 0x0000, 1, 0x0180 }, /* R51 */
  83. { 0x0000, 0x0077, 0x0000, 1, 0x0000 }, /* R52 */
  84. { 0x0000, 0x0077, 0x0000, 1, 0x0000 }, /* R53 */
  85. { 0x0000, 0x00FF, 0x0000, 1, 0x0000 }, /* R54 */
  86. { 0x0000, 0x0001, 0x0000, 1, 0x0000 }, /* R55 */
  87. { 0x0000, 0x003F, 0x0000, 1, 0x0000 }, /* R56 */
  88. { 0x0000, 0x004F, 0x0000, 1, 0x0000 }, /* R57 */
  89. { 0x0000, 0x00FD, 0x0000, 1, 0x0000 }, /* R58 */
  90. { 0x0000, 0x0000, 0x0000, 0, 0x0000 }, /* R59 */
  91. { 0x1FFF, 0x1FFF, 0x0000, 1, 0x0000 }, /* R60 */
  92. { 0xFFFF, 0xFFFF, 0x0000, 1, 0x0000 }, /* R61 */
  93. { 0x03FF, 0x03FF, 0x0000, 1, 0x0000 }, /* R62 */
  94. { 0x007F, 0x007F, 0x0000, 1, 0x0000 }, /* R63 */
  95. { 0x0000, 0x0000, 0x0000, 0, 0x0000 }, /* R64 */
  96. { 0xDFFF, 0xDFFF, 0x0000, 0, 0x0000 }, /* R65 */
  97. { 0xDFFF, 0xDFFF, 0x0000, 0, 0x0000 }, /* R66 */
  98. { 0xDFFF, 0xDFFF, 0x0000, 0, 0x0000 }, /* R67 */
  99. { 0xDFFF, 0xDFFF, 0x0000, 0, 0x0000 }, /* R68 */
  100. { 0x0000, 0x0000, 0x0000, 0, 0x0000 }, /* R69 */
  101. { 0xFFFF, 0xFFFF, 0x0000, 0, 0x4400 }, /* R70 */
  102. { 0x23FF, 0x23FF, 0x0000, 0, 0x0000 }, /* R71 */
  103. { 0xFFFF, 0xFFFF, 0x0000, 0, 0x4400 }, /* R72 */
  104. { 0x23FF, 0x23FF, 0x0000, 0, 0x0000 }, /* R73 */
  105. { 0x0000, 0x0000, 0x0000, 0, 0x0000 }, /* R74 */
  106. { 0x000E, 0x000E, 0x0000, 0, 0x0008 }, /* R75 */
  107. { 0xE00F, 0xE00F, 0x0000, 0, 0x0000 }, /* R76 */
  108. { 0x0000, 0x0000, 0x0000, 0, 0x0000 }, /* R77 */
  109. { 0x03C0, 0x03C0, 0x0000, 0, 0x02C0 }, /* R78 */
  110. { 0xFFFF, 0x0000, 0xffff, 0, 0x0000 }, /* R79 */
  111. { 0xFFFF, 0xFFFF, 0x0000, 0, 0x0000 }, /* R80 */
  112. { 0xFFFF, 0x0000, 0xffff, 0, 0x0000 }, /* R81 */
  113. { 0x2BFF, 0x0000, 0xffff, 0, 0x0000 }, /* R82 */
  114. { 0x0000, 0x0000, 0x0000, 0, 0x0000 }, /* R83 */
  115. { 0x80FF, 0x80FF, 0x0000, 0, 0x00ff }, /* R84 */
  116. };
  117. static int wm8400_read(struct wm8400 *wm8400, u8 reg, int num_regs, u16 *dest)
  118. {
  119. int i, ret = 0;
  120. BUG_ON(reg + num_regs > ARRAY_SIZE(wm8400->reg_cache));
  121. /* If there are any volatile reads then read back the entire block */
  122. for (i = reg; i < reg + num_regs; i++)
  123. if (reg_data[i].vol) {
  124. ret = regmap_bulk_read(wm8400->regmap, reg, dest,
  125. num_regs);
  126. return ret;
  127. }
  128. /* Otherwise use the cache */
  129. memcpy(dest, &wm8400->reg_cache[reg], num_regs * sizeof(u16));
  130. return 0;
  131. }
  132. static int wm8400_write(struct wm8400 *wm8400, u8 reg, int num_regs,
  133. u16 *src)
  134. {
  135. int ret, i;
  136. BUG_ON(reg + num_regs > ARRAY_SIZE(wm8400->reg_cache));
  137. for (i = 0; i < num_regs; i++) {
  138. BUG_ON(!reg_data[reg + i].writable);
  139. wm8400->reg_cache[reg + i] = src[i];
  140. ret = regmap_write(wm8400->regmap, reg, src[i]);
  141. if (ret != 0)
  142. return ret;
  143. }
  144. return 0;
  145. }
  146. /**
  147. * wm8400_reg_read - Single register read
  148. *
  149. * @wm8400: Pointer to wm8400 control structure
  150. * @reg: Register to read
  151. *
  152. * @return Read value
  153. */
  154. u16 wm8400_reg_read(struct wm8400 *wm8400, u8 reg)
  155. {
  156. u16 val;
  157. mutex_lock(&wm8400->io_lock);
  158. wm8400_read(wm8400, reg, 1, &val);
  159. mutex_unlock(&wm8400->io_lock);
  160. return val;
  161. }
  162. EXPORT_SYMBOL_GPL(wm8400_reg_read);
  163. int wm8400_block_read(struct wm8400 *wm8400, u8 reg, int count, u16 *data)
  164. {
  165. int ret;
  166. mutex_lock(&wm8400->io_lock);
  167. ret = wm8400_read(wm8400, reg, count, data);
  168. mutex_unlock(&wm8400->io_lock);
  169. return ret;
  170. }
  171. EXPORT_SYMBOL_GPL(wm8400_block_read);
  172. /**
  173. * wm8400_set_bits - Bitmask write
  174. *
  175. * @wm8400: Pointer to wm8400 control structure
  176. * @reg: Register to access
  177. * @mask: Mask of bits to change
  178. * @val: Value to set for masked bits
  179. */
  180. int wm8400_set_bits(struct wm8400 *wm8400, u8 reg, u16 mask, u16 val)
  181. {
  182. u16 tmp;
  183. int ret;
  184. mutex_lock(&wm8400->io_lock);
  185. ret = wm8400_read(wm8400, reg, 1, &tmp);
  186. tmp = (tmp & ~mask) | val;
  187. if (ret == 0)
  188. ret = wm8400_write(wm8400, reg, 1, &tmp);
  189. mutex_unlock(&wm8400->io_lock);
  190. return ret;
  191. }
  192. EXPORT_SYMBOL_GPL(wm8400_set_bits);
  193. /**
  194. * wm8400_reset_codec_reg_cache - Reset cached codec registers to
  195. * their default values.
  196. */
  197. void wm8400_reset_codec_reg_cache(struct wm8400 *wm8400)
  198. {
  199. int i;
  200. mutex_lock(&wm8400->io_lock);
  201. /* Reset all codec registers to their initial value */
  202. for (i = 0; i < ARRAY_SIZE(wm8400->reg_cache); i++)
  203. if (reg_data[i].is_codec)
  204. wm8400->reg_cache[i] = reg_data[i].default_val;
  205. mutex_unlock(&wm8400->io_lock);
  206. }
  207. EXPORT_SYMBOL_GPL(wm8400_reset_codec_reg_cache);
  208. static int wm8400_register_codec(struct wm8400 *wm8400)
  209. {
  210. struct mfd_cell cell = {
  211. .name = "wm8400-codec",
  212. .platform_data = wm8400,
  213. .pdata_size = sizeof(*wm8400),
  214. };
  215. return mfd_add_devices(wm8400->dev, -1, &cell, 1, NULL, 0);
  216. }
  217. /*
  218. * wm8400_init - Generic initialisation
  219. *
  220. * The WM8400 can be configured as either an I2C or SPI device. Probe
  221. * functions for each bus set up the accessors then call into this to
  222. * set up the device itself.
  223. */
  224. static int wm8400_init(struct wm8400 *wm8400,
  225. struct wm8400_platform_data *pdata)
  226. {
  227. u16 reg;
  228. int ret, i;
  229. mutex_init(&wm8400->io_lock);
  230. dev_set_drvdata(wm8400->dev, wm8400);
  231. /* Check that this is actually a WM8400 */
  232. ret = regmap_read(wm8400->regmap, WM8400_RESET_ID, &i);
  233. if (ret != 0) {
  234. dev_err(wm8400->dev, "Chip ID register read failed\n");
  235. return -EIO;
  236. }
  237. if (i != reg_data[WM8400_RESET_ID].default_val) {
  238. dev_err(wm8400->dev, "Device is not a WM8400, ID is %x\n", i);
  239. return -ENODEV;
  240. }
  241. /* We don't know what state the hardware is in and since this
  242. * is a PMIC we can't reset it safely so initialise the register
  243. * cache from the hardware.
  244. */
  245. ret = regmap_raw_read(wm8400->regmap, 0, wm8400->reg_cache,
  246. ARRAY_SIZE(wm8400->reg_cache));
  247. if (ret != 0) {
  248. dev_err(wm8400->dev, "Register cache read failed\n");
  249. return -EIO;
  250. }
  251. for (i = 0; i < ARRAY_SIZE(wm8400->reg_cache); i++)
  252. wm8400->reg_cache[i] = be16_to_cpu(wm8400->reg_cache[i]);
  253. /* If the codec is in reset use hard coded values */
  254. if (!(wm8400->reg_cache[WM8400_POWER_MANAGEMENT_1] & WM8400_CODEC_ENA))
  255. for (i = 0; i < ARRAY_SIZE(wm8400->reg_cache); i++)
  256. if (reg_data[i].is_codec)
  257. wm8400->reg_cache[i] = reg_data[i].default_val;
  258. ret = wm8400_read(wm8400, WM8400_ID, 1, &reg);
  259. if (ret != 0) {
  260. dev_err(wm8400->dev, "ID register read failed: %d\n", ret);
  261. return ret;
  262. }
  263. reg = (reg & WM8400_CHIP_REV_MASK) >> WM8400_CHIP_REV_SHIFT;
  264. dev_info(wm8400->dev, "WM8400 revision %x\n", reg);
  265. ret = wm8400_register_codec(wm8400);
  266. if (ret != 0) {
  267. dev_err(wm8400->dev, "Failed to register codec\n");
  268. goto err_children;
  269. }
  270. if (pdata && pdata->platform_init) {
  271. ret = pdata->platform_init(wm8400->dev);
  272. if (ret != 0) {
  273. dev_err(wm8400->dev, "Platform init failed: %d\n",
  274. ret);
  275. goto err_children;
  276. }
  277. } else
  278. dev_warn(wm8400->dev, "No platform initialisation supplied\n");
  279. return 0;
  280. err_children:
  281. mfd_remove_devices(wm8400->dev);
  282. return ret;
  283. }
  284. static void wm8400_release(struct wm8400 *wm8400)
  285. {
  286. mfd_remove_devices(wm8400->dev);
  287. }
  288. static const struct regmap_config wm8400_regmap_config = {
  289. .reg_bits = 8,
  290. .val_bits = 16,
  291. .max_register = WM8400_REGISTER_COUNT - 1,
  292. };
  293. #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
  294. static int wm8400_i2c_probe(struct i2c_client *i2c,
  295. const struct i2c_device_id *id)
  296. {
  297. struct wm8400 *wm8400;
  298. int ret;
  299. wm8400 = devm_kzalloc(&i2c->dev, sizeof(struct wm8400), GFP_KERNEL);
  300. if (wm8400 == NULL) {
  301. ret = -ENOMEM;
  302. goto err;
  303. }
  304. wm8400->regmap = devm_regmap_init_i2c(i2c, &wm8400_regmap_config);
  305. if (IS_ERR(wm8400->regmap)) {
  306. ret = PTR_ERR(wm8400->regmap);
  307. goto err;
  308. }
  309. wm8400->dev = &i2c->dev;
  310. i2c_set_clientdata(i2c, wm8400);
  311. ret = wm8400_init(wm8400, i2c->dev.platform_data);
  312. if (ret != 0)
  313. goto err;
  314. return 0;
  315. err:
  316. return ret;
  317. }
  318. static int wm8400_i2c_remove(struct i2c_client *i2c)
  319. {
  320. struct wm8400 *wm8400 = i2c_get_clientdata(i2c);
  321. wm8400_release(wm8400);
  322. return 0;
  323. }
  324. static const struct i2c_device_id wm8400_i2c_id[] = {
  325. { "wm8400", 0 },
  326. { }
  327. };
  328. MODULE_DEVICE_TABLE(i2c, wm8400_i2c_id);
  329. static struct i2c_driver wm8400_i2c_driver = {
  330. .driver = {
  331. .name = "WM8400",
  332. .owner = THIS_MODULE,
  333. },
  334. .probe = wm8400_i2c_probe,
  335. .remove = wm8400_i2c_remove,
  336. .id_table = wm8400_i2c_id,
  337. };
  338. #endif
  339. static int __init wm8400_module_init(void)
  340. {
  341. int ret = -ENODEV;
  342. #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
  343. ret = i2c_add_driver(&wm8400_i2c_driver);
  344. if (ret != 0)
  345. pr_err("Failed to register I2C driver: %d\n", ret);
  346. #endif
  347. return ret;
  348. }
  349. subsys_initcall(wm8400_module_init);
  350. static void __exit wm8400_module_exit(void)
  351. {
  352. #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
  353. i2c_del_driver(&wm8400_i2c_driver);
  354. #endif
  355. }
  356. module_exit(wm8400_module_exit);
  357. MODULE_LICENSE("GPL");
  358. MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");