HID: picoLCD: prevent NULL pointer dereferences
[linux-block.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;
fabdbf2f
BP
99#endif /* CONFIG_HID_PICOLCD_FB */
100#ifdef CONFIG_HID_PICOLCD_LCD
101 struct lcd_device *lcd;
102 u8 lcd_contrast;
103#endif /* CONFIG_HID_PICOLCD_LCD */
104#ifdef CONFIG_HID_PICOLCD_BACKLIGHT
105 struct backlight_device *backlight;
106 u8 lcd_brightness;
107 u8 lcd_power;
108#endif /* CONFIG_HID_PICOLCD_BACKLIGHT */
109#ifdef CONFIG_HID_PICOLCD_LEDS
110 /* LED stuff */
111 u8 led_state;
112 struct led_classdev *led[8];
113#endif /* CONFIG_HID_PICOLCD_LEDS */
114
115 /* Housekeeping stuff */
116 spinlock_t lock;
117 struct mutex mutex;
118 struct picolcd_pending *pending;
119 int status;
120#define PICOLCD_BOOTLOADER 1
121#define PICOLCD_FAILED 2
122#define PICOLCD_READY_FB 4
123};
124
125
126/* Find a given report */
127#define picolcd_in_report(id, dev) picolcd_report(id, dev, HID_INPUT_REPORT)
128#define picolcd_out_report(id, dev) picolcd_report(id, dev, HID_OUTPUT_REPORT)
129
130struct hid_report *picolcd_report(int id, struct hid_device *hdev, int dir);
131
132#ifdef CONFIG_DEBUG_FS
133void picolcd_debug_out_report(struct picolcd_data *data,
134 struct hid_device *hdev, struct hid_report *report);
135#define usbhid_submit_report(a, b, c) \
136 do { \
137 picolcd_debug_out_report(hid_get_drvdata(a), a, b); \
138 usbhid_submit_report(a, b, c); \
139 } while (0)
140
141void picolcd_debug_raw_event(struct picolcd_data *data,
142 struct hid_device *hdev, struct hid_report *report,
143 u8 *raw_data, int size);
144
145void picolcd_init_devfs(struct picolcd_data *data,
146 struct hid_report *eeprom_r, struct hid_report *eeprom_w,
147 struct hid_report *flash_r, struct hid_report *flash_w,
148 struct hid_report *reset);
149
150void picolcd_exit_devfs(struct picolcd_data *data);
151#else
152static inline void picolcd_debug_raw_event(struct picolcd_data *data,
153 struct hid_device *hdev, struct hid_report *report,
154 u8 *raw_data, int size)
155{
156}
157static inline void picolcd_init_devfs(struct picolcd_data *data,
158 struct hid_report *eeprom_r, struct hid_report *eeprom_w,
159 struct hid_report *flash_r, struct hid_report *flash_w,
160 struct hid_report *reset)
161{
162}
163static inline void picolcd_exit_devfs(struct picolcd_data *data)
164{
165}
166static inline void picolcd_debug_raw_event(struct picolcd_data *data,
167 struct hid_device *hdev, struct hid_report *report,
168 u8 *raw_data, int size)
169{
170}
171#endif /* CONFIG_DEBUG_FS */
172
173
174#ifdef CONFIG_HID_PICOLCD_FB
175int picolcd_fb_reset(struct picolcd_data *data, int clear);
176
177int picolcd_init_framebuffer(struct picolcd_data *data);
178
179void picolcd_exit_framebuffer(struct picolcd_data *data);
180
fabdbf2f
BP
181void picolcd_fb_refresh(struct picolcd_data *data);
182#define picolcd_fbinfo(d) ((d)->fb_info)
183#else
184static inline int picolcd_fb_reset(struct picolcd_data *data, int clear)
185{
186 return 0;
187}
188static inline int picolcd_init_framebuffer(struct picolcd_data *data)
189{
190 return 0;
191}
192static inline void picolcd_exit_framebuffer(struct picolcd_data *data)
193{
194}
fabdbf2f
BP
195static inline void picolcd_fb_refresh(struct picolcd_data *data)
196{
197}
198#define picolcd_fbinfo(d) NULL
199#endif /* CONFIG_HID_PICOLCD_FB */
200
201
202#ifdef CONFIG_HID_PICOLCD_BACKLIGHT
203int picolcd_init_backlight(struct picolcd_data *data,
204 struct hid_report *report);
205
206void picolcd_exit_backlight(struct picolcd_data *data);
207
208int picolcd_resume_backlight(struct picolcd_data *data);
209
210void picolcd_suspend_backlight(struct picolcd_data *data);
211#else
212static inline int picolcd_init_backlight(struct picolcd_data *data,
213 struct hid_report *report)
214{
215 return 0;
216}
217static inline void picolcd_exit_backlight(struct picolcd_data *data)
218{
219}
220static inline int picolcd_resume_backlight(struct picolcd_data *data)
221{
222 return 0;
223}
224static inline void picolcd_suspend_backlight(struct picolcd_data *data)
225{
226}
227
228#endif /* CONFIG_HID_PICOLCD_BACKLIGHT */
229
230
231#ifdef CONFIG_HID_PICOLCD_LCD
232int picolcd_init_lcd(struct picolcd_data *data,
233 struct hid_report *report);
234
235void picolcd_exit_lcd(struct picolcd_data *data);
236
237int picolcd_resume_lcd(struct picolcd_data *data);
238#else
239static inline int picolcd_init_lcd(struct picolcd_data *data,
240 struct hid_report *report)
241{
242 return 0;
243}
244static inline void picolcd_exit_lcd(struct picolcd_data *data)
245{
246}
247static inline int picolcd_resume_lcd(struct picolcd_data *data)
248{
249 return 0;
250}
251#endif /* CONFIG_HID_PICOLCD_LCD */
252
253
254#ifdef CONFIG_HID_PICOLCD_LEDS
255int picolcd_init_leds(struct picolcd_data *data,
256 struct hid_report *report);
257
258void picolcd_exit_leds(struct picolcd_data *data);
259
260void picolcd_leds_set(struct picolcd_data *data);
261#else
262static inline int picolcd_init_leds(struct picolcd_data *data,
263 struct hid_report *report)
264{
265 return 0;
266}
267static inline void picolcd_exit_leds(struct picolcd_data *data)
268{
269}
270static inline void picolcd_leds_set(struct picolcd_data *data)
271{
272}
273#endif /* CONFIG_HID_PICOLCD_LEDS */
274
275
276#ifdef CONFIG_HID_PICOLCD_CIR
277int picolcd_raw_cir(struct picolcd_data *data,
278 struct hid_report *report, u8 *raw_data, int size);
279
280int picolcd_init_cir(struct picolcd_data *data, struct hid_report *report);
281
282void picolcd_exit_cir(struct picolcd_data *data);
283#else
284static inline int picolcd_raw_cir(struct picolcd_data *data,
285 struct hid_report *report, u8 *raw_data, int size)
286{
287 return 1;
288}
289static inline int picolcd_init_cir(struct picolcd_data *data, struct hid_report *report)
290{
291 return 0;
292}
293static inline void picolcd_exit_cir(struct picolcd_data *data)
294{
295}
296#endif /* CONFIG_HID_PICOLCD_LIRC */
297
298int picolcd_reset(struct hid_device *hdev);
299struct picolcd_pending *picolcd_send_and_wait(struct hid_device *hdev,
300 int report_id, const u8 *raw_data, int size);