Commit | Line | Data |
---|---|---|
c8f7a62c LB |
1 | /* |
2 | * dock.c - ACPI dock station driver | |
3 | * | |
4 | * Copyright (C) 2006 Kristen Carlson Accardi <kristen.c.accardi@intel.com> | |
5 | * | |
6 | * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
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 (at | |
11 | * your option) any later version. | |
12 | * | |
13 | * This program is distributed in the hope that it will be useful, but | |
14 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
16 | * General Public License for more details. | |
17 | * | |
18 | * You should have received a copy of the GNU General Public License along | |
19 | * with this program; if not, write to the Free Software Foundation, Inc., | |
20 | * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. | |
21 | * | |
22 | * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
23 | */ | |
24 | ||
25 | #include <linux/kernel.h> | |
26 | #include <linux/module.h> | |
5a0e3ad6 | 27 | #include <linux/slab.h> |
c8f7a62c LB |
28 | #include <linux/init.h> |
29 | #include <linux/types.h> | |
30 | #include <linux/notifier.h> | |
671adbec | 31 | #include <linux/platform_device.h> |
914e2637 | 32 | #include <linux/jiffies.h> |
62a6d7fd | 33 | #include <linux/stddef.h> |
cd73018f | 34 | #include <linux/acpi.h> |
c8f7a62c LB |
35 | #include <acpi/acpi_bus.h> |
36 | #include <acpi/acpi_drivers.h> | |
37 | ||
a192a958 LB |
38 | #define PREFIX "ACPI: " |
39 | ||
7cda93e0 | 40 | #define ACPI_DOCK_DRIVER_DESCRIPTION "ACPI Dock Station Driver" |
c8f7a62c | 41 | |
f52fd66d | 42 | ACPI_MODULE_NAME("dock"); |
c8f7a62c | 43 | MODULE_AUTHOR("Kristen Carlson Accardi"); |
7cda93e0 | 44 | MODULE_DESCRIPTION(ACPI_DOCK_DRIVER_DESCRIPTION); |
c8f7a62c LB |
45 | MODULE_LICENSE("GPL"); |
46 | ||
90ab5ee9 | 47 | static bool immediate_undock = 1; |
a0cd35fd KCA |
48 | module_param(immediate_undock, bool, 0644); |
49 | MODULE_PARM_DESC(immediate_undock, "1 (default) will cause the driver to " | |
50 | "undock immediately when the undock button is pressed, 0 will cause" | |
51 | " the driver to wait for userspace to write the undock sysfs file " | |
52 | " before undocking"); | |
53 | ||
a340af14 FS |
54 | static const struct acpi_device_id dock_device_ids[] = { |
55 | {"LNXDOCK", 0}, | |
56 | {"", 0}, | |
57 | }; | |
58 | MODULE_DEVICE_TABLE(acpi, dock_device_ids); | |
59 | ||
c8f7a62c LB |
60 | struct dock_station { |
61 | acpi_handle handle; | |
62 | unsigned long last_dock_time; | |
63 | u32 flags; | |
c8f7a62c | 64 | struct list_head dependent_devices; |
db350b08 | 65 | |
50d716e4 | 66 | struct list_head sibling; |
db350b08 | 67 | struct platform_device *dock_device; |
c8f7a62c | 68 | }; |
db350b08 SL |
69 | static LIST_HEAD(dock_stations); |
70 | static int dock_station_count; | |
21a31013 | 71 | static DEFINE_MUTEX(hotplug_lock); |
c8f7a62c LB |
72 | |
73 | struct dock_dependent_device { | |
74 | struct list_head list; | |
c8f7a62c | 75 | acpi_handle handle; |
21a31013 RW |
76 | const struct acpi_dock_ops *hp_ops; |
77 | void *hp_context; | |
78 | unsigned int hp_refcount; | |
79 | void (*hp_release)(void *); | |
c8f7a62c LB |
80 | }; |
81 | ||
82 | #define DOCK_DOCKING 0x00000001 | |
a0cd35fd | 83 | #define DOCK_UNDOCKING 0x00000002 |
db350b08 SL |
84 | #define DOCK_IS_DOCK 0x00000010 |
85 | #define DOCK_IS_ATA 0x00000020 | |
86 | #define DOCK_IS_BAT 0x00000040 | |
5669021e KCA |
87 | #define DOCK_EVENT 3 |
88 | #define UNDOCK_EVENT 2 | |
c8f7a62c | 89 | |
f09ce741 RW |
90 | enum dock_callback_type { |
91 | DOCK_CALL_HANDLER, | |
92 | DOCK_CALL_FIXUP, | |
93 | DOCK_CALL_UEVENT, | |
94 | }; | |
95 | ||
c8f7a62c LB |
96 | /***************************************************************************** |
97 | * Dock Dependent device functions * | |
98 | *****************************************************************************/ | |
99 | /** | |
f69cfdd2 AC |
100 | * add_dock_dependent_device - associate a device with the dock station |
101 | * @ds: The dock station | |
102 | * @handle: handle of the dependent device | |
c8f7a62c | 103 | * |
f69cfdd2 | 104 | * Add the dependent device to the dock's dependent device list. |
c8f7a62c | 105 | */ |
d423c083 | 106 | static int __init |
f69cfdd2 | 107 | add_dock_dependent_device(struct dock_station *ds, acpi_handle handle) |
c8f7a62c LB |
108 | { |
109 | struct dock_dependent_device *dd; | |
110 | ||
111 | dd = kzalloc(sizeof(*dd), GFP_KERNEL); | |
f69cfdd2 AC |
112 | if (!dd) |
113 | return -ENOMEM; | |
114 | ||
115 | dd->handle = handle; | |
116 | INIT_LIST_HEAD(&dd->list); | |
c8f7a62c | 117 | list_add_tail(&dd->list, &ds->dependent_devices); |
f69cfdd2 AC |
118 | |
119 | return 0; | |
c8f7a62c LB |
120 | } |
121 | ||
a30c4c5e RW |
122 | static void remove_dock_dependent_devices(struct dock_station *ds) |
123 | { | |
124 | struct dock_dependent_device *dd, *aux; | |
125 | ||
126 | list_for_each_entry_safe(dd, aux, &ds->dependent_devices, list) { | |
127 | list_del(&dd->list); | |
128 | kfree(dd); | |
129 | } | |
130 | } | |
131 | ||
c8f7a62c | 132 | /** |
21a31013 RW |
133 | * dock_init_hotplug - Initialize a hotplug device on a docking station. |
134 | * @dd: Dock-dependent device. | |
135 | * @ops: Dock operations to attach to the dependent device. | |
136 | * @context: Data to pass to the @ops callbacks and @release. | |
137 | * @init: Optional initialization routine to run after setting up context. | |
138 | * @release: Optional release routine to run on removal. | |
c8f7a62c | 139 | */ |
21a31013 RW |
140 | static int dock_init_hotplug(struct dock_dependent_device *dd, |
141 | const struct acpi_dock_ops *ops, void *context, | |
142 | void (*init)(void *), void (*release)(void *)) | |
c8f7a62c | 143 | { |
21a31013 RW |
144 | int ret = 0; |
145 | ||
146 | mutex_lock(&hotplug_lock); | |
4ec24065 | 147 | if (WARN_ON(dd->hp_context)) { |
21a31013 RW |
148 | ret = -EEXIST; |
149 | } else { | |
150 | dd->hp_refcount = 1; | |
151 | dd->hp_ops = ops; | |
152 | dd->hp_context = context; | |
153 | dd->hp_release = release; | |
4ec24065 RW |
154 | if (init) |
155 | init(context); | |
21a31013 | 156 | } |
21a31013 RW |
157 | mutex_unlock(&hotplug_lock); |
158 | return ret; | |
c8f7a62c LB |
159 | } |
160 | ||
161 | /** | |
21a31013 RW |
162 | * dock_release_hotplug - Decrement hotplug reference counter of dock device. |
163 | * @dd: Dock-dependent device. | |
c8f7a62c | 164 | * |
21a31013 RW |
165 | * Decrement the reference counter of @dd and if 0, detach its hotplug |
166 | * operations from it, reset its context pointer and run the optional release | |
167 | * routine if present. | |
c8f7a62c | 168 | */ |
21a31013 | 169 | static void dock_release_hotplug(struct dock_dependent_device *dd) |
c8f7a62c | 170 | { |
21a31013 | 171 | mutex_lock(&hotplug_lock); |
21a31013 | 172 | if (dd->hp_context && !--dd->hp_refcount) { |
4ec24065 RW |
173 | void (*release)(void *) = dd->hp_release; |
174 | void *context = dd->hp_context; | |
175 | ||
21a31013 | 176 | dd->hp_ops = NULL; |
21a31013 | 177 | dd->hp_context = NULL; |
21a31013 | 178 | dd->hp_release = NULL; |
4ec24065 RW |
179 | if (release) |
180 | release(context); | |
21a31013 | 181 | } |
21a31013 RW |
182 | mutex_unlock(&hotplug_lock); |
183 | } | |
184 | ||
185 | static void dock_hotplug_event(struct dock_dependent_device *dd, u32 event, | |
f09ce741 | 186 | enum dock_callback_type cb_type) |
21a31013 RW |
187 | { |
188 | acpi_notify_handler cb = NULL; | |
189 | bool run = false; | |
190 | ||
191 | mutex_lock(&hotplug_lock); | |
192 | ||
193 | if (dd->hp_context) { | |
194 | run = true; | |
195 | dd->hp_refcount++; | |
f09ce741 RW |
196 | if (dd->hp_ops) { |
197 | switch (cb_type) { | |
198 | case DOCK_CALL_FIXUP: | |
199 | cb = dd->hp_ops->fixup; | |
200 | break; | |
201 | case DOCK_CALL_UEVENT: | |
202 | cb = dd->hp_ops->uevent; | |
203 | break; | |
204 | default: | |
205 | cb = dd->hp_ops->handler; | |
206 | } | |
207 | } | |
21a31013 RW |
208 | } |
209 | ||
210 | mutex_unlock(&hotplug_lock); | |
211 | ||
212 | if (!run) | |
213 | return; | |
214 | ||
215 | if (cb) | |
216 | cb(dd->handle, event, dd->hp_context); | |
217 | ||
218 | dock_release_hotplug(dd); | |
c8f7a62c LB |
219 | } |
220 | ||
221 | /** | |
222 | * find_dock_dependent_device - get a device dependent on this dock | |
223 | * @ds: the dock station | |
224 | * @handle: the acpi_handle of the device we want | |
225 | * | |
226 | * iterate over the dependent device list for this dock. If the | |
227 | * dependent device matches the handle, return. | |
228 | */ | |
229 | static struct dock_dependent_device * | |
230 | find_dock_dependent_device(struct dock_station *ds, acpi_handle handle) | |
231 | { | |
232 | struct dock_dependent_device *dd; | |
233 | ||
ed633e70 JL |
234 | list_for_each_entry(dd, &ds->dependent_devices, list) |
235 | if (handle == dd->handle) | |
c8f7a62c | 236 | return dd; |
ed633e70 | 237 | |
c8f7a62c LB |
238 | return NULL; |
239 | } | |
240 | ||
241 | /***************************************************************************** | |
242 | * Dock functions * | |
243 | *****************************************************************************/ | |
d423c083 | 244 | static int __init is_battery(acpi_handle handle) |
db350b08 SL |
245 | { |
246 | struct acpi_device_info *info; | |
db350b08 SL |
247 | int ret = 1; |
248 | ||
15b8dd53 | 249 | if (!ACPI_SUCCESS(acpi_get_object_info(handle, &info))) |
db350b08 | 250 | return 0; |
db350b08 SL |
251 | if (!(info->valid & ACPI_VALID_HID)) |
252 | ret = 0; | |
253 | else | |
15b8dd53 | 254 | ret = !strcmp("PNP0C0A", info->hardware_id.string); |
db350b08 | 255 | |
15b8dd53 | 256 | kfree(info); |
db350b08 SL |
257 | return ret; |
258 | } | |
259 | ||
c9b5471f JL |
260 | /* Check whether ACPI object is an ejectable battery or disk bay */ |
261 | static bool __init is_ejectable_bay(acpi_handle handle) | |
db350b08 | 262 | { |
c9b5471f JL |
263 | if (acpi_has_method(handle, "_EJ0") && is_battery(handle)) |
264 | return true; | |
747479a3 | 265 | |
c9b5471f | 266 | return acpi_bay_match(handle); |
db350b08 SL |
267 | } |
268 | ||
c8f7a62c LB |
269 | /** |
270 | * is_dock_device - see if a device is on a dock station | |
271 | * @handle: acpi handle of the device | |
272 | * | |
273 | * If this device is either the dock station itself, | |
274 | * or is a device dependent on the dock station, then it | |
275 | * is a dock device | |
276 | */ | |
277 | int is_dock_device(acpi_handle handle) | |
278 | { | |
db350b08 SL |
279 | struct dock_station *dock_station; |
280 | ||
281 | if (!dock_station_count) | |
c8f7a62c LB |
282 | return 0; |
283 | ||
c9b5471f | 284 | if (acpi_dock_match(handle)) |
c8f7a62c | 285 | return 1; |
747479a3 AC |
286 | |
287 | list_for_each_entry(dock_station, &dock_stations, sibling) | |
db350b08 SL |
288 | if (find_dock_dependent_device(dock_station, handle)) |
289 | return 1; | |
c8f7a62c LB |
290 | |
291 | return 0; | |
292 | } | |
c8f7a62c LB |
293 | EXPORT_SYMBOL_GPL(is_dock_device); |
294 | ||
295 | /** | |
296 | * dock_present - see if the dock station is present. | |
297 | * @ds: the dock station | |
298 | * | |
299 | * execute the _STA method. note that present does not | |
300 | * imply that we are docked. | |
301 | */ | |
302 | static int dock_present(struct dock_station *ds) | |
303 | { | |
27663c58 | 304 | unsigned long long sta; |
c8f7a62c LB |
305 | acpi_status status; |
306 | ||
307 | if (ds) { | |
308 | status = acpi_evaluate_integer(ds->handle, "_STA", NULL, &sta); | |
309 | if (ACPI_SUCCESS(status) && sta) | |
310 | return 1; | |
311 | } | |
312 | return 0; | |
313 | } | |
314 | ||
c8f7a62c LB |
315 | /** |
316 | * dock_create_acpi_device - add new devices to acpi | |
317 | * @handle - handle of the device to add | |
318 | * | |
319 | * This function will create a new acpi_device for the given | |
320 | * handle if one does not exist already. This should cause | |
321 | * acpi to scan for drivers for the given devices, and call | |
322 | * matching driver's add routine. | |
c8f7a62c | 323 | */ |
472d963b | 324 | static void dock_create_acpi_device(acpi_handle handle) |
c8f7a62c | 325 | { |
747479a3 | 326 | struct acpi_device *device; |
c8f7a62c LB |
327 | int ret; |
328 | ||
329 | if (acpi_bus_get_device(handle, &device)) { | |
330 | /* | |
331 | * no device created for this object, | |
332 | * so we should create one. | |
333 | */ | |
b8bd759a | 334 | ret = acpi_bus_scan(handle); |
636458de | 335 | if (ret) |
747479a3 | 336 | pr_debug("error adding bus, %x\n", -ret); |
c8f7a62c | 337 | } |
c8f7a62c LB |
338 | } |
339 | ||
340 | /** | |
341 | * dock_remove_acpi_device - remove the acpi_device struct from acpi | |
342 | * @handle - the handle of the device to remove | |
343 | * | |
344 | * Tell acpi to remove the acpi_device. This should cause any loaded | |
345 | * driver to have it's remove routine called. | |
346 | */ | |
347 | static void dock_remove_acpi_device(acpi_handle handle) | |
348 | { | |
349 | struct acpi_device *device; | |
c8f7a62c | 350 | |
bfee26db RW |
351 | if (!acpi_bus_get_device(handle, &device)) |
352 | acpi_bus_trim(device); | |
c8f7a62c LB |
353 | } |
354 | ||
c8f7a62c | 355 | /** |
37f90877 RW |
356 | * hot_remove_dock_devices - Remove dock station devices. |
357 | * @ds: Dock station. | |
358 | */ | |
359 | static void hot_remove_dock_devices(struct dock_station *ds) | |
360 | { | |
361 | struct dock_dependent_device *dd; | |
362 | ||
363 | /* | |
364 | * Walk the list in reverse order so that devices that have been added | |
365 | * last are removed first (in case there are some indirect dependencies | |
366 | * between them). | |
367 | */ | |
368 | list_for_each_entry_reverse(dd, &ds->dependent_devices, list) | |
369 | dock_hotplug_event(dd, ACPI_NOTIFY_EJECT_REQUEST, false); | |
370 | ||
371 | list_for_each_entry_reverse(dd, &ds->dependent_devices, list) | |
372 | dock_remove_acpi_device(dd->handle); | |
373 | } | |
374 | ||
375 | /** | |
376 | * hotplug_dock_devices - Insert devices on a dock station. | |
c8f7a62c | 377 | * @ds: the dock station |
37f90877 | 378 | * @event: either bus check or device check request |
c8f7a62c LB |
379 | * |
380 | * Some devices on the dock station need to have drivers called | |
381 | * to perform hotplug operations after a dock event has occurred. | |
382 | * Traverse the list of dock devices that have registered a | |
383 | * hotplug handler, and call the handler. | |
384 | */ | |
385 | static void hotplug_dock_devices(struct dock_station *ds, u32 event) | |
386 | { | |
387 | struct dock_dependent_device *dd; | |
388 | ||
f09ce741 RW |
389 | /* Call driver specific post-dock fixups. */ |
390 | list_for_each_entry(dd, &ds->dependent_devices, list) | |
391 | dock_hotplug_event(dd, event, DOCK_CALL_FIXUP); | |
392 | ||
37f90877 | 393 | /* Call driver specific hotplug functions. */ |
21a31013 | 394 | list_for_each_entry(dd, &ds->dependent_devices, list) |
f09ce741 | 395 | dock_hotplug_event(dd, event, DOCK_CALL_HANDLER); |
c8f7a62c LB |
396 | |
397 | /* | |
37f90877 RW |
398 | * Now make sure that an acpi_device is created for each dependent |
399 | * device. That will cause scan handlers to be attached to device | |
400 | * objects or acpi_drivers to be stopped/started if they are present. | |
c8f7a62c | 401 | */ |
37f90877 RW |
402 | list_for_each_entry(dd, &ds->dependent_devices, list) |
403 | dock_create_acpi_device(dd->handle); | |
c8f7a62c LB |
404 | } |
405 | ||
406 | static void dock_event(struct dock_station *ds, u32 event, int num) | |
407 | { | |
db350b08 | 408 | struct device *dev = &ds->dock_device->dev; |
66b56821 | 409 | char event_string[13]; |
79a8f70b | 410 | char *envp[] = { event_string, NULL }; |
1253f7aa | 411 | struct dock_dependent_device *dd; |
79a8f70b KCA |
412 | |
413 | if (num == UNDOCK_EVENT) | |
66b56821 | 414 | sprintf(event_string, "EVENT=undock"); |
79a8f70b | 415 | else |
66b56821 | 416 | sprintf(event_string, "EVENT=dock"); |
79a8f70b | 417 | |
5669021e | 418 | /* |
8ea86e0b KCA |
419 | * Indicate that the status of the dock station has |
420 | * changed. | |
5669021e | 421 | */ |
1253f7aa SL |
422 | if (num == DOCK_EVENT) |
423 | kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp); | |
424 | ||
21a31013 | 425 | list_for_each_entry(dd, &ds->dependent_devices, list) |
f09ce741 | 426 | dock_hotplug_event(dd, event, DOCK_CALL_UEVENT); |
747479a3 | 427 | |
1253f7aa SL |
428 | if (num != DOCK_EVENT) |
429 | kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp); | |
c8f7a62c LB |
430 | } |
431 | ||
c8f7a62c LB |
432 | /** |
433 | * handle_dock - handle a dock event | |
434 | * @ds: the dock station | |
435 | * @dock: to dock, or undock - that is the question | |
436 | * | |
437 | * Execute the _DCK method in response to an acpi event | |
438 | */ | |
439 | static void handle_dock(struct dock_station *ds, int dock) | |
440 | { | |
441 | acpi_status status; | |
442 | struct acpi_object_list arg_list; | |
443 | union acpi_object arg; | |
6a868e17 | 444 | unsigned long long value; |
c8f7a62c | 445 | |
cd73018f | 446 | acpi_handle_info(ds->handle, "%s\n", dock ? "docking" : "undocking"); |
c8f7a62c LB |
447 | |
448 | /* _DCK method has one argument */ | |
449 | arg_list.count = 1; | |
450 | arg_list.pointer = &arg; | |
451 | arg.type = ACPI_TYPE_INTEGER; | |
452 | arg.integer.value = dock; | |
6a868e17 | 453 | status = acpi_evaluate_integer(ds->handle, "_DCK", &arg_list, &value); |
db350b08 | 454 | if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) |
cd73018f TK |
455 | acpi_handle_err(ds->handle, "Failed to execute _DCK (0x%x)\n", |
456 | status); | |
c8f7a62c LB |
457 | } |
458 | ||
459 | static inline void dock(struct dock_station *ds) | |
460 | { | |
461 | handle_dock(ds, 1); | |
462 | } | |
463 | ||
464 | static inline void undock(struct dock_station *ds) | |
465 | { | |
466 | handle_dock(ds, 0); | |
467 | } | |
468 | ||
469 | static inline void begin_dock(struct dock_station *ds) | |
470 | { | |
471 | ds->flags |= DOCK_DOCKING; | |
472 | } | |
473 | ||
474 | static inline void complete_dock(struct dock_station *ds) | |
475 | { | |
476 | ds->flags &= ~(DOCK_DOCKING); | |
477 | ds->last_dock_time = jiffies; | |
478 | } | |
479 | ||
a0cd35fd KCA |
480 | static inline void begin_undock(struct dock_station *ds) |
481 | { | |
482 | ds->flags |= DOCK_UNDOCKING; | |
483 | } | |
484 | ||
485 | static inline void complete_undock(struct dock_station *ds) | |
486 | { | |
487 | ds->flags &= ~(DOCK_UNDOCKING); | |
488 | } | |
489 | ||
c8f7a62c LB |
490 | /** |
491 | * dock_in_progress - see if we are in the middle of handling a dock event | |
492 | * @ds: the dock station | |
493 | * | |
494 | * Sometimes while docking, false dock events can be sent to the driver | |
495 | * because good connections aren't made or some other reason. Ignore these | |
496 | * if we are in the middle of doing something. | |
497 | */ | |
498 | static int dock_in_progress(struct dock_station *ds) | |
499 | { | |
500 | if ((ds->flags & DOCK_DOCKING) || | |
501 | time_before(jiffies, (ds->last_dock_time + HZ))) | |
502 | return 1; | |
503 | return 0; | |
504 | } | |
505 | ||
c8f7a62c LB |
506 | /** |
507 | * register_hotplug_dock_device - register a hotplug function | |
508 | * @handle: the handle of the device | |
1253f7aa | 509 | * @ops: handlers to call after docking |
c8f7a62c | 510 | * @context: device specific data |
21a31013 RW |
511 | * @init: Optional initialization routine to run after registration |
512 | * @release: Optional release routine to run on unregistration | |
c8f7a62c LB |
513 | * |
514 | * If a driver would like to perform a hotplug operation after a dock | |
515 | * event, they can register an acpi_notifiy_handler to be called by | |
516 | * the dock driver after _DCK is executed. | |
517 | */ | |
21a31013 RW |
518 | int register_hotplug_dock_device(acpi_handle handle, |
519 | const struct acpi_dock_ops *ops, void *context, | |
520 | void (*init)(void *), void (*release)(void *)) | |
c8f7a62c LB |
521 | { |
522 | struct dock_dependent_device *dd; | |
db350b08 | 523 | struct dock_station *dock_station; |
61b83695 | 524 | int ret = -EINVAL; |
c8f7a62c | 525 | |
21a31013 RW |
526 | if (WARN_ON(!context)) |
527 | return -EINVAL; | |
528 | ||
db350b08 | 529 | if (!dock_station_count) |
c8f7a62c LB |
530 | return -ENODEV; |
531 | ||
532 | /* | |
533 | * make sure this handle is for a device dependent on the dock, | |
534 | * this would include the dock station itself | |
535 | */ | |
50d716e4 | 536 | list_for_each_entry(dock_station, &dock_stations, sibling) { |
61b83695 SL |
537 | /* |
538 | * An ATA bay can be in a dock and itself can be ejected | |
3ad2f3fb | 539 | * separately, so there are two 'dock stations' which need the |
61b83695 SL |
540 | * ops |
541 | */ | |
db350b08 | 542 | dd = find_dock_dependent_device(dock_station, handle); |
21a31013 | 543 | if (dd && !dock_init_hotplug(dd, ops, context, init, release)) |
61b83695 | 544 | ret = 0; |
c8f7a62c LB |
545 | } |
546 | ||
61b83695 | 547 | return ret; |
c8f7a62c | 548 | } |
c8f7a62c LB |
549 | EXPORT_SYMBOL_GPL(register_hotplug_dock_device); |
550 | ||
551 | /** | |
552 | * unregister_hotplug_dock_device - remove yourself from the hotplug list | |
553 | * @handle: the acpi handle of the device | |
554 | */ | |
555 | void unregister_hotplug_dock_device(acpi_handle handle) | |
556 | { | |
557 | struct dock_dependent_device *dd; | |
db350b08 | 558 | struct dock_station *dock_station; |
c8f7a62c | 559 | |
db350b08 | 560 | if (!dock_station_count) |
c8f7a62c LB |
561 | return; |
562 | ||
50d716e4 | 563 | list_for_each_entry(dock_station, &dock_stations, sibling) { |
db350b08 SL |
564 | dd = find_dock_dependent_device(dock_station, handle); |
565 | if (dd) | |
21a31013 | 566 | dock_release_hotplug(dd); |
db350b08 | 567 | } |
c8f7a62c | 568 | } |
c8f7a62c LB |
569 | EXPORT_SYMBOL_GPL(unregister_hotplug_dock_device); |
570 | ||
c80fdbe8 | 571 | /** |
572 | * handle_eject_request - handle an undock request checking for error conditions | |
573 | * | |
574 | * Check to make sure the dock device is still present, then undock and | |
575 | * hotremove all the devices that may need removing. | |
576 | */ | |
577 | static int handle_eject_request(struct dock_station *ds, u32 event) | |
578 | { | |
c80fdbe8 | 579 | if (dock_in_progress(ds)) |
580 | return -EBUSY; | |
581 | ||
582 | /* | |
583 | * here we need to generate the undock | |
584 | * event prior to actually doing the undock | |
585 | * so that the device struct still exists. | |
afd7301d HM |
586 | * Also, even send the dock event if the |
587 | * device is not present anymore | |
c80fdbe8 | 588 | */ |
589 | dock_event(ds, event, UNDOCK_EVENT); | |
afd7301d | 590 | |
37f90877 | 591 | hot_remove_dock_devices(ds); |
c80fdbe8 | 592 | undock(ds); |
c9b5471f JL |
593 | acpi_evaluate_lck(ds->handle, 0); |
594 | acpi_evaluate_ej0(ds->handle); | |
c80fdbe8 | 595 | if (dock_present(ds)) { |
cd73018f | 596 | acpi_handle_err(ds->handle, "Unable to undock!\n"); |
c80fdbe8 | 597 | return -EBUSY; |
598 | } | |
a0cd35fd | 599 | complete_undock(ds); |
c80fdbe8 | 600 | return 0; |
601 | } | |
602 | ||
c8f7a62c LB |
603 | /** |
604 | * dock_notify - act upon an acpi dock notification | |
59401ccc | 605 | * @ds: dock station |
c8f7a62c | 606 | * @event: the acpi event |
c8f7a62c LB |
607 | * |
608 | * If we are notified to dock, then check to see if the dock is | |
609 | * present and then dock. Notify all drivers of the dock event, | |
c80fdbe8 | 610 | * and then hotplug and devices that may need hotplugging. |
c8f7a62c | 611 | */ |
59401ccc | 612 | static void dock_notify(struct dock_station *ds, u32 event) |
c8f7a62c | 613 | { |
59401ccc RW |
614 | acpi_handle handle = ds->handle; |
615 | struct acpi_device *ad; | |
db350b08 | 616 | int surprise_removal = 0; |
c8f7a62c | 617 | |
db350b08 SL |
618 | /* |
619 | * According to acpi spec 3.0a, if a DEVICE_CHECK notification | |
620 | * is sent and _DCK is present, it is assumed to mean an undock | |
621 | * request. | |
622 | */ | |
623 | if ((ds->flags & DOCK_IS_DOCK) && event == ACPI_NOTIFY_DEVICE_CHECK) | |
624 | event = ACPI_NOTIFY_EJECT_REQUEST; | |
625 | ||
626 | /* | |
627 | * dock station: BUS_CHECK - docked or surprise removal | |
628 | * DEVICE_CHECK - undocked | |
629 | * other device: BUS_CHECK/DEVICE_CHECK - added or surprise removal | |
630 | * | |
631 | * To simplify event handling, dock dependent device handler always | |
632 | * get ACPI_NOTIFY_BUS_CHECK/ACPI_NOTIFY_DEVICE_CHECK for add and | |
633 | * ACPI_NOTIFY_EJECT_REQUEST for removal | |
634 | */ | |
c8f7a62c LB |
635 | switch (event) { |
636 | case ACPI_NOTIFY_BUS_CHECK: | |
db350b08 | 637 | case ACPI_NOTIFY_DEVICE_CHECK: |
59401ccc | 638 | if (!dock_in_progress(ds) && acpi_bus_get_device(handle, &ad)) { |
c8f7a62c LB |
639 | begin_dock(ds); |
640 | dock(ds); | |
641 | if (!dock_present(ds)) { | |
cd73018f | 642 | acpi_handle_err(handle, "Unable to dock!\n"); |
8b59560a | 643 | complete_dock(ds); |
c8f7a62c LB |
644 | break; |
645 | } | |
c8f7a62c LB |
646 | hotplug_dock_devices(ds, event); |
647 | complete_dock(ds); | |
648 | dock_event(ds, event, DOCK_EVENT); | |
c9b5471f | 649 | acpi_evaluate_lck(ds->handle, 1); |
3a37898d | 650 | acpi_update_all_gpes(); |
db350b08 | 651 | break; |
c8f7a62c | 652 | } |
db350b08 SL |
653 | if (dock_present(ds) || dock_in_progress(ds)) |
654 | break; | |
655 | /* This is a surprise removal */ | |
656 | surprise_removal = 1; | |
657 | event = ACPI_NOTIFY_EJECT_REQUEST; | |
658 | /* Fall back */ | |
c8f7a62c | 659 | case ACPI_NOTIFY_EJECT_REQUEST: |
a0cd35fd | 660 | begin_undock(ds); |
f730ae18 SL |
661 | if ((immediate_undock && !(ds->flags & DOCK_IS_ATA)) |
662 | || surprise_removal) | |
a0cd35fd KCA |
663 | handle_eject_request(ds, event); |
664 | else | |
665 | dock_event(ds, event, UNDOCK_EVENT); | |
c8f7a62c LB |
666 | break; |
667 | default: | |
cd73018f | 668 | acpi_handle_err(handle, "Unknown dock event %d\n", event); |
c8f7a62c LB |
669 | } |
670 | } | |
671 | ||
7b98118a | 672 | static void acpi_dock_deferred_cb(void *data, u32 event) |
19cd847a | 673 | { |
3757b948 | 674 | acpi_scan_lock_acquire(); |
7b98118a | 675 | dock_notify(data, event); |
3757b948 | 676 | acpi_scan_lock_release(); |
19cd847a ZR |
677 | } |
678 | ||
59401ccc | 679 | static void dock_notify_handler(acpi_handle handle, u32 event, void *data) |
6bd00a61 | 680 | { |
6bd00a61 SL |
681 | if (event != ACPI_NOTIFY_BUS_CHECK && event != ACPI_NOTIFY_DEVICE_CHECK |
682 | && event != ACPI_NOTIFY_EJECT_REQUEST) | |
59401ccc | 683 | return; |
3757b948 | 684 | |
7b98118a | 685 | acpi_hotplug_execute(acpi_dock_deferred_cb, data, event); |
6bd00a61 SL |
686 | } |
687 | ||
c8f7a62c LB |
688 | /** |
689 | * find_dock_devices - find devices on the dock station | |
690 | * @handle: the handle of the device we are examining | |
691 | * @lvl: unused | |
692 | * @context: the dock station private data | |
693 | * @rv: unused | |
694 | * | |
695 | * This function is called by acpi_walk_namespace. It will | |
696 | * check to see if an object has an _EJD method. If it does, then it | |
697 | * will see if it is dependent on the dock station. | |
698 | */ | |
96c0a4d4 RW |
699 | static acpi_status __init find_dock_devices(acpi_handle handle, u32 lvl, |
700 | void *context, void **rv) | |
c8f7a62c | 701 | { |
50dd0969 | 702 | struct dock_station *ds = context; |
96c0a4d4 | 703 | acpi_handle ejd = NULL; |
c8f7a62c | 704 | |
96c0a4d4 RW |
705 | acpi_bus_get_ejd(handle, &ejd); |
706 | if (ejd == ds->handle) | |
f69cfdd2 AC |
707 | add_dock_dependent_device(ds, handle); |
708 | ||
c8f7a62c LB |
709 | return AE_OK; |
710 | } | |
711 | ||
c80fdbe8 | 712 | /* |
713 | * show_docked - read method for "docked" file in sysfs | |
714 | */ | |
715 | static ssize_t show_docked(struct device *dev, | |
716 | struct device_attribute *attr, char *buf) | |
717 | { | |
fc5a9f88 HM |
718 | struct acpi_device *tmp; |
719 | ||
fe06fba2 | 720 | struct dock_station *dock_station = dev->platform_data; |
c80fdbe8 | 721 | |
02df7349 | 722 | if (!acpi_bus_get_device(dock_station->handle, &tmp)) |
fc5a9f88 HM |
723 | return snprintf(buf, PAGE_SIZE, "1\n"); |
724 | return snprintf(buf, PAGE_SIZE, "0\n"); | |
c80fdbe8 | 725 | } |
e5685b9d | 726 | static DEVICE_ATTR(docked, S_IRUGO, show_docked, NULL); |
c80fdbe8 | 727 | |
a0cd35fd KCA |
728 | /* |
729 | * show_flags - read method for flags file in sysfs | |
730 | */ | |
731 | static ssize_t show_flags(struct device *dev, | |
732 | struct device_attribute *attr, char *buf) | |
733 | { | |
fe06fba2 | 734 | struct dock_station *dock_station = dev->platform_data; |
a0cd35fd KCA |
735 | return snprintf(buf, PAGE_SIZE, "%d\n", dock_station->flags); |
736 | ||
737 | } | |
e5685b9d | 738 | static DEVICE_ATTR(flags, S_IRUGO, show_flags, NULL); |
a0cd35fd | 739 | |
c80fdbe8 | 740 | /* |
741 | * write_undock - write method for "undock" file in sysfs | |
742 | */ | |
743 | static ssize_t write_undock(struct device *dev, struct device_attribute *attr, | |
744 | const char *buf, size_t count) | |
745 | { | |
746 | int ret; | |
fe06fba2 | 747 | struct dock_station *dock_station = dev->platform_data; |
c80fdbe8 | 748 | |
749 | if (!count) | |
750 | return -EINVAL; | |
751 | ||
8112006f | 752 | acpi_scan_lock_acquire(); |
9171f834 | 753 | begin_undock(dock_station); |
c80fdbe8 | 754 | ret = handle_eject_request(dock_station, ACPI_NOTIFY_EJECT_REQUEST); |
8112006f | 755 | acpi_scan_lock_release(); |
c80fdbe8 | 756 | return ret ? ret: count; |
757 | } | |
e5685b9d | 758 | static DEVICE_ATTR(undock, S_IWUSR, NULL, write_undock); |
c80fdbe8 | 759 | |
ac122bb6 IVE |
760 | /* |
761 | * show_dock_uid - read method for "uid" file in sysfs | |
762 | */ | |
763 | static ssize_t show_dock_uid(struct device *dev, | |
764 | struct device_attribute *attr, char *buf) | |
765 | { | |
27663c58 | 766 | unsigned long long lbuf; |
fe06fba2 | 767 | struct dock_station *dock_station = dev->platform_data; |
38ff4ffc KCA |
768 | acpi_status status = acpi_evaluate_integer(dock_station->handle, |
769 | "_UID", NULL, &lbuf); | |
770 | if (ACPI_FAILURE(status)) | |
ac122bb6 | 771 | return 0; |
38ff4ffc | 772 | |
27663c58 | 773 | return snprintf(buf, PAGE_SIZE, "%llx\n", lbuf); |
ac122bb6 | 774 | } |
e5685b9d | 775 | static DEVICE_ATTR(uid, S_IRUGO, show_dock_uid, NULL); |
ac122bb6 | 776 | |
8652b00f SL |
777 | static ssize_t show_dock_type(struct device *dev, |
778 | struct device_attribute *attr, char *buf) | |
779 | { | |
fe06fba2 | 780 | struct dock_station *dock_station = dev->platform_data; |
8652b00f SL |
781 | char *type; |
782 | ||
783 | if (dock_station->flags & DOCK_IS_DOCK) | |
784 | type = "dock_station"; | |
785 | else if (dock_station->flags & DOCK_IS_ATA) | |
786 | type = "ata_bay"; | |
787 | else if (dock_station->flags & DOCK_IS_BAT) | |
788 | type = "battery_bay"; | |
789 | else | |
790 | type = "unknown"; | |
791 | ||
792 | return snprintf(buf, PAGE_SIZE, "%s\n", type); | |
793 | } | |
794 | static DEVICE_ATTR(type, S_IRUGO, show_dock_type, NULL); | |
795 | ||
5f46c2f2 AC |
796 | static struct attribute *dock_attributes[] = { |
797 | &dev_attr_docked.attr, | |
798 | &dev_attr_flags.attr, | |
799 | &dev_attr_undock.attr, | |
800 | &dev_attr_uid.attr, | |
801 | &dev_attr_type.attr, | |
802 | NULL | |
803 | }; | |
804 | ||
805 | static struct attribute_group dock_attribute_group = { | |
806 | .attrs = dock_attributes | |
807 | }; | |
808 | ||
c8f7a62c LB |
809 | /** |
810 | * dock_add - add a new dock station | |
811 | * @handle: the dock station handle | |
812 | * | |
813 | * allocated and initialize a new dock station device. Find all devices | |
814 | * that are on the dock station, and register for dock event notifications. | |
815 | */ | |
d38a5edf | 816 | static int __init dock_add(acpi_handle handle) |
c8f7a62c | 817 | { |
2efbca4d | 818 | struct dock_station *dock_station, ds = { NULL, }; |
747479a3 | 819 | struct platform_device *dd; |
59401ccc | 820 | acpi_status status; |
2efbca4d | 821 | int ret; |
c8f7a62c | 822 | |
2efbca4d RW |
823 | dd = platform_device_register_data(NULL, "dock", dock_station_count, |
824 | &ds, sizeof(ds)); | |
747479a3 AC |
825 | if (IS_ERR(dd)) |
826 | return PTR_ERR(dd); | |
827 | ||
828 | dock_station = dd->dev.platform_data; | |
c8f7a62c | 829 | |
c8f7a62c | 830 | dock_station->handle = handle; |
747479a3 | 831 | dock_station->dock_device = dd; |
c8f7a62c | 832 | dock_station->last_dock_time = jiffies - HZ; |
747479a3 | 833 | |
747479a3 | 834 | INIT_LIST_HEAD(&dock_station->sibling); |
747479a3 | 835 | INIT_LIST_HEAD(&dock_station->dependent_devices); |
a0cd35fd | 836 | |
9ef2a9a9 | 837 | /* we want the dock device to send uevents */ |
747479a3 | 838 | dev_set_uevent_suppress(&dd->dev, 0); |
9ef2a9a9 | 839 | |
c9b5471f | 840 | if (acpi_dock_match(handle)) |
db350b08 | 841 | dock_station->flags |= DOCK_IS_DOCK; |
c9b5471f | 842 | if (acpi_ata_match(handle)) |
db350b08 SL |
843 | dock_station->flags |= DOCK_IS_ATA; |
844 | if (is_battery(handle)) | |
845 | dock_station->flags |= DOCK_IS_BAT; | |
846 | ||
747479a3 | 847 | ret = sysfs_create_group(&dd->dev.kobj, &dock_attribute_group); |
8652b00f | 848 | if (ret) |
5f46c2f2 | 849 | goto err_unregister; |
671adbec | 850 | |
c8f7a62c LB |
851 | /* Find dependent devices */ |
852 | acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT, | |
2263576c LM |
853 | ACPI_UINT32_MAX, find_dock_devices, NULL, |
854 | dock_station, NULL); | |
c8f7a62c LB |
855 | |
856 | /* add the dock station as a device dependent on itself */ | |
f69cfdd2 AC |
857 | ret = add_dock_dependent_device(dock_station, handle); |
858 | if (ret) | |
5f46c2f2 | 859 | goto err_rmgroup; |
c8f7a62c | 860 | |
59401ccc RW |
861 | status = acpi_install_notify_handler(handle, ACPI_SYSTEM_NOTIFY, |
862 | dock_notify_handler, dock_station); | |
0177f29f WY |
863 | if (ACPI_FAILURE(status)) { |
864 | ret = -ENODEV; | |
59401ccc | 865 | goto err_rmgroup; |
0177f29f | 866 | } |
59401ccc | 867 | |
db350b08 | 868 | dock_station_count++; |
50d716e4 | 869 | list_add(&dock_station->sibling, &dock_stations); |
c8f7a62c LB |
870 | return 0; |
871 | ||
5f46c2f2 | 872 | err_rmgroup: |
a30c4c5e | 873 | remove_dock_dependent_devices(dock_station); |
747479a3 | 874 | sysfs_remove_group(&dd->dev.kobj, &dock_attribute_group); |
5f46c2f2 | 875 | err_unregister: |
747479a3 | 876 | platform_device_unregister(dd); |
cd73018f | 877 | acpi_handle_err(handle, "%s encountered error %d\n", __func__, ret); |
c8f7a62c LB |
878 | return ret; |
879 | } | |
880 | ||
c8f7a62c | 881 | /** |
8ab0ab25 | 882 | * find_dock_and_bay - look for dock stations and bays |
c8f7a62c LB |
883 | * @handle: acpi handle of a device |
884 | * @lvl: unused | |
8ab0ab25 | 885 | * @context: unused |
c8f7a62c LB |
886 | * @rv: unused |
887 | * | |
8ab0ab25 | 888 | * This is called by acpi_walk_namespace to look for dock stations and bays. |
c8f7a62c | 889 | */ |
027951e5 | 890 | static acpi_status __init |
8ab0ab25 | 891 | find_dock_and_bay(acpi_handle handle, u32 lvl, void *context, void **rv) |
c8f7a62c | 892 | { |
c9b5471f | 893 | if (acpi_dock_match(handle) || is_ejectable_bay(handle)) |
1ee4d61f | 894 | dock_add(handle); |
747479a3 | 895 | |
1ee4d61f | 896 | return AE_OK; |
c8f7a62c LB |
897 | } |
898 | ||
2ce65fe8 | 899 | void __init acpi_dock_init(void) |
db350b08 | 900 | { |
816c2eda | 901 | if (acpi_disabled) |
2ce65fe8 | 902 | return; |
816c2eda | 903 | |
8ab0ab25 | 904 | /* look for dock stations and bays */ |
c8f7a62c | 905 | acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT, |
8ab0ab25 | 906 | ACPI_UINT32_MAX, find_dock_and_bay, NULL, NULL, NULL); |
c8f7a62c | 907 | |
db350b08 | 908 | if (!dock_station_count) { |
cd73018f | 909 | pr_info(PREFIX "No dock devices found.\n"); |
2ce65fe8 | 910 | return; |
db350b08 | 911 | } |
c8f7a62c | 912 | |
cd73018f | 913 | pr_info(PREFIX "%s: %d docks/bays found\n", |
db350b08 | 914 | ACPI_DOCK_DRIVER_DESCRIPTION, dock_station_count); |
c8f7a62c | 915 | } |