leds-lp8501.c 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * TI LP8501 9 channel LED Driver
  4. *
  5. * Copyright (C) 2013 Texas Instruments
  6. *
  7. * Author: Milo(Woogyom) Kim <milo.kim@ti.com>
  8. */
  9. #include <linux/delay.h>
  10. #include <linux/firmware.h>
  11. #include <linux/i2c.h>
  12. #include <linux/init.h>
  13. #include <linux/leds.h>
  14. #include <linux/module.h>
  15. #include <linux/mutex.h>
  16. #include <linux/of.h>
  17. #include <linux/platform_data/leds-lp55xx.h>
  18. #include <linux/slab.h>
  19. #include "leds-lp55xx-common.h"
  20. #define LP8501_PROGRAM_LENGTH 32
  21. #define LP8501_MAX_LEDS 9
  22. /* Registers */
  23. #define LP8501_REG_ENABLE 0x00
  24. #define LP8501_ENABLE BIT(6)
  25. #define LP8501_EXEC_M 0x3F
  26. #define LP8501_EXEC_ENG1_M 0x30
  27. #define LP8501_EXEC_ENG2_M 0x0C
  28. #define LP8501_EXEC_ENG3_M 0x03
  29. #define LP8501_RUN_ENG1 0x20
  30. #define LP8501_RUN_ENG2 0x08
  31. #define LP8501_RUN_ENG3 0x02
  32. #define LP8501_REG_OP_MODE 0x01
  33. #define LP8501_MODE_ENG1_M 0x30
  34. #define LP8501_MODE_ENG2_M 0x0C
  35. #define LP8501_MODE_ENG3_M 0x03
  36. #define LP8501_LOAD_ENG1 0x10
  37. #define LP8501_LOAD_ENG2 0x04
  38. #define LP8501_LOAD_ENG3 0x01
  39. #define LP8501_REG_PWR_CONFIG 0x05
  40. #define LP8501_PWR_CONFIG_M 0x03
  41. #define LP8501_REG_LED_PWM_BASE 0x16
  42. #define LP8501_REG_LED_CURRENT_BASE 0x26
  43. #define LP8501_REG_CONFIG 0x36
  44. #define LP8501_PWM_PSAVE BIT(7)
  45. #define LP8501_AUTO_INC BIT(6)
  46. #define LP8501_PWR_SAVE BIT(5)
  47. #define LP8501_CP_AUTO 0x18
  48. #define LP8501_INT_CLK BIT(0)
  49. #define LP8501_DEFAULT_CFG \
  50. (LP8501_PWM_PSAVE | LP8501_AUTO_INC | LP8501_PWR_SAVE | LP8501_CP_AUTO)
  51. #define LP8501_REG_RESET 0x3D
  52. #define LP8501_RESET 0xFF
  53. #define LP8501_REG_PROG_PAGE_SEL 0x4F
  54. #define LP8501_PAGE_ENG1 0
  55. #define LP8501_PAGE_ENG2 1
  56. #define LP8501_PAGE_ENG3 2
  57. #define LP8501_REG_PROG_MEM 0x50
  58. #define LP8501_ENG1_IS_LOADING(mode) \
  59. ((mode & LP8501_MODE_ENG1_M) == LP8501_LOAD_ENG1)
  60. #define LP8501_ENG2_IS_LOADING(mode) \
  61. ((mode & LP8501_MODE_ENG2_M) == LP8501_LOAD_ENG2)
  62. #define LP8501_ENG3_IS_LOADING(mode) \
  63. ((mode & LP8501_MODE_ENG3_M) == LP8501_LOAD_ENG3)
  64. static inline void lp8501_wait_opmode_done(void)
  65. {
  66. usleep_range(1000, 2000);
  67. }
  68. static void lp8501_set_led_current(struct lp55xx_led *led, u8 led_current)
  69. {
  70. led->led_current = led_current;
  71. lp55xx_write(led->chip, LP8501_REG_LED_CURRENT_BASE + led->chan_nr,
  72. led_current);
  73. }
  74. static int lp8501_post_init_device(struct lp55xx_chip *chip)
  75. {
  76. int ret;
  77. u8 val = LP8501_DEFAULT_CFG;
  78. ret = lp55xx_write(chip, LP8501_REG_ENABLE, LP8501_ENABLE);
  79. if (ret)
  80. return ret;
  81. /* Chip startup time is 500 us, 1 - 2 ms gives some margin */
  82. usleep_range(1000, 2000);
  83. if (chip->pdata->clock_mode != LP55XX_CLOCK_EXT)
  84. val |= LP8501_INT_CLK;
  85. ret = lp55xx_write(chip, LP8501_REG_CONFIG, val);
  86. if (ret)
  87. return ret;
  88. /* Power selection for each output */
  89. return lp55xx_update_bits(chip, LP8501_REG_PWR_CONFIG,
  90. LP8501_PWR_CONFIG_M, chip->pdata->pwr_sel);
  91. }
  92. static void lp8501_load_engine(struct lp55xx_chip *chip)
  93. {
  94. enum lp55xx_engine_index idx = chip->engine_idx;
  95. static const u8 mask[] = {
  96. [LP55XX_ENGINE_1] = LP8501_MODE_ENG1_M,
  97. [LP55XX_ENGINE_2] = LP8501_MODE_ENG2_M,
  98. [LP55XX_ENGINE_3] = LP8501_MODE_ENG3_M,
  99. };
  100. static const u8 val[] = {
  101. [LP55XX_ENGINE_1] = LP8501_LOAD_ENG1,
  102. [LP55XX_ENGINE_2] = LP8501_LOAD_ENG2,
  103. [LP55XX_ENGINE_3] = LP8501_LOAD_ENG3,
  104. };
  105. static const u8 page_sel[] = {
  106. [LP55XX_ENGINE_1] = LP8501_PAGE_ENG1,
  107. [LP55XX_ENGINE_2] = LP8501_PAGE_ENG2,
  108. [LP55XX_ENGINE_3] = LP8501_PAGE_ENG3,
  109. };
  110. lp55xx_update_bits(chip, LP8501_REG_OP_MODE, mask[idx], val[idx]);
  111. lp8501_wait_opmode_done();
  112. lp55xx_write(chip, LP8501_REG_PROG_PAGE_SEL, page_sel[idx]);
  113. }
  114. static void lp8501_stop_engine(struct lp55xx_chip *chip)
  115. {
  116. lp55xx_write(chip, LP8501_REG_OP_MODE, 0);
  117. lp8501_wait_opmode_done();
  118. }
  119. static void lp8501_turn_off_channels(struct lp55xx_chip *chip)
  120. {
  121. int i;
  122. for (i = 0; i < LP8501_MAX_LEDS; i++)
  123. lp55xx_write(chip, LP8501_REG_LED_PWM_BASE + i, 0);
  124. }
  125. static void lp8501_run_engine(struct lp55xx_chip *chip, bool start)
  126. {
  127. int ret;
  128. u8 mode;
  129. u8 exec;
  130. /* stop engine */
  131. if (!start) {
  132. lp8501_stop_engine(chip);
  133. lp8501_turn_off_channels(chip);
  134. return;
  135. }
  136. /*
  137. * To run the engine,
  138. * operation mode and enable register should updated at the same time
  139. */
  140. ret = lp55xx_read(chip, LP8501_REG_OP_MODE, &mode);
  141. if (ret)
  142. return;
  143. ret = lp55xx_read(chip, LP8501_REG_ENABLE, &exec);
  144. if (ret)
  145. return;
  146. /* change operation mode to RUN only when each engine is loading */
  147. if (LP8501_ENG1_IS_LOADING(mode)) {
  148. mode = (mode & ~LP8501_MODE_ENG1_M) | LP8501_RUN_ENG1;
  149. exec = (exec & ~LP8501_EXEC_ENG1_M) | LP8501_RUN_ENG1;
  150. }
  151. if (LP8501_ENG2_IS_LOADING(mode)) {
  152. mode = (mode & ~LP8501_MODE_ENG2_M) | LP8501_RUN_ENG2;
  153. exec = (exec & ~LP8501_EXEC_ENG2_M) | LP8501_RUN_ENG2;
  154. }
  155. if (LP8501_ENG3_IS_LOADING(mode)) {
  156. mode = (mode & ~LP8501_MODE_ENG3_M) | LP8501_RUN_ENG3;
  157. exec = (exec & ~LP8501_EXEC_ENG3_M) | LP8501_RUN_ENG3;
  158. }
  159. lp55xx_write(chip, LP8501_REG_OP_MODE, mode);
  160. lp8501_wait_opmode_done();
  161. lp55xx_update_bits(chip, LP8501_REG_ENABLE, LP8501_EXEC_M, exec);
  162. }
  163. static int lp8501_update_program_memory(struct lp55xx_chip *chip,
  164. const u8 *data, size_t size)
  165. {
  166. u8 pattern[LP8501_PROGRAM_LENGTH] = {0};
  167. unsigned cmd;
  168. char c[3];
  169. int update_size;
  170. int nrchars;
  171. int offset = 0;
  172. int ret;
  173. int i;
  174. /* clear program memory before updating */
  175. for (i = 0; i < LP8501_PROGRAM_LENGTH; i++)
  176. lp55xx_write(chip, LP8501_REG_PROG_MEM + i, 0);
  177. i = 0;
  178. while ((offset < size - 1) && (i < LP8501_PROGRAM_LENGTH)) {
  179. /* separate sscanfs because length is working only for %s */
  180. ret = sscanf(data + offset, "%2s%n ", c, &nrchars);
  181. if (ret != 1)
  182. goto err;
  183. ret = sscanf(c, "%2x", &cmd);
  184. if (ret != 1)
  185. goto err;
  186. pattern[i] = (u8)cmd;
  187. offset += nrchars;
  188. i++;
  189. }
  190. /* Each instruction is 16bit long. Check that length is even */
  191. if (i % 2)
  192. goto err;
  193. update_size = i;
  194. for (i = 0; i < update_size; i++)
  195. lp55xx_write(chip, LP8501_REG_PROG_MEM + i, pattern[i]);
  196. return 0;
  197. err:
  198. dev_err(&chip->cl->dev, "wrong pattern format\n");
  199. return -EINVAL;
  200. }
  201. static void lp8501_firmware_loaded(struct lp55xx_chip *chip)
  202. {
  203. const struct firmware *fw = chip->fw;
  204. if (fw->size > LP8501_PROGRAM_LENGTH) {
  205. dev_err(&chip->cl->dev, "firmware data size overflow: %zu\n",
  206. fw->size);
  207. return;
  208. }
  209. /*
  210. * Program memory sequence
  211. * 1) set engine mode to "LOAD"
  212. * 2) write firmware data into program memory
  213. */
  214. lp8501_load_engine(chip);
  215. lp8501_update_program_memory(chip, fw->data, fw->size);
  216. }
  217. static int lp8501_led_brightness(struct lp55xx_led *led)
  218. {
  219. struct lp55xx_chip *chip = led->chip;
  220. int ret;
  221. mutex_lock(&chip->lock);
  222. ret = lp55xx_write(chip, LP8501_REG_LED_PWM_BASE + led->chan_nr,
  223. led->brightness);
  224. mutex_unlock(&chip->lock);
  225. return ret;
  226. }
  227. /* Chip specific configurations */
  228. static struct lp55xx_device_config lp8501_cfg = {
  229. .reset = {
  230. .addr = LP8501_REG_RESET,
  231. .val = LP8501_RESET,
  232. },
  233. .enable = {
  234. .addr = LP8501_REG_ENABLE,
  235. .val = LP8501_ENABLE,
  236. },
  237. .max_channel = LP8501_MAX_LEDS,
  238. .post_init_device = lp8501_post_init_device,
  239. .brightness_fn = lp8501_led_brightness,
  240. .set_led_current = lp8501_set_led_current,
  241. .firmware_cb = lp8501_firmware_loaded,
  242. .run_engine = lp8501_run_engine,
  243. };
  244. static int lp8501_probe(struct i2c_client *client,
  245. const struct i2c_device_id *id)
  246. {
  247. int ret;
  248. struct lp55xx_chip *chip;
  249. struct lp55xx_led *led;
  250. struct lp55xx_platform_data *pdata = dev_get_platdata(&client->dev);
  251. struct device_node *np = dev_of_node(&client->dev);
  252. chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
  253. if (!chip)
  254. return -ENOMEM;
  255. chip->cfg = &lp8501_cfg;
  256. if (!pdata) {
  257. if (np) {
  258. pdata = lp55xx_of_populate_pdata(&client->dev, np,
  259. chip);
  260. if (IS_ERR(pdata))
  261. return PTR_ERR(pdata);
  262. } else {
  263. dev_err(&client->dev, "no platform data\n");
  264. return -EINVAL;
  265. }
  266. }
  267. led = devm_kcalloc(&client->dev,
  268. pdata->num_channels, sizeof(*led), GFP_KERNEL);
  269. if (!led)
  270. return -ENOMEM;
  271. chip->cl = client;
  272. chip->pdata = pdata;
  273. mutex_init(&chip->lock);
  274. i2c_set_clientdata(client, led);
  275. ret = lp55xx_init_device(chip);
  276. if (ret)
  277. goto err_init;
  278. dev_info(&client->dev, "%s Programmable led chip found\n", id->name);
  279. ret = lp55xx_register_leds(led, chip);
  280. if (ret)
  281. goto err_out;
  282. ret = lp55xx_register_sysfs(chip);
  283. if (ret) {
  284. dev_err(&client->dev, "registering sysfs failed\n");
  285. goto err_out;
  286. }
  287. return 0;
  288. err_out:
  289. lp55xx_deinit_device(chip);
  290. err_init:
  291. return ret;
  292. }
  293. static int lp8501_remove(struct i2c_client *client)
  294. {
  295. struct lp55xx_led *led = i2c_get_clientdata(client);
  296. struct lp55xx_chip *chip = led->chip;
  297. lp8501_stop_engine(chip);
  298. lp55xx_unregister_sysfs(chip);
  299. lp55xx_deinit_device(chip);
  300. return 0;
  301. }
  302. static const struct i2c_device_id lp8501_id[] = {
  303. { "lp8501", 0 },
  304. { }
  305. };
  306. MODULE_DEVICE_TABLE(i2c, lp8501_id);
  307. #ifdef CONFIG_OF
  308. static const struct of_device_id of_lp8501_leds_match[] = {
  309. { .compatible = "ti,lp8501", },
  310. {},
  311. };
  312. MODULE_DEVICE_TABLE(of, of_lp8501_leds_match);
  313. #endif
  314. static struct i2c_driver lp8501_driver = {
  315. .driver = {
  316. .name = "lp8501",
  317. .of_match_table = of_match_ptr(of_lp8501_leds_match),
  318. },
  319. .probe = lp8501_probe,
  320. .remove = lp8501_remove,
  321. .id_table = lp8501_id,
  322. };
  323. module_i2c_driver(lp8501_driver);
  324. MODULE_DESCRIPTION("Texas Instruments LP8501 LED driver");
  325. MODULE_AUTHOR("Milo Kim");
  326. MODULE_LICENSE("GPL");