2 * LP55XX Common Driver Header
4 * Copyright (C) 2012 Texas Instruments
6 * Author: Milo(Woogyom) Kim <milo.kim@ti.com>
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.
12 * Derived from leds-lp5521.c, leds-lp5523.c
15 #ifndef _LEDS_LP55XX_COMMON_H
16 #define _LEDS_LP55XX_COMMON_H
18 enum lp55xx_engine_index {
19 LP55XX_ENGINE_INVALID,
30 * @addr : Register address
31 * @val : Register value
39 * struct lp55xx_device_config
40 * @reset : Chip specific reset command
41 * @enable : Chip specific enable command
42 * @max_channel : Maximum number of channels
43 * @post_init_device : Chip specific initialization code
44 * @brightness_work_fn : Brightness work function
45 * @set_led_current : LED current set function
46 * @firmware_cb : Call function when the firmware is loaded
47 * @run_engine : Run internal engine for pattern
49 struct lp55xx_device_config {
50 const struct lp55xx_reg reset;
51 const struct lp55xx_reg enable;
52 const int max_channel;
54 /* define if the device has specific initialization process */
55 int (*post_init_device) (struct lp55xx_chip *chip);
57 /* access brightness register */
58 void (*brightness_work_fn)(struct work_struct *work);
60 /* current setting function */
61 void (*set_led_current) (struct lp55xx_led *led, u8 led_current);
63 /* access program memory when the firmware is loaded */
64 void (*firmware_cb)(struct lp55xx_chip *chip);
66 /* used for running firmware LED patterns */
67 void (*run_engine) (struct lp55xx_chip *chip, bool start);
72 * @cl : I2C communication for access registers
73 * @pdata : Platform specific data
74 * @lock : Lock for user-space interface
75 * @num_leds : Number of registered LEDs
76 * @cfg : Device specific configuration data
77 * @engine_idx : Selected engine number
78 * @fw : Firmware data for running a LED pattern
81 struct i2c_client *cl;
82 struct lp55xx_platform_data *pdata;
83 struct mutex lock; /* lock for user-space interface */
85 struct lp55xx_device_config *cfg;
86 enum lp55xx_engine_index engine_idx;
87 const struct firmware *fw;
92 * @chan_nr : Channel number
93 * @cdev : LED class device
94 * @led_current : Current setting at each led channel
95 * @max_current : Maximun current at each led channel
96 * @brightness_work : Workqueue for brightness control
97 * @brightness : Brightness value
98 * @chip : The lp55xx chip data
102 struct led_classdev cdev;
105 struct work_struct brightness_work;
107 struct lp55xx_chip *chip;
110 /* register access */
111 extern int lp55xx_write(struct lp55xx_chip *chip, u8 reg, u8 val);
112 extern int lp55xx_read(struct lp55xx_chip *chip, u8 reg, u8 *val);
113 extern int lp55xx_update_bits(struct lp55xx_chip *chip, u8 reg,
116 /* common device init/deinit functions */
117 extern int lp55xx_init_device(struct lp55xx_chip *chip);
118 extern void lp55xx_deinit_device(struct lp55xx_chip *chip);
120 /* common LED class device functions */
121 extern int lp55xx_register_leds(struct lp55xx_led *led,
122 struct lp55xx_chip *chip);
123 extern void lp55xx_unregister_leds(struct lp55xx_led *led,
124 struct lp55xx_chip *chip);
126 /* common device attributes functions */
127 extern int lp55xx_register_sysfs(struct lp55xx_chip *chip);
129 #endif /* _LEDS_LP55XX_COMMON_H */