linux/Documentation/leds/leds-lp5523.txt
<<
>>
Prefs
   1Kernel driver for lp5523
   2========================
   3
   4* National Semiconductor LP5523 led driver chip
   5* Datasheet: http://www.national.com/pf/LP/LP5523.html
   6
   7Authors: Mathias Nyman, Yuri Zaporozhets, Samu Onkalo
   8Contact: Samu Onkalo (samu.p.onkalo-at-nokia.com)
   9
  10Description
  11-----------
  12LP5523 can drive up to 9 channels. Leds can be controlled directly via
  13the led class control interface.
  14The name of each channel is configurable in the platform data - name and label.
  15There are three options to make the channel name.
  16
  17a) Define the 'name' in the platform data
  18To make specific channel name, then use 'name' platform data.
  19/sys/class/leds/R1               (name: 'R1')
  20/sys/class/leds/B1               (name: 'B1')
  21
  22b) Use the 'label' with no 'name' field
  23For one device name with channel number, then use 'label'.
  24/sys/class/leds/RGB:channelN     (label: 'RGB', N: 0 ~ 8)
  25
  26c) Default
  27If both fields are NULL, 'lp5523' is used by default.
  28/sys/class/leds/lp5523:channelN  (N: 0 ~ 8)
  29
  30LP5523 has the internal program memory for running various LED patterns.
  31For the details, please refer to 'firmware' section in leds-lp55xx.txt
  32
  33Selftest uses always the current from the platform data.
  34
  35Each channel contains led current settings.
  36/sys/class/leds/lp5523:channel2/led_current - RW
  37/sys/class/leds/lp5523:channel2/max_current - RO
  38Format: 10x mA i.e 10 means 1.0 mA
  39
  40Example platform data:
  41
  42Note - chan_nr can have values between 0 and 8.
  43
  44static struct lp55xx_led_config lp5523_led_config[] = {
  45        {
  46                .name           = "D1",
  47                .chan_nr        = 0,
  48                .led_current    = 50,
  49                .max_current    = 130,
  50        },
  51...
  52        {
  53                .chan_nr        = 8,
  54                .led_current    = 50,
  55                .max_current    = 130,
  56        }
  57};
  58
  59static int lp5523_setup(void)
  60{
  61        /* Setup HW resources */
  62}
  63
  64static void lp5523_release(void)
  65{
  66        /* Release HW resources */
  67}
  68
  69static void lp5523_enable(bool state)
  70{
  71        /* Control chip enable signal */
  72}
  73
  74static struct lp55xx_platform_data lp5523_platform_data = {
  75        .led_config     = lp5523_led_config,
  76        .num_channels   = ARRAY_SIZE(lp5523_led_config),
  77        .clock_mode     = LP55XX_CLOCK_EXT,
  78        .setup_resources   = lp5523_setup,
  79        .release_resources = lp5523_release,
  80        .enable            = lp5523_enable,
  81};
  82
lxr.linux.no kindly hosted by Redpill Linpro AS, provider of Linux consulting and operations services since 1995.