HID: add framebuffer support to PicoLCD device
[safe/jmp/linux-2.6] / drivers / hid / hid-picolcd.c
1 /***************************************************************************
2  *   Copyright (C) 2010 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 #include <linux/hid.h>
21 #include <linux/hid-debug.h>
22 #include <linux/input.h>
23 #include "hid-ids.h"
24 #include "usbhid/usbhid.h"
25 #include <linux/usb.h>
26
27 #include <linux/fb.h>
28 #include <linux/vmalloc.h>
29
30 #include <linux/seq_file.h>
31 #include <linux/debugfs.h>
32
33 #include <linux/completion.h>
34
35 #define PICOLCD_NAME "PicoLCD (graphic)"
36
37 /* Report numbers */
38 #define REPORT_ERROR_CODE      0x10 /* LCD: IN[16]  */
39 #define   ERR_SUCCESS            0x00
40 #define   ERR_PARAMETER_MISSING  0x01
41 #define   ERR_DATA_MISSING       0x02
42 #define   ERR_BLOCK_READ_ONLY    0x03
43 #define   ERR_BLOCK_NOT_ERASABLE 0x04
44 #define   ERR_BLOCK_TOO_BIG      0x05
45 #define   ERR_SECTION_OVERFLOW   0x06
46 #define   ERR_INVALID_CMD_LEN    0x07
47 #define   ERR_INVALID_DATA_LEN   0x08
48 #define REPORT_KEY_STATE       0x11 /* LCD: IN[2]   */
49 #define REPORT_IR_DATA         0x21 /* LCD: IN[63]  */
50 #define REPORT_EE_DATA         0x32 /* LCD: IN[63]  */
51 #define REPORT_MEMORY          0x41 /* LCD: IN[63]  */
52 #define REPORT_LED_STATE       0x81 /* LCD: OUT[1]  */
53 #define REPORT_BRIGHTNESS      0x91 /* LCD: OUT[1]  */
54 #define REPORT_CONTRAST        0x92 /* LCD: OUT[1]  */
55 #define REPORT_RESET           0x93 /* LCD: OUT[2]  */
56 #define REPORT_LCD_CMD         0x94 /* LCD: OUT[63] */
57 #define REPORT_LCD_DATA        0x95 /* LCD: OUT[63] */
58 #define REPORT_LCD_CMD_DATA    0x96 /* LCD: OUT[63] */
59 #define REPORT_EE_READ         0xa3 /* LCD: OUT[63] */
60 #define REPORT_EE_WRITE        0xa4 /* LCD: OUT[63] */
61 #define REPORT_ERASE_MEMORY    0xb2 /* LCD: OUT[2]  */
62 #define REPORT_READ_MEMORY     0xb3 /* LCD: OUT[3]  */
63 #define REPORT_WRITE_MEMORY    0xb4 /* LCD: OUT[63] */
64 #define REPORT_SPLASH_RESTART  0xc1 /* LCD: OUT[1]  */
65 #define REPORT_EXIT_KEYBOARD   0xef /* LCD: OUT[2]  */
66 #define REPORT_VERSION         0xf1 /* LCD: IN[2],OUT[1]    Bootloader: IN[2],OUT[1]   */
67 #define REPORT_BL_ERASE_MEMORY 0xf2 /*                      Bootloader: IN[36],OUT[4]  */
68 #define REPORT_BL_READ_MEMORY  0xf3 /*                      Bootloader: IN[36],OUT[4]  */
69 #define REPORT_BL_WRITE_MEMORY 0xf4 /*                      Bootloader: IN[36],OUT[36] */
70 #define REPORT_DEVID           0xf5 /* LCD: IN[5], OUT[1]   Bootloader: IN[5],OUT[1]   */
71 #define REPORT_SPLASH_SIZE     0xf6 /* LCD: IN[4], OUT[1]   */
72 #define REPORT_HOOK_VERSION    0xf7 /* LCD: IN[2], OUT[1]   */
73 #define REPORT_EXIT_FLASHER    0xff /*                      Bootloader: OUT[2]         */
74
75 #if defined(CONFIG_FB) || defined(CONFIG_FB_MODULE)
76 /* Framebuffer
77  *
78  * The PicoLCD use a Topway LCD module of 256x64 pixel
79  * This display area is tiled over 4 controllers with 8 tiles
80  * each. Each tile has 8x64 pixel, each data byte representing
81  * a 1-bit wide vertical line of the tile.
82  *
83  * The display can be updated at a tile granularity.
84  *
85  *       Chip 1           Chip 2           Chip 3           Chip 4
86  * +----------------+----------------+----------------+----------------+
87  * |     Tile 1     |     Tile 1     |     Tile 1     |     Tile 1     |
88  * +----------------+----------------+----------------+----------------+
89  * |     Tile 2     |     Tile 2     |     Tile 2     |     Tile 2     |
90  * +----------------+----------------+----------------+----------------+
91  *                                  ...
92  * +----------------+----------------+----------------+----------------+
93  * |     Tile 8     |     Tile 8     |     Tile 8     |     Tile 8     |
94  * +----------------+----------------+----------------+----------------+
95  */
96 #define PICOLCDFB_NAME "picolcdfb"
97 #define PICOLCDFB_WIDTH (256)
98 #define PICOLCDFB_HEIGHT (64)
99 #define PICOLCDFB_SIZE (PICOLCDFB_WIDTH * PICOLCDFB_HEIGHT / 8)
100
101 #define PICOLCDFB_UPDATE_RATE_LIMIT   10
102 #define PICOLCDFB_UPDATE_RATE_DEFAULT  2
103
104 /* Framebuffer visual structures */
105 static const struct fb_fix_screeninfo picolcdfb_fix = {
106         .id          = PICOLCDFB_NAME,
107         .type        = FB_TYPE_PACKED_PIXELS,
108         .visual      = FB_VISUAL_MONO01,
109         .xpanstep    = 0,
110         .ypanstep    = 0,
111         .ywrapstep   = 0,
112         .line_length = PICOLCDFB_WIDTH / 8,
113         .accel       = FB_ACCEL_NONE,
114 };
115
116 static const struct fb_var_screeninfo picolcdfb_var = {
117         .xres           = PICOLCDFB_WIDTH,
118         .yres           = PICOLCDFB_HEIGHT,
119         .xres_virtual   = PICOLCDFB_WIDTH,
120         .yres_virtual   = PICOLCDFB_HEIGHT,
121         .width          = 103,
122         .height         = 26,
123         .bits_per_pixel = 1,
124         .grayscale      = 1,
125 };
126 #endif /* CONFIG_FB */
127
128 /* Input device
129  *
130  * The PicoLCD has an IR receiver header, a built-in keypad with 5 keys
131  * and header for 4x4 key matrix. The built-in keys are part of the matrix.
132  */
133 static const unsigned short def_keymap[] = {
134         KEY_RESERVED,   /* none */
135         KEY_BACK,       /* col 4 + row 1 */
136         KEY_HOMEPAGE,   /* col 3 + row 1 */
137         KEY_RESERVED,   /* col 2 + row 1 */
138         KEY_RESERVED,   /* col 1 + row 1 */
139         KEY_SCROLLUP,   /* col 4 + row 2 */
140         KEY_OK,         /* col 3 + row 2 */
141         KEY_SCROLLDOWN, /* col 2 + row 2 */
142         KEY_RESERVED,   /* col 1 + row 2 */
143         KEY_RESERVED,   /* col 4 + row 3 */
144         KEY_RESERVED,   /* col 3 + row 3 */
145         KEY_RESERVED,   /* col 2 + row 3 */
146         KEY_RESERVED,   /* col 1 + row 3 */
147         KEY_RESERVED,   /* col 4 + row 4 */
148         KEY_RESERVED,   /* col 3 + row 4 */
149         KEY_RESERVED,   /* col 2 + row 4 */
150         KEY_RESERVED,   /* col 1 + row 4 */
151 };
152 #define PICOLCD_KEYS ARRAY_SIZE(def_keymap)
153
154 /* Description of in-progress IO operation, used for operations
155  * that trigger response from device */
156 struct picolcd_pending {
157         struct hid_report *out_report;
158         struct hid_report *in_report;
159         struct completion ready;
160         int raw_size;
161         u8 raw_data[64];
162 };
163
164 /* Per device data structure */
165 struct picolcd_data {
166         struct hid_device *hdev;
167 #ifdef CONFIG_DEBUG_FS
168         int addr_sz;
169 #endif
170         u8 version[2];
171         /* input stuff */
172         u8 pressed_keys[2];
173         struct input_dev *input_keys;
174         struct input_dev *input_cir;
175         unsigned short keycode[PICOLCD_KEYS];
176
177 #if defined(CONFIG_FB) || defined(CONFIG_FB_MODULE)
178         /* Framebuffer stuff */
179         u8 fb_update_rate;
180         u8 fb_bpp;
181         u8 *fb_vbitmap;         /* local copy of what was sent to PicoLCD */
182         u8 *fb_bitmap;          /* framebuffer */
183         struct fb_info *fb_info;
184         struct fb_deferred_io fb_defio;
185 #endif /* CONFIG_FB */
186
187         /* Housekeeping stuff */
188         spinlock_t lock;
189         struct mutex mutex;
190         struct picolcd_pending *pending;
191         int status;
192 #define PICOLCD_BOOTLOADER 1
193 #define PICOLCD_FAILED 2
194 #define PICOLCD_READY_FB 4
195 };
196
197
198 /* Find a given report */
199 #define picolcd_in_report(id, dev) picolcd_report(id, dev, HID_INPUT_REPORT)
200 #define picolcd_out_report(id, dev) picolcd_report(id, dev, HID_OUTPUT_REPORT)
201
202 static struct hid_report *picolcd_report(int id, struct hid_device *hdev, int dir)
203 {
204         struct list_head *feature_report_list = &hdev->report_enum[dir].report_list;
205         struct hid_report *report = NULL;
206
207         list_for_each_entry(report, feature_report_list, list) {
208                 if (report->id == id)
209                         return report;
210         }
211         dev_warn(&hdev->dev, "No report with id 0x%x found\n", id);
212         return NULL;
213 }
214
215 #ifdef CONFIG_DEBUG_FS
216 static void picolcd_debug_out_report(struct picolcd_data *data,
217                 struct hid_device *hdev, struct hid_report *report);
218 #define usbhid_submit_report(a, b, c) \
219         do { \
220                 picolcd_debug_out_report(hid_get_drvdata(a), a, b); \
221                 usbhid_submit_report(a, b, c); \
222         } while (0)
223 #endif
224
225 /* Submit a report and wait for a reply from device - if device fades away
226  * or does not respond in time, return NULL */
227 static struct picolcd_pending *picolcd_send_and_wait(struct hid_device *hdev,
228                 int report_id, const u8 *raw_data, int size)
229 {
230         struct picolcd_data *data = hid_get_drvdata(hdev);
231         struct picolcd_pending *work;
232         struct hid_report *report = picolcd_out_report(report_id, hdev);
233         unsigned long flags;
234         int i, j, k;
235
236         if (!report || !data)
237                 return NULL;
238         if (data->status & PICOLCD_FAILED)
239                 return NULL;
240         work = kzalloc(sizeof(*work), GFP_KERNEL);
241         if (!work)
242                 return NULL;
243
244         init_completion(&work->ready);
245         work->out_report = report;
246         work->in_report  = NULL;
247         work->raw_size   = 0;
248
249         mutex_lock(&data->mutex);
250         spin_lock_irqsave(&data->lock, flags);
251         for (i = k = 0; i < report->maxfield; i++)
252                 for (j = 0; j < report->field[i]->report_count; j++) {
253                         hid_set_field(report->field[i], j, k < size ? raw_data[k] : 0);
254                         k++;
255                 }
256         data->pending = work;
257         usbhid_submit_report(data->hdev, report, USB_DIR_OUT);
258         spin_unlock_irqrestore(&data->lock, flags);
259         wait_for_completion_interruptible_timeout(&work->ready, HZ*2);
260         spin_lock_irqsave(&data->lock, flags);
261         data->pending = NULL;
262         spin_unlock_irqrestore(&data->lock, flags);
263         mutex_unlock(&data->mutex);
264         return work;
265 }
266
267 #if defined(CONFIG_FB) || defined(CONFIG_FB_MODULE)
268 /* Send a given tile to PicoLCD */
269 static int picolcd_fb_send_tile(struct hid_device *hdev, int chip, int tile)
270 {
271         struct picolcd_data *data = hid_get_drvdata(hdev);
272         struct hid_report *report1 = picolcd_out_report(REPORT_LCD_CMD_DATA, hdev);
273         struct hid_report *report2 = picolcd_out_report(REPORT_LCD_DATA, hdev);
274         unsigned long flags;
275         u8 *tdata;
276         int i;
277
278         if (!report1 || report1->maxfield != 1 || !report2 || report2->maxfield != 1)
279                 return -ENODEV;
280
281         spin_lock_irqsave(&data->lock, flags);
282         hid_set_field(report1->field[0],  0, chip << 2);
283         hid_set_field(report1->field[0],  1, 0x02);
284         hid_set_field(report1->field[0],  2, 0x00);
285         hid_set_field(report1->field[0],  3, 0x00);
286         hid_set_field(report1->field[0],  4, 0xb8 | tile);
287         hid_set_field(report1->field[0],  5, 0x00);
288         hid_set_field(report1->field[0],  6, 0x00);
289         hid_set_field(report1->field[0],  7, 0x40);
290         hid_set_field(report1->field[0],  8, 0x00);
291         hid_set_field(report1->field[0],  9, 0x00);
292         hid_set_field(report1->field[0], 10,   32);
293
294         hid_set_field(report2->field[0],  0, (chip << 2) | 0x01);
295         hid_set_field(report2->field[0],  1, 0x00);
296         hid_set_field(report2->field[0],  2, 0x00);
297         hid_set_field(report2->field[0],  3,   32);
298
299         tdata = data->fb_vbitmap + (tile * 4 + chip) * 64;
300         for (i = 0; i < 64; i++)
301                 if (i < 32)
302                         hid_set_field(report1->field[0], 11 + i, tdata[i]);
303                 else
304                         hid_set_field(report2->field[0], 4 + i - 32, tdata[i]);
305
306         usbhid_submit_report(data->hdev, report1, USB_DIR_OUT);
307         usbhid_submit_report(data->hdev, report2, USB_DIR_OUT);
308         spin_unlock_irqrestore(&data->lock, flags);
309         return 0;
310 }
311
312 /* Translate a single tile*/
313 static int picolcd_fb_update_tile(u8 *vbitmap, const u8 *bitmap, int bpp,
314                 int chip, int tile)
315 {
316         int i, b, changed = 0;
317         u8 tdata[64];
318         u8 *vdata = vbitmap + (tile * 4 + chip) * 64;
319
320         if (bpp == 1) {
321                 for (b = 7; b >= 0; b--) {
322                         const u8 *bdata = bitmap + tile * 256 + chip * 8 + b * 32;
323                         for (i = 0; i < 64; i++) {
324                                 tdata[i] <<= 1;
325                                 tdata[i] |= (bdata[i/8] >> (7 - i % 8)) & 0x01;
326                         }
327                 }
328         } else if (bpp == 8) {
329                 for (b = 7; b >= 0; b--) {
330                         const u8 *bdata = bitmap + (tile * 256 + chip * 8 + b * 32) * 8;
331                         for (i = 0; i < 64; i++) {
332                                 tdata[i] <<= 1;
333                                 tdata[i] |= (bdata[i] & 0x80) ? 0x01 : 0x00;
334                         }
335                 }
336         } else {
337                 /* Oops, we should never get here! */
338                 WARN_ON(1);
339                 return 0;
340         }
341
342         for (i = 0; i < 64; i++)
343                 if (tdata[i] != vdata[i]) {
344                         changed = 1;
345                         vdata[i] = tdata[i];
346                 }
347         return changed;
348 }
349
350 /* Reconfigure LCD display */
351 static int picolcd_fb_reset(struct picolcd_data *data, int clear)
352 {
353         struct hid_report *report = picolcd_out_report(REPORT_LCD_CMD, data->hdev);
354         int i, j;
355         unsigned long flags;
356         static const u8 mapcmd[8] = { 0x00, 0x02, 0x00, 0x64, 0x3f, 0x00, 0x64, 0xc0 };
357
358         if (!report || report->maxfield != 1)
359                 return -ENODEV;
360
361         spin_lock_irqsave(&data->lock, flags);
362         for (i = 0; i < 4; i++) {
363                 for (j = 0; j < report->field[0]->maxusage; j++)
364                         if (j == 0)
365                                 hid_set_field(report->field[0], j, i << 2);
366                         else if (j < sizeof(mapcmd))
367                                 hid_set_field(report->field[0], j, mapcmd[j]);
368                         else
369                                 hid_set_field(report->field[0], j, 0);
370                 usbhid_submit_report(data->hdev, report, USB_DIR_OUT);
371         }
372
373         data->status |= PICOLCD_READY_FB;
374         spin_unlock_irqrestore(&data->lock, flags);
375
376         if (data->fb_bitmap) {
377                 if (clear) {
378                         memset(data->fb_vbitmap, 0xff, PICOLCDFB_SIZE);
379                         memset(data->fb_bitmap, 0, PICOLCDFB_SIZE*data->fb_bpp);
380                 } else {
381                         /* invert 1 byte in each tile to force resend */
382                         for (i = 0; i < PICOLCDFB_SIZE; i += 64)
383                                 data->fb_vbitmap[i] = ~data->fb_vbitmap[i];
384                 }
385         }
386
387         /* schedule first output of framebuffer */
388         if (data->fb_info)
389                 schedule_delayed_work(&data->fb_info->deferred_work, 0);
390
391         return 0;
392 }
393
394 /* Update fb_vbitmap from the screen_base and send changed tiles to device */
395 static void picolcd_fb_update(struct picolcd_data *data)
396 {
397         int chip, tile, n;
398         unsigned long flags;
399
400         spin_lock_irqsave(&data->lock, flags);
401         if (!(data->status & PICOLCD_READY_FB)) {
402                 spin_unlock_irqrestore(&data->lock, flags);
403                 picolcd_fb_reset(data, 0);
404         } else {
405                 spin_unlock_irqrestore(&data->lock, flags);
406         }
407
408         /*
409          * Translate the framebuffer into the format needed by the PicoLCD.
410          * See display layout above.
411          * Do this one tile after the other and push those tiles that changed.
412          *
413          * Wait for our IO to complete as otherwise we might flood the queue!
414          */
415         n = 0;
416         for (chip = 0; chip < 4; chip++)
417                 for (tile = 0; tile < 8; tile++)
418                         if (picolcd_fb_update_tile(data->fb_vbitmap,
419                                         data->fb_bitmap, data->fb_bpp, chip, tile)) {
420                                 n += 2;
421                                 if (n >= HID_OUTPUT_FIFO_SIZE / 2) {
422                                         usbhid_wait_io(data->hdev);
423                                         n = 0;
424                                 }
425                                 picolcd_fb_send_tile(data->hdev, chip, tile);
426                         }
427         if (n)
428                 usbhid_wait_io(data->hdev);
429 }
430
431 /* Stub to call the system default and update the image on the picoLCD */
432 static void picolcd_fb_fillrect(struct fb_info *info,
433                 const struct fb_fillrect *rect)
434 {
435         if (!info->par)
436                 return;
437         sys_fillrect(info, rect);
438
439         schedule_delayed_work(&info->deferred_work, 0);
440 }
441
442 /* Stub to call the system default and update the image on the picoLCD */
443 static void picolcd_fb_copyarea(struct fb_info *info,
444                 const struct fb_copyarea *area)
445 {
446         if (!info->par)
447                 return;
448         sys_copyarea(info, area);
449
450         schedule_delayed_work(&info->deferred_work, 0);
451 }
452
453 /* Stub to call the system default and update the image on the picoLCD */
454 static void picolcd_fb_imageblit(struct fb_info *info, const struct fb_image *image)
455 {
456         if (!info->par)
457                 return;
458         sys_imageblit(info, image);
459
460         schedule_delayed_work(&info->deferred_work, 0);
461 }
462
463 /*
464  * this is the slow path from userspace. they can seek and write to
465  * the fb. it's inefficient to do anything less than a full screen draw
466  */
467 static ssize_t picolcd_fb_write(struct fb_info *info, const char __user *buf,
468                 size_t count, loff_t *ppos)
469 {
470         ssize_t ret;
471         if (!info->par)
472                 return -ENODEV;
473         ret = fb_sys_write(info, buf, count, ppos);
474         if (ret >= 0)
475                 schedule_delayed_work(&info->deferred_work, 0);
476         return ret;
477 }
478
479 static int picolcd_fb_blank(int blank, struct fb_info *info)
480 {
481         if (!info->par)
482                 return -ENODEV;
483         /* We let fb notification do this for us via lcd/backlight device */
484         return 0;
485 }
486
487 static void picolcd_fb_destroy(struct fb_info *info)
488 {
489         struct picolcd_data *data = info->par;
490         info->par = NULL;
491         if (data)
492                 data->fb_info = NULL;
493         fb_deferred_io_cleanup(info);
494         framebuffer_release(info);
495 }
496
497 static int picolcd_fb_check_var(struct fb_var_screeninfo *var, struct fb_info *info)
498 {
499         __u32 bpp      = var->bits_per_pixel;
500         __u32 activate = var->activate;
501
502         /* only allow 1/8 bit depth (8-bit is grayscale) */
503         *var = picolcdfb_var;
504         var->activate = activate;
505         if (bpp >= 8)
506                 var->bits_per_pixel = 8;
507         else
508                 var->bits_per_pixel = 1;
509         return 0;
510 }
511
512 static int picolcd_set_par(struct fb_info *info)
513 {
514         struct picolcd_data *data = info->par;
515         u8 *o_fb, *n_fb;
516         if (info->var.bits_per_pixel == data->fb_bpp)
517                 return 0;
518         /* switch between 1/8 bit depths */
519         if (info->var.bits_per_pixel != 1 && info->var.bits_per_pixel != 8)
520                 return -EINVAL;
521
522         o_fb = data->fb_bitmap;
523         n_fb = vmalloc(PICOLCDFB_SIZE*info->var.bits_per_pixel);
524         if (!n_fb)
525                 return -ENOMEM;
526
527         fb_deferred_io_cleanup(info);
528         /* translate FB content to new bits-per-pixel */
529         if (info->var.bits_per_pixel == 1) {
530                 int i, b;
531                 for (i = 0; i < PICOLCDFB_SIZE; i++) {
532                         u8 p = 0;
533                         for (b = 0; b < 8; b++) {
534                                 p <<= 1;
535                                 p |= o_fb[i*8+b] ? 0x01 : 0x00;
536                         }
537                 }
538                 info->fix.visual = FB_VISUAL_MONO01;
539                 info->fix.line_length = PICOLCDFB_WIDTH / 8;
540         } else {
541                 int i;
542                 for (i = 0; i < PICOLCDFB_SIZE * 8; i++)
543                         n_fb[i] = o_fb[i/8] & (0x01 << (7 - i % 8)) ? 0xff : 0x00;
544                 info->fix.visual = FB_VISUAL_TRUECOLOR;
545                 info->fix.line_length = PICOLCDFB_WIDTH;
546         }
547
548         data->fb_bitmap   = n_fb;
549         data->fb_bpp      = info->var.bits_per_pixel;
550         info->screen_base = (char __force __iomem *)n_fb;
551         info->fix.smem_start = (unsigned long)n_fb;
552         info->fix.smem_len   = PICOLCDFB_SIZE*data->fb_bpp;
553         fb_deferred_io_init(info);
554         vfree(o_fb);
555         return 0;
556 }
557
558 /* Note this can't be const because of struct fb_info definition */
559 static struct fb_ops picolcdfb_ops = {
560         .owner        = THIS_MODULE,
561         .fb_destroy   = picolcd_fb_destroy,
562         .fb_read      = fb_sys_read,
563         .fb_write     = picolcd_fb_write,
564         .fb_blank     = picolcd_fb_blank,
565         .fb_fillrect  = picolcd_fb_fillrect,
566         .fb_copyarea  = picolcd_fb_copyarea,
567         .fb_imageblit = picolcd_fb_imageblit,
568         .fb_check_var = picolcd_fb_check_var,
569         .fb_set_par   = picolcd_set_par,
570 };
571
572
573 /* Callback from deferred IO workqueue */
574 static void picolcd_fb_deferred_io(struct fb_info *info, struct list_head *pagelist)
575 {
576         picolcd_fb_update(info->par);
577 }
578
579 static const struct fb_deferred_io picolcd_fb_defio = {
580         .delay = HZ / PICOLCDFB_UPDATE_RATE_DEFAULT,
581         .deferred_io = picolcd_fb_deferred_io,
582 };
583
584
585 /*
586  * The "fb_update_rate" sysfs attribute
587  */
588 static ssize_t picolcd_fb_update_rate_show(struct device *dev,
589                 struct device_attribute *attr, char *buf)
590 {
591         struct picolcd_data *data = dev_get_drvdata(dev);
592         unsigned i, fb_update_rate = data->fb_update_rate;
593         size_t ret = 0;
594
595         for (i = 1; i <= PICOLCDFB_UPDATE_RATE_LIMIT; i++)
596                 if (ret >= PAGE_SIZE)
597                         break;
598                 else if (i == fb_update_rate)
599                         ret += snprintf(buf+ret, PAGE_SIZE-ret, "[%u] ", i);
600                 else
601                         ret += snprintf(buf+ret, PAGE_SIZE-ret, "%u ", i);
602         if (ret > 0)
603                 buf[min(ret, (size_t)PAGE_SIZE)-1] = '\n';
604         return ret;
605 }
606
607 static ssize_t picolcd_fb_update_rate_store(struct device *dev,
608                 struct device_attribute *attr, const char *buf, size_t count)
609 {
610         struct picolcd_data *data = dev_get_drvdata(dev);
611         int i;
612         unsigned u;
613
614         if (count < 1 || count > 10)
615                 return -EINVAL;
616
617         i = sscanf(buf, "%u", &u);
618         if (i != 1)
619                 return -EINVAL;
620
621         if (u > PICOLCDFB_UPDATE_RATE_LIMIT)
622                 return -ERANGE;
623         else if (u == 0)
624                 u = PICOLCDFB_UPDATE_RATE_DEFAULT;
625
626         data->fb_update_rate = u;
627         data->fb_defio.delay = HZ / data->fb_update_rate;
628         return count;
629 }
630
631 static DEVICE_ATTR(fb_update_rate, 0666, picolcd_fb_update_rate_show,
632                 picolcd_fb_update_rate_store);
633
634 /* initialize Framebuffer device */
635 static int picolcd_init_framebuffer(struct picolcd_data *data)
636 {
637         struct device *dev = &data->hdev->dev;
638         struct fb_info *info = NULL;
639         int error = -ENOMEM;
640         u8 *fb_vbitmap = NULL;
641         u8 *fb_bitmap  = NULL;
642
643         fb_bitmap = vmalloc(PICOLCDFB_SIZE*picolcdfb_var.bits_per_pixel);
644         if (fb_bitmap == NULL) {
645                 dev_err(dev, "can't get a free page for framebuffer\n");
646                 goto err_nomem;
647         }
648
649         fb_vbitmap = kmalloc(PICOLCDFB_SIZE, GFP_KERNEL);
650         if (fb_vbitmap == NULL) {
651                 dev_err(dev, "can't alloc vbitmap image buffer\n");
652                 goto err_nomem;
653         }
654
655         data->fb_update_rate = PICOLCDFB_UPDATE_RATE_DEFAULT;
656         data->fb_defio = picolcd_fb_defio;
657         info = framebuffer_alloc(0, dev);
658         if (info == NULL) {
659                 dev_err(dev, "failed to allocate a framebuffer\n");
660                 goto err_nomem;
661         }
662
663         info->fbdefio = &data->fb_defio;
664         info->screen_base = (char __force __iomem *)fb_bitmap;
665         info->fbops = &picolcdfb_ops;
666         info->var = picolcdfb_var;
667         info->fix = picolcdfb_fix;
668         info->fix.smem_len   = PICOLCDFB_SIZE;
669         info->fix.smem_start = (unsigned long)fb_bitmap;
670         info->par = data;
671         info->flags = FBINFO_FLAG_DEFAULT;
672
673         data->fb_vbitmap = fb_vbitmap;
674         data->fb_bitmap  = fb_bitmap;
675         data->fb_bpp     = picolcdfb_var.bits_per_pixel;
676         error = picolcd_fb_reset(data, 1);
677         if (error) {
678                 dev_err(dev, "failed to configure display\n");
679                 goto err_cleanup;
680         }
681         error = device_create_file(dev, &dev_attr_fb_update_rate);
682         if (error) {
683                 dev_err(dev, "failed to create sysfs attributes\n");
684                 goto err_cleanup;
685         }
686         data->fb_info    = info;
687         error = register_framebuffer(info);
688         if (error) {
689                 dev_err(dev, "failed to register framebuffer\n");
690                 goto err_sysfs;
691         }
692         fb_deferred_io_init(info);
693         /* schedule first output of framebuffer */
694         schedule_delayed_work(&info->deferred_work, 0);
695         return 0;
696
697 err_sysfs:
698         device_remove_file(dev, &dev_attr_fb_update_rate);
699 err_cleanup:
700         data->fb_vbitmap = NULL;
701         data->fb_bitmap  = NULL;
702         data->fb_bpp     = 0;
703         data->fb_info    = NULL;
704
705 err_nomem:
706         framebuffer_release(info);
707         vfree(fb_bitmap);
708         kfree(fb_vbitmap);
709         return error;
710 }
711
712 static void picolcd_exit_framebuffer(struct picolcd_data *data)
713 {
714         struct fb_info *info = data->fb_info;
715         u8 *fb_vbitmap = data->fb_vbitmap;
716         u8 *fb_bitmap  = data->fb_bitmap;
717
718         if (!info)
719                 return;
720
721         data->fb_vbitmap = NULL;
722         data->fb_bitmap  = NULL;
723         data->fb_bpp     = 0;
724         data->fb_info    = NULL;
725         device_remove_file(&data->hdev->dev, &dev_attr_fb_update_rate);
726         fb_deferred_io_cleanup(info);
727         unregister_framebuffer(info);
728         vfree(fb_bitmap);
729         kfree(fb_vbitmap);
730 }
731
732
733 #else
734 static inline int picolcd_fb_reset(struct picolcd_data *data, int clear)
735 {
736         return 0;
737 }
738 static inline int picolcd_init_framebuffer(struct picolcd_data *data)
739 {
740         return 0;
741 }
742 static void picolcd_exit_framebuffer(struct picolcd_data *data)
743 {
744 }
745 #endif /* CONFIG_FB */
746
747 /*
748  * input class device
749  */
750 static int picolcd_raw_keypad(struct picolcd_data *data,
751                 struct hid_report *report, u8 *raw_data, int size)
752 {
753         /*
754          * Keypad event
755          * First and second data bytes list currently pressed keys,
756          * 0x00 means no key and at most 2 keys may be pressed at same time
757          */
758         int i, j;
759
760         /* determine newly pressed keys */
761         for (i = 0; i < size; i++) {
762                 unsigned int key_code;
763                 if (raw_data[i] == 0)
764                         continue;
765                 for (j = 0; j < sizeof(data->pressed_keys); j++)
766                         if (data->pressed_keys[j] == raw_data[i])
767                                 goto key_already_down;
768                 for (j = 0; j < sizeof(data->pressed_keys); j++)
769                         if (data->pressed_keys[j] == 0) {
770                                 data->pressed_keys[j] = raw_data[i];
771                                 break;
772                         }
773                 input_event(data->input_keys, EV_MSC, MSC_SCAN, raw_data[i]);
774                 if (raw_data[i] < PICOLCD_KEYS)
775                         key_code = data->keycode[raw_data[i]];
776                 else
777                         key_code = KEY_UNKNOWN;
778                 if (key_code != KEY_UNKNOWN) {
779                         dbg_hid(PICOLCD_NAME " got key press for %u:%d",
780                                         raw_data[i], key_code);
781                         input_report_key(data->input_keys, key_code, 1);
782                 }
783                 input_sync(data->input_keys);
784 key_already_down:
785                 continue;
786         }
787
788         /* determine newly released keys */
789         for (j = 0; j < sizeof(data->pressed_keys); j++) {
790                 unsigned int key_code;
791                 if (data->pressed_keys[j] == 0)
792                         continue;
793                 for (i = 0; i < size; i++)
794                         if (data->pressed_keys[j] == raw_data[i])
795                                 goto key_still_down;
796                 input_event(data->input_keys, EV_MSC, MSC_SCAN, data->pressed_keys[j]);
797                 if (data->pressed_keys[j] < PICOLCD_KEYS)
798                         key_code = data->keycode[data->pressed_keys[j]];
799                 else
800                         key_code = KEY_UNKNOWN;
801                 if (key_code != KEY_UNKNOWN) {
802                         dbg_hid(PICOLCD_NAME " got key release for %u:%d",
803                                         data->pressed_keys[j], key_code);
804                         input_report_key(data->input_keys, key_code, 0);
805                 }
806                 input_sync(data->input_keys);
807                 data->pressed_keys[j] = 0;
808 key_still_down:
809                 continue;
810         }
811         return 1;
812 }
813
814 static int picolcd_raw_cir(struct picolcd_data *data,
815                 struct hid_report *report, u8 *raw_data, int size)
816 {
817         /* Need understanding of CIR data format to implement ... */
818         return 1;
819 }
820
821 static int picolcd_check_version(struct hid_device *hdev)
822 {
823         struct picolcd_data *data = hid_get_drvdata(hdev);
824         struct picolcd_pending *verinfo;
825         int ret = 0;
826
827         if (!data)
828                 return -ENODEV;
829
830         verinfo = picolcd_send_and_wait(hdev, REPORT_VERSION, NULL, 0);
831         if (!verinfo) {
832                 dev_err(&hdev->dev, "no version response from PicoLCD");
833                 return -ENODEV;
834         }
835
836         if (verinfo->raw_size == 2) {
837                 if (data->status & PICOLCD_BOOTLOADER) {
838                         dev_info(&hdev->dev, "PicoLCD, bootloader version %d.%d\n",
839                                         verinfo->raw_data[0], verinfo->raw_data[1]);
840                         data->version[0] = verinfo->raw_data[0];
841                         data->version[1] = verinfo->raw_data[1];
842                 } else {
843                         dev_info(&hdev->dev, "PicoLCD, firmware version %d.%d\n",
844                                         verinfo->raw_data[1], verinfo->raw_data[0]);
845                         data->version[0] = verinfo->raw_data[1];
846                         data->version[1] = verinfo->raw_data[0];
847                 }
848         } else {
849                 dev_err(&hdev->dev, "confused, got unexpected version response from PicoLCD\n");
850                 ret = -EINVAL;
851         }
852         kfree(verinfo);
853         return ret;
854 }
855
856 /*
857  * Reset our device and wait for answer to VERSION request
858  */
859 static int picolcd_reset(struct hid_device *hdev)
860 {
861         struct picolcd_data *data = hid_get_drvdata(hdev);
862         struct hid_report *report = picolcd_out_report(REPORT_RESET, hdev);
863         unsigned long flags;
864         int error;
865
866         if (!data || !report || report->maxfield != 1)
867                 return -ENODEV;
868
869         spin_lock_irqsave(&data->lock, flags);
870         if (hdev->product == USB_DEVICE_ID_PICOLCD_BOOTLOADER)
871                 data->status |= PICOLCD_BOOTLOADER;
872
873         /* perform the reset */
874         hid_set_field(report->field[0], 0, 1);
875         usbhid_submit_report(hdev, report, USB_DIR_OUT);
876         spin_unlock_irqrestore(&data->lock, flags);
877
878         error = picolcd_check_version(hdev);
879         if (error)
880                 return error;
881
882 #if defined(CONFIG_FB) || defined(CONFIG_FB_MODULE)
883         if (data->fb_info)
884                 schedule_delayed_work(&data->fb_info->deferred_work, 0);
885 #endif /* CONFIG_FB */
886
887         return 0;
888 }
889
890 /*
891  * The "operation_mode" sysfs attribute
892  */
893 static ssize_t picolcd_operation_mode_show(struct device *dev,
894                 struct device_attribute *attr, char *buf)
895 {
896         struct picolcd_data *data = dev_get_drvdata(dev);
897
898         if (data->status & PICOLCD_BOOTLOADER)
899                 return snprintf(buf, PAGE_SIZE, "[bootloader] lcd\n");
900         else
901                 return snprintf(buf, PAGE_SIZE, "bootloader [lcd]\n");
902 }
903
904 static ssize_t picolcd_operation_mode_store(struct device *dev,
905                 struct device_attribute *attr, const char *buf, size_t count)
906 {
907         struct picolcd_data *data = dev_get_drvdata(dev);
908         struct hid_report *report = NULL;
909         size_t cnt = count;
910         int timeout = 5000;
911         unsigned u;
912         unsigned long flags;
913
914         if (cnt >= 3 && strncmp("lcd", buf, 3) == 0) {
915                 if (data->status & PICOLCD_BOOTLOADER)
916                         report = picolcd_out_report(REPORT_EXIT_FLASHER, data->hdev);
917                 buf += 3;
918                 cnt -= 3;
919         } else if (cnt >= 10 && strncmp("bootloader", buf, 10) == 0) {
920                 if (!(data->status & PICOLCD_BOOTLOADER))
921                         report = picolcd_out_report(REPORT_EXIT_KEYBOARD, data->hdev);
922                 buf += 10;
923                 cnt -= 10;
924         }
925         if (!report)
926                 return -EINVAL;
927
928         while (cnt > 0 && (*buf == ' ' || *buf == '\t')) {
929                 buf++;
930                 cnt--;
931         }
932         while (cnt > 0 && (buf[cnt-1] == '\n' || buf[cnt-1] == '\r'))
933                 cnt--;
934         if (cnt > 0) {
935                 if (sscanf(buf, "%u", &u) != 1)
936                         return -EINVAL;
937                 if (u > 30000)
938                         return -EINVAL;
939                 else
940                         timeout = u;
941         }
942
943         spin_lock_irqsave(&data->lock, flags);
944         hid_set_field(report->field[0], 0, timeout & 0xff);
945         hid_set_field(report->field[0], 1, (timeout >> 8) & 0xff);
946         usbhid_submit_report(data->hdev, report, USB_DIR_OUT);
947         spin_unlock_irqrestore(&data->lock, flags);
948         return count;
949 }
950
951 static DEVICE_ATTR(operation_mode, 0644, picolcd_operation_mode_show,
952                 picolcd_operation_mode_store);
953
954
955 #ifdef CONFIG_DEBUG_FS
956 /*
957  * Helper code for HID report level dumping/debugging
958  */
959 static const char *error_codes[] = {
960         "success", "parameter missing", "data_missing", "block readonly",
961         "block not erasable", "block too big", "section overflow",
962         "invalid command length", "invalid data length",
963 };
964
965 static void dump_buff_as_hex(char *dst, size_t dst_sz, const u8 *data,
966                 const size_t data_len)
967 {
968         int i, j;
969         for (i = j = 0; i < data_len && j + 3 < dst_sz; i++) {
970                 dst[j++] = hex_asc[(data[i] >> 4) & 0x0f];
971                 dst[j++] = hex_asc[data[i] & 0x0f];
972                 dst[j++] = ' ';
973         }
974         if (j < dst_sz) {
975                 dst[j--] = '\0';
976                 dst[j] = '\n';
977         } else
978                 dst[j] = '\0';
979 }
980
981 static void picolcd_debug_out_report(struct picolcd_data *data,
982                 struct hid_device *hdev, struct hid_report *report)
983 {
984         u8 raw_data[70];
985         int raw_size = (report->size >> 3) + 1;
986         char *buff;
987 #define BUFF_SZ 256
988
989         /* Avoid unnecessary overhead if debugfs is disabled */
990         if (!hdev->debug_events)
991                 return;
992
993         buff = kmalloc(BUFF_SZ, GFP_ATOMIC);
994         if (!buff)
995                 return;
996
997         snprintf(buff, BUFF_SZ, "\nout report %d (size %d) =  ",
998                         report->id, raw_size);
999         hid_debug_event(hdev, buff);
1000         if (raw_size + 5 > sizeof(raw_data)) {
1001                 hid_debug_event(hdev, " TOO BIG\n");
1002                 return;
1003         } else {
1004                 raw_data[0] = report->id;
1005                 hid_output_report(report, raw_data);
1006                 dump_buff_as_hex(buff, BUFF_SZ, raw_data, raw_size);
1007                 hid_debug_event(hdev, buff);
1008         }
1009
1010         switch (report->id) {
1011         case REPORT_LED_STATE:
1012                 /* 1 data byte with GPO state */
1013                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1014                         "REPORT_LED_STATE", report->id, raw_size-1);
1015                 hid_debug_event(hdev, buff);
1016                 snprintf(buff, BUFF_SZ, "\tGPO state: 0x%02x\n", raw_data[1]);
1017                 hid_debug_event(hdev, buff);
1018                 break;
1019         case REPORT_BRIGHTNESS:
1020                 /* 1 data byte with brightness */
1021                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1022                         "REPORT_BRIGHTNESS", report->id, raw_size-1);
1023                 hid_debug_event(hdev, buff);
1024                 snprintf(buff, BUFF_SZ, "\tBrightness: 0x%02x\n", raw_data[1]);
1025                 hid_debug_event(hdev, buff);
1026                 break;
1027         case REPORT_CONTRAST:
1028                 /* 1 data byte with contrast */
1029                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1030                         "REPORT_CONTRAST", report->id, raw_size-1);
1031                 hid_debug_event(hdev, buff);
1032                 snprintf(buff, BUFF_SZ, "\tContrast: 0x%02x\n", raw_data[1]);
1033                 hid_debug_event(hdev, buff);
1034                 break;
1035         case REPORT_RESET:
1036                 /* 2 data bytes with reset duration in ms */
1037                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1038                         "REPORT_RESET", report->id, raw_size-1);
1039                 hid_debug_event(hdev, buff);
1040                 snprintf(buff, BUFF_SZ, "\tDuration: 0x%02x%02x (%dms)\n",
1041                                 raw_data[2], raw_data[1], raw_data[2] << 8 | raw_data[1]);
1042                 hid_debug_event(hdev, buff);
1043                 break;
1044         case REPORT_LCD_CMD:
1045                 /* 63 data bytes with LCD commands */
1046                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1047                         "REPORT_LCD_CMD", report->id, raw_size-1);
1048                 hid_debug_event(hdev, buff);
1049                 /* TODO: format decoding */
1050                 break;
1051         case REPORT_LCD_DATA:
1052                 /* 63 data bytes with LCD data */
1053                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1054                         "REPORT_LCD_CMD", report->id, raw_size-1);
1055                 /* TODO: format decoding */
1056                 hid_debug_event(hdev, buff);
1057                 break;
1058         case REPORT_LCD_CMD_DATA:
1059                 /* 63 data bytes with LCD commands and data */
1060                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1061                         "REPORT_LCD_CMD", report->id, raw_size-1);
1062                 /* TODO: format decoding */
1063                 hid_debug_event(hdev, buff);
1064                 break;
1065         case REPORT_EE_READ:
1066                 /* 3 data bytes with read area description */
1067                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1068                         "REPORT_EE_READ", report->id, raw_size-1);
1069                 hid_debug_event(hdev, buff);
1070                 snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x\n",
1071                                 raw_data[2], raw_data[1]);
1072                 hid_debug_event(hdev, buff);
1073                 snprintf(buff, BUFF_SZ, "\tData length: %d\n", raw_data[3]);
1074                 hid_debug_event(hdev, buff);
1075                 break;
1076         case REPORT_EE_WRITE:
1077                 /* 3+1..20 data bytes with write area description */
1078                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1079                         "REPORT_EE_WRITE", report->id, raw_size-1);
1080                 hid_debug_event(hdev, buff);
1081                 snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x\n",
1082                                 raw_data[2], raw_data[1]);
1083                 hid_debug_event(hdev, buff);
1084                 snprintf(buff, BUFF_SZ, "\tData length: %d\n", raw_data[3]);
1085                 hid_debug_event(hdev, buff);
1086                 if (raw_data[3] == 0) {
1087                         snprintf(buff, BUFF_SZ, "\tNo data\n");
1088                 } else if (raw_data[3] + 4 <= raw_size) {
1089                         snprintf(buff, BUFF_SZ, "\tData: ");
1090                         hid_debug_event(hdev, buff);
1091                         dump_buff_as_hex(buff, BUFF_SZ, raw_data+4, raw_data[3]);
1092                 } else {
1093                         snprintf(buff, BUFF_SZ, "\tData overflowed\n");
1094                 }
1095                 hid_debug_event(hdev, buff);
1096                 break;
1097         case REPORT_ERASE_MEMORY:
1098         case REPORT_BL_ERASE_MEMORY:
1099                 /* 3 data bytes with pointer inside erase block */
1100                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1101                         "REPORT_ERASE_MEMORY", report->id, raw_size-1);
1102                 hid_debug_event(hdev, buff);
1103                 switch (data->addr_sz) {
1104                 case 2:
1105                         snprintf(buff, BUFF_SZ, "\tAddress inside 64 byte block: 0x%02x%02x\n",
1106                                         raw_data[2], raw_data[1]);
1107                         break;
1108                 case 3:
1109                         snprintf(buff, BUFF_SZ, "\tAddress inside 64 byte block: 0x%02x%02x%02x\n",
1110                                         raw_data[3], raw_data[2], raw_data[1]);
1111                         break;
1112                 default:
1113                         snprintf(buff, BUFF_SZ, "\tNot supported\n");
1114                 }
1115                 hid_debug_event(hdev, buff);
1116                 break;
1117         case REPORT_READ_MEMORY:
1118         case REPORT_BL_READ_MEMORY:
1119                 /* 4 data bytes with read area description */
1120                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1121                         "REPORT_READ_MEMORY", report->id, raw_size-1);
1122                 hid_debug_event(hdev, buff);
1123                 switch (data->addr_sz) {
1124                 case 2:
1125                         snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x\n",
1126                                         raw_data[2], raw_data[1]);
1127                         hid_debug_event(hdev, buff);
1128                         snprintf(buff, BUFF_SZ, "\tData length: %d\n", raw_data[3]);
1129                         break;
1130                 case 3:
1131                         snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x%02x\n",
1132                                         raw_data[3], raw_data[2], raw_data[1]);
1133                         hid_debug_event(hdev, buff);
1134                         snprintf(buff, BUFF_SZ, "\tData length: %d\n", raw_data[4]);
1135                         break;
1136                 default:
1137                         snprintf(buff, BUFF_SZ, "\tNot supported\n");
1138                 }
1139                 hid_debug_event(hdev, buff);
1140                 break;
1141         case REPORT_WRITE_MEMORY:
1142         case REPORT_BL_WRITE_MEMORY:
1143                 /* 4+1..32 data bytes with write adrea description */
1144                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1145                         "REPORT_WRITE_MEMORY", report->id, raw_size-1);
1146                 hid_debug_event(hdev, buff);
1147                 switch (data->addr_sz) {
1148                 case 2:
1149                         snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x\n",
1150                                         raw_data[2], raw_data[1]);
1151                         hid_debug_event(hdev, buff);
1152                         snprintf(buff, BUFF_SZ, "\tData length: %d\n", raw_data[3]);
1153                         hid_debug_event(hdev, buff);
1154                         if (raw_data[3] == 0) {
1155                                 snprintf(buff, BUFF_SZ, "\tNo data\n");
1156                         } else if (raw_data[3] + 4 <= raw_size) {
1157                                 snprintf(buff, BUFF_SZ, "\tData: ");
1158                                 hid_debug_event(hdev, buff);
1159                                 dump_buff_as_hex(buff, BUFF_SZ, raw_data+4, raw_data[3]);
1160                         } else {
1161                                 snprintf(buff, BUFF_SZ, "\tData overflowed\n");
1162                         }
1163                         break;
1164                 case 3:
1165                         snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x%02x\n",
1166                                         raw_data[3], raw_data[2], raw_data[1]);
1167                         hid_debug_event(hdev, buff);
1168                         snprintf(buff, BUFF_SZ, "\tData length: %d\n", raw_data[4]);
1169                         hid_debug_event(hdev, buff);
1170                         if (raw_data[4] == 0) {
1171                                 snprintf(buff, BUFF_SZ, "\tNo data\n");
1172                         } else if (raw_data[4] + 5 <= raw_size) {
1173                                 snprintf(buff, BUFF_SZ, "\tData: ");
1174                                 hid_debug_event(hdev, buff);
1175                                 dump_buff_as_hex(buff, BUFF_SZ, raw_data+5, raw_data[4]);
1176                         } else {
1177                                 snprintf(buff, BUFF_SZ, "\tData overflowed\n");
1178                         }
1179                         break;
1180                 default:
1181                         snprintf(buff, BUFF_SZ, "\tNot supported\n");
1182                 }
1183                 hid_debug_event(hdev, buff);
1184                 break;
1185         case REPORT_SPLASH_RESTART:
1186                 /* TODO */
1187                 break;
1188         case REPORT_EXIT_KEYBOARD:
1189                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1190                         "REPORT_EXIT_KEYBOARD", report->id, raw_size-1);
1191                 hid_debug_event(hdev, buff);
1192                 snprintf(buff, BUFF_SZ, "\tRestart delay: %dms (0x%02x%02x)\n",
1193                                 raw_data[1] | (raw_data[2] << 8),
1194                                 raw_data[2], raw_data[1]);
1195                 hid_debug_event(hdev, buff);
1196                 break;
1197         case REPORT_VERSION:
1198                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1199                         "REPORT_VERSION", report->id, raw_size-1);
1200                 hid_debug_event(hdev, buff);
1201                 break;
1202         case REPORT_DEVID:
1203                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1204                         "REPORT_DEVID", report->id, raw_size-1);
1205                 hid_debug_event(hdev, buff);
1206                 break;
1207         case REPORT_SPLASH_SIZE:
1208                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1209                         "REPORT_SPLASH_SIZE", report->id, raw_size-1);
1210                 hid_debug_event(hdev, buff);
1211                 break;
1212         case REPORT_HOOK_VERSION:
1213                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1214                         "REPORT_HOOK_VERSION", report->id, raw_size-1);
1215                 hid_debug_event(hdev, buff);
1216                 break;
1217         case REPORT_EXIT_FLASHER:
1218                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1219                         "REPORT_VERSION", report->id, raw_size-1);
1220                 hid_debug_event(hdev, buff);
1221                 snprintf(buff, BUFF_SZ, "\tRestart delay: %dms (0x%02x%02x)\n",
1222                                 raw_data[1] | (raw_data[2] << 8),
1223                                 raw_data[2], raw_data[1]);
1224                 hid_debug_event(hdev, buff);
1225                 break;
1226         default:
1227                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1228                         "<unknown>", report->id, raw_size-1);
1229                 hid_debug_event(hdev, buff);
1230                 break;
1231         }
1232         wake_up_interruptible(&hdev->debug_wait);
1233         kfree(buff);
1234 }
1235
1236 static void picolcd_debug_raw_event(struct picolcd_data *data,
1237                 struct hid_device *hdev, struct hid_report *report,
1238                 u8 *raw_data, int size)
1239 {
1240         char *buff;
1241
1242 #define BUFF_SZ 256
1243         /* Avoid unnecessary overhead if debugfs is disabled */
1244         if (!hdev->debug_events)
1245                 return;
1246
1247         buff = kmalloc(BUFF_SZ, GFP_ATOMIC);
1248         if (!buff)
1249                 return;
1250
1251         switch (report->id) {
1252         case REPORT_ERROR_CODE:
1253                 /* 2 data bytes with affected report and error code */
1254                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
1255                         "REPORT_ERROR_CODE", report->id, size-1);
1256                 hid_debug_event(hdev, buff);
1257                 if (raw_data[2] < ARRAY_SIZE(error_codes))
1258                         snprintf(buff, BUFF_SZ, "\tError code 0x%02x (%s) in reply to report 0x%02x\n",
1259                                         raw_data[2], error_codes[raw_data[2]], raw_data[1]);
1260                 else
1261                         snprintf(buff, BUFF_SZ, "\tError code 0x%02x in reply to report 0x%02x\n",
1262                                         raw_data[2], raw_data[1]);
1263                 hid_debug_event(hdev, buff);
1264                 break;
1265         case REPORT_KEY_STATE:
1266                 /* 2 data bytes with key state */
1267                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
1268                         "REPORT_KEY_STATE", report->id, size-1);
1269                 hid_debug_event(hdev, buff);
1270                 if (raw_data[1] == 0)
1271                         snprintf(buff, BUFF_SZ, "\tNo key pressed\n");
1272                 else if (raw_data[2] == 0)
1273                         snprintf(buff, BUFF_SZ, "\tOne key pressed: 0x%02x (%d)\n",
1274                                         raw_data[1], raw_data[1]);
1275                 else
1276                         snprintf(buff, BUFF_SZ, "\tTwo keys pressed: 0x%02x (%d), 0x%02x (%d)\n",
1277                                         raw_data[1], raw_data[1], raw_data[2], raw_data[2]);
1278                 hid_debug_event(hdev, buff);
1279                 break;
1280         case REPORT_IR_DATA:
1281                 /* Up to 20 byes of IR scancode data */
1282                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
1283                         "REPORT_IR_DATA", report->id, size-1);
1284                 hid_debug_event(hdev, buff);
1285                 if (raw_data[1] == 0) {
1286                         snprintf(buff, BUFF_SZ, "\tUnexpectedly 0 data length\n");
1287                         hid_debug_event(hdev, buff);
1288                 } else if (raw_data[1] + 1 <= size) {
1289                         snprintf(buff, BUFF_SZ, "\tData length: %d\n\tIR Data: ",
1290                                         raw_data[1]-1);
1291                         hid_debug_event(hdev, buff);
1292                         dump_buff_as_hex(buff, BUFF_SZ, raw_data+2, raw_data[1]-1);
1293                         hid_debug_event(hdev, buff);
1294                 } else {
1295                         snprintf(buff, BUFF_SZ, "\tOverflowing data length: %d\n",
1296                                         raw_data[1]-1);
1297                         hid_debug_event(hdev, buff);
1298                 }
1299                 break;
1300         case REPORT_EE_DATA:
1301                 /* Data buffer in response to REPORT_EE_READ or REPORT_EE_WRITE */
1302                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
1303                         "REPORT_EE_DATA", report->id, size-1);
1304                 hid_debug_event(hdev, buff);
1305                 snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x\n",
1306                                 raw_data[2], raw_data[1]);
1307                 hid_debug_event(hdev, buff);
1308                 snprintf(buff, BUFF_SZ, "\tData length: %d\n", raw_data[3]);
1309                 hid_debug_event(hdev, buff);
1310                 if (raw_data[3] == 0) {
1311                         snprintf(buff, BUFF_SZ, "\tNo data\n");
1312                         hid_debug_event(hdev, buff);
1313                 } else if (raw_data[3] + 4 <= size) {
1314                         snprintf(buff, BUFF_SZ, "\tData: ");
1315                         hid_debug_event(hdev, buff);
1316                         dump_buff_as_hex(buff, BUFF_SZ, raw_data+4, raw_data[3]);
1317                         hid_debug_event(hdev, buff);
1318                 } else {
1319                         snprintf(buff, BUFF_SZ, "\tData overflowed\n");
1320                         hid_debug_event(hdev, buff);
1321                 }
1322                 break;
1323         case REPORT_MEMORY:
1324                 /* Data buffer in response to REPORT_READ_MEMORY or REPORT_WRTIE_MEMORY */
1325                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
1326                         "REPORT_MEMORY", report->id, size-1);
1327                 hid_debug_event(hdev, buff);
1328                 switch (data->addr_sz) {
1329                 case 2:
1330                         snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x\n",
1331                                         raw_data[2], raw_data[1]);
1332                         hid_debug_event(hdev, buff);
1333                         snprintf(buff, BUFF_SZ, "\tData length: %d\n", raw_data[3]);
1334                         hid_debug_event(hdev, buff);
1335                         if (raw_data[3] == 0) {
1336                                 snprintf(buff, BUFF_SZ, "\tNo data\n");
1337                         } else if (raw_data[3] + 4 <= size) {
1338                                 snprintf(buff, BUFF_SZ, "\tData: ");
1339                                 hid_debug_event(hdev, buff);
1340                                 dump_buff_as_hex(buff, BUFF_SZ, raw_data+4, raw_data[3]);
1341                         } else {
1342                                 snprintf(buff, BUFF_SZ, "\tData overflowed\n");
1343                         }
1344                         break;
1345                 case 3:
1346                         snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x%02x\n",
1347                                         raw_data[3], raw_data[2], raw_data[1]);
1348                         hid_debug_event(hdev, buff);
1349                         snprintf(buff, BUFF_SZ, "\tData length: %d\n", raw_data[4]);
1350                         hid_debug_event(hdev, buff);
1351                         if (raw_data[4] == 0) {
1352                                 snprintf(buff, BUFF_SZ, "\tNo data\n");
1353                         } else if (raw_data[4] + 5 <= size) {
1354                                 snprintf(buff, BUFF_SZ, "\tData: ");
1355                                 hid_debug_event(hdev, buff);
1356                                 dump_buff_as_hex(buff, BUFF_SZ, raw_data+5, raw_data[4]);
1357                         } else {
1358                                 snprintf(buff, BUFF_SZ, "\tData overflowed\n");
1359                         }
1360                         break;
1361                 default:
1362                         snprintf(buff, BUFF_SZ, "\tNot supported\n");
1363                 }
1364                 hid_debug_event(hdev, buff);
1365                 break;
1366         case REPORT_VERSION:
1367                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
1368                         "REPORT_VERSION", report->id, size-1);
1369                 hid_debug_event(hdev, buff);
1370                 snprintf(buff, BUFF_SZ, "\tFirmware version: %d.%d\n",
1371                                 raw_data[2], raw_data[1]);
1372                 hid_debug_event(hdev, buff);
1373                 break;
1374         case REPORT_BL_ERASE_MEMORY:
1375                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
1376                         "REPORT_BL_ERASE_MEMORY", report->id, size-1);
1377                 hid_debug_event(hdev, buff);
1378                 /* TODO */
1379                 break;
1380         case REPORT_BL_READ_MEMORY:
1381                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
1382                         "REPORT_BL_READ_MEMORY", report->id, size-1);
1383                 hid_debug_event(hdev, buff);
1384                 /* TODO */
1385                 break;
1386         case REPORT_BL_WRITE_MEMORY:
1387                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
1388                         "REPORT_BL_WRITE_MEMORY", report->id, size-1);
1389                 hid_debug_event(hdev, buff);
1390                 /* TODO */
1391                 break;
1392         case REPORT_DEVID:
1393                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
1394                         "REPORT_DEVID", report->id, size-1);
1395                 hid_debug_event(hdev, buff);
1396                 snprintf(buff, BUFF_SZ, "\tSerial: 0x%02x%02x%02x%02x\n",
1397                                 raw_data[1], raw_data[2], raw_data[3], raw_data[4]);
1398                 hid_debug_event(hdev, buff);
1399                 snprintf(buff, BUFF_SZ, "\tType: 0x%02x\n",
1400                                 raw_data[5]);
1401                 hid_debug_event(hdev, buff);
1402                 break;
1403         case REPORT_SPLASH_SIZE:
1404                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
1405                         "REPORT_SPLASH_SIZE", report->id, size-1);
1406                 hid_debug_event(hdev, buff);
1407                 snprintf(buff, BUFF_SZ, "\tTotal splash space: %d\n",
1408                                 (raw_data[2] << 8) | raw_data[1]);
1409                 hid_debug_event(hdev, buff);
1410                 snprintf(buff, BUFF_SZ, "\tUsed splash space: %d\n",
1411                                 (raw_data[4] << 8) | raw_data[3]);
1412                 hid_debug_event(hdev, buff);
1413                 break;
1414         case REPORT_HOOK_VERSION:
1415                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
1416                         "REPORT_HOOK_VERSION", report->id, size-1);
1417                 hid_debug_event(hdev, buff);
1418                 snprintf(buff, BUFF_SZ, "\tFirmware version: %d.%d\n",
1419                                 raw_data[1], raw_data[2]);
1420                 hid_debug_event(hdev, buff);
1421                 break;
1422         default:
1423                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
1424                         "<unknown>", report->id, size-1);
1425                 hid_debug_event(hdev, buff);
1426                 break;
1427         }
1428         wake_up_interruptible(&hdev->debug_wait);
1429         kfree(buff);
1430 }
1431 #else
1432 #define picolcd_debug_raw_event(data, hdev, report, raw_data, size)
1433 #endif
1434
1435 /*
1436  * Handle raw report as sent by device
1437  */
1438 static int picolcd_raw_event(struct hid_device *hdev,
1439                 struct hid_report *report, u8 *raw_data, int size)
1440 {
1441         struct picolcd_data *data = hid_get_drvdata(hdev);
1442         unsigned long flags;
1443         int ret = 0;
1444
1445         if (!data)
1446                 return 1;
1447
1448         if (report->id == REPORT_KEY_STATE) {
1449                 if (data->input_keys)
1450                         ret = picolcd_raw_keypad(data, report, raw_data+1, size-1);
1451         } else if (report->id == REPORT_IR_DATA) {
1452                 if (data->input_cir)
1453                         ret = picolcd_raw_cir(data, report, raw_data+1, size-1);
1454         } else {
1455                 spin_lock_irqsave(&data->lock, flags);
1456                 /*
1457                  * We let the caller of picolcd_send_and_wait() check if the
1458                  * report we got is one of the expected ones or not.
1459                  */
1460                 if (data->pending) {
1461                         memcpy(data->pending->raw_data, raw_data+1, size-1);
1462                         data->pending->raw_size  = size-1;
1463                         data->pending->in_report = report;
1464                         complete(&data->pending->ready);
1465                 }
1466                 spin_unlock_irqrestore(&data->lock, flags);
1467         }
1468
1469         picolcd_debug_raw_event(data, hdev, report, raw_data, size);
1470         return 1;
1471 }
1472
1473 /* initialize keypad input device */
1474 static int picolcd_init_keys(struct picolcd_data *data,
1475                 struct hid_report *report)
1476 {
1477         struct hid_device *hdev = data->hdev;
1478         struct input_dev *idev;
1479         int error, i;
1480
1481         if (!report)
1482                 return -ENODEV;
1483         if (report->maxfield != 1 || report->field[0]->report_count != 2 ||
1484                         report->field[0]->report_size != 8) {
1485                 dev_err(&hdev->dev, "unsupported KEY_STATE report");
1486                 return -EINVAL;
1487         }
1488
1489         idev = input_allocate_device();
1490         if (idev == NULL) {
1491                 dev_err(&hdev->dev, "failed to allocate input device");
1492                 return -ENOMEM;
1493         }
1494         input_set_drvdata(idev, hdev);
1495         memcpy(data->keycode, def_keymap, sizeof(def_keymap));
1496         idev->name = hdev->name;
1497         idev->phys = hdev->phys;
1498         idev->uniq = hdev->uniq;
1499         idev->id.bustype = hdev->bus;
1500         idev->id.vendor  = hdev->vendor;
1501         idev->id.product = hdev->product;
1502         idev->id.version = hdev->version;
1503         idev->dev.parent = hdev->dev.parent;
1504         idev->keycode     = &data->keycode;
1505         idev->keycodemax  = PICOLCD_KEYS;
1506         idev->keycodesize = sizeof(data->keycode[0]);
1507         input_set_capability(idev, EV_MSC, MSC_SCAN);
1508         set_bit(EV_REP, idev->evbit);
1509         for (i = 0; i < PICOLCD_KEYS; i++)
1510                 input_set_capability(idev, EV_KEY, data->keycode[i]);
1511         error = input_register_device(idev);
1512         if (error) {
1513                 dev_err(&hdev->dev, "error registering the input device");
1514                 input_free_device(idev);
1515                 return error;
1516         }
1517         data->input_keys = idev;
1518         return 0;
1519 }
1520
1521 static void picolcd_exit_keys(struct picolcd_data *data)
1522 {
1523         struct input_dev *idev = data->input_keys;
1524
1525         data->input_keys = NULL;
1526         if (idev)
1527                 input_unregister_device(idev);
1528 }
1529
1530 /* initialize CIR input device */
1531 static inline int picolcd_init_cir(struct picolcd_data *data, struct hid_report *report)
1532 {
1533         /* support not implemented yet */
1534         return 0;
1535 }
1536
1537 static inline void picolcd_exit_cir(struct picolcd_data *data)
1538 {
1539 }
1540
1541 static int picolcd_probe_lcd(struct hid_device *hdev, struct picolcd_data *data)
1542 {
1543         struct hid_report *report;
1544         int error;
1545
1546         error = picolcd_check_version(hdev);
1547         if (error)
1548                 return error;
1549
1550         if (data->version[0] != 0 && data->version[1] != 3)
1551                 dev_info(&hdev->dev, "Device with untested firmware revision, "
1552                                 "please submit /sys/kernel/debug/hid/%s/rdesc for this device.\n",
1553                                 dev_name(&hdev->dev));
1554
1555         /* Setup keypad input device */
1556         error = picolcd_init_keys(data, picolcd_in_report(REPORT_KEY_STATE, hdev));
1557         if (error)
1558                 goto err;
1559
1560         /* Setup CIR input device */
1561         error = picolcd_init_cir(data, picolcd_in_report(REPORT_IR_DATA, hdev));
1562         if (error)
1563                 goto err;
1564
1565         /* Set up the framebuffer device */
1566         error = picolcd_init_framebuffer(data);
1567         if (error)
1568                 goto err;
1569
1570 #ifdef CONFIG_DEBUG_FS
1571         report = picolcd_out_report(REPORT_READ_MEMORY, hdev);
1572         if (report && report->maxfield == 1 && report->field[0]->report_size == 8)
1573                 data->addr_sz = report->field[0]->report_count - 1;
1574         else
1575                 data->addr_sz = -1;
1576 #endif
1577         return 0;
1578 err:
1579         picolcd_exit_framebuffer(data);
1580         picolcd_exit_cir(data);
1581         picolcd_exit_keys(data);
1582         return error;
1583 }
1584
1585 static int picolcd_probe_bootloader(struct hid_device *hdev, struct picolcd_data *data)
1586 {
1587         struct hid_report *report;
1588         int error;
1589
1590         error = picolcd_check_version(hdev);
1591         if (error)
1592                 return error;
1593
1594         if (data->version[0] != 1 && data->version[1] != 0)
1595                 dev_info(&hdev->dev, "Device with untested bootloader revision, "
1596                                 "please submit /sys/kernel/debug/hid/%s/rdesc for this device.\n",
1597                                 dev_name(&hdev->dev));
1598
1599 #ifdef CONFIG_DEBUG_FS
1600         report = picolcd_out_report(REPORT_BL_READ_MEMORY, hdev);
1601         if (report && report->maxfield == 1 && report->field[0]->report_size == 8)
1602                 data->addr_sz = report->field[0]->report_count - 1;
1603         else
1604                 data->addr_sz = -1;
1605 #endif
1606         return 0;
1607 }
1608
1609 static int picolcd_probe(struct hid_device *hdev,
1610                      const struct hid_device_id *id)
1611 {
1612         struct picolcd_data *data;
1613         int error = -ENOMEM;
1614
1615         dbg_hid(PICOLCD_NAME " hardware probe...\n");
1616
1617         /*
1618          * Let's allocate the picolcd data structure, set some reasonable
1619          * defaults, and associate it with the device
1620          */
1621         data = kzalloc(sizeof(struct picolcd_data), GFP_KERNEL);
1622         if (data == NULL) {
1623                 dev_err(&hdev->dev, "can't allocate space for Minibox PicoLCD device data\n");
1624                 error = -ENOMEM;
1625                 goto err_no_cleanup;
1626         }
1627
1628         spin_lock_init(&data->lock);
1629         mutex_init(&data->mutex);
1630         data->hdev = hdev;
1631         if (hdev->product == USB_DEVICE_ID_PICOLCD_BOOTLOADER)
1632                 data->status |= PICOLCD_BOOTLOADER;
1633         hid_set_drvdata(hdev, data);
1634
1635         /* Parse the device reports and start it up */
1636         error = hid_parse(hdev);
1637         if (error) {
1638                 dev_err(&hdev->dev, "device report parse failed\n");
1639                 goto err_cleanup_data;
1640         }
1641
1642         /* We don't use hidinput but hid_hw_start() fails if nothing is
1643          * claimed. So spoof claimed input. */
1644         hdev->claimed = HID_CLAIMED_INPUT;
1645         error = hid_hw_start(hdev, 0);
1646         hdev->claimed = 0;
1647         if (error) {
1648                 dev_err(&hdev->dev, "hardware start failed\n");
1649                 goto err_cleanup_data;
1650         }
1651
1652         error = hdev->ll_driver->open(hdev);
1653         if (error) {
1654                 dev_err(&hdev->dev, "failed to open input interrupt pipe for key and IR events\n");
1655                 goto err_cleanup_hid_hw;
1656         }
1657
1658         error = device_create_file(&hdev->dev, &dev_attr_operation_mode);
1659         if (error) {
1660                 dev_err(&hdev->dev, "failed to create sysfs attributes\n");
1661                 goto err_cleanup_hid_ll;
1662         }
1663
1664         if (data->status & PICOLCD_BOOTLOADER)
1665                 error = picolcd_probe_bootloader(hdev, data);
1666         else
1667                 error = picolcd_probe_lcd(hdev, data);
1668         if (error)
1669                 goto err_cleanup_sysfs;
1670
1671         dbg_hid(PICOLCD_NAME " activated and initialized\n");
1672         return 0;
1673
1674 err_cleanup_sysfs:
1675         device_remove_file(&hdev->dev, &dev_attr_operation_mode);
1676 err_cleanup_hid_ll:
1677         hdev->ll_driver->close(hdev);
1678 err_cleanup_hid_hw:
1679         hid_hw_stop(hdev);
1680 err_cleanup_data:
1681         kfree(data);
1682 err_no_cleanup:
1683         hid_set_drvdata(hdev, NULL);
1684
1685         return error;
1686 }
1687
1688 static void picolcd_remove(struct hid_device *hdev)
1689 {
1690         struct picolcd_data *data = hid_get_drvdata(hdev);
1691         unsigned long flags;
1692
1693         dbg_hid(PICOLCD_NAME " hardware remove...\n");
1694         spin_lock_irqsave(&data->lock, flags);
1695         data->status |= PICOLCD_FAILED;
1696         spin_unlock_irqrestore(&data->lock, flags);
1697
1698         device_remove_file(&hdev->dev, &dev_attr_operation_mode);
1699         hdev->ll_driver->close(hdev);
1700         hid_hw_stop(hdev);
1701         hid_set_drvdata(hdev, NULL);
1702
1703         /* Shortcut potential pending reply that will never arrive */
1704         spin_lock_irqsave(&data->lock, flags);
1705         if (data->pending)
1706                 complete(&data->pending->ready);
1707         spin_unlock_irqrestore(&data->lock, flags);
1708
1709         /* Clean up the framebuffer */
1710         picolcd_exit_framebuffer(data);
1711         /* Cleanup input */
1712         picolcd_exit_cir(data);
1713         picolcd_exit_keys(data);
1714
1715         mutex_destroy(&data->mutex);
1716         /* Finally, clean up the picolcd data itself */
1717         kfree(data);
1718 }
1719
1720 static const struct hid_device_id picolcd_devices[] = {
1721         { HID_USB_DEVICE(USB_VENDOR_ID_MICROCHIP, USB_DEVICE_ID_PICOLCD) },
1722         { HID_USB_DEVICE(USB_VENDOR_ID_MICROCHIP, USB_DEVICE_ID_PICOLCD_BOOTLOADER) },
1723         { }
1724 };
1725 MODULE_DEVICE_TABLE(hid, picolcd_devices);
1726
1727 static struct hid_driver picolcd_driver = {
1728         .name =          "hid-picolcd",
1729         .id_table =      picolcd_devices,
1730         .probe =         picolcd_probe,
1731         .remove =        picolcd_remove,
1732         .raw_event =     picolcd_raw_event,
1733 };
1734
1735 static int __init picolcd_init(void)
1736 {
1737         return hid_register_driver(&picolcd_driver);
1738 }
1739
1740 static void __exit picolcd_exit(void)
1741 {
1742         hid_unregister_driver(&picolcd_driver);
1743 }
1744
1745 module_init(picolcd_init);
1746 module_exit(picolcd_exit);
1747 MODULE_DESCRIPTION("Minibox graphics PicoLCD Driver");
1748 MODULE_LICENSE("GPL v2");