1c8f7a62cSLen Brown /* 2c8f7a62cSLen Brown * dock.c - ACPI dock station driver 3c8f7a62cSLen Brown * 4c8f7a62cSLen Brown * Copyright (C) 2006 Kristen Carlson Accardi <kristen.c.accardi@intel.com> 5c8f7a62cSLen Brown * 6c8f7a62cSLen Brown * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 7c8f7a62cSLen Brown * 8c8f7a62cSLen Brown * This program is free software; you can redistribute it and/or modify 9c8f7a62cSLen Brown * it under the terms of the GNU General Public License as published by 10c8f7a62cSLen Brown * the Free Software Foundation; either version 2 of the License, or (at 11c8f7a62cSLen Brown * your option) any later version. 12c8f7a62cSLen Brown * 13c8f7a62cSLen Brown * This program is distributed in the hope that it will be useful, but 14c8f7a62cSLen Brown * WITHOUT ANY WARRANTY; without even the implied warranty of 15c8f7a62cSLen Brown * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16c8f7a62cSLen Brown * General Public License for more details. 17c8f7a62cSLen Brown * 18c8f7a62cSLen Brown * You should have received a copy of the GNU General Public License along 19c8f7a62cSLen Brown * with this program; if not, write to the Free Software Foundation, Inc., 20c8f7a62cSLen Brown * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 21c8f7a62cSLen Brown * 22c8f7a62cSLen Brown * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 23c8f7a62cSLen Brown */ 24c8f7a62cSLen Brown 25c8f7a62cSLen Brown #include <linux/kernel.h> 26c8f7a62cSLen Brown #include <linux/module.h> 275a0e3ad6STejun Heo #include <linux/slab.h> 28c8f7a62cSLen Brown #include <linux/init.h> 29c8f7a62cSLen Brown #include <linux/types.h> 30c8f7a62cSLen Brown #include <linux/notifier.h> 31671adbecSKristen Carlson Accardi #include <linux/platform_device.h> 32914e2637SAl Viro #include <linux/jiffies.h> 3362a6d7fdSRandy Dunlap #include <linux/stddef.h> 34cd73018fSToshi Kani #include <linux/acpi.h> 35c8f7a62cSLen Brown #include <acpi/acpi_bus.h> 36c8f7a62cSLen Brown #include <acpi/acpi_drivers.h> 37c8f7a62cSLen Brown 38a192a958SLen Brown #define PREFIX "ACPI: " 39a192a958SLen Brown 407cda93e0SLen Brown #define ACPI_DOCK_DRIVER_DESCRIPTION "ACPI Dock Station Driver" 41c8f7a62cSLen Brown 42f52fd66dSLen Brown ACPI_MODULE_NAME("dock"); 43c8f7a62cSLen Brown MODULE_AUTHOR("Kristen Carlson Accardi"); 447cda93e0SLen Brown MODULE_DESCRIPTION(ACPI_DOCK_DRIVER_DESCRIPTION); 45c8f7a62cSLen Brown MODULE_LICENSE("GPL"); 46c8f7a62cSLen Brown 4790ab5ee9SRusty Russell static bool immediate_undock = 1; 48a0cd35fdSKristen Carlson Accardi module_param(immediate_undock, bool, 0644); 49a0cd35fdSKristen Carlson Accardi MODULE_PARM_DESC(immediate_undock, "1 (default) will cause the driver to " 50a0cd35fdSKristen Carlson Accardi "undock immediately when the undock button is pressed, 0 will cause" 51a0cd35fdSKristen Carlson Accardi " the driver to wait for userspace to write the undock sysfs file " 52a0cd35fdSKristen Carlson Accardi " before undocking"); 53a0cd35fdSKristen Carlson Accardi 54c8f7a62cSLen Brown static struct atomic_notifier_head dock_notifier_list; 55c8f7a62cSLen Brown 56a340af14SFrank Seidel static const struct acpi_device_id dock_device_ids[] = { 57a340af14SFrank Seidel {"LNXDOCK", 0}, 58a340af14SFrank Seidel {"", 0}, 59a340af14SFrank Seidel }; 60a340af14SFrank Seidel MODULE_DEVICE_TABLE(acpi, dock_device_ids); 61a340af14SFrank Seidel 62c8f7a62cSLen Brown struct dock_station { 63c8f7a62cSLen Brown acpi_handle handle; 64c8f7a62cSLen Brown unsigned long last_dock_time; 65c8f7a62cSLen Brown u32 flags; 668b0dc866SKristen Carlson Accardi struct mutex hp_lock; 67c8f7a62cSLen Brown struct list_head dependent_devices; 68db350b08SShaohua Li 6950d716e4SAlex Chiang struct list_head sibling; 70db350b08SShaohua Li struct platform_device *dock_device; 71c8f7a62cSLen Brown }; 72db350b08SShaohua Li static LIST_HEAD(dock_stations); 73db350b08SShaohua Li static int dock_station_count; 7421a31013SRafael J. Wysocki static DEFINE_MUTEX(hotplug_lock); 75c8f7a62cSLen Brown 76c8f7a62cSLen Brown struct dock_dependent_device { 77c8f7a62cSLen Brown struct list_head list; 78c8f7a62cSLen Brown acpi_handle handle; 7921a31013SRafael J. Wysocki const struct acpi_dock_ops *hp_ops; 8021a31013SRafael J. Wysocki void *hp_context; 8121a31013SRafael J. Wysocki unsigned int hp_refcount; 8221a31013SRafael J. Wysocki void (*hp_release)(void *); 83c8f7a62cSLen Brown }; 84c8f7a62cSLen Brown 85c8f7a62cSLen Brown #define DOCK_DOCKING 0x00000001 86a0cd35fdSKristen Carlson Accardi #define DOCK_UNDOCKING 0x00000002 87db350b08SShaohua Li #define DOCK_IS_DOCK 0x00000010 88db350b08SShaohua Li #define DOCK_IS_ATA 0x00000020 89db350b08SShaohua Li #define DOCK_IS_BAT 0x00000040 905669021eSKristen Carlson Accardi #define DOCK_EVENT 3 915669021eSKristen Carlson Accardi #define UNDOCK_EVENT 2 92c8f7a62cSLen Brown 93c8f7a62cSLen Brown /***************************************************************************** 94c8f7a62cSLen Brown * Dock Dependent device functions * 95c8f7a62cSLen Brown *****************************************************************************/ 96c8f7a62cSLen Brown /** 97f69cfdd2SAlex Chiang * add_dock_dependent_device - associate a device with the dock station 98f69cfdd2SAlex Chiang * @ds: The dock station 99f69cfdd2SAlex Chiang * @handle: handle of the dependent device 100c8f7a62cSLen Brown * 101f69cfdd2SAlex Chiang * Add the dependent device to the dock's dependent device list. 102c8f7a62cSLen Brown */ 103d423c083SJiang Liu static int __init 104f69cfdd2SAlex Chiang add_dock_dependent_device(struct dock_station *ds, acpi_handle handle) 105c8f7a62cSLen Brown { 106c8f7a62cSLen Brown struct dock_dependent_device *dd; 107c8f7a62cSLen Brown 108c8f7a62cSLen Brown dd = kzalloc(sizeof(*dd), GFP_KERNEL); 109f69cfdd2SAlex Chiang if (!dd) 110f69cfdd2SAlex Chiang return -ENOMEM; 111f69cfdd2SAlex Chiang 112c8f7a62cSLen Brown dd->handle = handle; 113c8f7a62cSLen Brown INIT_LIST_HEAD(&dd->list); 114c8f7a62cSLen Brown list_add_tail(&dd->list, &ds->dependent_devices); 115f69cfdd2SAlex Chiang 116f69cfdd2SAlex Chiang return 0; 117c8f7a62cSLen Brown } 118c8f7a62cSLen Brown 119c8f7a62cSLen Brown /** 12021a31013SRafael J. Wysocki * dock_init_hotplug - Initialize a hotplug device on a docking station. 12121a31013SRafael J. Wysocki * @dd: Dock-dependent device. 12221a31013SRafael J. Wysocki * @ops: Dock operations to attach to the dependent device. 12321a31013SRafael J. Wysocki * @context: Data to pass to the @ops callbacks and @release. 12421a31013SRafael J. Wysocki * @init: Optional initialization routine to run after setting up context. 12521a31013SRafael J. Wysocki * @release: Optional release routine to run on removal. 126c8f7a62cSLen Brown */ 12721a31013SRafael J. Wysocki static int dock_init_hotplug(struct dock_dependent_device *dd, 12821a31013SRafael J. Wysocki const struct acpi_dock_ops *ops, void *context, 12921a31013SRafael J. Wysocki void (*init)(void *), void (*release)(void *)) 130c8f7a62cSLen Brown { 13121a31013SRafael J. Wysocki int ret = 0; 13221a31013SRafael J. Wysocki 13321a31013SRafael J. Wysocki mutex_lock(&hotplug_lock); 13421a31013SRafael J. Wysocki 13521a31013SRafael J. Wysocki if (dd->hp_context) { 13621a31013SRafael J. Wysocki ret = -EEXIST; 13721a31013SRafael J. Wysocki } else { 13821a31013SRafael J. Wysocki dd->hp_refcount = 1; 13921a31013SRafael J. Wysocki dd->hp_ops = ops; 14021a31013SRafael J. Wysocki dd->hp_context = context; 14121a31013SRafael J. Wysocki dd->hp_release = release; 14221a31013SRafael J. Wysocki } 14321a31013SRafael J. Wysocki 14421a31013SRafael J. Wysocki if (!WARN_ON(ret) && init) 14521a31013SRafael J. Wysocki init(context); 14621a31013SRafael J. Wysocki 14721a31013SRafael J. Wysocki mutex_unlock(&hotplug_lock); 14821a31013SRafael J. Wysocki return ret; 149c8f7a62cSLen Brown } 150c8f7a62cSLen Brown 151c8f7a62cSLen Brown /** 15221a31013SRafael J. Wysocki * dock_release_hotplug - Decrement hotplug reference counter of dock device. 15321a31013SRafael J. Wysocki * @dd: Dock-dependent device. 154c8f7a62cSLen Brown * 15521a31013SRafael J. Wysocki * Decrement the reference counter of @dd and if 0, detach its hotplug 15621a31013SRafael J. Wysocki * operations from it, reset its context pointer and run the optional release 15721a31013SRafael J. Wysocki * routine if present. 158c8f7a62cSLen Brown */ 15921a31013SRafael J. Wysocki static void dock_release_hotplug(struct dock_dependent_device *dd) 160c8f7a62cSLen Brown { 16121a31013SRafael J. Wysocki void (*release)(void *) = NULL; 16221a31013SRafael J. Wysocki void *context = NULL; 16321a31013SRafael J. Wysocki 16421a31013SRafael J. Wysocki mutex_lock(&hotplug_lock); 16521a31013SRafael J. Wysocki 16621a31013SRafael J. Wysocki if (dd->hp_context && !--dd->hp_refcount) { 16721a31013SRafael J. Wysocki dd->hp_ops = NULL; 16821a31013SRafael J. Wysocki context = dd->hp_context; 16921a31013SRafael J. Wysocki dd->hp_context = NULL; 17021a31013SRafael J. Wysocki release = dd->hp_release; 17121a31013SRafael J. Wysocki dd->hp_release = NULL; 17221a31013SRafael J. Wysocki } 17321a31013SRafael J. Wysocki 17421a31013SRafael J. Wysocki if (release && context) 17521a31013SRafael J. Wysocki release(context); 17621a31013SRafael J. Wysocki 17721a31013SRafael J. Wysocki mutex_unlock(&hotplug_lock); 17821a31013SRafael J. Wysocki } 17921a31013SRafael J. Wysocki 18021a31013SRafael J. Wysocki static void dock_hotplug_event(struct dock_dependent_device *dd, u32 event, 18121a31013SRafael J. Wysocki bool uevent) 18221a31013SRafael J. Wysocki { 18321a31013SRafael J. Wysocki acpi_notify_handler cb = NULL; 18421a31013SRafael J. Wysocki bool run = false; 18521a31013SRafael J. Wysocki 18621a31013SRafael J. Wysocki mutex_lock(&hotplug_lock); 18721a31013SRafael J. Wysocki 18821a31013SRafael J. Wysocki if (dd->hp_context) { 18921a31013SRafael J. Wysocki run = true; 19021a31013SRafael J. Wysocki dd->hp_refcount++; 19121a31013SRafael J. Wysocki if (dd->hp_ops) 19221a31013SRafael J. Wysocki cb = uevent ? dd->hp_ops->uevent : dd->hp_ops->handler; 19321a31013SRafael J. Wysocki } 19421a31013SRafael J. Wysocki 19521a31013SRafael J. Wysocki mutex_unlock(&hotplug_lock); 19621a31013SRafael J. Wysocki 19721a31013SRafael J. Wysocki if (!run) 19821a31013SRafael J. Wysocki return; 19921a31013SRafael J. Wysocki 20021a31013SRafael J. Wysocki if (cb) 20121a31013SRafael J. Wysocki cb(dd->handle, event, dd->hp_context); 20221a31013SRafael J. Wysocki 20321a31013SRafael J. Wysocki dock_release_hotplug(dd); 204c8f7a62cSLen Brown } 205c8f7a62cSLen Brown 206c8f7a62cSLen Brown /** 207c8f7a62cSLen Brown * find_dock_dependent_device - get a device dependent on this dock 208c8f7a62cSLen Brown * @ds: the dock station 209c8f7a62cSLen Brown * @handle: the acpi_handle of the device we want 210c8f7a62cSLen Brown * 211c8f7a62cSLen Brown * iterate over the dependent device list for this dock. If the 212c8f7a62cSLen Brown * dependent device matches the handle, return. 213c8f7a62cSLen Brown */ 214c8f7a62cSLen Brown static struct dock_dependent_device * 215c8f7a62cSLen Brown find_dock_dependent_device(struct dock_station *ds, acpi_handle handle) 216c8f7a62cSLen Brown { 217c8f7a62cSLen Brown struct dock_dependent_device *dd; 218c8f7a62cSLen Brown 219ed633e70SJiang Liu list_for_each_entry(dd, &ds->dependent_devices, list) 220ed633e70SJiang Liu if (handle == dd->handle) 221c8f7a62cSLen Brown return dd; 222ed633e70SJiang Liu 223c8f7a62cSLen Brown return NULL; 224c8f7a62cSLen Brown } 225c8f7a62cSLen Brown 226c8f7a62cSLen Brown /***************************************************************************** 227c8f7a62cSLen Brown * Dock functions * 228c8f7a62cSLen Brown *****************************************************************************/ 229c8f7a62cSLen Brown /** 230c8f7a62cSLen Brown * is_dock - see if a device is a dock station 231c8f7a62cSLen Brown * @handle: acpi handle of the device 232c8f7a62cSLen Brown * 233c8f7a62cSLen Brown * If an acpi object has a _DCK method, then it is by definition a dock 234c8f7a62cSLen Brown * station, so return true. 235c8f7a62cSLen Brown */ 236c8f7a62cSLen Brown static int is_dock(acpi_handle handle) 237c8f7a62cSLen Brown { 238c8f7a62cSLen Brown acpi_status status; 239c8f7a62cSLen Brown acpi_handle tmp; 240c8f7a62cSLen Brown 241c8f7a62cSLen Brown status = acpi_get_handle(handle, "_DCK", &tmp); 242c8f7a62cSLen Brown if (ACPI_FAILURE(status)) 243c8f7a62cSLen Brown return 0; 244c8f7a62cSLen Brown return 1; 245c8f7a62cSLen Brown } 246c8f7a62cSLen Brown 247d423c083SJiang Liu static int __init is_ejectable(acpi_handle handle) 248db350b08SShaohua Li { 249db350b08SShaohua Li acpi_status status; 250db350b08SShaohua Li acpi_handle tmp; 251db350b08SShaohua Li 252db350b08SShaohua Li status = acpi_get_handle(handle, "_EJ0", &tmp); 253db350b08SShaohua Li if (ACPI_FAILURE(status)) 254db350b08SShaohua Li return 0; 255db350b08SShaohua Li return 1; 256db350b08SShaohua Li } 257db350b08SShaohua Li 258d423c083SJiang Liu static int __init is_ata(acpi_handle handle) 259db350b08SShaohua Li { 260db350b08SShaohua Li acpi_handle tmp; 261db350b08SShaohua Li 262db350b08SShaohua Li if ((ACPI_SUCCESS(acpi_get_handle(handle, "_GTF", &tmp))) || 263db350b08SShaohua Li (ACPI_SUCCESS(acpi_get_handle(handle, "_GTM", &tmp))) || 264db350b08SShaohua Li (ACPI_SUCCESS(acpi_get_handle(handle, "_STM", &tmp))) || 265db350b08SShaohua Li (ACPI_SUCCESS(acpi_get_handle(handle, "_SDD", &tmp)))) 266db350b08SShaohua Li return 1; 267db350b08SShaohua Li 268db350b08SShaohua Li return 0; 269db350b08SShaohua Li } 270db350b08SShaohua Li 271d423c083SJiang Liu static int __init is_battery(acpi_handle handle) 272db350b08SShaohua Li { 273db350b08SShaohua Li struct acpi_device_info *info; 274db350b08SShaohua Li int ret = 1; 275db350b08SShaohua Li 27615b8dd53SBob Moore if (!ACPI_SUCCESS(acpi_get_object_info(handle, &info))) 277db350b08SShaohua Li return 0; 278db350b08SShaohua Li if (!(info->valid & ACPI_VALID_HID)) 279db350b08SShaohua Li ret = 0; 280db350b08SShaohua Li else 28115b8dd53SBob Moore ret = !strcmp("PNP0C0A", info->hardware_id.string); 282db350b08SShaohua Li 28315b8dd53SBob Moore kfree(info); 284db350b08SShaohua Li return ret; 285db350b08SShaohua Li } 286db350b08SShaohua Li 287d423c083SJiang Liu static int __init is_ejectable_bay(acpi_handle handle) 288db350b08SShaohua Li { 289db350b08SShaohua Li acpi_handle phandle; 290747479a3SAlex Chiang 291db350b08SShaohua Li if (!is_ejectable(handle)) 292db350b08SShaohua Li return 0; 293db350b08SShaohua Li if (is_battery(handle) || is_ata(handle)) 294db350b08SShaohua Li return 1; 295db350b08SShaohua Li if (!acpi_get_parent(handle, &phandle) && is_ata(phandle)) 296db350b08SShaohua Li return 1; 297db350b08SShaohua Li return 0; 298db350b08SShaohua Li } 299db350b08SShaohua Li 300c8f7a62cSLen Brown /** 301c8f7a62cSLen Brown * is_dock_device - see if a device is on a dock station 302c8f7a62cSLen Brown * @handle: acpi handle of the device 303c8f7a62cSLen Brown * 304c8f7a62cSLen Brown * If this device is either the dock station itself, 305c8f7a62cSLen Brown * or is a device dependent on the dock station, then it 306c8f7a62cSLen Brown * is a dock device 307c8f7a62cSLen Brown */ 308c8f7a62cSLen Brown int is_dock_device(acpi_handle handle) 309c8f7a62cSLen Brown { 310db350b08SShaohua Li struct dock_station *dock_station; 311db350b08SShaohua Li 312db350b08SShaohua Li if (!dock_station_count) 313c8f7a62cSLen Brown return 0; 314c8f7a62cSLen Brown 315db350b08SShaohua Li if (is_dock(handle)) 316c8f7a62cSLen Brown return 1; 317747479a3SAlex Chiang 318747479a3SAlex Chiang list_for_each_entry(dock_station, &dock_stations, sibling) 319db350b08SShaohua Li if (find_dock_dependent_device(dock_station, handle)) 320db350b08SShaohua Li return 1; 321c8f7a62cSLen Brown 322c8f7a62cSLen Brown return 0; 323c8f7a62cSLen Brown } 324c8f7a62cSLen Brown EXPORT_SYMBOL_GPL(is_dock_device); 325c8f7a62cSLen Brown 326c8f7a62cSLen Brown /** 327c8f7a62cSLen Brown * dock_present - see if the dock station is present. 328c8f7a62cSLen Brown * @ds: the dock station 329c8f7a62cSLen Brown * 330c8f7a62cSLen Brown * execute the _STA method. note that present does not 331c8f7a62cSLen Brown * imply that we are docked. 332c8f7a62cSLen Brown */ 333c8f7a62cSLen Brown static int dock_present(struct dock_station *ds) 334c8f7a62cSLen Brown { 33527663c58SMatthew Wilcox unsigned long long sta; 336c8f7a62cSLen Brown acpi_status status; 337c8f7a62cSLen Brown 338c8f7a62cSLen Brown if (ds) { 339c8f7a62cSLen Brown status = acpi_evaluate_integer(ds->handle, "_STA", NULL, &sta); 340c8f7a62cSLen Brown if (ACPI_SUCCESS(status) && sta) 341c8f7a62cSLen Brown return 1; 342c8f7a62cSLen Brown } 343c8f7a62cSLen Brown return 0; 344c8f7a62cSLen Brown } 345c8f7a62cSLen Brown 346c8f7a62cSLen Brown /** 347c8f7a62cSLen Brown * dock_create_acpi_device - add new devices to acpi 348c8f7a62cSLen Brown * @handle - handle of the device to add 349c8f7a62cSLen Brown * 350c8f7a62cSLen Brown * This function will create a new acpi_device for the given 351c8f7a62cSLen Brown * handle if one does not exist already. This should cause 352c8f7a62cSLen Brown * acpi to scan for drivers for the given devices, and call 353c8f7a62cSLen Brown * matching driver's add routine. 354c8f7a62cSLen Brown * 355c8f7a62cSLen Brown * Returns a pointer to the acpi_device corresponding to the handle. 356c8f7a62cSLen Brown */ 357c8f7a62cSLen Brown static struct acpi_device * dock_create_acpi_device(acpi_handle handle) 358c8f7a62cSLen Brown { 359747479a3SAlex Chiang struct acpi_device *device; 360c8f7a62cSLen Brown int ret; 361c8f7a62cSLen Brown 362c8f7a62cSLen Brown if (acpi_bus_get_device(handle, &device)) { 363c8f7a62cSLen Brown /* 364c8f7a62cSLen Brown * no device created for this object, 365c8f7a62cSLen Brown * so we should create one. 366c8f7a62cSLen Brown */ 367b8bd759aSRafael J. Wysocki ret = acpi_bus_scan(handle); 368636458deSRafael J. Wysocki if (ret) 369747479a3SAlex Chiang pr_debug("error adding bus, %x\n", -ret); 3700cd6ac52SRafael J. Wysocki 3710cd6ac52SRafael J. Wysocki acpi_bus_get_device(handle, &device); 372c8f7a62cSLen Brown } 373c8f7a62cSLen Brown return device; 374c8f7a62cSLen Brown } 375c8f7a62cSLen Brown 376c8f7a62cSLen Brown /** 377c8f7a62cSLen Brown * dock_remove_acpi_device - remove the acpi_device struct from acpi 378c8f7a62cSLen Brown * @handle - the handle of the device to remove 379c8f7a62cSLen Brown * 380c8f7a62cSLen Brown * Tell acpi to remove the acpi_device. This should cause any loaded 381c8f7a62cSLen Brown * driver to have it's remove routine called. 382c8f7a62cSLen Brown */ 383c8f7a62cSLen Brown static void dock_remove_acpi_device(acpi_handle handle) 384c8f7a62cSLen Brown { 385c8f7a62cSLen Brown struct acpi_device *device; 386c8f7a62cSLen Brown 387bfee26dbSRafael J. Wysocki if (!acpi_bus_get_device(handle, &device)) 388bfee26dbSRafael J. Wysocki acpi_bus_trim(device); 389c8f7a62cSLen Brown } 390c8f7a62cSLen Brown 391c8f7a62cSLen Brown /** 392c8f7a62cSLen Brown * hotplug_dock_devices - insert or remove devices on the dock station 393c8f7a62cSLen Brown * @ds: the dock station 394c8f7a62cSLen Brown * @event: either bus check or eject request 395c8f7a62cSLen Brown * 396c8f7a62cSLen Brown * Some devices on the dock station need to have drivers called 397c8f7a62cSLen Brown * to perform hotplug operations after a dock event has occurred. 398c8f7a62cSLen Brown * Traverse the list of dock devices that have registered a 399c8f7a62cSLen Brown * hotplug handler, and call the handler. 400c8f7a62cSLen Brown */ 401c8f7a62cSLen Brown static void hotplug_dock_devices(struct dock_station *ds, u32 event) 402c8f7a62cSLen Brown { 403c8f7a62cSLen Brown struct dock_dependent_device *dd; 404c8f7a62cSLen Brown 4058b0dc866SKristen Carlson Accardi mutex_lock(&ds->hp_lock); 406c8f7a62cSLen Brown 407c8f7a62cSLen Brown /* 408c8f7a62cSLen Brown * First call driver specific hotplug functions 409c8f7a62cSLen Brown */ 41021a31013SRafael J. Wysocki list_for_each_entry(dd, &ds->dependent_devices, list) 41121a31013SRafael J. Wysocki dock_hotplug_event(dd, event, false); 412c8f7a62cSLen Brown 413c8f7a62cSLen Brown /* 414c8f7a62cSLen Brown * Now make sure that an acpi_device is created for each 415c8f7a62cSLen Brown * dependent device, or removed if this is an eject request. 416c8f7a62cSLen Brown * This will cause acpi_drivers to be stopped/started if they 417c8f7a62cSLen Brown * exist 418c8f7a62cSLen Brown */ 419c8f7a62cSLen Brown list_for_each_entry(dd, &ds->dependent_devices, list) { 420c8f7a62cSLen Brown if (event == ACPI_NOTIFY_EJECT_REQUEST) 421c8f7a62cSLen Brown dock_remove_acpi_device(dd->handle); 422c8f7a62cSLen Brown else 423c8f7a62cSLen Brown dock_create_acpi_device(dd->handle); 424c8f7a62cSLen Brown } 4258b0dc866SKristen Carlson Accardi mutex_unlock(&ds->hp_lock); 426c8f7a62cSLen Brown } 427c8f7a62cSLen Brown 428c8f7a62cSLen Brown static void dock_event(struct dock_station *ds, u32 event, int num) 429c8f7a62cSLen Brown { 430db350b08SShaohua Li struct device *dev = &ds->dock_device->dev; 43166b56821SHolger Macht char event_string[13]; 43279a8f70bSKristen Carlson Accardi char *envp[] = { event_string, NULL }; 4331253f7aaSShaohua Li struct dock_dependent_device *dd; 43479a8f70bSKristen Carlson Accardi 43579a8f70bSKristen Carlson Accardi if (num == UNDOCK_EVENT) 43666b56821SHolger Macht sprintf(event_string, "EVENT=undock"); 43779a8f70bSKristen Carlson Accardi else 43866b56821SHolger Macht sprintf(event_string, "EVENT=dock"); 43979a8f70bSKristen Carlson Accardi 4405669021eSKristen Carlson Accardi /* 4418ea86e0bSKristen Carlson Accardi * Indicate that the status of the dock station has 4428ea86e0bSKristen Carlson Accardi * changed. 4435669021eSKristen Carlson Accardi */ 4441253f7aaSShaohua Li if (num == DOCK_EVENT) 4451253f7aaSShaohua Li kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp); 4461253f7aaSShaohua Li 44721a31013SRafael J. Wysocki list_for_each_entry(dd, &ds->dependent_devices, list) 44821a31013SRafael J. Wysocki dock_hotplug_event(dd, event, true); 449747479a3SAlex Chiang 4501253f7aaSShaohua Li if (num != DOCK_EVENT) 45179a8f70bSKristen Carlson Accardi kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp); 452c8f7a62cSLen Brown } 453c8f7a62cSLen Brown 454c8f7a62cSLen Brown /** 455c8f7a62cSLen Brown * eject_dock - respond to a dock eject request 456c8f7a62cSLen Brown * @ds: the dock station 457c8f7a62cSLen Brown * 458c8f7a62cSLen Brown * This is called after _DCK is called, to execute the dock station's 459c8f7a62cSLen Brown * _EJ0 method. 460c8f7a62cSLen Brown */ 461c8f7a62cSLen Brown static void eject_dock(struct dock_station *ds) 462c8f7a62cSLen Brown { 463c8f7a62cSLen Brown struct acpi_object_list arg_list; 464c8f7a62cSLen Brown union acpi_object arg; 465c8f7a62cSLen Brown acpi_status status; 466c8f7a62cSLen Brown acpi_handle tmp; 467c8f7a62cSLen Brown 468c8f7a62cSLen Brown /* all dock devices should have _EJ0, but check anyway */ 469c8f7a62cSLen Brown status = acpi_get_handle(ds->handle, "_EJ0", &tmp); 470c8f7a62cSLen Brown if (ACPI_FAILURE(status)) { 471c8f7a62cSLen Brown pr_debug("No _EJ0 support for dock device\n"); 472c8f7a62cSLen Brown return; 473c8f7a62cSLen Brown } 474c8f7a62cSLen Brown 475c8f7a62cSLen Brown arg_list.count = 1; 476c8f7a62cSLen Brown arg_list.pointer = &arg; 477c8f7a62cSLen Brown arg.type = ACPI_TYPE_INTEGER; 478c8f7a62cSLen Brown arg.integer.value = 1; 479c8f7a62cSLen Brown 480747479a3SAlex Chiang status = acpi_evaluate_object(ds->handle, "_EJ0", &arg_list, NULL); 481747479a3SAlex Chiang if (ACPI_FAILURE(status)) 482c8f7a62cSLen Brown pr_debug("Failed to evaluate _EJ0!\n"); 483c8f7a62cSLen Brown } 484c8f7a62cSLen Brown 485c8f7a62cSLen Brown /** 486c8f7a62cSLen Brown * handle_dock - handle a dock event 487c8f7a62cSLen Brown * @ds: the dock station 488c8f7a62cSLen Brown * @dock: to dock, or undock - that is the question 489c8f7a62cSLen Brown * 490c8f7a62cSLen Brown * Execute the _DCK method in response to an acpi event 491c8f7a62cSLen Brown */ 492c8f7a62cSLen Brown static void handle_dock(struct dock_station *ds, int dock) 493c8f7a62cSLen Brown { 494c8f7a62cSLen Brown acpi_status status; 495c8f7a62cSLen Brown struct acpi_object_list arg_list; 496c8f7a62cSLen Brown union acpi_object arg; 497c8f7a62cSLen Brown struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL }; 498c8f7a62cSLen Brown 499cd73018fSToshi Kani acpi_handle_info(ds->handle, "%s\n", dock ? "docking" : "undocking"); 500c8f7a62cSLen Brown 501c8f7a62cSLen Brown /* _DCK method has one argument */ 502c8f7a62cSLen Brown arg_list.count = 1; 503c8f7a62cSLen Brown arg_list.pointer = &arg; 504c8f7a62cSLen Brown arg.type = ACPI_TYPE_INTEGER; 505c8f7a62cSLen Brown arg.integer.value = dock; 506c8f7a62cSLen Brown status = acpi_evaluate_object(ds->handle, "_DCK", &arg_list, &buffer); 507db350b08SShaohua Li if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) 508cd73018fSToshi Kani acpi_handle_err(ds->handle, "Failed to execute _DCK (0x%x)\n", 509cd73018fSToshi Kani status); 5100a918a94SThomas Renninger 511c8f7a62cSLen Brown kfree(buffer.pointer); 512c8f7a62cSLen Brown } 513c8f7a62cSLen Brown 514c8f7a62cSLen Brown static inline void dock(struct dock_station *ds) 515c8f7a62cSLen Brown { 516c8f7a62cSLen Brown handle_dock(ds, 1); 517c8f7a62cSLen Brown } 518c8f7a62cSLen Brown 519c8f7a62cSLen Brown static inline void undock(struct dock_station *ds) 520c8f7a62cSLen Brown { 521c8f7a62cSLen Brown handle_dock(ds, 0); 522c8f7a62cSLen Brown } 523c8f7a62cSLen Brown 524c8f7a62cSLen Brown static inline void begin_dock(struct dock_station *ds) 525c8f7a62cSLen Brown { 526c8f7a62cSLen Brown ds->flags |= DOCK_DOCKING; 527c8f7a62cSLen Brown } 528c8f7a62cSLen Brown 529c8f7a62cSLen Brown static inline void complete_dock(struct dock_station *ds) 530c8f7a62cSLen Brown { 531c8f7a62cSLen Brown ds->flags &= ~(DOCK_DOCKING); 532c8f7a62cSLen Brown ds->last_dock_time = jiffies; 533c8f7a62cSLen Brown } 534c8f7a62cSLen Brown 535a0cd35fdSKristen Carlson Accardi static inline void begin_undock(struct dock_station *ds) 536a0cd35fdSKristen Carlson Accardi { 537a0cd35fdSKristen Carlson Accardi ds->flags |= DOCK_UNDOCKING; 538a0cd35fdSKristen Carlson Accardi } 539a0cd35fdSKristen Carlson Accardi 540a0cd35fdSKristen Carlson Accardi static inline void complete_undock(struct dock_station *ds) 541a0cd35fdSKristen Carlson Accardi { 542a0cd35fdSKristen Carlson Accardi ds->flags &= ~(DOCK_UNDOCKING); 543a0cd35fdSKristen Carlson Accardi } 544a0cd35fdSKristen Carlson Accardi 545406f692dSShaohua Li static void dock_lock(struct dock_station *ds, int lock) 546406f692dSShaohua Li { 547406f692dSShaohua Li struct acpi_object_list arg_list; 548406f692dSShaohua Li union acpi_object arg; 549406f692dSShaohua Li acpi_status status; 550406f692dSShaohua Li 551406f692dSShaohua Li arg_list.count = 1; 552406f692dSShaohua Li arg_list.pointer = &arg; 553406f692dSShaohua Li arg.type = ACPI_TYPE_INTEGER; 554406f692dSShaohua Li arg.integer.value = !!lock; 555406f692dSShaohua Li status = acpi_evaluate_object(ds->handle, "_LCK", &arg_list, NULL); 556406f692dSShaohua Li if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) { 557406f692dSShaohua Li if (lock) 558cd73018fSToshi Kani acpi_handle_warn(ds->handle, 559cd73018fSToshi Kani "Locking device failed (0x%x)\n", status); 560406f692dSShaohua Li else 561cd73018fSToshi Kani acpi_handle_warn(ds->handle, 562cd73018fSToshi Kani "Unlocking device failed (0x%x)\n", status); 563406f692dSShaohua Li } 564406f692dSShaohua Li } 565406f692dSShaohua Li 566c8f7a62cSLen Brown /** 567c8f7a62cSLen Brown * dock_in_progress - see if we are in the middle of handling a dock event 568c8f7a62cSLen Brown * @ds: the dock station 569c8f7a62cSLen Brown * 570c8f7a62cSLen Brown * Sometimes while docking, false dock events can be sent to the driver 571c8f7a62cSLen Brown * because good connections aren't made or some other reason. Ignore these 572c8f7a62cSLen Brown * if we are in the middle of doing something. 573c8f7a62cSLen Brown */ 574c8f7a62cSLen Brown static int dock_in_progress(struct dock_station *ds) 575c8f7a62cSLen Brown { 576c8f7a62cSLen Brown if ((ds->flags & DOCK_DOCKING) || 577c8f7a62cSLen Brown time_before(jiffies, (ds->last_dock_time + HZ))) 578c8f7a62cSLen Brown return 1; 579c8f7a62cSLen Brown return 0; 580c8f7a62cSLen Brown } 581c8f7a62cSLen Brown 582c8f7a62cSLen Brown /** 583c8f7a62cSLen Brown * register_dock_notifier - add yourself to the dock notifier list 584c8f7a62cSLen Brown * @nb: the callers notifier block 585c8f7a62cSLen Brown * 586c8f7a62cSLen Brown * If a driver wishes to be notified about dock events, they can 587c8f7a62cSLen Brown * use this function to put a notifier block on the dock notifier list. 588c8f7a62cSLen Brown * this notifier call chain will be called after a dock event, but 589c8f7a62cSLen Brown * before hotplugging any new devices. 590c8f7a62cSLen Brown */ 591c8f7a62cSLen Brown int register_dock_notifier(struct notifier_block *nb) 592c8f7a62cSLen Brown { 593db350b08SShaohua Li if (!dock_station_count) 5942548c06bSPrarit Bhargava return -ENODEV; 5952548c06bSPrarit Bhargava 596c8f7a62cSLen Brown return atomic_notifier_chain_register(&dock_notifier_list, nb); 597c8f7a62cSLen Brown } 598c8f7a62cSLen Brown EXPORT_SYMBOL_GPL(register_dock_notifier); 599c8f7a62cSLen Brown 600c8f7a62cSLen Brown /** 601c8f7a62cSLen Brown * unregister_dock_notifier - remove yourself from the dock notifier list 602c8f7a62cSLen Brown * @nb: the callers notifier block 603c8f7a62cSLen Brown */ 604c8f7a62cSLen Brown void unregister_dock_notifier(struct notifier_block *nb) 605c8f7a62cSLen Brown { 606db350b08SShaohua Li if (!dock_station_count) 6072548c06bSPrarit Bhargava return; 6082548c06bSPrarit Bhargava 609c8f7a62cSLen Brown atomic_notifier_chain_unregister(&dock_notifier_list, nb); 610c8f7a62cSLen Brown } 611c8f7a62cSLen Brown EXPORT_SYMBOL_GPL(unregister_dock_notifier); 612c8f7a62cSLen Brown 613c8f7a62cSLen Brown /** 614c8f7a62cSLen Brown * register_hotplug_dock_device - register a hotplug function 615c8f7a62cSLen Brown * @handle: the handle of the device 6161253f7aaSShaohua Li * @ops: handlers to call after docking 617c8f7a62cSLen Brown * @context: device specific data 61821a31013SRafael J. Wysocki * @init: Optional initialization routine to run after registration 61921a31013SRafael J. Wysocki * @release: Optional release routine to run on unregistration 620c8f7a62cSLen Brown * 621c8f7a62cSLen Brown * If a driver would like to perform a hotplug operation after a dock 622c8f7a62cSLen Brown * event, they can register an acpi_notifiy_handler to be called by 623c8f7a62cSLen Brown * the dock driver after _DCK is executed. 624c8f7a62cSLen Brown */ 62521a31013SRafael J. Wysocki int register_hotplug_dock_device(acpi_handle handle, 62621a31013SRafael J. Wysocki const struct acpi_dock_ops *ops, void *context, 62721a31013SRafael J. Wysocki void (*init)(void *), void (*release)(void *)) 628c8f7a62cSLen Brown { 629c8f7a62cSLen Brown struct dock_dependent_device *dd; 630db350b08SShaohua Li struct dock_station *dock_station; 63161b83695SShaohua Li int ret = -EINVAL; 632c8f7a62cSLen Brown 63321a31013SRafael J. Wysocki if (WARN_ON(!context)) 63421a31013SRafael J. Wysocki return -EINVAL; 63521a31013SRafael J. Wysocki 636db350b08SShaohua Li if (!dock_station_count) 637c8f7a62cSLen Brown return -ENODEV; 638c8f7a62cSLen Brown 639c8f7a62cSLen Brown /* 640c8f7a62cSLen Brown * make sure this handle is for a device dependent on the dock, 641c8f7a62cSLen Brown * this would include the dock station itself 642c8f7a62cSLen Brown */ 64350d716e4SAlex Chiang list_for_each_entry(dock_station, &dock_stations, sibling) { 64461b83695SShaohua Li /* 64561b83695SShaohua Li * An ATA bay can be in a dock and itself can be ejected 6463ad2f3fbSDaniel Mack * separately, so there are two 'dock stations' which need the 64761b83695SShaohua Li * ops 64861b83695SShaohua Li */ 649c8f7a62cSLen Brown dd = find_dock_dependent_device(dock_station, handle); 65021a31013SRafael J. Wysocki if (dd && !dock_init_hotplug(dd, ops, context, init, release)) 65161b83695SShaohua Li ret = 0; 652c8f7a62cSLen Brown } 653c8f7a62cSLen Brown 65461b83695SShaohua Li return ret; 655c8f7a62cSLen Brown } 656c8f7a62cSLen Brown EXPORT_SYMBOL_GPL(register_hotplug_dock_device); 657c8f7a62cSLen Brown 658c8f7a62cSLen Brown /** 659c8f7a62cSLen Brown * unregister_hotplug_dock_device - remove yourself from the hotplug list 660c8f7a62cSLen Brown * @handle: the acpi handle of the device 661c8f7a62cSLen Brown */ 662c8f7a62cSLen Brown void unregister_hotplug_dock_device(acpi_handle handle) 663c8f7a62cSLen Brown { 664c8f7a62cSLen Brown struct dock_dependent_device *dd; 665db350b08SShaohua Li struct dock_station *dock_station; 666c8f7a62cSLen Brown 667db350b08SShaohua Li if (!dock_station_count) 668c8f7a62cSLen Brown return; 669c8f7a62cSLen Brown 67050d716e4SAlex Chiang list_for_each_entry(dock_station, &dock_stations, sibling) { 671c8f7a62cSLen Brown dd = find_dock_dependent_device(dock_station, handle); 672c8f7a62cSLen Brown if (dd) 67321a31013SRafael J. Wysocki dock_release_hotplug(dd); 674c8f7a62cSLen Brown } 675db350b08SShaohua Li } 676c8f7a62cSLen Brown EXPORT_SYMBOL_GPL(unregister_hotplug_dock_device); 677c8f7a62cSLen Brown 678c8f7a62cSLen Brown /** 679c80fdbe8Sbrandon@ifup.org * handle_eject_request - handle an undock request checking for error conditions 680c80fdbe8Sbrandon@ifup.org * 681c80fdbe8Sbrandon@ifup.org * Check to make sure the dock device is still present, then undock and 682c80fdbe8Sbrandon@ifup.org * hotremove all the devices that may need removing. 683c80fdbe8Sbrandon@ifup.org */ 684c80fdbe8Sbrandon@ifup.org static int handle_eject_request(struct dock_station *ds, u32 event) 685c80fdbe8Sbrandon@ifup.org { 686c80fdbe8Sbrandon@ifup.org if (dock_in_progress(ds)) 687c80fdbe8Sbrandon@ifup.org return -EBUSY; 688c80fdbe8Sbrandon@ifup.org 689c80fdbe8Sbrandon@ifup.org /* 690c80fdbe8Sbrandon@ifup.org * here we need to generate the undock 691c80fdbe8Sbrandon@ifup.org * event prior to actually doing the undock 692c80fdbe8Sbrandon@ifup.org * so that the device struct still exists. 693afd7301dSHolger Macht * Also, even send the dock event if the 694afd7301dSHolger Macht * device is not present anymore 695c80fdbe8Sbrandon@ifup.org */ 696c80fdbe8Sbrandon@ifup.org dock_event(ds, event, UNDOCK_EVENT); 697afd7301dSHolger Macht 698c80fdbe8Sbrandon@ifup.org hotplug_dock_devices(ds, ACPI_NOTIFY_EJECT_REQUEST); 699c80fdbe8Sbrandon@ifup.org undock(ds); 700406f692dSShaohua Li dock_lock(ds, 0); 701c80fdbe8Sbrandon@ifup.org eject_dock(ds); 702c80fdbe8Sbrandon@ifup.org if (dock_present(ds)) { 703cd73018fSToshi Kani acpi_handle_err(ds->handle, "Unable to undock!\n"); 704c80fdbe8Sbrandon@ifup.org return -EBUSY; 705c80fdbe8Sbrandon@ifup.org } 706a0cd35fdSKristen Carlson Accardi complete_undock(ds); 707c80fdbe8Sbrandon@ifup.org return 0; 708c80fdbe8Sbrandon@ifup.org } 709c80fdbe8Sbrandon@ifup.org 710c80fdbe8Sbrandon@ifup.org /** 711c8f7a62cSLen Brown * dock_notify - act upon an acpi dock notification 712c8f7a62cSLen Brown * @handle: the dock station handle 713c8f7a62cSLen Brown * @event: the acpi event 714c8f7a62cSLen Brown * @data: our driver data struct 715c8f7a62cSLen Brown * 716c8f7a62cSLen Brown * If we are notified to dock, then check to see if the dock is 717c8f7a62cSLen Brown * present and then dock. Notify all drivers of the dock event, 718c80fdbe8Sbrandon@ifup.org * and then hotplug and devices that may need hotplugging. 719c8f7a62cSLen Brown */ 720c8f7a62cSLen Brown static void dock_notify(acpi_handle handle, u32 event, void *data) 721c8f7a62cSLen Brown { 72250dd0969SJan Engelhardt struct dock_station *ds = data; 7238b59560aSShaohua Li struct acpi_device *tmp; 724db350b08SShaohua Li int surprise_removal = 0; 725c8f7a62cSLen Brown 726db350b08SShaohua Li /* 727db350b08SShaohua Li * According to acpi spec 3.0a, if a DEVICE_CHECK notification 728db350b08SShaohua Li * is sent and _DCK is present, it is assumed to mean an undock 729db350b08SShaohua Li * request. 730db350b08SShaohua Li */ 731db350b08SShaohua Li if ((ds->flags & DOCK_IS_DOCK) && event == ACPI_NOTIFY_DEVICE_CHECK) 732db350b08SShaohua Li event = ACPI_NOTIFY_EJECT_REQUEST; 733db350b08SShaohua Li 734db350b08SShaohua Li /* 735db350b08SShaohua Li * dock station: BUS_CHECK - docked or surprise removal 736db350b08SShaohua Li * DEVICE_CHECK - undocked 737db350b08SShaohua Li * other device: BUS_CHECK/DEVICE_CHECK - added or surprise removal 738db350b08SShaohua Li * 739db350b08SShaohua Li * To simplify event handling, dock dependent device handler always 740db350b08SShaohua Li * get ACPI_NOTIFY_BUS_CHECK/ACPI_NOTIFY_DEVICE_CHECK for add and 741db350b08SShaohua Li * ACPI_NOTIFY_EJECT_REQUEST for removal 742db350b08SShaohua Li */ 743c8f7a62cSLen Brown switch (event) { 744c8f7a62cSLen Brown case ACPI_NOTIFY_BUS_CHECK: 745db350b08SShaohua Li case ACPI_NOTIFY_DEVICE_CHECK: 7468b59560aSShaohua Li if (!dock_in_progress(ds) && acpi_bus_get_device(ds->handle, 7478b59560aSShaohua Li &tmp)) { 748c8f7a62cSLen Brown begin_dock(ds); 749c8f7a62cSLen Brown dock(ds); 750c8f7a62cSLen Brown if (!dock_present(ds)) { 751cd73018fSToshi Kani acpi_handle_err(handle, "Unable to dock!\n"); 7528b59560aSShaohua Li complete_dock(ds); 753c8f7a62cSLen Brown break; 754c8f7a62cSLen Brown } 755c8f7a62cSLen Brown atomic_notifier_call_chain(&dock_notifier_list, 756c8f7a62cSLen Brown event, NULL); 757c8f7a62cSLen Brown hotplug_dock_devices(ds, event); 758c8f7a62cSLen Brown complete_dock(ds); 759c8f7a62cSLen Brown dock_event(ds, event, DOCK_EVENT); 760406f692dSShaohua Li dock_lock(ds, 1); 7613a37898dSLin Ming acpi_update_all_gpes(); 762c8f7a62cSLen Brown break; 763db350b08SShaohua Li } 764db350b08SShaohua Li if (dock_present(ds) || dock_in_progress(ds)) 765db350b08SShaohua Li break; 766db350b08SShaohua Li /* This is a surprise removal */ 767db350b08SShaohua Li surprise_removal = 1; 768db350b08SShaohua Li event = ACPI_NOTIFY_EJECT_REQUEST; 769db350b08SShaohua Li /* Fall back */ 770c8f7a62cSLen Brown case ACPI_NOTIFY_EJECT_REQUEST: 771a0cd35fdSKristen Carlson Accardi begin_undock(ds); 772f730ae18SShaohua Li if ((immediate_undock && !(ds->flags & DOCK_IS_ATA)) 773f730ae18SShaohua Li || surprise_removal) 774c80fdbe8Sbrandon@ifup.org handle_eject_request(ds, event); 775a0cd35fdSKristen Carlson Accardi else 776a0cd35fdSKristen Carlson Accardi dock_event(ds, event, UNDOCK_EVENT); 777c8f7a62cSLen Brown break; 778c8f7a62cSLen Brown default: 779cd73018fSToshi Kani acpi_handle_err(handle, "Unknown dock event %d\n", event); 780c8f7a62cSLen Brown } 781c8f7a62cSLen Brown } 782c8f7a62cSLen Brown 78319cd847aSZhang Rui struct dock_data { 78419cd847aSZhang Rui acpi_handle handle; 78519cd847aSZhang Rui unsigned long event; 78619cd847aSZhang Rui struct dock_station *ds; 78719cd847aSZhang Rui }; 78819cd847aSZhang Rui 78919cd847aSZhang Rui static void acpi_dock_deferred_cb(void *context) 79019cd847aSZhang Rui { 791747479a3SAlex Chiang struct dock_data *data = context; 79219cd847aSZhang Rui 7933757b948SRafael J. Wysocki acpi_scan_lock_acquire(); 79419cd847aSZhang Rui dock_notify(data->handle, data->event, data->ds); 7953757b948SRafael J. Wysocki acpi_scan_lock_release(); 79619cd847aSZhang Rui kfree(data); 79719cd847aSZhang Rui } 79819cd847aSZhang Rui 7996bd00a61SShaohua Li static int acpi_dock_notifier_call(struct notifier_block *this, 8006bd00a61SShaohua Li unsigned long event, void *data) 8016bd00a61SShaohua Li { 8026bd00a61SShaohua Li struct dock_station *dock_station; 803747479a3SAlex Chiang acpi_handle handle = data; 8046bd00a61SShaohua Li 8056bd00a61SShaohua Li if (event != ACPI_NOTIFY_BUS_CHECK && event != ACPI_NOTIFY_DEVICE_CHECK 8066bd00a61SShaohua Li && event != ACPI_NOTIFY_EJECT_REQUEST) 8076bd00a61SShaohua Li return 0; 8083757b948SRafael J. Wysocki 8093757b948SRafael J. Wysocki acpi_scan_lock_acquire(); 8103757b948SRafael J. Wysocki 81150d716e4SAlex Chiang list_for_each_entry(dock_station, &dock_stations, sibling) { 8126bd00a61SShaohua Li if (dock_station->handle == handle) { 813747479a3SAlex Chiang struct dock_data *dd; 8143757b948SRafael J. Wysocki acpi_status status; 81519cd847aSZhang Rui 816747479a3SAlex Chiang dd = kmalloc(sizeof(*dd), GFP_KERNEL); 817747479a3SAlex Chiang if (!dd) 8183757b948SRafael J. Wysocki break; 8193757b948SRafael J. Wysocki 820747479a3SAlex Chiang dd->handle = handle; 821747479a3SAlex Chiang dd->event = event; 822747479a3SAlex Chiang dd->ds = dock_station; 8233757b948SRafael J. Wysocki status = acpi_os_hotplug_execute(acpi_dock_deferred_cb, 8243757b948SRafael J. Wysocki dd); 8253757b948SRafael J. Wysocki if (ACPI_FAILURE(status)) 8263757b948SRafael J. Wysocki kfree(dd); 8273757b948SRafael J. Wysocki 8283757b948SRafael J. Wysocki break; 8296bd00a61SShaohua Li } 8306bd00a61SShaohua Li } 8313757b948SRafael J. Wysocki 8323757b948SRafael J. Wysocki acpi_scan_lock_release(); 8336bd00a61SShaohua Li return 0; 8346bd00a61SShaohua Li } 8356bd00a61SShaohua Li 8366bd00a61SShaohua Li static struct notifier_block dock_acpi_notifier = { 8376bd00a61SShaohua Li .notifier_call = acpi_dock_notifier_call, 8386bd00a61SShaohua Li }; 8396bd00a61SShaohua Li 840c8f7a62cSLen Brown /** 841c8f7a62cSLen Brown * find_dock_devices - find devices on the dock station 842c8f7a62cSLen Brown * @handle: the handle of the device we are examining 843c8f7a62cSLen Brown * @lvl: unused 844c8f7a62cSLen Brown * @context: the dock station private data 845c8f7a62cSLen Brown * @rv: unused 846c8f7a62cSLen Brown * 847c8f7a62cSLen Brown * This function is called by acpi_walk_namespace. It will 848c8f7a62cSLen Brown * check to see if an object has an _EJD method. If it does, then it 849c8f7a62cSLen Brown * will see if it is dependent on the dock station. 850c8f7a62cSLen Brown */ 851d423c083SJiang Liu static acpi_status __init 852c8f7a62cSLen Brown find_dock_devices(acpi_handle handle, u32 lvl, void *context, void **rv) 853c8f7a62cSLen Brown { 854c8f7a62cSLen Brown acpi_status status; 855fe9a2f77SKristen Carlson Accardi acpi_handle tmp, parent; 85650dd0969SJan Engelhardt struct dock_station *ds = context; 857c8f7a62cSLen Brown 858c8f7a62cSLen Brown status = acpi_bus_get_ejd(handle, &tmp); 859fe9a2f77SKristen Carlson Accardi if (ACPI_FAILURE(status)) { 860fe9a2f77SKristen Carlson Accardi /* try the parent device as well */ 861fe9a2f77SKristen Carlson Accardi status = acpi_get_parent(handle, &parent); 862c8f7a62cSLen Brown if (ACPI_FAILURE(status)) 863fe9a2f77SKristen Carlson Accardi goto fdd_out; 864fe9a2f77SKristen Carlson Accardi /* see if parent is dependent on dock */ 865fe9a2f77SKristen Carlson Accardi status = acpi_bus_get_ejd(parent, &tmp); 866fe9a2f77SKristen Carlson Accardi if (ACPI_FAILURE(status)) 867fe9a2f77SKristen Carlson Accardi goto fdd_out; 868fe9a2f77SKristen Carlson Accardi } 869c8f7a62cSLen Brown 870f69cfdd2SAlex Chiang if (tmp == ds->handle) 871f69cfdd2SAlex Chiang add_dock_dependent_device(ds, handle); 872f69cfdd2SAlex Chiang 873fe9a2f77SKristen Carlson Accardi fdd_out: 874c8f7a62cSLen Brown return AE_OK; 875c8f7a62cSLen Brown } 876c8f7a62cSLen Brown 877c80fdbe8Sbrandon@ifup.org /* 878c80fdbe8Sbrandon@ifup.org * show_docked - read method for "docked" file in sysfs 879c80fdbe8Sbrandon@ifup.org */ 880c80fdbe8Sbrandon@ifup.org static ssize_t show_docked(struct device *dev, 881c80fdbe8Sbrandon@ifup.org struct device_attribute *attr, char *buf) 882c80fdbe8Sbrandon@ifup.org { 883fc5a9f88SHolger Macht struct acpi_device *tmp; 884fc5a9f88SHolger Macht 885fe06fba2SAlex Chiang struct dock_station *dock_station = dev->platform_data; 886c80fdbe8Sbrandon@ifup.org 88702df7349SYasuaki Ishimatsu if (!acpi_bus_get_device(dock_station->handle, &tmp)) 888fc5a9f88SHolger Macht return snprintf(buf, PAGE_SIZE, "1\n"); 889fc5a9f88SHolger Macht return snprintf(buf, PAGE_SIZE, "0\n"); 890c80fdbe8Sbrandon@ifup.org } 891e5685b9dSAdrian Bunk static DEVICE_ATTR(docked, S_IRUGO, show_docked, NULL); 892c80fdbe8Sbrandon@ifup.org 893c80fdbe8Sbrandon@ifup.org /* 894a0cd35fdSKristen Carlson Accardi * show_flags - read method for flags file in sysfs 895a0cd35fdSKristen Carlson Accardi */ 896a0cd35fdSKristen Carlson Accardi static ssize_t show_flags(struct device *dev, 897a0cd35fdSKristen Carlson Accardi struct device_attribute *attr, char *buf) 898a0cd35fdSKristen Carlson Accardi { 899fe06fba2SAlex Chiang struct dock_station *dock_station = dev->platform_data; 900a0cd35fdSKristen Carlson Accardi return snprintf(buf, PAGE_SIZE, "%d\n", dock_station->flags); 901a0cd35fdSKristen Carlson Accardi 902a0cd35fdSKristen Carlson Accardi } 903e5685b9dSAdrian Bunk static DEVICE_ATTR(flags, S_IRUGO, show_flags, NULL); 904a0cd35fdSKristen Carlson Accardi 905a0cd35fdSKristen Carlson Accardi /* 906c80fdbe8Sbrandon@ifup.org * write_undock - write method for "undock" file in sysfs 907c80fdbe8Sbrandon@ifup.org */ 908c80fdbe8Sbrandon@ifup.org static ssize_t write_undock(struct device *dev, struct device_attribute *attr, 909c80fdbe8Sbrandon@ifup.org const char *buf, size_t count) 910c80fdbe8Sbrandon@ifup.org { 911c80fdbe8Sbrandon@ifup.org int ret; 912fe06fba2SAlex Chiang struct dock_station *dock_station = dev->platform_data; 913c80fdbe8Sbrandon@ifup.org 914c80fdbe8Sbrandon@ifup.org if (!count) 915c80fdbe8Sbrandon@ifup.org return -EINVAL; 916c80fdbe8Sbrandon@ifup.org 9178112006fSRafael J. Wysocki acpi_scan_lock_acquire(); 9189171f834SHolger Macht begin_undock(dock_station); 919c80fdbe8Sbrandon@ifup.org ret = handle_eject_request(dock_station, ACPI_NOTIFY_EJECT_REQUEST); 9208112006fSRafael J. Wysocki acpi_scan_lock_release(); 921c80fdbe8Sbrandon@ifup.org return ret ? ret: count; 922c80fdbe8Sbrandon@ifup.org } 923e5685b9dSAdrian Bunk static DEVICE_ATTR(undock, S_IWUSR, NULL, write_undock); 924c80fdbe8Sbrandon@ifup.org 925ac122bb6SIlya A. Volynets-Evenbakh /* 926ac122bb6SIlya A. Volynets-Evenbakh * show_dock_uid - read method for "uid" file in sysfs 927ac122bb6SIlya A. Volynets-Evenbakh */ 928ac122bb6SIlya A. Volynets-Evenbakh static ssize_t show_dock_uid(struct device *dev, 929ac122bb6SIlya A. Volynets-Evenbakh struct device_attribute *attr, char *buf) 930ac122bb6SIlya A. Volynets-Evenbakh { 93127663c58SMatthew Wilcox unsigned long long lbuf; 932fe06fba2SAlex Chiang struct dock_station *dock_station = dev->platform_data; 93338ff4ffcSKristen Carlson Accardi acpi_status status = acpi_evaluate_integer(dock_station->handle, 93438ff4ffcSKristen Carlson Accardi "_UID", NULL, &lbuf); 93538ff4ffcSKristen Carlson Accardi if (ACPI_FAILURE(status)) 936ac122bb6SIlya A. Volynets-Evenbakh return 0; 93738ff4ffcSKristen Carlson Accardi 93827663c58SMatthew Wilcox return snprintf(buf, PAGE_SIZE, "%llx\n", lbuf); 939ac122bb6SIlya A. Volynets-Evenbakh } 940e5685b9dSAdrian Bunk static DEVICE_ATTR(uid, S_IRUGO, show_dock_uid, NULL); 941ac122bb6SIlya A. Volynets-Evenbakh 9428652b00fSShaohua Li static ssize_t show_dock_type(struct device *dev, 9438652b00fSShaohua Li struct device_attribute *attr, char *buf) 9448652b00fSShaohua Li { 945fe06fba2SAlex Chiang struct dock_station *dock_station = dev->platform_data; 9468652b00fSShaohua Li char *type; 9478652b00fSShaohua Li 9488652b00fSShaohua Li if (dock_station->flags & DOCK_IS_DOCK) 9498652b00fSShaohua Li type = "dock_station"; 9508652b00fSShaohua Li else if (dock_station->flags & DOCK_IS_ATA) 9518652b00fSShaohua Li type = "ata_bay"; 9528652b00fSShaohua Li else if (dock_station->flags & DOCK_IS_BAT) 9538652b00fSShaohua Li type = "battery_bay"; 9548652b00fSShaohua Li else 9558652b00fSShaohua Li type = "unknown"; 9568652b00fSShaohua Li 9578652b00fSShaohua Li return snprintf(buf, PAGE_SIZE, "%s\n", type); 9588652b00fSShaohua Li } 9598652b00fSShaohua Li static DEVICE_ATTR(type, S_IRUGO, show_dock_type, NULL); 9608652b00fSShaohua Li 9615f46c2f2SAlex Chiang static struct attribute *dock_attributes[] = { 9625f46c2f2SAlex Chiang &dev_attr_docked.attr, 9635f46c2f2SAlex Chiang &dev_attr_flags.attr, 9645f46c2f2SAlex Chiang &dev_attr_undock.attr, 9655f46c2f2SAlex Chiang &dev_attr_uid.attr, 9665f46c2f2SAlex Chiang &dev_attr_type.attr, 9675f46c2f2SAlex Chiang NULL 9685f46c2f2SAlex Chiang }; 9695f46c2f2SAlex Chiang 9705f46c2f2SAlex Chiang static struct attribute_group dock_attribute_group = { 9715f46c2f2SAlex Chiang .attrs = dock_attributes 9725f46c2f2SAlex Chiang }; 9735f46c2f2SAlex Chiang 974c8f7a62cSLen Brown /** 975c8f7a62cSLen Brown * dock_add - add a new dock station 976c8f7a62cSLen Brown * @handle: the dock station handle 977c8f7a62cSLen Brown * 978c8f7a62cSLen Brown * allocated and initialize a new dock station device. Find all devices 979c8f7a62cSLen Brown * that are on the dock station, and register for dock event notifications. 980c8f7a62cSLen Brown */ 981d38a5edfSUwe Kleine-König static int __init dock_add(acpi_handle handle) 982c8f7a62cSLen Brown { 983fe06fba2SAlex Chiang int ret, id; 984fe06fba2SAlex Chiang struct dock_station ds, *dock_station; 985747479a3SAlex Chiang struct platform_device *dd; 986c8f7a62cSLen Brown 987fe06fba2SAlex Chiang id = dock_station_count; 98849c6fb2eSAlex Chiang memset(&ds, 0, sizeof(ds)); 989747479a3SAlex Chiang dd = platform_device_register_data(NULL, "dock", id, &ds, sizeof(ds)); 990747479a3SAlex Chiang if (IS_ERR(dd)) 991747479a3SAlex Chiang return PTR_ERR(dd); 9929751cb72SAlex Chiang 993747479a3SAlex Chiang dock_station = dd->dev.platform_data; 994747479a3SAlex Chiang 995c8f7a62cSLen Brown dock_station->handle = handle; 996747479a3SAlex Chiang dock_station->dock_device = dd; 997c8f7a62cSLen Brown dock_station->last_dock_time = jiffies - HZ; 998c8f7a62cSLen Brown 999c8f7a62cSLen Brown mutex_init(&dock_station->hp_lock); 1000747479a3SAlex Chiang INIT_LIST_HEAD(&dock_station->sibling); 1001747479a3SAlex Chiang INIT_LIST_HEAD(&dock_station->dependent_devices); 1002a0cd35fdSKristen Carlson Accardi 10039ef2a9a9SKristen Carlson Accardi /* we want the dock device to send uevents */ 1004747479a3SAlex Chiang dev_set_uevent_suppress(&dd->dev, 0); 10059ef2a9a9SKristen Carlson Accardi 1006db350b08SShaohua Li if (is_dock(handle)) 1007db350b08SShaohua Li dock_station->flags |= DOCK_IS_DOCK; 1008db350b08SShaohua Li if (is_ata(handle)) 1009db350b08SShaohua Li dock_station->flags |= DOCK_IS_ATA; 1010db350b08SShaohua Li if (is_battery(handle)) 1011db350b08SShaohua Li dock_station->flags |= DOCK_IS_BAT; 1012db350b08SShaohua Li 1013747479a3SAlex Chiang ret = sysfs_create_group(&dd->dev.kobj, &dock_attribute_group); 10148652b00fSShaohua Li if (ret) 10155f46c2f2SAlex Chiang goto err_unregister; 1016671adbecSKristen Carlson Accardi 1017c8f7a62cSLen Brown /* Find dependent devices */ 1018c8f7a62cSLen Brown acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT, 10192263576cSLin Ming ACPI_UINT32_MAX, find_dock_devices, NULL, 10202263576cSLin Ming dock_station, NULL); 1021c8f7a62cSLen Brown 1022c8f7a62cSLen Brown /* add the dock station as a device dependent on itself */ 1023f69cfdd2SAlex Chiang ret = add_dock_dependent_device(dock_station, handle); 1024f69cfdd2SAlex Chiang if (ret) 10255f46c2f2SAlex Chiang goto err_rmgroup; 1026c8f7a62cSLen Brown 1027db350b08SShaohua Li dock_station_count++; 102850d716e4SAlex Chiang list_add(&dock_station->sibling, &dock_stations); 1029c8f7a62cSLen Brown return 0; 1030c8f7a62cSLen Brown 10315f46c2f2SAlex Chiang err_rmgroup: 1032747479a3SAlex Chiang sysfs_remove_group(&dd->dev.kobj, &dock_attribute_group); 10335f46c2f2SAlex Chiang err_unregister: 1034747479a3SAlex Chiang platform_device_unregister(dd); 1035cd73018fSToshi Kani acpi_handle_err(handle, "%s encountered error %d\n", __func__, ret); 1036c8f7a62cSLen Brown return ret; 1037c8f7a62cSLen Brown } 1038c8f7a62cSLen Brown 1039c8f7a62cSLen Brown /** 10408ab0ab25SToshi Kani * find_dock_and_bay - look for dock stations and bays 1041c8f7a62cSLen Brown * @handle: acpi handle of a device 1042c8f7a62cSLen Brown * @lvl: unused 10438ab0ab25SToshi Kani * @context: unused 1044c8f7a62cSLen Brown * @rv: unused 1045c8f7a62cSLen Brown * 10468ab0ab25SToshi Kani * This is called by acpi_walk_namespace to look for dock stations and bays. 1047c8f7a62cSLen Brown */ 1048d38a5edfSUwe Kleine-König static __init acpi_status 10498ab0ab25SToshi Kani find_dock_and_bay(acpi_handle handle, u32 lvl, void *context, void **rv) 1050c8f7a62cSLen Brown { 10518ab0ab25SToshi Kani if (is_dock(handle) || is_ejectable_bay(handle)) 10521ee4d61fSZhang Rui dock_add(handle); 1053747479a3SAlex Chiang 10541ee4d61fSZhang Rui return AE_OK; 1055c8f7a62cSLen Brown } 1056c8f7a62cSLen Brown 10572ce65fe8SRafael J. Wysocki void __init acpi_dock_init(void) 1058c8f7a62cSLen Brown { 1059816c2edaSLen Brown if (acpi_disabled) 10602ce65fe8SRafael J. Wysocki return; 1061816c2edaSLen Brown 10628ab0ab25SToshi Kani /* look for dock stations and bays */ 1063c8f7a62cSLen Brown acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT, 10648ab0ab25SToshi Kani ACPI_UINT32_MAX, find_dock_and_bay, NULL, NULL, NULL); 1065c8f7a62cSLen Brown 1066db350b08SShaohua Li if (!dock_station_count) { 1067cd73018fSToshi Kani pr_info(PREFIX "No dock devices found.\n"); 10682ce65fe8SRafael J. Wysocki return; 1069db350b08SShaohua Li } 1070c8f7a62cSLen Brown 1071f22ff552SJiang Liu ATOMIC_INIT_NOTIFIER_HEAD(&dock_notifier_list); 10726bd00a61SShaohua Li register_acpi_bus_notifier(&dock_acpi_notifier); 1073cd73018fSToshi Kani pr_info(PREFIX "%s: %d docks/bays found\n", 1074db350b08SShaohua Li ACPI_DOCK_DRIVER_DESCRIPTION, dock_station_count); 1075c8f7a62cSLen Brown } 1076