blob: 0fc6e5fc745fbf0de60d97e7059d93dc6ad82348 [file] [log] [blame]
akpm@osdl.org069e8a62006-05-26 13:17:09 -07001/*
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
akpm@osdl.org069e8a62006-05-26 13:17:09 -070023#include <linux/kernel.h>
24#include <linux/errno.h>
25#include <linux/init.h>
26#include <linux/module.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090027#include <linux/slab.h>
akpm@osdl.org069e8a62006-05-26 13:17:09 -070028#include <linux/usb.h>
29#include <linux/backlight.h>
30#include <linux/timer.h>
31#include <linux/workqueue.h>
Arun Sharma600634972011-07-26 16:09:06 -070032#include <linux/atomic.h>
akpm@osdl.org069e8a62006-05-26 13:17:09 -070033
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 */
Németh Márton33b9e162010-01-10 15:34:45 +010061static const struct usb_device_id appledisplay_table[] = {
akpm@osdl.org069e8a62006-05-26 13:17:09 -070062 { APPLEDISPLAY_DEVICE(0x9218) },
63 { APPLEDISPLAY_DEVICE(0x9219) },
pancho horrillo4b3720722009-12-02 20:19:42 +010064 { APPLEDISPLAY_DEVICE(0x921c) },
akpm@osdl.org069e8a62006-05-26 13:17:09 -070065 { APPLEDISPLAY_DEVICE(0x921d) },
66
67 /* Terminating entry */
68 { }
69};
70MODULE_DEVICE_TABLE(usb, appledisplay_table);
71
72/* Structure to hold all of our device specific stuff */
73struct appledisplay {
74 struct usb_device *udev; /* usb device */
75 struct urb *urb; /* usb request block */
76 struct backlight_device *bd; /* backlight device */
pancho horrillo37e90662009-12-23 11:09:13 +010077 u8 *urbdata; /* interrupt URB data buffer */
78 u8 *msgdata; /* control message data buffer */
akpm@osdl.org069e8a62006-05-26 13:17:09 -070079
David Howells6d5aefb2006-12-05 19:36:26 +000080 struct delayed_work work;
akpm@osdl.org069e8a62006-05-26 13:17:09 -070081 int button_pressed;
82 spinlock_t lock;
83};
84
85static atomic_t count_displays = ATOMIC_INIT(0);
86static struct workqueue_struct *wq;
87
David Howells7d12e782006-10-05 14:55:46 +010088static void appledisplay_complete(struct urb *urb)
akpm@osdl.org069e8a62006-05-26 13:17:09 -070089{
90 struct appledisplay *pdata = urb->context;
Greg Kroah-Hartman0a3fd532012-05-01 21:33:54 -070091 struct device *dev = &pdata->udev->dev;
akpm@osdl.org069e8a62006-05-26 13:17:09 -070092 unsigned long flags;
Greg Kroah-Hartman13f97822007-07-18 10:58:02 -070093 int status = urb->status;
akpm@osdl.org069e8a62006-05-26 13:17:09 -070094 int retval;
95
Greg Kroah-Hartman13f97822007-07-18 10:58:02 -070096 switch (status) {
akpm@osdl.org069e8a62006-05-26 13:17:09 -070097 case 0:
98 /* success */
99 break;
100 case -EOVERFLOW:
Greg Kroah-Hartman0a3fd532012-05-01 21:33:54 -0700101 dev_err(dev,
102 "OVERFLOW with data length %d, actual length is %d\n",
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700103 ACD_URB_BUFFER_LEN, pdata->urb->actual_length);
104 case -ECONNRESET:
105 case -ENOENT:
106 case -ESHUTDOWN:
107 /* This urb is terminated, clean up */
Greg Kroah-Hartman0a3fd532012-05-01 21:33:54 -0700108 dev_dbg(dev, "%s - urb shuttingdown with status: %d\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800109 __func__, status);
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700110 return;
111 default:
Greg Kroah-Hartman0a3fd532012-05-01 21:33:54 -0700112 dev_dbg(dev, "%s - nonzero urb status received: %d/n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800113 __func__, status);
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700114 goto exit;
115 }
116
117 spin_lock_irqsave(&pdata->lock, flags);
118
119 switch(pdata->urbdata[1]) {
120 case ACD_BTN_BRIGHT_UP:
121 case ACD_BTN_BRIGHT_DOWN:
122 pdata->button_pressed = 1;
David Howells6d5aefb2006-12-05 19:36:26 +0000123 queue_delayed_work(wq, &pdata->work, 0);
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700124 break;
125 case ACD_BTN_NONE:
126 default:
127 pdata->button_pressed = 0;
128 break;
129 }
130
131 spin_unlock_irqrestore(&pdata->lock, flags);
132
133exit:
134 retval = usb_submit_urb(pdata->urb, GFP_ATOMIC);
135 if (retval) {
Greg Kroah-Hartman0a3fd532012-05-01 21:33:54 -0700136 dev_err(dev, "%s - usb_submit_urb failed with result %d\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800137 __func__, retval);
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700138 }
139}
140
141static int appledisplay_bl_update_status(struct backlight_device *bd)
142{
Richard Purdie655bfd72007-07-09 12:17:24 +0100143 struct appledisplay *pdata = bl_get_data(bd);
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700144 int retval;
145
146 pdata->msgdata[0] = 0x10;
Richard Purdie599a52d2007-02-10 23:07:48 +0000147 pdata->msgdata[1] = bd->props.brightness;
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700148
149 retval = usb_control_msg(
150 pdata->udev,
151 usb_sndctrlpipe(pdata->udev, 0),
152 USB_REQ_SET_REPORT,
153 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
154 ACD_USB_BRIGHTNESS,
155 0,
156 pdata->msgdata, 2,
157 ACD_USB_TIMEOUT);
158
159 return retval;
160}
161
162static int appledisplay_bl_get_brightness(struct backlight_device *bd)
163{
Richard Purdie655bfd72007-07-09 12:17:24 +0100164 struct appledisplay *pdata = bl_get_data(bd);
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700165 int retval;
166
167 retval = usb_control_msg(
168 pdata->udev,
169 usb_rcvctrlpipe(pdata->udev, 0),
170 USB_REQ_GET_REPORT,
171 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
172 ACD_USB_BRIGHTNESS,
173 0,
174 pdata->msgdata, 2,
175 ACD_USB_TIMEOUT);
176
177 if (retval < 0)
178 return retval;
179 else
180 return pdata->msgdata[1];
181}
182
Bruno Prémontcedf8a72010-02-26 13:02:04 +0100183static const struct backlight_ops appledisplay_bl_data = {
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700184 .get_brightness = appledisplay_bl_get_brightness,
185 .update_status = appledisplay_bl_update_status,
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700186};
187
David Howells6d5aefb2006-12-05 19:36:26 +0000188static void appledisplay_work(struct work_struct *work)
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700189{
David Howells6d5aefb2006-12-05 19:36:26 +0000190 struct appledisplay *pdata =
191 container_of(work, struct appledisplay, work.work);
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700192 int retval;
193
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700194 retval = appledisplay_bl_get_brightness(pdata->bd);
195 if (retval >= 0)
Richard Purdie599a52d2007-02-10 23:07:48 +0000196 pdata->bd->props.brightness = retval;
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700197
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
203static int appledisplay_probe(struct usb_interface *iface,
204 const struct usb_device_id *id)
205{
Matthew Garretta19a6ee2010-02-17 16:39:44 -0500206 struct backlight_properties props;
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700207 struct appledisplay *pdata;
208 struct usb_device *udev = interface_to_usbdev(iface);
209 struct usb_host_interface *iface_desc;
210 struct usb_endpoint_descriptor *endpoint;
211 int int_in_endpointAddr = 0;
212 int i, retval = -ENOMEM, brightness;
213 char bl_name[20];
214
215 /* set up the endpoint information */
216 /* use only the first interrupt-in endpoint */
217 iface_desc = iface->cur_altsetting;
218 for (i = 0; i < iface_desc->desc.bNumEndpoints; i++) {
219 endpoint = &iface_desc->endpoint[i].desc;
Luiz Fernando N. Capitulino16f96372006-10-26 13:02:46 -0300220 if (!int_in_endpointAddr && usb_endpoint_is_int_in(endpoint)) {
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700221 /* we found an interrupt in endpoint */
222 int_in_endpointAddr = endpoint->bEndpointAddress;
223 break;
224 }
225 }
226 if (!int_in_endpointAddr) {
Greg Kroah-Hartmanfd3f1912008-08-14 09:37:34 -0700227 dev_err(&iface->dev, "Could not find int-in endpoint\n");
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700228 return -EIO;
229 }
230
231 /* allocate memory for our device state and initialize it */
232 pdata = kzalloc(sizeof(struct appledisplay), GFP_KERNEL);
233 if (!pdata) {
234 retval = -ENOMEM;
Greg Kroah-Hartmanfd3f1912008-08-14 09:37:34 -0700235 dev_err(&iface->dev, "Out of memory\n");
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700236 goto error;
237 }
238
239 pdata->udev = udev;
240
241 spin_lock_init(&pdata->lock);
David Howells6d5aefb2006-12-05 19:36:26 +0000242 INIT_DELAYED_WORK(&pdata->work, appledisplay_work);
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700243
244 /* Allocate buffer for control messages */
245 pdata->msgdata = kmalloc(ACD_MSG_BUFFER_LEN, GFP_KERNEL);
246 if (!pdata->msgdata) {
247 retval = -ENOMEM;
Greg Kroah-Hartmanfd3f1912008-08-14 09:37:34 -0700248 dev_err(&iface->dev,
249 "Allocating buffer for control messages failed\n");
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700250 goto error;
251 }
252
253 /* Allocate interrupt URB */
254 pdata->urb = usb_alloc_urb(0, GFP_KERNEL);
255 if (!pdata->urb) {
256 retval = -ENOMEM;
Greg Kroah-Hartmanfd3f1912008-08-14 09:37:34 -0700257 dev_err(&iface->dev, "Allocating URB failed\n");
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700258 goto error;
259 }
260
261 /* Allocate buffer for interrupt data */
Daniel Mack997ea582010-04-12 13:17:25 +0200262 pdata->urbdata = usb_alloc_coherent(pdata->udev, ACD_URB_BUFFER_LEN,
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700263 GFP_KERNEL, &pdata->urb->transfer_dma);
264 if (!pdata->urbdata) {
265 retval = -ENOMEM;
Greg Kroah-Hartmanfd3f1912008-08-14 09:37:34 -0700266 dev_err(&iface->dev, "Allocating URB buffer failed\n");
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700267 goto error;
268 }
269
270 /* Configure interrupt URB */
271 usb_fill_int_urb(pdata->urb, udev,
272 usb_rcvintpipe(udev, int_in_endpointAddr),
273 pdata->urbdata, ACD_URB_BUFFER_LEN, appledisplay_complete,
274 pdata, 1);
275 if (usb_submit_urb(pdata->urb, GFP_KERNEL)) {
276 retval = -EIO;
Greg Kroah-Hartmanfd3f1912008-08-14 09:37:34 -0700277 dev_err(&iface->dev, "Submitting URB failed\n");
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700278 goto error;
279 }
280
281 /* Register backlight device */
282 snprintf(bl_name, sizeof(bl_name), "appledisplay%d",
283 atomic_inc_return(&count_displays) - 1);
Matthew Garretta19a6ee2010-02-17 16:39:44 -0500284 memset(&props, 0, sizeof(struct backlight_properties));
Matthew Garrettbb7ca742011-03-22 16:30:21 -0700285 props.type = BACKLIGHT_RAW;
Matthew Garretta19a6ee2010-02-17 16:39:44 -0500286 props.max_brightness = 0xff;
Len Brown81450b72007-02-16 18:52:41 -0500287 pdata->bd = backlight_device_register(bl_name, NULL, pdata,
Matthew Garretta19a6ee2010-02-17 16:39:44 -0500288 &appledisplay_bl_data, &props);
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700289 if (IS_ERR(pdata->bd)) {
Greg Kroah-Hartmanfd3f1912008-08-14 09:37:34 -0700290 dev_err(&iface->dev, "Backlight registration failed\n");
Bruno Prémontcedf8a72010-02-26 13:02:04 +0100291 retval = PTR_ERR(pdata->bd);
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700292 goto error;
293 }
294
295 /* Try to get brightness */
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700296 brightness = appledisplay_bl_get_brightness(pdata->bd);
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700297
298 if (brightness < 0) {
299 retval = brightness;
Greg Kroah-Hartmanfd3f1912008-08-14 09:37:34 -0700300 dev_err(&iface->dev,
301 "Error while getting initial brightness: %d\n", retval);
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700302 goto error;
303 }
304
305 /* Set brightness in backlight device */
Richard Purdie599a52d2007-02-10 23:07:48 +0000306 pdata->bd->props.brightness = brightness;
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700307
308 /* save our data pointer in the interface device */
309 usb_set_intfdata(iface, pdata);
310
311 printk(KERN_INFO "appledisplay: Apple Cinema Display connected\n");
312
313 return 0;
314
315error:
316 if (pdata) {
317 if (pdata->urb) {
318 usb_kill_urb(pdata->urb);
319 if (pdata->urbdata)
Daniel Mack997ea582010-04-12 13:17:25 +0200320 usb_free_coherent(pdata->udev, ACD_URB_BUFFER_LEN,
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700321 pdata->urbdata, pdata->urb->transfer_dma);
322 usb_free_urb(pdata->urb);
323 }
Julien Brunelbedf0882008-09-01 10:57:27 +0200324 if (pdata->bd && !IS_ERR(pdata->bd))
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700325 backlight_device_unregister(pdata->bd);
326 kfree(pdata->msgdata);
327 }
328 usb_set_intfdata(iface, NULL);
329 kfree(pdata);
330 return retval;
331}
332
333static void appledisplay_disconnect(struct usb_interface *iface)
334{
335 struct appledisplay *pdata = usb_get_intfdata(iface);
336
337 if (pdata) {
338 usb_kill_urb(pdata->urb);
339 cancel_delayed_work(&pdata->work);
340 backlight_device_unregister(pdata->bd);
Daniel Mack997ea582010-04-12 13:17:25 +0200341 usb_free_coherent(pdata->udev, ACD_URB_BUFFER_LEN,
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700342 pdata->urbdata, pdata->urb->transfer_dma);
343 usb_free_urb(pdata->urb);
344 kfree(pdata->msgdata);
345 kfree(pdata);
346 }
347
348 printk(KERN_INFO "appledisplay: Apple Cinema Display disconnected\n");
349}
350
351static struct usb_driver appledisplay_driver = {
352 .name = "appledisplay",
353 .probe = appledisplay_probe,
354 .disconnect = appledisplay_disconnect,
355 .id_table = appledisplay_table,
356};
357
358static int __init appledisplay_init(void)
359{
360 wq = create_singlethread_workqueue("appledisplay");
361 if (!wq) {
Greg Kroah-Hartmanfd3f1912008-08-14 09:37:34 -0700362 printk(KERN_ERR "appledisplay: Could not create work queue\n");
akpm@osdl.org069e8a62006-05-26 13:17:09 -0700363 return -ENOMEM;
364 }
365
366 return usb_register(&appledisplay_driver);
367}
368
369static void __exit appledisplay_exit(void)
370{
371 flush_workqueue(wq);
372 destroy_workqueue(wq);
373 usb_deregister(&appledisplay_driver);
374}
375
376MODULE_AUTHOR("Michael Hanselmann");
377MODULE_DESCRIPTION("Apple Cinema Display driver");
378MODULE_LICENSE("GPL");
379
380module_init(appledisplay_init);
381module_exit(appledisplay_exit);