xref: /openbmc/linux/drivers/acpi/dock.c (revision edf5bf34d40804fbef32f240a79b74ffc69a658b)
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>
27 #include <linux/slab.h>
28 #include <linux/init.h>
29 #include <linux/types.h>
30 #include <linux/notifier.h>
31 #include <linux/platform_device.h>
32 #include <linux/jiffies.h>
33 #include <linux/stddef.h>
34 #include <linux/acpi.h>
35 
36 #include "internal.h"
37 
38 #define PREFIX "ACPI: "
39 
40 #define ACPI_DOCK_DRIVER_DESCRIPTION "ACPI Dock Station Driver"
41 
42 ACPI_MODULE_NAME("dock");
43 MODULE_AUTHOR("Kristen Carlson Accardi");
44 MODULE_DESCRIPTION(ACPI_DOCK_DRIVER_DESCRIPTION);
45 MODULE_LICENSE("GPL");
46 
47 static bool immediate_undock = 1;
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 
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 
60 struct dock_station {
61 	acpi_handle handle;
62 	unsigned long last_dock_time;
63 	u32 flags;
64 	struct list_head dependent_devices;
65 
66 	struct list_head sibling;
67 	struct platform_device *dock_device;
68 };
69 static LIST_HEAD(dock_stations);
70 static int dock_station_count;
71 static DEFINE_MUTEX(hotplug_lock);
72 
73 struct dock_dependent_device {
74 	struct list_head list;
75 	struct acpi_device *adev;
76 	const struct acpi_dock_ops *hp_ops;
77 	void *hp_context;
78 	unsigned int hp_refcount;
79 	void (*hp_release)(void *);
80 };
81 
82 #define DOCK_DOCKING	0x00000001
83 #define DOCK_UNDOCKING  0x00000002
84 #define DOCK_IS_DOCK	0x00000010
85 #define DOCK_IS_ATA	0x00000020
86 #define DOCK_IS_BAT	0x00000040
87 #define DOCK_EVENT	3
88 #define UNDOCK_EVENT	2
89 
90 enum dock_callback_type {
91 	DOCK_CALL_HANDLER,
92 	DOCK_CALL_FIXUP,
93 	DOCK_CALL_UEVENT,
94 };
95 
96 /*****************************************************************************
97  *                         Dock Dependent device functions                   *
98  *****************************************************************************/
99 /**
100  * add_dock_dependent_device - associate a device with the dock station
101  * @ds: Dock station.
102  * @adev: Dependent ACPI device object.
103  *
104  * Add the dependent device to the dock's dependent device list.
105  */
106 static int add_dock_dependent_device(struct dock_station *ds,
107 				     struct acpi_device *adev)
108 {
109 	struct dock_dependent_device *dd;
110 
111 	dd = kzalloc(sizeof(*dd), GFP_KERNEL);
112 	if (!dd)
113 		return -ENOMEM;
114 
115 	dd->adev = adev;
116 	INIT_LIST_HEAD(&dd->list);
117 	list_add_tail(&dd->list, &ds->dependent_devices);
118 
119 	return 0;
120 }
121 
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 
132 /**
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.
139  */
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 *))
143 {
144 	int ret = 0;
145 
146 	mutex_lock(&hotplug_lock);
147 	if (WARN_ON(dd->hp_context)) {
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;
154 		if (init)
155 			init(context);
156 	}
157 	mutex_unlock(&hotplug_lock);
158 	return ret;
159 }
160 
161 /**
162  * dock_release_hotplug - Decrement hotplug reference counter of dock device.
163  * @dd: Dock-dependent device.
164  *
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.
168  */
169 static void dock_release_hotplug(struct dock_dependent_device *dd)
170 {
171 	mutex_lock(&hotplug_lock);
172 	if (dd->hp_context && !--dd->hp_refcount) {
173 		void (*release)(void *) = dd->hp_release;
174 		void *context = dd->hp_context;
175 
176 		dd->hp_ops = NULL;
177 		dd->hp_context = NULL;
178 		dd->hp_release = NULL;
179 		if (release)
180 			release(context);
181 	}
182 	mutex_unlock(&hotplug_lock);
183 }
184 
185 static void dock_hotplug_event(struct dock_dependent_device *dd, u32 event,
186 			       enum dock_callback_type cb_type)
187 {
188 	struct acpi_device *adev = dd->adev;
189 	acpi_notify_handler cb = NULL;
190 	bool run = false;
191 
192 	acpi_lock_hp_context();
193 
194 	if (!adev->hp)
195 		goto no_context;
196 
197 	if (cb_type == DOCK_CALL_FIXUP) {
198 		void (*fixup)(struct acpi_device *);
199 
200 		fixup = adev->hp->fixup;
201 		if (fixup) {
202 			acpi_unlock_hp_context();
203 			fixup(adev);
204 			return;
205 		}
206 	} else {
207 		int (*notify)(struct acpi_device *, u32);
208 
209 		notify = adev->hp->event;
210 		if (notify) {
211 			acpi_unlock_hp_context();
212 			notify(adev, event);
213 			return;
214 		}
215 	}
216 
217  no_context:
218 	acpi_unlock_hp_context();
219 
220 	mutex_lock(&hotplug_lock);
221 
222 	if (dd->hp_context) {
223 		run = true;
224 		dd->hp_refcount++;
225 		if (dd->hp_ops) {
226 			switch (cb_type) {
227 			case DOCK_CALL_FIXUP:
228 				cb = dd->hp_ops->fixup;
229 				break;
230 			case DOCK_CALL_UEVENT:
231 				cb = dd->hp_ops->uevent;
232 				break;
233 			default:
234 				cb = dd->hp_ops->handler;
235 			}
236 		}
237 	}
238 
239 	mutex_unlock(&hotplug_lock);
240 
241 	if (!run)
242 		return;
243 
244 	if (cb)
245 		cb(dd->adev->handle, event, dd->hp_context);
246 
247 	dock_release_hotplug(dd);
248 }
249 
250 static struct dock_station *find_dock_station(acpi_handle handle)
251 {
252 	struct dock_station *ds;
253 
254 	list_for_each_entry(ds, &dock_stations, sibling)
255 		if (ds->handle == handle)
256 			return ds;
257 
258 	return NULL;
259 }
260 
261 /**
262  * find_dock_dependent_device - get a device dependent on this dock
263  * @ds: the dock station
264  * @adev: ACPI device object to find.
265  *
266  * iterate over the dependent device list for this dock.  If the
267  * dependent device matches the handle, return.
268  */
269 static struct dock_dependent_device *
270 find_dock_dependent_device(struct dock_station *ds, struct acpi_device *adev)
271 {
272 	struct dock_dependent_device *dd;
273 
274 	list_for_each_entry(dd, &ds->dependent_devices, list)
275 		if (adev == dd->adev)
276 			return dd;
277 
278 	return NULL;
279 }
280 
281 void register_dock_dependent_device(struct acpi_device *adev,
282 				    acpi_handle dshandle)
283 {
284 	struct dock_station *ds = find_dock_station(dshandle);
285 
286 	if (ds && !find_dock_dependent_device(ds, adev))
287 		add_dock_dependent_device(ds, adev);
288 }
289 
290 /*****************************************************************************
291  *                         Dock functions                                    *
292  *****************************************************************************/
293 
294 /**
295  * is_dock_device - see if a device is on a dock station
296  * @adev: ACPI device object to check.
297  *
298  * If this device is either the dock station itself,
299  * or is a device dependent on the dock station, then it
300  * is a dock device
301  */
302 int is_dock_device(struct acpi_device *adev)
303 {
304 	struct dock_station *dock_station;
305 
306 	if (!dock_station_count)
307 		return 0;
308 
309 	if (acpi_dock_match(adev->handle))
310 		return 1;
311 
312 	list_for_each_entry(dock_station, &dock_stations, sibling)
313 		if (find_dock_dependent_device(dock_station, adev))
314 			return 1;
315 
316 	return 0;
317 }
318 EXPORT_SYMBOL_GPL(is_dock_device);
319 
320 /**
321  * dock_present - see if the dock station is present.
322  * @ds: the dock station
323  *
324  * execute the _STA method.  note that present does not
325  * imply that we are docked.
326  */
327 static int dock_present(struct dock_station *ds)
328 {
329 	unsigned long long sta;
330 	acpi_status status;
331 
332 	if (ds) {
333 		status = acpi_evaluate_integer(ds->handle, "_STA", NULL, &sta);
334 		if (ACPI_SUCCESS(status) && sta)
335 			return 1;
336 	}
337 	return 0;
338 }
339 
340 /**
341  * hot_remove_dock_devices - Remove dock station devices.
342  * @ds: Dock station.
343  */
344 static void hot_remove_dock_devices(struct dock_station *ds)
345 {
346 	struct dock_dependent_device *dd;
347 
348 	/*
349 	 * Walk the list in reverse order so that devices that have been added
350 	 * last are removed first (in case there are some indirect dependencies
351 	 * between them).
352 	 */
353 	list_for_each_entry_reverse(dd, &ds->dependent_devices, list)
354 		dock_hotplug_event(dd, ACPI_NOTIFY_EJECT_REQUEST, false);
355 
356 	list_for_each_entry_reverse(dd, &ds->dependent_devices, list)
357 		acpi_bus_trim(dd->adev);
358 }
359 
360 /**
361  * hotplug_dock_devices - Insert devices on a dock station.
362  * @ds: the dock station
363  * @event: either bus check or device check request
364  *
365  * Some devices on the dock station need to have drivers called
366  * to perform hotplug operations after a dock event has occurred.
367  * Traverse the list of dock devices that have registered a
368  * hotplug handler, and call the handler.
369  */
370 static void hotplug_dock_devices(struct dock_station *ds, u32 event)
371 {
372 	struct dock_dependent_device *dd;
373 
374 	/* Call driver specific post-dock fixups. */
375 	list_for_each_entry(dd, &ds->dependent_devices, list)
376 		dock_hotplug_event(dd, event, DOCK_CALL_FIXUP);
377 
378 	/* Call driver specific hotplug functions. */
379 	list_for_each_entry(dd, &ds->dependent_devices, list)
380 		dock_hotplug_event(dd, event, DOCK_CALL_HANDLER);
381 
382 	/*
383 	 * Check if all devices have been enumerated already.  If not, run
384 	 * acpi_bus_scan() for them and that will cause scan handlers to be
385 	 * attached to device objects or acpi_drivers to be stopped/started if
386 	 * they are present.
387 	 */
388 	list_for_each_entry(dd, &ds->dependent_devices, list) {
389 		struct acpi_device *adev = dd->adev;
390 
391 		if (!acpi_device_enumerated(adev)) {
392 			int ret = acpi_bus_scan(adev->handle);
393 			if (ret)
394 				dev_dbg(&adev->dev, "scan error %d\n", -ret);
395 		}
396 	}
397 }
398 
399 static void dock_event(struct dock_station *ds, u32 event, int num)
400 {
401 	struct device *dev = &ds->dock_device->dev;
402 	char event_string[13];
403 	char *envp[] = { event_string, NULL };
404 	struct dock_dependent_device *dd;
405 
406 	if (num == UNDOCK_EVENT)
407 		sprintf(event_string, "EVENT=undock");
408 	else
409 		sprintf(event_string, "EVENT=dock");
410 
411 	/*
412 	 * Indicate that the status of the dock station has
413 	 * changed.
414 	 */
415 	if (num == DOCK_EVENT)
416 		kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp);
417 
418 	list_for_each_entry(dd, &ds->dependent_devices, list)
419 		dock_hotplug_event(dd, event, DOCK_CALL_UEVENT);
420 
421 	if (num != DOCK_EVENT)
422 		kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp);
423 }
424 
425 /**
426  * handle_dock - handle a dock event
427  * @ds: the dock station
428  * @dock: to dock, or undock - that is the question
429  *
430  * Execute the _DCK method in response to an acpi event
431  */
432 static void handle_dock(struct dock_station *ds, int dock)
433 {
434 	acpi_status status;
435 	struct acpi_object_list arg_list;
436 	union acpi_object arg;
437 	unsigned long long value;
438 
439 	acpi_handle_info(ds->handle, "%s\n", dock ? "docking" : "undocking");
440 
441 	/* _DCK method has one argument */
442 	arg_list.count = 1;
443 	arg_list.pointer = &arg;
444 	arg.type = ACPI_TYPE_INTEGER;
445 	arg.integer.value = dock;
446 	status = acpi_evaluate_integer(ds->handle, "_DCK", &arg_list, &value);
447 	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND)
448 		acpi_handle_err(ds->handle, "Failed to execute _DCK (0x%x)\n",
449 				status);
450 }
451 
452 static inline void dock(struct dock_station *ds)
453 {
454 	handle_dock(ds, 1);
455 }
456 
457 static inline void undock(struct dock_station *ds)
458 {
459 	handle_dock(ds, 0);
460 }
461 
462 static inline void begin_dock(struct dock_station *ds)
463 {
464 	ds->flags |= DOCK_DOCKING;
465 }
466 
467 static inline void complete_dock(struct dock_station *ds)
468 {
469 	ds->flags &= ~(DOCK_DOCKING);
470 	ds->last_dock_time = jiffies;
471 }
472 
473 static inline void begin_undock(struct dock_station *ds)
474 {
475 	ds->flags |= DOCK_UNDOCKING;
476 }
477 
478 static inline void complete_undock(struct dock_station *ds)
479 {
480 	ds->flags &= ~(DOCK_UNDOCKING);
481 }
482 
483 /**
484  * dock_in_progress - see if we are in the middle of handling a dock event
485  * @ds: the dock station
486  *
487  * Sometimes while docking, false dock events can be sent to the driver
488  * because good connections aren't made or some other reason.  Ignore these
489  * if we are in the middle of doing something.
490  */
491 static int dock_in_progress(struct dock_station *ds)
492 {
493 	if ((ds->flags & DOCK_DOCKING) ||
494 	    time_before(jiffies, (ds->last_dock_time + HZ)))
495 		return 1;
496 	return 0;
497 }
498 
499 /**
500  * register_hotplug_dock_device - register a hotplug function
501  * @handle: the handle of the device
502  * @ops: handlers to call after docking
503  * @context: device specific data
504  * @init: Optional initialization routine to run after registration
505  * @release: Optional release routine to run on unregistration
506  *
507  * If a driver would like to perform a hotplug operation after a dock
508  * event, they can register an acpi_notifiy_handler to be called by
509  * the dock driver after _DCK is executed.
510  */
511 int register_hotplug_dock_device(acpi_handle handle,
512 				 const struct acpi_dock_ops *ops, void *context,
513 				 void (*init)(void *), void (*release)(void *))
514 {
515 	struct dock_dependent_device *dd;
516 	struct dock_station *dock_station;
517 	struct acpi_device *adev;
518 	int ret = -EINVAL;
519 
520 	if (WARN_ON(!context))
521 		return -EINVAL;
522 
523 	if (!dock_station_count)
524 		return -ENODEV;
525 
526 	ret = acpi_bus_get_device(handle, &adev);
527 	if (ret)
528 		return ret;
529 
530 	/*
531 	 * make sure this handle is for a device dependent on the dock,
532 	 * this would include the dock station itself
533 	 */
534 	list_for_each_entry(dock_station, &dock_stations, sibling) {
535 		/*
536 		 * An ATA bay can be in a dock and itself can be ejected
537 		 * separately, so there are two 'dock stations' which need the
538 		 * ops
539 		 */
540 		dd = find_dock_dependent_device(dock_station, adev);
541 		if (dd && !dock_init_hotplug(dd, ops, context, init, release))
542 			ret = 0;
543 	}
544 
545 	return ret;
546 }
547 EXPORT_SYMBOL_GPL(register_hotplug_dock_device);
548 
549 /**
550  * unregister_hotplug_dock_device - remove yourself from the hotplug list
551  * @handle: the acpi handle of the device
552  */
553 void unregister_hotplug_dock_device(acpi_handle handle)
554 {
555 	struct dock_dependent_device *dd;
556 	struct dock_station *dock_station;
557 	struct acpi_device *adev;
558 
559 	if (!dock_station_count)
560 		return;
561 
562 	if (acpi_bus_get_device(handle, &adev))
563 		return;
564 
565 	list_for_each_entry(dock_station, &dock_stations, sibling) {
566 		dd = find_dock_dependent_device(dock_station, adev);
567 		if (dd)
568 			dock_release_hotplug(dd);
569 	}
570 }
571 EXPORT_SYMBOL_GPL(unregister_hotplug_dock_device);
572 
573 /**
574  * handle_eject_request - handle an undock request checking for error conditions
575  *
576  * Check to make sure the dock device is still present, then undock and
577  * hotremove all the devices that may need removing.
578  */
579 static int handle_eject_request(struct dock_station *ds, u32 event)
580 {
581 	if (dock_in_progress(ds))
582 		return -EBUSY;
583 
584 	/*
585 	 * here we need to generate the undock
586 	 * event prior to actually doing the undock
587 	 * so that the device struct still exists.
588 	 * Also, even send the dock event if the
589 	 * device is not present anymore
590 	 */
591 	dock_event(ds, event, UNDOCK_EVENT);
592 
593 	hot_remove_dock_devices(ds);
594 	undock(ds);
595 	acpi_evaluate_lck(ds->handle, 0);
596 	acpi_evaluate_ej0(ds->handle);
597 	if (dock_present(ds)) {
598 		acpi_handle_err(ds->handle, "Unable to undock!\n");
599 		return -EBUSY;
600 	}
601 	complete_undock(ds);
602 	return 0;
603 }
604 
605 /**
606  * dock_notify - Handle ACPI dock notification.
607  * @adev: Dock station's ACPI device object.
608  * @event: Event code.
609  *
610  * If we are notified to dock, then check to see if the dock is
611  * present and then dock.  Notify all drivers of the dock event,
612  * and then hotplug and devices that may need hotplugging.
613  */
614 int dock_notify(struct acpi_device *adev, u32 event)
615 {
616 	acpi_handle handle = adev->handle;
617 	struct dock_station *ds = find_dock_station(handle);
618 	int surprise_removal = 0;
619 
620 	if (!ds)
621 		return -ENODEV;
622 
623 	/*
624 	 * According to acpi spec 3.0a, if a DEVICE_CHECK notification
625 	 * is sent and _DCK is present, it is assumed to mean an undock
626 	 * request.
627 	 */
628 	if ((ds->flags & DOCK_IS_DOCK) && event == ACPI_NOTIFY_DEVICE_CHECK)
629 		event = ACPI_NOTIFY_EJECT_REQUEST;
630 
631 	/*
632 	 * dock station: BUS_CHECK - docked or surprise removal
633 	 *		 DEVICE_CHECK - undocked
634 	 * other device: BUS_CHECK/DEVICE_CHECK - added or surprise removal
635 	 *
636 	 * To simplify event handling, dock dependent device handler always
637 	 * get ACPI_NOTIFY_BUS_CHECK/ACPI_NOTIFY_DEVICE_CHECK for add and
638 	 * ACPI_NOTIFY_EJECT_REQUEST for removal
639 	 */
640 	switch (event) {
641 	case ACPI_NOTIFY_BUS_CHECK:
642 	case ACPI_NOTIFY_DEVICE_CHECK:
643 		if (!dock_in_progress(ds) && !acpi_device_enumerated(adev)) {
644 			begin_dock(ds);
645 			dock(ds);
646 			if (!dock_present(ds)) {
647 				acpi_handle_err(handle, "Unable to dock!\n");
648 				complete_dock(ds);
649 				break;
650 			}
651 			hotplug_dock_devices(ds, event);
652 			complete_dock(ds);
653 			dock_event(ds, event, DOCK_EVENT);
654 			acpi_evaluate_lck(ds->handle, 1);
655 			acpi_update_all_gpes();
656 			break;
657 		}
658 		if (dock_present(ds) || dock_in_progress(ds))
659 			break;
660 		/* This is a surprise removal */
661 		surprise_removal = 1;
662 		event = ACPI_NOTIFY_EJECT_REQUEST;
663 		/* Fall back */
664 	case ACPI_NOTIFY_EJECT_REQUEST:
665 		begin_undock(ds);
666 		if ((immediate_undock && !(ds->flags & DOCK_IS_ATA))
667 		   || surprise_removal)
668 			handle_eject_request(ds, event);
669 		else
670 			dock_event(ds, event, UNDOCK_EVENT);
671 		break;
672 	}
673 	return 0;
674 }
675 
676 /*
677  * show_docked - read method for "docked" file in sysfs
678  */
679 static ssize_t show_docked(struct device *dev,
680 			   struct device_attribute *attr, char *buf)
681 {
682 	struct dock_station *dock_station = dev->platform_data;
683 	struct acpi_device *adev = NULL;
684 
685 	acpi_bus_get_device(dock_station->handle, &adev);
686 	return snprintf(buf, PAGE_SIZE, "%u\n", acpi_device_enumerated(adev));
687 }
688 static DEVICE_ATTR(docked, S_IRUGO, show_docked, NULL);
689 
690 /*
691  * show_flags - read method for flags file in sysfs
692  */
693 static ssize_t show_flags(struct device *dev,
694 			  struct device_attribute *attr, char *buf)
695 {
696 	struct dock_station *dock_station = dev->platform_data;
697 	return snprintf(buf, PAGE_SIZE, "%d\n", dock_station->flags);
698 
699 }
700 static DEVICE_ATTR(flags, S_IRUGO, show_flags, NULL);
701 
702 /*
703  * write_undock - write method for "undock" file in sysfs
704  */
705 static ssize_t write_undock(struct device *dev, struct device_attribute *attr,
706 			   const char *buf, size_t count)
707 {
708 	int ret;
709 	struct dock_station *dock_station = dev->platform_data;
710 
711 	if (!count)
712 		return -EINVAL;
713 
714 	acpi_scan_lock_acquire();
715 	begin_undock(dock_station);
716 	ret = handle_eject_request(dock_station, ACPI_NOTIFY_EJECT_REQUEST);
717 	acpi_scan_lock_release();
718 	return ret ? ret: count;
719 }
720 static DEVICE_ATTR(undock, S_IWUSR, NULL, write_undock);
721 
722 /*
723  * show_dock_uid - read method for "uid" file in sysfs
724  */
725 static ssize_t show_dock_uid(struct device *dev,
726 			     struct device_attribute *attr, char *buf)
727 {
728 	unsigned long long lbuf;
729 	struct dock_station *dock_station = dev->platform_data;
730 	acpi_status status = acpi_evaluate_integer(dock_station->handle,
731 					"_UID", NULL, &lbuf);
732 	if (ACPI_FAILURE(status))
733 	    return 0;
734 
735 	return snprintf(buf, PAGE_SIZE, "%llx\n", lbuf);
736 }
737 static DEVICE_ATTR(uid, S_IRUGO, show_dock_uid, NULL);
738 
739 static ssize_t show_dock_type(struct device *dev,
740 		struct device_attribute *attr, char *buf)
741 {
742 	struct dock_station *dock_station = dev->platform_data;
743 	char *type;
744 
745 	if (dock_station->flags & DOCK_IS_DOCK)
746 		type = "dock_station";
747 	else if (dock_station->flags & DOCK_IS_ATA)
748 		type = "ata_bay";
749 	else if (dock_station->flags & DOCK_IS_BAT)
750 		type = "battery_bay";
751 	else
752 		type = "unknown";
753 
754 	return snprintf(buf, PAGE_SIZE, "%s\n", type);
755 }
756 static DEVICE_ATTR(type, S_IRUGO, show_dock_type, NULL);
757 
758 static struct attribute *dock_attributes[] = {
759 	&dev_attr_docked.attr,
760 	&dev_attr_flags.attr,
761 	&dev_attr_undock.attr,
762 	&dev_attr_uid.attr,
763 	&dev_attr_type.attr,
764 	NULL
765 };
766 
767 static struct attribute_group dock_attribute_group = {
768 	.attrs = dock_attributes
769 };
770 
771 /**
772  * acpi_dock_add - Add a new dock station
773  * @adev: Dock station ACPI device object.
774  *
775  * allocated and initialize a new dock station device.
776  */
777 void acpi_dock_add(struct acpi_device *adev)
778 {
779 	struct dock_station *dock_station, ds = { NULL, };
780 	struct platform_device_info pdevinfo;
781 	acpi_handle handle = adev->handle;
782 	struct platform_device *dd;
783 	int ret;
784 
785 	memset(&pdevinfo, 0, sizeof(pdevinfo));
786 	pdevinfo.name = "dock";
787 	pdevinfo.id = dock_station_count;
788 	pdevinfo.acpi_node.companion = adev;
789 	pdevinfo.data = &ds;
790 	pdevinfo.size_data = sizeof(ds);
791 	dd = platform_device_register_full(&pdevinfo);
792 	if (IS_ERR(dd))
793 		return;
794 
795 	dock_station = dd->dev.platform_data;
796 
797 	dock_station->handle = handle;
798 	dock_station->dock_device = dd;
799 	dock_station->last_dock_time = jiffies - HZ;
800 
801 	INIT_LIST_HEAD(&dock_station->sibling);
802 	INIT_LIST_HEAD(&dock_station->dependent_devices);
803 
804 	/* we want the dock device to send uevents */
805 	dev_set_uevent_suppress(&dd->dev, 0);
806 
807 	if (acpi_dock_match(handle))
808 		dock_station->flags |= DOCK_IS_DOCK;
809 	if (acpi_ata_match(handle))
810 		dock_station->flags |= DOCK_IS_ATA;
811 	if (acpi_device_is_battery(adev))
812 		dock_station->flags |= DOCK_IS_BAT;
813 
814 	ret = sysfs_create_group(&dd->dev.kobj, &dock_attribute_group);
815 	if (ret)
816 		goto err_unregister;
817 
818 	/* add the dock station as a device dependent on itself */
819 	ret = add_dock_dependent_device(dock_station, adev);
820 	if (ret)
821 		goto err_rmgroup;
822 
823 	dock_station_count++;
824 	list_add(&dock_station->sibling, &dock_stations);
825 	adev->flags.is_dock_station = true;
826 	dev_info(&adev->dev, "ACPI dock station (docks/bays count: %d)\n",
827 		 dock_station_count);
828 	return;
829 
830 err_rmgroup:
831 	remove_dock_dependent_devices(dock_station);
832 	sysfs_remove_group(&dd->dev.kobj, &dock_attribute_group);
833 err_unregister:
834 	platform_device_unregister(dd);
835 	acpi_handle_err(handle, "%s encountered error %d\n", __func__, ret);
836 }
837