hid-picolcd.c 57 KB

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