Commit 6f2846cc authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

docs: lp855x-driver.txt: convert to ReST and move to kernel-api

This small file seems to be an attempt to start documenting
backlight drivers.

It contains descriptions of the controls for the driver
with could sound as an somewhat user-faced description, but
it's main focus is to describe, instead, the data that should
be passed via platform data and some driver-specific stuff.

While this is not part of the driver-api book, mark it as
:orphan:, in order to avoid build warnings.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
parent 065504d5
:orphan:
====================
Kernel driver lp855x Kernel driver lp855x
==================== ====================
Backlight driver for LP855x ICs Backlight driver for LP855x ICs
Supported chips: Supported chips:
Texas Instruments LP8550, LP8551, LP8552, LP8553, LP8555, LP8556 and Texas Instruments LP8550, LP8551, LP8552, LP8553, LP8555, LP8556 and
LP8557 LP8557
...@@ -14,53 +18,66 @@ Description ...@@ -14,53 +18,66 @@ Description
* Brightness control * Brightness control
Brightness can be controlled by the pwm input or the i2c command. Brightness can be controlled by the pwm input or the i2c command.
The lp855x driver supports both cases. The lp855x driver supports both cases.
* Device attributes * Device attributes
1) bl_ctl_mode 1) bl_ctl_mode
Backlight control mode.
Value : pwm based or register based Backlight control mode.
2) chip_id Value: pwm based or register based
The lp855x chip id.
Value : lp8550/lp8551/lp8552/lp8553/lp8555/lp8556/lp8557 2) chip_id
The lp855x chip id.
Value: lp8550/lp8551/lp8552/lp8553/lp8555/lp8556/lp8557
Platform data for lp855x Platform data for lp855x
------------------------ ------------------------
For supporting platform specific data, the lp855x platform data can be used. For supporting platform specific data, the lp855x platform data can be used.
* name : Backlight driver name. If it is not defined, default name is set. * name:
* device_control : Value of DEVICE CONTROL register. Backlight driver name. If it is not defined, default name is set.
* initial_brightness : Initial value of backlight brightness. * device_control:
* period_ns : Platform specific PWM period value. unit is nano. 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 brightness is pwm input mode. Only valid when brightness is pwm input mode.
* size_program : Total size of lp855x_rom_data. * size_program:
* rom_data : List of new eeprom/eprom registers. Total size of lp855x_rom_data.
* rom_data:
List of new eeprom/eprom registers.
Examples
========
example 1) lp8552 platform data : i2c register mode with new eeprom data 1) lp8552 platform data: i2c register mode with new eeprom data::
#define EEPROM_A5_ADDR 0xA5 #define EEPROM_A5_ADDR 0xA5
#define EEPROM_A5_VAL 0x4f /* EN_VSYNC=0 */ #define EEPROM_A5_VAL 0x4f /* EN_VSYNC=0 */
static struct lp855x_rom_data lp8552_eeprom_arr[] = { static struct lp855x_rom_data lp8552_eeprom_arr[] = {
{EEPROM_A5_ADDR, EEPROM_A5_VAL}, {EEPROM_A5_ADDR, EEPROM_A5_VAL},
}; };
static struct lp855x_platform_data lp8552_pdata = { static struct lp855x_platform_data lp8552_pdata = {
.name = "lcd-bl", .name = "lcd-bl",
.device_control = I2C_CONFIG(LP8552), .device_control = I2C_CONFIG(LP8552),
.initial_brightness = INITIAL_BRT, .initial_brightness = INITIAL_BRT,
.size_program = ARRAY_SIZE(lp8552_eeprom_arr), .size_program = ARRAY_SIZE(lp8552_eeprom_arr),
.rom_data = lp8552_eeprom_arr, .rom_data = lp8552_eeprom_arr,
}; };
example 2) lp8556 platform data : pwm input mode with default rom data 2) lp8556 platform data: pwm input mode with default rom data::
static struct lp855x_platform_data lp8556_pdata = { static struct lp855x_platform_data lp8556_pdata = {
.device_control = PWM_CONFIG(LP8556), .device_control = PWM_CONFIG(LP8556),
.initial_brightness = INITIAL_BRT, .initial_brightness = INITIAL_BRT,
.period_ns = 1000000, .period_ns = 1000000,
}; };
...@@ -15964,7 +15964,7 @@ F: sound/soc/codecs/isabelle* ...@@ -15964,7 +15964,7 @@ F: sound/soc/codecs/isabelle*
TI LP855x BACKLIGHT DRIVER TI LP855x BACKLIGHT DRIVER
M: Milo Kim <milo.kim@ti.com> M: Milo Kim <milo.kim@ti.com>
S: Maintained S: Maintained
F: Documentation/backlight/lp855x-driver.txt F: Documentation/backlight/lp855x-driver.rst
F: drivers/video/backlight/lp855x_bl.c F: drivers/video/backlight/lp855x_bl.c
F: include/linux/platform_data/lp855x.h F: include/linux/platform_data/lp855x.h
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment