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 #include <linux/backlight.h>
  30 #include <linux/lcd.h>
  31
  32 #include <linux/leds.h>
  33
  34 #include <linux/seq_file.h>
  35 #include <linux/debugfs.h>
  36
  37 #include <linux/completion.h>
  38 #include <linux/uaccess.h>
  39
  40 #define PICOLCD_NAME "PicoLCD (graphic)"
  41
  42 /* Report numbers */
  43 #define REPORT_ERROR_CODE      0x10 /* LCD: IN[16]  */
  44 #define   ERR_SUCCESS            0x00
  45 #define   ERR_PARAMETER_MISSING  0x01
  46 #define   ERR_DATA_MISSING       0x02
  47 #define   ERR_BLOCK_READ_ONLY    0x03
  48 #define   ERR_BLOCK_NOT_ERASABLE 0x04
  49 #define   ERR_BLOCK_TOO_BIG      0x05
  50 #define   ERR_SECTION_OVERFLOW   0x06
  51 #define   ERR_INVALID_CMD_LEN    0x07
  52 #define   ERR_INVALID_DATA_LEN   0x08
  53 #define REPORT_KEY_STATE       0x11 /* LCD: IN[2]   */
  54 #define REPORT_IR_DATA         0x21 /* LCD: IN[63]  */
  55 #define REPORT_EE_DATA         0x32 /* LCD: IN[63]  */
  56 #define REPORT_MEMORY          0x41 /* LCD: IN[63]  */
  57 #define REPORT_LED_STATE       0x81 /* LCD: OUT[1]  */
  58 #define REPORT_BRIGHTNESS      0x91 /* LCD: OUT[1]  */
  59 #define REPORT_CONTRAST        0x92 /* LCD: OUT[1]  */
  60 #define REPORT_RESET           0x93 /* LCD: OUT[2]  */
  61 #define REPORT_LCD_CMD         0x94 /* LCD: OUT[63] */
  62 #define REPORT_LCD_DATA        0x95 /* LCD: OUT[63] */
  63 #define REPORT_LCD_CMD_DATA    0x96 /* LCD: OUT[63] */
  64 #define REPORT_EE_READ         0xa3 /* LCD: OUT[63] */
  65 #define REPORT_EE_WRITE        0xa4 /* LCD: OUT[63] */
  66 #define REPORT_ERASE_MEMORY    0xb2 /* LCD: OUT[2]  */
  67 #define REPORT_READ_MEMORY     0xb3 /* LCD: OUT[3]  */
  68 #define REPORT_WRITE_MEMORY    0xb4 /* LCD: OUT[63] */
  69 #define REPORT_SPLASH_RESTART  0xc1 /* LCD: OUT[1]  */
  70 #define REPORT_EXIT_KEYBOARD   0xef /* LCD: OUT[2]  */
  71 #define REPORT_VERSION         0xf1 /* LCD: IN[2],OUT[1]    Bootloader: IN[2],OUT[1]   */
  72 #define REPORT_BL_ERASE_MEMORY 0xf2 /*                      Bootloader: IN[36],OUT[4]  */
  73 #define REPORT_BL_READ_MEMORY  0xf3 /*                      Bootloader: IN[36],OUT[4]  */
  74 #define REPORT_BL_WRITE_MEMORY 0xf4 /*                      Bootloader: IN[36],OUT[36] */
  75 #define REPORT_DEVID           0xf5 /* LCD: IN[5], OUT[1]   Bootloader: IN[5],OUT[1]   */
  76 #define REPORT_SPLASH_SIZE     0xf6 /* LCD: IN[4], OUT[1]   */
  77 #define REPORT_HOOK_VERSION    0xf7 /* LCD: IN[2], OUT[1]   */
  78 #define REPORT_EXIT_FLASHER    0xff /*                      Bootloader: OUT[2]         */
  79
  80 #ifdef CONFIG_HID_PICOLCD_FB
  81 /* Framebuffer
  82  *
  83  * The PicoLCD use a Topway LCD module of 256x64 pixel
  84  * This display area is tiled over 4 controllers with 8 tiles
  85  * each. Each tile has 8x64 pixel, each data byte representing
  86  * a 1-bit wide vertical line of the tile.
  87  *
  88  * The display can be updated at a tile granularity.
  89  *
  90  *       Chip 1           Chip 2           Chip 3           Chip 4
  91  * +----------------+----------------+----------------+----------------+
  92  * |     Tile 1     |     Tile 1     |     Tile 1     |     Tile 1     |
  93  * +----------------+----------------+----------------+----------------+
  94  * |     Tile 2     |     Tile 2     |     Tile 2     |     Tile 2     |
  95  * +----------------+----------------+----------------+----------------+
  96  *                                  ...
  97  * +----------------+----------------+----------------+----------------+
  98  * |     Tile 8     |     Tile 8     |     Tile 8     |     Tile 8     |
  99  * +----------------+----------------+----------------+----------------+
 100  */
 101 #define PICOLCDFB_NAME "picolcdfb"
 102 #define PICOLCDFB_WIDTH (256)
 103 #define PICOLCDFB_HEIGHT (64)
 104 #define PICOLCDFB_SIZE (PICOLCDFB_WIDTH * PICOLCDFB_HEIGHT / 8)
 105
 106 #define PICOLCDFB_UPDATE_RATE_LIMIT   10
 107 #define PICOLCDFB_UPDATE_RATE_DEFAULT  2
 108
 109 /* Framebuffer visual structures */
 110 static const struct fb_fix_screeninfo picolcdfb_fix = {
 111         .id          = PICOLCDFB_NAME,
 112         .type        = FB_TYPE_PACKED_PIXELS,
 113         .visual      = FB_VISUAL_MONO01,
 114         .xpanstep    = 0,
 115         .ypanstep    = 0,
 116         .ywrapstep   = 0,
 117         .line_length = PICOLCDFB_WIDTH / 8,
 118         .accel       = FB_ACCEL_NONE,
 119 };
 120
 121 static const struct fb_var_screeninfo picolcdfb_var = {
 122         .xres           = PICOLCDFB_WIDTH,
 123         .yres           = PICOLCDFB_HEIGHT,
 124         .xres_virtual   = PICOLCDFB_WIDTH,
 125         .yres_virtual   = PICOLCDFB_HEIGHT,
 126         .width          = 103,
 127         .height         = 26,
 128         .bits_per_pixel = 1,
 129         .grayscale      = 1,
 130 };
 131 #endif /* CONFIG_HID_PICOLCD_FB */
 132
 133 /* Input device
 134  *
 135  * The PicoLCD has an IR receiver header, a built-in keypad with 5 keys
 136  * and header for 4x4 key matrix. The built-in keys are part of the matrix.
 137  */
 138 static const unsigned short def_keymap[] = {
 139         KEY_RESERVED,   /* none */
 140         KEY_BACK,       /* col 4 + row 1 */
 141         KEY_HOMEPAGE,   /* col 3 + row 1 */
 142         KEY_RESERVED,   /* col 2 + row 1 */
 143         KEY_RESERVED,   /* col 1 + row 1 */
 144         KEY_SCROLLUP,   /* col 4 + row 2 */
 145         KEY_OK,         /* col 3 + row 2 */
 146         KEY_SCROLLDOWN, /* col 2 + row 2 */
 147         KEY_RESERVED,   /* col 1 + row 2 */
 148         KEY_RESERVED,   /* col 4 + row 3 */
 149         KEY_RESERVED,   /* col 3 + row 3 */
 150         KEY_RESERVED,   /* col 2 + row 3 */
 151         KEY_RESERVED,   /* col 1 + row 3 */
 152         KEY_RESERVED,   /* col 4 + row 4 */
 153         KEY_RESERVED,   /* col 3 + row 4 */
 154         KEY_RESERVED,   /* col 2 + row 4 */
 155         KEY_RESERVED,   /* col 1 + row 4 */
 156 };
 157 #define PICOLCD_KEYS ARRAY_SIZE(def_keymap)
 158
 159 /* Description of in-progress IO operation, used for operations
 160  * that trigger response from device */
 161 struct picolcd_pending {
 162         struct hid_report *out_report;
 163         struct hid_report *in_report;
 164         struct completion ready;
 165         int raw_size;
 166         u8 raw_data[64];
 167 };
 168
 169 /* Per device data structure */
 170 struct picolcd_data {
 171         struct hid_device *hdev;
 172 #ifdef CONFIG_DEBUG_FS
 173         struct dentry *debug_reset;
 174         struct dentry *debug_eeprom;
 175         struct dentry *debug_flash;
 176         struct mutex mutex_flash;
 177         int addr_sz;
 178 #endif
 179         u8 version[2];
 180         /* input stuff */
 181         u8 pressed_keys[2];
 182         struct input_dev *input_keys;
 183         struct input_dev *input_cir;
 184         unsigned short keycode[PICOLCD_KEYS];
 185
 186 #ifdef CONFIG_HID_PICOLCD_FB
 187         /* Framebuffer stuff */
 188         u8 fb_update_rate;
 189         u8 fb_bpp;
 190         u8 *fb_vbitmap;         /* local copy of what was sent to PicoLCD */
 191         u8 *fb_bitmap;          /* framebuffer */
 192         struct fb_info *fb_info;
 193         struct fb_deferred_io fb_defio;
 194 #endif /* CONFIG_HID_PICOLCD_FB */
 195 #ifdef CONFIG_HID_PICOLCD_LCD
 196         struct lcd_device *lcd;
 197         u8 lcd_contrast;
 198 #endif /* CONFIG_HID_PICOLCD_LCD */
 199 #ifdef CONFIG_HID_PICOLCD_BACKLIGHT
 200         struct backlight_device *backlight;
 201         u8 lcd_brightness;
 202         u8 lcd_power;
 203 #endif /* CONFIG_HID_PICOLCD_BACKLIGHT */
 204 #ifdef CONFIG_HID_PICOLCD_LEDS
 205         /* LED stuff */
 206         u8 led_state;
 207         struct led_classdev *led[8];
 208 #endif /* CONFIG_HID_PICOLCD_LEDS */
 209
 210         /* Housekeeping stuff */
 211         spinlock_t lock;
 212         struct mutex mutex;
 213         struct picolcd_pending *pending;
 214         int status;
 215 #define PICOLCD_BOOTLOADER 1
 216 #define PICOLCD_FAILED 2
 217 #define PICOLCD_READY_FB 4
 218 };
 219
 220
 221 /* Find a given report */
 222 #define picolcd_in_report(id, dev) picolcd_report(id, dev, HID_INPUT_REPORT)
 223 #define picolcd_out_report(id, dev) picolcd_report(id, dev, HID_OUTPUT_REPORT)
 224
 225 static struct hid_report *picolcd_report(int id, struct hid_device *hdev, int dir)
 226 {
 227         struct list_head *feature_report_list = &hdev->report_enum[dir].report_list;
 228         struct hid_report *report = NULL;
 229
 230         list_for_each_entry(report, feature_report_list, list) {
 231                 if (report->id == id)
 232                         return report;
 233         }
 234         dev_warn(&hdev->dev, "No report with id 0x%x found\n", id);
 235         return NULL;
 236 }
 237
 238 #ifdef CONFIG_DEBUG_FS
 239 static void picolcd_debug_out_report(struct picolcd_data *data,
 240                 struct hid_device *hdev, struct hid_report *report);
 241 #define usbhid_submit_report(a, b, c) \
 242         do { \
 243                 picolcd_debug_out_report(hid_get_drvdata(a), a, b); \
 244                 usbhid_submit_report(a, b, c); \
 245         } while (0)
 246 #endif
 247
 248 /* Submit a report and wait for a reply from device - if device fades away
 249  * or does not respond in time, return NULL */
 250 static struct picolcd_pending *picolcd_send_and_wait(struct hid_device *hdev,
 251                 int report_id, const u8 *raw_data, int size)
 252 {
 253         struct picolcd_data *data = hid_get_drvdata(hdev);
 254         struct picolcd_pending *work;
 255         struct hid_report *report = picolcd_out_report(report_id, hdev);
 256         unsigned long flags;
 257         int i, j, k;
 258
 259         if (!report || !data)
 260                 return NULL;
 261         if (data->status & PICOLCD_FAILED)
 262                 return NULL;
 263         work = kzalloc(sizeof(*work), GFP_KERNEL);
 264         if (!work)
 265                 return NULL;
 266
 267         init_completion(&work->ready);
 268         work->out_report = report;
 269         work->in_report  = NULL;
 270         work->raw_size   = 0;
 271
 272         mutex_lock(&data->mutex);
 273         spin_lock_irqsave(&data->lock, flags);
 274         for (i = k = 0; i < report->maxfield; i++)
 275                 for (j = 0; j < report->field[i]->report_count; j++) {
 276                         hid_set_field(report->field[i], j, k < size ? raw_data[k] : 0);
 277                         k++;
 278                 }
 279         data->pending = work;
 280         usbhid_submit_report(data->hdev, report, USB_DIR_OUT);
 281         spin_unlock_irqrestore(&data->lock, flags);
 282         wait_for_completion_interruptible_timeout(&work->ready, HZ*2);
 283         spin_lock_irqsave(&data->lock, flags);
 284         data->pending = NULL;
 285         spin_unlock_irqrestore(&data->lock, flags);
 286         mutex_unlock(&data->mutex);
 287         return work;
 288 }
 289
 290 #ifdef CONFIG_HID_PICOLCD_FB
 291 /* Send a given tile to PicoLCD */
 292 static int picolcd_fb_send_tile(struct hid_device *hdev, int chip, int tile)
 293 {
 294         struct picolcd_data *data = hid_get_drvdata(hdev);
 295         struct hid_report *report1 = picolcd_out_report(REPORT_LCD_CMD_DATA, hdev);
 296         struct hid_report *report2 = picolcd_out_report(REPORT_LCD_DATA, hdev);
 297         unsigned long flags;
 298         u8 *tdata;
 299         int i;
 300
 301         if (!report1 || report1->maxfield != 1 || !report2 || report2->maxfield != 1)
 302                 return -ENODEV;
 303
 304         spin_lock_irqsave(&data->lock, flags);
 305         hid_set_field(report1->field[0],  0, chip << 2);
 306         hid_set_field(report1->field[0],  1, 0x02);
 307         hid_set_field(report1->field[0],  2, 0x00);
 308         hid_set_field(report1->field[0],  3, 0x00);
 309         hid_set_field(report1->field[0],  4, 0xb8 | tile);
 310         hid_set_field(report1->field[0],  5, 0x00);
 311         hid_set_field(report1->field[0],  6, 0x00);
 312         hid_set_field(report1->field[0],  7, 0x40);
 313         hid_set_field(report1->field[0],  8, 0x00);
 314         hid_set_field(report1->field[0],  9, 0x00);
 315         hid_set_field(report1->field[0], 10,   32);
 316
 317         hid_set_field(report2->field[0],  0, (chip << 2) | 0x01);
 318         hid_set_field(report2->field[0],  1, 0x00);
 319         hid_set_field(report2->field[0],  2, 0x00);
 320         hid_set_field(report2->field[0],  3,   32);
 321
 322         tdata = data->fb_vbitmap + (tile * 4 + chip) * 64;
 323         for (i = 0; i < 64; i++)
 324                 if (i < 32)
 325                         hid_set_field(report1->field[0], 11 + i, tdata[i]);
 326                 else
 327                         hid_set_field(report2->field[0], 4 + i - 32, tdata[i]);
 328
 329         usbhid_submit_report(data->hdev, report1, USB_DIR_OUT);
 330         usbhid_submit_report(data->hdev, report2, USB_DIR_OUT);
 331         spin_unlock_irqrestore(&data->lock, flags);
 332         return 0;
 333 }
 334
 335 /* Translate a single tile*/
 336 static int picolcd_fb_update_tile(u8 *vbitmap, const u8 *bitmap, int bpp,
 337                 int chip, int tile)
 338 {
 339         int i, b, changed = 0;
 340         u8 tdata[64];
 341         u8 *vdata = vbitmap + (tile * 4 + chip) * 64;
 342
 343         if (bpp == 1) {
 344                 for (b = 7; b >= 0; b--) {
 345                         const u8 *bdata = bitmap + tile * 256 + chip * 8 + b * 32;
 346                         for (i = 0; i < 64; i++) {
 347                                 tdata[i] <<= 1;
 348                                 tdata[i] |= (bdata[i/8] >> (7 - i % 8)) & 0x01;
 349                         }
 350                 }
 351         } else if (bpp == 8) {
 352                 for (b = 7; b >= 0; b--) {
 353                         const u8 *bdata = bitmap + (tile * 256 + chip * 8 + b * 32) * 8;
 354                         for (i = 0; i < 64; i++) {
 355                                 tdata[i] <<= 1;
 356                                 tdata[i] |= (bdata[i] & 0x80) ? 0x01 : 0x00;
 357                         }
 358                 }
 359         } else {
 360                 /* Oops, we should never get here! */
 361                 WARN_ON(1);
 362                 return 0;
 363         }
 364
 365         for (i = 0; i < 64; i++)
 366                 if (tdata[i] != vdata[i]) {
 367                         changed = 1;
 368                         vdata[i] = tdata[i];
 369                 }
 370         return changed;
 371 }
 372
 373 /* Reconfigure LCD display */
 374 static int picolcd_fb_reset(struct picolcd_data *data, int clear)
 375 {
 376         struct hid_report *report = picolcd_out_report(REPORT_LCD_CMD, data->hdev);
 377         int i, j;
 378         unsigned long flags;
 379         static const u8 mapcmd[8] = { 0x00, 0x02, 0x00, 0x64, 0x3f, 0x00, 0x64, 0xc0 };
 380
 381         if (!report || report->maxfield != 1)
 382                 return -ENODEV;
 383
 384         spin_lock_irqsave(&data->lock, flags);
 385         for (i = 0; i < 4; i++) {
 386                 for (j = 0; j < report->field[0]->maxusage; j++)
 387                         if (j == 0)
 388                                 hid_set_field(report->field[0], j, i << 2);
 389                         else if (j < sizeof(mapcmd))
 390                                 hid_set_field(report->field[0], j, mapcmd[j]);
 391                         else
 392                                 hid_set_field(report->field[0], j, 0);
 393                 usbhid_submit_report(data->hdev, report, USB_DIR_OUT);
 394         }
 395
 396         data->status |= PICOLCD_READY_FB;
 397         spin_unlock_irqrestore(&data->lock, flags);
 398
 399         if (data->fb_bitmap) {
 400                 if (clear) {
 401                         memset(data->fb_vbitmap, 0xff, PICOLCDFB_SIZE);
 402                         memset(data->fb_bitmap, 0, PICOLCDFB_SIZE*data->fb_bpp);
 403                 } else {
 404                         /* invert 1 byte in each tile to force resend */
 405                         for (i = 0; i < PICOLCDFB_SIZE; i += 64)
 406                                 data->fb_vbitmap[i] = ~data->fb_vbitmap[i];
 407                 }
 408         }
 409
 410         /* schedule first output of framebuffer */
 411         if (data->fb_info)
 412                 schedule_delayed_work(&data->fb_info->deferred_work, 0);
 413
 414         return 0;
 415 }
 416
 417 /* Update fb_vbitmap from the screen_base and send changed tiles to device */
 418 static void picolcd_fb_update(struct picolcd_data *data)
 419 {
 420         int chip, tile, n;
 421         unsigned long flags;
 422
 423         spin_lock_irqsave(&data->lock, flags);
 424         if (!(data->status & PICOLCD_READY_FB)) {
 425                 spin_unlock_irqrestore(&data->lock, flags);
 426                 picolcd_fb_reset(data, 0);
 427         } else {
 428                 spin_unlock_irqrestore(&data->lock, flags);
 429         }
 430
 431         /*
 432          * Translate the framebuffer into the format needed by the PicoLCD.
 433          * See display layout above.
 434          * Do this one tile after the other and push those tiles that changed.
 435          *
 436          * Wait for our IO to complete as otherwise we might flood the queue!
 437          */
 438         n = 0;
 439         for (chip = 0; chip < 4; chip++)
 440                 for (tile = 0; tile < 8; tile++)
 441                         if (picolcd_fb_update_tile(data->fb_vbitmap,
 442                                         data->fb_bitmap, data->fb_bpp, chip, tile)) {
 443                                 n += 2;
 444                                 if (n >= HID_OUTPUT_FIFO_SIZE / 2) {
 445                                         usbhid_wait_io(data->hdev);
 446                                         n = 0;
 447                                 }
 448                                 picolcd_fb_send_tile(data->hdev, chip, tile);
 449                         }
 450         if (n)
 451                 usbhid_wait_io(data->hdev);
 452 }
 453
 454 /* Stub to call the system default and update the image on the picoLCD */
 455 static void picolcd_fb_fillrect(struct fb_info *info,
 456                 const struct fb_fillrect *rect)
 457 {
 458         if (!info->par)
 459                 return;
 460         sys_fillrect(info, rect);
 461
 462         schedule_delayed_work(&info->deferred_work, 0);
 463 }
 464
 465 /* Stub to call the system default and update the image on the picoLCD */
 466 static void picolcd_fb_copyarea(struct fb_info *info,
 467                 const struct fb_copyarea *area)
 468 {
 469         if (!info->par)
 470                 return;
 471         sys_copyarea(info, area);
 472
 473         schedule_delayed_work(&info->deferred_work, 0);
 474 }
 475
 476 /* Stub to call the system default and update the image on the picoLCD */
 477 static void picolcd_fb_imageblit(struct fb_info *info, const struct fb_image *image)
 478 {
 479         if (!info->par)
 480                 return;
 481         sys_imageblit(info, image);
 482
 483         schedule_delayed_work(&info->deferred_work, 0);
 484 }
 485
 486 /*
 487  * this is the slow path from userspace. they can seek and write to
 488  * the fb. it's inefficient to do anything less than a full screen draw
 489  */
 490 static ssize_t picolcd_fb_write(struct fb_info *info, const char __user *buf,
 491                 size_t count, loff_t *ppos)
 492 {
 493         ssize_t ret;
 494         if (!info->par)
 495                 return -ENODEV;
 496         ret = fb_sys_write(info, buf, count, ppos);
 497         if (ret >= 0)
 498                 schedule_delayed_work(&info->deferred_work, 0);
 499         return ret;
 500 }
 501
 502 static int picolcd_fb_blank(int blank, struct fb_info *info)
 503 {
 504         if (!info->par)
 505                 return -ENODEV;
 506         /* We let fb notification do this for us via lcd/backlight device */
 507         return 0;
 508 }
 509
 510 static void picolcd_fb_destroy(struct fb_info *info)
 511 {
 512         struct picolcd_data *data = info->par;
 513         info->par = NULL;
 514         if (data)
 515                 data->fb_info = NULL;
 516         fb_deferred_io_cleanup(info);
 517         framebuffer_release(info);
 518 }
 519
 520 static int picolcd_fb_check_var(struct fb_var_screeninfo *var, struct fb_info *info)
 521 {
 522         __u32 bpp      = var->bits_per_pixel;
 523         __u32 activate = var->activate;
 524
 525         /* only allow 1/8 bit depth (8-bit is grayscale) */
 526         *var = picolcdfb_var;
 527         var->activate = activate;
 528         if (bpp >= 8)
 529                 var->bits_per_pixel = 8;
 530         else
 531                 var->bits_per_pixel = 1;
 532         return 0;
 533 }
 534
 535 static int picolcd_set_par(struct fb_info *info)
 536 {
 537         struct picolcd_data *data = info->par;
 538         u8 *o_fb, *n_fb;
 539         if (info->var.bits_per_pixel == data->fb_bpp)
 540                 return 0;
 541         /* switch between 1/8 bit depths */
 542         if (info->var.bits_per_pixel != 1 && info->var.bits_per_pixel != 8)
 543                 return -EINVAL;
 544
 545         o_fb = data->fb_bitmap;
 546         n_fb = vmalloc(PICOLCDFB_SIZE*info->var.bits_per_pixel);
 547         if (!n_fb)
 548                 return -ENOMEM;
 549
 550         fb_deferred_io_cleanup(info);
 551         /* translate FB content to new bits-per-pixel */
 552         if (info->var.bits_per_pixel == 1) {
 553                 int i, b;
 554                 for (i = 0; i < PICOLCDFB_SIZE; i++) {
 555                         u8 p = 0;
 556                         for (b = 0; b < 8; b++) {
 557                                 p <<= 1;
 558                                 p |= o_fb[i*8+b] ? 0x01 : 0x00;
 559                         }
 560                 }
 561                 info->fix.visual = FB_VISUAL_MONO01;
 562                 info->fix.line_length = PICOLCDFB_WIDTH / 8;
 563         } else {
 564                 int i;
 565                 for (i = 0; i < PICOLCDFB_SIZE * 8; i++)
 566                         n_fb[i] = o_fb[i/8] & (0x01 << (7 - i % 8)) ? 0xff : 0x00;
 567                 info->fix.visual = FB_VISUAL_TRUECOLOR;
 568                 info->fix.line_length = PICOLCDFB_WIDTH;
 569         }
 570
 571         data->fb_bitmap   = n_fb;
 572         data->fb_bpp      = info->var.bits_per_pixel;
 573         info->screen_base = (char __force __iomem *)n_fb;
 574         info->fix.smem_start = (unsigned long)n_fb;
 575         info->fix.smem_len   = PICOLCDFB_SIZE*data->fb_bpp;
 576         fb_deferred_io_init(info);
 577         vfree(o_fb);
 578         return 0;
 579 }
 580
 581 /* Note this can't be const because of struct fb_info definition */
 582 static struct fb_ops picolcdfb_ops = {
 583         .owner        = THIS_MODULE,
 584         .fb_destroy   = picolcd_fb_destroy,
 585         .fb_read      = fb_sys_read,
 586         .fb_write     = picolcd_fb_write,
 587         .fb_blank     = picolcd_fb_blank,
 588         .fb_fillrect  = picolcd_fb_fillrect,
 589         .fb_copyarea  = picolcd_fb_copyarea,
 590         .fb_imageblit = picolcd_fb_imageblit,
 591         .fb_check_var = picolcd_fb_check_var,
 592         .fb_set_par   = picolcd_set_par,
 593 };
 594
 595
 596 /* Callback from deferred IO workqueue */
 597 static void picolcd_fb_deferred_io(struct fb_info *info, struct list_head *pagelist)
 598 {
 599         picolcd_fb_update(info->par);
 600 }
 601
 602 static const struct fb_deferred_io picolcd_fb_defio = {
 603         .delay = HZ / PICOLCDFB_UPDATE_RATE_DEFAULT,
 604         .deferred_io = picolcd_fb_deferred_io,
 605 };
 606
 607
 608 /*
 609  * The "fb_update_rate" sysfs attribute
 610  */
 611 static ssize_t picolcd_fb_update_rate_show(struct device *dev,
 612                 struct device_attribute *attr, char *buf)
 613 {
 614         struct picolcd_data *data = dev_get_drvdata(dev);
 615         unsigned i, fb_update_rate = data->fb_update_rate;
 616         size_t ret = 0;
 617
 618         for (i = 1; i <= PICOLCDFB_UPDATE_RATE_LIMIT; i++)
 619                 if (ret >= PAGE_SIZE)
 620                         break;
 621                 else if (i == fb_update_rate)
 622                         ret += snprintf(buf+ret, PAGE_SIZE-ret, "[%u] ", i);
 623                 else
 624                         ret += snprintf(buf+ret, PAGE_SIZE-ret, "%u ", i);
 625         if (ret > 0)
 626                 buf[min(ret, (size_t)PAGE_SIZE)-1] = '\n';
 627         return ret;
 628 }
 629
 630 static ssize_t picolcd_fb_update_rate_store(struct device *dev,
 631                 struct device_attribute *attr, const char *buf, size_t count)
 632 {
 633         struct picolcd_data *data = dev_get_drvdata(dev);
 634         int i;
 635         unsigned u;
 636
 637         if (count < 1 || count > 10)
 638                 return -EINVAL;
 639
 640         i = sscanf(buf, "%u", &u);
 641         if (i != 1)
 642                 return -EINVAL;
 643
 644         if (u > PICOLCDFB_UPDATE_RATE_LIMIT)
 645                 return -ERANGE;
 646         else if (u == 0)
 647                 u = PICOLCDFB_UPDATE_RATE_DEFAULT;
 648
 649         data->fb_update_rate = u;
 650         data->fb_defio.delay = HZ / data->fb_update_rate;
 651         return count;
 652 }
 653
 654 static DEVICE_ATTR(fb_update_rate, 0666, picolcd_fb_update_rate_show,
 655                 picolcd_fb_update_rate_store);
 656
 657 /* initialize Framebuffer device */
 658 static int picolcd_init_framebuffer(struct picolcd_data *data)
 659 {
 660         struct device *dev = &data->hdev->dev;
 661         struct fb_info *info = NULL;
 662         int error = -ENOMEM;
 663         u8 *fb_vbitmap = NULL;
 664         u8 *fb_bitmap  = NULL;
 665
 666         fb_bitmap = vmalloc(PICOLCDFB_SIZE*picolcdfb_var.bits_per_pixel);
 667         if (fb_bitmap == NULL) {
 668                 dev_err(dev, "can't get a free page for framebuffer\n");
 669                 goto err_nomem;
 670         }
 671
 672         fb_vbitmap = kmalloc(PICOLCDFB_SIZE, GFP_KERNEL);
 673         if (fb_vbitmap == NULL) {
 674                 dev_err(dev, "can't alloc vbitmap image buffer\n");
 675                 goto err_nomem;
 676         }
 677
 678         data->fb_update_rate = PICOLCDFB_UPDATE_RATE_DEFAULT;
 679         data->fb_defio = picolcd_fb_defio;
 680         info = framebuffer_alloc(0, dev);
 681         if (info == NULL) {
 682                 dev_err(dev, "failed to allocate a framebuffer\n");
 683                 goto err_nomem;
 684         }
 685
 686         info->fbdefio = &data->fb_defio;
 687         info->screen_base = (char __force __iomem *)fb_bitmap;
 688         info->fbops = &picolcdfb_ops;
 689         info->var = picolcdfb_var;
 690         info->fix = picolcdfb_fix;
 691         info->fix.smem_len   = PICOLCDFB_SIZE;
 692         info->fix.smem_start = (unsigned long)fb_bitmap;
 693         info->par = data;
 694         info->flags = FBINFO_FLAG_DEFAULT;
 695
 696         data->fb_vbitmap = fb_vbitmap;
 697         data->fb_bitmap  = fb_bitmap;
 698         data->fb_bpp     = picolcdfb_var.bits_per_pixel;
 699         error = picolcd_fb_reset(data, 1);
 700         if (error) {
 701                 dev_err(dev, "failed to configure display\n");
 702                 goto err_cleanup;
 703         }
 704         error = device_create_file(dev, &dev_attr_fb_update_rate);
 705         if (error) {
 706                 dev_err(dev, "failed to create sysfs attributes\n");
 707                 goto err_cleanup;
 708         }
 709         data->fb_info    = info;
 710         error = register_framebuffer(info);
 711         if (error) {
 712                 dev_err(dev, "failed to register framebuffer\n");
 713                 goto err_sysfs;
 714         }
 715         fb_deferred_io_init(info);
 716         /* schedule first output of framebuffer */
 717         schedule_delayed_work(&info->deferred_work, 0);
 718         return 0;
 719
 720 err_sysfs:
 721         device_remove_file(dev, &dev_attr_fb_update_rate);
 722 err_cleanup:
 723         data->fb_vbitmap = NULL;
 724         data->fb_bitmap  = NULL;
 725         data->fb_bpp     = 0;
 726         data->fb_info    = NULL;
 727
 728 err_nomem:
 729         framebuffer_release(info);
 730         vfree(fb_bitmap);
 731         kfree(fb_vbitmap);
 732         return error;
 733 }
 734
 735 static void picolcd_exit_framebuffer(struct picolcd_data *data)
 736 {
 737         struct fb_info *info = data->fb_info;
 738         u8 *fb_vbitmap = data->fb_vbitmap;
 739         u8 *fb_bitmap  = data->fb_bitmap;
 740
 741         if (!info)
 742                 return;
 743
 744         data->fb_vbitmap = NULL;
 745         data->fb_bitmap  = NULL;
 746         data->fb_bpp     = 0;
 747         data->fb_info    = NULL;
 748         device_remove_file(&data->hdev->dev, &dev_attr_fb_update_rate);
 749         fb_deferred_io_cleanup(info);
 750         unregister_framebuffer(info);
 751         vfree(fb_bitmap);
 752         kfree(fb_vbitmap);
 753 }
 754
 755 #define picolcd_fbinfo(d) ((d)->fb_info)
 756 #else
 757 static inline int picolcd_fb_reset(struct picolcd_data *data, int clear)
 758 {
 759         return 0;
 760 }
 761 static inline int picolcd_init_framebuffer(struct picolcd_data *data)
 762 {
 763         return 0;
 764 }
 765 static void picolcd_exit_framebuffer(struct picolcd_data *data)
 766 {
 767 }
 768 #define picolcd_fbinfo(d) NULL
 769 #endif /* CONFIG_HID_PICOLCD_FB */
 770
 771 #ifdef CONFIG_HID_PICOLCD_BACKLIGHT
 772 /*
 773  * backlight class device
 774  */
 775 static int picolcd_get_brightness(struct backlight_device *bdev)
 776 {
 777         struct picolcd_data *data = bl_get_data(bdev);
 778         return data->lcd_brightness;
 779 }
 780
 781 static int picolcd_set_brightness(struct backlight_device *bdev)
 782 {
 783         struct picolcd_data *data = bl_get_data(bdev);
 784         struct hid_report *report = picolcd_out_report(REPORT_BRIGHTNESS, data->hdev);
 785         unsigned long flags;
 786
 787         if (!report || report->maxfield != 1 || report->field[0]->report_count != 1)
 788                 return -ENODEV;
 789
 790         data->lcd_brightness = bdev->props.brightness & 0x0ff;
 791         data->lcd_power      = bdev->props.power;
 792         spin_lock_irqsave(&data->lock, flags);
 793         hid_set_field(report->field[0], 0, data->lcd_power == FB_BLANK_UNBLANK ? data->lcd_brightness : 0);
 794         usbhid_submit_report(data->hdev, report, USB_DIR_OUT);
 795         spin_unlock_irqrestore(&data->lock, flags);
 796         return 0;
 797 }
 798
 799 static int picolcd_check_bl_fb(struct backlight_device *bdev, struct fb_info *fb)
 800 {
 801         return fb && fb == picolcd_fbinfo((struct picolcd_data *)bl_get_data(bdev));
 802 }
 803
 804 static const struct backlight_ops picolcd_blops = {
 805         .update_status  = picolcd_set_brightness,
 806         .get_brightness = picolcd_get_brightness,
 807         .check_fb       = picolcd_check_bl_fb,
 808 };
 809
 810 static int picolcd_init_backlight(struct picolcd_data *data, struct hid_report *report)
 811 {
 812         struct device *dev = &data->hdev->dev;
 813         struct backlight_device *bdev;
 814         struct backlight_properties props;
 815         if (!report)
 816                 return -ENODEV;
 817         if (report->maxfield != 1 || report->field[0]->report_count != 1 ||
 818                         report->field[0]->report_size != 8) {
 819                 dev_err(dev, "unsupported BRIGHTNESS report");
 820                 return -EINVAL;
 821         }
 822
 823         memset(&props, 0, sizeof(props));
 824         props.max_brightness = 0xff;
 825         bdev = backlight_device_register(dev_name(dev), dev, data,
 826                         &picolcd_blops, &props);
 827         if (IS_ERR(bdev)) {
 828                 dev_err(dev, "failed to register backlight\n");
 829                 return PTR_ERR(bdev);
 830         }
 831         bdev->props.brightness     = 0xff;
 832         data->lcd_brightness       = 0xff;
 833         data->backlight            = bdev;
 834         picolcd_set_brightness(bdev);
 835         return 0;
 836 }
 837
 838 static void picolcd_exit_backlight(struct picolcd_data *data)
 839 {
 840         struct backlight_device *bdev = data->backlight;
 841
 842         data->backlight = NULL;
 843         if (bdev)
 844                 backlight_device_unregister(bdev);
 845 }
 846
 847 static inline int picolcd_resume_backlight(struct picolcd_data *data)
 848 {
 849         if (!data->backlight)
 850                 return 0;
 851         return picolcd_set_brightness(data->backlight);
 852 }
 853
 854 #else
 855 static inline int picolcd_init_backlight(struct picolcd_data *data,
 856                 struct hid_report *report)
 857 {
 858         return 0;
 859 }
 860 static inline void picolcd_exit_backlight(struct picolcd_data *data)
 861 {
 862 }
 863 static inline int picolcd_resume_backlight(struct picolcd_data *data)
 864 {
 865         return 0;
 866 }
 867 #endif /* CONFIG_HID_PICOLCD_BACKLIGHT */
 868
 869 #ifdef CONFIG_HID_PICOLCD_LCD
 870 /*
 871  * lcd class device
 872  */
 873 static int picolcd_get_contrast(struct lcd_device *ldev)
 874 {
 875         struct picolcd_data *data = lcd_get_data(ldev);
 876         return data->lcd_contrast;
 877 }
 878
 879 static int picolcd_set_contrast(struct lcd_device *ldev, int contrast)
 880 {
 881         struct picolcd_data *data = lcd_get_data(ldev);
 882         struct hid_report *report = picolcd_out_report(REPORT_CONTRAST, data->hdev);
 883         unsigned long flags;
 884
 885         if (!report || report->maxfield != 1 || report->field[0]->report_count != 1)
 886                 return -ENODEV;
 887
 888         data->lcd_contrast = contrast & 0x0ff;
 889         spin_lock_irqsave(&data->lock, flags);
 890         hid_set_field(report->field[0], 0, data->lcd_contrast);
 891         usbhid_submit_report(data->hdev, report, USB_DIR_OUT);
 892         spin_unlock_irqrestore(&data->lock, flags);
 893         return 0;
 894 }
 895
 896 static int picolcd_check_lcd_fb(struct lcd_device *ldev, struct fb_info *fb)
 897 {
 898         return fb && fb == picolcd_fbinfo((struct picolcd_data *)lcd_get_data(ldev));
 899 }
 900
 901 static struct lcd_ops picolcd_lcdops = {
 902         .get_contrast   = picolcd_get_contrast,
 903         .set_contrast   = picolcd_set_contrast,
 904         .check_fb       = picolcd_check_lcd_fb,
 905 };
 906
 907 static int picolcd_init_lcd(struct picolcd_data *data, struct hid_report *report)
 908 {
 909         struct device *dev = &data->hdev->dev;
 910         struct lcd_device *ldev;
 911
 912         if (!report)
 913                 return -ENODEV;
 914         if (report->maxfield != 1 || report->field[0]->report_count != 1 ||
 915                         report->field[0]->report_size != 8) {
 916                 dev_err(dev, "unsupported CONTRAST report");
 917                 return -EINVAL;
 918         }
 919
 920         ldev = lcd_device_register(dev_name(dev), dev, data, &picolcd_lcdops);
 921         if (IS_ERR(ldev)) {
 922                 dev_err(dev, "failed to register LCD\n");
 923                 return PTR_ERR(ldev);
 924         }
 925         ldev->props.max_contrast = 0x0ff;
 926         data->lcd_contrast = 0xe5;
 927         data->lcd = ldev;
 928         picolcd_set_contrast(ldev, 0xe5);
 929         return 0;
 930 }
 931
 932 static void picolcd_exit_lcd(struct picolcd_data *data)
 933 {
 934         struct lcd_device *ldev = data->lcd;
 935
 936         data->lcd = NULL;
 937         if (ldev)
 938                 lcd_device_unregister(ldev);
 939 }
 940
 941 static inline int picolcd_resume_lcd(struct picolcd_data *data)
 942 {
 943         if (!data->lcd)
 944                 return 0;
 945         return picolcd_set_contrast(data->lcd, data->lcd_contrast);
 946 }
 947 #else
 948 static inline int picolcd_init_lcd(struct picolcd_data *data,
 949                 struct hid_report *report)
 950 {
 951         return 0;
 952 }
 953 static inline void picolcd_exit_lcd(struct picolcd_data *data)
 954 {
 955 }
 956 static inline int picolcd_resume_lcd(struct picolcd_data *data)
 957 {
 958         return 0;
 959 }
 960 #endif /* CONFIG_HID_PICOLCD_LCD */
 961
 962 #ifdef CONFIG_HID_PICOLCD_LEDS
 963 /**
 964  * LED class device
 965  */
 966 static void picolcd_leds_set(struct picolcd_data *data)
 967 {
 968         struct hid_report *report;
 969         unsigned long flags;
 970
 971         if (!data->led[0])
 972                 return;
 973         report = picolcd_out_report(REPORT_LED_STATE, data->hdev);
 974         if (!report || report->maxfield != 1 || report->field[0]->report_count != 1)
 975                 return;
 976
 977         spin_lock_irqsave(&data->lock, flags);
 978         hid_set_field(report->field[0], 0, data->led_state);
 979         usbhid_submit_report(data->hdev, report, USB_DIR_OUT);
 980         spin_unlock_irqrestore(&data->lock, flags);
 981 }
 982
 983 static void picolcd_led_set_brightness(struct led_classdev *led_cdev,
 984                         enum led_brightness value)
 985 {
 986         struct device *dev;
 987         struct hid_device *hdev;
 988         struct picolcd_data *data;
 989         int i, state = 0;
 990
 991         dev  = led_cdev->dev->parent;
 992         hdev = container_of(dev, struct hid_device, dev);
 993         data = hid_get_drvdata(hdev);
 994         for (i = 0; i < 8; i++) {
 995                 if (led_cdev != data->led[i])
 996                         continue;
 997                 state = (data->led_state >> i) & 1;
 998                 if (value == LED_OFF && state) {
 999                         data->led_state &= ~(1 << i);
1000                         picolcd_leds_set(data);
1001                 } else if (value != LED_OFF && !state) {
1002                         data->led_state |= 1 << i;
1003                         picolcd_leds_set(data);
1004                 }
1005                 break;
1006         }
1007 }
1008
1009 static enum led_brightness picolcd_led_get_brightness(struct led_classdev *led_cdev)
1010 {
1011         struct device *dev;
1012         struct hid_device *hdev;
1013         struct picolcd_data *data;
1014         int i, value = 0;
1015
1016         dev  = led_cdev->dev->parent;
1017         hdev = container_of(dev, struct hid_device, dev);
1018         data = hid_get_drvdata(hdev);
1019         for (i = 0; i < 8; i++)
1020                 if (led_cdev == data->led[i]) {
1021                         value = (data->led_state >> i) & 1;
1022                         break;
1023                 }
1024         return value ? LED_FULL : LED_OFF;
1025 }
1026
1027 static int picolcd_init_leds(struct picolcd_data *data, struct hid_report *report)
1028 {
1029         struct device *dev = &data->hdev->dev;
1030         struct led_classdev *led;
1031         size_t name_sz = strlen(dev_name(dev)) + 8;
1032         char *name;
1033         int i, ret = 0;
1034
1035         if (!report)
1036                 return -ENODEV;
1037         if (report->maxfield != 1 || report->field[0]->report_count != 1 ||
1038                         report->field[0]->report_size != 8) {
1039                 dev_err(dev, "unsupported LED_STATE report");
1040                 return -EINVAL;
1041         }
1042
1043         for (i = 0; i < 8; i++) {
1044                 led = kzalloc(sizeof(struct led_classdev)+name_sz, GFP_KERNEL);
1045                 if (!led) {
1046                         dev_err(dev, "can't allocate memory for LED %d\n", i);
1047                         ret = -ENOMEM;
1048                         goto err;
1049                 }
1050                 name = (void *)(&led[1]);
1051                 snprintf(name, name_sz, "%s::GPO%d", dev_name(dev), i);
1052                 led->name = name;
1053                 led->brightness = 0;
1054                 led->max_brightness = 1;
1055                 led->brightness_get = picolcd_led_get_brightness;
1056                 led->brightness_set = picolcd_led_set_brightness;
1057
1058                 data->led[i] = led;
1059                 ret = led_classdev_register(dev, data->led[i]);
1060                 if (ret) {
1061                         data->led[i] = NULL;
1062                         kfree(led);
1063                         dev_err(dev, "can't register LED %d\n", i);
1064                         goto err;
1065                 }
1066         }
1067         return 0;
1068 err:
1069         for (i = 0; i < 8; i++)
1070                 if (data->led[i]) {
1071                         led = data->led[i];
1072                         data->led[i] = NULL;
1073                         led_classdev_unregister(led);
1074                         kfree(led);
1075                 }
1076         return ret;
1077 }
1078
1079 static void picolcd_exit_leds(struct picolcd_data *data)
1080 {
1081         struct led_classdev *led;
1082         int i;
1083
1084         for (i = 0; i < 8; i++) {
1085                 led = data->led[i];
1086                 data->led[i] = NULL;
1087                 if (!led)
1088                         continue;
1089                 led_classdev_unregister(led);
1090                 kfree(led);
1091         }
1092 }
1093
1094 #else
1095 static inline int picolcd_init_leds(struct picolcd_data *data,
1096                 struct hid_report *report)
1097 {
1098         return 0;
1099 }
1100 static void picolcd_exit_leds(struct picolcd_data *data)
1101 {
1102 }
1103 static inline int picolcd_leds_set(struct picolcd_data *data)
1104 {
1105         return 0;
1106 }
1107 #endif /* CONFIG_HID_PICOLCD_LEDS */
1108
1109 /*
1110  * input class device
1111  */
1112 static int picolcd_raw_keypad(struct picolcd_data *data,
1113                 struct hid_report *report, u8 *raw_data, int size)
1114 {
1115         /*
1116          * Keypad event
1117          * First and second data bytes list currently pressed keys,
1118          * 0x00 means no key and at most 2 keys may be pressed at same time
1119          */
1120         int i, j;
1121
1122         /* determine newly pressed keys */
1123         for (i = 0; i < size; i++) {
1124                 unsigned int key_code;
1125                 if (raw_data[i] == 0)
1126                         continue;
1127                 for (j = 0; j < sizeof(data->pressed_keys); j++)
1128                         if (data->pressed_keys[j] == raw_data[i])
1129                                 goto key_already_down;
1130                 for (j = 0; j < sizeof(data->pressed_keys); j++)
1131                         if (data->pressed_keys[j] == 0) {
1132                                 data->pressed_keys[j] = raw_data[i];
1133                                 break;
1134                         }
1135                 input_event(data->input_keys, EV_MSC, MSC_SCAN, raw_data[i]);
1136                 if (raw_data[i] < PICOLCD_KEYS)
1137                         key_code = data->keycode[raw_data[i]];
1138                 else
1139                         key_code = KEY_UNKNOWN;
1140                 if (key_code != KEY_UNKNOWN) {
1141                         dbg_hid(PICOLCD_NAME " got key press for %u:%d",
1142                                         raw_data[i], key_code);
1143                         input_report_key(data->input_keys, key_code, 1);
1144                 }
1145                 input_sync(data->input_keys);
1146 key_already_down:
1147                 continue;
1148         }
1149
1150         /* determine newly released keys */
1151         for (j = 0; j < sizeof(data->pressed_keys); j++) {
1152                 unsigned int key_code;
1153                 if (data->pressed_keys[j] == 0)
1154                         continue;
1155                 for (i = 0; i < size; i++)
1156                         if (data->pressed_keys[j] == raw_data[i])
1157                                 goto key_still_down;
1158                 input_event(data->input_keys, EV_MSC, MSC_SCAN, data->pressed_keys[j]);
1159                 if (data->pressed_keys[j] < PICOLCD_KEYS)
1160                         key_code = data->keycode[data->pressed_keys[j]];
1161                 else
1162                         key_code = KEY_UNKNOWN;
1163                 if (key_code != KEY_UNKNOWN) {
1164                         dbg_hid(PICOLCD_NAME " got key release for %u:%d",
1165                                         data->pressed_keys[j], key_code);
1166                         input_report_key(data->input_keys, key_code, 0);
1167                 }
1168                 input_sync(data->input_keys);
1169                 data->pressed_keys[j] = 0;
1170 key_still_down:
1171                 continue;
1172         }
1173         return 1;
1174 }
1175
1176 static int picolcd_raw_cir(struct picolcd_data *data,
1177                 struct hid_report *report, u8 *raw_data, int size)
1178 {
1179         /* Need understanding of CIR data format to implement ... */
1180         return 1;
1181 }
1182
1183 static int picolcd_check_version(struct hid_device *hdev)
1184 {
1185         struct picolcd_data *data = hid_get_drvdata(hdev);
1186         struct picolcd_pending *verinfo;
1187         int ret = 0;
1188
1189         if (!data)
1190                 return -ENODEV;
1191
1192         verinfo = picolcd_send_and_wait(hdev, REPORT_VERSION, NULL, 0);
1193         if (!verinfo) {
1194                 dev_err(&hdev->dev, "no version response from PicoLCD");
1195                 return -ENODEV;
1196         }
1197
1198         if (verinfo->raw_size == 2) {
1199                 data->version[0] = verinfo->raw_data[1];
1200                 data->version[1] = verinfo->raw_data[0];
1201                 if (data->status & PICOLCD_BOOTLOADER) {
1202                         dev_info(&hdev->dev, "PicoLCD, bootloader version %d.%d\n",
1203                                         verinfo->raw_data[1], verinfo->raw_data[0]);
1204                 } else {
1205                         dev_info(&hdev->dev, "PicoLCD, firmware version %d.%d\n",
1206                                         verinfo->raw_data[1], verinfo->raw_data[0]);
1207                 }
1208         } else {
1209                 dev_err(&hdev->dev, "confused, got unexpected version response from PicoLCD\n");
1210                 ret = -EINVAL;
1211         }
1212         kfree(verinfo);
1213         return ret;
1214 }
1215
1216 /*
1217  * Reset our device and wait for answer to VERSION request
1218  */
1219 static int picolcd_reset(struct hid_device *hdev)
1220 {
1221         struct picolcd_data *data = hid_get_drvdata(hdev);
1222         struct hid_report *report = picolcd_out_report(REPORT_RESET, hdev);
1223         unsigned long flags;
1224         int error;
1225
1226         if (!data || !report || report->maxfield != 1)
1227                 return -ENODEV;
1228
1229         spin_lock_irqsave(&data->lock, flags);
1230         if (hdev->product == USB_DEVICE_ID_PICOLCD_BOOTLOADER)
1231                 data->status |= PICOLCD_BOOTLOADER;
1232
1233         /* perform the reset */
1234         hid_set_field(report->field[0], 0, 1);
1235         usbhid_submit_report(hdev, report, USB_DIR_OUT);
1236         spin_unlock_irqrestore(&data->lock, flags);
1237
1238         error = picolcd_check_version(hdev);
1239         if (error)
1240                 return error;
1241
1242         picolcd_resume_lcd(data);
1243         picolcd_resume_backlight(data);
1244 #ifdef CONFIG_HID_PICOLCD_FB
1245         if (data->fb_info)
1246                 schedule_delayed_work(&data->fb_info->deferred_work, 0);
1247 #endif /* CONFIG_HID_PICOLCD_FB */
1248
1249         picolcd_leds_set(data);
1250         return 0;
1251 }
1252
1253 /*
1254  * The "operation_mode" sysfs attribute
1255  */
1256 static ssize_t picolcd_operation_mode_show(struct device *dev,
1257                 struct device_attribute *attr, char *buf)
1258 {
1259         struct picolcd_data *data = dev_get_drvdata(dev);
1260
1261         if (data->status & PICOLCD_BOOTLOADER)
1262                 return snprintf(buf, PAGE_SIZE, "[bootloader] lcd\n");
1263         else
1264                 return snprintf(buf, PAGE_SIZE, "bootloader [lcd]\n");
1265 }
1266
1267 static ssize_t picolcd_operation_mode_store(struct device *dev,
1268                 struct device_attribute *attr, const char *buf, size_t count)
1269 {
1270         struct picolcd_data *data = dev_get_drvdata(dev);
1271         struct hid_report *report = NULL;
1272         size_t cnt = count;
1273         int timeout = 5000;
1274         unsigned u;
1275         unsigned long flags;
1276
1277         if (cnt >= 3 && strncmp("lcd", buf, 3) == 0) {
1278                 if (data->status & PICOLCD_BOOTLOADER)
1279                         report = picolcd_out_report(REPORT_EXIT_FLASHER, data->hdev);
1280                 buf += 3;
1281                 cnt -= 3;
1282         } else if (cnt >= 10 && strncmp("bootloader", buf, 10) == 0) {
1283                 if (!(data->status & PICOLCD_BOOTLOADER))
1284                         report = picolcd_out_report(REPORT_EXIT_KEYBOARD, data->hdev);
1285                 buf += 10;
1286                 cnt -= 10;
1287         }
1288         if (!report)
1289                 return -EINVAL;
1290
1291         while (cnt > 0 && (*buf == ' ' || *buf == '\t')) {
1292                 buf++;
1293                 cnt--;
1294         }
1295         while (cnt > 0 && (buf[cnt-1] == '\n' || buf[cnt-1] == '\r'))
1296                 cnt--;
1297         if (cnt > 0) {
1298                 if (sscanf(buf, "%u", &u) != 1)
1299                         return -EINVAL;
1300                 if (u > 30000)
1301                         return -EINVAL;
1302                 else
1303                         timeout = u;
1304         }
1305
1306         spin_lock_irqsave(&data->lock, flags);
1307         hid_set_field(report->field[0], 0, timeout & 0xff);
1308         hid_set_field(report->field[0], 1, (timeout >> 8) & 0xff);
1309         usbhid_submit_report(data->hdev, report, USB_DIR_OUT);
1310         spin_unlock_irqrestore(&data->lock, flags);
1311         return count;
1312 }
1313
1314 static DEVICE_ATTR(operation_mode, 0644, picolcd_operation_mode_show,
1315                 picolcd_operation_mode_store);
1316
1317
1318 #ifdef CONFIG_DEBUG_FS
1319 /*
1320  * The "reset" file
1321  */
1322 static int picolcd_debug_reset_show(struct seq_file *f, void *p)
1323 {
1324         if (picolcd_fbinfo((struct picolcd_data *)f->private))
1325                 seq_printf(f, "all fb\n");
1326         else
1327                 seq_printf(f, "all\n");
1328         return 0;
1329 }
1330
1331 static int picolcd_debug_reset_open(struct inode *inode, struct file *f)
1332 {
1333         return single_open(f, picolcd_debug_reset_show, inode->i_private);
1334 }
1335
1336 static ssize_t picolcd_debug_reset_write(struct file *f, const char __user *user_buf,
1337                 size_t count, loff_t *ppos)
1338 {
1339         struct picolcd_data *data = ((struct seq_file *)f->private_data)->private;
1340         char buf[32];
1341         size_t cnt = min(count, sizeof(buf)-1);
1342         if (copy_from_user(buf, user_buf, cnt))
1343                 return -EFAULT;
1344
1345         while (cnt > 0 && (buf[cnt-1] == ' ' || buf[cnt-1] == '\n'))
1346                 cnt--;
1347         buf[cnt] = '\0';
1348         if (strcmp(buf, "all") == 0) {
1349                 picolcd_reset(data->hdev);
1350                 picolcd_fb_reset(data, 1);
1351         } else if (strcmp(buf, "fb") == 0) {
1352                 picolcd_fb_reset(data, 1);
1353         } else {
1354                 return -EINVAL;
1355         }
1356         return count;
1357 }
1358
1359 static const struct file_operations picolcd_debug_reset_fops = {
1360         .owner    = THIS_MODULE,
1361         .open     = picolcd_debug_reset_open,
1362         .read     = seq_read,
1363         .llseek   = seq_lseek,
1364         .write    = picolcd_debug_reset_write,
1365         .release  = single_release,
1366 };
1367
1368 /*
1369  * The "eeprom" file
1370  */
1371 static int picolcd_debug_eeprom_open(struct inode *i, struct file *f)
1372 {
1373         f->private_data = i->i_private;
1374         return 0;
1375 }
1376
1377 static ssize_t picolcd_debug_eeprom_read(struct file *f, char __user *u,
1378                 size_t s, loff_t *off)
1379 {
1380         struct picolcd_data *data = f->private_data;
1381         struct picolcd_pending *resp;
1382         u8 raw_data[3];
1383         ssize_t ret = -EIO;
1384
1385         if (s == 0)
1386                 return -EINVAL;
1387         if (*off > 0x0ff)
1388                 return 0;
1389
1390         /* prepare buffer with info about what we want to read (addr & len) */
1391         raw_data[0] = *off & 0xff;
1392         raw_data[1] = (*off >> 8) && 0xff;
1393         raw_data[2] = s < 20 ? s : 20;
1394         if (*off + raw_data[2] > 0xff)
1395                 raw_data[2] = 0x100 - *off;
1396         resp = picolcd_send_and_wait(data->hdev, REPORT_EE_READ, raw_data,
1397                         sizeof(raw_data));
1398         if (!resp)
1399                 return -EIO;
1400
1401         if (resp->in_report && resp->in_report->id == REPORT_EE_DATA) {
1402                 /* successful read :) */
1403                 ret = resp->raw_data[2];
1404                 if (ret > s)
1405                         ret = s;
1406                 if (copy_to_user(u, resp->raw_data+3, ret))
1407                         ret = -EFAULT;
1408                 else
1409                         *off += ret;
1410         } /* anything else is some kind of IO error */
1411
1412         kfree(resp);
1413         return ret;
1414 }
1415
1416 static ssize_t picolcd_debug_eeprom_write(struct file *f, const char __user *u,
1417                 size_t s, loff_t *off)
1418 {
1419         struct picolcd_data *data = f->private_data;
1420         struct picolcd_pending *resp;
1421         ssize_t ret = -EIO;
1422         u8 raw_data[23];
1423
1424         if (s == 0)
1425                 return -EINVAL;
1426         if (*off > 0x0ff)
1427                 return -ENOSPC;
1428
1429         memset(raw_data, 0, sizeof(raw_data));
1430         raw_data[0] = *off & 0xff;
1431         raw_data[1] = (*off >> 8) && 0xff;
1432         raw_data[2] = s < 20 ? s : 20;
1433         if (*off + raw_data[2] > 0xff)
1434                 raw_data[2] = 0x100 - *off;
1435
1436         if (copy_from_user(raw_data+3, u, raw_data[2]))
1437                 return -EFAULT;
1438         resp = picolcd_send_and_wait(data->hdev, REPORT_EE_WRITE, raw_data,
1439                         sizeof(raw_data));
1440
1441         if (!resp)
1442                 return -EIO;
1443
1444         if (resp->in_report && resp->in_report->id == REPORT_EE_DATA) {
1445                 /* check if written data matches */
1446                 if (memcmp(raw_data, resp->raw_data, 3+raw_data[2]) == 0) {
1447                         *off += raw_data[2];
1448                         ret = raw_data[2];
1449                 }
1450         }
1451         kfree(resp);
1452         return ret;
1453 }
1454
1455 /*
1456  * Notes:
1457  * - read/write happens in chunks of at most 20 bytes, it's up to userspace
1458  *   to loop in order to get more data.
1459  * - on write errors on otherwise correct write request the bytes
1460  *   that should have been written are in undefined state.
1461  */
1462 static const struct file_operations picolcd_debug_eeprom_fops = {
1463         .owner    = THIS_MODULE,
1464         .open     = picolcd_debug_eeprom_open,
1465         .read     = picolcd_debug_eeprom_read,
1466         .write    = picolcd_debug_eeprom_write,
1467         .llseek   = generic_file_llseek,
1468 };
1469
1470 /*
1471  * The "flash" file
1472  */
1473 static int picolcd_debug_flash_open(struct inode *i, struct file *f)
1474 {
1475         f->private_data = i->i_private;
1476         return 0;
1477 }
1478
1479 /* record a flash address to buf (bounds check to be done by caller) */
1480 static int _picolcd_flash_setaddr(struct picolcd_data *data, u8 *buf, long off)
1481 {
1482         buf[0] = off & 0xff;
1483         buf[1] = (off >> 8) & 0xff;
1484         if (data->addr_sz == 3)
1485                 buf[2] = (off >> 16) & 0xff;
1486         return data->addr_sz == 2 ? 2 : 3;
1487 }
1488
1489 /* read a given size of data (bounds check to be done by caller) */
1490 static ssize_t _picolcd_flash_read(struct picolcd_data *data, int report_id,
1491                 char __user *u, size_t s, loff_t *off)
1492 {
1493         struct picolcd_pending *resp;
1494         u8 raw_data[4];
1495         ssize_t ret = 0;
1496         int len_off, err = -EIO;
1497
1498         while (s > 0) {
1499                 err = -EIO;
1500                 len_off = _picolcd_flash_setaddr(data, raw_data, *off);
1501                 raw_data[len_off] = s > 32 ? 32 : s;
1502                 resp = picolcd_send_and_wait(data->hdev, report_id, raw_data, len_off+1);
1503                 if (!resp || !resp->in_report)
1504                         goto skip;
1505                 if (resp->in_report->id == REPORT_MEMORY ||
1506                         resp->in_report->id == REPORT_BL_READ_MEMORY) {
1507                         if (memcmp(raw_data, resp->raw_data, len_off+1) != 0)
1508                                 goto skip;
1509                         if (copy_to_user(u+ret, resp->raw_data+len_off+1, raw_data[len_off])) {
1510                                 err = -EFAULT;
1511                                 goto skip;
1512                         }
1513                         *off += raw_data[len_off];
1514                         s    -= raw_data[len_off];
1515                         ret  += raw_data[len_off];
1516                         err   = 0;
1517                 }
1518 skip:
1519                 kfree(resp);
1520                 if (err)
1521                         return ret > 0 ? ret : err;
1522         }
1523         return ret;
1524 }
1525
1526 static ssize_t picolcd_debug_flash_read(struct file *f, char __user *u,
1527                 size_t s, loff_t *off)
1528 {
1529         struct picolcd_data *data = f->private_data;
1530
1531         if (s == 0)
1532                 return -EINVAL;
1533         if (*off > 0x05fff)
1534                 return 0;
1535         if (*off + s > 0x05fff)
1536                 s = 0x06000 - *off;
1537
1538         if (data->status & PICOLCD_BOOTLOADER)
1539                 return _picolcd_flash_read(data, REPORT_BL_READ_MEMORY, u, s, off);
1540         else
1541                 return _picolcd_flash_read(data, REPORT_READ_MEMORY, u, s, off);
1542 }
1543
1544 /* erase block aligned to 64bytes boundary */
1545 static ssize_t _picolcd_flash_erase64(struct picolcd_data *data, int report_id,
1546                 loff_t *off)
1547 {
1548         struct picolcd_pending *resp;
1549         u8 raw_data[3];
1550         int len_off;
1551         ssize_t ret = -EIO;
1552
1553         if (*off & 0x3f)
1554                 return -EINVAL;
1555
1556         len_off = _picolcd_flash_setaddr(data, raw_data, *off);
1557         resp = picolcd_send_and_wait(data->hdev, report_id, raw_data, len_off);
1558         if (!resp || !resp->in_report)
1559                 goto skip;
1560         if (resp->in_report->id == REPORT_MEMORY ||
1561                 resp->in_report->id == REPORT_BL_ERASE_MEMORY) {
1562                 if (memcmp(raw_data, resp->raw_data, len_off) != 0)
1563                         goto skip;
1564                 ret = 0;
1565         }
1566 skip:
1567         kfree(resp);
1568         return ret;
1569 }
1570
1571 /* write a given size of data (bounds check to be done by caller) */
1572 static ssize_t _picolcd_flash_write(struct picolcd_data *data, int report_id,
1573                 const char __user *u, size_t s, loff_t *off)
1574 {
1575         struct picolcd_pending *resp;
1576         u8 raw_data[36];
1577         ssize_t ret = 0;
1578         int len_off, err = -EIO;
1579
1580         while (s > 0) {
1581                 err = -EIO;
1582                 len_off = _picolcd_flash_setaddr(data, raw_data, *off);
1583                 raw_data[len_off] = s > 32 ? 32 : s;
1584                 if (copy_from_user(raw_data+len_off+1, u, raw_data[len_off])) {
1585                         err = -EFAULT;
1586                         goto skip;
1587                 }
1588                 resp = picolcd_send_and_wait(data->hdev, report_id, raw_data,
1589                                 len_off+1+raw_data[len_off]);
1590                 if (!resp || !resp->in_report)
1591                         goto skip;
1592                 if (resp->in_report->id == REPORT_MEMORY ||
1593                         resp->in_report->id == REPORT_BL_WRITE_MEMORY) {
1594                         if (memcmp(raw_data, resp->raw_data, len_off+1+raw_data[len_off]) != 0)
1595                                 goto skip;
1596                         *off += raw_data[len_off];
1597                         s    -= raw_data[len_off];
1598                         ret  += raw_data[len_off];
1599                         err   = 0;
1600                 }
1601 skip:
1602                 kfree(resp);
1603                 if (err)
1604                         break;
1605         }
1606         return ret > 0 ? ret : err;
1607 }
1608
1609 static ssize_t picolcd_debug_flash_write(struct file *f, const char __user *u,
1610                 size_t s, loff_t *off)
1611 {
1612         struct picolcd_data *data = f->private_data;
1613         ssize_t err, ret = 0;
1614         int report_erase, report_write;
1615
1616         if (s == 0)
1617                 return -EINVAL;
1618         if (*off > 0x5fff)
1619                 return -ENOSPC;
1620         if (s & 0x3f)
1621                 return -EINVAL;
1622         if (*off & 0x3f)
1623                 return -EINVAL;
1624
1625         if (data->status & PICOLCD_BOOTLOADER) {
1626                 report_erase = REPORT_BL_ERASE_MEMORY;
1627                 report_write = REPORT_BL_WRITE_MEMORY;
1628         } else {
1629                 report_erase = REPORT_ERASE_MEMORY;
1630                 report_write = REPORT_WRITE_MEMORY;
1631         }
1632         mutex_lock(&data->mutex_flash);
1633         while (s > 0) {
1634                 err = _picolcd_flash_erase64(data, report_erase, off);
1635                 if (err)
1636                         break;
1637                 err = _picolcd_flash_write(data, report_write, u, 64, off);
1638                 if (err < 0)
1639                         break;
1640                 ret += err;
1641                 *off += err;
1642                 s -= err;
1643                 if (err != 64)
1644                         break;
1645         }
1646         mutex_unlock(&data->mutex_flash);
1647         return ret > 0 ? ret : err;
1648 }
1649
1650 /*
1651  * Notes:
1652  * - concurrent writing is prevented by mutex and all writes must be
1653  *   n*64 bytes and 64-byte aligned, each write being preceeded by an
1654  *   ERASE which erases a 64byte block.
1655  *   If less than requested was written or an error is returned for an
1656  *   otherwise correct write request the next 64-byte block which should
1657  *   have been written is in undefined state (mostly: original, erased,
1658  *   (half-)written with write error)
1659  * - reading can happend without special restriction
1660  */
1661 static const struct file_operations picolcd_debug_flash_fops = {
1662         .owner    = THIS_MODULE,
1663         .open     = picolcd_debug_flash_open,
1664         .read     = picolcd_debug_flash_read,
1665         .write    = picolcd_debug_flash_write,
1666         .llseek   = generic_file_llseek,
1667 };
1668
1669
1670 /*
1671  * Helper code for HID report level dumping/debugging
1672  */
1673 static const char *error_codes[] = {
1674         "success", "parameter missing", "data_missing", "block readonly",
1675         "block not erasable", "block too big", "section overflow",
1676         "invalid command length", "invalid data length",
1677 };
1678
1679 static void dump_buff_as_hex(char *dst, size_t dst_sz, const u8 *data,
1680                 const size_t data_len)
1681 {
1682         int i, j;
1683         for (i = j = 0; i < data_len && j + 3 < dst_sz; i++) {
1684                 dst[j++] = hex_asc[(data[i] >> 4) & 0x0f];
1685                 dst[j++] = hex_asc[data[i] & 0x0f];
1686                 dst[j++] = ' ';
1687         }
1688         if (j < dst_sz) {
1689                 dst[j--] = '\0';
1690                 dst[j] = '\n';
1691         } else
1692                 dst[j] = '\0';
1693 }
1694
1695 static void picolcd_debug_out_report(struct picolcd_data *data,
1696                 struct hid_device *hdev, struct hid_report *report)
1697 {
1698         u8 raw_data[70];
1699         int raw_size = (report->size >> 3) + 1;
1700         char *buff;
1701 #define BUFF_SZ 256
1702
1703         /* Avoid unnecessary overhead if debugfs is disabled */
1704         if (!hdev->debug_events)
1705                 return;
1706
1707         buff = kmalloc(BUFF_SZ, GFP_ATOMIC);
1708         if (!buff)
1709                 return;
1710
1711         snprintf(buff, BUFF_SZ, "\nout report %d (size %d) =  ",
1712                         report->id, raw_size);
1713         hid_debug_event(hdev, buff);
1714         if (raw_size + 5 > sizeof(raw_data)) {
1715                 hid_debug_event(hdev, " TOO BIG\n");
1716                 return;
1717         } else {
1718                 raw_data[0] = report->id;
1719                 hid_output_report(report, raw_data);
1720                 dump_buff_as_hex(buff, BUFF_SZ, raw_data, raw_size);
1721                 hid_debug_event(hdev, buff);
1722         }
1723
1724         switch (report->id) {
1725         case REPORT_LED_STATE:
1726                 /* 1 data byte with GPO state */
1727                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1728                         "REPORT_LED_STATE", report->id, raw_size-1);
1729                 hid_debug_event(hdev, buff);
1730                 snprintf(buff, BUFF_SZ, "\tGPO state: 0x%02x\n", raw_data[1]);
1731                 hid_debug_event(hdev, buff);
1732                 break;
1733         case REPORT_BRIGHTNESS:
1734                 /* 1 data byte with brightness */
1735                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1736                         "REPORT_BRIGHTNESS", report->id, raw_size-1);
1737                 hid_debug_event(hdev, buff);
1738                 snprintf(buff, BUFF_SZ, "\tBrightness: 0x%02x\n", raw_data[1]);
1739                 hid_debug_event(hdev, buff);
1740                 break;
1741         case REPORT_CONTRAST:
1742                 /* 1 data byte with contrast */
1743                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1744                         "REPORT_CONTRAST", report->id, raw_size-1);
1745                 hid_debug_event(hdev, buff);
1746                 snprintf(buff, BUFF_SZ, "\tContrast: 0x%02x\n", raw_data[1]);
1747                 hid_debug_event(hdev, buff);
1748                 break;
1749         case REPORT_RESET:
1750                 /* 2 data bytes with reset duration in ms */
1751                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1752                         "REPORT_RESET", report->id, raw_size-1);
1753                 hid_debug_event(hdev, buff);
1754                 snprintf(buff, BUFF_SZ, "\tDuration: 0x%02x%02x (%dms)\n",
1755                                 raw_data[2], raw_data[1], raw_data[2] << 8 | raw_data[1]);
1756                 hid_debug_event(hdev, buff);
1757                 break;
1758         case REPORT_LCD_CMD:
1759                 /* 63 data bytes with LCD commands */
1760                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1761                         "REPORT_LCD_CMD", report->id, raw_size-1);
1762                 hid_debug_event(hdev, buff);
1763                 /* TODO: format decoding */
1764                 break;
1765         case REPORT_LCD_DATA:
1766                 /* 63 data bytes with LCD data */
1767                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1768                         "REPORT_LCD_CMD", report->id, raw_size-1);
1769                 /* TODO: format decoding */
1770                 hid_debug_event(hdev, buff);
1771                 break;
1772         case REPORT_LCD_CMD_DATA:
1773                 /* 63 data bytes with LCD commands and data */
1774                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1775                         "REPORT_LCD_CMD", report->id, raw_size-1);
1776                 /* TODO: format decoding */
1777                 hid_debug_event(hdev, buff);
1778                 break;
1779         case REPORT_EE_READ:
1780                 /* 3 data bytes with read area description */
1781                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1782                         "REPORT_EE_READ", report->id, raw_size-1);
1783                 hid_debug_event(hdev, buff);
1784                 snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x\n",
1785                                 raw_data[2], raw_data[1]);
1786                 hid_debug_event(hdev, buff);
1787                 snprintf(buff, BUFF_SZ, "\tData length: %d\n", raw_data[3]);
1788                 hid_debug_event(hdev, buff);
1789                 break;
1790         case REPORT_EE_WRITE:
1791                 /* 3+1..20 data bytes with write area description */
1792                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1793                         "REPORT_EE_WRITE", report->id, raw_size-1);
1794                 hid_debug_event(hdev, buff);
1795                 snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x\n",
1796                                 raw_data[2], raw_data[1]);
1797                 hid_debug_event(hdev, buff);
1798                 snprintf(buff, BUFF_SZ, "\tData length: %d\n", raw_data[3]);
1799                 hid_debug_event(hdev, buff);
1800                 if (raw_data[3] == 0) {
1801                         snprintf(buff, BUFF_SZ, "\tNo data\n");
1802                 } else if (raw_data[3] + 4 <= raw_size) {
1803                         snprintf(buff, BUFF_SZ, "\tData: ");
1804                         hid_debug_event(hdev, buff);
1805                         dump_buff_as_hex(buff, BUFF_SZ, raw_data+4, raw_data[3]);
1806                 } else {
1807                         snprintf(buff, BUFF_SZ, "\tData overflowed\n");
1808                 }
1809                 hid_debug_event(hdev, buff);
1810                 break;
1811         case REPORT_ERASE_MEMORY:
1812         case REPORT_BL_ERASE_MEMORY:
1813                 /* 3 data bytes with pointer inside erase block */
1814                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1815                         "REPORT_ERASE_MEMORY", report->id, raw_size-1);
1816                 hid_debug_event(hdev, buff);
1817                 switch (data->addr_sz) {
1818                 case 2:
1819                         snprintf(buff, BUFF_SZ, "\tAddress inside 64 byte block: 0x%02x%02x\n",
1820                                         raw_data[2], raw_data[1]);
1821                         break;
1822                 case 3:
1823                         snprintf(buff, BUFF_SZ, "\tAddress inside 64 byte block: 0x%02x%02x%02x\n",
1824                                         raw_data[3], raw_data[2], raw_data[1]);
1825                         break;
1826                 default:
1827                         snprintf(buff, BUFF_SZ, "\tNot supported\n");
1828                 }
1829                 hid_debug_event(hdev, buff);
1830                 break;
1831         case REPORT_READ_MEMORY:
1832         case REPORT_BL_READ_MEMORY:
1833                 /* 4 data bytes with read area description */
1834                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1835                         "REPORT_READ_MEMORY", report->id, raw_size-1);
1836                 hid_debug_event(hdev, buff);
1837                 switch (data->addr_sz) {
1838                 case 2:
1839                         snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x\n",
1840                                         raw_data[2], raw_data[1]);
1841                         hid_debug_event(hdev, buff);
1842                         snprintf(buff, BUFF_SZ, "\tData length: %d\n", raw_data[3]);
1843                         break;
1844                 case 3:
1845                         snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x%02x\n",
1846                                         raw_data[3], raw_data[2], raw_data[1]);
1847                         hid_debug_event(hdev, buff);
1848                         snprintf(buff, BUFF_SZ, "\tData length: %d\n", raw_data[4]);
1849                         break;
1850                 default:
1851                         snprintf(buff, BUFF_SZ, "\tNot supported\n");
1852                 }
1853                 hid_debug_event(hdev, buff);
1854                 break;
1855         case REPORT_WRITE_MEMORY:
1856         case REPORT_BL_WRITE_MEMORY:
1857                 /* 4+1..32 data bytes with write adrea description */
1858                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1859                         "REPORT_WRITE_MEMORY", report->id, raw_size-1);
1860                 hid_debug_event(hdev, buff);
1861                 switch (data->addr_sz) {
1862                 case 2:
1863                         snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x\n",
1864                                         raw_data[2], raw_data[1]);
1865                         hid_debug_event(hdev, buff);
1866                         snprintf(buff, BUFF_SZ, "\tData length: %d\n", raw_data[3]);
1867                         hid_debug_event(hdev, buff);
1868                         if (raw_data[3] == 0) {
1869                                 snprintf(buff, BUFF_SZ, "\tNo data\n");
1870                         } else if (raw_data[3] + 4 <= raw_size) {
1871                                 snprintf(buff, BUFF_SZ, "\tData: ");
1872                                 hid_debug_event(hdev, buff);
1873                                 dump_buff_as_hex(buff, BUFF_SZ, raw_data+4, raw_data[3]);
1874                         } else {
1875                                 snprintf(buff, BUFF_SZ, "\tData overflowed\n");
1876                         }
1877                         break;
1878                 case 3:
1879                         snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x%02x\n",
1880                                         raw_data[3], raw_data[2], raw_data[1]);
1881                         hid_debug_event(hdev, buff);
1882                         snprintf(buff, BUFF_SZ, "\tData length: %d\n", raw_data[4]);
1883                         hid_debug_event(hdev, buff);
1884                         if (raw_data[4] == 0) {
1885                                 snprintf(buff, BUFF_SZ, "\tNo data\n");
1886                         } else if (raw_data[4] + 5 <= raw_size) {
1887                                 snprintf(buff, BUFF_SZ, "\tData: ");
1888                                 hid_debug_event(hdev, buff);
1889                                 dump_buff_as_hex(buff, BUFF_SZ, raw_data+5, raw_data[4]);
1890                         } else {
1891                                 snprintf(buff, BUFF_SZ, "\tData overflowed\n");
1892                         }
1893                         break;
1894                 default:
1895                         snprintf(buff, BUFF_SZ, "\tNot supported\n");
1896                 }
1897                 hid_debug_event(hdev, buff);
1898                 break;
1899         case REPORT_SPLASH_RESTART:
1900                 /* TODO */
1901                 break;
1902         case REPORT_EXIT_KEYBOARD:
1903                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1904                         "REPORT_EXIT_KEYBOARD", report->id, raw_size-1);
1905                 hid_debug_event(hdev, buff);
1906                 snprintf(buff, BUFF_SZ, "\tRestart delay: %dms (0x%02x%02x)\n",
1907                                 raw_data[1] | (raw_data[2] << 8),
1908                                 raw_data[2], raw_data[1]);
1909                 hid_debug_event(hdev, buff);
1910                 break;
1911         case REPORT_VERSION:
1912                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1913                         "REPORT_VERSION", report->id, raw_size-1);
1914                 hid_debug_event(hdev, buff);
1915                 break;
1916         case REPORT_DEVID:
1917                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1918                         "REPORT_DEVID", report->id, raw_size-1);
1919                 hid_debug_event(hdev, buff);
1920                 break;
1921         case REPORT_SPLASH_SIZE:
1922                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1923                         "REPORT_SPLASH_SIZE", report->id, raw_size-1);
1924                 hid_debug_event(hdev, buff);
1925                 break;
1926         case REPORT_HOOK_VERSION:
1927                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1928                         "REPORT_HOOK_VERSION", report->id, raw_size-1);
1929                 hid_debug_event(hdev, buff);
1930                 break;
1931         case REPORT_EXIT_FLASHER:
1932                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1933                         "REPORT_VERSION", report->id, raw_size-1);
1934                 hid_debug_event(hdev, buff);
1935                 snprintf(buff, BUFF_SZ, "\tRestart delay: %dms (0x%02x%02x)\n",
1936                                 raw_data[1] | (raw_data[2] << 8),
1937                                 raw_data[2], raw_data[1]);
1938                 hid_debug_event(hdev, buff);
1939                 break;
1940         default:
1941                 snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)\n",
1942                         "<unknown>", report->id, raw_size-1);
1943                 hid_debug_event(hdev, buff);
1944                 break;
1945         }
1946         wake_up_interruptible(&hdev->debug_wait);
1947         kfree(buff);
1948 }
1949
1950 static void picolcd_debug_raw_event(struct picolcd_data *data,
1951                 struct hid_device *hdev, struct hid_report *report,
1952                 u8 *raw_data, int size)
1953 {
1954         char *buff;
1955
1956 #define BUFF_SZ 256
1957         /* Avoid unnecessary overhead if debugfs is disabled */
1958         if (!hdev->debug_events)
1959                 return;
1960
1961         buff = kmalloc(BUFF_SZ, GFP_ATOMIC);
1962         if (!buff)
1963                 return;
1964
1965         switch (report->id) {
1966         case REPORT_ERROR_CODE:
1967                 /* 2 data bytes with affected report and error code */
1968                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
1969                         "REPORT_ERROR_CODE", report->id, size-1);
1970                 hid_debug_event(hdev, buff);
1971                 if (raw_data[2] < ARRAY_SIZE(error_codes))
1972                         snprintf(buff, BUFF_SZ, "\tError code 0x%02x (%s) in reply to report 0x%02x\n",
1973                                         raw_data[2], error_codes[raw_data[2]], raw_data[1]);
1974                 else
1975                         snprintf(buff, BUFF_SZ, "\tError code 0x%02x in reply to report 0x%02x\n",
1976                                         raw_data[2], raw_data[1]);
1977                 hid_debug_event(hdev, buff);
1978                 break;
1979         case REPORT_KEY_STATE:
1980                 /* 2 data bytes with key state */
1981                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
1982                         "REPORT_KEY_STATE", report->id, size-1);
1983                 hid_debug_event(hdev, buff);
1984                 if (raw_data[1] == 0)
1985                         snprintf(buff, BUFF_SZ, "\tNo key pressed\n");
1986                 else if (raw_data[2] == 0)
1987                         snprintf(buff, BUFF_SZ, "\tOne key pressed: 0x%02x (%d)\n",
1988                                         raw_data[1], raw_data[1]);
1989                 else
1990                         snprintf(buff, BUFF_SZ, "\tTwo keys pressed: 0x%02x (%d), 0x%02x (%d)\n",
1991                                         raw_data[1], raw_data[1], raw_data[2], raw_data[2]);
1992                 hid_debug_event(hdev, buff);
1993                 break;
1994         case REPORT_IR_DATA:
1995                 /* Up to 20 byes of IR scancode data */
1996                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
1997                         "REPORT_IR_DATA", report->id, size-1);
1998                 hid_debug_event(hdev, buff);
1999                 if (raw_data[1] == 0) {
2000                         snprintf(buff, BUFF_SZ, "\tUnexpectedly 0 data length\n");
2001                         hid_debug_event(hdev, buff);
2002                 } else if (raw_data[1] + 1 <= size) {
2003                         snprintf(buff, BUFF_SZ, "\tData length: %d\n\tIR Data: ",
2004                                         raw_data[1]-1);
2005                         hid_debug_event(hdev, buff);
2006                         dump_buff_as_hex(buff, BUFF_SZ, raw_data+2, raw_data[1]-1);
2007                         hid_debug_event(hdev, buff);
2008                 } else {
2009                         snprintf(buff, BUFF_SZ, "\tOverflowing data length: %d\n",
2010                                         raw_data[1]-1);
2011                         hid_debug_event(hdev, buff);
2012                 }
2013                 break;
2014         case REPORT_EE_DATA:
2015                 /* Data buffer in response to REPORT_EE_READ or REPORT_EE_WRITE */
2016                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
2017                         "REPORT_EE_DATA", report->id, size-1);
2018                 hid_debug_event(hdev, buff);
2019                 snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x\n",
2020                                 raw_data[2], raw_data[1]);
2021                 hid_debug_event(hdev, buff);
2022                 snprintf(buff, BUFF_SZ, "\tData length: %d\n", raw_data[3]);
2023                 hid_debug_event(hdev, buff);
2024                 if (raw_data[3] == 0) {
2025                         snprintf(buff, BUFF_SZ, "\tNo data\n");
2026                         hid_debug_event(hdev, buff);
2027                 } else if (raw_data[3] + 4 <= size) {
2028                         snprintf(buff, BUFF_SZ, "\tData: ");
2029                         hid_debug_event(hdev, buff);
2030                         dump_buff_as_hex(buff, BUFF_SZ, raw_data+4, raw_data[3]);
2031                         hid_debug_event(hdev, buff);
2032                 } else {
2033                         snprintf(buff, BUFF_SZ, "\tData overflowed\n");
2034                         hid_debug_event(hdev, buff);
2035                 }
2036                 break;
2037         case REPORT_MEMORY:
2038                 /* Data buffer in response to REPORT_READ_MEMORY or REPORT_WRTIE_MEMORY */
2039                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
2040                         "REPORT_MEMORY", report->id, size-1);
2041                 hid_debug_event(hdev, buff);
2042                 switch (data->addr_sz) {
2043                 case 2:
2044                         snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x\n",
2045                                         raw_data[2], raw_data[1]);
2046                         hid_debug_event(hdev, buff);
2047                         snprintf(buff, BUFF_SZ, "\tData length: %d\n", raw_data[3]);
2048                         hid_debug_event(hdev, buff);
2049                         if (raw_data[3] == 0) {
2050                                 snprintf(buff, BUFF_SZ, "\tNo data\n");
2051                         } else if (raw_data[3] + 4 <= size) {
2052                                 snprintf(buff, BUFF_SZ, "\tData: ");
2053                                 hid_debug_event(hdev, buff);
2054                                 dump_buff_as_hex(buff, BUFF_SZ, raw_data+4, raw_data[3]);
2055                         } else {
2056                                 snprintf(buff, BUFF_SZ, "\tData overflowed\n");
2057                         }
2058                         break;
2059                 case 3:
2060                         snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x%02x\n",
2061                                         raw_data[3], raw_data[2], raw_data[1]);
2062                         hid_debug_event(hdev, buff);
2063                         snprintf(buff, BUFF_SZ, "\tData length: %d\n", raw_data[4]);
2064                         hid_debug_event(hdev, buff);
2065                         if (raw_data[4] == 0) {
2066                                 snprintf(buff, BUFF_SZ, "\tNo data\n");
2067                         } else if (raw_data[4] + 5 <= size) {
2068                                 snprintf(buff, BUFF_SZ, "\tData: ");
2069                                 hid_debug_event(hdev, buff);
2070                                 dump_buff_as_hex(buff, BUFF_SZ, raw_data+5, raw_data[4]);
2071                         } else {
2072                                 snprintf(buff, BUFF_SZ, "\tData overflowed\n");
2073                         }
2074                         break;
2075                 default:
2076                         snprintf(buff, BUFF_SZ, "\tNot supported\n");
2077                 }
2078                 hid_debug_event(hdev, buff);
2079                 break;
2080         case REPORT_VERSION:
2081                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
2082                         "REPORT_VERSION", report->id, size-1);
2083                 hid_debug_event(hdev, buff);
2084                 snprintf(buff, BUFF_SZ, "\tFirmware version: %d.%d\n",
2085                                 raw_data[2], raw_data[1]);
2086                 hid_debug_event(hdev, buff);
2087                 break;
2088         case REPORT_BL_ERASE_MEMORY:
2089                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
2090                         "REPORT_BL_ERASE_MEMORY", report->id, size-1);
2091                 hid_debug_event(hdev, buff);
2092                 /* TODO */
2093                 break;
2094         case REPORT_BL_READ_MEMORY:
2095                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
2096                         "REPORT_BL_READ_MEMORY", report->id, size-1);
2097                 hid_debug_event(hdev, buff);
2098                 /* TODO */
2099                 break;
2100         case REPORT_BL_WRITE_MEMORY:
2101                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
2102                         "REPORT_BL_WRITE_MEMORY", report->id, size-1);
2103                 hid_debug_event(hdev, buff);
2104                 /* TODO */
2105                 break;
2106         case REPORT_DEVID:
2107                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
2108                         "REPORT_DEVID", report->id, size-1);
2109                 hid_debug_event(hdev, buff);
2110                 snprintf(buff, BUFF_SZ, "\tSerial: 0x%02x%02x%02x%02x\n",
2111                                 raw_data[1], raw_data[2], raw_data[3], raw_data[4]);
2112                 hid_debug_event(hdev, buff);
2113                 snprintf(buff, BUFF_SZ, "\tType: 0x%02x\n",
2114                                 raw_data[5]);
2115                 hid_debug_event(hdev, buff);
2116                 break;
2117         case REPORT_SPLASH_SIZE:
2118                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
2119                         "REPORT_SPLASH_SIZE", report->id, size-1);
2120                 hid_debug_event(hdev, buff);
2121                 snprintf(buff, BUFF_SZ, "\tTotal splash space: %d\n",
2122                                 (raw_data[2] << 8) | raw_data[1]);
2123                 hid_debug_event(hdev, buff);
2124                 snprintf(buff, BUFF_SZ, "\tUsed splash space: %d\n",
2125                                 (raw_data[4] << 8) | raw_data[3]);
2126                 hid_debug_event(hdev, buff);
2127                 break;
2128         case REPORT_HOOK_VERSION:
2129                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
2130                         "REPORT_HOOK_VERSION", report->id, size-1);
2131                 hid_debug_event(hdev, buff);
2132                 snprintf(buff, BUFF_SZ, "\tFirmware version: %d.%d\n",
2133                                 raw_data[1], raw_data[2]);
2134                 hid_debug_event(hdev, buff);
2135                 break;
2136         default:
2137                 snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)\n",
2138                         "<unknown>", report->id, size-1);
2139                 hid_debug_event(hdev, buff);
2140                 break;
2141         }
2142         wake_up_interruptible(&hdev->debug_wait);
2143         kfree(buff);
2144 }
2145
2146 static void picolcd_init_devfs(struct picolcd_data *data,
2147                 struct hid_report *eeprom_r, struct hid_report *eeprom_w,
2148                 struct hid_report *flash_r, struct hid_report *flash_w,
2149                 struct hid_report *reset)
2150 {
2151         struct hid_device *hdev = data->hdev;
2152
2153         mutex_init(&data->mutex_flash);
2154
2155         /* reset */
2156         if (reset)
2157                 data->debug_reset = debugfs_create_file("reset", 0600,
2158                                 hdev->debug_dir, data, &picolcd_debug_reset_fops);
2159
2160         /* eeprom */
2161         if (eeprom_r || eeprom_w)
2162                 data->debug_eeprom = debugfs_create_file("eeprom",
2163                         (eeprom_w ? S_IWUSR : 0) | (eeprom_r ? S_IRUSR : 0),
2164                         hdev->debug_dir, data, &picolcd_debug_eeprom_fops);
2165
2166         /* flash */
2167         if (flash_r && flash_r->maxfield == 1 && flash_r->field[0]->report_size == 8)
2168                 data->addr_sz = flash_r->field[0]->report_count - 1;
2169         else
2170                 data->addr_sz = -1;
2171         if (data->addr_sz == 2 || data->addr_sz == 3) {
2172                 data->debug_flash = debugfs_create_file("flash",
2173                         (flash_w ? S_IWUSR : 0) | (flash_r ? S_IRUSR : 0),
2174                         hdev->debug_dir, data, &picolcd_debug_flash_fops);
2175         } else if (flash_r || flash_w)
2176                 dev_warn(&hdev->dev, "Unexpected FLASH access reports, "
2177                                 "please submit rdesc for review\n");
2178 }
2179
2180 static void picolcd_exit_devfs(struct picolcd_data *data)
2181 {
2182         struct dentry *dent;
2183
2184         dent = data->debug_reset;
2185         data->debug_reset = NULL;
2186         if (dent)
2187                 debugfs_remove(dent);
2188         dent = data->debug_eeprom;
2189         data->debug_eeprom = NULL;
2190         if (dent)
2191                 debugfs_remove(dent);
2192         dent = data->debug_flash;
2193         data->debug_flash = NULL;
2194         if (dent)
2195                 debugfs_remove(dent);
2196         mutex_destroy(&data->mutex_flash);
2197 }
2198 #else
2199 #define picolcd_debug_raw_event(data, hdev, report, raw_data, size)
2200 #define picolcd_init_devfs(data, eeprom_r, eeprom_w, flash_r, flash_w, reset)
2201 static void picolcd_exit_devfs(struct picolcd_data *data)
2202 {
2203 }
2204 #endif /* CONFIG_DEBUG_FS */
2205
2206 /*
2207  * Handle raw report as sent by device
2208  */
2209 static int picolcd_raw_event(struct hid_device *hdev,
2210                 struct hid_report *report, u8 *raw_data, int size)
2211 {
2212         struct picolcd_data *data = hid_get_drvdata(hdev);
2213         unsigned long flags;
2214         int ret = 0;
2215
2216         if (!data)
2217                 return 1;
2218
2219         if (report->id == REPORT_KEY_STATE) {
2220                 if (data->input_keys)
2221                         ret = picolcd_raw_keypad(data, report, raw_data+1, size-1);
2222         } else if (report->id == REPORT_IR_DATA) {
2223                 if (data->input_cir)
2224                         ret = picolcd_raw_cir(data, report, raw_data+1, size-1);
2225         } else {
2226                 spin_lock_irqsave(&data->lock, flags);
2227                 /*
2228                  * We let the caller of picolcd_send_and_wait() check if the
2229                  * report we got is one of the expected ones or not.
2230                  */
2231                 if (data->pending) {
2232                         memcpy(data->pending->raw_data, raw_data+1, size-1);
2233                         data->pending->raw_size  = size-1;
2234                         data->pending->in_report = report;
2235                         complete(&data->pending->ready);
2236                 }
2237                 spin_unlock_irqrestore(&data->lock, flags);
2238         }
2239
2240         picolcd_debug_raw_event(data, hdev, report, raw_data, size);
2241         return 1;
2242 }
2243
2244 /* initialize keypad input device */
2245 static int picolcd_init_keys(struct picolcd_data *data,
2246                 struct hid_report *report)
2247 {
2248         struct hid_device *hdev = data->hdev;
2249         struct input_dev *idev;
2250         int error, i;
2251
2252         if (!report)
2253                 return -ENODEV;
2254         if (report->maxfield != 1 || report->field[0]->report_count != 2 ||
2255                         report->field[0]->report_size != 8) {
2256                 dev_err(&hdev->dev, "unsupported KEY_STATE report");
2257                 return -EINVAL;
2258         }
2259
2260         idev = input_allocate_device();
2261         if (idev == NULL) {
2262                 dev_err(&hdev->dev, "failed to allocate input device");
2263                 return -ENOMEM;
2264         }
2265         input_set_drvdata(idev, hdev);
2266         memcpy(data->keycode, def_keymap, sizeof(def_keymap));
2267         idev->name = hdev->name;
2268         idev->phys = hdev->phys;
2269         idev->uniq = hdev->uniq;
2270         idev->id.bustype = hdev->bus;
2271         idev->id.vendor  = hdev->vendor;
2272         idev->id.product = hdev->product;
2273         idev->id.version = hdev->version;
2274         idev->dev.parent = hdev->dev.parent;
2275         idev->keycode     = &data->keycode;
2276         idev->keycodemax  = PICOLCD_KEYS;
2277         idev->keycodesize = sizeof(data->keycode[0]);
2278         input_set_capability(idev, EV_MSC, MSC_SCAN);
2279         set_bit(EV_REP, idev->evbit);
2280         for (i = 0; i < PICOLCD_KEYS; i++)
2281                 input_set_capability(idev, EV_KEY, data->keycode[i]);
2282         error = input_register_device(idev);
2283         if (error) {
2284                 dev_err(&hdev->dev, "error registering the input device");
2285                 input_free_device(idev);
2286                 return error;
2287         }
2288         data->input_keys = idev;
2289         return 0;
2290 }
2291
2292 static void picolcd_exit_keys(struct picolcd_data *data)
2293 {
2294         struct input_dev *idev = data->input_keys;
2295
2296         data->input_keys = NULL;
2297         if (idev)
2298                 input_unregister_device(idev);
2299 }
2300
2301 /* initialize CIR input device */
2302 static inline int picolcd_init_cir(struct picolcd_data *data, struct hid_report *report)
2303 {
2304         /* support not implemented yet */
2305         return 0;
2306 }
2307
2308 static inline void picolcd_exit_cir(struct picolcd_data *data)
2309 {
2310 }
2311
2312 static int picolcd_probe_lcd(struct hid_device *hdev, struct picolcd_data *data)
2313 {
2314         int error;
2315
2316         error = picolcd_check_version(hdev);
2317         if (error)
2318                 return error;
2319
2320         if (data->version[0] != 0 && data->version[1] != 3)
2321                 dev_info(&hdev->dev, "Device with untested firmware revision, "
2322                                 "please submit /sys/kernel/debug/hid/%s/rdesc for this device.\n",
2323                                 dev_name(&hdev->dev));
2324
2325         /* Setup keypad input device */
2326         error = picolcd_init_keys(data, picolcd_in_report(REPORT_KEY_STATE, hdev));
2327         if (error)
2328                 goto err;
2329
2330         /* Setup CIR input device */
2331         error = picolcd_init_cir(data, picolcd_in_report(REPORT_IR_DATA, hdev));
2332         if (error)
2333                 goto err;
2334
2335         /* Set up the framebuffer device */
2336         error = picolcd_init_framebuffer(data);
2337         if (error)
2338                 goto err;
2339
2340         /* Setup lcd class device */
2341         error = picolcd_init_lcd(data, picolcd_out_report(REPORT_CONTRAST, hdev));
2342         if (error)
2343                 goto err;
2344
2345         /* Setup backlight class device */
2346         error = picolcd_init_backlight(data, picolcd_out_report(REPORT_BRIGHTNESS, hdev));
2347         if (error)
2348                 goto err;
2349
2350         /* Setup the LED class devices */
2351         error = picolcd_init_leds(data, picolcd_out_report(REPORT_LED_STATE, hdev));
2352         if (error)
2353                 goto err;
2354
2355         picolcd_init_devfs(data, picolcd_out_report(REPORT_EE_READ, hdev),
2356                         picolcd_out_report(REPORT_EE_WRITE, hdev),
2357                         picolcd_out_report(REPORT_READ_MEMORY, hdev),
2358                         picolcd_out_report(REPORT_WRITE_MEMORY, hdev),
2359                         picolcd_out_report(REPORT_RESET, hdev));
2360         return 0;
2361 err:
2362         picolcd_exit_leds(data);
2363         picolcd_exit_backlight(data);
2364         picolcd_exit_lcd(data);
2365         picolcd_exit_framebuffer(data);
2366         picolcd_exit_cir(data);
2367         picolcd_exit_keys(data);
2368         return error;
2369 }
2370
2371 static int picolcd_probe_bootloader(struct hid_device *hdev, struct picolcd_data *data)
2372 {
2373         int error;
2374
2375         error = picolcd_check_version(hdev);
2376         if (error)
2377                 return error;
2378
2379         if (data->version[0] != 1 && data->version[1] != 0)
2380                 dev_info(&hdev->dev, "Device with untested bootloader revision, "
2381                                 "please submit /sys/kernel/debug/hid/%s/rdesc for this device.\n",
2382                                 dev_name(&hdev->dev));
2383
2384         picolcd_init_devfs(data, NULL, NULL,
2385                         picolcd_out_report(REPORT_BL_READ_MEMORY, hdev),
2386                         picolcd_out_report(REPORT_BL_WRITE_MEMORY, hdev), NULL);
2387         return 0;
2388 }
2389
2390 static int picolcd_probe(struct hid_device *hdev,
2391                      const struct hid_device_id *id)
2392 {
2393         struct picolcd_data *data;
2394         int error = -ENOMEM;
2395
2396         dbg_hid(PICOLCD_NAME " hardware probe...\n");
2397
2398         /*
2399          * Let's allocate the picolcd data structure, set some reasonable
2400          * defaults, and associate it with the device
2401          */
2402         data = kzalloc(sizeof(struct picolcd_data), GFP_KERNEL);
2403         if (data == NULL) {
2404                 dev_err(&hdev->dev, "can't allocate space for Minibox PicoLCD device data\n");
2405                 error = -ENOMEM;
2406                 goto err_no_cleanup;
2407         }
2408
2409         spin_lock_init(&data->lock);
2410         mutex_init(&data->mutex);
2411         data->hdev = hdev;
2412         if (hdev->product == USB_DEVICE_ID_PICOLCD_BOOTLOADER)
2413                 data->status |= PICOLCD_BOOTLOADER;
2414         hid_set_drvdata(hdev, data);
2415
2416         /* Parse the device reports and start it up */
2417         error = hid_parse(hdev);
2418         if (error) {
2419                 dev_err(&hdev->dev, "device report parse failed\n");
2420                 goto err_cleanup_data;
2421         }
2422
2423         /* We don't use hidinput but hid_hw_start() fails if nothing is
2424          * claimed. So spoof claimed input. */
2425         hdev->claimed = HID_CLAIMED_INPUT;
2426         error = hid_hw_start(hdev, 0);
2427         hdev->claimed = 0;
2428         if (error) {
2429                 dev_err(&hdev->dev, "hardware start failed\n");
2430                 goto err_cleanup_data;
2431         }
2432
2433         error = hdev->ll_driver->open(hdev);
2434         if (error) {
2435                 dev_err(&hdev->dev, "failed to open input interrupt pipe for key and IR events\n");
2436                 goto err_cleanup_hid_hw;
2437         }
2438
2439         error = device_create_file(&hdev->dev, &dev_attr_operation_mode);
2440         if (error) {
2441                 dev_err(&hdev->dev, "failed to create sysfs attributes\n");
2442                 goto err_cleanup_hid_ll;
2443         }
2444
2445         if (data->status & PICOLCD_BOOTLOADER)
2446                 error = picolcd_probe_bootloader(hdev, data);
2447         else
2448                 error = picolcd_probe_lcd(hdev, data);
2449         if (error)
2450                 goto err_cleanup_sysfs;
2451
2452         dbg_hid(PICOLCD_NAME " activated and initialized\n");
2453         return 0;
2454
2455 err_cleanup_sysfs:
2456         device_remove_file(&hdev->dev, &dev_attr_operation_mode);
2457 err_cleanup_hid_ll:
2458         hdev->ll_driver->close(hdev);
2459 err_cleanup_hid_hw:
2460         hid_hw_stop(hdev);
2461 err_cleanup_data:
2462         kfree(data);
2463 err_no_cleanup:
2464         hid_set_drvdata(hdev, NULL);
2465
2466         return error;
2467 }
2468
2469 static void picolcd_remove(struct hid_device *hdev)
2470 {
2471         struct picolcd_data *data = hid_get_drvdata(hdev);
2472         unsigned long flags;
2473
2474         dbg_hid(PICOLCD_NAME " hardware remove...\n");
2475         spin_lock_irqsave(&data->lock, flags);
2476         data->status |= PICOLCD_FAILED;
2477         spin_unlock_irqrestore(&data->lock, flags);
2478
2479         picolcd_exit_devfs(data);
2480         device_remove_file(&hdev->dev, &dev_attr_operation_mode);
2481         hdev->ll_driver->close(hdev);
2482         hid_hw_stop(hdev);
2483         hid_set_drvdata(hdev, NULL);
2484
2485         /* Shortcut potential pending reply that will never arrive */
2486         spin_lock_irqsave(&data->lock, flags);
2487         if (data->pending)
2488                 complete(&data->pending->ready);
2489         spin_unlock_irqrestore(&data->lock, flags);
2490
2491         /* Cleanup LED */
2492         picolcd_exit_leds(data);
2493         /* Clean up the framebuffer */
2494         picolcd_exit_backlight(data);
2495         picolcd_exit_lcd(data);
2496         picolcd_exit_framebuffer(data);
2497         /* Cleanup input */
2498         picolcd_exit_cir(data);
2499         picolcd_exit_keys(data);
2500
2501         mutex_destroy(&data->mutex);
2502         /* Finally, clean up the picolcd data itself */
2503         kfree(data);
2504 }
2505
2506 static const struct hid_device_id picolcd_devices[] = {
2507         { HID_USB_DEVICE(USB_VENDOR_ID_MICROCHIP, USB_DEVICE_ID_PICOLCD) },
2508         { HID_USB_DEVICE(USB_VENDOR_ID_MICROCHIP, USB_DEVICE_ID_PICOLCD_BOOTLOADER) },
2509         { }
2510 };
2511 MODULE_DEVICE_TABLE(hid, picolcd_devices);
2512
2513 static struct hid_driver picolcd_driver = {
2514         .name =          "hid-picolcd",
2515         .id_table =      picolcd_devices,
2516         .probe =         picolcd_probe,
2517         .remove =        picolcd_remove,
2518         .raw_event =     picolcd_raw_event,
2519 };
2520
2521 static int __init picolcd_init(void)
2522 {
2523         return hid_register_driver(&picolcd_driver);
2524 }
2525
2526 static void __exit picolcd_exit(void)
2527 {
2528         hid_unregister_driver(&picolcd_driver);
2529 }
2530
2531 module_init(picolcd_init);
2532 module_exit(picolcd_exit);
2533 MODULE_DESCRIPTION("Minibox graphics PicoLCD Driver");
2534 MODULE_LICENSE("GPL v2");