[linux-2.6-block.git] / drivers / leds / leds-lp5523.c

/*
 * lp5523.c - LP5523 LED Driver
 *
 * Copyright (C) 2010 Nokia Corporation
 *
 * Contact: Samu Onkalo <samu.p.onkalo@nokia.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */

#include <linux/module.h>
#include <linux/init.h>
#include <linux/i2c.h>
#include <linux/mutex.h>
#include <linux/gpio.h>
#include <linux/interrupt.h>
#include <linux/delay.h>
#include <linux/ctype.h>
#include <linux/spinlock.h>
#include <linux/wait.h>
#include <linux/leds.h>
#include <linux/leds-lp5523.h>
#include <linux/workqueue.h>
#include <linux/slab.h>
#include <linux/platform_data/leds-lp55xx.h>
#include <linux/firmware.h>

#include "leds-lp55xx-common.h"

#define LP5523_PROGRAM_LENGTH		32
#define LP5523_MAX_LEDS			9

/* Registers */
#define LP5523_REG_ENABLE		0x00
#define LP5523_REG_OP_MODE		0x01
#define LP5523_REG_ENABLE_LEDS_MSB	0x04
#define LP5523_REG_ENABLE_LEDS_LSB	0x05
#define LP5523_REG_LED_PWM_BASE		0x16
#define LP5523_REG_LED_CURRENT_BASE	0x26
#define LP5523_REG_CONFIG		0x36
#define LP5523_REG_STATUS		0x3A
#define LP5523_REG_RESET		0x3D
#define LP5523_REG_LED_TEST_CTRL	0x41
#define LP5523_REG_LED_TEST_ADC		0x42
#define LP5523_REG_PROG_PAGE_SEL	0x4F
#define LP5523_REG_PROG_MEM		0x50

/* Bit description in registers */
#define LP5523_ENABLE			0x40
#define LP5523_AUTO_INC			0x40
#define LP5523_PWR_SAVE			0x20
#define LP5523_PWM_PWR_SAVE		0x04
#define LP5523_CP_AUTO			0x18
#define LP5523_AUTO_CLK			0x02

#define LP5523_EN_LEDTEST		0x80
#define LP5523_LEDTEST_DONE		0x80
#define LP5523_RESET			0xFF
#define LP5523_ADC_SHORTCIRC_LIM	80
#define LP5523_EXT_CLK_USED		0x08

/* Memory Page Selection */
#define LP5523_PAGE_ENG1		0
#define LP5523_PAGE_ENG2		1
#define LP5523_PAGE_ENG3		2

/* Program Memory Operations */
#define LP5523_MODE_ENG1_M		0x30	/* Operation Mode Register */
#define LP5523_MODE_ENG2_M		0x0C
#define LP5523_MODE_ENG3_M		0x03
#define LP5523_LOAD_ENG1		0x10
#define LP5523_LOAD_ENG2		0x04
#define LP5523_LOAD_ENG3		0x01

#define LP5523_ENG1_IS_LOADING(mode)	\
	((mode & LP5523_MODE_ENG1_M) == LP5523_LOAD_ENG1)
#define LP5523_ENG2_IS_LOADING(mode)	\
	((mode & LP5523_MODE_ENG2_M) == LP5523_LOAD_ENG2)
#define LP5523_ENG3_IS_LOADING(mode)	\
	((mode & LP5523_MODE_ENG3_M) == LP5523_LOAD_ENG3)

#define LP5523_EXEC_ENG1_M		0x30	/* Enable Register */
#define LP5523_EXEC_ENG2_M		0x0C
#define LP5523_EXEC_ENG3_M		0x03
#define LP5523_EXEC_M			0x3F
#define LP5523_RUN_ENG1			0x20
#define LP5523_RUN_ENG2			0x08
#define LP5523_RUN_ENG3			0x02

enum lp5523_chip_id {
	LP5523,
	LP55231,
};

static inline void lp5523_wait_opmode_done(void)
{
	usleep_range(1000, 2000);
}

static void lp5523_set_led_current(struct lp55xx_led *led, u8 led_current)
{
	led->led_current = led_current;
	lp55xx_write(led->chip, LP5523_REG_LED_CURRENT_BASE + led->chan_nr,
		led_current);
}

static int lp5523_post_init_device(struct lp55xx_chip *chip)
{
	int ret;

	ret = lp55xx_write(chip, LP5523_REG_ENABLE, LP5523_ENABLE);
	if (ret)
		return ret;

	/* Chip startup time is 500 us, 1 - 2 ms gives some margin */
	usleep_range(1000, 2000);

	ret = lp55xx_write(chip, LP5523_REG_CONFIG,
			    LP5523_AUTO_INC | LP5523_PWR_SAVE |
			    LP5523_CP_AUTO | LP5523_AUTO_CLK |
			    LP5523_PWM_PWR_SAVE);
	if (ret)
		return ret;

	/* turn on all leds */
	ret = lp55xx_write(chip, LP5523_REG_ENABLE_LEDS_MSB, 0x01);
	if (ret)
		return ret;

	return lp55xx_write(chip, LP5523_REG_ENABLE_LEDS_LSB, 0xff);
}

static void lp5523_load_engine(struct lp55xx_chip *chip)
{
	enum lp55xx_engine_index idx = chip->engine_idx;
	u8 mask[] = {
		[LP55XX_ENGINE_1] = LP5523_MODE_ENG1_M,
		[LP55XX_ENGINE_2] = LP5523_MODE_ENG2_M,
		[LP55XX_ENGINE_3] = LP5523_MODE_ENG3_M,
	};

	u8 val[] = {
		[LP55XX_ENGINE_1] = LP5523_LOAD_ENG1,
		[LP55XX_ENGINE_2] = LP5523_LOAD_ENG2,
		[LP55XX_ENGINE_3] = LP5523_LOAD_ENG3,
	};

	u8 page_sel[] = {
		[LP55XX_ENGINE_1] = LP5523_PAGE_ENG1,
		[LP55XX_ENGINE_2] = LP5523_PAGE_ENG2,
		[LP55XX_ENGINE_3] = LP5523_PAGE_ENG3,
	};

	lp55xx_update_bits(chip, LP5523_REG_OP_MODE, mask[idx], val[idx]);

	lp5523_wait_opmode_done();

	lp55xx_write(chip, LP5523_REG_PROG_PAGE_SEL, page_sel[idx]);
}

static void lp5523_stop_engine(struct lp55xx_chip *chip)
{
	lp55xx_write(chip, LP5523_REG_OP_MODE, 0);
	lp5523_wait_opmode_done();
}

static void lp5523_turn_off_channels(struct lp55xx_chip *chip)
{
	int i;

	for (i = 0; i < LP5523_MAX_LEDS; i++)
		lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + i, 0);
}

static void lp5523_run_engine(struct lp55xx_chip *chip, bool start)
{
	int ret;
	u8 mode;
	u8 exec;

	/* stop engine */
	if (!start) {
		lp5523_stop_engine(chip);
		lp5523_turn_off_channels(chip);
		return;
	}

	/*
	 * To run the engine,
	 * operation mode and enable register should updated at the same time
	 */

	ret = lp55xx_read(chip, LP5523_REG_OP_MODE, &mode);
	if (ret)
		return;

	ret = lp55xx_read(chip, LP5523_REG_ENABLE, &exec);
	if (ret)
		return;

	/* change operation mode to RUN only when each engine is loading */
	if (LP5523_ENG1_IS_LOADING(mode)) {
		mode = (mode & ~LP5523_MODE_ENG1_M) | LP5523_RUN_ENG1;
		exec = (exec & ~LP5523_EXEC_ENG1_M) | LP5523_RUN_ENG1;
	}

	if (LP5523_ENG2_IS_LOADING(mode)) {
		mode = (mode & ~LP5523_MODE_ENG2_M) | LP5523_RUN_ENG2;
		exec = (exec & ~LP5523_EXEC_ENG2_M) | LP5523_RUN_ENG2;
	}

	if (LP5523_ENG3_IS_LOADING(mode)) {
		mode = (mode & ~LP5523_MODE_ENG3_M) | LP5523_RUN_ENG3;
		exec = (exec & ~LP5523_EXEC_ENG3_M) | LP5523_RUN_ENG3;
	}

	lp55xx_write(chip, LP5523_REG_OP_MODE, mode);
	lp5523_wait_opmode_done();

	lp55xx_update_bits(chip, LP5523_REG_ENABLE, LP5523_EXEC_M, exec);
}

static int lp5523_update_program_memory(struct lp55xx_chip *chip,
					const u8 *data, size_t size)
{
	u8 pattern[LP5523_PROGRAM_LENGTH] = {0};
	unsigned cmd;
	char c[3];
	int update_size;
	int nrchars;
	int offset = 0;
	int ret;
	int i;

	/* clear program memory before updating */
	for (i = 0; i < LP5523_PROGRAM_LENGTH; i++)
		lp55xx_write(chip, LP5523_REG_PROG_MEM + i, 0);

	i = 0;
	while ((offset < size - 1) && (i < LP5523_PROGRAM_LENGTH)) {
		/* separate sscanfs because length is working only for %s */
		ret = sscanf(data + offset, "%2s%n ", c, &nrchars);
		if (ret != 1)
			goto err;

		ret = sscanf(c, "%2x", &cmd);
		if (ret != 1)
			goto err;

		pattern[i] = (u8)cmd;
		offset += nrchars;
		i++;
	}

	/* Each instruction is 16bit long. Check that length is even */
	if (i % 2)
		goto err;

	update_size = i;
	for (i = 0; i < update_size; i++)
		lp55xx_write(chip, LP5523_REG_PROG_MEM + i, pattern[i]);

	return 0;

err:
	dev_err(&chip->cl->dev, "wrong pattern format\n");
	return -EINVAL;
}

static void lp5523_firmware_loaded(struct lp55xx_chip *chip)
{
	const struct firmware *fw = chip->fw;

	if (fw->size > LP5523_PROGRAM_LENGTH) {
		dev_err(&chip->cl->dev, "firmware data size overflow: %zu\n",
			fw->size);
		return;
	}

	/*
	 * Program momery sequence
	 *  1) set engine mode to "LOAD"
	 *  2) write firmware data into program memory
	 */

	lp5523_load_engine(chip);
	lp5523_update_program_memory(chip, fw->data, fw->size);
}

static ssize_t lp5523_selftest(struct device *dev,
			       struct device_attribute *attr,
			       char *buf)
{
	struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
	struct lp55xx_chip *chip = led->chip;
	struct lp55xx_platform_data *pdata = chip->pdata;
	int i, ret, pos = 0;
	u8 status, adc, vdd;

	mutex_lock(&chip->lock);

	ret = lp55xx_read(chip, LP5523_REG_STATUS, &status);
	if (ret < 0)
		goto fail;

	/* Check that ext clock is really in use if requested */
	if (pdata->clock_mode == LP55XX_CLOCK_EXT) {
		if  ((status & LP5523_EXT_CLK_USED) == 0)
			goto fail;
	}

	/* Measure VDD (i.e. VBAT) first (channel 16 corresponds to VDD) */
	lp55xx_write(chip, LP5523_REG_LED_TEST_CTRL, LP5523_EN_LEDTEST | 16);
	usleep_range(3000, 6000); /* ADC conversion time is typically 2.7 ms */
	ret = lp55xx_read(chip, LP5523_REG_STATUS, &status);
	if (ret < 0)
		goto fail;

	if (!(status & LP5523_LEDTEST_DONE))
		usleep_range(3000, 6000); /* Was not ready. Wait little bit */

	ret = lp55xx_read(chip, LP5523_REG_LED_TEST_ADC, &vdd);
	if (ret < 0)
		goto fail;

	vdd--;	/* There may be some fluctuation in measurement */

	for (i = 0; i < LP5523_MAX_LEDS; i++) {
		/* Skip non-existing channels */
		if (pdata->led_config[i].led_current == 0)
			continue;

		/* Set default current */
		lp55xx_write(chip, LP5523_REG_LED_CURRENT_BASE + i,
			pdata->led_config[i].led_current);

		lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + i, 0xff);
		/* let current stabilize 2 - 4ms before measurements start */
		usleep_range(2000, 4000);
		lp55xx_write(chip, LP5523_REG_LED_TEST_CTRL,
			     LP5523_EN_LEDTEST | i);
		/* ADC conversion time is 2.7 ms typically */
		usleep_range(3000, 6000);
		ret = lp55xx_read(chip, LP5523_REG_STATUS, &status);
		if (ret < 0)
			goto fail;

		if (!(status & LP5523_LEDTEST_DONE))
			usleep_range(3000, 6000);/* Was not ready. Wait. */

		ret = lp55xx_read(chip, LP5523_REG_LED_TEST_ADC, &adc);
		if (ret < 0)
			goto fail;

		if (adc >= vdd || adc < LP5523_ADC_SHORTCIRC_LIM)
			pos += sprintf(buf + pos, "LED %d FAIL\n", i);

		lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + i, 0x00);

		/* Restore current */
		lp55xx_write(chip, LP5523_REG_LED_CURRENT_BASE + i,
			led->led_current);
		led++;
	}
	if (pos == 0)
		pos = sprintf(buf, "OK\n");
	goto release_lock;
fail:
	pos = sprintf(buf, "FAIL\n");

release_lock:
	mutex_unlock(&chip->lock);

	return pos;
}

static void lp5523_led_brightness_work(struct work_struct *work)
{
	struct lp55xx_led *led = container_of(work, struct lp55xx_led,
					      brightness_work);
	struct lp55xx_chip *chip = led->chip;

	mutex_lock(&chip->lock);
	lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + led->chan_nr,
		     led->brightness);
	mutex_unlock(&chip->lock);
}

static DEVICE_ATTR(selftest, S_IRUGO, lp5523_selftest, NULL);

static struct attribute *lp5523_attributes[] = {
	&dev_attr_selftest.attr,
	NULL,
};

static const struct attribute_group lp5523_group = {
	.attrs = lp5523_attributes,
};

/* Chip specific configurations */
static struct lp55xx_device_config lp5523_cfg = {
	.reset = {
		.addr = LP5523_REG_RESET,
		.val  = LP5523_RESET,
	},
	.enable = {
		.addr = LP5523_REG_ENABLE,
		.val  = LP5523_ENABLE,
	},
	.max_channel  = LP5523_MAX_LEDS,
	.post_init_device   = lp5523_post_init_device,
	.brightness_work_fn = lp5523_led_brightness_work,
	.set_led_current    = lp5523_set_led_current,
	.firmware_cb        = lp5523_firmware_loaded,
	.run_engine         = lp5523_run_engine,
	.dev_attr_group     = &lp5523_group,
};

static int lp5523_probe(struct i2c_client *client,
			const struct i2c_device_id *id)
{
	int ret;
	struct lp55xx_chip *chip;
	struct lp55xx_led *led;
	struct lp55xx_platform_data *pdata = client->dev.platform_data;

	if (!pdata) {
		dev_err(&client->dev, "no platform data\n");
		return -EINVAL;
	}

	chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
	if (!chip)
		return -ENOMEM;

	led = devm_kzalloc(&client->dev,
			sizeof(*led) * pdata->num_channels, GFP_KERNEL);
	if (!led)
		return -ENOMEM;

	chip->cl = client;
	chip->pdata = pdata;
	chip->cfg = &lp5523_cfg;

	mutex_init(&chip->lock);

	i2c_set_clientdata(client, led);

	ret = lp55xx_init_device(chip);
	if (ret)
		goto err_init;

	dev_info(&client->dev, "%s Programmable led chip found\n", id->name);

	ret = lp55xx_register_leds(led, chip);
	if (ret)
		goto err_register_leds;

	ret = lp55xx_register_sysfs(chip);
	if (ret) {
		dev_err(&client->dev, "registering sysfs failed\n");
		goto err_register_sysfs;
	}

	return 0;

err_register_sysfs:
	lp55xx_unregister_leds(led, chip);
err_register_leds:
	lp55xx_deinit_device(chip);
err_init:
	return ret;
}

static int lp5523_remove(struct i2c_client *client)
{
	struct lp55xx_led *led = i2c_get_clientdata(client);
	struct lp55xx_chip *chip = led->chip;

	lp5523_stop_engine(chip);
	lp55xx_unregister_sysfs(chip);
	lp55xx_unregister_leds(led, chip);
	lp55xx_deinit_device(chip);

	return 0;
}

static const struct i2c_device_id lp5523_id[] = {
	{ "lp5523",  LP5523 },
	{ "lp55231", LP55231 },
	{ }
};

MODULE_DEVICE_TABLE(i2c, lp5523_id);

static struct i2c_driver lp5523_driver = {
	.driver = {
		.name	= "lp5523x",
	},
	.probe		= lp5523_probe,
	.remove		= lp5523_remove,
	.id_table	= lp5523_id,
};

module_i2c_driver(lp5523_driver);

MODULE_AUTHOR("Mathias Nyman <mathias.nyman@nokia.com>");
MODULE_DESCRIPTION("LP5523 LED engine");
MODULE_LICENSE("GPL");
Commit	Line	Data
0efba16c SO	1	/*
	2	* lp5523.c - LP5523 LED Driver
	3	*
	4	* Copyright (C) 2010 Nokia Corporation
	5	*
	6	* Contact: Samu Onkalo <samu.p.onkalo@nokia.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
	10	* version 2 as published by the Free Software Foundation.
	11	*
	12	* This program is distributed in the hope that it will be useful, but
	13	* WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	15	* General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
	20	* 02110-1301 USA
	21	*/
	22
	23	#include <linux/module.h>
	24	#include <linux/init.h>
	25	#include <linux/i2c.h>
	26	#include <linux/mutex.h>
	27	#include <linux/gpio.h>
	28	#include <linux/interrupt.h>
	29	#include <linux/delay.h>
	30	#include <linux/ctype.h>
	31	#include <linux/spinlock.h>
	32	#include <linux/wait.h>
	33	#include <linux/leds.h>
	34	#include <linux/leds-lp5523.h>
	35	#include <linux/workqueue.h>
	36	#include <linux/slab.h>
6a0c9a47	37	#include <linux/platform_data/leds-lp55xx.h>
db6eaf83	38	#include <linux/firmware.h>
6a0c9a47 MWK	39
6a0c9a47 MWK	40	#include "leds-lp55xx-common.h"
0efba16c	41
12f022d2 MWK	42	#define LP5523_PROGRAM_LENGTH 32
	43	#define LP5523_MAX_LEDS 9
	44
	45	/* Registers */
0efba16c SO	46	#define LP5523_REG_ENABLE 0x00
0efba16c SO	47	#define LP5523_REG_OP_MODE 0x01
0efba16c SO	48	#define LP5523_REG_ENABLE_LEDS_MSB 0x04
0efba16c SO	49	#define LP5523_REG_ENABLE_LEDS_LSB 0x05
0efba16c SO	50	#define LP5523_REG_LED_PWM_BASE 0x16
	51	#define LP5523_REG_LED_CURRENT_BASE 0x26
	52	#define LP5523_REG_CONFIG 0x36
12f022d2 MWK	53	#define LP5523_REG_STATUS 0x3A
12f022d2 MWK	54	#define LP5523_REG_RESET 0x3D
0efba16c SO	55	#define LP5523_REG_LED_TEST_CTRL 0x41
0efba16c SO	56	#define LP5523_REG_LED_TEST_ADC 0x42
12f022d2	57	#define LP5523_REG_PROG_PAGE_SEL 0x4F
0efba16c SO	58	#define LP5523_REG_PROG_MEM 0x50
0efba16c SO	59
12f022d2	60	/* Bit description in registers */
0efba16c SO	61	#define LP5523_ENABLE 0x40
	62	#define LP5523_AUTO_INC 0x40
	63	#define LP5523_PWR_SAVE 0x20
	64	#define LP5523_PWM_PWR_SAVE 0x04
0efba16c	65	#define LP5523_CP_AUTO 0x18
0efba16c	66	#define LP5523_AUTO_CLK 0x02
12f022d2	67
0efba16c SO	68	#define LP5523_EN_LEDTEST 0x80
0efba16c SO	69	#define LP5523_LEDTEST_DONE 0x80
48068d5d	70	#define LP5523_RESET 0xFF
0efba16c	71	#define LP5523_ADC_SHORTCIRC_LIM 80
0efba16c SO	72	#define LP5523_EXT_CLK_USED 0x08
0efba16c SO	73
db6eaf83 MWK	74	/* Memory Page Selection */
	75	#define LP5523_PAGE_ENG1 0
	76	#define LP5523_PAGE_ENG2 1
	77	#define LP5523_PAGE_ENG3 2
	78
	79	/* Program Memory Operations */
	80	#define LP5523_MODE_ENG1_M 0x30 /* Operation Mode Register */
	81	#define LP5523_MODE_ENG2_M 0x0C
	82	#define LP5523_MODE_ENG3_M 0x03
	83	#define LP5523_LOAD_ENG1 0x10
	84	#define LP5523_LOAD_ENG2 0x04
	85	#define LP5523_LOAD_ENG3 0x01
	86
	87	#define LP5523_ENG1_IS_LOADING(mode) \
	88	((mode & LP5523_MODE_ENG1_M) == LP5523_LOAD_ENG1)
	89	#define LP5523_ENG2_IS_LOADING(mode) \
	90	((mode & LP5523_MODE_ENG2_M) == LP5523_LOAD_ENG2)
	91	#define LP5523_ENG3_IS_LOADING(mode) \
	92	((mode & LP5523_MODE_ENG3_M) == LP5523_LOAD_ENG3)
	93
	94	#define LP5523_EXEC_ENG1_M 0x30 /* Enable Register */
	95	#define LP5523_EXEC_ENG2_M 0x0C
	96	#define LP5523_EXEC_ENG3_M 0x03
	97	#define LP5523_EXEC_M 0x3F
	98	#define LP5523_RUN_ENG1 0x20
	99	#define LP5523_RUN_ENG2 0x08
	100	#define LP5523_RUN_ENG3 0x02
	101
27d7704e KM	102	enum lp5523_chip_id {
	103	LP5523,
	104	LP55231,
	105	};
	106
db6eaf83 MWK	107	static inline void lp5523_wait_opmode_done(void)
	108	{
	109	usleep_range(1000, 2000);
	110	}
	111
a96bfa13 MWK	112	static void lp5523_set_led_current(struct lp55xx_led *led, u8 led_current)
	113	{
	114	led->led_current = led_current;
	115	lp55xx_write(led->chip, LP5523_REG_LED_CURRENT_BASE + led->chan_nr,
	116	led_current);
	117	}
	118
ffbdccdb	119	static int lp5523_post_init_device(struct lp55xx_chip *chip)
0efba16c	120	{
ffbdccdb	121	int ret;
0efba16c	122
ffbdccdb	123	ret = lp55xx_write(chip, LP5523_REG_ENABLE, LP5523_ENABLE);
632418bf MWK	124	if (ret)
632418bf MWK	125	return ret;
0efba16c	126
2e4840ed SO	127	/* Chip startup time is 500 us, 1 - 2 ms gives some margin */
2e4840ed SO	128	usleep_range(1000, 2000);
0efba16c	129
ffbdccdb	130	ret = lp55xx_write(chip, LP5523_REG_CONFIG,
0efba16c SO	131	LP5523_AUTO_INC \| LP5523_PWR_SAVE \|
	132	LP5523_CP_AUTO \| LP5523_AUTO_CLK \|
	133	LP5523_PWM_PWR_SAVE);
632418bf MWK	134	if (ret)
632418bf MWK	135	return ret;
0efba16c SO	136
0efba16c SO	137	/* turn on all leds */
ffbdccdb	138	ret = lp55xx_write(chip, LP5523_REG_ENABLE_LEDS_MSB, 0x01);
632418bf	139	if (ret)
1b21ec5a JH	140	return ret;
1b21ec5a JH	141
ffbdccdb	142	return lp55xx_write(chip, LP5523_REG_ENABLE_LEDS_LSB, 0xff);
0efba16c SO	143	}
0efba16c SO	144
db6eaf83	145	static void lp5523_load_engine(struct lp55xx_chip *chip)
0efba16c	146	{
db6eaf83 MWK	147	enum lp55xx_engine_index idx = chip->engine_idx;
	148	u8 mask[] = {
	149	[LP55XX_ENGINE_1] = LP5523_MODE_ENG1_M,
	150	[LP55XX_ENGINE_2] = LP5523_MODE_ENG2_M,
	151	[LP55XX_ENGINE_3] = LP5523_MODE_ENG3_M,
	152	};
	153
	154	u8 val[] = {
	155	[LP55XX_ENGINE_1] = LP5523_LOAD_ENG1,
	156	[LP55XX_ENGINE_2] = LP5523_LOAD_ENG2,
	157	[LP55XX_ENGINE_3] = LP5523_LOAD_ENG3,
	158	};
	159
	160	u8 page_sel[] = {
	161	[LP55XX_ENGINE_1] = LP5523_PAGE_ENG1,
	162	[LP55XX_ENGINE_2] = LP5523_PAGE_ENG2,
	163	[LP55XX_ENGINE_3] = LP5523_PAGE_ENG3,
	164	};
	165
	166	lp55xx_update_bits(chip, LP5523_REG_OP_MODE, mask[idx], val[idx]);
	167
	168	lp5523_wait_opmode_done();
	169
	170	lp55xx_write(chip, LP5523_REG_PROG_PAGE_SEL, page_sel[idx]);
0efba16c SO	171	}
0efba16c SO	172
db6eaf83	173	static void lp5523_stop_engine(struct lp55xx_chip *chip)
0efba16c	174	{
db6eaf83 MWK	175	lp55xx_write(chip, LP5523_REG_OP_MODE, 0);
	176	lp5523_wait_opmode_done();
	177	}
0efba16c	178
db6eaf83 MWK	179	static void lp5523_turn_off_channels(struct lp55xx_chip *chip)
	180	{
	181	int i;
0efba16c	182
db6eaf83 MWK	183	for (i = 0; i < LP5523_MAX_LEDS; i++)
db6eaf83 MWK	184	lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + i, 0);
0efba16c SO	185	}
0efba16c SO	186
db6eaf83	187	static void lp5523_run_engine(struct lp55xx_chip *chip, bool start)
0efba16c	188	{
db6eaf83 MWK	189	int ret;
	190	u8 mode;
	191	u8 exec;
0efba16c	192
db6eaf83 MWK	193	/* stop engine */
	194	if (!start) {
	195	lp5523_stop_engine(chip);
	196	lp5523_turn_off_channels(chip);
	197	return;
	198	}
0efba16c	199
db6eaf83 MWK	200	/*
	201	* To run the engine,
	202	* operation mode and enable register should updated at the same time
	203	*/
0efba16c	204
db6eaf83 MWK	205	ret = lp55xx_read(chip, LP5523_REG_OP_MODE, &mode);
	206	if (ret)
	207	return;
0efba16c	208
db6eaf83 MWK	209	ret = lp55xx_read(chip, LP5523_REG_ENABLE, &exec);
	210	if (ret)
	211	return;
0efba16c	212
db6eaf83 MWK	213	/* change operation mode to RUN only when each engine is loading */
	214	if (LP5523_ENG1_IS_LOADING(mode)) {
	215	mode = (mode & ~LP5523_MODE_ENG1_M) \| LP5523_RUN_ENG1;
	216	exec = (exec & ~LP5523_EXEC_ENG1_M) \| LP5523_RUN_ENG1;
	217	}
0efba16c	218
db6eaf83 MWK	219	if (LP5523_ENG2_IS_LOADING(mode)) {
	220	mode = (mode & ~LP5523_MODE_ENG2_M) \| LP5523_RUN_ENG2;
	221	exec = (exec & ~LP5523_EXEC_ENG2_M) \| LP5523_RUN_ENG2;
	222	}
0efba16c	223
db6eaf83 MWK	224	if (LP5523_ENG3_IS_LOADING(mode)) {
	225	mode = (mode & ~LP5523_MODE_ENG3_M) \| LP5523_RUN_ENG3;
	226	exec = (exec & ~LP5523_EXEC_ENG3_M) \| LP5523_RUN_ENG3;
	227	}
	228
	229	lp55xx_write(chip, LP5523_REG_OP_MODE, mode);
	230	lp5523_wait_opmode_done();
	231
	232	lp55xx_update_bits(chip, LP5523_REG_ENABLE, LP5523_EXEC_M, exec);
0efba16c SO	233	}
0efba16c SO	234
db6eaf83 MWK	235	static int lp5523_update_program_memory(struct lp55xx_chip *chip,
db6eaf83 MWK	236	const u8 *data, size_t size)
0efba16c	237	{
db6eaf83 MWK	238	u8 pattern[LP5523_PROGRAM_LENGTH] = {0};
	239	unsigned cmd;
	240	char c[3];
	241	int update_size;
	242	int nrchars;
	243	int offset = 0;
	244	int ret;
0efba16c	245	int i;
0efba16c	246
db6eaf83 MWK	247	/* clear program memory before updating */
	248	for (i = 0; i < LP5523_PROGRAM_LENGTH; i++)
	249	lp55xx_write(chip, LP5523_REG_PROG_MEM + i, 0);
0efba16c	250
db6eaf83 MWK	251	i = 0;
	252	while ((offset < size - 1) && (i < LP5523_PROGRAM_LENGTH)) {
	253	/* separate sscanfs because length is working only for %s */
	254	ret = sscanf(data + offset, "%2s%n ", c, &nrchars);
	255	if (ret != 1)
	256	goto err;
0efba16c	257
db6eaf83 MWK	258	ret = sscanf(c, "%2x", &cmd);
	259	if (ret != 1)
	260	goto err;
0efba16c	261
db6eaf83 MWK	262	pattern[i] = (u8)cmd;
	263	offset += nrchars;
	264	i++;
	265	}
0efba16c	266
db6eaf83 MWK	267	/* Each instruction is 16bit long. Check that length is even */
	268	if (i % 2)
	269	goto err;
0efba16c	270
db6eaf83 MWK	271	update_size = i;
	272	for (i = 0; i < update_size; i++)
	273	lp55xx_write(chip, LP5523_REG_PROG_MEM + i, pattern[i]);
0efba16c	274
db6eaf83	275	return 0;
0efba16c	276
db6eaf83 MWK	277	err:
	278	dev_err(&chip->cl->dev, "wrong pattern format\n");
	279	return -EINVAL;
0efba16c	280	}
0efba16c	281
db6eaf83	282	static void lp5523_firmware_loaded(struct lp55xx_chip *chip)
0efba16c	283	{
db6eaf83	284	const struct firmware *fw = chip->fw;
fbac0812	285
db6eaf83 MWK	286	if (fw->size > LP5523_PROGRAM_LENGTH) {
	287	dev_err(&chip->cl->dev, "firmware data size overflow: %zu\n",
	288	fw->size);
	289	return;
	290	}
0efba16c	291
db6eaf83 MWK	292	/*
	293	* Program momery sequence
	294	* 1) set engine mode to "LOAD"
	295	* 2) write firmware data into program memory
	296	*/
0efba16c	297
db6eaf83 MWK	298	lp5523_load_engine(chip);
db6eaf83 MWK	299	lp5523_update_program_memory(chip, fw->data, fw->size);
0efba16c	300	}
0efba16c SO	301
	302	static ssize_t lp5523_selftest(struct device *dev,
	303	struct device_attribute *attr,
	304	char *buf)
	305	{
9ca3bd80 MWK	306	struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
	307	struct lp55xx_chip *chip = led->chip;
	308	struct lp55xx_platform_data *pdata = chip->pdata;
0efba16c	309	int i, ret, pos = 0;
0efba16c SO	310	u8 status, adc, vdd;
	311
	312	mutex_lock(&chip->lock);
	313
9ca3bd80	314	ret = lp55xx_read(chip, LP5523_REG_STATUS, &status);
0efba16c SO	315	if (ret < 0)
	316	goto fail;
	317
	318	/* Check that ext clock is really in use if requested */
9ca3bd80	319	if (pdata->clock_mode == LP55XX_CLOCK_EXT) {
0efba16c SO	320	if ((status & LP5523_EXT_CLK_USED) == 0)
0efba16c SO	321	goto fail;
9ca3bd80	322	}
0efba16c SO	323
0efba16c SO	324	/* Measure VDD (i.e. VBAT) first (channel 16 corresponds to VDD) */
9ca3bd80	325	lp55xx_write(chip, LP5523_REG_LED_TEST_CTRL, LP5523_EN_LEDTEST \| 16);
2e4840ed	326	usleep_range(3000, 6000); /* ADC conversion time is typically 2.7 ms */
9ca3bd80	327	ret = lp55xx_read(chip, LP5523_REG_STATUS, &status);
1b21ec5a JH	328	if (ret < 0)
	329	goto fail;
	330
0efba16c	331	if (!(status & LP5523_LEDTEST_DONE))
2e4840ed	332	usleep_range(3000, 6000); /* Was not ready. Wait little bit */
0efba16c	333
9ca3bd80	334	ret = lp55xx_read(chip, LP5523_REG_LED_TEST_ADC, &vdd);
1b21ec5a JH	335	if (ret < 0)
	336	goto fail;
	337
0efba16c SO	338	vdd--; /* There may be some fluctuation in measurement */
0efba16c SO	339
0e202346	340	for (i = 0; i < LP5523_MAX_LEDS; i++) {
0efba16c	341	/* Skip non-existing channels */
9ca3bd80	342	if (pdata->led_config[i].led_current == 0)
0efba16c SO	343	continue;
	344
	345	/* Set default current */
9ca3bd80 MWK	346	lp55xx_write(chip, LP5523_REG_LED_CURRENT_BASE + i,
9ca3bd80 MWK	347	pdata->led_config[i].led_current);
0efba16c	348
9ca3bd80	349	lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + i, 0xff);
2e4840ed SO	350	/* let current stabilize 2 - 4ms before measurements start */
2e4840ed SO	351	usleep_range(2000, 4000);
9ca3bd80	352	lp55xx_write(chip, LP5523_REG_LED_TEST_CTRL,
0efba16c	353	LP5523_EN_LEDTEST \| i);
2e4840ed SO	354	/* ADC conversion time is 2.7 ms typically */
2e4840ed SO	355	usleep_range(3000, 6000);
9ca3bd80	356	ret = lp55xx_read(chip, LP5523_REG_STATUS, &status);
1b21ec5a JH	357	if (ret < 0)
	358	goto fail;
	359
0efba16c	360	if (!(status & LP5523_LEDTEST_DONE))
2e4840ed	361	usleep_range(3000, 6000);/* Was not ready. Wait. */
9ca3bd80 MWK	362
9ca3bd80 MWK	363	ret = lp55xx_read(chip, LP5523_REG_LED_TEST_ADC, &adc);
1b21ec5a JH	364	if (ret < 0)
1b21ec5a JH	365	goto fail;
0efba16c SO	366
	367	if (adc >= vdd \|\| adc < LP5523_ADC_SHORTCIRC_LIM)
	368	pos += sprintf(buf + pos, "LED %d FAIL\n", i);
	369
9ca3bd80	370	lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + i, 0x00);
0efba16c SO	371
0efba16c SO	372	/* Restore current */
9ca3bd80 MWK	373	lp55xx_write(chip, LP5523_REG_LED_CURRENT_BASE + i,
9ca3bd80 MWK	374	led->led_current);
0efba16c SO	375	led++;
	376	}
	377	if (pos == 0)
	378	pos = sprintf(buf, "OK\n");
	379	goto release_lock;
	380	fail:
	381	pos = sprintf(buf, "FAIL\n");
	382
	383	release_lock:
	384	mutex_unlock(&chip->lock);
	385
	386	return pos;
	387	}
	388
0efba16c SO	389	static void lp5523_led_brightness_work(struct work_struct *work)
0efba16c SO	390	{
a6e4679a	391	struct lp55xx_led *led = container_of(work, struct lp55xx_led,
0efba16c	392	brightness_work);
a6e4679a	393	struct lp55xx_chip *chip = led->chip;
0efba16c SO	394
0efba16c SO	395	mutex_lock(&chip->lock);
a6e4679a	396	lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + led->chan_nr,
0efba16c	397	led->brightness);
0efba16c SO	398	mutex_unlock(&chip->lock);
	399	}
	400
0efba16c SO	401	static DEVICE_ATTR(selftest, S_IRUGO, lp5523_selftest, NULL);
	402
	403	static struct attribute *lp5523_attributes[] = {
0efba16c	404	&dev_attr_selftest.attr,
f1625842	405	NULL,
0efba16c SO	406	};
	407
	408	static const struct attribute_group lp5523_group = {
	409	.attrs = lp5523_attributes,
	410	};
	411
48068d5d MWK	412	/* Chip specific configurations */
	413	static struct lp55xx_device_config lp5523_cfg = {
	414	.reset = {
	415	.addr = LP5523_REG_RESET,
	416	.val = LP5523_RESET,
	417	},
e3a700d8 MWK	418	.enable = {
	419	.addr = LP5523_REG_ENABLE,
	420	.val = LP5523_ENABLE,
	421	},
0e202346	422	.max_channel = LP5523_MAX_LEDS,
ffbdccdb	423	.post_init_device = lp5523_post_init_device,
a6e4679a	424	.brightness_work_fn = lp5523_led_brightness_work,
a96bfa13	425	.set_led_current = lp5523_set_led_current,
db6eaf83 MWK	426	.firmware_cb = lp5523_firmware_loaded,
db6eaf83 MWK	427	.run_engine = lp5523_run_engine,
e73c0ce6	428	.dev_attr_group = &lp5523_group,
48068d5d MWK	429	};
48068d5d MWK	430
98ea1ea2	431	static int lp5523_probe(struct i2c_client *client,
0efba16c SO	432	const struct i2c_device_id *id)
0efba16c SO	433	{
22ebeb48	434	int ret;
6a0c9a47 MWK	435	struct lp55xx_chip *chip;
	436	struct lp55xx_led *led;
	437	struct lp55xx_platform_data *pdata = client->dev.platform_data;
0efba16c	438
6a0c9a47	439	if (!pdata) {
0efba16c	440	dev_err(&client->dev, "no platform data\n");
94ca4bcc	441	return -EINVAL;
0efba16c SO	442	}
0efba16c SO	443
6a0c9a47 MWK	444	chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
	445	if (!chip)
	446	return -ENOMEM;
	447
	448	led = devm_kzalloc(&client->dev,
	449	sizeof(led) pdata->num_channels, GFP_KERNEL);
	450	if (!led)
	451	return -ENOMEM;
	452
	453	chip->cl = client;
	454	chip->pdata = pdata;
48068d5d	455	chip->cfg = &lp5523_cfg;
6a0c9a47 MWK	456
6a0c9a47 MWK	457	mutex_init(&chip->lock);
0efba16c	458
6a0c9a47	459	i2c_set_clientdata(client, led);
0efba16c	460
22ebeb48	461	ret = lp55xx_init_device(chip);
0efba16c	462	if (ret)
f6c64c6f	463	goto err_init;
0efba16c	464
56a1e9ad	465	dev_info(&client->dev, "%s Programmable led chip found\n", id->name);
0efba16c	466
9e9b3db1	467	ret = lp55xx_register_leds(led, chip);
f6524808	468	if (ret)
9e9b3db1	469	goto err_register_leds;
0efba16c	470
e73c0ce6	471	ret = lp55xx_register_sysfs(chip);
0efba16c SO	472	if (ret) {
0efba16c SO	473	dev_err(&client->dev, "registering sysfs failed\n");
e73c0ce6	474	goto err_register_sysfs;
0efba16c	475	}
e73c0ce6 MWK	476
	477	return 0;
	478
	479	err_register_sysfs:
c3a68ebf	480	lp55xx_unregister_leds(led, chip);
9e9b3db1	481	err_register_leds:
6ce61762	482	lp55xx_deinit_device(chip);
f6c64c6f	483	err_init:
0efba16c SO	484	return ret;
	485	}
	486
	487	static int lp5523_remove(struct i2c_client *client)
	488	{
6ce61762 MWK	489	struct lp55xx_led *led = i2c_get_clientdata(client);
6ce61762 MWK	490	struct lp55xx_chip *chip = led->chip;
0efba16c	491
87cc4bde MWK	492	lp5523_stop_engine(chip);
87cc4bde MWK	493	lp55xx_unregister_sysfs(chip);
c3a68ebf	494	lp55xx_unregister_leds(led, chip);
6ce61762	495	lp55xx_deinit_device(chip);
0efba16c	496
0efba16c SO	497	return 0;
	498	}
	499
	500	static const struct i2c_device_id lp5523_id[] = {
27d7704e KM	501	{ "lp5523", LP5523 },
27d7704e KM	502	{ "lp55231", LP55231 },
0efba16c SO	503	{ }
	504	};
	505
	506	MODULE_DEVICE_TABLE(i2c, lp5523_id);
	507
	508	static struct i2c_driver lp5523_driver = {
	509	.driver = {
27d7704e	510	.name = "lp5523x",
0efba16c SO	511	},
	512	.probe = lp5523_probe,
	513	.remove = lp5523_remove,
	514	.id_table = lp5523_id,
	515	};
	516
09a0d183	517	module_i2c_driver(lp5523_driver);
0efba16c SO	518
	519	MODULE_AUTHOR("Mathias Nyman <mathias.nyman@nokia.com>");
	520	MODULE_DESCRIPTION("LP5523 LED engine");
	521	MODULE_LICENSE("GPL");