drivers/usb/misc/appledisplay.c

   1 /*
   2  * Apple Cinema Display driver
   3  *
   4  * Copyright (C) 2006  Michael Hanselmann (linux-kernel@hansmi.ch)
   5  *
   6  * Thanks to Caskey L. Dickson for his work with acdctl.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  */
  22
  23 #include <linux/kernel.h>
  24 #include <linux/errno.h>
  25 #include <linux/init.h>
  26 #include <linux/module.h>
  27 #include <linux/usb.h>
  28 #include <linux/backlight.h>
  29 #include <linux/timer.h>
  30 #include <linux/workqueue.h>
  31 #include <asm/atomic.h>
  32 #include <asm/semaphore.h>
  33
  34 #define APPLE_VENDOR_ID         0x05AC
  35
  36 #define USB_REQ_GET_REPORT      0x01
  37 #define USB_REQ_SET_REPORT      0x09
  38
  39 #define ACD_USB_TIMEOUT         250
  40
  41 #define ACD_USB_EDID            0x0302
  42 #define ACD_USB_BRIGHTNESS      0x0310
  43
  44 #define ACD_BTN_NONE            0
  45 #define ACD_BTN_BRIGHT_UP       3
  46 #define ACD_BTN_BRIGHT_DOWN     4
  47
  48 #define ACD_URB_BUFFER_LEN      2
  49 #define ACD_MSG_BUFFER_LEN      2
  50
  51 #define APPLEDISPLAY_DEVICE(prod)                               \
  52         .match_flags = USB_DEVICE_ID_MATCH_DEVICE |             \
  53                        USB_DEVICE_ID_MATCH_INT_CLASS |          \
  54                        USB_DEVICE_ID_MATCH_INT_PROTOCOL,        \
  55         .idVendor = APPLE_VENDOR_ID,                            \
  56         .idProduct = (prod),                                    \
  57         .bInterfaceClass = USB_CLASS_HID,                       \
  58         .bInterfaceProtocol = 0x00
  59
  60 /* table of devices that work with this driver */
  61 static struct usb_device_id appledisplay_table [] = {
  62         { APPLEDISPLAY_DEVICE(0x9218) },
  63         { APPLEDISPLAY_DEVICE(0x9219) },
  64         { APPLEDISPLAY_DEVICE(0x921d) },
  65
  66         /* Terminating entry */
  67         { }
  68 };
  69 MODULE_DEVICE_TABLE(usb, appledisplay_table);
  70
  71 /* Structure to hold all of our device specific stuff */
  72 struct appledisplay {
  73         struct usb_device *udev;        /* usb device */
  74         struct urb *urb;                /* usb request block */
  75         struct backlight_device *bd;    /* backlight device */
  76         char *urbdata;                  /* interrupt URB data buffer */
  77         char *msgdata;                  /* control message data buffer */
  78
  79         struct work_struct work;
  80         int button_pressed;
  81         spinlock_t lock;
  82 };
  83
  84 static atomic_t count_displays = ATOMIC_INIT(0);
  85 static struct workqueue_struct *wq;
  86
  87 static void appledisplay_complete(struct urb *urb)
  88 {
  89         struct appledisplay *pdata = urb->context;
  90         unsigned long flags;
  91         int retval;
  92
  93         switch (urb->status) {
  94         case 0:
  95                 /* success */
  96                 break;
  97         case -EOVERFLOW:
  98                 printk(KERN_ERR "appletouch: OVERFLOW with data "
  99                         "length %d, actual length is %d\n",
 100                         ACD_URB_BUFFER_LEN, pdata->urb->actual_length);
 101         case -ECONNRESET:
 102         case -ENOENT:
 103         case -ESHUTDOWN:
 104                 /* This urb is terminated, clean up */
 105                 dbg("%s - urb shutting down with status: %d",
 106                         __FUNCTION__, urb->status);
 107                 return;
 108         default:
 109                 dbg("%s - nonzero urb status received: %d",
 110                         __FUNCTION__, urb->status);
 111                 goto exit;
 112         }
 113
 114         spin_lock_irqsave(&pdata->lock, flags);
 115
 116         switch(pdata->urbdata[1]) {
 117         case ACD_BTN_BRIGHT_UP:
 118         case ACD_BTN_BRIGHT_DOWN:
 119                 pdata->button_pressed = 1;
 120                 queue_work(wq, &pdata->work);
 121                 break;
 122         case ACD_BTN_NONE:
 123         default:
 124                 pdata->button_pressed = 0;
 125                 break;
 126         }
 127
 128         spin_unlock_irqrestore(&pdata->lock, flags);
 129
 130 exit:
 131         retval = usb_submit_urb(pdata->urb, GFP_ATOMIC);
 132         if (retval) {
 133                 err("%s - usb_submit_urb failed with result %d",
 134                         __FUNCTION__, retval);
 135         }
 136 }
 137
 138 static int appledisplay_bl_update_status(struct backlight_device *bd)
 139 {
 140         struct appledisplay *pdata = class_get_devdata(&bd->class_dev);
 141         int retval;
 142
 143         pdata->msgdata[0] = 0x10;
 144         pdata->msgdata[1] = bd->props->brightness;
 145
 146         retval = usb_control_msg(
 147                 pdata->udev,
 148                 usb_sndctrlpipe(pdata->udev, 0),
 149                 USB_REQ_SET_REPORT,
 150                 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
 151                 ACD_USB_BRIGHTNESS,
 152                 0,
 153                 pdata->msgdata, 2,
 154                 ACD_USB_TIMEOUT);
 155
 156         return retval;
 157 }
 158
 159 static int appledisplay_bl_get_brightness(struct backlight_device *bd)
 160 {
 161         struct appledisplay *pdata = class_get_devdata(&bd->class_dev);
 162         int retval;
 163
 164         retval = usb_control_msg(
 165                 pdata->udev,
 166                 usb_rcvctrlpipe(pdata->udev, 0),
 167                 USB_REQ_GET_REPORT,
 168                 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
 169                 ACD_USB_BRIGHTNESS,
 170                 0,
 171                 pdata->msgdata, 2,
 172                 ACD_USB_TIMEOUT);
 173
 174         if (retval < 0)
 175                 return retval;
 176         else
 177                 return pdata->msgdata[1];
 178 }
 179
 180 static struct backlight_properties appledisplay_bl_data = {
 181         .owner          = THIS_MODULE,
 182         .get_brightness = appledisplay_bl_get_brightness,
 183         .update_status  = appledisplay_bl_update_status,
 184         .max_brightness = 0xFF
 185 };
 186
 187 static void appledisplay_work(void *private)
 188 {
 189         struct appledisplay *pdata = private;
 190         int retval;
 191
 192         up(&pdata->bd->sem);
 193         retval = appledisplay_bl_get_brightness(pdata->bd);
 194         if (retval >= 0)
 195                 pdata->bd->props->brightness = retval;
 196         down(&pdata->bd->sem);
 197
 198         /* Poll again in about 125ms if there's still a button pressed */
 199         if (pdata->button_pressed)
 200                 schedule_delayed_work(&pdata->work, HZ / 8);
 201 }
 202
 203 static int appledisplay_probe(struct usb_interface *iface,
 204         const struct usb_device_id *id)
 205 {
 206         struct appledisplay *pdata;
 207         struct usb_device *udev = interface_to_usbdev(iface);
 208         struct usb_host_interface *iface_desc;
 209         struct usb_endpoint_descriptor *endpoint;
 210         int int_in_endpointAddr = 0;
 211         int i, retval = -ENOMEM, brightness;
 212         char bl_name[20];
 213
 214         /* set up the endpoint information */
 215         /* use only the first interrupt-in endpoint */
 216         iface_desc = iface->cur_altsetting;
 217         for (i = 0; i < iface_desc->desc.bNumEndpoints; i++) {
 218                 endpoint = &iface_desc->endpoint[i].desc;
 219                 if (!int_in_endpointAddr &&
 220                     (endpoint->bEndpointAddress & USB_DIR_IN) &&
 221                     ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 222                      USB_ENDPOINT_XFER_INT)) {
 223                         /* we found an interrupt in endpoint */
 224                         int_in_endpointAddr = endpoint->bEndpointAddress;
 225                         break;
 226                 }
 227         }
 228         if (!int_in_endpointAddr) {
 229                 err("Could not find int-in endpoint");
 230                 return -EIO;
 231         }
 232
 233         /* allocate memory for our device state and initialize it */
 234         pdata = kzalloc(sizeof(struct appledisplay), GFP_KERNEL);
 235         if (!pdata) {
 236                 retval = -ENOMEM;
 237                 err("Out of memory");
 238                 goto error;
 239         }
 240
 241         pdata->udev = udev;
 242
 243         spin_lock_init(&pdata->lock);
 244         INIT_WORK(&pdata->work, appledisplay_work, pdata);
 245
 246         /* Allocate buffer for control messages */
 247         pdata->msgdata = kmalloc(ACD_MSG_BUFFER_LEN, GFP_KERNEL);
 248         if (!pdata->msgdata) {
 249                 retval = -ENOMEM;
 250                 err("appledisplay: Allocating buffer for control messages "
 251                         "failed");
 252                 goto error;
 253         }
 254
 255         /* Allocate interrupt URB */
 256         pdata->urb = usb_alloc_urb(0, GFP_KERNEL);
 257         if (!pdata->urb) {
 258                 retval = -ENOMEM;
 259                 err("appledisplay: Allocating URB failed");
 260                 goto error;
 261         }
 262
 263         /* Allocate buffer for interrupt data */
 264         pdata->urbdata = usb_buffer_alloc(pdata->udev, ACD_URB_BUFFER_LEN,
 265                 GFP_KERNEL, &pdata->urb->transfer_dma);
 266         if (!pdata->urbdata) {
 267                 retval = -ENOMEM;
 268                 err("appledisplay: Allocating URB buffer failed");
 269                 goto error;
 270         }
 271
 272         /* Configure interrupt URB */
 273         usb_fill_int_urb(pdata->urb, udev,
 274                 usb_rcvintpipe(udev, int_in_endpointAddr),
 275                 pdata->urbdata, ACD_URB_BUFFER_LEN, appledisplay_complete,
 276                 pdata, 1);
 277         if (usb_submit_urb(pdata->urb, GFP_KERNEL)) {
 278                 retval = -EIO;
 279                 err("appledisplay: Submitting URB failed");
 280                 goto error;
 281         }
 282
 283         /* Register backlight device */
 284         snprintf(bl_name, sizeof(bl_name), "appledisplay%d",
 285                 atomic_inc_return(&count_displays) - 1);
 286         pdata->bd = backlight_device_register(bl_name, pdata,
 287                                                 &appledisplay_bl_data);
 288         if (IS_ERR(pdata->bd)) {
 289                 err("appledisplay: Backlight registration failed");
 290                 goto error;
 291         }
 292
 293         /* Try to get brightness */
 294         up(&pdata->bd->sem);
 295         brightness = appledisplay_bl_get_brightness(pdata->bd);
 296         down(&pdata->bd->sem);
 297
 298         if (brightness < 0) {
 299                 retval = brightness;
 300                 err("appledisplay: Error while getting initial brightness: %d", retval);
 301                 goto error;
 302         }
 303
 304         /* Set brightness in backlight device */
 305         up(&pdata->bd->sem);
 306         pdata->bd->props->brightness = brightness;
 307         down(&pdata->bd->sem);
 308
 309         /* save our data pointer in the interface device */
 310         usb_set_intfdata(iface, pdata);
 311
 312         printk(KERN_INFO "appledisplay: Apple Cinema Display connected\n");
 313
 314         return 0;
 315
 316 error:
 317         if (pdata) {
 318                 if (pdata->urb) {
 319                         usb_kill_urb(pdata->urb);
 320                         if (pdata->urbdata)
 321                                 usb_buffer_free(pdata->udev, ACD_URB_BUFFER_LEN,
 322                                         pdata->urbdata, pdata->urb->transfer_dma);
 323                         usb_free_urb(pdata->urb);
 324                 }
 325                 if (pdata->bd)
 326                         backlight_device_unregister(pdata->bd);
 327                 kfree(pdata->msgdata);
 328         }
 329         usb_set_intfdata(iface, NULL);
 330         kfree(pdata);
 331         return retval;
 332 }
 333
 334 static void appledisplay_disconnect(struct usb_interface *iface)
 335 {
 336         struct appledisplay *pdata = usb_get_intfdata(iface);
 337
 338         if (pdata) {
 339                 usb_kill_urb(pdata->urb);
 340                 cancel_delayed_work(&pdata->work);
 341                 backlight_device_unregister(pdata->bd);
 342                 usb_buffer_free(pdata->udev, ACD_URB_BUFFER_LEN,
 343                         pdata->urbdata, pdata->urb->transfer_dma);
 344                 usb_free_urb(pdata->urb);
 345                 kfree(pdata->msgdata);
 346                 kfree(pdata);
 347         }
 348
 349         printk(KERN_INFO "appledisplay: Apple Cinema Display disconnected\n");
 350 }
 351
 352 static struct usb_driver appledisplay_driver = {
 353         .name           = "appledisplay",
 354         .probe          = appledisplay_probe,
 355         .disconnect     = appledisplay_disconnect,
 356         .id_table       = appledisplay_table,
 357 };
 358
 359 static int __init appledisplay_init(void)
 360 {
 361         wq = create_singlethread_workqueue("appledisplay");
 362         if (!wq) {
 363                 err("Could not create work queue\n");
 364                 return -ENOMEM;
 365         }
 366
 367         return usb_register(&appledisplay_driver);
 368 }
 369
 370 static void __exit appledisplay_exit(void)
 371 {
 372         flush_workqueue(wq);
 373         destroy_workqueue(wq);
 374         usb_deregister(&appledisplay_driver);
 375 }
 376
 377 MODULE_AUTHOR("Michael Hanselmann");
 378 MODULE_DESCRIPTION("Apple Cinema Display driver");
 379 MODULE_LICENSE("GPL");
 380
 381 module_init(appledisplay_init);
 382 module_exit(appledisplay_exit);