blob: 4ade66a2d9d4758b314c45ed52a222ff0cb0aeca [file] [log] [blame]
Samu Onkalo0efba162010-11-11 14:05:22 -08001/*
2 * lp5523.c - LP5523 LED Driver
3 *
4 * Copyright (C) 2010 Nokia Corporation
Milo(Woogyom) Kima2387cb2013-02-05 19:28:00 +09005 * Copyright (C) 2012 Texas Instruments
Samu Onkalo0efba162010-11-11 14:05:22 -08006 *
7 * Contact: Samu Onkalo <samu.p.onkalo@nokia.com>
Milo(Woogyom) Kima2387cb2013-02-05 19:28:00 +09008 * Milo(Woogyom) Kim <milo.kim@ti.com>
Samu Onkalo0efba162010-11-11 14:05:22 -08009 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * version 2 as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 * 02110-1301 USA
23 */
24
Samu Onkalo0efba162010-11-11 14:05:22 -080025#include <linux/delay.h>
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +090026#include <linux/firmware.h>
Milo(Woogyom) Kim79bcc102013-02-05 19:26:14 +090027#include <linux/i2c.h>
28#include <linux/init.h>
29#include <linux/leds.h>
30#include <linux/module.h>
31#include <linux/mutex.h>
Sachin Kamatc68f46d2013-09-28 04:38:30 -070032#include <linux/of.h>
Milo(Woogyom) Kim79bcc102013-02-05 19:26:14 +090033#include <linux/platform_data/leds-lp55xx.h>
34#include <linux/slab.h>
Milo(Woogyom) Kim6a0c9a42013-02-05 18:03:08 +090035
36#include "leds-lp55xx-common.h"
Samu Onkalo0efba162010-11-11 14:05:22 -080037
Pavel Machekbfb18d82014-01-10 00:14:05 +010038#define LP5523_PROGRAM_LENGTH 32 /* bytes */
39/* Memory is used like this:
40 0x00 engine 1 program
41 0x10 engine 2 program
42 0x20 engine 3 program
43 0x30 engine 1 muxing info
44 0x40 engine 2 muxing info
45 0x50 engine 3 muxing info
46*/
Milo(Woogyom) Kim12f022d2013-02-05 19:25:26 +090047#define LP5523_MAX_LEDS 9
48
49/* Registers */
Samu Onkalo0efba162010-11-11 14:05:22 -080050#define LP5523_REG_ENABLE 0x00
51#define LP5523_REG_OP_MODE 0x01
Samu Onkalo0efba162010-11-11 14:05:22 -080052#define LP5523_REG_ENABLE_LEDS_MSB 0x04
53#define LP5523_REG_ENABLE_LEDS_LSB 0x05
Samu Onkalo0efba162010-11-11 14:05:22 -080054#define LP5523_REG_LED_PWM_BASE 0x16
55#define LP5523_REG_LED_CURRENT_BASE 0x26
56#define LP5523_REG_CONFIG 0x36
Milo(Woogyom) Kim12f022d2013-02-05 19:25:26 +090057#define LP5523_REG_STATUS 0x3A
58#define LP5523_REG_RESET 0x3D
Samu Onkalo0efba162010-11-11 14:05:22 -080059#define LP5523_REG_LED_TEST_CTRL 0x41
60#define LP5523_REG_LED_TEST_ADC 0x42
Milo Kim22460432013-08-08 13:57:35 +090061#define LP5523_REG_CH1_PROG_START 0x4C
62#define LP5523_REG_CH2_PROG_START 0x4D
63#define LP5523_REG_CH3_PROG_START 0x4E
Milo(Woogyom) Kim12f022d2013-02-05 19:25:26 +090064#define LP5523_REG_PROG_PAGE_SEL 0x4F
Samu Onkalo0efba162010-11-11 14:05:22 -080065#define LP5523_REG_PROG_MEM 0x50
66
Milo(Woogyom) Kim12f022d2013-02-05 19:25:26 +090067/* Bit description in registers */
Samu Onkalo0efba162010-11-11 14:05:22 -080068#define LP5523_ENABLE 0x40
69#define LP5523_AUTO_INC 0x40
70#define LP5523_PWR_SAVE 0x20
71#define LP5523_PWM_PWR_SAVE 0x04
Samu Onkalo0efba162010-11-11 14:05:22 -080072#define LP5523_CP_AUTO 0x18
Samu Onkalo0efba162010-11-11 14:05:22 -080073#define LP5523_AUTO_CLK 0x02
Milo(Woogyom) Kim12f022d2013-02-05 19:25:26 +090074
Samu Onkalo0efba162010-11-11 14:05:22 -080075#define LP5523_EN_LEDTEST 0x80
76#define LP5523_LEDTEST_DONE 0x80
Milo(Woogyom) Kim48068d52013-02-05 18:08:49 +090077#define LP5523_RESET 0xFF
Samu Onkalo0efba162010-11-11 14:05:22 -080078#define LP5523_ADC_SHORTCIRC_LIM 80
Samu Onkalo0efba162010-11-11 14:05:22 -080079#define LP5523_EXT_CLK_USED 0x08
Milo Kim22460432013-08-08 13:57:35 +090080#define LP5523_ENG_STATUS_MASK 0x07
Samu Onkalo0efba162010-11-11 14:05:22 -080081
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +090082/* Memory Page Selection */
83#define LP5523_PAGE_ENG1 0
84#define LP5523_PAGE_ENG2 1
85#define LP5523_PAGE_ENG3 2
Milo Kim45e611b2013-08-08 14:02:29 +090086#define LP5523_PAGE_MUX1 3
87#define LP5523_PAGE_MUX2 4
88#define LP5523_PAGE_MUX3 5
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +090089
90/* Program Memory Operations */
91#define LP5523_MODE_ENG1_M 0x30 /* Operation Mode Register */
92#define LP5523_MODE_ENG2_M 0x0C
93#define LP5523_MODE_ENG3_M 0x03
94#define LP5523_LOAD_ENG1 0x10
95#define LP5523_LOAD_ENG2 0x04
96#define LP5523_LOAD_ENG3 0x01
97
98#define LP5523_ENG1_IS_LOADING(mode) \
99 ((mode & LP5523_MODE_ENG1_M) == LP5523_LOAD_ENG1)
100#define LP5523_ENG2_IS_LOADING(mode) \
101 ((mode & LP5523_MODE_ENG2_M) == LP5523_LOAD_ENG2)
102#define LP5523_ENG3_IS_LOADING(mode) \
103 ((mode & LP5523_MODE_ENG3_M) == LP5523_LOAD_ENG3)
104
105#define LP5523_EXEC_ENG1_M 0x30 /* Enable Register */
106#define LP5523_EXEC_ENG2_M 0x0C
107#define LP5523_EXEC_ENG3_M 0x03
108#define LP5523_EXEC_M 0x3F
109#define LP5523_RUN_ENG1 0x20
110#define LP5523_RUN_ENG2 0x08
111#define LP5523_RUN_ENG3 0x02
112
Milo Kim45e611b2013-08-08 14:02:29 +0900113#define LED_ACTIVE(mux, led) (!!(mux & (0x0001 << led)))
114
Kim, Milo27d77042012-09-04 15:06:18 +0800115enum lp5523_chip_id {
116 LP5523,
117 LP55231,
118};
119
Milo Kim22460432013-08-08 13:57:35 +0900120static int lp5523_init_program_engine(struct lp55xx_chip *chip);
121
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900122static inline void lp5523_wait_opmode_done(void)
123{
124 usleep_range(1000, 2000);
125}
126
Milo(Woogyom) Kima96bfa12013-02-05 19:09:32 +0900127static void lp5523_set_led_current(struct lp55xx_led *led, u8 led_current)
128{
129 led->led_current = led_current;
130 lp55xx_write(led->chip, LP5523_REG_LED_CURRENT_BASE + led->chan_nr,
131 led_current);
132}
133
Milo(Woogyom) Kimffbdccd2013-02-05 18:57:36 +0900134static int lp5523_post_init_device(struct lp55xx_chip *chip)
Samu Onkalo0efba162010-11-11 14:05:22 -0800135{
Milo(Woogyom) Kimffbdccd2013-02-05 18:57:36 +0900136 int ret;
Samu Onkalo0efba162010-11-11 14:05:22 -0800137
Milo(Woogyom) Kimffbdccd2013-02-05 18:57:36 +0900138 ret = lp55xx_write(chip, LP5523_REG_ENABLE, LP5523_ENABLE);
Milo(Woogyom) Kim632418b2013-02-05 18:04:50 +0900139 if (ret)
140 return ret;
Samu Onkalo0efba162010-11-11 14:05:22 -0800141
Samu Onkalo2e4840e2010-11-24 12:57:04 -0800142 /* Chip startup time is 500 us, 1 - 2 ms gives some margin */
143 usleep_range(1000, 2000);
Samu Onkalo0efba162010-11-11 14:05:22 -0800144
Milo(Woogyom) Kimffbdccd2013-02-05 18:57:36 +0900145 ret = lp55xx_write(chip, LP5523_REG_CONFIG,
Samu Onkalo0efba162010-11-11 14:05:22 -0800146 LP5523_AUTO_INC | LP5523_PWR_SAVE |
147 LP5523_CP_AUTO | LP5523_AUTO_CLK |
148 LP5523_PWM_PWR_SAVE);
Milo(Woogyom) Kim632418b2013-02-05 18:04:50 +0900149 if (ret)
Jingoo Han1b21ec52012-10-28 18:45:11 -0700150 return ret;
151
Milo(Woogyom) Kim632418b2013-02-05 18:04:50 +0900152 /* turn on all leds */
Milo(Woogyom) Kimffbdccd2013-02-05 18:57:36 +0900153 ret = lp55xx_write(chip, LP5523_REG_ENABLE_LEDS_MSB, 0x01);
Milo(Woogyom) Kim632418b2013-02-05 18:04:50 +0900154 if (ret)
155 return ret;
Samu Onkalo0efba162010-11-11 14:05:22 -0800156
Milo Kim22460432013-08-08 13:57:35 +0900157 ret = lp55xx_write(chip, LP5523_REG_ENABLE_LEDS_LSB, 0xff);
158 if (ret)
159 return ret;
160
161 return lp5523_init_program_engine(chip);
Samu Onkalo0efba162010-11-11 14:05:22 -0800162}
163
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900164static void lp5523_load_engine(struct lp55xx_chip *chip)
Samu Onkalo0efba162010-11-11 14:05:22 -0800165{
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900166 enum lp55xx_engine_index idx = chip->engine_idx;
167 u8 mask[] = {
168 [LP55XX_ENGINE_1] = LP5523_MODE_ENG1_M,
169 [LP55XX_ENGINE_2] = LP5523_MODE_ENG2_M,
170 [LP55XX_ENGINE_3] = LP5523_MODE_ENG3_M,
171 };
Samu Onkalo0efba162010-11-11 14:05:22 -0800172
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900173 u8 val[] = {
174 [LP55XX_ENGINE_1] = LP5523_LOAD_ENG1,
175 [LP55XX_ENGINE_2] = LP5523_LOAD_ENG2,
176 [LP55XX_ENGINE_3] = LP5523_LOAD_ENG3,
177 };
Samu Onkalo0efba162010-11-11 14:05:22 -0800178
Milo Kimb9e17302013-08-08 13:56:01 +0900179 lp55xx_update_bits(chip, LP5523_REG_OP_MODE, mask[idx], val[idx]);
180
181 lp5523_wait_opmode_done();
182}
183
184static void lp5523_load_engine_and_select_page(struct lp55xx_chip *chip)
185{
186 enum lp55xx_engine_index idx = chip->engine_idx;
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900187 u8 page_sel[] = {
188 [LP55XX_ENGINE_1] = LP5523_PAGE_ENG1,
189 [LP55XX_ENGINE_2] = LP5523_PAGE_ENG2,
190 [LP55XX_ENGINE_3] = LP5523_PAGE_ENG3,
191 };
Samu Onkalo0efba162010-11-11 14:05:22 -0800192
Milo Kimb9e17302013-08-08 13:56:01 +0900193 lp5523_load_engine(chip);
Samu Onkalo0efba162010-11-11 14:05:22 -0800194
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900195 lp55xx_write(chip, LP5523_REG_PROG_PAGE_SEL, page_sel[idx]);
Samu Onkalo0efba162010-11-11 14:05:22 -0800196}
197
Milo Kim28c92662013-11-20 22:13:34 -0800198static void lp5523_stop_all_engines(struct lp55xx_chip *chip)
Samu Onkalo0efba162010-11-11 14:05:22 -0800199{
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900200 lp55xx_write(chip, LP5523_REG_OP_MODE, 0);
201 lp5523_wait_opmode_done();
Samu Onkalo0efba162010-11-11 14:05:22 -0800202}
203
Milo Kim28c92662013-11-20 22:13:34 -0800204static void lp5523_stop_engine(struct lp55xx_chip *chip)
205{
206 enum lp55xx_engine_index idx = chip->engine_idx;
207 u8 mask[] = {
208 [LP55XX_ENGINE_1] = LP5523_MODE_ENG1_M,
209 [LP55XX_ENGINE_2] = LP5523_MODE_ENG2_M,
210 [LP55XX_ENGINE_3] = LP5523_MODE_ENG3_M,
211 };
212
213 lp55xx_update_bits(chip, LP5523_REG_OP_MODE, mask[idx], 0);
214
215 lp5523_wait_opmode_done();
216}
217
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900218static void lp5523_turn_off_channels(struct lp55xx_chip *chip)
Samu Onkalo0efba162010-11-11 14:05:22 -0800219{
220 int i;
Kim, Milo469eba02012-08-21 17:04:02 +0800221
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900222 for (i = 0; i < LP5523_MAX_LEDS; i++)
223 lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + i, 0);
224}
225
226static void lp5523_run_engine(struct lp55xx_chip *chip, bool start)
227{
228 int ret;
229 u8 mode;
230 u8 exec;
231
232 /* stop engine */
233 if (!start) {
234 lp5523_stop_engine(chip);
235 lp5523_turn_off_channels(chip);
236 return;
Samu Onkalo0efba162010-11-11 14:05:22 -0800237 }
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900238
239 /*
240 * To run the engine,
241 * operation mode and enable register should updated at the same time
242 */
243
244 ret = lp55xx_read(chip, LP5523_REG_OP_MODE, &mode);
245 if (ret)
246 return;
247
248 ret = lp55xx_read(chip, LP5523_REG_ENABLE, &exec);
249 if (ret)
250 return;
251
252 /* change operation mode to RUN only when each engine is loading */
253 if (LP5523_ENG1_IS_LOADING(mode)) {
254 mode = (mode & ~LP5523_MODE_ENG1_M) | LP5523_RUN_ENG1;
255 exec = (exec & ~LP5523_EXEC_ENG1_M) | LP5523_RUN_ENG1;
256 }
257
258 if (LP5523_ENG2_IS_LOADING(mode)) {
259 mode = (mode & ~LP5523_MODE_ENG2_M) | LP5523_RUN_ENG2;
260 exec = (exec & ~LP5523_EXEC_ENG2_M) | LP5523_RUN_ENG2;
261 }
262
263 if (LP5523_ENG3_IS_LOADING(mode)) {
264 mode = (mode & ~LP5523_MODE_ENG3_M) | LP5523_RUN_ENG3;
265 exec = (exec & ~LP5523_EXEC_ENG3_M) | LP5523_RUN_ENG3;
266 }
267
268 lp55xx_write(chip, LP5523_REG_OP_MODE, mode);
269 lp5523_wait_opmode_done();
270
271 lp55xx_update_bits(chip, LP5523_REG_ENABLE, LP5523_EXEC_M, exec);
272}
273
Milo Kim22460432013-08-08 13:57:35 +0900274static int lp5523_init_program_engine(struct lp55xx_chip *chip)
275{
276 int i;
277 int j;
278 int ret;
279 u8 status;
280 /* one pattern per engine setting LED MUX start and stop addresses */
281 static const u8 pattern[][LP5523_PROGRAM_LENGTH] = {
282 { 0x9c, 0x30, 0x9c, 0xb0, 0x9d, 0x80, 0xd8, 0x00, 0},
283 { 0x9c, 0x40, 0x9c, 0xc0, 0x9d, 0x80, 0xd8, 0x00, 0},
284 { 0x9c, 0x50, 0x9c, 0xd0, 0x9d, 0x80, 0xd8, 0x00, 0},
285 };
286
287 /* hardcode 32 bytes of memory for each engine from program memory */
288 ret = lp55xx_write(chip, LP5523_REG_CH1_PROG_START, 0x00);
289 if (ret)
290 return ret;
291
292 ret = lp55xx_write(chip, LP5523_REG_CH2_PROG_START, 0x10);
293 if (ret)
294 return ret;
295
296 ret = lp55xx_write(chip, LP5523_REG_CH3_PROG_START, 0x20);
297 if (ret)
298 return ret;
299
300 /* write LED MUX address space for each engine */
301 for (i = LP55XX_ENGINE_1; i <= LP55XX_ENGINE_3; i++) {
302 chip->engine_idx = i;
303 lp5523_load_engine_and_select_page(chip);
304
305 for (j = 0; j < LP5523_PROGRAM_LENGTH; j++) {
306 ret = lp55xx_write(chip, LP5523_REG_PROG_MEM + j,
307 pattern[i - 1][j]);
308 if (ret)
309 goto out;
310 }
311 }
312
313 lp5523_run_engine(chip, true);
314
315 /* Let the programs run for couple of ms and check the engine status */
316 usleep_range(3000, 6000);
317 lp55xx_read(chip, LP5523_REG_STATUS, &status);
318 status &= LP5523_ENG_STATUS_MASK;
319
320 if (status != LP5523_ENG_STATUS_MASK) {
321 dev_err(&chip->cl->dev,
322 "cound not configure LED engine, status = 0x%.2x\n",
323 status);
324 ret = -1;
325 }
326
327out:
Milo Kim28c92662013-11-20 22:13:34 -0800328 lp5523_stop_all_engines(chip);
Milo Kim22460432013-08-08 13:57:35 +0900329 return ret;
330}
331
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900332static int lp5523_update_program_memory(struct lp55xx_chip *chip,
333 const u8 *data, size_t size)
334{
335 u8 pattern[LP5523_PROGRAM_LENGTH] = {0};
336 unsigned cmd;
337 char c[3];
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900338 int nrchars;
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900339 int ret;
Milo Kim2f733ca2013-08-08 14:09:24 +0900340 int offset = 0;
341 int i = 0;
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900342
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900343 while ((offset < size - 1) && (i < LP5523_PROGRAM_LENGTH)) {
344 /* separate sscanfs because length is working only for %s */
345 ret = sscanf(data + offset, "%2s%n ", c, &nrchars);
346 if (ret != 1)
347 goto err;
348
349 ret = sscanf(c, "%2x", &cmd);
350 if (ret != 1)
351 goto err;
352
353 pattern[i] = (u8)cmd;
354 offset += nrchars;
355 i++;
356 }
357
358 /* Each instruction is 16bit long. Check that length is even */
359 if (i % 2)
360 goto err;
361
Milo Kim2f733ca2013-08-08 14:09:24 +0900362 for (i = 0; i < LP5523_PROGRAM_LENGTH; i++) {
Milo Kim45e611b2013-08-08 14:02:29 +0900363 ret = lp55xx_write(chip, LP5523_REG_PROG_MEM + i, pattern[i]);
Milo Kime70988d2013-12-02 17:21:44 -0800364 if (ret)
Milo Kim45e611b2013-08-08 14:02:29 +0900365 return -EINVAL;
Milo Kim45e611b2013-08-08 14:02:29 +0900366 }
367
Milo Kim45e611b2013-08-08 14:02:29 +0900368 return size;
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900369
370err:
371 dev_err(&chip->cl->dev, "wrong pattern format\n");
372 return -EINVAL;
Samu Onkalo0efba162010-11-11 14:05:22 -0800373}
374
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900375static void lp5523_firmware_loaded(struct lp55xx_chip *chip)
Samu Onkalo0efba162010-11-11 14:05:22 -0800376{
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900377 const struct firmware *fw = chip->fw;
Samu Onkalo0efba162010-11-11 14:05:22 -0800378
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900379 if (fw->size > LP5523_PROGRAM_LENGTH) {
380 dev_err(&chip->cl->dev, "firmware data size overflow: %zu\n",
381 fw->size);
382 return;
383 }
384
385 /*
386 * Program momery sequence
387 * 1) set engine mode to "LOAD"
388 * 2) write firmware data into program memory
389 */
390
Milo Kimb9e17302013-08-08 13:56:01 +0900391 lp5523_load_engine_and_select_page(chip);
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900392 lp5523_update_program_memory(chip, fw->data, fw->size);
Samu Onkalo0efba162010-11-11 14:05:22 -0800393}
394
Milo Kim45e611b2013-08-08 14:02:29 +0900395static ssize_t show_engine_mode(struct device *dev,
396 struct device_attribute *attr,
397 char *buf, int nr)
398{
399 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
400 struct lp55xx_chip *chip = led->chip;
401 enum lp55xx_engine_mode mode = chip->engines[nr - 1].mode;
402
403 switch (mode) {
404 case LP55XX_ENGINE_RUN:
405 return sprintf(buf, "run\n");
406 case LP55XX_ENGINE_LOAD:
407 return sprintf(buf, "load\n");
408 case LP55XX_ENGINE_DISABLED:
409 default:
410 return sprintf(buf, "disabled\n");
411 }
412}
413show_mode(1)
414show_mode(2)
415show_mode(3)
416
417static ssize_t store_engine_mode(struct device *dev,
418 struct device_attribute *attr,
419 const char *buf, size_t len, int nr)
420{
421 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
422 struct lp55xx_chip *chip = led->chip;
423 struct lp55xx_engine *engine = &chip->engines[nr - 1];
424
425 mutex_lock(&chip->lock);
426
427 chip->engine_idx = nr;
428
429 if (!strncmp(buf, "run", 3)) {
430 lp5523_run_engine(chip, true);
431 engine->mode = LP55XX_ENGINE_RUN;
432 } else if (!strncmp(buf, "load", 4)) {
433 lp5523_stop_engine(chip);
434 lp5523_load_engine(chip);
435 engine->mode = LP55XX_ENGINE_LOAD;
436 } else if (!strncmp(buf, "disabled", 8)) {
437 lp5523_stop_engine(chip);
438 engine->mode = LP55XX_ENGINE_DISABLED;
439 }
440
441 mutex_unlock(&chip->lock);
442
443 return len;
444}
445store_mode(1)
446store_mode(2)
447store_mode(3)
448
449static int lp5523_mux_parse(const char *buf, u16 *mux, size_t len)
450{
451 u16 tmp_mux = 0;
452 int i;
453
454 len = min_t(int, len, LP5523_MAX_LEDS);
455
456 for (i = 0; i < len; i++) {
457 switch (buf[i]) {
458 case '1':
459 tmp_mux |= (1 << i);
460 break;
461 case '0':
462 break;
463 case '\n':
464 i = len;
465 break;
466 default:
467 return -1;
468 }
469 }
470 *mux = tmp_mux;
471
472 return 0;
473}
474
475static void lp5523_mux_to_array(u16 led_mux, char *array)
476{
477 int i, pos = 0;
478 for (i = 0; i < LP5523_MAX_LEDS; i++)
479 pos += sprintf(array + pos, "%x", LED_ACTIVE(led_mux, i));
480
481 array[pos] = '\0';
482}
483
484static ssize_t show_engine_leds(struct device *dev,
485 struct device_attribute *attr,
486 char *buf, int nr)
487{
488 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
489 struct lp55xx_chip *chip = led->chip;
490 char mux[LP5523_MAX_LEDS + 1];
491
492 lp5523_mux_to_array(chip->engines[nr - 1].led_mux, mux);
493
494 return sprintf(buf, "%s\n", mux);
495}
496show_leds(1)
497show_leds(2)
498show_leds(3)
499
500static int lp5523_load_mux(struct lp55xx_chip *chip, u16 mux, int nr)
501{
502 struct lp55xx_engine *engine = &chip->engines[nr - 1];
503 int ret;
504 u8 mux_page[] = {
505 [LP55XX_ENGINE_1] = LP5523_PAGE_MUX1,
506 [LP55XX_ENGINE_2] = LP5523_PAGE_MUX2,
507 [LP55XX_ENGINE_3] = LP5523_PAGE_MUX3,
508 };
509
510 lp5523_load_engine(chip);
511
512 ret = lp55xx_write(chip, LP5523_REG_PROG_PAGE_SEL, mux_page[nr]);
513 if (ret)
514 return ret;
515
516 ret = lp55xx_write(chip, LP5523_REG_PROG_MEM , (u8)(mux >> 8));
517 if (ret)
518 return ret;
519
520 ret = lp55xx_write(chip, LP5523_REG_PROG_MEM + 1, (u8)(mux));
521 if (ret)
522 return ret;
523
524 engine->led_mux = mux;
525 return 0;
526}
527
528static ssize_t store_engine_leds(struct device *dev,
529 struct device_attribute *attr,
530 const char *buf, size_t len, int nr)
531{
532 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
533 struct lp55xx_chip *chip = led->chip;
534 struct lp55xx_engine *engine = &chip->engines[nr - 1];
535 u16 mux = 0;
536 ssize_t ret;
537
538 if (lp5523_mux_parse(buf, &mux, len))
539 return -EINVAL;
540
541 mutex_lock(&chip->lock);
542
543 chip->engine_idx = nr;
544 ret = -EINVAL;
545
546 if (engine->mode != LP55XX_ENGINE_LOAD)
547 goto leave;
548
549 if (lp5523_load_mux(chip, mux, nr))
550 goto leave;
551
552 ret = len;
553leave:
554 mutex_unlock(&chip->lock);
555 return ret;
556}
557store_leds(1)
558store_leds(2)
559store_leds(3)
560
561static ssize_t store_engine_load(struct device *dev,
562 struct device_attribute *attr,
563 const char *buf, size_t len, int nr)
564{
565 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
566 struct lp55xx_chip *chip = led->chip;
Milo Kime70988d2013-12-02 17:21:44 -0800567 int ret;
Milo Kim45e611b2013-08-08 14:02:29 +0900568
569 mutex_lock(&chip->lock);
570
571 chip->engine_idx = nr;
572 lp5523_load_engine_and_select_page(chip);
Milo Kime70988d2013-12-02 17:21:44 -0800573 ret = lp5523_update_program_memory(chip, buf, len);
Milo Kim45e611b2013-08-08 14:02:29 +0900574
575 mutex_unlock(&chip->lock);
576
Milo Kime70988d2013-12-02 17:21:44 -0800577 return ret;
Milo Kim45e611b2013-08-08 14:02:29 +0900578}
579store_load(1)
580store_load(2)
581store_load(3)
582
Samu Onkalo0efba162010-11-11 14:05:22 -0800583static ssize_t lp5523_selftest(struct device *dev,
584 struct device_attribute *attr,
585 char *buf)
586{
Milo(Woogyom) Kim9ca3bd82013-02-05 19:21:43 +0900587 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
588 struct lp55xx_chip *chip = led->chip;
589 struct lp55xx_platform_data *pdata = chip->pdata;
Samu Onkalo0efba162010-11-11 14:05:22 -0800590 int i, ret, pos = 0;
Samu Onkalo0efba162010-11-11 14:05:22 -0800591 u8 status, adc, vdd;
592
593 mutex_lock(&chip->lock);
594
Milo(Woogyom) Kim9ca3bd82013-02-05 19:21:43 +0900595 ret = lp55xx_read(chip, LP5523_REG_STATUS, &status);
Samu Onkalo0efba162010-11-11 14:05:22 -0800596 if (ret < 0)
597 goto fail;
598
599 /* Check that ext clock is really in use if requested */
Milo(Woogyom) Kim9ca3bd82013-02-05 19:21:43 +0900600 if (pdata->clock_mode == LP55XX_CLOCK_EXT) {
Samu Onkalo0efba162010-11-11 14:05:22 -0800601 if ((status & LP5523_EXT_CLK_USED) == 0)
602 goto fail;
Milo(Woogyom) Kim9ca3bd82013-02-05 19:21:43 +0900603 }
Samu Onkalo0efba162010-11-11 14:05:22 -0800604
605 /* Measure VDD (i.e. VBAT) first (channel 16 corresponds to VDD) */
Milo(Woogyom) Kim9ca3bd82013-02-05 19:21:43 +0900606 lp55xx_write(chip, LP5523_REG_LED_TEST_CTRL, LP5523_EN_LEDTEST | 16);
Samu Onkalo2e4840e2010-11-24 12:57:04 -0800607 usleep_range(3000, 6000); /* ADC conversion time is typically 2.7 ms */
Milo(Woogyom) Kim9ca3bd82013-02-05 19:21:43 +0900608 ret = lp55xx_read(chip, LP5523_REG_STATUS, &status);
Jingoo Han1b21ec52012-10-28 18:45:11 -0700609 if (ret < 0)
610 goto fail;
611
Samu Onkalo0efba162010-11-11 14:05:22 -0800612 if (!(status & LP5523_LEDTEST_DONE))
Samu Onkalo2e4840e2010-11-24 12:57:04 -0800613 usleep_range(3000, 6000); /* Was not ready. Wait little bit */
Samu Onkalo0efba162010-11-11 14:05:22 -0800614
Milo(Woogyom) Kim9ca3bd82013-02-05 19:21:43 +0900615 ret = lp55xx_read(chip, LP5523_REG_LED_TEST_ADC, &vdd);
Jingoo Han1b21ec52012-10-28 18:45:11 -0700616 if (ret < 0)
617 goto fail;
618
Samu Onkalo0efba162010-11-11 14:05:22 -0800619 vdd--; /* There may be some fluctuation in measurement */
620
Milo(Woogyom) Kim0e202342013-02-05 19:07:34 +0900621 for (i = 0; i < LP5523_MAX_LEDS; i++) {
Samu Onkalo0efba162010-11-11 14:05:22 -0800622 /* Skip non-existing channels */
Milo(Woogyom) Kim9ca3bd82013-02-05 19:21:43 +0900623 if (pdata->led_config[i].led_current == 0)
Samu Onkalo0efba162010-11-11 14:05:22 -0800624 continue;
625
626 /* Set default current */
Milo(Woogyom) Kim9ca3bd82013-02-05 19:21:43 +0900627 lp55xx_write(chip, LP5523_REG_LED_CURRENT_BASE + i,
628 pdata->led_config[i].led_current);
Samu Onkalo0efba162010-11-11 14:05:22 -0800629
Milo(Woogyom) Kim9ca3bd82013-02-05 19:21:43 +0900630 lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + i, 0xff);
Samu Onkalo2e4840e2010-11-24 12:57:04 -0800631 /* let current stabilize 2 - 4ms before measurements start */
632 usleep_range(2000, 4000);
Milo(Woogyom) Kim9ca3bd82013-02-05 19:21:43 +0900633 lp55xx_write(chip, LP5523_REG_LED_TEST_CTRL,
Samu Onkalo0efba162010-11-11 14:05:22 -0800634 LP5523_EN_LEDTEST | i);
Samu Onkalo2e4840e2010-11-24 12:57:04 -0800635 /* ADC conversion time is 2.7 ms typically */
636 usleep_range(3000, 6000);
Milo(Woogyom) Kim9ca3bd82013-02-05 19:21:43 +0900637 ret = lp55xx_read(chip, LP5523_REG_STATUS, &status);
Jingoo Han1b21ec52012-10-28 18:45:11 -0700638 if (ret < 0)
639 goto fail;
640
Samu Onkalo0efba162010-11-11 14:05:22 -0800641 if (!(status & LP5523_LEDTEST_DONE))
Samu Onkalo2e4840e2010-11-24 12:57:04 -0800642 usleep_range(3000, 6000);/* Was not ready. Wait. */
Milo(Woogyom) Kim9ca3bd82013-02-05 19:21:43 +0900643
644 ret = lp55xx_read(chip, LP5523_REG_LED_TEST_ADC, &adc);
Jingoo Han1b21ec52012-10-28 18:45:11 -0700645 if (ret < 0)
646 goto fail;
Samu Onkalo0efba162010-11-11 14:05:22 -0800647
648 if (adc >= vdd || adc < LP5523_ADC_SHORTCIRC_LIM)
649 pos += sprintf(buf + pos, "LED %d FAIL\n", i);
650
Milo(Woogyom) Kim9ca3bd82013-02-05 19:21:43 +0900651 lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + i, 0x00);
Samu Onkalo0efba162010-11-11 14:05:22 -0800652
653 /* Restore current */
Milo(Woogyom) Kim9ca3bd82013-02-05 19:21:43 +0900654 lp55xx_write(chip, LP5523_REG_LED_CURRENT_BASE + i,
655 led->led_current);
Samu Onkalo0efba162010-11-11 14:05:22 -0800656 led++;
657 }
658 if (pos == 0)
659 pos = sprintf(buf, "OK\n");
660 goto release_lock;
661fail:
662 pos = sprintf(buf, "FAIL\n");
663
664release_lock:
665 mutex_unlock(&chip->lock);
666
667 return pos;
668}
669
Samu Onkalo0efba162010-11-11 14:05:22 -0800670static void lp5523_led_brightness_work(struct work_struct *work)
671{
Milo(Woogyom) Kima6e46792013-02-05 19:08:40 +0900672 struct lp55xx_led *led = container_of(work, struct lp55xx_led,
Samu Onkalo0efba162010-11-11 14:05:22 -0800673 brightness_work);
Milo(Woogyom) Kima6e46792013-02-05 19:08:40 +0900674 struct lp55xx_chip *chip = led->chip;
Samu Onkalo0efba162010-11-11 14:05:22 -0800675
676 mutex_lock(&chip->lock);
Milo(Woogyom) Kima6e46792013-02-05 19:08:40 +0900677 lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + led->chan_nr,
Samu Onkalo0efba162010-11-11 14:05:22 -0800678 led->brightness);
Samu Onkalo0efba162010-11-11 14:05:22 -0800679 mutex_unlock(&chip->lock);
680}
681
Milo Kim45e611b2013-08-08 14:02:29 +0900682static LP55XX_DEV_ATTR_RW(engine1_mode, show_engine1_mode, store_engine1_mode);
683static LP55XX_DEV_ATTR_RW(engine2_mode, show_engine2_mode, store_engine2_mode);
684static LP55XX_DEV_ATTR_RW(engine3_mode, show_engine3_mode, store_engine3_mode);
685static LP55XX_DEV_ATTR_RW(engine1_leds, show_engine1_leds, store_engine1_leds);
686static LP55XX_DEV_ATTR_RW(engine2_leds, show_engine2_leds, store_engine2_leds);
687static LP55XX_DEV_ATTR_RW(engine3_leds, show_engine3_leds, store_engine3_leds);
688static LP55XX_DEV_ATTR_WO(engine1_load, store_engine1_load);
689static LP55XX_DEV_ATTR_WO(engine2_load, store_engine2_load);
690static LP55XX_DEV_ATTR_WO(engine3_load, store_engine3_load);
691static LP55XX_DEV_ATTR_RO(selftest, lp5523_selftest);
Samu Onkalo0efba162010-11-11 14:05:22 -0800692
693static struct attribute *lp5523_attributes[] = {
Milo Kim45e611b2013-08-08 14:02:29 +0900694 &dev_attr_engine1_mode.attr,
695 &dev_attr_engine2_mode.attr,
696 &dev_attr_engine3_mode.attr,
697 &dev_attr_engine1_load.attr,
698 &dev_attr_engine2_load.attr,
699 &dev_attr_engine3_load.attr,
700 &dev_attr_engine1_leds.attr,
701 &dev_attr_engine2_leds.attr,
702 &dev_attr_engine3_leds.attr,
Samu Onkalo0efba162010-11-11 14:05:22 -0800703 &dev_attr_selftest.attr,
Kim, Milof1625842012-09-12 20:16:03 +0800704 NULL,
Samu Onkalo0efba162010-11-11 14:05:22 -0800705};
706
707static const struct attribute_group lp5523_group = {
708 .attrs = lp5523_attributes,
709};
710
Milo(Woogyom) Kim48068d52013-02-05 18:08:49 +0900711/* Chip specific configurations */
712static struct lp55xx_device_config lp5523_cfg = {
713 .reset = {
714 .addr = LP5523_REG_RESET,
715 .val = LP5523_RESET,
716 },
Milo(Woogyom) Kime3a700d2013-02-05 18:09:56 +0900717 .enable = {
718 .addr = LP5523_REG_ENABLE,
719 .val = LP5523_ENABLE,
720 },
Milo(Woogyom) Kim0e202342013-02-05 19:07:34 +0900721 .max_channel = LP5523_MAX_LEDS,
Milo(Woogyom) Kimffbdccd2013-02-05 18:57:36 +0900722 .post_init_device = lp5523_post_init_device,
Milo(Woogyom) Kima6e46792013-02-05 19:08:40 +0900723 .brightness_work_fn = lp5523_led_brightness_work,
Milo(Woogyom) Kima96bfa12013-02-05 19:09:32 +0900724 .set_led_current = lp5523_set_led_current,
Milo(Woogyom) Kimdb6eaf82013-02-05 19:18:51 +0900725 .firmware_cb = lp5523_firmware_loaded,
726 .run_engine = lp5523_run_engine,
Milo(Woogyom) Kime73c0ce2013-02-05 19:20:45 +0900727 .dev_attr_group = &lp5523_group,
Milo(Woogyom) Kim48068d52013-02-05 18:08:49 +0900728};
729
Bill Pemberton98ea1ea2012-11-19 13:23:02 -0500730static int lp5523_probe(struct i2c_client *client,
Samu Onkalo0efba162010-11-11 14:05:22 -0800731 const struct i2c_device_id *id)
732{
Milo(Woogyom) Kim22ebeb42013-02-05 18:58:35 +0900733 int ret;
Milo(Woogyom) Kim6a0c9a42013-02-05 18:03:08 +0900734 struct lp55xx_chip *chip;
735 struct lp55xx_led *led;
Linus Walleij7542a04b2013-04-23 04:52:59 -0700736 struct lp55xx_platform_data *pdata;
737 struct device_node *np = client->dev.of_node;
Samu Onkalo0efba162010-11-11 14:05:22 -0800738
Jingoo Han87aae1e2013-07-30 01:07:35 -0700739 if (!dev_get_platdata(&client->dev)) {
Linus Walleij7542a04b2013-04-23 04:52:59 -0700740 if (np) {
741 ret = lp55xx_of_populate_pdata(&client->dev, np);
742 if (ret < 0)
743 return ret;
744 } else {
745 dev_err(&client->dev, "no platform data\n");
746 return -EINVAL;
747 }
Samu Onkalo0efba162010-11-11 14:05:22 -0800748 }
Jingoo Han87aae1e2013-07-30 01:07:35 -0700749 pdata = dev_get_platdata(&client->dev);
Samu Onkalo0efba162010-11-11 14:05:22 -0800750
Milo(Woogyom) Kim6a0c9a42013-02-05 18:03:08 +0900751 chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
752 if (!chip)
753 return -ENOMEM;
Samu Onkalo0efba162010-11-11 14:05:22 -0800754
Milo(Woogyom) Kim6a0c9a42013-02-05 18:03:08 +0900755 led = devm_kzalloc(&client->dev,
756 sizeof(*led) * pdata->num_channels, GFP_KERNEL);
757 if (!led)
758 return -ENOMEM;
759
760 chip->cl = client;
761 chip->pdata = pdata;
Milo(Woogyom) Kim48068d52013-02-05 18:08:49 +0900762 chip->cfg = &lp5523_cfg;
Milo(Woogyom) Kim6a0c9a42013-02-05 18:03:08 +0900763
764 mutex_init(&chip->lock);
765
766 i2c_set_clientdata(client, led);
Samu Onkalo0efba162010-11-11 14:05:22 -0800767
Milo(Woogyom) Kim22ebeb42013-02-05 18:58:35 +0900768 ret = lp55xx_init_device(chip);
Samu Onkalo0efba162010-11-11 14:05:22 -0800769 if (ret)
Milo(Woogyom) Kimf6c64c62013-02-05 17:58:01 +0900770 goto err_init;
Samu Onkalo0efba162010-11-11 14:05:22 -0800771
Kim, Milo56a1e9a2012-09-04 15:06:26 +0800772 dev_info(&client->dev, "%s Programmable led chip found\n", id->name);
Samu Onkalo0efba162010-11-11 14:05:22 -0800773
Milo(Woogyom) Kim9e9b3db2013-02-05 19:06:27 +0900774 ret = lp55xx_register_leds(led, chip);
Milo(Woogyom) Kimf6524802013-02-05 17:53:40 +0900775 if (ret)
Milo(Woogyom) Kim9e9b3db2013-02-05 19:06:27 +0900776 goto err_register_leds;
Samu Onkalo0efba162010-11-11 14:05:22 -0800777
Milo(Woogyom) Kime73c0ce2013-02-05 19:20:45 +0900778 ret = lp55xx_register_sysfs(chip);
Samu Onkalo0efba162010-11-11 14:05:22 -0800779 if (ret) {
780 dev_err(&client->dev, "registering sysfs failed\n");
Milo(Woogyom) Kime73c0ce2013-02-05 19:20:45 +0900781 goto err_register_sysfs;
Samu Onkalo0efba162010-11-11 14:05:22 -0800782 }
Milo(Woogyom) Kime73c0ce2013-02-05 19:20:45 +0900783
784 return 0;
785
786err_register_sysfs:
Milo(Woogyom) Kimc3a68eb2013-02-05 19:11:18 +0900787 lp55xx_unregister_leds(led, chip);
Milo(Woogyom) Kim9e9b3db2013-02-05 19:06:27 +0900788err_register_leds:
Milo(Woogyom) Kim6ce61762013-02-05 19:03:02 +0900789 lp55xx_deinit_device(chip);
Milo(Woogyom) Kimf6c64c62013-02-05 17:58:01 +0900790err_init:
Samu Onkalo0efba162010-11-11 14:05:22 -0800791 return ret;
792}
793
794static int lp5523_remove(struct i2c_client *client)
795{
Milo(Woogyom) Kim6ce61762013-02-05 19:03:02 +0900796 struct lp55xx_led *led = i2c_get_clientdata(client);
797 struct lp55xx_chip *chip = led->chip;
Samu Onkalo0efba162010-11-11 14:05:22 -0800798
Milo Kim28c92662013-11-20 22:13:34 -0800799 lp5523_stop_all_engines(chip);
Milo(Woogyom) Kim87cc4bd2013-02-05 19:23:51 +0900800 lp55xx_unregister_sysfs(chip);
Milo(Woogyom) Kimc3a68eb2013-02-05 19:11:18 +0900801 lp55xx_unregister_leds(led, chip);
Milo(Woogyom) Kim6ce61762013-02-05 19:03:02 +0900802 lp55xx_deinit_device(chip);
Samu Onkalo0efba162010-11-11 14:05:22 -0800803
Samu Onkalo0efba162010-11-11 14:05:22 -0800804 return 0;
805}
806
807static const struct i2c_device_id lp5523_id[] = {
Kim, Milo27d77042012-09-04 15:06:18 +0800808 { "lp5523", LP5523 },
809 { "lp55231", LP55231 },
Samu Onkalo0efba162010-11-11 14:05:22 -0800810 { }
811};
812
813MODULE_DEVICE_TABLE(i2c, lp5523_id);
814
Axel Lin33c88b62013-05-08 21:48:57 -0700815#ifdef CONFIG_OF
816static const struct of_device_id of_lp5523_leds_match[] = {
817 { .compatible = "national,lp5523", },
818 {},
819};
820
821MODULE_DEVICE_TABLE(of, of_lp5523_leds_match);
822#endif
823
Samu Onkalo0efba162010-11-11 14:05:22 -0800824static struct i2c_driver lp5523_driver = {
825 .driver = {
Kim, Milo27d77042012-09-04 15:06:18 +0800826 .name = "lp5523x",
Axel Lin33c88b62013-05-08 21:48:57 -0700827 .of_match_table = of_match_ptr(of_lp5523_leds_match),
Samu Onkalo0efba162010-11-11 14:05:22 -0800828 },
829 .probe = lp5523_probe,
830 .remove = lp5523_remove,
831 .id_table = lp5523_id,
832};
833
Axel Lin09a0d182012-01-10 15:09:27 -0800834module_i2c_driver(lp5523_driver);
Samu Onkalo0efba162010-11-11 14:05:22 -0800835
836MODULE_AUTHOR("Mathias Nyman <mathias.nyman@nokia.com>");
Milo(Woogyom) Kima2387cb2013-02-05 19:28:00 +0900837MODULE_AUTHOR("Milo Kim <milo.kim@ti.com>");
Samu Onkalo0efba162010-11-11 14:05:22 -0800838MODULE_DESCRIPTION("LP5523 LED engine");
839MODULE_LICENSE("GPL");