[mirror_ubuntu-artful-kernel.git] / include / linux / platform_data / lp855x.h

/*
 * LP855x Backlight Driver
 *
 *			Copyright (C) 2011 Texas Instruments
 *
 * 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.
 *
 */

#ifndef _LP855X_H
#define _LP855X_H

#define BL_CTL_SHFT	(0)
#define BRT_MODE_SHFT	(1)
#define BRT_MODE_MASK	(0x06)

/* Enable backlight. Only valid when BRT_MODE=10(I2C only) */
#define ENABLE_BL	(1)
#define DISABLE_BL	(0)

#define I2C_CONFIG(id)	id ## _I2C_CONFIG
#define PWM_CONFIG(id)	id ## _PWM_CONFIG

/* DEVICE CONTROL register - LP8550 */
#define LP8550_PWM_CONFIG	(LP8550_PWM_ONLY << BRT_MODE_SHFT)
#define LP8550_I2C_CONFIG	((ENABLE_BL << BL_CTL_SHFT) | \
				(LP8550_I2C_ONLY << BRT_MODE_SHFT))

/* DEVICE CONTROL register - LP8551 */
#define LP8551_PWM_CONFIG	LP8550_PWM_CONFIG
#define LP8551_I2C_CONFIG	LP8550_I2C_CONFIG

/* DEVICE CONTROL register - LP8552 */
#define LP8552_PWM_CONFIG	LP8550_PWM_CONFIG
#define LP8552_I2C_CONFIG	LP8550_I2C_CONFIG

/* DEVICE CONTROL register - LP8553 */
#define LP8553_PWM_CONFIG	LP8550_PWM_CONFIG
#define LP8553_I2C_CONFIG	LP8550_I2C_CONFIG

/* CONFIG register - LP8555 */
#define LP8555_PWM_STANDBY	BIT(7)
#define LP8555_PWM_FILTER	BIT(6)
#define LP8555_RELOAD_EPROM	BIT(3)	/* use it if EPROMs should be reset
					   when the backlight turns on */
#define LP8555_OFF_OPENLEDS	BIT(2)
#define LP8555_PWM_CONFIG	LP8555_PWM_ONLY
#define LP8555_I2C_CONFIG	LP8555_I2C_ONLY
#define LP8555_COMB1_CONFIG	LP8555_COMBINED1
#define LP8555_COMB2_CONFIG	LP8555_COMBINED2

/* DEVICE CONTROL register - LP8556 */
#define LP8556_PWM_CONFIG	(LP8556_PWM_ONLY << BRT_MODE_SHFT)
#define LP8556_COMB1_CONFIG	(LP8556_COMBINED1 << BRT_MODE_SHFT)
#define LP8556_I2C_CONFIG	((ENABLE_BL << BL_CTL_SHFT) | \
				(LP8556_I2C_ONLY << BRT_MODE_SHFT))
#define LP8556_COMB2_CONFIG	(LP8556_COMBINED2 << BRT_MODE_SHFT)
#define LP8556_FAST_CONFIG	BIT(7) /* use it if EPROMs should be maintained
					  when exiting the low power mode */

/* CONFIG register - LP8557 */
#define LP8557_PWM_STANDBY	BIT(7)
#define LP8557_PWM_FILTER	BIT(6)
#define LP8557_RELOAD_EPROM	BIT(3)	/* use it if EPROMs should be reset
					   when the backlight turns on */
#define LP8557_OFF_OPENLEDS	BIT(2)
#define LP8557_PWM_CONFIG	LP8557_PWM_ONLY
#define LP8557_I2C_CONFIG	LP8557_I2C_ONLY
#define LP8557_COMB1_CONFIG	LP8557_COMBINED1
#define LP8557_COMB2_CONFIG	LP8557_COMBINED2

enum lp855x_chip_id {
	LP8550,
	LP8551,
	LP8552,
	LP8553,
	LP8555,
	LP8556,
	LP8557,
};

enum lp8550_brighntess_source {
	LP8550_PWM_ONLY,
	LP8550_I2C_ONLY = 2,
};

enum lp8551_brighntess_source {
	LP8551_PWM_ONLY = LP8550_PWM_ONLY,
	LP8551_I2C_ONLY = LP8550_I2C_ONLY,
};

enum lp8552_brighntess_source {
	LP8552_PWM_ONLY = LP8550_PWM_ONLY,
	LP8552_I2C_ONLY = LP8550_I2C_ONLY,
};

enum lp8553_brighntess_source {
	LP8553_PWM_ONLY = LP8550_PWM_ONLY,
	LP8553_I2C_ONLY = LP8550_I2C_ONLY,
};

enum lp8555_brightness_source {
	LP8555_PWM_ONLY,
	LP8555_I2C_ONLY,
	LP8555_COMBINED1,	/* Brightness register with shaped PWM */
	LP8555_COMBINED2,	/* PWM with shaped brightness register */
};

enum lp8556_brightness_source {
	LP8556_PWM_ONLY,
	LP8556_COMBINED1,	/* pwm + i2c before the shaper block */
	LP8556_I2C_ONLY,
	LP8556_COMBINED2,	/* pwm + i2c after the shaper block */
};

enum lp8557_brightness_source {
	LP8557_PWM_ONLY,
	LP8557_I2C_ONLY,
	LP8557_COMBINED1,	/* pwm + i2c after the shaper block */
	LP8557_COMBINED2,	/* pwm + i2c before the shaper block */
};

struct lp855x_rom_data {
	u8 addr;
	u8 val;
};

/**
 * struct lp855x_platform_data
 * @name : Backlight driver name. If it is not defined, default name is set.
 * @device_control : value of DEVICE CONTROL register
 * @initial_brightness : initial value of backlight brightness
 * @period_ns : platform specific pwm period value. unit is nano.
		Only valid when mode is PWM_BASED.
 * @size_program : total size of lp855x_rom_data
 * @rom_data : list of new eeprom/eprom registers
 */
struct lp855x_platform_data {
	const char *name;
	u8 device_control;
	u8 initial_brightness;
	unsigned int period_ns;
	int size_program;
	struct lp855x_rom_data *rom_data;
};

#endif
Commit	Line	Data
7be865ab KM	1	/*
	2	* LP855x Backlight Driver
	3	*
	4	* Copyright (C) 2011 Texas Instruments
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License version 2 as
	8	* published by the Free Software Foundation.
	9	*
	10	*/
	11
	12	#ifndef _LP855X_H
	13	#define _LP855X_H
	14
	15	#define BL_CTL_SHFT (0)
	16	#define BRT_MODE_SHFT (1)
	17	#define BRT_MODE_MASK (0x06)
	18
	19	/* Enable backlight. Only valid when BRT_MODE=10(I2C only) */
	20	#define ENABLE_BL (1)
	21	#define DISABLE_BL (0)
	22
	23	#define I2C_CONFIG(id) id ## _I2C_CONFIG
	24	#define PWM_CONFIG(id) id ## _PWM_CONFIG
	25
	26	/* DEVICE CONTROL register - LP8550 */
	27	#define LP8550_PWM_CONFIG (LP8550_PWM_ONLY << BRT_MODE_SHFT)
	28	#define LP8550_I2C_CONFIG ((ENABLE_BL << BL_CTL_SHFT) \| \
	29	(LP8550_I2C_ONLY << BRT_MODE_SHFT))
	30
	31	/* DEVICE CONTROL register - LP8551 */
	32	#define LP8551_PWM_CONFIG LP8550_PWM_CONFIG
	33	#define LP8551_I2C_CONFIG LP8550_I2C_CONFIG
	34
	35	/* DEVICE CONTROL register - LP8552 */
	36	#define LP8552_PWM_CONFIG LP8550_PWM_CONFIG
	37	#define LP8552_I2C_CONFIG LP8550_I2C_CONFIG
	38
	39	/* DEVICE CONTROL register - LP8553 */
	40	#define LP8553_PWM_CONFIG LP8550_PWM_CONFIG
	41	#define LP8553_I2C_CONFIG LP8550_I2C_CONFIG
	42
5812c13a MK	43	/* CONFIG register - LP8555 */
	44	#define LP8555_PWM_STANDBY BIT(7)
	45	#define LP8555_PWM_FILTER BIT(6)
	46	#define LP8555_RELOAD_EPROM BIT(3) /* use it if EPROMs should be reset
	47	when the backlight turns on */
	48	#define LP8555_OFF_OPENLEDS BIT(2)
	49	#define LP8555_PWM_CONFIG LP8555_PWM_ONLY
	50	#define LP8555_I2C_CONFIG LP8555_I2C_ONLY
	51	#define LP8555_COMB1_CONFIG LP8555_COMBINED1
	52	#define LP8555_COMB2_CONFIG LP8555_COMBINED2
	53
7be865ab KM	54	/* DEVICE CONTROL register - LP8556 */
	55	#define LP8556_PWM_CONFIG (LP8556_PWM_ONLY << BRT_MODE_SHFT)
	56	#define LP8556_COMB1_CONFIG (LP8556_COMBINED1 << BRT_MODE_SHFT)
	57	#define LP8556_I2C_CONFIG ((ENABLE_BL << BL_CTL_SHFT) \| \
	58	(LP8556_I2C_ONLY << BRT_MODE_SHFT))
	59	#define LP8556_COMB2_CONFIG (LP8556_COMBINED2 << BRT_MODE_SHFT)
6275ce9f KM	60	#define LP8556_FAST_CONFIG BIT(7) /* use it if EPROMs should be maintained
6275ce9f KM	61	when exiting the low power mode */
7be865ab	62
26e8ccc2 KM	63	/* CONFIG register - LP8557 */
	64	#define LP8557_PWM_STANDBY BIT(7)
	65	#define LP8557_PWM_FILTER BIT(6)
	66	#define LP8557_RELOAD_EPROM BIT(3) /* use it if EPROMs should be reset
	67	when the backlight turns on */
	68	#define LP8557_OFF_OPENLEDS BIT(2)
	69	#define LP8557_PWM_CONFIG LP8557_PWM_ONLY
	70	#define LP8557_I2C_CONFIG LP8557_I2C_ONLY
	71	#define LP8557_COMB1_CONFIG LP8557_COMBINED1
	72	#define LP8557_COMB2_CONFIG LP8557_COMBINED2
	73
7be865ab KM	74	enum lp855x_chip_id {
	75	LP8550,
	76	LP8551,
	77	LP8552,
	78	LP8553,
5812c13a	79	LP8555,
7be865ab	80	LP8556,
26e8ccc2	81	LP8557,
7be865ab KM	82	};
7be865ab KM	83
7be865ab KM	84	enum lp8550_brighntess_source {
	85	LP8550_PWM_ONLY,
	86	LP8550_I2C_ONLY = 2,
	87	};
	88
	89	enum lp8551_brighntess_source {
	90	LP8551_PWM_ONLY = LP8550_PWM_ONLY,
	91	LP8551_I2C_ONLY = LP8550_I2C_ONLY,
	92	};
	93
	94	enum lp8552_brighntess_source {
	95	LP8552_PWM_ONLY = LP8550_PWM_ONLY,
	96	LP8552_I2C_ONLY = LP8550_I2C_ONLY,
	97	};
	98
	99	enum lp8553_brighntess_source {
	100	LP8553_PWM_ONLY = LP8550_PWM_ONLY,
	101	LP8553_I2C_ONLY = LP8550_I2C_ONLY,
	102	};
	103
5812c13a MK	104	enum lp8555_brightness_source {
	105	LP8555_PWM_ONLY,
	106	LP8555_I2C_ONLY,
	107	LP8555_COMBINED1, /* Brightness register with shaped PWM */
	108	LP8555_COMBINED2, /* PWM with shaped brightness register */
	109	};
	110
7be865ab KM	111	enum lp8556_brightness_source {
	112	LP8556_PWM_ONLY,
	113	LP8556_COMBINED1, /* pwm + i2c before the shaper block */
	114	LP8556_I2C_ONLY,
	115	LP8556_COMBINED2, /* pwm + i2c after the shaper block */
	116	};
	117
26e8ccc2 KM	118	enum lp8557_brightness_source {
	119	LP8557_PWM_ONLY,
	120	LP8557_I2C_ONLY,
	121	LP8557_COMBINED1, /* pwm + i2c after the shaper block */
	122	LP8557_COMBINED2, /* pwm + i2c before the shaper block */
	123	};
	124
7be865ab KM	125	struct lp855x_rom_data {
	126	u8 addr;
	127	u8 val;
	128	};
	129
	130	/**
	131	* struct lp855x_platform_data
	132	* @name : Backlight driver name. If it is not defined, default name is set.
7be865ab KM	133	* @device_control : value of DEVICE CONTROL register
7be865ab KM	134	* @initial_brightness : initial value of backlight brightness
8cc9764c	135	* @period_ns : platform specific pwm period value. unit is nano.
7be865ab	136	Only valid when mode is PWM_BASED.
7be865ab KM	137	* @size_program : total size of lp855x_rom_data
	138	* @rom_data : list of new eeprom/eprom registers
	139	*/
	140	struct lp855x_platform_data {
600ffd33	141	const char *name;
7be865ab	142	u8 device_control;
98e35be2	143	u8 initial_brightness;
8cc9764c	144	unsigned int period_ns;
7be865ab KM	145	int size_program;
	146	struct lp855x_rom_data *rom_data;
	147	};
	148
	149	#endif