Blame view

kernel/linux-imx6_3.14.28/drivers/hid/hid-picolcd_debugfs.c 27.1 KB
6b13f685e   김민수   BSP 최초 추가
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
  /***************************************************************************
   *   Copyright (C) 2010-2012 by Bruno Prémont <bonbons@linux-vserver.org>  *
   *                                                                         *
   *   Based on Logitech G13 driver (v0.4)                                   *
   *     Copyright (C) 2009 by Rick L. Vinyard, Jr. <rvinyard@cs.nmsu.edu>   *
   *                                                                         *
   *   This program is free software: you can redistribute it and/or modify  *
   *   it under the terms of the GNU General Public License as published by  *
   *   the Free Software Foundation, version 2 of the License.               *
   *                                                                         *
   *   This driver is distributed in the hope that it will be useful, but    *
   *   WITHOUT ANY WARRANTY; without even the implied warranty of            *
   *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      *
   *   General Public License for more details.                              *
   *                                                                         *
   *   You should have received a copy of the GNU General Public License     *
   *   along with this software. If not see <http://www.gnu.org/licenses/>.  *
   ***************************************************************************/
  
  #include <linux/hid.h>
  #include <linux/hid-debug.h>
  
  #include <linux/fb.h>
  #include <linux/seq_file.h>
  #include <linux/debugfs.h>
  
  #include <linux/module.h>
  #include <linux/uaccess.h>
  
  #include "hid-picolcd.h"
  
  
  static int picolcd_debug_reset_show(struct seq_file *f, void *p)
  {
  	if (picolcd_fbinfo((struct picolcd_data *)f->private))
  		seq_printf(f, "all fb
  ");
  	else
  		seq_printf(f, "all
  ");
  	return 0;
  }
  
  static int picolcd_debug_reset_open(struct inode *inode, struct file *f)
  {
  	return single_open(f, picolcd_debug_reset_show, inode->i_private);
  }
  
  static ssize_t picolcd_debug_reset_write(struct file *f, const char __user *user_buf,
  		size_t count, loff_t *ppos)
  {
  	struct picolcd_data *data = ((struct seq_file *)f->private_data)->private;
  	char buf[32];
  	size_t cnt = min(count, sizeof(buf)-1);
  	if (copy_from_user(buf, user_buf, cnt))
  		return -EFAULT;
  
  	while (cnt > 0 && (buf[cnt-1] == ' ' || buf[cnt-1] == '
  '))
  		cnt--;
  	buf[cnt] = '\0';
  	if (strcmp(buf, "all") == 0) {
  		picolcd_reset(data->hdev);
  		picolcd_fb_reset(data, 1);
  	} else if (strcmp(buf, "fb") == 0) {
  		picolcd_fb_reset(data, 1);
  	} else {
  		return -EINVAL;
  	}
  	return count;
  }
  
  static const struct file_operations picolcd_debug_reset_fops = {
  	.owner    = THIS_MODULE,
  	.open     = picolcd_debug_reset_open,
  	.read     = seq_read,
  	.llseek   = seq_lseek,
  	.write    = picolcd_debug_reset_write,
  	.release  = single_release,
  };
  
  /*
   * The "eeprom" file
   */
  static ssize_t picolcd_debug_eeprom_read(struct file *f, char __user *u,
  		size_t s, loff_t *off)
  {
  	struct picolcd_data *data = f->private_data;
  	struct picolcd_pending *resp;
  	u8 raw_data[3];
  	ssize_t ret = -EIO;
  
  	if (s == 0)
  		return -EINVAL;
  	if (*off > 0x0ff)
  		return 0;
  
  	/* prepare buffer with info about what we want to read (addr & len) */
  	raw_data[0] = *off & 0xff;
  	raw_data[1] = (*off >> 8) & 0xff;
  	raw_data[2] = s < 20 ? s : 20;
  	if (*off + raw_data[2] > 0xff)
  		raw_data[2] = 0x100 - *off;
  	resp = picolcd_send_and_wait(data->hdev, REPORT_EE_READ, raw_data,
  			sizeof(raw_data));
  	if (!resp)
  		return -EIO;
  
  	if (resp->in_report && resp->in_report->id == REPORT_EE_DATA) {
  		/* successful read :) */
  		ret = resp->raw_data[2];
  		if (ret > s)
  			ret = s;
  		if (copy_to_user(u, resp->raw_data+3, ret))
  			ret = -EFAULT;
  		else
  			*off += ret;
  	} /* anything else is some kind of IO error */
  
  	kfree(resp);
  	return ret;
  }
  
  static ssize_t picolcd_debug_eeprom_write(struct file *f, const char __user *u,
  		size_t s, loff_t *off)
  {
  	struct picolcd_data *data = f->private_data;
  	struct picolcd_pending *resp;
  	ssize_t ret = -EIO;
  	u8 raw_data[23];
  
  	if (s == 0)
  		return -EINVAL;
  	if (*off > 0x0ff)
  		return -ENOSPC;
  
  	memset(raw_data, 0, sizeof(raw_data));
  	raw_data[0] = *off & 0xff;
  	raw_data[1] = (*off >> 8) & 0xff;
  	raw_data[2] = min_t(size_t, 20, s);
  	if (*off + raw_data[2] > 0xff)
  		raw_data[2] = 0x100 - *off;
  
  	if (copy_from_user(raw_data+3, u, min((u8)20, raw_data[2])))
  		return -EFAULT;
  	resp = picolcd_send_and_wait(data->hdev, REPORT_EE_WRITE, raw_data,
  			sizeof(raw_data));
  
  	if (!resp)
  		return -EIO;
  
  	if (resp->in_report && resp->in_report->id == REPORT_EE_DATA) {
  		/* check if written data matches */
  		if (memcmp(raw_data, resp->raw_data, 3+raw_data[2]) == 0) {
  			*off += raw_data[2];
  			ret = raw_data[2];
  		}
  	}
  	kfree(resp);
  	return ret;
  }
  
  /*
   * Notes:
   * - read/write happens in chunks of at most 20 bytes, it's up to userspace
   *   to loop in order to get more data.
   * - on write errors on otherwise correct write request the bytes
   *   that should have been written are in undefined state.
   */
  static const struct file_operations picolcd_debug_eeprom_fops = {
  	.owner    = THIS_MODULE,
  	.open     = simple_open,
  	.read     = picolcd_debug_eeprom_read,
  	.write    = picolcd_debug_eeprom_write,
  	.llseek   = generic_file_llseek,
  };
  
  /*
   * The "flash" file
   */
  /* record a flash address to buf (bounds check to be done by caller) */
  static int _picolcd_flash_setaddr(struct picolcd_data *data, u8 *buf, long off)
  {
  	buf[0] = off & 0xff;
  	buf[1] = (off >> 8) & 0xff;
  	if (data->addr_sz == 3)
  		buf[2] = (off >> 16) & 0xff;
  	return data->addr_sz == 2 ? 2 : 3;
  }
  
  /* read a given size of data (bounds check to be done by caller) */
  static ssize_t _picolcd_flash_read(struct picolcd_data *data, int report_id,
  		char __user *u, size_t s, loff_t *off)
  {
  	struct picolcd_pending *resp;
  	u8 raw_data[4];
  	ssize_t ret = 0;
  	int len_off, err = -EIO;
  
  	while (s > 0) {
  		err = -EIO;
  		len_off = _picolcd_flash_setaddr(data, raw_data, *off);
  		raw_data[len_off] = s > 32 ? 32 : s;
  		resp = picolcd_send_and_wait(data->hdev, report_id, raw_data, len_off+1);
  		if (!resp || !resp->in_report)
  			goto skip;
  		if (resp->in_report->id == REPORT_MEMORY ||
  			resp->in_report->id == REPORT_BL_READ_MEMORY) {
  			if (memcmp(raw_data, resp->raw_data, len_off+1) != 0)
  				goto skip;
  			if (copy_to_user(u+ret, resp->raw_data+len_off+1, raw_data[len_off])) {
  				err = -EFAULT;
  				goto skip;
  			}
  			*off += raw_data[len_off];
  			s    -= raw_data[len_off];
  			ret  += raw_data[len_off];
  			err   = 0;
  		}
  skip:
  		kfree(resp);
  		if (err)
  			return ret > 0 ? ret : err;
  	}
  	return ret;
  }
  
  static ssize_t picolcd_debug_flash_read(struct file *f, char __user *u,
  		size_t s, loff_t *off)
  {
  	struct picolcd_data *data = f->private_data;
  
  	if (s == 0)
  		return -EINVAL;
  	if (*off > 0x05fff)
  		return 0;
  	if (*off + s > 0x05fff)
  		s = 0x06000 - *off;
  
  	if (data->status & PICOLCD_BOOTLOADER)
  		return _picolcd_flash_read(data, REPORT_BL_READ_MEMORY, u, s, off);
  	else
  		return _picolcd_flash_read(data, REPORT_READ_MEMORY, u, s, off);
  }
  
  /* erase block aligned to 64bytes boundary */
  static ssize_t _picolcd_flash_erase64(struct picolcd_data *data, int report_id,
  		loff_t *off)
  {
  	struct picolcd_pending *resp;
  	u8 raw_data[3];
  	int len_off;
  	ssize_t ret = -EIO;
  
  	if (*off & 0x3f)
  		return -EINVAL;
  
  	len_off = _picolcd_flash_setaddr(data, raw_data, *off);
  	resp = picolcd_send_and_wait(data->hdev, report_id, raw_data, len_off);
  	if (!resp || !resp->in_report)
  		goto skip;
  	if (resp->in_report->id == REPORT_MEMORY ||
  		resp->in_report->id == REPORT_BL_ERASE_MEMORY) {
  		if (memcmp(raw_data, resp->raw_data, len_off) != 0)
  			goto skip;
  		ret = 0;
  	}
  skip:
  	kfree(resp);
  	return ret;
  }
  
  /* write a given size of data (bounds check to be done by caller) */
  static ssize_t _picolcd_flash_write(struct picolcd_data *data, int report_id,
  		const char __user *u, size_t s, loff_t *off)
  {
  	struct picolcd_pending *resp;
  	u8 raw_data[36];
  	ssize_t ret = 0;
  	int len_off, err = -EIO;
  
  	while (s > 0) {
  		err = -EIO;
  		len_off = _picolcd_flash_setaddr(data, raw_data, *off);
  		raw_data[len_off] = s > 32 ? 32 : s;
  		if (copy_from_user(raw_data+len_off+1, u, raw_data[len_off])) {
  			err = -EFAULT;
  			break;
  		}
  		resp = picolcd_send_and_wait(data->hdev, report_id, raw_data,
  				len_off+1+raw_data[len_off]);
  		if (!resp || !resp->in_report)
  			goto skip;
  		if (resp->in_report->id == REPORT_MEMORY ||
  			resp->in_report->id == REPORT_BL_WRITE_MEMORY) {
  			if (memcmp(raw_data, resp->raw_data, len_off+1+raw_data[len_off]) != 0)
  				goto skip;
  			*off += raw_data[len_off];
  			s    -= raw_data[len_off];
  			ret  += raw_data[len_off];
  			err   = 0;
  		}
  skip:
  		kfree(resp);
  		if (err)
  			break;
  	}
  	return ret > 0 ? ret : err;
  }
  
  static ssize_t picolcd_debug_flash_write(struct file *f, const char __user *u,
  		size_t s, loff_t *off)
  {
  	struct picolcd_data *data = f->private_data;
  	ssize_t err, ret = 0;
  	int report_erase, report_write;
  
  	if (s == 0)
  		return -EINVAL;
  	if (*off > 0x5fff)
  		return -ENOSPC;
  	if (s & 0x3f)
  		return -EINVAL;
  	if (*off & 0x3f)
  		return -EINVAL;
  
  	if (data->status & PICOLCD_BOOTLOADER) {
  		report_erase = REPORT_BL_ERASE_MEMORY;
  		report_write = REPORT_BL_WRITE_MEMORY;
  	} else {
  		report_erase = REPORT_ERASE_MEMORY;
  		report_write = REPORT_WRITE_MEMORY;
  	}
  	mutex_lock(&data->mutex_flash);
  	while (s > 0) {
  		err = _picolcd_flash_erase64(data, report_erase, off);
  		if (err)
  			break;
  		err = _picolcd_flash_write(data, report_write, u, 64, off);
  		if (err < 0)
  			break;
  		ret += err;
  		*off += err;
  		s -= err;
  		if (err != 64)
  			break;
  	}
  	mutex_unlock(&data->mutex_flash);
  	return ret > 0 ? ret : err;
  }
  
  /*
   * Notes:
   * - concurrent writing is prevented by mutex and all writes must be
   *   n*64 bytes and 64-byte aligned, each write being preceded by an
   *   ERASE which erases a 64byte block.
   *   If less than requested was written or an error is returned for an
   *   otherwise correct write request the next 64-byte block which should
   *   have been written is in undefined state (mostly: original, erased,
   *   (half-)written with write error)
   * - reading can happen without special restriction
   */
  static const struct file_operations picolcd_debug_flash_fops = {
  	.owner    = THIS_MODULE,
  	.open     = simple_open,
  	.read     = picolcd_debug_flash_read,
  	.write    = picolcd_debug_flash_write,
  	.llseek   = generic_file_llseek,
  };
  
  
  /*
   * Helper code for HID report level dumping/debugging
   */
  static const char * const error_codes[] = {
  	"success", "parameter missing", "data_missing", "block readonly",
  	"block not erasable", "block too big", "section overflow",
  	"invalid command length", "invalid data length",
  };
  
  static void dump_buff_as_hex(char *dst, size_t dst_sz, const u8 *data,
  		const size_t data_len)
  {
  	int i, j;
  	for (i = j = 0; i < data_len && j + 4 < dst_sz; i++) {
  		dst[j++] = hex_asc[(data[i] >> 4) & 0x0f];
  		dst[j++] = hex_asc[data[i] & 0x0f];
  		dst[j++] = ' ';
  	}
  	dst[j]   = '\0';
  	if (j > 0)
  		dst[j-1] = '
  ';
  	if (i < data_len && j > 2)
  		dst[j-2] = dst[j-3] = '.';
  }
  
  void picolcd_debug_out_report(struct picolcd_data *data,
  		struct hid_device *hdev, struct hid_report *report)
  {
  	u8 *raw_data;
  	int raw_size = (report->size >> 3) + 1;
  	char *buff;
  #define BUFF_SZ 256
  
  	/* Avoid unnecessary overhead if debugfs is disabled */
  	if (list_empty(&hdev->debug_list))
  		return;
  
  	buff = kmalloc(BUFF_SZ, GFP_ATOMIC);
  	if (!buff)
  		return;
  
  	raw_data = hid_alloc_report_buf(report, GFP_ATOMIC);
  	if (!raw_data) {
  		kfree(buff);
  		return;
  	}
  
  	snprintf(buff, BUFF_SZ, "
  out report %d (size %d) =  ",
  			report->id, raw_size);
  	hid_debug_event(hdev, buff);
  	raw_data[0] = report->id;
  	hid_output_report(report, raw_data);
  	dump_buff_as_hex(buff, BUFF_SZ, raw_data, raw_size);
  	hid_debug_event(hdev, buff);
  
  	switch (report->id) {
  	case REPORT_LED_STATE:
  		/* 1 data byte with GPO state */
  		snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)
  ",
  			"REPORT_LED_STATE", report->id, raw_size-1);
  		hid_debug_event(hdev, buff);
  		snprintf(buff, BUFF_SZ, "\tGPO state: 0x%02x
  ", raw_data[1]);
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_BRIGHTNESS:
  		/* 1 data byte with brightness */
  		snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)
  ",
  			"REPORT_BRIGHTNESS", report->id, raw_size-1);
  		hid_debug_event(hdev, buff);
  		snprintf(buff, BUFF_SZ, "\tBrightness: 0x%02x
  ", raw_data[1]);
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_CONTRAST:
  		/* 1 data byte with contrast */
  		snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)
  ",
  			"REPORT_CONTRAST", report->id, raw_size-1);
  		hid_debug_event(hdev, buff);
  		snprintf(buff, BUFF_SZ, "\tContrast: 0x%02x
  ", raw_data[1]);
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_RESET:
  		/* 2 data bytes with reset duration in ms */
  		snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)
  ",
  			"REPORT_RESET", report->id, raw_size-1);
  		hid_debug_event(hdev, buff);
  		snprintf(buff, BUFF_SZ, "\tDuration: 0x%02x%02x (%dms)
  ",
  				raw_data[2], raw_data[1], raw_data[2] << 8 | raw_data[1]);
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_LCD_CMD:
  		/* 63 data bytes with LCD commands */
  		snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)
  ",
  			"REPORT_LCD_CMD", report->id, raw_size-1);
  		hid_debug_event(hdev, buff);
  		/* TODO: format decoding */
  		break;
  	case REPORT_LCD_DATA:
  		/* 63 data bytes with LCD data */
  		snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)
  ",
  			"REPORT_LCD_CMD", report->id, raw_size-1);
  		/* TODO: format decoding */
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_LCD_CMD_DATA:
  		/* 63 data bytes with LCD commands and data */
  		snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)
  ",
  			"REPORT_LCD_CMD", report->id, raw_size-1);
  		/* TODO: format decoding */
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_EE_READ:
  		/* 3 data bytes with read area description */
  		snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)
  ",
  			"REPORT_EE_READ", report->id, raw_size-1);
  		hid_debug_event(hdev, buff);
  		snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x
  ",
  				raw_data[2], raw_data[1]);
  		hid_debug_event(hdev, buff);
  		snprintf(buff, BUFF_SZ, "\tData length: %d
  ", raw_data[3]);
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_EE_WRITE:
  		/* 3+1..20 data bytes with write area description */
  		snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)
  ",
  			"REPORT_EE_WRITE", report->id, raw_size-1);
  		hid_debug_event(hdev, buff);
  		snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x
  ",
  				raw_data[2], raw_data[1]);
  		hid_debug_event(hdev, buff);
  		snprintf(buff, BUFF_SZ, "\tData length: %d
  ", raw_data[3]);
  		hid_debug_event(hdev, buff);
  		if (raw_data[3] == 0) {
  			snprintf(buff, BUFF_SZ, "\tNo data
  ");
  		} else if (raw_data[3] + 4 <= raw_size) {
  			snprintf(buff, BUFF_SZ, "\tData: ");
  			hid_debug_event(hdev, buff);
  			dump_buff_as_hex(buff, BUFF_SZ, raw_data+4, raw_data[3]);
  		} else {
  			snprintf(buff, BUFF_SZ, "\tData overflowed
  ");
  		}
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_ERASE_MEMORY:
  	case REPORT_BL_ERASE_MEMORY:
  		/* 3 data bytes with pointer inside erase block */
  		snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)
  ",
  			"REPORT_ERASE_MEMORY", report->id, raw_size-1);
  		hid_debug_event(hdev, buff);
  		switch (data->addr_sz) {
  		case 2:
  			snprintf(buff, BUFF_SZ, "\tAddress inside 64 byte block: 0x%02x%02x
  ",
  					raw_data[2], raw_data[1]);
  			break;
  		case 3:
  			snprintf(buff, BUFF_SZ, "\tAddress inside 64 byte block: 0x%02x%02x%02x
  ",
  					raw_data[3], raw_data[2], raw_data[1]);
  			break;
  		default:
  			snprintf(buff, BUFF_SZ, "\tNot supported
  ");
  		}
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_READ_MEMORY:
  	case REPORT_BL_READ_MEMORY:
  		/* 4 data bytes with read area description */
  		snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)
  ",
  			"REPORT_READ_MEMORY", report->id, raw_size-1);
  		hid_debug_event(hdev, buff);
  		switch (data->addr_sz) {
  		case 2:
  			snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x
  ",
  					raw_data[2], raw_data[1]);
  			hid_debug_event(hdev, buff);
  			snprintf(buff, BUFF_SZ, "\tData length: %d
  ", raw_data[3]);
  			break;
  		case 3:
  			snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x%02x
  ",
  					raw_data[3], raw_data[2], raw_data[1]);
  			hid_debug_event(hdev, buff);
  			snprintf(buff, BUFF_SZ, "\tData length: %d
  ", raw_data[4]);
  			break;
  		default:
  			snprintf(buff, BUFF_SZ, "\tNot supported
  ");
  		}
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_WRITE_MEMORY:
  	case REPORT_BL_WRITE_MEMORY:
  		/* 4+1..32 data bytes with write adrea description */
  		snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)
  ",
  			"REPORT_WRITE_MEMORY", report->id, raw_size-1);
  		hid_debug_event(hdev, buff);
  		switch (data->addr_sz) {
  		case 2:
  			snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x
  ",
  					raw_data[2], raw_data[1]);
  			hid_debug_event(hdev, buff);
  			snprintf(buff, BUFF_SZ, "\tData length: %d
  ", raw_data[3]);
  			hid_debug_event(hdev, buff);
  			if (raw_data[3] == 0) {
  				snprintf(buff, BUFF_SZ, "\tNo data
  ");
  			} else if (raw_data[3] + 4 <= raw_size) {
  				snprintf(buff, BUFF_SZ, "\tData: ");
  				hid_debug_event(hdev, buff);
  				dump_buff_as_hex(buff, BUFF_SZ, raw_data+4, raw_data[3]);
  			} else {
  				snprintf(buff, BUFF_SZ, "\tData overflowed
  ");
  			}
  			break;
  		case 3:
  			snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x%02x
  ",
  					raw_data[3], raw_data[2], raw_data[1]);
  			hid_debug_event(hdev, buff);
  			snprintf(buff, BUFF_SZ, "\tData length: %d
  ", raw_data[4]);
  			hid_debug_event(hdev, buff);
  			if (raw_data[4] == 0) {
  				snprintf(buff, BUFF_SZ, "\tNo data
  ");
  			} else if (raw_data[4] + 5 <= raw_size) {
  				snprintf(buff, BUFF_SZ, "\tData: ");
  				hid_debug_event(hdev, buff);
  				dump_buff_as_hex(buff, BUFF_SZ, raw_data+5, raw_data[4]);
  			} else {
  				snprintf(buff, BUFF_SZ, "\tData overflowed
  ");
  			}
  			break;
  		default:
  			snprintf(buff, BUFF_SZ, "\tNot supported
  ");
  		}
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_SPLASH_RESTART:
  		/* TODO */
  		break;
  	case REPORT_EXIT_KEYBOARD:
  		snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)
  ",
  			"REPORT_EXIT_KEYBOARD", report->id, raw_size-1);
  		hid_debug_event(hdev, buff);
  		snprintf(buff, BUFF_SZ, "\tRestart delay: %dms (0x%02x%02x)
  ",
  				raw_data[1] | (raw_data[2] << 8),
  				raw_data[2], raw_data[1]);
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_VERSION:
  		snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)
  ",
  			"REPORT_VERSION", report->id, raw_size-1);
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_DEVID:
  		snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)
  ",
  			"REPORT_DEVID", report->id, raw_size-1);
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_SPLASH_SIZE:
  		snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)
  ",
  			"REPORT_SPLASH_SIZE", report->id, raw_size-1);
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_HOOK_VERSION:
  		snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)
  ",
  			"REPORT_HOOK_VERSION", report->id, raw_size-1);
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_EXIT_FLASHER:
  		snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)
  ",
  			"REPORT_VERSION", report->id, raw_size-1);
  		hid_debug_event(hdev, buff);
  		snprintf(buff, BUFF_SZ, "\tRestart delay: %dms (0x%02x%02x)
  ",
  				raw_data[1] | (raw_data[2] << 8),
  				raw_data[2], raw_data[1]);
  		hid_debug_event(hdev, buff);
  		break;
  	default:
  		snprintf(buff, BUFF_SZ, "out report %s (%d, size=%d)
  ",
  			"<unknown>", report->id, raw_size-1);
  		hid_debug_event(hdev, buff);
  		break;
  	}
  	wake_up_interruptible(&hdev->debug_wait);
  	kfree(raw_data);
  	kfree(buff);
  }
  
  void picolcd_debug_raw_event(struct picolcd_data *data,
  		struct hid_device *hdev, struct hid_report *report,
  		u8 *raw_data, int size)
  {
  	char *buff;
  
  #define BUFF_SZ 256
  	/* Avoid unnecessary overhead if debugfs is disabled */
  	if (list_empty(&hdev->debug_list))
  		return;
  
  	buff = kmalloc(BUFF_SZ, GFP_ATOMIC);
  	if (!buff)
  		return;
  
  	switch (report->id) {
  	case REPORT_ERROR_CODE:
  		/* 2 data bytes with affected report and error code */
  		snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)
  ",
  			"REPORT_ERROR_CODE", report->id, size-1);
  		hid_debug_event(hdev, buff);
  		if (raw_data[2] < ARRAY_SIZE(error_codes))
  			snprintf(buff, BUFF_SZ, "\tError code 0x%02x (%s) in reply to report 0x%02x
  ",
  					raw_data[2], error_codes[raw_data[2]], raw_data[1]);
  		else
  			snprintf(buff, BUFF_SZ, "\tError code 0x%02x in reply to report 0x%02x
  ",
  					raw_data[2], raw_data[1]);
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_KEY_STATE:
  		/* 2 data bytes with key state */
  		snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)
  ",
  			"REPORT_KEY_STATE", report->id, size-1);
  		hid_debug_event(hdev, buff);
  		if (raw_data[1] == 0)
  			snprintf(buff, BUFF_SZ, "\tNo key pressed
  ");
  		else if (raw_data[2] == 0)
  			snprintf(buff, BUFF_SZ, "\tOne key pressed: 0x%02x (%d)
  ",
  					raw_data[1], raw_data[1]);
  		else
  			snprintf(buff, BUFF_SZ, "\tTwo keys pressed: 0x%02x (%d), 0x%02x (%d)
  ",
  					raw_data[1], raw_data[1], raw_data[2], raw_data[2]);
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_IR_DATA:
  		/* Up to 20 byes of IR scancode data */
  		snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)
  ",
  			"REPORT_IR_DATA", report->id, size-1);
  		hid_debug_event(hdev, buff);
  		if (raw_data[1] == 0) {
  			snprintf(buff, BUFF_SZ, "\tUnexpectedly 0 data length
  ");
  			hid_debug_event(hdev, buff);
  		} else if (raw_data[1] + 1 <= size) {
  			snprintf(buff, BUFF_SZ, "\tData length: %d
  \tIR Data: ",
  					raw_data[1]);
  			hid_debug_event(hdev, buff);
  			dump_buff_as_hex(buff, BUFF_SZ, raw_data+2, raw_data[1]);
  			hid_debug_event(hdev, buff);
  		} else {
  			snprintf(buff, BUFF_SZ, "\tOverflowing data length: %d
  ",
  					raw_data[1]-1);
  			hid_debug_event(hdev, buff);
  		}
  		break;
  	case REPORT_EE_DATA:
  		/* Data buffer in response to REPORT_EE_READ or REPORT_EE_WRITE */
  		snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)
  ",
  			"REPORT_EE_DATA", report->id, size-1);
  		hid_debug_event(hdev, buff);
  		snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x
  ",
  				raw_data[2], raw_data[1]);
  		hid_debug_event(hdev, buff);
  		snprintf(buff, BUFF_SZ, "\tData length: %d
  ", raw_data[3]);
  		hid_debug_event(hdev, buff);
  		if (raw_data[3] == 0) {
  			snprintf(buff, BUFF_SZ, "\tNo data
  ");
  			hid_debug_event(hdev, buff);
  		} else if (raw_data[3] + 4 <= size) {
  			snprintf(buff, BUFF_SZ, "\tData: ");
  			hid_debug_event(hdev, buff);
  			dump_buff_as_hex(buff, BUFF_SZ, raw_data+4, raw_data[3]);
  			hid_debug_event(hdev, buff);
  		} else {
  			snprintf(buff, BUFF_SZ, "\tData overflowed
  ");
  			hid_debug_event(hdev, buff);
  		}
  		break;
  	case REPORT_MEMORY:
  		/* Data buffer in response to REPORT_READ_MEMORY or REPORT_WRTIE_MEMORY */
  		snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)
  ",
  			"REPORT_MEMORY", report->id, size-1);
  		hid_debug_event(hdev, buff);
  		switch (data->addr_sz) {
  		case 2:
  			snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x
  ",
  					raw_data[2], raw_data[1]);
  			hid_debug_event(hdev, buff);
  			snprintf(buff, BUFF_SZ, "\tData length: %d
  ", raw_data[3]);
  			hid_debug_event(hdev, buff);
  			if (raw_data[3] == 0) {
  				snprintf(buff, BUFF_SZ, "\tNo data
  ");
  			} else if (raw_data[3] + 4 <= size) {
  				snprintf(buff, BUFF_SZ, "\tData: ");
  				hid_debug_event(hdev, buff);
  				dump_buff_as_hex(buff, BUFF_SZ, raw_data+4, raw_data[3]);
  			} else {
  				snprintf(buff, BUFF_SZ, "\tData overflowed
  ");
  			}
  			break;
  		case 3:
  			snprintf(buff, BUFF_SZ, "\tData address: 0x%02x%02x%02x
  ",
  					raw_data[3], raw_data[2], raw_data[1]);
  			hid_debug_event(hdev, buff);
  			snprintf(buff, BUFF_SZ, "\tData length: %d
  ", raw_data[4]);
  			hid_debug_event(hdev, buff);
  			if (raw_data[4] == 0) {
  				snprintf(buff, BUFF_SZ, "\tNo data
  ");
  			} else if (raw_data[4] + 5 <= size) {
  				snprintf(buff, BUFF_SZ, "\tData: ");
  				hid_debug_event(hdev, buff);
  				dump_buff_as_hex(buff, BUFF_SZ, raw_data+5, raw_data[4]);
  			} else {
  				snprintf(buff, BUFF_SZ, "\tData overflowed
  ");
  			}
  			break;
  		default:
  			snprintf(buff, BUFF_SZ, "\tNot supported
  ");
  		}
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_VERSION:
  		snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)
  ",
  			"REPORT_VERSION", report->id, size-1);
  		hid_debug_event(hdev, buff);
  		snprintf(buff, BUFF_SZ, "\tFirmware version: %d.%d
  ",
  				raw_data[2], raw_data[1]);
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_BL_ERASE_MEMORY:
  		snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)
  ",
  			"REPORT_BL_ERASE_MEMORY", report->id, size-1);
  		hid_debug_event(hdev, buff);
  		/* TODO */
  		break;
  	case REPORT_BL_READ_MEMORY:
  		snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)
  ",
  			"REPORT_BL_READ_MEMORY", report->id, size-1);
  		hid_debug_event(hdev, buff);
  		/* TODO */
  		break;
  	case REPORT_BL_WRITE_MEMORY:
  		snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)
  ",
  			"REPORT_BL_WRITE_MEMORY", report->id, size-1);
  		hid_debug_event(hdev, buff);
  		/* TODO */
  		break;
  	case REPORT_DEVID:
  		snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)
  ",
  			"REPORT_DEVID", report->id, size-1);
  		hid_debug_event(hdev, buff);
  		snprintf(buff, BUFF_SZ, "\tSerial: 0x%02x%02x%02x%02x
  ",
  				raw_data[1], raw_data[2], raw_data[3], raw_data[4]);
  		hid_debug_event(hdev, buff);
  		snprintf(buff, BUFF_SZ, "\tType: 0x%02x
  ",
  				raw_data[5]);
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_SPLASH_SIZE:
  		snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)
  ",
  			"REPORT_SPLASH_SIZE", report->id, size-1);
  		hid_debug_event(hdev, buff);
  		snprintf(buff, BUFF_SZ, "\tTotal splash space: %d
  ",
  				(raw_data[2] << 8) | raw_data[1]);
  		hid_debug_event(hdev, buff);
  		snprintf(buff, BUFF_SZ, "\tUsed splash space: %d
  ",
  				(raw_data[4] << 8) | raw_data[3]);
  		hid_debug_event(hdev, buff);
  		break;
  	case REPORT_HOOK_VERSION:
  		snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)
  ",
  			"REPORT_HOOK_VERSION", report->id, size-1);
  		hid_debug_event(hdev, buff);
  		snprintf(buff, BUFF_SZ, "\tFirmware version: %d.%d
  ",
  				raw_data[1], raw_data[2]);
  		hid_debug_event(hdev, buff);
  		break;
  	default:
  		snprintf(buff, BUFF_SZ, "report %s (%d, size=%d)
  ",
  			"<unknown>", report->id, size-1);
  		hid_debug_event(hdev, buff);
  		break;
  	}
  	wake_up_interruptible(&hdev->debug_wait);
  	kfree(buff);
  }
  
  void picolcd_init_devfs(struct picolcd_data *data,
  		struct hid_report *eeprom_r, struct hid_report *eeprom_w,
  		struct hid_report *flash_r, struct hid_report *flash_w,
  		struct hid_report *reset)
  {
  	struct hid_device *hdev = data->hdev;
  
  	mutex_init(&data->mutex_flash);
  
  	/* reset */
  	if (reset)
  		data->debug_reset = debugfs_create_file("reset", 0600,
  				hdev->debug_dir, data, &picolcd_debug_reset_fops);
  
  	/* eeprom */
  	if (eeprom_r || eeprom_w)
  		data->debug_eeprom = debugfs_create_file("eeprom",
  			(eeprom_w ? S_IWUSR : 0) | (eeprom_r ? S_IRUSR : 0),
  			hdev->debug_dir, data, &picolcd_debug_eeprom_fops);
  
  	/* flash */
  	if (flash_r && flash_r->maxfield == 1 && flash_r->field[0]->report_size == 8)
  		data->addr_sz = flash_r->field[0]->report_count - 1;
  	else
  		data->addr_sz = -1;
  	if (data->addr_sz == 2 || data->addr_sz == 3) {
  		data->debug_flash = debugfs_create_file("flash",
  			(flash_w ? S_IWUSR : 0) | (flash_r ? S_IRUSR : 0),
  			hdev->debug_dir, data, &picolcd_debug_flash_fops);
  	} else if (flash_r || flash_w)
  		hid_warn(hdev, "Unexpected FLASH access reports, please submit rdesc for review
  ");
  }
  
  void picolcd_exit_devfs(struct picolcd_data *data)
  {
  	struct dentry *dent;
  
  	dent = data->debug_reset;
  	data->debug_reset = NULL;
  	if (dent)
  		debugfs_remove(dent);
  	dent = data->debug_eeprom;
  	data->debug_eeprom = NULL;
  	if (dent)
  		debugfs_remove(dent);
  	dent = data->debug_flash;
  	data->debug_flash = NULL;
  	if (dent)
  		debugfs_remove(dent);
  	mutex_destroy(&data->mutex_flash);
  }