lochnagar-i2c.c 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398
  1. // SPDX-License-Identifier: GPL-2.0
  2. /*
  3. * Lochnagar I2C bus interface
  4. *
  5. * Copyright (c) 2012-2018 Cirrus Logic, Inc. and
  6. * Cirrus Logic International Semiconductor Ltd.
  7. *
  8. * Author: Charles Keepax <ckeepax@opensource.cirrus.com>
  9. */
  10. #include <linux/delay.h>
  11. #include <linux/device.h>
  12. #include <linux/err.h>
  13. #include <linux/gpio/consumer.h>
  14. #include <linux/i2c.h>
  15. #include <linux/lockdep.h>
  16. #include <linux/mfd/core.h>
  17. #include <linux/mutex.h>
  18. #include <linux/of.h>
  19. #include <linux/of_platform.h>
  20. #include <linux/regmap.h>
  21. #include <linux/mfd/lochnagar.h>
  22. #include <linux/mfd/lochnagar1_regs.h>
  23. #include <linux/mfd/lochnagar2_regs.h>
  24. #define LOCHNAGAR_BOOT_RETRIES 10
  25. #define LOCHNAGAR_BOOT_DELAY_MS 350
  26. #define LOCHNAGAR_CONFIG_POLL_US 10000
  27. static bool lochnagar1_readable_register(struct device *dev, unsigned int reg)
  28. {
  29. switch (reg) {
  30. case LOCHNAGAR_SOFTWARE_RESET:
  31. case LOCHNAGAR_FIRMWARE_ID1...LOCHNAGAR_FIRMWARE_ID2:
  32. case LOCHNAGAR1_CDC_AIF1_SEL...LOCHNAGAR1_CDC_AIF3_SEL:
  33. case LOCHNAGAR1_CDC_MCLK1_SEL...LOCHNAGAR1_CDC_MCLK2_SEL:
  34. case LOCHNAGAR1_CDC_AIF_CTRL1...LOCHNAGAR1_CDC_AIF_CTRL2:
  35. case LOCHNAGAR1_EXT_AIF_CTRL:
  36. case LOCHNAGAR1_DSP_AIF1_SEL...LOCHNAGAR1_DSP_AIF2_SEL:
  37. case LOCHNAGAR1_DSP_CLKIN_SEL:
  38. case LOCHNAGAR1_DSP_AIF:
  39. case LOCHNAGAR1_GF_AIF1...LOCHNAGAR1_GF_AIF2:
  40. case LOCHNAGAR1_PSIA_AIF:
  41. case LOCHNAGAR1_PSIA1_SEL...LOCHNAGAR1_PSIA2_SEL:
  42. case LOCHNAGAR1_SPDIF_AIF_SEL:
  43. case LOCHNAGAR1_GF_AIF3_SEL...LOCHNAGAR1_GF_AIF4_SEL:
  44. case LOCHNAGAR1_GF_CLKOUT1_SEL:
  45. case LOCHNAGAR1_GF_AIF1_SEL...LOCHNAGAR1_GF_AIF2_SEL:
  46. case LOCHNAGAR1_GF_GPIO2...LOCHNAGAR1_GF_GPIO7:
  47. case LOCHNAGAR1_RST:
  48. case LOCHNAGAR1_LED1...LOCHNAGAR1_LED2:
  49. case LOCHNAGAR1_I2C_CTRL:
  50. return true;
  51. default:
  52. return false;
  53. }
  54. }
  55. static const struct regmap_config lochnagar1_i2c_regmap = {
  56. .reg_bits = 8,
  57. .val_bits = 8,
  58. .reg_format_endian = REGMAP_ENDIAN_BIG,
  59. .val_format_endian = REGMAP_ENDIAN_BIG,
  60. .max_register = 0x50,
  61. .readable_reg = lochnagar1_readable_register,
  62. .use_single_read = true,
  63. .use_single_write = true,
  64. .cache_type = REGCACHE_RBTREE,
  65. };
  66. static const struct reg_sequence lochnagar1_patch[] = {
  67. { 0x40, 0x0083 },
  68. { 0x47, 0x0018 },
  69. { 0x50, 0x0000 },
  70. };
  71. static bool lochnagar2_readable_register(struct device *dev, unsigned int reg)
  72. {
  73. switch (reg) {
  74. case LOCHNAGAR_SOFTWARE_RESET:
  75. case LOCHNAGAR_FIRMWARE_ID1...LOCHNAGAR_FIRMWARE_ID2:
  76. case LOCHNAGAR2_CDC_AIF1_CTRL...LOCHNAGAR2_CDC_AIF3_CTRL:
  77. case LOCHNAGAR2_DSP_AIF1_CTRL...LOCHNAGAR2_DSP_AIF2_CTRL:
  78. case LOCHNAGAR2_PSIA1_CTRL...LOCHNAGAR2_PSIA2_CTRL:
  79. case LOCHNAGAR2_GF_AIF3_CTRL...LOCHNAGAR2_GF_AIF4_CTRL:
  80. case LOCHNAGAR2_GF_AIF1_CTRL...LOCHNAGAR2_GF_AIF2_CTRL:
  81. case LOCHNAGAR2_SPDIF_AIF_CTRL:
  82. case LOCHNAGAR2_USB_AIF1_CTRL...LOCHNAGAR2_USB_AIF2_CTRL:
  83. case LOCHNAGAR2_ADAT_AIF_CTRL:
  84. case LOCHNAGAR2_CDC_MCLK1_CTRL...LOCHNAGAR2_CDC_MCLK2_CTRL:
  85. case LOCHNAGAR2_DSP_CLKIN_CTRL:
  86. case LOCHNAGAR2_PSIA1_MCLK_CTRL...LOCHNAGAR2_PSIA2_MCLK_CTRL:
  87. case LOCHNAGAR2_SPDIF_MCLK_CTRL:
  88. case LOCHNAGAR2_GF_CLKOUT1_CTRL...LOCHNAGAR2_GF_CLKOUT2_CTRL:
  89. case LOCHNAGAR2_ADAT_MCLK_CTRL:
  90. case LOCHNAGAR2_SOUNDCARD_MCLK_CTRL:
  91. case LOCHNAGAR2_GPIO_FPGA_GPIO1...LOCHNAGAR2_GPIO_FPGA_GPIO6:
  92. case LOCHNAGAR2_GPIO_CDC_GPIO1...LOCHNAGAR2_GPIO_CDC_GPIO8:
  93. case LOCHNAGAR2_GPIO_DSP_GPIO1...LOCHNAGAR2_GPIO_DSP_GPIO6:
  94. case LOCHNAGAR2_GPIO_GF_GPIO2...LOCHNAGAR2_GPIO_GF_GPIO7:
  95. case LOCHNAGAR2_GPIO_CDC_AIF1_BCLK...LOCHNAGAR2_GPIO_CDC_AIF3_TXDAT:
  96. case LOCHNAGAR2_GPIO_DSP_AIF1_BCLK...LOCHNAGAR2_GPIO_DSP_AIF2_TXDAT:
  97. case LOCHNAGAR2_GPIO_PSIA1_BCLK...LOCHNAGAR2_GPIO_PSIA2_TXDAT:
  98. case LOCHNAGAR2_GPIO_GF_AIF3_BCLK...LOCHNAGAR2_GPIO_GF_AIF4_TXDAT:
  99. case LOCHNAGAR2_GPIO_GF_AIF1_BCLK...LOCHNAGAR2_GPIO_GF_AIF2_TXDAT:
  100. case LOCHNAGAR2_GPIO_DSP_UART1_RX...LOCHNAGAR2_GPIO_DSP_UART2_TX:
  101. case LOCHNAGAR2_GPIO_GF_UART2_RX...LOCHNAGAR2_GPIO_GF_UART2_TX:
  102. case LOCHNAGAR2_GPIO_USB_UART_RX:
  103. case LOCHNAGAR2_GPIO_CDC_PDMCLK1...LOCHNAGAR2_GPIO_CDC_PDMDAT2:
  104. case LOCHNAGAR2_GPIO_CDC_DMICCLK1...LOCHNAGAR2_GPIO_CDC_DMICDAT4:
  105. case LOCHNAGAR2_GPIO_DSP_DMICCLK1...LOCHNAGAR2_GPIO_DSP_DMICDAT2:
  106. case LOCHNAGAR2_GPIO_I2C2_SCL...LOCHNAGAR2_GPIO_I2C4_SDA:
  107. case LOCHNAGAR2_GPIO_DSP_STANDBY:
  108. case LOCHNAGAR2_GPIO_CDC_MCLK1...LOCHNAGAR2_GPIO_CDC_MCLK2:
  109. case LOCHNAGAR2_GPIO_DSP_CLKIN:
  110. case LOCHNAGAR2_GPIO_PSIA1_MCLK...LOCHNAGAR2_GPIO_PSIA2_MCLK:
  111. case LOCHNAGAR2_GPIO_GF_GPIO1...LOCHNAGAR2_GPIO_GF_GPIO5:
  112. case LOCHNAGAR2_GPIO_DSP_GPIO20:
  113. case LOCHNAGAR2_GPIO_CHANNEL1...LOCHNAGAR2_GPIO_CHANNEL16:
  114. case LOCHNAGAR2_MINICARD_RESETS:
  115. case LOCHNAGAR2_ANALOGUE_PATH_CTRL1...LOCHNAGAR2_ANALOGUE_PATH_CTRL2:
  116. case LOCHNAGAR2_COMMS_CTRL4:
  117. case LOCHNAGAR2_SPDIF_CTRL:
  118. case LOCHNAGAR2_IMON_CTRL1...LOCHNAGAR2_IMON_CTRL4:
  119. case LOCHNAGAR2_IMON_DATA1...LOCHNAGAR2_IMON_DATA2:
  120. case LOCHNAGAR2_POWER_CTRL:
  121. case LOCHNAGAR2_MICVDD_CTRL1:
  122. case LOCHNAGAR2_MICVDD_CTRL2:
  123. case LOCHNAGAR2_VDDCORE_CDC_CTRL1:
  124. case LOCHNAGAR2_VDDCORE_CDC_CTRL2:
  125. case LOCHNAGAR2_SOUNDCARD_AIF_CTRL:
  126. return true;
  127. default:
  128. return false;
  129. }
  130. }
  131. static bool lochnagar2_volatile_register(struct device *dev, unsigned int reg)
  132. {
  133. switch (reg) {
  134. case LOCHNAGAR2_GPIO_CHANNEL1...LOCHNAGAR2_GPIO_CHANNEL16:
  135. case LOCHNAGAR2_ANALOGUE_PATH_CTRL1:
  136. case LOCHNAGAR2_IMON_CTRL3...LOCHNAGAR2_IMON_CTRL4:
  137. case LOCHNAGAR2_IMON_DATA1...LOCHNAGAR2_IMON_DATA2:
  138. return true;
  139. default:
  140. return false;
  141. }
  142. }
  143. static const struct regmap_config lochnagar2_i2c_regmap = {
  144. .reg_bits = 16,
  145. .val_bits = 16,
  146. .reg_format_endian = REGMAP_ENDIAN_BIG,
  147. .val_format_endian = REGMAP_ENDIAN_BIG,
  148. .max_register = 0x1F1F,
  149. .readable_reg = lochnagar2_readable_register,
  150. .volatile_reg = lochnagar2_volatile_register,
  151. .cache_type = REGCACHE_RBTREE,
  152. };
  153. static const struct reg_sequence lochnagar2_patch[] = {
  154. { 0x00EE, 0x0000 },
  155. };
  156. struct lochnagar_config {
  157. int id;
  158. const char * const name;
  159. enum lochnagar_type type;
  160. const struct regmap_config *regmap;
  161. const struct reg_sequence *patch;
  162. int npatch;
  163. };
  164. static struct lochnagar_config lochnagar_configs[] = {
  165. {
  166. .id = 0x50,
  167. .name = "lochnagar1",
  168. .type = LOCHNAGAR1,
  169. .regmap = &lochnagar1_i2c_regmap,
  170. .patch = lochnagar1_patch,
  171. .npatch = ARRAY_SIZE(lochnagar1_patch),
  172. },
  173. {
  174. .id = 0xCB58,
  175. .name = "lochnagar2",
  176. .type = LOCHNAGAR2,
  177. .regmap = &lochnagar2_i2c_regmap,
  178. .patch = lochnagar2_patch,
  179. .npatch = ARRAY_SIZE(lochnagar2_patch),
  180. },
  181. };
  182. static const struct of_device_id lochnagar_of_match[] = {
  183. { .compatible = "cirrus,lochnagar1", .data = &lochnagar_configs[0] },
  184. { .compatible = "cirrus,lochnagar2", .data = &lochnagar_configs[1] },
  185. {},
  186. };
  187. static int lochnagar_wait_for_boot(struct regmap *regmap, unsigned int *id)
  188. {
  189. int i, ret;
  190. for (i = 0; i < LOCHNAGAR_BOOT_RETRIES; ++i) {
  191. msleep(LOCHNAGAR_BOOT_DELAY_MS);
  192. /* The reset register will return the device ID when read */
  193. ret = regmap_read(regmap, LOCHNAGAR_SOFTWARE_RESET, id);
  194. if (!ret)
  195. return ret;
  196. }
  197. return -ETIMEDOUT;
  198. }
  199. /**
  200. * lochnagar_update_config - Synchronise the boards analogue configuration to
  201. * the hardware.
  202. *
  203. * @lochnagar: A pointer to the primary core data structure.
  204. *
  205. * Return: Zero on success or an appropriate negative error code on failure.
  206. */
  207. int lochnagar_update_config(struct lochnagar *lochnagar)
  208. {
  209. struct regmap *regmap = lochnagar->regmap;
  210. unsigned int done = LOCHNAGAR2_ANALOGUE_PATH_UPDATE_STS_MASK;
  211. int timeout_ms = LOCHNAGAR_BOOT_DELAY_MS * LOCHNAGAR_BOOT_RETRIES;
  212. unsigned int val = 0;
  213. int ret;
  214. lockdep_assert_held(&lochnagar->analogue_config_lock);
  215. if (lochnagar->type != LOCHNAGAR2)
  216. return 0;
  217. /*
  218. * Toggle the ANALOGUE_PATH_UPDATE bit and wait for the device to
  219. * acknowledge that any outstanding changes to the analogue
  220. * configuration have been applied.
  221. */
  222. ret = regmap_write(regmap, LOCHNAGAR2_ANALOGUE_PATH_CTRL1, 0);
  223. if (ret < 0)
  224. return ret;
  225. ret = regmap_write(regmap, LOCHNAGAR2_ANALOGUE_PATH_CTRL1,
  226. LOCHNAGAR2_ANALOGUE_PATH_UPDATE_MASK);
  227. if (ret < 0)
  228. return ret;
  229. ret = regmap_read_poll_timeout(regmap,
  230. LOCHNAGAR2_ANALOGUE_PATH_CTRL1, val,
  231. (val & done), LOCHNAGAR_CONFIG_POLL_US,
  232. timeout_ms * 1000);
  233. if (ret < 0)
  234. return ret;
  235. return 0;
  236. }
  237. EXPORT_SYMBOL_GPL(lochnagar_update_config);
  238. static int lochnagar_i2c_probe(struct i2c_client *i2c)
  239. {
  240. struct device *dev = &i2c->dev;
  241. const struct lochnagar_config *config = NULL;
  242. const struct of_device_id *of_id;
  243. struct lochnagar *lochnagar;
  244. struct gpio_desc *reset, *present;
  245. unsigned int val;
  246. unsigned int firmwareid;
  247. unsigned int devid, rev;
  248. int ret;
  249. lochnagar = devm_kzalloc(dev, sizeof(*lochnagar), GFP_KERNEL);
  250. if (!lochnagar)
  251. return -ENOMEM;
  252. of_id = of_match_device(lochnagar_of_match, dev);
  253. if (!of_id)
  254. return -EINVAL;
  255. config = of_id->data;
  256. lochnagar->dev = dev;
  257. mutex_init(&lochnagar->analogue_config_lock);
  258. dev_set_drvdata(dev, lochnagar);
  259. reset = devm_gpiod_get(dev, "reset", GPIOD_OUT_LOW);
  260. if (IS_ERR(reset)) {
  261. ret = PTR_ERR(reset);
  262. dev_err(dev, "Failed to get reset GPIO: %d\n", ret);
  263. return ret;
  264. }
  265. present = devm_gpiod_get_optional(dev, "present", GPIOD_OUT_HIGH);
  266. if (IS_ERR(present)) {
  267. ret = PTR_ERR(present);
  268. dev_err(dev, "Failed to get present GPIO: %d\n", ret);
  269. return ret;
  270. }
  271. /* Leave the Lochnagar in reset for a reasonable amount of time */
  272. msleep(20);
  273. /* Bring Lochnagar out of reset */
  274. gpiod_set_value_cansleep(reset, 1);
  275. /* Identify Lochnagar */
  276. lochnagar->type = config->type;
  277. lochnagar->regmap = devm_regmap_init_i2c(i2c, config->regmap);
  278. if (IS_ERR(lochnagar->regmap)) {
  279. ret = PTR_ERR(lochnagar->regmap);
  280. dev_err(dev, "Failed to allocate register map: %d\n", ret);
  281. return ret;
  282. }
  283. /* Wait for Lochnagar to boot */
  284. ret = lochnagar_wait_for_boot(lochnagar->regmap, &val);
  285. if (ret < 0) {
  286. dev_err(dev, "Failed to read device ID: %d\n", ret);
  287. return ret;
  288. }
  289. devid = val & LOCHNAGAR_DEVICE_ID_MASK;
  290. rev = val & LOCHNAGAR_REV_ID_MASK;
  291. if (devid != config->id) {
  292. dev_err(dev,
  293. "ID does not match %s (expected 0x%x got 0x%x)\n",
  294. config->name, config->id, devid);
  295. return -ENODEV;
  296. }
  297. /* Identify firmware */
  298. ret = regmap_read(lochnagar->regmap, LOCHNAGAR_FIRMWARE_ID1, &val);
  299. if (ret < 0) {
  300. dev_err(dev, "Failed to read firmware id 1: %d\n", ret);
  301. return ret;
  302. }
  303. firmwareid = val;
  304. ret = regmap_read(lochnagar->regmap, LOCHNAGAR_FIRMWARE_ID2, &val);
  305. if (ret < 0) {
  306. dev_err(dev, "Failed to read firmware id 2: %d\n", ret);
  307. return ret;
  308. }
  309. firmwareid |= (val << config->regmap->val_bits);
  310. dev_info(dev, "Found %s (0x%x) revision %u firmware 0x%.6x\n",
  311. config->name, devid, rev + 1, firmwareid);
  312. ret = regmap_register_patch(lochnagar->regmap, config->patch,
  313. config->npatch);
  314. if (ret < 0) {
  315. dev_err(dev, "Failed to register patch: %d\n", ret);
  316. return ret;
  317. }
  318. ret = devm_of_platform_populate(dev);
  319. if (ret < 0) {
  320. dev_err(dev, "Failed to populate child nodes: %d\n", ret);
  321. return ret;
  322. }
  323. return ret;
  324. }
  325. static struct i2c_driver lochnagar_i2c_driver = {
  326. .driver = {
  327. .name = "lochnagar",
  328. .of_match_table = of_match_ptr(lochnagar_of_match),
  329. .suppress_bind_attrs = true,
  330. },
  331. .probe_new = lochnagar_i2c_probe,
  332. };
  333. static int __init lochnagar_i2c_init(void)
  334. {
  335. int ret;
  336. ret = i2c_add_driver(&lochnagar_i2c_driver);
  337. if (ret)
  338. pr_err("Failed to register Lochnagar driver: %d\n", ret);
  339. return ret;
  340. }
  341. subsys_initcall(lochnagar_i2c_init);