]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/hid/hid-picolcd.h
HID: picoLCD: split driver code
[mirror_ubuntu-artful-kernel.git] / drivers / hid / hid-picolcd.h
CommitLineData
fabdbf2f
BP
1/***************************************************************************
2 * Copyright (C) 2010-2012 by Bruno Prémont <bonbons@linux-vserver.org> *
3 * *
4 * Based on Logitech G13 driver (v0.4) *
5 * Copyright (C) 2009 by Rick L. Vinyard, Jr. <rvinyard@cs.nmsu.edu> *
6 * *
7 * This program is free software: you can redistribute it and/or modify *
8 * it under the terms of the GNU General Public License as published by *
9 * the Free Software Foundation, version 2 of the License. *
10 * *
11 * This driver is distributed in the hope that it will be useful, but *
12 * WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14 * General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU General Public License *
17 * along with this software. If not see <http://www.gnu.org/licenses/>. *
18 ***************************************************************************/
19
20#define PICOLCD_NAME "PicoLCD (graphic)"
21
22/* Report numbers */
23#define REPORT_ERROR_CODE 0x10 /* LCD: IN[16] */
24#define ERR_SUCCESS 0x00
25#define ERR_PARAMETER_MISSING 0x01
26#define ERR_DATA_MISSING 0x02
27#define ERR_BLOCK_READ_ONLY 0x03
28#define ERR_BLOCK_NOT_ERASABLE 0x04
29#define ERR_BLOCK_TOO_BIG 0x05
30#define ERR_SECTION_OVERFLOW 0x06
31#define ERR_INVALID_CMD_LEN 0x07
32#define ERR_INVALID_DATA_LEN 0x08
33#define REPORT_KEY_STATE 0x11 /* LCD: IN[2] */
34#define REPORT_IR_DATA 0x21 /* LCD: IN[63] */
35#define REPORT_EE_DATA 0x32 /* LCD: IN[63] */
36#define REPORT_MEMORY 0x41 /* LCD: IN[63] */
37#define REPORT_LED_STATE 0x81 /* LCD: OUT[1] */
38#define REPORT_BRIGHTNESS 0x91 /* LCD: OUT[1] */
39#define REPORT_CONTRAST 0x92 /* LCD: OUT[1] */
40#define REPORT_RESET 0x93 /* LCD: OUT[2] */
41#define REPORT_LCD_CMD 0x94 /* LCD: OUT[63] */
42#define REPORT_LCD_DATA 0x95 /* LCD: OUT[63] */
43#define REPORT_LCD_CMD_DATA 0x96 /* LCD: OUT[63] */
44#define REPORT_EE_READ 0xa3 /* LCD: OUT[63] */
45#define REPORT_EE_WRITE 0xa4 /* LCD: OUT[63] */
46#define REPORT_ERASE_MEMORY 0xb2 /* LCD: OUT[2] */
47#define REPORT_READ_MEMORY 0xb3 /* LCD: OUT[3] */
48#define REPORT_WRITE_MEMORY 0xb4 /* LCD: OUT[63] */
49#define REPORT_SPLASH_RESTART 0xc1 /* LCD: OUT[1] */
50#define REPORT_EXIT_KEYBOARD 0xef /* LCD: OUT[2] */
51#define REPORT_VERSION 0xf1 /* LCD: IN[2],OUT[1] Bootloader: IN[2],OUT[1] */
52#define REPORT_BL_ERASE_MEMORY 0xf2 /* Bootloader: IN[36],OUT[4] */
53#define REPORT_BL_READ_MEMORY 0xf3 /* Bootloader: IN[36],OUT[4] */
54#define REPORT_BL_WRITE_MEMORY 0xf4 /* Bootloader: IN[36],OUT[36] */
55#define REPORT_DEVID 0xf5 /* LCD: IN[5], OUT[1] Bootloader: IN[5],OUT[1] */
56#define REPORT_SPLASH_SIZE 0xf6 /* LCD: IN[4], OUT[1] */
57#define REPORT_HOOK_VERSION 0xf7 /* LCD: IN[2], OUT[1] */
58#define REPORT_EXIT_FLASHER 0xff /* Bootloader: OUT[2] */
59
60/* Description of in-progress IO operation, used for operations
61 * that trigger response from device */
62struct picolcd_pending {
63 struct hid_report *out_report;
64 struct hid_report *in_report;
65 struct completion ready;
66 int raw_size;
67 u8 raw_data[64];
68};
69
70
71#define PICOLCD_KEYS 17
72
73/* Per device data structure */
74struct picolcd_data {
75 struct hid_device *hdev;
76#ifdef CONFIG_DEBUG_FS
77 struct dentry *debug_reset;
78 struct dentry *debug_eeprom;
79 struct dentry *debug_flash;
80 struct mutex mutex_flash;
81 int addr_sz;
82#endif
83 u8 version[2];
84 unsigned short opmode_delay;
85 /* input stuff */
86 u8 pressed_keys[2];
87 struct input_dev *input_keys;
88 struct input_dev *input_cir;
89 unsigned short keycode[PICOLCD_KEYS];
90
91#ifdef CONFIG_HID_PICOLCD_FB
92 /* Framebuffer stuff */
93 u8 fb_update_rate;
94 u8 fb_bpp;
95 u8 fb_force;
96 u8 *fb_vbitmap; /* local copy of what was sent to PicoLCD */
97 u8 *fb_bitmap; /* framebuffer */
98 struct fb_info *fb_info;
99 struct fb_deferred_io fb_defio;
100#endif /* CONFIG_HID_PICOLCD_FB */
101#ifdef CONFIG_HID_PICOLCD_LCD
102 struct lcd_device *lcd;
103 u8 lcd_contrast;
104#endif /* CONFIG_HID_PICOLCD_LCD */
105#ifdef CONFIG_HID_PICOLCD_BACKLIGHT
106 struct backlight_device *backlight;
107 u8 lcd_brightness;
108 u8 lcd_power;
109#endif /* CONFIG_HID_PICOLCD_BACKLIGHT */
110#ifdef CONFIG_HID_PICOLCD_LEDS
111 /* LED stuff */
112 u8 led_state;
113 struct led_classdev *led[8];
114#endif /* CONFIG_HID_PICOLCD_LEDS */
115
116 /* Housekeeping stuff */
117 spinlock_t lock;
118 struct mutex mutex;
119 struct picolcd_pending *pending;
120 int status;
121#define PICOLCD_BOOTLOADER 1
122#define PICOLCD_FAILED 2
123#define PICOLCD_READY_FB 4
124};
125
126
127/* Find a given report */
128#define picolcd_in_report(id, dev) picolcd_report(id, dev, HID_INPUT_REPORT)
129#define picolcd_out_report(id, dev) picolcd_report(id, dev, HID_OUTPUT_REPORT)
130
131struct hid_report *picolcd_report(int id, struct hid_device *hdev, int dir);
132
133#ifdef CONFIG_DEBUG_FS
134void picolcd_debug_out_report(struct picolcd_data *data,
135 struct hid_device *hdev, struct hid_report *report);
136#define usbhid_submit_report(a, b, c) \
137 do { \
138 picolcd_debug_out_report(hid_get_drvdata(a), a, b); \
139 usbhid_submit_report(a, b, c); \
140 } while (0)
141
142void picolcd_debug_raw_event(struct picolcd_data *data,
143 struct hid_device *hdev, struct hid_report *report,
144 u8 *raw_data, int size);
145
146void picolcd_init_devfs(struct picolcd_data *data,
147 struct hid_report *eeprom_r, struct hid_report *eeprom_w,
148 struct hid_report *flash_r, struct hid_report *flash_w,
149 struct hid_report *reset);
150
151void picolcd_exit_devfs(struct picolcd_data *data);
152#else
153static inline void picolcd_debug_raw_event(struct picolcd_data *data,
154 struct hid_device *hdev, struct hid_report *report,
155 u8 *raw_data, int size)
156{
157}
158static inline void picolcd_init_devfs(struct picolcd_data *data,
159 struct hid_report *eeprom_r, struct hid_report *eeprom_w,
160 struct hid_report *flash_r, struct hid_report *flash_w,
161 struct hid_report *reset)
162{
163}
164static inline void picolcd_exit_devfs(struct picolcd_data *data)
165{
166}
167static inline void picolcd_debug_raw_event(struct picolcd_data *data,
168 struct hid_device *hdev, struct hid_report *report,
169 u8 *raw_data, int size)
170{
171}
172#endif /* CONFIG_DEBUG_FS */
173
174
175#ifdef CONFIG_HID_PICOLCD_FB
176int picolcd_fb_reset(struct picolcd_data *data, int clear);
177
178int picolcd_init_framebuffer(struct picolcd_data *data);
179
180void picolcd_exit_framebuffer(struct picolcd_data *data);
181
182void picolcd_fb_unload(void);
183
184void picolcd_fb_refresh(struct picolcd_data *data);
185#define picolcd_fbinfo(d) ((d)->fb_info)
186#else
187static inline int picolcd_fb_reset(struct picolcd_data *data, int clear)
188{
189 return 0;
190}
191static inline int picolcd_init_framebuffer(struct picolcd_data *data)
192{
193 return 0;
194}
195static inline void picolcd_exit_framebuffer(struct picolcd_data *data)
196{
197}
198static inline void picolcd_fb_unload(void)
199{
200}
201static inline void picolcd_fb_refresh(struct picolcd_data *data)
202{
203}
204#define picolcd_fbinfo(d) NULL
205#endif /* CONFIG_HID_PICOLCD_FB */
206
207
208#ifdef CONFIG_HID_PICOLCD_BACKLIGHT
209int picolcd_init_backlight(struct picolcd_data *data,
210 struct hid_report *report);
211
212void picolcd_exit_backlight(struct picolcd_data *data);
213
214int picolcd_resume_backlight(struct picolcd_data *data);
215
216void picolcd_suspend_backlight(struct picolcd_data *data);
217#else
218static inline int picolcd_init_backlight(struct picolcd_data *data,
219 struct hid_report *report)
220{
221 return 0;
222}
223static inline void picolcd_exit_backlight(struct picolcd_data *data)
224{
225}
226static inline int picolcd_resume_backlight(struct picolcd_data *data)
227{
228 return 0;
229}
230static inline void picolcd_suspend_backlight(struct picolcd_data *data)
231{
232}
233
234#endif /* CONFIG_HID_PICOLCD_BACKLIGHT */
235
236
237#ifdef CONFIG_HID_PICOLCD_LCD
238int picolcd_init_lcd(struct picolcd_data *data,
239 struct hid_report *report);
240
241void picolcd_exit_lcd(struct picolcd_data *data);
242
243int picolcd_resume_lcd(struct picolcd_data *data);
244#else
245static inline int picolcd_init_lcd(struct picolcd_data *data,
246 struct hid_report *report)
247{
248 return 0;
249}
250static inline void picolcd_exit_lcd(struct picolcd_data *data)
251{
252}
253static inline int picolcd_resume_lcd(struct picolcd_data *data)
254{
255 return 0;
256}
257#endif /* CONFIG_HID_PICOLCD_LCD */
258
259
260#ifdef CONFIG_HID_PICOLCD_LEDS
261int picolcd_init_leds(struct picolcd_data *data,
262 struct hid_report *report);
263
264void picolcd_exit_leds(struct picolcd_data *data);
265
266void picolcd_leds_set(struct picolcd_data *data);
267#else
268static inline int picolcd_init_leds(struct picolcd_data *data,
269 struct hid_report *report)
270{
271 return 0;
272}
273static inline void picolcd_exit_leds(struct picolcd_data *data)
274{
275}
276static inline void picolcd_leds_set(struct picolcd_data *data)
277{
278}
279#endif /* CONFIG_HID_PICOLCD_LEDS */
280
281
282#ifdef CONFIG_HID_PICOLCD_CIR
283int picolcd_raw_cir(struct picolcd_data *data,
284 struct hid_report *report, u8 *raw_data, int size);
285
286int picolcd_init_cir(struct picolcd_data *data, struct hid_report *report);
287
288void picolcd_exit_cir(struct picolcd_data *data);
289#else
290static inline int picolcd_raw_cir(struct picolcd_data *data,
291 struct hid_report *report, u8 *raw_data, int size)
292{
293 return 1;
294}
295static inline int picolcd_init_cir(struct picolcd_data *data, struct hid_report *report)
296{
297 return 0;
298}
299static inline void picolcd_exit_cir(struct picolcd_data *data)
300{
301}
302#endif /* CONFIG_HID_PICOLCD_LIRC */
303
304int picolcd_reset(struct hid_device *hdev);
305struct picolcd_pending *picolcd_send_and_wait(struct hid_device *hdev,
306 int report_id, const u8 *raw_data, int size);