blob: c7f1e6155001f6eeb76818f6a4dcf3904624c7e8 [file] [log] [blame]
Milo(Woogyom) Kimc93d08f2013-02-05 18:01:23 +09001/*
2 * LP55XX Common Driver Header
3 *
4 * Copyright (C) 2012 Texas Instruments
5 *
6 * Author: Milo(Woogyom) Kim <milo.kim@ti.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 * Derived from leds-lp5521.c, leds-lp5523.c
13 */
14
15#ifndef _LEDS_LP55XX_COMMON_H
16#define _LEDS_LP55XX_COMMON_H
17
Milo(Woogyom) Kim10c06d12013-02-05 19:17:20 +090018enum lp55xx_engine_index {
19 LP55XX_ENGINE_INVALID,
20 LP55XX_ENGINE_1,
21 LP55XX_ENGINE_2,
22 LP55XX_ENGINE_3,
Milo Kim6841a912013-08-08 12:45:41 +090023 LP55XX_ENGINE_MAX = LP55XX_ENGINE_3,
24};
25
26enum lp55xx_engine_mode {
27 LP55XX_ENGINE_DISABLED,
28 LP55XX_ENGINE_LOAD,
29 LP55XX_ENGINE_RUN,
Milo(Woogyom) Kim10c06d12013-02-05 19:17:20 +090030};
31
Milo Kim36030972013-08-08 12:46:43 +090032#define LP55XX_DEV_ATTR_RW(name, show, store) \
33 DEVICE_ATTR(name, S_IRUGO | S_IWUSR, show, store)
34#define LP55XX_DEV_ATTR_RO(name, show) \
35 DEVICE_ATTR(name, S_IRUGO, show, NULL)
36#define LP55XX_DEV_ATTR_WO(name, store) \
37 DEVICE_ATTR(name, S_IWUSR, NULL, store)
38
39#define show_mode(nr) \
40static ssize_t show_engine##nr##_mode(struct device *dev, \
41 struct device_attribute *attr, \
42 char *buf) \
43{ \
44 return show_engine_mode(dev, attr, buf, nr); \
45}
46
47#define store_mode(nr) \
48static ssize_t store_engine##nr##_mode(struct device *dev, \
49 struct device_attribute *attr, \
50 const char *buf, size_t len) \
51{ \
52 return store_engine_mode(dev, attr, buf, len, nr); \
53}
54
55#define show_leds(nr) \
56static ssize_t show_engine##nr##_leds(struct device *dev, \
57 struct device_attribute *attr, \
58 char *buf) \
59{ \
60 return show_engine_leds(dev, attr, buf, nr); \
61}
62
63#define store_leds(nr) \
64static ssize_t store_engine##nr##_leds(struct device *dev, \
65 struct device_attribute *attr, \
66 const char *buf, size_t len) \
67{ \
68 return store_engine_leds(dev, attr, buf, len, nr); \
69}
70
71#define store_load(nr) \
72static ssize_t store_engine##nr##_load(struct device *dev, \
73 struct device_attribute *attr, \
74 const char *buf, size_t len) \
75{ \
76 return store_engine_load(dev, attr, buf, len, nr); \
77}
78
Milo(Woogyom) Kimc93d08f2013-02-05 18:01:23 +090079struct lp55xx_led;
80struct lp55xx_chip;
81
82/*
Milo(Woogyom) Kim48068d52013-02-05 18:08:49 +090083 * struct lp55xx_reg
84 * @addr : Register address
85 * @val : Register value
86 */
87struct lp55xx_reg {
88 u8 addr;
89 u8 val;
90};
91
92/*
93 * struct lp55xx_device_config
94 * @reset : Chip specific reset command
Milo(Woogyom) Kime3a700d2013-02-05 18:09:56 +090095 * @enable : Chip specific enable command
Milo(Woogyom) Kim0e202342013-02-05 19:07:34 +090096 * @max_channel : Maximum number of channels
Milo(Woogyom) Kimffbdccd2013-02-05 18:57:36 +090097 * @post_init_device : Chip specific initialization code
Milo(Woogyom) Kim9e9b3db2013-02-05 19:06:27 +090098 * @brightness_work_fn : Brightness work function
99 * @set_led_current : LED current set function
Milo(Woogyom) Kim10c06d12013-02-05 19:17:20 +0900100 * @firmware_cb : Call function when the firmware is loaded
101 * @run_engine : Run internal engine for pattern
Milo(Woogyom) Kim240085e2013-02-05 19:20:01 +0900102 * @dev_attr_group : Device specific attributes
Milo(Woogyom) Kim48068d52013-02-05 18:08:49 +0900103 */
104struct lp55xx_device_config {
105 const struct lp55xx_reg reset;
Milo(Woogyom) Kime3a700d2013-02-05 18:09:56 +0900106 const struct lp55xx_reg enable;
Milo(Woogyom) Kim0e202342013-02-05 19:07:34 +0900107 const int max_channel;
Milo(Woogyom) Kimffbdccd2013-02-05 18:57:36 +0900108
109 /* define if the device has specific initialization process */
110 int (*post_init_device) (struct lp55xx_chip *chip);
Milo(Woogyom) Kim9e9b3db2013-02-05 19:06:27 +0900111
112 /* access brightness register */
113 void (*brightness_work_fn)(struct work_struct *work);
114
115 /* current setting function */
116 void (*set_led_current) (struct lp55xx_led *led, u8 led_current);
Milo(Woogyom) Kim10c06d12013-02-05 19:17:20 +0900117
118 /* access program memory when the firmware is loaded */
119 void (*firmware_cb)(struct lp55xx_chip *chip);
120
121 /* used for running firmware LED patterns */
122 void (*run_engine) (struct lp55xx_chip *chip, bool start);
Milo(Woogyom) Kim240085e2013-02-05 19:20:01 +0900123
124 /* additional device specific attributes */
125 const struct attribute_group *dev_attr_group;
Milo(Woogyom) Kim48068d52013-02-05 18:08:49 +0900126};
127
128/*
Milo Kim6841a912013-08-08 12:45:41 +0900129 * struct lp55xx_engine
130 * @mode : Engine mode
131 * @led_mux : Mux bits for LED selection. Only used in LP5523
132 */
133struct lp55xx_engine {
134 enum lp55xx_engine_mode mode;
135 u16 led_mux;
136};
137
138/*
Milo(Woogyom) Kimc93d08f2013-02-05 18:01:23 +0900139 * struct lp55xx_chip
140 * @cl : I2C communication for access registers
141 * @pdata : Platform specific data
142 * @lock : Lock for user-space interface
143 * @num_leds : Number of registered LEDs
Milo(Woogyom) Kim48068d52013-02-05 18:08:49 +0900144 * @cfg : Device specific configuration data
Milo(Woogyom) Kim10c06d12013-02-05 19:17:20 +0900145 * @engine_idx : Selected engine number
Milo Kim6841a912013-08-08 12:45:41 +0900146 * @engines : Engine structure for the device attribute R/W interface
Milo(Woogyom) Kim10c06d12013-02-05 19:17:20 +0900147 * @fw : Firmware data for running a LED pattern
Milo(Woogyom) Kimc93d08f2013-02-05 18:01:23 +0900148 */
149struct lp55xx_chip {
150 struct i2c_client *cl;
Kim, Milo53b41922013-03-20 17:37:00 -0700151 struct clk *clk;
Milo(Woogyom) Kimc93d08f2013-02-05 18:01:23 +0900152 struct lp55xx_platform_data *pdata;
153 struct mutex lock; /* lock for user-space interface */
154 int num_leds;
Milo(Woogyom) Kim48068d52013-02-05 18:08:49 +0900155 struct lp55xx_device_config *cfg;
Milo(Woogyom) Kim10c06d12013-02-05 19:17:20 +0900156 enum lp55xx_engine_index engine_idx;
Milo Kim6841a912013-08-08 12:45:41 +0900157 struct lp55xx_engine engines[LP55XX_ENGINE_MAX];
Milo(Woogyom) Kim10c06d12013-02-05 19:17:20 +0900158 const struct firmware *fw;
Milo(Woogyom) Kimc93d08f2013-02-05 18:01:23 +0900159};
160
161/*
162 * struct lp55xx_led
163 * @chan_nr : Channel number
164 * @cdev : LED class device
165 * @led_current : Current setting at each led channel
166 * @max_current : Maximun current at each led channel
167 * @brightness_work : Workqueue for brightness control
168 * @brightness : Brightness value
169 * @chip : The lp55xx chip data
170 */
171struct lp55xx_led {
172 int chan_nr;
173 struct led_classdev cdev;
174 u8 led_current;
175 u8 max_current;
176 struct work_struct brightness_work;
177 u8 brightness;
178 struct lp55xx_chip *chip;
179};
180
181/* register access */
182extern int lp55xx_write(struct lp55xx_chip *chip, u8 reg, u8 val);
183extern int lp55xx_read(struct lp55xx_chip *chip, u8 reg, u8 *val);
184extern int lp55xx_update_bits(struct lp55xx_chip *chip, u8 reg,
185 u8 mask, u8 val);
186
Kim, Milo53b41922013-03-20 17:37:00 -0700187/* external clock detection */
188extern bool lp55xx_is_extclk_used(struct lp55xx_chip *chip);
189
Milo(Woogyom) Kim6ce61762013-02-05 19:03:02 +0900190/* common device init/deinit functions */
Milo(Woogyom) Kima85908d2013-02-05 18:07:20 +0900191extern int lp55xx_init_device(struct lp55xx_chip *chip);
Milo(Woogyom) Kim6ce61762013-02-05 19:03:02 +0900192extern void lp55xx_deinit_device(struct lp55xx_chip *chip);
Milo(Woogyom) Kima85908d2013-02-05 18:07:20 +0900193
Milo(Woogyom) Kim9e9b3db2013-02-05 19:06:27 +0900194/* common LED class device functions */
195extern int lp55xx_register_leds(struct lp55xx_led *led,
196 struct lp55xx_chip *chip);
Milo(Woogyom) Kimc3a68eb2013-02-05 19:11:18 +0900197extern void lp55xx_unregister_leds(struct lp55xx_led *led,
198 struct lp55xx_chip *chip);
Milo(Woogyom) Kimb3b6f812013-02-05 19:15:27 +0900199
200/* common device attributes functions */
201extern int lp55xx_register_sysfs(struct lp55xx_chip *chip);
Milo(Woogyom) Kimba6fa842013-02-05 19:23:04 +0900202extern void lp55xx_unregister_sysfs(struct lp55xx_chip *chip);
Milo(Woogyom) Kimb3b6f812013-02-05 19:15:27 +0900203
Linus Walleij7542a04b2013-04-23 04:52:59 -0700204/* common device tree population function */
Milo Kimed1333522015-08-24 16:09:55 +0900205extern struct lp55xx_platform_data
206*lp55xx_of_populate_pdata(struct device *dev, struct device_node *np);
Linus Walleij7542a04b2013-04-23 04:52:59 -0700207
Milo(Woogyom) Kimc93d08f2013-02-05 18:01:23 +0900208#endif /* _LEDS_LP55XX_COMMON_H */