blob: edeb72b619fbbe5c365c50a800e3f7404976f88e [file] [log] [blame]
Len Brownc8f7a622006-07-09 17:22:28 -04001/*
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>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090027#include <linux/slab.h>
Len Brownc8f7a622006-07-09 17:22:28 -040028#include <linux/init.h>
29#include <linux/types.h>
30#include <linux/notifier.h>
Kristen Carlson Accardi671adbe2006-12-04 14:49:43 -080031#include <linux/platform_device.h>
Al Viro914e2632006-10-18 13:55:46 -040032#include <linux/jiffies.h>
Randy Dunlap62a6d7f2007-03-26 21:38:49 -080033#include <linux/stddef.h>
Toshi Kanicd730182012-11-20 23:42:30 +000034#include <linux/acpi.h>
Len Brownc8f7a622006-07-09 17:22:28 -040035
Rashika3f9eed52013-12-17 15:00:04 +053036#include "internal.h"
37
Len Browna192a952009-07-28 16:45:54 -040038#define PREFIX "ACPI: "
39
Len Brown7cda93e2007-02-12 23:50:02 -050040#define ACPI_DOCK_DRIVER_DESCRIPTION "ACPI Dock Station Driver"
Len Brownc8f7a622006-07-09 17:22:28 -040041
Len Brownf52fd662007-02-12 22:42:12 -050042ACPI_MODULE_NAME("dock");
Len Brownc8f7a622006-07-09 17:22:28 -040043MODULE_AUTHOR("Kristen Carlson Accardi");
Len Brown7cda93e2007-02-12 23:50:02 -050044MODULE_DESCRIPTION(ACPI_DOCK_DRIVER_DESCRIPTION);
Len Brownc8f7a622006-07-09 17:22:28 -040045MODULE_LICENSE("GPL");
46
Rusty Russell90ab5ee2012-01-13 09:32:20 +103047static bool immediate_undock = 1;
Kristen Carlson Accardia0cd35f2007-05-09 15:08:15 -070048module_param(immediate_undock, bool, 0644);
49MODULE_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
Frank Seidela340af12007-12-07 13:20:42 +010054static const struct acpi_device_id dock_device_ids[] = {
55 {"LNXDOCK", 0},
56 {"", 0},
57};
58MODULE_DEVICE_TABLE(acpi, dock_device_ids);
59
Len Brownc8f7a622006-07-09 17:22:28 -040060struct dock_station {
61 acpi_handle handle;
62 unsigned long last_dock_time;
63 u32 flags;
Len Brownc8f7a622006-07-09 17:22:28 -040064 struct list_head dependent_devices;
Shaohua Lidb350b02008-08-28 10:03:58 +080065
Alex Chiang50d716e2009-10-01 11:59:23 -060066 struct list_head sibling;
Shaohua Lidb350b02008-08-28 10:03:58 +080067 struct platform_device *dock_device;
Len Brownc8f7a622006-07-09 17:22:28 -040068};
Shaohua Lidb350b02008-08-28 10:03:58 +080069static LIST_HEAD(dock_stations);
70static int dock_station_count;
Rafael J. Wysocki21a31012013-06-24 11:22:53 +020071static DEFINE_MUTEX(hotplug_lock);
Len Brownc8f7a622006-07-09 17:22:28 -040072
73struct dock_dependent_device {
74 struct list_head list;
Len Brownc8f7a622006-07-09 17:22:28 -040075 acpi_handle handle;
Rafael J. Wysocki21a31012013-06-24 11:22:53 +020076 const struct acpi_dock_ops *hp_ops;
77 void *hp_context;
78 unsigned int hp_refcount;
79 void (*hp_release)(void *);
Len Brownc8f7a622006-07-09 17:22:28 -040080};
81
82#define DOCK_DOCKING 0x00000001
Kristen Carlson Accardia0cd35f2007-05-09 15:08:15 -070083#define DOCK_UNDOCKING 0x00000002
Shaohua Lidb350b02008-08-28 10:03:58 +080084#define DOCK_IS_DOCK 0x00000010
85#define DOCK_IS_ATA 0x00000020
86#define DOCK_IS_BAT 0x00000040
Kristen Carlson Accardi56690212006-08-01 14:59:19 -070087#define DOCK_EVENT 3
88#define UNDOCK_EVENT 2
Len Brownc8f7a622006-07-09 17:22:28 -040089
Rafael J. Wysockif09ce742013-07-05 03:03:25 +020090enum dock_callback_type {
91 DOCK_CALL_HANDLER,
92 DOCK_CALL_FIXUP,
93 DOCK_CALL_UEVENT,
94};
95
Len Brownc8f7a622006-07-09 17:22:28 -040096/*****************************************************************************
97 * Dock Dependent device functions *
98 *****************************************************************************/
99/**
Alex Chiangf69cfdd2009-10-19 15:14:29 -0600100 * add_dock_dependent_device - associate a device with the dock station
101 * @ds: The dock station
102 * @handle: handle of the dependent device
Len Brownc8f7a622006-07-09 17:22:28 -0400103 *
Alex Chiangf69cfdd2009-10-19 15:14:29 -0600104 * Add the dependent device to the dock's dependent device list.
Len Brownc8f7a622006-07-09 17:22:28 -0400105 */
Rafael J. Wysocki1e2380c2014-02-16 01:51:01 +0100106static int add_dock_dependent_device(struct dock_station *ds, acpi_handle handle)
Len Brownc8f7a622006-07-09 17:22:28 -0400107{
108 struct dock_dependent_device *dd;
109
110 dd = kzalloc(sizeof(*dd), GFP_KERNEL);
Alex Chiangf69cfdd2009-10-19 15:14:29 -0600111 if (!dd)
112 return -ENOMEM;
Len Brownc8f7a622006-07-09 17:22:28 -0400113
Alex Chiangf69cfdd2009-10-19 15:14:29 -0600114 dd->handle = handle;
115 INIT_LIST_HEAD(&dd->list);
Len Brownc8f7a622006-07-09 17:22:28 -0400116 list_add_tail(&dd->list, &ds->dependent_devices);
Alex Chiangf69cfdd2009-10-19 15:14:29 -0600117
118 return 0;
Len Brownc8f7a622006-07-09 17:22:28 -0400119}
120
Rafael J. Wysockia30c4c52013-06-30 23:50:24 +0200121static void remove_dock_dependent_devices(struct dock_station *ds)
122{
123 struct dock_dependent_device *dd, *aux;
124
125 list_for_each_entry_safe(dd, aux, &ds->dependent_devices, list) {
126 list_del(&dd->list);
127 kfree(dd);
128 }
129}
130
Len Brownc8f7a622006-07-09 17:22:28 -0400131/**
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200132 * dock_init_hotplug - Initialize a hotplug device on a docking station.
133 * @dd: Dock-dependent device.
134 * @ops: Dock operations to attach to the dependent device.
135 * @context: Data to pass to the @ops callbacks and @release.
136 * @init: Optional initialization routine to run after setting up context.
137 * @release: Optional release routine to run on removal.
Len Brownc8f7a622006-07-09 17:22:28 -0400138 */
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200139static int dock_init_hotplug(struct dock_dependent_device *dd,
140 const struct acpi_dock_ops *ops, void *context,
141 void (*init)(void *), void (*release)(void *))
Len Brownc8f7a622006-07-09 17:22:28 -0400142{
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200143 int ret = 0;
144
145 mutex_lock(&hotplug_lock);
Rafael J. Wysocki4ec24062013-06-30 23:47:14 +0200146 if (WARN_ON(dd->hp_context)) {
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200147 ret = -EEXIST;
148 } else {
149 dd->hp_refcount = 1;
150 dd->hp_ops = ops;
151 dd->hp_context = context;
152 dd->hp_release = release;
Rafael J. Wysocki4ec24062013-06-30 23:47:14 +0200153 if (init)
154 init(context);
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200155 }
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200156 mutex_unlock(&hotplug_lock);
157 return ret;
Len Brownc8f7a622006-07-09 17:22:28 -0400158}
159
160/**
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200161 * dock_release_hotplug - Decrement hotplug reference counter of dock device.
162 * @dd: Dock-dependent device.
Len Brownc8f7a622006-07-09 17:22:28 -0400163 *
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200164 * Decrement the reference counter of @dd and if 0, detach its hotplug
165 * operations from it, reset its context pointer and run the optional release
166 * routine if present.
Len Brownc8f7a622006-07-09 17:22:28 -0400167 */
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200168static void dock_release_hotplug(struct dock_dependent_device *dd)
Len Brownc8f7a622006-07-09 17:22:28 -0400169{
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200170 mutex_lock(&hotplug_lock);
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200171 if (dd->hp_context && !--dd->hp_refcount) {
Rafael J. Wysocki4ec24062013-06-30 23:47:14 +0200172 void (*release)(void *) = dd->hp_release;
173 void *context = dd->hp_context;
174
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200175 dd->hp_ops = NULL;
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200176 dd->hp_context = NULL;
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200177 dd->hp_release = NULL;
Rafael J. Wysocki4ec24062013-06-30 23:47:14 +0200178 if (release)
179 release(context);
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200180 }
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200181 mutex_unlock(&hotplug_lock);
182}
183
184static void dock_hotplug_event(struct dock_dependent_device *dd, u32 event,
Rafael J. Wysockif09ce742013-07-05 03:03:25 +0200185 enum dock_callback_type cb_type)
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200186{
187 acpi_notify_handler cb = NULL;
188 bool run = false;
189
190 mutex_lock(&hotplug_lock);
191
192 if (dd->hp_context) {
193 run = true;
194 dd->hp_refcount++;
Rafael J. Wysockif09ce742013-07-05 03:03:25 +0200195 if (dd->hp_ops) {
196 switch (cb_type) {
197 case DOCK_CALL_FIXUP:
198 cb = dd->hp_ops->fixup;
199 break;
200 case DOCK_CALL_UEVENT:
201 cb = dd->hp_ops->uevent;
202 break;
203 default:
204 cb = dd->hp_ops->handler;
205 }
206 }
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200207 }
208
209 mutex_unlock(&hotplug_lock);
210
211 if (!run)
212 return;
213
214 if (cb)
215 cb(dd->handle, event, dd->hp_context);
216
217 dock_release_hotplug(dd);
Len Brownc8f7a622006-07-09 17:22:28 -0400218}
219
Rafael J. Wysocki1e2380c2014-02-16 01:51:01 +0100220static struct dock_station *find_dock_station(acpi_handle handle)
221{
222 struct dock_station *ds;
223
224 list_for_each_entry(ds, &dock_stations, sibling)
225 if (ds->handle == handle)
226 return ds;
227
228 return NULL;
229}
230
Len Brownc8f7a622006-07-09 17:22:28 -0400231/**
232 * find_dock_dependent_device - get a device dependent on this dock
233 * @ds: the dock station
234 * @handle: the acpi_handle of the device we want
235 *
236 * iterate over the dependent device list for this dock. If the
237 * dependent device matches the handle, return.
238 */
239static struct dock_dependent_device *
240find_dock_dependent_device(struct dock_station *ds, acpi_handle handle)
241{
242 struct dock_dependent_device *dd;
243
Jiang Liued633e72013-06-29 00:24:35 +0800244 list_for_each_entry(dd, &ds->dependent_devices, list)
245 if (handle == dd->handle)
Len Brownc8f7a622006-07-09 17:22:28 -0400246 return dd;
Jiang Liued633e72013-06-29 00:24:35 +0800247
Len Brownc8f7a622006-07-09 17:22:28 -0400248 return NULL;
249}
250
Rafael J. Wysocki1e2380c2014-02-16 01:51:01 +0100251void register_dock_dependent_device(struct acpi_device *adev,
252 acpi_handle dshandle)
253{
254 struct dock_station *ds = find_dock_station(dshandle);
255 acpi_handle handle = adev->handle;
256
257 if (ds && !find_dock_dependent_device(ds, handle))
258 add_dock_dependent_device(ds, handle);
259}
260
Len Brownc8f7a622006-07-09 17:22:28 -0400261/*****************************************************************************
262 * Dock functions *
263 *****************************************************************************/
Shaohua Lidb350b02008-08-28 10:03:58 +0800264
Len Brownc8f7a622006-07-09 17:22:28 -0400265/**
266 * is_dock_device - see if a device is on a dock station
267 * @handle: acpi handle of the device
268 *
269 * If this device is either the dock station itself,
270 * or is a device dependent on the dock station, then it
271 * is a dock device
272 */
273int is_dock_device(acpi_handle handle)
274{
Shaohua Lidb350b02008-08-28 10:03:58 +0800275 struct dock_station *dock_station;
276
277 if (!dock_station_count)
Len Brownc8f7a622006-07-09 17:22:28 -0400278 return 0;
279
Jiang Liuc9b54712013-06-29 00:24:42 +0800280 if (acpi_dock_match(handle))
Len Brownc8f7a622006-07-09 17:22:28 -0400281 return 1;
Alex Chiang747479a2009-10-19 15:14:50 -0600282
283 list_for_each_entry(dock_station, &dock_stations, sibling)
Shaohua Lidb350b02008-08-28 10:03:58 +0800284 if (find_dock_dependent_device(dock_station, handle))
285 return 1;
Len Brownc8f7a622006-07-09 17:22:28 -0400286
287 return 0;
288}
Len Brownc8f7a622006-07-09 17:22:28 -0400289EXPORT_SYMBOL_GPL(is_dock_device);
290
291/**
292 * dock_present - see if the dock station is present.
293 * @ds: the dock station
294 *
295 * execute the _STA method. note that present does not
296 * imply that we are docked.
297 */
298static int dock_present(struct dock_station *ds)
299{
Matthew Wilcox27663c52008-10-10 02:22:59 -0400300 unsigned long long sta;
Len Brownc8f7a622006-07-09 17:22:28 -0400301 acpi_status status;
302
303 if (ds) {
304 status = acpi_evaluate_integer(ds->handle, "_STA", NULL, &sta);
305 if (ACPI_SUCCESS(status) && sta)
306 return 1;
307 }
308 return 0;
309}
310
Len Brownc8f7a622006-07-09 17:22:28 -0400311/**
312 * dock_create_acpi_device - add new devices to acpi
313 * @handle - handle of the device to add
314 *
315 * This function will create a new acpi_device for the given
316 * handle if one does not exist already. This should cause
317 * acpi to scan for drivers for the given devices, and call
318 * matching driver's add routine.
Len Brownc8f7a622006-07-09 17:22:28 -0400319 */
Jiang Liu472d9632013-06-29 00:24:37 +0800320static void dock_create_acpi_device(acpi_handle handle)
Len Brownc8f7a622006-07-09 17:22:28 -0400321{
Rafael J. Wysocki202317a2013-11-22 21:54:37 +0100322 struct acpi_device *device = NULL;
Len Brownc8f7a622006-07-09 17:22:28 -0400323 int ret;
324
Rafael J. Wysocki202317a2013-11-22 21:54:37 +0100325 acpi_bus_get_device(handle, &device);
326 if (!acpi_device_enumerated(device)) {
Rafael J. Wysockib8bd7592013-01-19 01:27:35 +0100327 ret = acpi_bus_scan(handle);
Rafael J. Wysocki636458d2012-12-21 00:36:47 +0100328 if (ret)
Alex Chiang747479a2009-10-19 15:14:50 -0600329 pr_debug("error adding bus, %x\n", -ret);
Len Brownc8f7a622006-07-09 17:22:28 -0400330 }
Len Brownc8f7a622006-07-09 17:22:28 -0400331}
332
333/**
334 * dock_remove_acpi_device - remove the acpi_device struct from acpi
335 * @handle - the handle of the device to remove
336 *
337 * Tell acpi to remove the acpi_device. This should cause any loaded
338 * driver to have it's remove routine called.
339 */
340static void dock_remove_acpi_device(acpi_handle handle)
341{
342 struct acpi_device *device;
Len Brownc8f7a622006-07-09 17:22:28 -0400343
Rafael J. Wysockibfee26d2013-01-26 00:27:44 +0100344 if (!acpi_bus_get_device(handle, &device))
345 acpi_bus_trim(device);
Len Brownc8f7a622006-07-09 17:22:28 -0400346}
347
Len Brownc8f7a622006-07-09 17:22:28 -0400348/**
Rafael J. Wysocki37f90872013-06-30 23:46:42 +0200349 * hot_remove_dock_devices - Remove dock station devices.
350 * @ds: Dock station.
351 */
352static void hot_remove_dock_devices(struct dock_station *ds)
353{
354 struct dock_dependent_device *dd;
355
356 /*
357 * Walk the list in reverse order so that devices that have been added
358 * last are removed first (in case there are some indirect dependencies
359 * between them).
360 */
361 list_for_each_entry_reverse(dd, &ds->dependent_devices, list)
362 dock_hotplug_event(dd, ACPI_NOTIFY_EJECT_REQUEST, false);
363
364 list_for_each_entry_reverse(dd, &ds->dependent_devices, list)
365 dock_remove_acpi_device(dd->handle);
366}
367
368/**
369 * hotplug_dock_devices - Insert devices on a dock station.
Len Brownc8f7a622006-07-09 17:22:28 -0400370 * @ds: the dock station
Rafael J. Wysocki37f90872013-06-30 23:46:42 +0200371 * @event: either bus check or device check request
Len Brownc8f7a622006-07-09 17:22:28 -0400372 *
373 * Some devices on the dock station need to have drivers called
374 * to perform hotplug operations after a dock event has occurred.
375 * Traverse the list of dock devices that have registered a
376 * hotplug handler, and call the handler.
377 */
378static void hotplug_dock_devices(struct dock_station *ds, u32 event)
379{
380 struct dock_dependent_device *dd;
381
Rafael J. Wysockif09ce742013-07-05 03:03:25 +0200382 /* Call driver specific post-dock fixups. */
383 list_for_each_entry(dd, &ds->dependent_devices, list)
384 dock_hotplug_event(dd, event, DOCK_CALL_FIXUP);
385
Rafael J. Wysocki37f90872013-06-30 23:46:42 +0200386 /* Call driver specific hotplug functions. */
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200387 list_for_each_entry(dd, &ds->dependent_devices, list)
Rafael J. Wysockif09ce742013-07-05 03:03:25 +0200388 dock_hotplug_event(dd, event, DOCK_CALL_HANDLER);
Len Brownc8f7a622006-07-09 17:22:28 -0400389
390 /*
Rafael J. Wysocki37f90872013-06-30 23:46:42 +0200391 * Now make sure that an acpi_device is created for each dependent
392 * device. That will cause scan handlers to be attached to device
393 * objects or acpi_drivers to be stopped/started if they are present.
Len Brownc8f7a622006-07-09 17:22:28 -0400394 */
Rafael J. Wysocki37f90872013-06-30 23:46:42 +0200395 list_for_each_entry(dd, &ds->dependent_devices, list)
396 dock_create_acpi_device(dd->handle);
Len Brownc8f7a622006-07-09 17:22:28 -0400397}
398
399static void dock_event(struct dock_station *ds, u32 event, int num)
400{
Shaohua Lidb350b02008-08-28 10:03:58 +0800401 struct device *dev = &ds->dock_device->dev;
Holger Macht66b56822007-08-10 13:10:32 -0700402 char event_string[13];
Kristen Carlson Accardi79a8f702007-05-09 15:10:22 -0700403 char *envp[] = { event_string, NULL };
Shaohua Li1253f7a2008-08-28 10:06:16 +0800404 struct dock_dependent_device *dd;
Kristen Carlson Accardi79a8f702007-05-09 15:10:22 -0700405
406 if (num == UNDOCK_EVENT)
Holger Macht66b56822007-08-10 13:10:32 -0700407 sprintf(event_string, "EVENT=undock");
Kristen Carlson Accardi79a8f702007-05-09 15:10:22 -0700408 else
Holger Macht66b56822007-08-10 13:10:32 -0700409 sprintf(event_string, "EVENT=dock");
Kristen Carlson Accardi79a8f702007-05-09 15:10:22 -0700410
Kristen Carlson Accardi56690212006-08-01 14:59:19 -0700411 /*
Kristen Carlson Accardi8ea86e02006-12-11 12:05:08 -0800412 * Indicate that the status of the dock station has
413 * changed.
Kristen Carlson Accardi56690212006-08-01 14:59:19 -0700414 */
Shaohua Li1253f7a2008-08-28 10:06:16 +0800415 if (num == DOCK_EVENT)
416 kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp);
417
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200418 list_for_each_entry(dd, &ds->dependent_devices, list)
Rafael J. Wysockif09ce742013-07-05 03:03:25 +0200419 dock_hotplug_event(dd, event, DOCK_CALL_UEVENT);
Alex Chiang747479a2009-10-19 15:14:50 -0600420
Shaohua Li1253f7a2008-08-28 10:06:16 +0800421 if (num != DOCK_EVENT)
422 kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp);
Len Brownc8f7a622006-07-09 17:22:28 -0400423}
424
425/**
Len Brownc8f7a622006-07-09 17:22:28 -0400426 * 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 */
432static 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;
Zhang Rui6a868e12013-09-03 08:32:10 +0800437 unsigned long long value;
Len Brownc8f7a622006-07-09 17:22:28 -0400438
Toshi Kanicd730182012-11-20 23:42:30 +0000439 acpi_handle_info(ds->handle, "%s\n", dock ? "docking" : "undocking");
Len Brownc8f7a622006-07-09 17:22:28 -0400440
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;
Zhang Rui6a868e12013-09-03 08:32:10 +0800446 status = acpi_evaluate_integer(ds->handle, "_DCK", &arg_list, &value);
Shaohua Lidb350b02008-08-28 10:03:58 +0800447 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND)
Toshi Kanicd730182012-11-20 23:42:30 +0000448 acpi_handle_err(ds->handle, "Failed to execute _DCK (0x%x)\n",
449 status);
Len Brownc8f7a622006-07-09 17:22:28 -0400450}
451
452static inline void dock(struct dock_station *ds)
453{
454 handle_dock(ds, 1);
455}
456
457static inline void undock(struct dock_station *ds)
458{
459 handle_dock(ds, 0);
460}
461
462static inline void begin_dock(struct dock_station *ds)
463{
464 ds->flags |= DOCK_DOCKING;
465}
466
467static inline void complete_dock(struct dock_station *ds)
468{
469 ds->flags &= ~(DOCK_DOCKING);
470 ds->last_dock_time = jiffies;
471}
472
Kristen Carlson Accardia0cd35f2007-05-09 15:08:15 -0700473static inline void begin_undock(struct dock_station *ds)
474{
475 ds->flags |= DOCK_UNDOCKING;
476}
477
478static inline void complete_undock(struct dock_station *ds)
479{
480 ds->flags &= ~(DOCK_UNDOCKING);
481}
482
Len Brownc8f7a622006-07-09 17:22:28 -0400483/**
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 */
491static 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/**
Len Brownc8f7a622006-07-09 17:22:28 -0400500 * register_hotplug_dock_device - register a hotplug function
501 * @handle: the handle of the device
Shaohua Li1253f7a2008-08-28 10:06:16 +0800502 * @ops: handlers to call after docking
Len Brownc8f7a622006-07-09 17:22:28 -0400503 * @context: device specific data
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200504 * @init: Optional initialization routine to run after registration
505 * @release: Optional release routine to run on unregistration
Len Brownc8f7a622006-07-09 17:22:28 -0400506 *
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 */
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200511int register_hotplug_dock_device(acpi_handle handle,
512 const struct acpi_dock_ops *ops, void *context,
513 void (*init)(void *), void (*release)(void *))
Len Brownc8f7a622006-07-09 17:22:28 -0400514{
515 struct dock_dependent_device *dd;
Shaohua Lidb350b02008-08-28 10:03:58 +0800516 struct dock_station *dock_station;
Shaohua Li61b83692008-08-28 10:07:14 +0800517 int ret = -EINVAL;
Len Brownc8f7a622006-07-09 17:22:28 -0400518
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200519 if (WARN_ON(!context))
520 return -EINVAL;
521
Shaohua Lidb350b02008-08-28 10:03:58 +0800522 if (!dock_station_count)
Len Brownc8f7a622006-07-09 17:22:28 -0400523 return -ENODEV;
524
525 /*
526 * make sure this handle is for a device dependent on the dock,
527 * this would include the dock station itself
528 */
Alex Chiang50d716e2009-10-01 11:59:23 -0600529 list_for_each_entry(dock_station, &dock_stations, sibling) {
Shaohua Li61b83692008-08-28 10:07:14 +0800530 /*
531 * An ATA bay can be in a dock and itself can be ejected
Daniel Mack3ad2f3fb2010-02-03 08:01:28 +0800532 * separately, so there are two 'dock stations' which need the
Shaohua Li61b83692008-08-28 10:07:14 +0800533 * ops
534 */
Shaohua Lidb350b02008-08-28 10:03:58 +0800535 dd = find_dock_dependent_device(dock_station, handle);
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200536 if (dd && !dock_init_hotplug(dd, ops, context, init, release))
Shaohua Li61b83692008-08-28 10:07:14 +0800537 ret = 0;
Len Brownc8f7a622006-07-09 17:22:28 -0400538 }
539
Shaohua Li61b83692008-08-28 10:07:14 +0800540 return ret;
Len Brownc8f7a622006-07-09 17:22:28 -0400541}
Len Brownc8f7a622006-07-09 17:22:28 -0400542EXPORT_SYMBOL_GPL(register_hotplug_dock_device);
543
544/**
545 * unregister_hotplug_dock_device - remove yourself from the hotplug list
546 * @handle: the acpi handle of the device
547 */
548void unregister_hotplug_dock_device(acpi_handle handle)
549{
550 struct dock_dependent_device *dd;
Shaohua Lidb350b02008-08-28 10:03:58 +0800551 struct dock_station *dock_station;
Len Brownc8f7a622006-07-09 17:22:28 -0400552
Shaohua Lidb350b02008-08-28 10:03:58 +0800553 if (!dock_station_count)
Len Brownc8f7a622006-07-09 17:22:28 -0400554 return;
555
Alex Chiang50d716e2009-10-01 11:59:23 -0600556 list_for_each_entry(dock_station, &dock_stations, sibling) {
Shaohua Lidb350b02008-08-28 10:03:58 +0800557 dd = find_dock_dependent_device(dock_station, handle);
558 if (dd)
Rafael J. Wysocki21a31012013-06-24 11:22:53 +0200559 dock_release_hotplug(dd);
Shaohua Lidb350b02008-08-28 10:03:58 +0800560 }
Len Brownc8f7a622006-07-09 17:22:28 -0400561}
Len Brownc8f7a622006-07-09 17:22:28 -0400562EXPORT_SYMBOL_GPL(unregister_hotplug_dock_device);
563
564/**
brandon@ifup.orgc80fdbe2006-12-04 14:49:58 -0800565 * handle_eject_request - handle an undock request checking for error conditions
566 *
567 * Check to make sure the dock device is still present, then undock and
568 * hotremove all the devices that may need removing.
569 */
570static int handle_eject_request(struct dock_station *ds, u32 event)
571{
brandon@ifup.orgc80fdbe2006-12-04 14:49:58 -0800572 if (dock_in_progress(ds))
573 return -EBUSY;
574
575 /*
576 * here we need to generate the undock
577 * event prior to actually doing the undock
578 * so that the device struct still exists.
Holger Machtafd73012008-08-06 17:56:01 +0200579 * Also, even send the dock event if the
580 * device is not present anymore
brandon@ifup.orgc80fdbe2006-12-04 14:49:58 -0800581 */
582 dock_event(ds, event, UNDOCK_EVENT);
Holger Machtafd73012008-08-06 17:56:01 +0200583
Rafael J. Wysocki37f90872013-06-30 23:46:42 +0200584 hot_remove_dock_devices(ds);
brandon@ifup.orgc80fdbe2006-12-04 14:49:58 -0800585 undock(ds);
Jiang Liuc9b54712013-06-29 00:24:42 +0800586 acpi_evaluate_lck(ds->handle, 0);
587 acpi_evaluate_ej0(ds->handle);
brandon@ifup.orgc80fdbe2006-12-04 14:49:58 -0800588 if (dock_present(ds)) {
Toshi Kanicd730182012-11-20 23:42:30 +0000589 acpi_handle_err(ds->handle, "Unable to undock!\n");
brandon@ifup.orgc80fdbe2006-12-04 14:49:58 -0800590 return -EBUSY;
591 }
Kristen Carlson Accardia0cd35f2007-05-09 15:08:15 -0700592 complete_undock(ds);
brandon@ifup.orgc80fdbe2006-12-04 14:49:58 -0800593 return 0;
594}
595
596/**
Rafael J. Wysocki1e2380c2014-02-16 01:51:01 +0100597 * dock_notify - Handle ACPI dock notification.
598 * @adev: Dock station's ACPI device object.
599 * @event: Event code.
Len Brownc8f7a622006-07-09 17:22:28 -0400600 *
601 * If we are notified to dock, then check to see if the dock is
602 * present and then dock. Notify all drivers of the dock event,
brandon@ifup.orgc80fdbe2006-12-04 14:49:58 -0800603 * and then hotplug and devices that may need hotplugging.
Len Brownc8f7a622006-07-09 17:22:28 -0400604 */
Rafael J. Wysocki1e2380c2014-02-16 01:51:01 +0100605int dock_notify(struct acpi_device *adev, u32 event)
Len Brownc8f7a622006-07-09 17:22:28 -0400606{
Rafael J. Wysocki1e2380c2014-02-16 01:51:01 +0100607 acpi_handle handle = adev->handle;
608 struct dock_station *ds = find_dock_station(handle);
Shaohua Lidb350b02008-08-28 10:03:58 +0800609 int surprise_removal = 0;
Len Brownc8f7a622006-07-09 17:22:28 -0400610
Rafael J. Wysocki1e2380c2014-02-16 01:51:01 +0100611 if (!ds)
612 return -ENODEV;
613
Shaohua Lidb350b02008-08-28 10:03:58 +0800614 /*
615 * According to acpi spec 3.0a, if a DEVICE_CHECK notification
616 * is sent and _DCK is present, it is assumed to mean an undock
617 * request.
618 */
619 if ((ds->flags & DOCK_IS_DOCK) && event == ACPI_NOTIFY_DEVICE_CHECK)
620 event = ACPI_NOTIFY_EJECT_REQUEST;
621
622 /*
623 * dock station: BUS_CHECK - docked or surprise removal
624 * DEVICE_CHECK - undocked
625 * other device: BUS_CHECK/DEVICE_CHECK - added or surprise removal
626 *
627 * To simplify event handling, dock dependent device handler always
628 * get ACPI_NOTIFY_BUS_CHECK/ACPI_NOTIFY_DEVICE_CHECK for add and
629 * ACPI_NOTIFY_EJECT_REQUEST for removal
630 */
Len Brownc8f7a622006-07-09 17:22:28 -0400631 switch (event) {
632 case ACPI_NOTIFY_BUS_CHECK:
Shaohua Lidb350b02008-08-28 10:03:58 +0800633 case ACPI_NOTIFY_DEVICE_CHECK:
Rafael J. Wysocki0a8e5c32014-02-10 13:44:20 +0100634 if (!dock_in_progress(ds) && !acpi_device_enumerated(adev)) {
Len Brownc8f7a622006-07-09 17:22:28 -0400635 begin_dock(ds);
636 dock(ds);
637 if (!dock_present(ds)) {
Toshi Kanicd730182012-11-20 23:42:30 +0000638 acpi_handle_err(handle, "Unable to dock!\n");
Shaohua Li8b595602008-08-28 10:02:03 +0800639 complete_dock(ds);
Len Brownc8f7a622006-07-09 17:22:28 -0400640 break;
641 }
Len Brownc8f7a622006-07-09 17:22:28 -0400642 hotplug_dock_devices(ds, event);
643 complete_dock(ds);
644 dock_event(ds, event, DOCK_EVENT);
Jiang Liuc9b54712013-06-29 00:24:42 +0800645 acpi_evaluate_lck(ds->handle, 1);
Lin Ming3a378982010-12-13 13:36:15 +0800646 acpi_update_all_gpes();
Shaohua Lidb350b02008-08-28 10:03:58 +0800647 break;
Len Brownc8f7a622006-07-09 17:22:28 -0400648 }
Shaohua Lidb350b02008-08-28 10:03:58 +0800649 if (dock_present(ds) || dock_in_progress(ds))
650 break;
651 /* This is a surprise removal */
652 surprise_removal = 1;
653 event = ACPI_NOTIFY_EJECT_REQUEST;
654 /* Fall back */
Len Brownc8f7a622006-07-09 17:22:28 -0400655 case ACPI_NOTIFY_EJECT_REQUEST:
Kristen Carlson Accardia0cd35f2007-05-09 15:08:15 -0700656 begin_undock(ds);
Shaohua Lif730ae12008-08-28 10:05:45 +0800657 if ((immediate_undock && !(ds->flags & DOCK_IS_ATA))
658 || surprise_removal)
Kristen Carlson Accardia0cd35f2007-05-09 15:08:15 -0700659 handle_eject_request(ds, event);
660 else
661 dock_event(ds, event, UNDOCK_EVENT);
Len Brownc8f7a622006-07-09 17:22:28 -0400662 break;
Len Brownc8f7a622006-07-09 17:22:28 -0400663 }
Rafael J. Wysocki1e2380c2014-02-16 01:51:01 +0100664 return 0;
Len Brownc8f7a622006-07-09 17:22:28 -0400665}
666
brandon@ifup.orgc80fdbe2006-12-04 14:49:58 -0800667/*
668 * show_docked - read method for "docked" file in sysfs
669 */
670static ssize_t show_docked(struct device *dev,
671 struct device_attribute *attr, char *buf)
672{
Alex Chiangfe06fba2009-10-19 15:14:45 -0600673 struct dock_station *dock_station = dev->platform_data;
Rafael J. Wysockiab62f9c2014-02-15 01:29:06 +0100674 struct acpi_device *adev = NULL;
brandon@ifup.orgc80fdbe2006-12-04 14:49:58 -0800675
Rafael J. Wysockiab62f9c2014-02-15 01:29:06 +0100676 acpi_bus_get_device(dock_station->handle, &adev);
677 return snprintf(buf, PAGE_SIZE, "%u\n", acpi_device_enumerated(adev));
brandon@ifup.orgc80fdbe2006-12-04 14:49:58 -0800678}
Adrian Bunke5685b92007-10-24 18:24:42 +0200679static DEVICE_ATTR(docked, S_IRUGO, show_docked, NULL);
brandon@ifup.orgc80fdbe2006-12-04 14:49:58 -0800680
681/*
Kristen Carlson Accardia0cd35f2007-05-09 15:08:15 -0700682 * show_flags - read method for flags file in sysfs
683 */
684static ssize_t show_flags(struct device *dev,
685 struct device_attribute *attr, char *buf)
686{
Alex Chiangfe06fba2009-10-19 15:14:45 -0600687 struct dock_station *dock_station = dev->platform_data;
Kristen Carlson Accardia0cd35f2007-05-09 15:08:15 -0700688 return snprintf(buf, PAGE_SIZE, "%d\n", dock_station->flags);
689
690}
Adrian Bunke5685b92007-10-24 18:24:42 +0200691static DEVICE_ATTR(flags, S_IRUGO, show_flags, NULL);
Kristen Carlson Accardia0cd35f2007-05-09 15:08:15 -0700692
693/*
brandon@ifup.orgc80fdbe2006-12-04 14:49:58 -0800694 * write_undock - write method for "undock" file in sysfs
695 */
696static ssize_t write_undock(struct device *dev, struct device_attribute *attr,
697 const char *buf, size_t count)
698{
699 int ret;
Alex Chiangfe06fba2009-10-19 15:14:45 -0600700 struct dock_station *dock_station = dev->platform_data;
brandon@ifup.orgc80fdbe2006-12-04 14:49:58 -0800701
702 if (!count)
703 return -EINVAL;
704
Rafael J. Wysocki81120062013-06-16 00:38:30 +0200705 acpi_scan_lock_acquire();
Holger Macht9171f8342008-03-12 01:07:27 +0100706 begin_undock(dock_station);
brandon@ifup.orgc80fdbe2006-12-04 14:49:58 -0800707 ret = handle_eject_request(dock_station, ACPI_NOTIFY_EJECT_REQUEST);
Rafael J. Wysocki81120062013-06-16 00:38:30 +0200708 acpi_scan_lock_release();
brandon@ifup.orgc80fdbe2006-12-04 14:49:58 -0800709 return ret ? ret: count;
710}
Adrian Bunke5685b92007-10-24 18:24:42 +0200711static DEVICE_ATTR(undock, S_IWUSR, NULL, write_undock);
brandon@ifup.orgc80fdbe2006-12-04 14:49:58 -0800712
Ilya A. Volynets-Evenbakhac122bb2007-02-19 15:19:31 -0800713/*
714 * show_dock_uid - read method for "uid" file in sysfs
715 */
716static ssize_t show_dock_uid(struct device *dev,
717 struct device_attribute *attr, char *buf)
718{
Matthew Wilcox27663c52008-10-10 02:22:59 -0400719 unsigned long long lbuf;
Alex Chiangfe06fba2009-10-19 15:14:45 -0600720 struct dock_station *dock_station = dev->platform_data;
Kristen Carlson Accardi38ff4ff2007-05-09 15:04:24 -0700721 acpi_status status = acpi_evaluate_integer(dock_station->handle,
722 "_UID", NULL, &lbuf);
723 if (ACPI_FAILURE(status))
Ilya A. Volynets-Evenbakhac122bb2007-02-19 15:19:31 -0800724 return 0;
Kristen Carlson Accardi38ff4ff2007-05-09 15:04:24 -0700725
Matthew Wilcox27663c52008-10-10 02:22:59 -0400726 return snprintf(buf, PAGE_SIZE, "%llx\n", lbuf);
Ilya A. Volynets-Evenbakhac122bb2007-02-19 15:19:31 -0800727}
Adrian Bunke5685b92007-10-24 18:24:42 +0200728static DEVICE_ATTR(uid, S_IRUGO, show_dock_uid, NULL);
Ilya A. Volynets-Evenbakhac122bb2007-02-19 15:19:31 -0800729
Shaohua Li8652b002008-08-28 10:07:45 +0800730static ssize_t show_dock_type(struct device *dev,
731 struct device_attribute *attr, char *buf)
732{
Alex Chiangfe06fba2009-10-19 15:14:45 -0600733 struct dock_station *dock_station = dev->platform_data;
Shaohua Li8652b002008-08-28 10:07:45 +0800734 char *type;
735
736 if (dock_station->flags & DOCK_IS_DOCK)
737 type = "dock_station";
738 else if (dock_station->flags & DOCK_IS_ATA)
739 type = "ata_bay";
740 else if (dock_station->flags & DOCK_IS_BAT)
741 type = "battery_bay";
742 else
743 type = "unknown";
744
745 return snprintf(buf, PAGE_SIZE, "%s\n", type);
746}
747static DEVICE_ATTR(type, S_IRUGO, show_dock_type, NULL);
748
Alex Chiang5f46c2f2009-10-19 15:14:24 -0600749static struct attribute *dock_attributes[] = {
750 &dev_attr_docked.attr,
751 &dev_attr_flags.attr,
752 &dev_attr_undock.attr,
753 &dev_attr_uid.attr,
754 &dev_attr_type.attr,
755 NULL
756};
757
758static struct attribute_group dock_attribute_group = {
759 .attrs = dock_attributes
760};
761
Len Brownc8f7a622006-07-09 17:22:28 -0400762/**
Rafael J. Wysocki1e2380c2014-02-16 01:51:01 +0100763 * acpi_dock_add - Add a new dock station
764 * @adev: Dock station ACPI device object.
Len Brownc8f7a622006-07-09 17:22:28 -0400765 *
Rafael J. Wysocki1e2380c2014-02-16 01:51:01 +0100766 * allocated and initialize a new dock station device.
Len Brownc8f7a622006-07-09 17:22:28 -0400767 */
Rafael J. Wysocki1e2380c2014-02-16 01:51:01 +0100768void acpi_dock_add(struct acpi_device *adev)
Len Brownc8f7a622006-07-09 17:22:28 -0400769{
Rafael J. Wysocki2efbca42013-07-05 03:23:36 +0200770 struct dock_station *dock_station, ds = { NULL, };
Rafael J. Wysocki1e2380c2014-02-16 01:51:01 +0100771 acpi_handle handle = adev->handle;
Alex Chiang747479a2009-10-19 15:14:50 -0600772 struct platform_device *dd;
Rafael J. Wysocki2efbca42013-07-05 03:23:36 +0200773 int ret;
Len Brownc8f7a622006-07-09 17:22:28 -0400774
Rafael J. Wysocki2efbca42013-07-05 03:23:36 +0200775 dd = platform_device_register_data(NULL, "dock", dock_station_count,
776 &ds, sizeof(ds));
Alex Chiang747479a2009-10-19 15:14:50 -0600777 if (IS_ERR(dd))
Rafael J. Wysocki1e2380c2014-02-16 01:51:01 +0100778 return;
Alex Chiang9751cb72009-10-19 15:14:40 -0600779
Alex Chiang747479a2009-10-19 15:14:50 -0600780 dock_station = dd->dev.platform_data;
781
Len Brownc8f7a622006-07-09 17:22:28 -0400782 dock_station->handle = handle;
Alex Chiang747479a2009-10-19 15:14:50 -0600783 dock_station->dock_device = dd;
Len Brownc8f7a622006-07-09 17:22:28 -0400784 dock_station->last_dock_time = jiffies - HZ;
Len Brownc8f7a622006-07-09 17:22:28 -0400785
Alex Chiang747479a2009-10-19 15:14:50 -0600786 INIT_LIST_HEAD(&dock_station->sibling);
Alex Chiang747479a2009-10-19 15:14:50 -0600787 INIT_LIST_HEAD(&dock_station->dependent_devices);
Kristen Carlson Accardia0cd35f2007-05-09 15:08:15 -0700788
Kristen Carlson Accardi9ef2a9a2007-05-09 15:09:12 -0700789 /* we want the dock device to send uevents */
Alex Chiang747479a2009-10-19 15:14:50 -0600790 dev_set_uevent_suppress(&dd->dev, 0);
Kristen Carlson Accardi9ef2a9a2007-05-09 15:09:12 -0700791
Jiang Liuc9b54712013-06-29 00:24:42 +0800792 if (acpi_dock_match(handle))
Shaohua Lidb350b02008-08-28 10:03:58 +0800793 dock_station->flags |= DOCK_IS_DOCK;
Jiang Liuc9b54712013-06-29 00:24:42 +0800794 if (acpi_ata_match(handle))
Shaohua Lidb350b02008-08-28 10:03:58 +0800795 dock_station->flags |= DOCK_IS_ATA;
Rafael J. Wysockib43109f2014-02-16 00:09:34 +0100796 if (acpi_device_is_battery(adev))
Shaohua Lidb350b02008-08-28 10:03:58 +0800797 dock_station->flags |= DOCK_IS_BAT;
798
Alex Chiang747479a2009-10-19 15:14:50 -0600799 ret = sysfs_create_group(&dd->dev.kobj, &dock_attribute_group);
Shaohua Li8652b002008-08-28 10:07:45 +0800800 if (ret)
Alex Chiang5f46c2f2009-10-19 15:14:24 -0600801 goto err_unregister;
Kristen Carlson Accardi671adbe2006-12-04 14:49:43 -0800802
Len Brownc8f7a622006-07-09 17:22:28 -0400803 /* add the dock station as a device dependent on itself */
Alex Chiangf69cfdd2009-10-19 15:14:29 -0600804 ret = add_dock_dependent_device(dock_station, handle);
805 if (ret)
Alex Chiang5f46c2f2009-10-19 15:14:24 -0600806 goto err_rmgroup;
Len Brownc8f7a622006-07-09 17:22:28 -0400807
Shaohua Lidb350b02008-08-28 10:03:58 +0800808 dock_station_count++;
Alex Chiang50d716e2009-10-01 11:59:23 -0600809 list_add(&dock_station->sibling, &dock_stations);
Rafael J. Wysocki1e2380c2014-02-16 01:51:01 +0100810 adev->flags.is_dock_station = true;
811 dev_info(&adev->dev, "ACPI dock station (docks/bays count: %d)\n",
812 dock_station_count);
813 return;
Len Brownc8f7a622006-07-09 17:22:28 -0400814
Alex Chiang5f46c2f2009-10-19 15:14:24 -0600815err_rmgroup:
Rafael J. Wysockia30c4c52013-06-30 23:50:24 +0200816 remove_dock_dependent_devices(dock_station);
Alex Chiang747479a2009-10-19 15:14:50 -0600817 sysfs_remove_group(&dd->dev.kobj, &dock_attribute_group);
Alex Chiang5f46c2f2009-10-19 15:14:24 -0600818err_unregister:
Alex Chiang747479a2009-10-19 15:14:50 -0600819 platform_device_unregister(dd);
Toshi Kanicd730182012-11-20 23:42:30 +0000820 acpi_handle_err(handle, "%s encountered error %d\n", __func__, ret);
Len Brownc8f7a622006-07-09 17:22:28 -0400821}