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