4 * Copyright (C) 2007,2008 Jakub Schmidtke (sjakub@gmail.com)
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 * This module is based on usbled and asus-laptop modules.
26 * Asus OLED support is based on asusoled program taken from
27 * https://launchpad.net/asusoled/.
32 #include <linux/kernel.h>
33 #include <linux/errno.h>
34 #include <linux/init.h>
35 #include <linux/slab.h>
36 #include <linux/module.h>
37 #include <linux/usb.h>
38 #include <linux/platform_device.h>
39 #include <linux/ctype.h>
41 #define ASUS_OLED_VERSION "0.04-dev"
42 #define ASUS_OLED_NAME "asus-oled"
43 #define ASUS_OLED_UNDERSCORE_NAME "asus_oled"
45 #define ASUS_OLED_ERROR "Asus OLED Display Error: "
47 #define ASUS_OLED_STATIC 's'
48 #define ASUS_OLED_ROLL 'r'
49 #define ASUS_OLED_FLASH 'f'
51 #define ASUS_OLED_MAX_WIDTH 1792
52 #define ASUS_OLED_DISP_HEIGHT 32
53 #define ASUS_OLED_PACKET_BUF_SIZE 256
55 #define USB_VENDOR_ID_ASUS 0x0b05
56 #define USB_DEVICE_ID_ASUS_LCM 0x1726
57 #define USB_DEVICE_ID_ASUS_LCM2 0x175b
59 MODULE_AUTHOR("Jakub Schmidtke, sjakub@gmail.com");
60 MODULE_DESCRIPTION("Asus OLED Driver v" ASUS_OLED_VERSION
);
61 MODULE_LICENSE("GPL");
63 static struct class *oled_class
;
66 static uint start_off
;
68 module_param(start_off
, uint
, 0644);
70 MODULE_PARM_DESC(start_off
,
71 "Set to 1 to switch off OLED display after it is attached");
79 struct oled_dev_desc_str
{
82 /* width of display */
84 /* formula to be used while packing the picture */
85 enum oled_pack_mode packMode
;
89 /* table of devices that work with this driver */
90 static const struct usb_device_id id_table
[] = {
91 /* Asus G1/G2 (and variants)*/
92 { USB_DEVICE(USB_VENDOR_ID_ASUS
, USB_DEVICE_ID_ASUS_LCM
) },
93 /* Asus G50V (and possibly others - G70? G71?)*/
94 { USB_DEVICE(USB_VENDOR_ID_ASUS
, USB_DEVICE_ID_ASUS_LCM2
) },
98 /* parameters of specific devices */
99 static struct oled_dev_desc_str oled_dev_desc_table
[] = {
100 { USB_VENDOR_ID_ASUS
, USB_DEVICE_ID_ASUS_LCM
, 128, PACK_MODE_G1
,
102 { USB_VENDOR_ID_ASUS
, USB_DEVICE_ID_ASUS_LCM2
, 256, PACK_MODE_G50
,
107 MODULE_DEVICE_TABLE(usb
, id_table
);
109 struct asus_oled_header
{
120 } __attribute((packed
));
122 struct asus_oled_packet
{
123 struct asus_oled_header header
;
124 uint8_t bitmap
[ASUS_OLED_PACKET_BUF_SIZE
];
125 } __attribute((packed
));
127 struct asus_oled_dev
{
128 struct usb_device
*udev
;
131 enum oled_pack_mode pack_mode
;
144 static void setup_packet_header(struct asus_oled_packet
*packet
, char flags
,
145 char value3
, char buffer1
, char buffer2
, char value6
,
146 char value7
, char value8
)
148 memset(packet
, 0, sizeof(struct asus_oled_header
));
149 packet
->header
.magic1
= 0x55;
150 packet
->header
.magic2
= 0xaa;
151 packet
->header
.flags
= flags
;
152 packet
->header
.value3
= value3
;
153 packet
->header
.buffer1
= buffer1
;
154 packet
->header
.buffer2
= buffer2
;
155 packet
->header
.value6
= value6
;
156 packet
->header
.value7
= value7
;
157 packet
->header
.value8
= value8
;
160 static void enable_oled(struct asus_oled_dev
*odev
, uint8_t enabl
)
165 struct asus_oled_packet
*packet
;
167 packet
= kzalloc(sizeof(struct asus_oled_packet
), GFP_KERNEL
);
170 dev_err(&odev
->udev
->dev
, "out of memory\n");
174 setup_packet_header(packet
, 0x20, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00);
177 packet
->bitmap
[0] = 0xaf;
179 packet
->bitmap
[0] = 0xae;
181 for (a
= 0; a
< 1; a
++) {
182 retval
= usb_bulk_msg(odev
->udev
,
183 usb_sndbulkpipe(odev
->udev
, 2),
185 sizeof(struct asus_oled_header
) + 1,
190 dev_dbg(&odev
->udev
->dev
, "retval = %d\n", retval
);
193 odev
->enabled
= enabl
;
198 static ssize_t
set_enabled(struct device
*dev
, struct device_attribute
*attr
,
199 const char *buf
, size_t count
)
201 struct usb_interface
*intf
= to_usb_interface(dev
);
202 struct asus_oled_dev
*odev
= usb_get_intfdata(intf
);
204 if (strict_strtoul(buf
, 10, &value
))
207 enable_oled(odev
, value
);
212 static ssize_t
class_set_enabled(struct device
*device
,
213 struct device_attribute
*attr
,
214 const char *buf
, size_t count
)
216 struct asus_oled_dev
*odev
=
217 (struct asus_oled_dev
*) dev_get_drvdata(device
);
220 if (strict_strtoul(buf
, 10, &value
))
223 enable_oled(odev
, value
);
228 static ssize_t
get_enabled(struct device
*dev
, struct device_attribute
*attr
,
231 struct usb_interface
*intf
= to_usb_interface(dev
);
232 struct asus_oled_dev
*odev
= usb_get_intfdata(intf
);
234 return sprintf(buf
, "%d\n", odev
->enabled
);
237 static ssize_t
class_get_enabled(struct device
*device
,
238 struct device_attribute
*attr
, char *buf
)
240 struct asus_oled_dev
*odev
=
241 (struct asus_oled_dev
*) dev_get_drvdata(device
);
243 return sprintf(buf
, "%d\n", odev
->enabled
);
246 static void send_packets(struct usb_device
*udev
,
247 struct asus_oled_packet
*packet
,
248 char *buf
, uint8_t p_type
, size_t p_num
)
253 for (i
= 0; i
< p_num
; i
++) {
258 setup_packet_header(packet
, 0x40, 0x80, p_num
,
259 i
+ 1, 0x00, 0x01, 0xff);
261 case ASUS_OLED_STATIC
:
262 setup_packet_header(packet
, 0x10 + i
, 0x80, 0x01,
263 0x01, 0x00, 0x01, 0x00);
265 case ASUS_OLED_FLASH
:
266 setup_packet_header(packet
, 0x10 + i
, 0x80, 0x01,
267 0x01, 0x00, 0x00, 0xff);
271 memcpy(packet
->bitmap
, buf
+ (ASUS_OLED_PACKET_BUF_SIZE
*i
),
272 ASUS_OLED_PACKET_BUF_SIZE
);
274 retval
= usb_bulk_msg(udev
, usb_sndctrlpipe(udev
, 2),
275 packet
, sizeof(struct asus_oled_packet
),
279 dev_dbg(&udev
->dev
, "retval = %d\n", retval
);
283 static void send_packet(struct usb_device
*udev
,
284 struct asus_oled_packet
*packet
,
285 size_t offset
, size_t len
, char *buf
, uint8_t b1
,
286 uint8_t b2
, uint8_t b3
, uint8_t b4
, uint8_t b5
,
291 setup_packet_header(packet
, b1
, b2
, b3
, b4
, b5
, b6
, 0x00);
292 memcpy(packet
->bitmap
, buf
+ offset
, len
);
294 retval
= usb_bulk_msg(udev
,
295 usb_sndctrlpipe(udev
, 2),
297 sizeof(struct asus_oled_packet
),
302 dev_dbg(&udev
->dev
, "retval = %d\n", retval
);
306 static void send_packets_g50(struct usb_device
*udev
,
307 struct asus_oled_packet
*packet
, char *buf
)
309 send_packet(udev
, packet
, 0, 0x100, buf
,
310 0x10, 0x00, 0x02, 0x01, 0x00, 0x01);
311 send_packet(udev
, packet
, 0x100, 0x080, buf
,
312 0x10, 0x00, 0x02, 0x02, 0x80, 0x00);
314 send_packet(udev
, packet
, 0x180, 0x100, buf
,
315 0x11, 0x00, 0x03, 0x01, 0x00, 0x01);
316 send_packet(udev
, packet
, 0x280, 0x100, buf
,
317 0x11, 0x00, 0x03, 0x02, 0x00, 0x01);
318 send_packet(udev
, packet
, 0x380, 0x080, buf
,
319 0x11, 0x00, 0x03, 0x03, 0x80, 0x00);
323 static void send_data(struct asus_oled_dev
*odev
)
325 size_t packet_num
= odev
->buf_size
/ ASUS_OLED_PACKET_BUF_SIZE
;
326 struct asus_oled_packet
*packet
;
328 packet
= kzalloc(sizeof(struct asus_oled_packet
), GFP_KERNEL
);
331 dev_err(&odev
->udev
->dev
, "out of memory\n");
335 if (odev
->pack_mode
== PACK_MODE_G1
) {
336 /* When sending roll-mode data the display updated only
337 first packet. I have no idea why, but when static picture
338 is sent just before rolling picture everything works fine. */
339 if (odev
->pic_mode
== ASUS_OLED_ROLL
)
340 send_packets(odev
->udev
, packet
, odev
->buf
,
341 ASUS_OLED_STATIC
, 2);
343 /* Only ROLL mode can use more than 2 packets.*/
344 if (odev
->pic_mode
!= ASUS_OLED_ROLL
&& packet_num
> 2)
347 send_packets(odev
->udev
, packet
, odev
->buf
,
348 odev
->pic_mode
, packet_num
);
349 } else if (odev
->pack_mode
== PACK_MODE_G50
) {
350 send_packets_g50(odev
->udev
, packet
, odev
->buf
);
356 static int append_values(struct asus_oled_dev
*odev
, uint8_t val
, size_t count
)
358 while (count
-- > 0 && val
) {
359 size_t x
= odev
->buf_offs
% odev
->width
;
360 size_t y
= odev
->buf_offs
/ odev
->width
;
366 switch (odev
->pack_mode
) {
368 /* i = (x/128)*640 + 127 - x + (y/8)*128;
369 This one for 128 is the same, but might be better
370 for different widths? */
371 i
= (x
/odev
->dev_width
)*640 +
372 odev
->dev_width
- 1 - x
+
373 (y
/8)*odev
->dev_width
;
377 i
= (odev
->dev_width
- 1 - x
)/8 + y
*odev
->dev_width
/8;
382 printk(ASUS_OLED_ERROR
"Unknown OLED Pack Mode: %d!\n",
387 if (i
>= odev
->buf_size
) {
388 printk(ASUS_OLED_ERROR
"Buffer overflow! Report a bug:"
389 "offs: %d >= %d i: %d (x: %d y: %d)\n",
390 (int) odev
->buf_offs
, (int) odev
->buf_size
,
391 (int) i
, (int) x
, (int) y
);
395 switch (odev
->pack_mode
) {
397 odev
->buf
[i
] &= ~(1<<(y
%8));
401 odev
->buf
[i
] &= ~(1<<(x
%8));
405 /* cannot get here; stops gcc complaining*/
409 odev
->last_val
= val
;
416 static ssize_t
odev_set_picture(struct asus_oled_dev
*odev
,
417 const char *buf
, size_t count
)
419 size_t offs
= 0, max_offs
;
424 if (tolower(buf
[0]) == 'b') {
425 /* binary mode, set the entire memory*/
429 odev
->buf_size
= (odev
->dev_width
* ASUS_OLED_DISP_HEIGHT
) / 8;
432 odev
->buf
= kmalloc(odev
->buf_size
, GFP_KERNEL
);
433 if (odev
->buf
== NULL
) {
435 printk(ASUS_OLED_ERROR
"Out of memory!\n");
439 memset(odev
->buf
, 0xff, odev
->buf_size
);
441 for (i
= 1; i
< count
&& i
<= 32 * 32; i
++) {
442 odev
->buf
[i
-1] = buf
[i
];
443 odev
->buf_offs
= i
-1;
446 odev
->width
= odev
->dev_width
/ 8;
447 odev
->height
= ASUS_OLED_DISP_HEIGHT
;
462 if (count
< 10 || buf
[2] != ':')
466 switch (tolower(buf
[1])) {
467 case ASUS_OLED_STATIC
:
469 case ASUS_OLED_FLASH
:
470 odev
->pic_mode
= buf
[1];
473 printk(ASUS_OLED_ERROR
"Wrong picture mode: '%c'.\n",
479 for (i
= 3; i
< count
; ++i
) {
480 if (buf
[i
] >= '0' && buf
[i
] <= '9') {
481 w
= 10*w
+ (buf
[i
] - '0');
483 if (w
> ASUS_OLED_MAX_WIDTH
)
485 } else if (tolower(buf
[i
]) == 'x') {
492 for (++i
; i
< count
; ++i
) {
493 if (buf
[i
] >= '0' && buf
[i
] <= '9') {
494 h
= 10*h
+ (buf
[i
] - '0');
496 if (h
> ASUS_OLED_DISP_HEIGHT
)
498 } else if (tolower(buf
[i
]) == '>') {
505 if (w
< 1 || w
> ASUS_OLED_MAX_WIDTH
)
508 if (h
< 1 || h
> ASUS_OLED_DISP_HEIGHT
)
511 if (i
>= count
|| buf
[i
] != '>')
516 if (w
% (odev
->dev_width
) != 0)
517 w_mem
= (w
/(odev
->dev_width
) + 1)*(odev
->dev_width
);
521 if (h
< ASUS_OLED_DISP_HEIGHT
)
522 h_mem
= ASUS_OLED_DISP_HEIGHT
;
526 odev
->buf_size
= w_mem
* h_mem
/ 8;
529 odev
->buf
= kmalloc(odev
->buf_size
, GFP_KERNEL
);
531 if (odev
->buf
== NULL
) {
533 printk(ASUS_OLED_ERROR
"Out of memory!\n");
537 memset(odev
->buf
, 0xff, odev
->buf_size
);
546 if (odev
->pic_mode
== ASUS_OLED_FLASH
) {
547 if (h
< ASUS_OLED_DISP_HEIGHT
/2)
548 odev
->y_shift
= (ASUS_OLED_DISP_HEIGHT
/2 - h
)/2;
550 if (h
< ASUS_OLED_DISP_HEIGHT
)
551 odev
->y_shift
= (ASUS_OLED_DISP_HEIGHT
- h
)/2;
554 if (w
< (odev
->dev_width
))
555 odev
->x_shift
= ((odev
->dev_width
) - w
)/2;
558 max_offs
= odev
->width
* odev
->height
;
560 while (offs
< count
&& odev
->buf_offs
< max_offs
) {
563 if (buf
[offs
] == '1' || buf
[offs
] == '#') {
564 ret
= append_values(odev
, 1, 1);
567 } else if (buf
[offs
] == '0' || buf
[offs
] == ' ') {
568 ret
= append_values(odev
, 0, 1);
571 } else if (buf
[offs
] == '\n') {
572 /* New line detected. Lets assume, that all characters
573 till the end of the line were equal to the last
574 character in this line.*/
575 if (odev
->buf_offs
% odev
->width
!= 0)
576 ret
= append_values(odev
, odev
->last_val
,
587 if (odev
->buf_offs
>= max_offs
)
593 printk(ASUS_OLED_ERROR
"Wrong picture width specified.\n");
597 printk(ASUS_OLED_ERROR
"Wrong picture height specified.\n");
601 printk(ASUS_OLED_ERROR
"Wrong picture header.\n");
605 static ssize_t
set_picture(struct device
*dev
, struct device_attribute
*attr
,
606 const char *buf
, size_t count
)
608 struct usb_interface
*intf
= to_usb_interface(dev
);
610 return odev_set_picture(usb_get_intfdata(intf
), buf
, count
);
613 static ssize_t
class_set_picture(struct device
*device
,
614 struct device_attribute
*attr
,
615 const char *buf
, size_t count
)
617 return odev_set_picture((struct asus_oled_dev
*)
618 dev_get_drvdata(device
), buf
, count
);
621 #define ASUS_OLED_DEVICE_ATTR(_file) dev_attr_asus_oled_##_file
623 static DEVICE_ATTR(asus_oled_enabled
, S_IWUGO
| S_IRUGO
,
624 get_enabled
, set_enabled
);
625 static DEVICE_ATTR(asus_oled_picture
, S_IWUGO
, NULL
, set_picture
);
627 static DEVICE_ATTR(enabled
, S_IWUGO
| S_IRUGO
,
628 class_get_enabled
, class_set_enabled
);
629 static DEVICE_ATTR(picture
, S_IWUGO
, NULL
, class_set_picture
);
631 static int asus_oled_probe(struct usb_interface
*interface
,
632 const struct usb_device_id
*id
)
634 struct usb_device
*udev
= interface_to_usbdev(interface
);
635 struct asus_oled_dev
*odev
= NULL
;
636 int retval
= -ENOMEM
;
637 uint16_t dev_width
= 0;
638 enum oled_pack_mode pack_mode
= PACK_MODE_LAST
;
639 const struct oled_dev_desc_str
*dev_desc
= oled_dev_desc_table
;
640 const char *desc
= NULL
;
643 /* Even possible? Just to make sure...*/
644 dev_err(&interface
->dev
, "No usb_device_id provided!\n");
648 for (; dev_desc
->idVendor
; dev_desc
++) {
649 if (dev_desc
->idVendor
== id
->idVendor
650 && dev_desc
->idProduct
== id
->idProduct
) {
651 dev_width
= dev_desc
->devWidth
;
652 desc
= dev_desc
->devDesc
;
653 pack_mode
= dev_desc
->packMode
;
658 if (!desc
|| dev_width
< 1 || pack_mode
== PACK_MODE_LAST
) {
659 dev_err(&interface
->dev
,
660 "Missing or incomplete device description!\n");
664 odev
= kzalloc(sizeof(struct asus_oled_dev
), GFP_KERNEL
);
667 dev_err(&interface
->dev
, "Out of memory\n");
671 odev
->udev
= usb_get_dev(udev
);
672 odev
->pic_mode
= ASUS_OLED_STATIC
;
673 odev
->dev_width
= dev_width
;
674 odev
->pack_mode
= pack_mode
;
686 usb_set_intfdata(interface
, odev
);
688 retval
= device_create_file(&interface
->dev
,
689 &ASUS_OLED_DEVICE_ATTR(enabled
));
693 retval
= device_create_file(&interface
->dev
,
694 &ASUS_OLED_DEVICE_ATTR(picture
));
698 odev
->dev
= device_create(oled_class
, &interface
->dev
, MKDEV(0, 0),
699 NULL
, "oled_%d", ++oled_num
);
701 if (IS_ERR(odev
->dev
)) {
702 retval
= PTR_ERR(odev
->dev
);
706 dev_set_drvdata(odev
->dev
, odev
);
708 retval
= device_create_file(odev
->dev
, &dev_attr_enabled
);
710 goto err_class_enabled
;
712 retval
= device_create_file(odev
->dev
, &dev_attr_picture
);
714 goto err_class_picture
;
716 dev_info(&interface
->dev
,
717 "Attached Asus OLED device: %s [width %u, pack_mode %d]\n",
718 desc
, odev
->dev_width
, odev
->pack_mode
);
721 enable_oled(odev
, 0);
726 device_remove_file(odev
->dev
, &dev_attr_picture
);
729 device_remove_file(odev
->dev
, &dev_attr_enabled
);
730 device_unregister(odev
->dev
);
733 device_remove_file(&interface
->dev
, &ASUS_OLED_DEVICE_ATTR(enabled
));
734 device_remove_file(&interface
->dev
, &ASUS_OLED_DEVICE_ATTR(picture
));
736 usb_set_intfdata(interface
, NULL
);
737 usb_put_dev(odev
->udev
);
743 static void asus_oled_disconnect(struct usb_interface
*interface
)
745 struct asus_oled_dev
*odev
;
747 odev
= usb_get_intfdata(interface
);
748 usb_set_intfdata(interface
, NULL
);
750 device_remove_file(odev
->dev
, &dev_attr_picture
);
751 device_remove_file(odev
->dev
, &dev_attr_enabled
);
752 device_unregister(odev
->dev
);
754 device_remove_file(&interface
->dev
, &ASUS_OLED_DEVICE_ATTR(picture
));
755 device_remove_file(&interface
->dev
, &ASUS_OLED_DEVICE_ATTR(enabled
));
757 usb_put_dev(odev
->udev
);
763 dev_info(&interface
->dev
, "Disconnected Asus OLED device\n");
766 static struct usb_driver oled_driver
= {
767 .name
= ASUS_OLED_NAME
,
768 .probe
= asus_oled_probe
,
769 .disconnect
= asus_oled_disconnect
,
770 .id_table
= id_table
,
773 static CLASS_ATTR_STRING(version
, S_IRUGO
,
774 ASUS_OLED_UNDERSCORE_NAME
" " ASUS_OLED_VERSION
);
776 static int __init
asus_oled_init(void)
779 oled_class
= class_create(THIS_MODULE
, ASUS_OLED_UNDERSCORE_NAME
);
781 if (IS_ERR(oled_class
)) {
782 err("Error creating " ASUS_OLED_UNDERSCORE_NAME
" class");
783 return PTR_ERR(oled_class
);
786 retval
= class_create_file(oled_class
, &class_attr_version
.attr
);
788 err("Error creating class version file");
792 retval
= usb_register(&oled_driver
);
795 err("usb_register failed. Error number %d", retval
);
802 class_destroy(oled_class
);
806 static void __exit
asus_oled_exit(void)
808 class_remove_file(oled_class
, &class_attr_version
.attr
);
809 class_destroy(oled_class
);
811 usb_deregister(&oled_driver
);
814 module_init(asus_oled_init
);
815 module_exit(asus_oled_exit
);