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; 66c8f7a62cSLen Brown spinlock_t dd_lock; 678b0dc866SKristen Carlson Accardi struct mutex hp_lock; 68c8f7a62cSLen Brown struct list_head dependent_devices; 69c8f7a62cSLen Brown struct list_head hotplug_devices; 70db350b08SShaohua Li 7150d716e4SAlex Chiang struct list_head sibling; 72db350b08SShaohua Li struct platform_device *dock_device; 73c8f7a62cSLen Brown }; 74db350b08SShaohua Li static LIST_HEAD(dock_stations); 75db350b08SShaohua Li static int dock_station_count; 76c8f7a62cSLen Brown 77c8f7a62cSLen Brown struct dock_dependent_device { 78c8f7a62cSLen Brown struct list_head list; 79c8f7a62cSLen Brown struct list_head hotplug_list; 80c8f7a62cSLen Brown acpi_handle handle; 819c8b04beSVasiliy Kulikov const struct acpi_dock_ops *ops; 82c8f7a62cSLen Brown void *context; 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 */ 103f69cfdd2SAlex Chiang static int 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 INIT_LIST_HEAD(&dd->hotplug_list); 115c8f7a62cSLen Brown 116c8f7a62cSLen Brown spin_lock(&ds->dd_lock); 117c8f7a62cSLen Brown list_add_tail(&dd->list, &ds->dependent_devices); 118c8f7a62cSLen Brown spin_unlock(&ds->dd_lock); 119f69cfdd2SAlex Chiang 120f69cfdd2SAlex Chiang return 0; 121c8f7a62cSLen Brown } 122c8f7a62cSLen Brown 123c8f7a62cSLen Brown /** 124c8f7a62cSLen Brown * dock_add_hotplug_device - associate a hotplug handler with the dock station 125c8f7a62cSLen Brown * @ds: The dock station 126c8f7a62cSLen Brown * @dd: The dependent device struct 127c8f7a62cSLen Brown * 128c8f7a62cSLen Brown * Add the dependent device to the dock's hotplug device list 129c8f7a62cSLen Brown */ 130c8f7a62cSLen Brown static void 131c8f7a62cSLen Brown dock_add_hotplug_device(struct dock_station *ds, 132c8f7a62cSLen Brown struct dock_dependent_device *dd) 133c8f7a62cSLen Brown { 1348b0dc866SKristen Carlson Accardi mutex_lock(&ds->hp_lock); 135c8f7a62cSLen Brown list_add_tail(&dd->hotplug_list, &ds->hotplug_devices); 1368b0dc866SKristen Carlson Accardi mutex_unlock(&ds->hp_lock); 137c8f7a62cSLen Brown } 138c8f7a62cSLen Brown 139c8f7a62cSLen Brown /** 140c8f7a62cSLen Brown * dock_del_hotplug_device - remove a hotplug handler from the dock station 141c8f7a62cSLen Brown * @ds: The dock station 142c8f7a62cSLen Brown * @dd: the dependent device struct 143c8f7a62cSLen Brown * 144c8f7a62cSLen Brown * Delete the dependent device from the dock's hotplug device list 145c8f7a62cSLen Brown */ 146c8f7a62cSLen Brown static void 147c8f7a62cSLen Brown dock_del_hotplug_device(struct dock_station *ds, 148c8f7a62cSLen Brown struct dock_dependent_device *dd) 149c8f7a62cSLen Brown { 1508b0dc866SKristen Carlson Accardi mutex_lock(&ds->hp_lock); 151c8f7a62cSLen Brown list_del(&dd->hotplug_list); 1528b0dc866SKristen Carlson Accardi mutex_unlock(&ds->hp_lock); 153c8f7a62cSLen Brown } 154c8f7a62cSLen Brown 155c8f7a62cSLen Brown /** 156c8f7a62cSLen Brown * find_dock_dependent_device - get a device dependent on this dock 157c8f7a62cSLen Brown * @ds: the dock station 158c8f7a62cSLen Brown * @handle: the acpi_handle of the device we want 159c8f7a62cSLen Brown * 160c8f7a62cSLen Brown * iterate over the dependent device list for this dock. If the 161c8f7a62cSLen Brown * dependent device matches the handle, return. 162c8f7a62cSLen Brown */ 163c8f7a62cSLen Brown static struct dock_dependent_device * 164c8f7a62cSLen Brown find_dock_dependent_device(struct dock_station *ds, acpi_handle handle) 165c8f7a62cSLen Brown { 166c8f7a62cSLen Brown struct dock_dependent_device *dd; 167c8f7a62cSLen Brown 168c8f7a62cSLen Brown spin_lock(&ds->dd_lock); 169c8f7a62cSLen Brown list_for_each_entry(dd, &ds->dependent_devices, list) { 170c8f7a62cSLen Brown if (handle == dd->handle) { 171c8f7a62cSLen Brown spin_unlock(&ds->dd_lock); 172c8f7a62cSLen Brown return dd; 173c8f7a62cSLen Brown } 174c8f7a62cSLen Brown } 175c8f7a62cSLen Brown spin_unlock(&ds->dd_lock); 176c8f7a62cSLen Brown return NULL; 177c8f7a62cSLen Brown } 178c8f7a62cSLen Brown 179c8f7a62cSLen Brown /***************************************************************************** 180c8f7a62cSLen Brown * Dock functions * 181c8f7a62cSLen Brown *****************************************************************************/ 182c8f7a62cSLen Brown /** 183c8f7a62cSLen Brown * is_dock - see if a device is a dock station 184c8f7a62cSLen Brown * @handle: acpi handle of the device 185c8f7a62cSLen Brown * 186c8f7a62cSLen Brown * If an acpi object has a _DCK method, then it is by definition a dock 187c8f7a62cSLen Brown * station, so return true. 188c8f7a62cSLen Brown */ 189c8f7a62cSLen Brown static int is_dock(acpi_handle handle) 190c8f7a62cSLen Brown { 191c8f7a62cSLen Brown acpi_status status; 192c8f7a62cSLen Brown acpi_handle tmp; 193c8f7a62cSLen Brown 194c8f7a62cSLen Brown status = acpi_get_handle(handle, "_DCK", &tmp); 195c8f7a62cSLen Brown if (ACPI_FAILURE(status)) 196c8f7a62cSLen Brown return 0; 197c8f7a62cSLen Brown return 1; 198c8f7a62cSLen Brown } 199c8f7a62cSLen Brown 200db350b08SShaohua Li static int is_ejectable(acpi_handle handle) 201db350b08SShaohua Li { 202db350b08SShaohua Li acpi_status status; 203db350b08SShaohua Li acpi_handle tmp; 204db350b08SShaohua Li 205db350b08SShaohua Li status = acpi_get_handle(handle, "_EJ0", &tmp); 206db350b08SShaohua Li if (ACPI_FAILURE(status)) 207db350b08SShaohua Li return 0; 208db350b08SShaohua Li return 1; 209db350b08SShaohua Li } 210db350b08SShaohua Li 211db350b08SShaohua Li static int is_ata(acpi_handle handle) 212db350b08SShaohua Li { 213db350b08SShaohua Li acpi_handle tmp; 214db350b08SShaohua Li 215db350b08SShaohua Li if ((ACPI_SUCCESS(acpi_get_handle(handle, "_GTF", &tmp))) || 216db350b08SShaohua Li (ACPI_SUCCESS(acpi_get_handle(handle, "_GTM", &tmp))) || 217db350b08SShaohua Li (ACPI_SUCCESS(acpi_get_handle(handle, "_STM", &tmp))) || 218db350b08SShaohua Li (ACPI_SUCCESS(acpi_get_handle(handle, "_SDD", &tmp)))) 219db350b08SShaohua Li return 1; 220db350b08SShaohua Li 221db350b08SShaohua Li return 0; 222db350b08SShaohua Li } 223db350b08SShaohua Li 224db350b08SShaohua Li static int is_battery(acpi_handle handle) 225db350b08SShaohua Li { 226db350b08SShaohua Li struct acpi_device_info *info; 227db350b08SShaohua Li int ret = 1; 228db350b08SShaohua Li 22915b8dd53SBob Moore if (!ACPI_SUCCESS(acpi_get_object_info(handle, &info))) 230db350b08SShaohua Li return 0; 231db350b08SShaohua Li if (!(info->valid & ACPI_VALID_HID)) 232db350b08SShaohua Li ret = 0; 233db350b08SShaohua Li else 23415b8dd53SBob Moore ret = !strcmp("PNP0C0A", info->hardware_id.string); 235db350b08SShaohua Li 23615b8dd53SBob Moore kfree(info); 237db350b08SShaohua Li return ret; 238db350b08SShaohua Li } 239db350b08SShaohua Li 240db350b08SShaohua Li static int is_ejectable_bay(acpi_handle handle) 241db350b08SShaohua Li { 242db350b08SShaohua Li acpi_handle phandle; 243747479a3SAlex Chiang 244db350b08SShaohua Li if (!is_ejectable(handle)) 245db350b08SShaohua Li return 0; 246db350b08SShaohua Li if (is_battery(handle) || is_ata(handle)) 247db350b08SShaohua Li return 1; 248db350b08SShaohua Li if (!acpi_get_parent(handle, &phandle) && is_ata(phandle)) 249db350b08SShaohua Li return 1; 250db350b08SShaohua Li return 0; 251db350b08SShaohua Li } 252db350b08SShaohua Li 253c8f7a62cSLen Brown /** 254c8f7a62cSLen Brown * is_dock_device - see if a device is on a dock station 255c8f7a62cSLen Brown * @handle: acpi handle of the device 256c8f7a62cSLen Brown * 257c8f7a62cSLen Brown * If this device is either the dock station itself, 258c8f7a62cSLen Brown * or is a device dependent on the dock station, then it 259c8f7a62cSLen Brown * is a dock device 260c8f7a62cSLen Brown */ 261c8f7a62cSLen Brown int is_dock_device(acpi_handle handle) 262c8f7a62cSLen Brown { 263db350b08SShaohua Li struct dock_station *dock_station; 264db350b08SShaohua Li 265db350b08SShaohua Li if (!dock_station_count) 266c8f7a62cSLen Brown return 0; 267c8f7a62cSLen Brown 268db350b08SShaohua Li if (is_dock(handle)) 269c8f7a62cSLen Brown return 1; 270747479a3SAlex Chiang 271747479a3SAlex Chiang list_for_each_entry(dock_station, &dock_stations, sibling) 272db350b08SShaohua Li if (find_dock_dependent_device(dock_station, handle)) 273db350b08SShaohua Li return 1; 274c8f7a62cSLen Brown 275c8f7a62cSLen Brown return 0; 276c8f7a62cSLen Brown } 277c8f7a62cSLen Brown EXPORT_SYMBOL_GPL(is_dock_device); 278c8f7a62cSLen Brown 279c8f7a62cSLen Brown /** 280c8f7a62cSLen Brown * dock_present - see if the dock station is present. 281c8f7a62cSLen Brown * @ds: the dock station 282c8f7a62cSLen Brown * 283c8f7a62cSLen Brown * execute the _STA method. note that present does not 284c8f7a62cSLen Brown * imply that we are docked. 285c8f7a62cSLen Brown */ 286c8f7a62cSLen Brown static int dock_present(struct dock_station *ds) 287c8f7a62cSLen Brown { 28827663c58SMatthew Wilcox unsigned long long sta; 289c8f7a62cSLen Brown acpi_status status; 290c8f7a62cSLen Brown 291c8f7a62cSLen Brown if (ds) { 292c8f7a62cSLen Brown status = acpi_evaluate_integer(ds->handle, "_STA", NULL, &sta); 293c8f7a62cSLen Brown if (ACPI_SUCCESS(status) && sta) 294c8f7a62cSLen Brown return 1; 295c8f7a62cSLen Brown } 296c8f7a62cSLen Brown return 0; 297c8f7a62cSLen Brown } 298c8f7a62cSLen Brown 299c8f7a62cSLen Brown /** 300c8f7a62cSLen Brown * dock_create_acpi_device - add new devices to acpi 301c8f7a62cSLen Brown * @handle - handle of the device to add 302c8f7a62cSLen Brown * 303c8f7a62cSLen Brown * This function will create a new acpi_device for the given 304c8f7a62cSLen Brown * handle if one does not exist already. This should cause 305c8f7a62cSLen Brown * acpi to scan for drivers for the given devices, and call 306c8f7a62cSLen Brown * matching driver's add routine. 307c8f7a62cSLen Brown * 308c8f7a62cSLen Brown * Returns a pointer to the acpi_device corresponding to the handle. 309c8f7a62cSLen Brown */ 310c8f7a62cSLen Brown static struct acpi_device * dock_create_acpi_device(acpi_handle handle) 311c8f7a62cSLen Brown { 312747479a3SAlex Chiang struct acpi_device *device; 313c8f7a62cSLen Brown int ret; 314c8f7a62cSLen Brown 315c8f7a62cSLen Brown if (acpi_bus_get_device(handle, &device)) { 316c8f7a62cSLen Brown /* 317c8f7a62cSLen Brown * no device created for this object, 318c8f7a62cSLen Brown * so we should create one. 319c8f7a62cSLen Brown */ 320636458deSRafael J. Wysocki ret = acpi_bus_add(handle, &device); 321636458deSRafael J. Wysocki if (ret) 322747479a3SAlex Chiang pr_debug("error adding bus, %x\n", -ret); 323c8f7a62cSLen Brown } 324c8f7a62cSLen Brown return device; 325c8f7a62cSLen Brown } 326c8f7a62cSLen Brown 327c8f7a62cSLen Brown /** 328c8f7a62cSLen Brown * dock_remove_acpi_device - remove the acpi_device struct from acpi 329c8f7a62cSLen Brown * @handle - the handle of the device to remove 330c8f7a62cSLen Brown * 331c8f7a62cSLen Brown * Tell acpi to remove the acpi_device. This should cause any loaded 332c8f7a62cSLen Brown * driver to have it's remove routine called. 333c8f7a62cSLen Brown */ 334c8f7a62cSLen Brown static void dock_remove_acpi_device(acpi_handle handle) 335c8f7a62cSLen Brown { 336c8f7a62cSLen Brown struct acpi_device *device; 337c8f7a62cSLen Brown int ret; 338c8f7a62cSLen Brown 339c8f7a62cSLen Brown if (!acpi_bus_get_device(handle, &device)) { 340c8f7a62cSLen Brown ret = acpi_bus_trim(device, 1); 341c8f7a62cSLen Brown if (ret) 342c8f7a62cSLen Brown pr_debug("error removing bus, %x\n", -ret); 343c8f7a62cSLen Brown } 344c8f7a62cSLen Brown } 345c8f7a62cSLen Brown 346c8f7a62cSLen Brown /** 347c8f7a62cSLen Brown * hotplug_dock_devices - insert or remove devices on the dock station 348c8f7a62cSLen Brown * @ds: the dock station 349c8f7a62cSLen Brown * @event: either bus check or eject request 350c8f7a62cSLen Brown * 351c8f7a62cSLen Brown * Some devices on the dock station need to have drivers called 352c8f7a62cSLen Brown * to perform hotplug operations after a dock event has occurred. 353c8f7a62cSLen Brown * Traverse the list of dock devices that have registered a 354c8f7a62cSLen Brown * hotplug handler, and call the handler. 355c8f7a62cSLen Brown */ 356c8f7a62cSLen Brown static void hotplug_dock_devices(struct dock_station *ds, u32 event) 357c8f7a62cSLen Brown { 358c8f7a62cSLen Brown struct dock_dependent_device *dd; 359c8f7a62cSLen Brown 3608b0dc866SKristen Carlson Accardi mutex_lock(&ds->hp_lock); 361c8f7a62cSLen Brown 362c8f7a62cSLen Brown /* 363c8f7a62cSLen Brown * First call driver specific hotplug functions 364c8f7a62cSLen Brown */ 365747479a3SAlex Chiang list_for_each_entry(dd, &ds->hotplug_devices, hotplug_list) 3661253f7aaSShaohua Li if (dd->ops && dd->ops->handler) 3671253f7aaSShaohua Li dd->ops->handler(dd->handle, event, dd->context); 368c8f7a62cSLen Brown 369c8f7a62cSLen Brown /* 370c8f7a62cSLen Brown * Now make sure that an acpi_device is created for each 371c8f7a62cSLen Brown * dependent device, or removed if this is an eject request. 372c8f7a62cSLen Brown * This will cause acpi_drivers to be stopped/started if they 373c8f7a62cSLen Brown * exist 374c8f7a62cSLen Brown */ 375c8f7a62cSLen Brown list_for_each_entry(dd, &ds->dependent_devices, list) { 376c8f7a62cSLen Brown if (event == ACPI_NOTIFY_EJECT_REQUEST) 377c8f7a62cSLen Brown dock_remove_acpi_device(dd->handle); 378c8f7a62cSLen Brown else 379c8f7a62cSLen Brown dock_create_acpi_device(dd->handle); 380c8f7a62cSLen Brown } 3818b0dc866SKristen Carlson Accardi mutex_unlock(&ds->hp_lock); 382c8f7a62cSLen Brown } 383c8f7a62cSLen Brown 384c8f7a62cSLen Brown static void dock_event(struct dock_station *ds, u32 event, int num) 385c8f7a62cSLen Brown { 386db350b08SShaohua Li struct device *dev = &ds->dock_device->dev; 38766b56821SHolger Macht char event_string[13]; 38879a8f70bSKristen Carlson Accardi char *envp[] = { event_string, NULL }; 3891253f7aaSShaohua Li struct dock_dependent_device *dd; 39079a8f70bSKristen Carlson Accardi 39179a8f70bSKristen Carlson Accardi if (num == UNDOCK_EVENT) 39266b56821SHolger Macht sprintf(event_string, "EVENT=undock"); 39379a8f70bSKristen Carlson Accardi else 39466b56821SHolger Macht sprintf(event_string, "EVENT=dock"); 39579a8f70bSKristen Carlson Accardi 3965669021eSKristen Carlson Accardi /* 3978ea86e0bSKristen Carlson Accardi * Indicate that the status of the dock station has 3988ea86e0bSKristen Carlson Accardi * changed. 3995669021eSKristen Carlson Accardi */ 4001253f7aaSShaohua Li if (num == DOCK_EVENT) 4011253f7aaSShaohua Li kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp); 4021253f7aaSShaohua Li 4031253f7aaSShaohua Li list_for_each_entry(dd, &ds->hotplug_devices, hotplug_list) 4041253f7aaSShaohua Li if (dd->ops && dd->ops->uevent) 4051253f7aaSShaohua Li dd->ops->uevent(dd->handle, event, dd->context); 406747479a3SAlex Chiang 4071253f7aaSShaohua Li if (num != DOCK_EVENT) 40879a8f70bSKristen Carlson Accardi kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp); 409c8f7a62cSLen Brown } 410c8f7a62cSLen Brown 411c8f7a62cSLen Brown /** 412c8f7a62cSLen Brown * eject_dock - respond to a dock eject request 413c8f7a62cSLen Brown * @ds: the dock station 414c8f7a62cSLen Brown * 415c8f7a62cSLen Brown * This is called after _DCK is called, to execute the dock station's 416c8f7a62cSLen Brown * _EJ0 method. 417c8f7a62cSLen Brown */ 418c8f7a62cSLen Brown static void eject_dock(struct dock_station *ds) 419c8f7a62cSLen Brown { 420c8f7a62cSLen Brown struct acpi_object_list arg_list; 421c8f7a62cSLen Brown union acpi_object arg; 422c8f7a62cSLen Brown acpi_status status; 423c8f7a62cSLen Brown acpi_handle tmp; 424c8f7a62cSLen Brown 425c8f7a62cSLen Brown /* all dock devices should have _EJ0, but check anyway */ 426c8f7a62cSLen Brown status = acpi_get_handle(ds->handle, "_EJ0", &tmp); 427c8f7a62cSLen Brown if (ACPI_FAILURE(status)) { 428c8f7a62cSLen Brown pr_debug("No _EJ0 support for dock device\n"); 429c8f7a62cSLen Brown return; 430c8f7a62cSLen Brown } 431c8f7a62cSLen Brown 432c8f7a62cSLen Brown arg_list.count = 1; 433c8f7a62cSLen Brown arg_list.pointer = &arg; 434c8f7a62cSLen Brown arg.type = ACPI_TYPE_INTEGER; 435c8f7a62cSLen Brown arg.integer.value = 1; 436c8f7a62cSLen Brown 437747479a3SAlex Chiang status = acpi_evaluate_object(ds->handle, "_EJ0", &arg_list, NULL); 438747479a3SAlex Chiang if (ACPI_FAILURE(status)) 439c8f7a62cSLen Brown pr_debug("Failed to evaluate _EJ0!\n"); 440c8f7a62cSLen Brown } 441c8f7a62cSLen Brown 442c8f7a62cSLen Brown /** 443c8f7a62cSLen Brown * handle_dock - handle a dock event 444c8f7a62cSLen Brown * @ds: the dock station 445c8f7a62cSLen Brown * @dock: to dock, or undock - that is the question 446c8f7a62cSLen Brown * 447c8f7a62cSLen Brown * Execute the _DCK method in response to an acpi event 448c8f7a62cSLen Brown */ 449c8f7a62cSLen Brown static void handle_dock(struct dock_station *ds, int dock) 450c8f7a62cSLen Brown { 451c8f7a62cSLen Brown acpi_status status; 452c8f7a62cSLen Brown struct acpi_object_list arg_list; 453c8f7a62cSLen Brown union acpi_object arg; 454c8f7a62cSLen Brown struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL }; 455c8f7a62cSLen Brown 456cd73018fSToshi Kani acpi_handle_info(ds->handle, "%s\n", dock ? "docking" : "undocking"); 457c8f7a62cSLen Brown 458c8f7a62cSLen Brown /* _DCK method has one argument */ 459c8f7a62cSLen Brown arg_list.count = 1; 460c8f7a62cSLen Brown arg_list.pointer = &arg; 461c8f7a62cSLen Brown arg.type = ACPI_TYPE_INTEGER; 462c8f7a62cSLen Brown arg.integer.value = dock; 463c8f7a62cSLen Brown status = acpi_evaluate_object(ds->handle, "_DCK", &arg_list, &buffer); 464db350b08SShaohua Li if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) 465cd73018fSToshi Kani acpi_handle_err(ds->handle, "Failed to execute _DCK (0x%x)\n", 466cd73018fSToshi Kani status); 4670a918a94SThomas Renninger 468c8f7a62cSLen Brown kfree(buffer.pointer); 469c8f7a62cSLen Brown } 470c8f7a62cSLen Brown 471c8f7a62cSLen Brown static inline void dock(struct dock_station *ds) 472c8f7a62cSLen Brown { 473c8f7a62cSLen Brown handle_dock(ds, 1); 474c8f7a62cSLen Brown } 475c8f7a62cSLen Brown 476c8f7a62cSLen Brown static inline void undock(struct dock_station *ds) 477c8f7a62cSLen Brown { 478c8f7a62cSLen Brown handle_dock(ds, 0); 479c8f7a62cSLen Brown } 480c8f7a62cSLen Brown 481c8f7a62cSLen Brown static inline void begin_dock(struct dock_station *ds) 482c8f7a62cSLen Brown { 483c8f7a62cSLen Brown ds->flags |= DOCK_DOCKING; 484c8f7a62cSLen Brown } 485c8f7a62cSLen Brown 486c8f7a62cSLen Brown static inline void complete_dock(struct dock_station *ds) 487c8f7a62cSLen Brown { 488c8f7a62cSLen Brown ds->flags &= ~(DOCK_DOCKING); 489c8f7a62cSLen Brown ds->last_dock_time = jiffies; 490c8f7a62cSLen Brown } 491c8f7a62cSLen Brown 492a0cd35fdSKristen Carlson Accardi static inline void begin_undock(struct dock_station *ds) 493a0cd35fdSKristen Carlson Accardi { 494a0cd35fdSKristen Carlson Accardi ds->flags |= DOCK_UNDOCKING; 495a0cd35fdSKristen Carlson Accardi } 496a0cd35fdSKristen Carlson Accardi 497a0cd35fdSKristen Carlson Accardi static inline void complete_undock(struct dock_station *ds) 498a0cd35fdSKristen Carlson Accardi { 499a0cd35fdSKristen Carlson Accardi ds->flags &= ~(DOCK_UNDOCKING); 500a0cd35fdSKristen Carlson Accardi } 501a0cd35fdSKristen Carlson Accardi 502406f692dSShaohua Li static void dock_lock(struct dock_station *ds, int lock) 503406f692dSShaohua Li { 504406f692dSShaohua Li struct acpi_object_list arg_list; 505406f692dSShaohua Li union acpi_object arg; 506406f692dSShaohua Li acpi_status status; 507406f692dSShaohua Li 508406f692dSShaohua Li arg_list.count = 1; 509406f692dSShaohua Li arg_list.pointer = &arg; 510406f692dSShaohua Li arg.type = ACPI_TYPE_INTEGER; 511406f692dSShaohua Li arg.integer.value = !!lock; 512406f692dSShaohua Li status = acpi_evaluate_object(ds->handle, "_LCK", &arg_list, NULL); 513406f692dSShaohua Li if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) { 514406f692dSShaohua Li if (lock) 515cd73018fSToshi Kani acpi_handle_warn(ds->handle, 516cd73018fSToshi Kani "Locking device failed (0x%x)\n", status); 517406f692dSShaohua Li else 518cd73018fSToshi Kani acpi_handle_warn(ds->handle, 519cd73018fSToshi Kani "Unlocking device failed (0x%x)\n", status); 520406f692dSShaohua Li } 521406f692dSShaohua Li } 522406f692dSShaohua Li 523c8f7a62cSLen Brown /** 524c8f7a62cSLen Brown * dock_in_progress - see if we are in the middle of handling a dock event 525c8f7a62cSLen Brown * @ds: the dock station 526c8f7a62cSLen Brown * 527c8f7a62cSLen Brown * Sometimes while docking, false dock events can be sent to the driver 528c8f7a62cSLen Brown * because good connections aren't made or some other reason. Ignore these 529c8f7a62cSLen Brown * if we are in the middle of doing something. 530c8f7a62cSLen Brown */ 531c8f7a62cSLen Brown static int dock_in_progress(struct dock_station *ds) 532c8f7a62cSLen Brown { 533c8f7a62cSLen Brown if ((ds->flags & DOCK_DOCKING) || 534c8f7a62cSLen Brown time_before(jiffies, (ds->last_dock_time + HZ))) 535c8f7a62cSLen Brown return 1; 536c8f7a62cSLen Brown return 0; 537c8f7a62cSLen Brown } 538c8f7a62cSLen Brown 539c8f7a62cSLen Brown /** 540c8f7a62cSLen Brown * register_dock_notifier - add yourself to the dock notifier list 541c8f7a62cSLen Brown * @nb: the callers notifier block 542c8f7a62cSLen Brown * 543c8f7a62cSLen Brown * If a driver wishes to be notified about dock events, they can 544c8f7a62cSLen Brown * use this function to put a notifier block on the dock notifier list. 545c8f7a62cSLen Brown * this notifier call chain will be called after a dock event, but 546c8f7a62cSLen Brown * before hotplugging any new devices. 547c8f7a62cSLen Brown */ 548c8f7a62cSLen Brown int register_dock_notifier(struct notifier_block *nb) 549c8f7a62cSLen Brown { 550db350b08SShaohua Li if (!dock_station_count) 5512548c06bSPrarit Bhargava return -ENODEV; 5522548c06bSPrarit Bhargava 553c8f7a62cSLen Brown return atomic_notifier_chain_register(&dock_notifier_list, nb); 554c8f7a62cSLen Brown } 555c8f7a62cSLen Brown EXPORT_SYMBOL_GPL(register_dock_notifier); 556c8f7a62cSLen Brown 557c8f7a62cSLen Brown /** 558c8f7a62cSLen Brown * unregister_dock_notifier - remove yourself from the dock notifier list 559c8f7a62cSLen Brown * @nb: the callers notifier block 560c8f7a62cSLen Brown */ 561c8f7a62cSLen Brown void unregister_dock_notifier(struct notifier_block *nb) 562c8f7a62cSLen Brown { 563db350b08SShaohua Li if (!dock_station_count) 5642548c06bSPrarit Bhargava return; 5652548c06bSPrarit Bhargava 566c8f7a62cSLen Brown atomic_notifier_chain_unregister(&dock_notifier_list, nb); 567c8f7a62cSLen Brown } 568c8f7a62cSLen Brown EXPORT_SYMBOL_GPL(unregister_dock_notifier); 569c8f7a62cSLen Brown 570c8f7a62cSLen Brown /** 571c8f7a62cSLen Brown * register_hotplug_dock_device - register a hotplug function 572c8f7a62cSLen Brown * @handle: the handle of the device 5731253f7aaSShaohua Li * @ops: handlers to call after docking 574c8f7a62cSLen Brown * @context: device specific data 575c8f7a62cSLen Brown * 576c8f7a62cSLen Brown * If a driver would like to perform a hotplug operation after a dock 577c8f7a62cSLen Brown * event, they can register an acpi_notifiy_handler to be called by 578c8f7a62cSLen Brown * the dock driver after _DCK is executed. 579c8f7a62cSLen Brown */ 580c8f7a62cSLen Brown int 5819c8b04beSVasiliy Kulikov register_hotplug_dock_device(acpi_handle handle, const struct acpi_dock_ops *ops, 582c8f7a62cSLen Brown void *context) 583c8f7a62cSLen Brown { 584c8f7a62cSLen Brown struct dock_dependent_device *dd; 585db350b08SShaohua Li struct dock_station *dock_station; 58661b83695SShaohua Li int ret = -EINVAL; 587c8f7a62cSLen Brown 588db350b08SShaohua Li if (!dock_station_count) 589c8f7a62cSLen Brown return -ENODEV; 590c8f7a62cSLen Brown 591c8f7a62cSLen Brown /* 592c8f7a62cSLen Brown * make sure this handle is for a device dependent on the dock, 593c8f7a62cSLen Brown * this would include the dock station itself 594c8f7a62cSLen Brown */ 59550d716e4SAlex Chiang list_for_each_entry(dock_station, &dock_stations, sibling) { 59661b83695SShaohua Li /* 59761b83695SShaohua Li * An ATA bay can be in a dock and itself can be ejected 5983ad2f3fbSDaniel Mack * separately, so there are two 'dock stations' which need the 59961b83695SShaohua Li * ops 60061b83695SShaohua Li */ 601c8f7a62cSLen Brown dd = find_dock_dependent_device(dock_station, handle); 602c8f7a62cSLen Brown if (dd) { 6031253f7aaSShaohua Li dd->ops = ops; 604c8f7a62cSLen Brown dd->context = context; 605c8f7a62cSLen Brown dock_add_hotplug_device(dock_station, dd); 60661b83695SShaohua Li ret = 0; 607c8f7a62cSLen Brown } 608db350b08SShaohua Li } 609c8f7a62cSLen Brown 61061b83695SShaohua Li return ret; 611c8f7a62cSLen Brown } 612c8f7a62cSLen Brown EXPORT_SYMBOL_GPL(register_hotplug_dock_device); 613c8f7a62cSLen Brown 614c8f7a62cSLen Brown /** 615c8f7a62cSLen Brown * unregister_hotplug_dock_device - remove yourself from the hotplug list 616c8f7a62cSLen Brown * @handle: the acpi handle of the device 617c8f7a62cSLen Brown */ 618c8f7a62cSLen Brown void unregister_hotplug_dock_device(acpi_handle handle) 619c8f7a62cSLen Brown { 620c8f7a62cSLen Brown struct dock_dependent_device *dd; 621db350b08SShaohua Li struct dock_station *dock_station; 622c8f7a62cSLen Brown 623db350b08SShaohua Li if (!dock_station_count) 624c8f7a62cSLen Brown return; 625c8f7a62cSLen Brown 62650d716e4SAlex Chiang list_for_each_entry(dock_station, &dock_stations, sibling) { 627c8f7a62cSLen Brown dd = find_dock_dependent_device(dock_station, handle); 628c8f7a62cSLen Brown if (dd) 629c8f7a62cSLen Brown dock_del_hotplug_device(dock_station, dd); 630c8f7a62cSLen Brown } 631db350b08SShaohua Li } 632c8f7a62cSLen Brown EXPORT_SYMBOL_GPL(unregister_hotplug_dock_device); 633c8f7a62cSLen Brown 634c8f7a62cSLen Brown /** 635c80fdbe8Sbrandon@ifup.org * handle_eject_request - handle an undock request checking for error conditions 636c80fdbe8Sbrandon@ifup.org * 637c80fdbe8Sbrandon@ifup.org * Check to make sure the dock device is still present, then undock and 638c80fdbe8Sbrandon@ifup.org * hotremove all the devices that may need removing. 639c80fdbe8Sbrandon@ifup.org */ 640c80fdbe8Sbrandon@ifup.org static int handle_eject_request(struct dock_station *ds, u32 event) 641c80fdbe8Sbrandon@ifup.org { 642c80fdbe8Sbrandon@ifup.org if (dock_in_progress(ds)) 643c80fdbe8Sbrandon@ifup.org return -EBUSY; 644c80fdbe8Sbrandon@ifup.org 645c80fdbe8Sbrandon@ifup.org /* 646c80fdbe8Sbrandon@ifup.org * here we need to generate the undock 647c80fdbe8Sbrandon@ifup.org * event prior to actually doing the undock 648c80fdbe8Sbrandon@ifup.org * so that the device struct still exists. 649afd7301dSHolger Macht * Also, even send the dock event if the 650afd7301dSHolger Macht * device is not present anymore 651c80fdbe8Sbrandon@ifup.org */ 652c80fdbe8Sbrandon@ifup.org dock_event(ds, event, UNDOCK_EVENT); 653afd7301dSHolger Macht 654c80fdbe8Sbrandon@ifup.org hotplug_dock_devices(ds, ACPI_NOTIFY_EJECT_REQUEST); 655c80fdbe8Sbrandon@ifup.org undock(ds); 656406f692dSShaohua Li dock_lock(ds, 0); 657c80fdbe8Sbrandon@ifup.org eject_dock(ds); 658c80fdbe8Sbrandon@ifup.org if (dock_present(ds)) { 659cd73018fSToshi Kani acpi_handle_err(ds->handle, "Unable to undock!\n"); 660c80fdbe8Sbrandon@ifup.org return -EBUSY; 661c80fdbe8Sbrandon@ifup.org } 662a0cd35fdSKristen Carlson Accardi complete_undock(ds); 663c80fdbe8Sbrandon@ifup.org return 0; 664c80fdbe8Sbrandon@ifup.org } 665c80fdbe8Sbrandon@ifup.org 666c80fdbe8Sbrandon@ifup.org /** 667c8f7a62cSLen Brown * dock_notify - act upon an acpi dock notification 668c8f7a62cSLen Brown * @handle: the dock station handle 669c8f7a62cSLen Brown * @event: the acpi event 670c8f7a62cSLen Brown * @data: our driver data struct 671c8f7a62cSLen Brown * 672c8f7a62cSLen Brown * If we are notified to dock, then check to see if the dock is 673c8f7a62cSLen Brown * present and then dock. Notify all drivers of the dock event, 674c80fdbe8Sbrandon@ifup.org * and then hotplug and devices that may need hotplugging. 675c8f7a62cSLen Brown */ 676c8f7a62cSLen Brown static void dock_notify(acpi_handle handle, u32 event, void *data) 677c8f7a62cSLen Brown { 67850dd0969SJan Engelhardt struct dock_station *ds = data; 6798b59560aSShaohua Li struct acpi_device *tmp; 680db350b08SShaohua Li int surprise_removal = 0; 681c8f7a62cSLen Brown 682db350b08SShaohua Li /* 683db350b08SShaohua Li * According to acpi spec 3.0a, if a DEVICE_CHECK notification 684db350b08SShaohua Li * is sent and _DCK is present, it is assumed to mean an undock 685db350b08SShaohua Li * request. 686db350b08SShaohua Li */ 687db350b08SShaohua Li if ((ds->flags & DOCK_IS_DOCK) && event == ACPI_NOTIFY_DEVICE_CHECK) 688db350b08SShaohua Li event = ACPI_NOTIFY_EJECT_REQUEST; 689db350b08SShaohua Li 690db350b08SShaohua Li /* 691db350b08SShaohua Li * dock station: BUS_CHECK - docked or surprise removal 692db350b08SShaohua Li * DEVICE_CHECK - undocked 693db350b08SShaohua Li * other device: BUS_CHECK/DEVICE_CHECK - added or surprise removal 694db350b08SShaohua Li * 695db350b08SShaohua Li * To simplify event handling, dock dependent device handler always 696db350b08SShaohua Li * get ACPI_NOTIFY_BUS_CHECK/ACPI_NOTIFY_DEVICE_CHECK for add and 697db350b08SShaohua Li * ACPI_NOTIFY_EJECT_REQUEST for removal 698db350b08SShaohua Li */ 699c8f7a62cSLen Brown switch (event) { 700c8f7a62cSLen Brown case ACPI_NOTIFY_BUS_CHECK: 701db350b08SShaohua Li case ACPI_NOTIFY_DEVICE_CHECK: 7028b59560aSShaohua Li if (!dock_in_progress(ds) && acpi_bus_get_device(ds->handle, 7038b59560aSShaohua Li &tmp)) { 704c8f7a62cSLen Brown begin_dock(ds); 705c8f7a62cSLen Brown dock(ds); 706c8f7a62cSLen Brown if (!dock_present(ds)) { 707cd73018fSToshi Kani acpi_handle_err(handle, "Unable to dock!\n"); 7088b59560aSShaohua Li complete_dock(ds); 709c8f7a62cSLen Brown break; 710c8f7a62cSLen Brown } 711c8f7a62cSLen Brown atomic_notifier_call_chain(&dock_notifier_list, 712c8f7a62cSLen Brown event, NULL); 713c8f7a62cSLen Brown hotplug_dock_devices(ds, event); 714c8f7a62cSLen Brown complete_dock(ds); 715c8f7a62cSLen Brown dock_event(ds, event, DOCK_EVENT); 716406f692dSShaohua Li dock_lock(ds, 1); 7173a37898dSLin Ming acpi_update_all_gpes(); 718c8f7a62cSLen Brown break; 719db350b08SShaohua Li } 720db350b08SShaohua Li if (dock_present(ds) || dock_in_progress(ds)) 721db350b08SShaohua Li break; 722db350b08SShaohua Li /* This is a surprise removal */ 723db350b08SShaohua Li surprise_removal = 1; 724db350b08SShaohua Li event = ACPI_NOTIFY_EJECT_REQUEST; 725db350b08SShaohua Li /* Fall back */ 726c8f7a62cSLen Brown case ACPI_NOTIFY_EJECT_REQUEST: 727a0cd35fdSKristen Carlson Accardi begin_undock(ds); 728f730ae18SShaohua Li if ((immediate_undock && !(ds->flags & DOCK_IS_ATA)) 729f730ae18SShaohua Li || surprise_removal) 730c80fdbe8Sbrandon@ifup.org handle_eject_request(ds, event); 731a0cd35fdSKristen Carlson Accardi else 732a0cd35fdSKristen Carlson Accardi dock_event(ds, event, UNDOCK_EVENT); 733c8f7a62cSLen Brown break; 734c8f7a62cSLen Brown default: 735cd73018fSToshi Kani acpi_handle_err(handle, "Unknown dock event %d\n", event); 736c8f7a62cSLen Brown } 737c8f7a62cSLen Brown } 738c8f7a62cSLen Brown 73919cd847aSZhang Rui struct dock_data { 74019cd847aSZhang Rui acpi_handle handle; 74119cd847aSZhang Rui unsigned long event; 74219cd847aSZhang Rui struct dock_station *ds; 74319cd847aSZhang Rui }; 74419cd847aSZhang Rui 74519cd847aSZhang Rui static void acpi_dock_deferred_cb(void *context) 74619cd847aSZhang Rui { 747747479a3SAlex Chiang struct dock_data *data = context; 74819cd847aSZhang Rui 74919cd847aSZhang Rui dock_notify(data->handle, data->event, data->ds); 75019cd847aSZhang Rui kfree(data); 75119cd847aSZhang Rui } 75219cd847aSZhang Rui 7536bd00a61SShaohua Li static int acpi_dock_notifier_call(struct notifier_block *this, 7546bd00a61SShaohua Li unsigned long event, void *data) 7556bd00a61SShaohua Li { 7566bd00a61SShaohua Li struct dock_station *dock_station; 757747479a3SAlex Chiang acpi_handle handle = data; 7586bd00a61SShaohua Li 7596bd00a61SShaohua Li if (event != ACPI_NOTIFY_BUS_CHECK && event != ACPI_NOTIFY_DEVICE_CHECK 7606bd00a61SShaohua Li && event != ACPI_NOTIFY_EJECT_REQUEST) 7616bd00a61SShaohua Li return 0; 76250d716e4SAlex Chiang list_for_each_entry(dock_station, &dock_stations, sibling) { 7636bd00a61SShaohua Li if (dock_station->handle == handle) { 764747479a3SAlex Chiang struct dock_data *dd; 76519cd847aSZhang Rui 766747479a3SAlex Chiang dd = kmalloc(sizeof(*dd), GFP_KERNEL); 767747479a3SAlex Chiang if (!dd) 76819cd847aSZhang Rui return 0; 769747479a3SAlex Chiang dd->handle = handle; 770747479a3SAlex Chiang dd->event = event; 771747479a3SAlex Chiang dd->ds = dock_station; 772747479a3SAlex Chiang acpi_os_hotplug_execute(acpi_dock_deferred_cb, dd); 7736bd00a61SShaohua Li return 0 ; 7746bd00a61SShaohua Li } 7756bd00a61SShaohua Li } 7766bd00a61SShaohua Li return 0; 7776bd00a61SShaohua Li } 7786bd00a61SShaohua Li 7796bd00a61SShaohua Li static struct notifier_block dock_acpi_notifier = { 7806bd00a61SShaohua Li .notifier_call = acpi_dock_notifier_call, 7816bd00a61SShaohua Li }; 7826bd00a61SShaohua Li 783c8f7a62cSLen Brown /** 784c8f7a62cSLen Brown * find_dock_devices - find devices on the dock station 785c8f7a62cSLen Brown * @handle: the handle of the device we are examining 786c8f7a62cSLen Brown * @lvl: unused 787c8f7a62cSLen Brown * @context: the dock station private data 788c8f7a62cSLen Brown * @rv: unused 789c8f7a62cSLen Brown * 790c8f7a62cSLen Brown * This function is called by acpi_walk_namespace. It will 791c8f7a62cSLen Brown * check to see if an object has an _EJD method. If it does, then it 792c8f7a62cSLen Brown * will see if it is dependent on the dock station. 793c8f7a62cSLen Brown */ 794c8f7a62cSLen Brown static acpi_status 795c8f7a62cSLen Brown find_dock_devices(acpi_handle handle, u32 lvl, void *context, void **rv) 796c8f7a62cSLen Brown { 797c8f7a62cSLen Brown acpi_status status; 798fe9a2f77SKristen Carlson Accardi acpi_handle tmp, parent; 79950dd0969SJan Engelhardt struct dock_station *ds = context; 800c8f7a62cSLen Brown 801c8f7a62cSLen Brown status = acpi_bus_get_ejd(handle, &tmp); 802fe9a2f77SKristen Carlson Accardi if (ACPI_FAILURE(status)) { 803fe9a2f77SKristen Carlson Accardi /* try the parent device as well */ 804fe9a2f77SKristen Carlson Accardi status = acpi_get_parent(handle, &parent); 805c8f7a62cSLen Brown if (ACPI_FAILURE(status)) 806fe9a2f77SKristen Carlson Accardi goto fdd_out; 807fe9a2f77SKristen Carlson Accardi /* see if parent is dependent on dock */ 808fe9a2f77SKristen Carlson Accardi status = acpi_bus_get_ejd(parent, &tmp); 809fe9a2f77SKristen Carlson Accardi if (ACPI_FAILURE(status)) 810fe9a2f77SKristen Carlson Accardi goto fdd_out; 811fe9a2f77SKristen Carlson Accardi } 812c8f7a62cSLen Brown 813f69cfdd2SAlex Chiang if (tmp == ds->handle) 814f69cfdd2SAlex Chiang add_dock_dependent_device(ds, handle); 815f69cfdd2SAlex Chiang 816fe9a2f77SKristen Carlson Accardi fdd_out: 817c8f7a62cSLen Brown return AE_OK; 818c8f7a62cSLen Brown } 819c8f7a62cSLen Brown 820c80fdbe8Sbrandon@ifup.org /* 821c80fdbe8Sbrandon@ifup.org * show_docked - read method for "docked" file in sysfs 822c80fdbe8Sbrandon@ifup.org */ 823c80fdbe8Sbrandon@ifup.org static ssize_t show_docked(struct device *dev, 824c80fdbe8Sbrandon@ifup.org struct device_attribute *attr, char *buf) 825c80fdbe8Sbrandon@ifup.org { 826fc5a9f88SHolger Macht struct acpi_device *tmp; 827fc5a9f88SHolger Macht 828fe06fba2SAlex Chiang struct dock_station *dock_station = dev->platform_data; 829c80fdbe8Sbrandon@ifup.org 830fc5a9f88SHolger Macht if (ACPI_SUCCESS(acpi_bus_get_device(dock_station->handle, &tmp))) 831fc5a9f88SHolger Macht return snprintf(buf, PAGE_SIZE, "1\n"); 832fc5a9f88SHolger Macht return snprintf(buf, PAGE_SIZE, "0\n"); 833c80fdbe8Sbrandon@ifup.org } 834e5685b9dSAdrian Bunk static DEVICE_ATTR(docked, S_IRUGO, show_docked, NULL); 835c80fdbe8Sbrandon@ifup.org 836c80fdbe8Sbrandon@ifup.org /* 837a0cd35fdSKristen Carlson Accardi * show_flags - read method for flags file in sysfs 838a0cd35fdSKristen Carlson Accardi */ 839a0cd35fdSKristen Carlson Accardi static ssize_t show_flags(struct device *dev, 840a0cd35fdSKristen Carlson Accardi struct device_attribute *attr, char *buf) 841a0cd35fdSKristen Carlson Accardi { 842fe06fba2SAlex Chiang struct dock_station *dock_station = dev->platform_data; 843a0cd35fdSKristen Carlson Accardi return snprintf(buf, PAGE_SIZE, "%d\n", dock_station->flags); 844a0cd35fdSKristen Carlson Accardi 845a0cd35fdSKristen Carlson Accardi } 846e5685b9dSAdrian Bunk static DEVICE_ATTR(flags, S_IRUGO, show_flags, NULL); 847a0cd35fdSKristen Carlson Accardi 848a0cd35fdSKristen Carlson Accardi /* 849c80fdbe8Sbrandon@ifup.org * write_undock - write method for "undock" file in sysfs 850c80fdbe8Sbrandon@ifup.org */ 851c80fdbe8Sbrandon@ifup.org static ssize_t write_undock(struct device *dev, struct device_attribute *attr, 852c80fdbe8Sbrandon@ifup.org const char *buf, size_t count) 853c80fdbe8Sbrandon@ifup.org { 854c80fdbe8Sbrandon@ifup.org int ret; 855fe06fba2SAlex Chiang struct dock_station *dock_station = dev->platform_data; 856c80fdbe8Sbrandon@ifup.org 857c80fdbe8Sbrandon@ifup.org if (!count) 858c80fdbe8Sbrandon@ifup.org return -EINVAL; 859c80fdbe8Sbrandon@ifup.org 8609171f834SHolger Macht begin_undock(dock_station); 861c80fdbe8Sbrandon@ifup.org ret = handle_eject_request(dock_station, ACPI_NOTIFY_EJECT_REQUEST); 862c80fdbe8Sbrandon@ifup.org return ret ? ret: count; 863c80fdbe8Sbrandon@ifup.org } 864e5685b9dSAdrian Bunk static DEVICE_ATTR(undock, S_IWUSR, NULL, write_undock); 865c80fdbe8Sbrandon@ifup.org 866ac122bb6SIlya A. Volynets-Evenbakh /* 867ac122bb6SIlya A. Volynets-Evenbakh * show_dock_uid - read method for "uid" file in sysfs 868ac122bb6SIlya A. Volynets-Evenbakh */ 869ac122bb6SIlya A. Volynets-Evenbakh static ssize_t show_dock_uid(struct device *dev, 870ac122bb6SIlya A. Volynets-Evenbakh struct device_attribute *attr, char *buf) 871ac122bb6SIlya A. Volynets-Evenbakh { 87227663c58SMatthew Wilcox unsigned long long lbuf; 873fe06fba2SAlex Chiang struct dock_station *dock_station = dev->platform_data; 87438ff4ffcSKristen Carlson Accardi acpi_status status = acpi_evaluate_integer(dock_station->handle, 87538ff4ffcSKristen Carlson Accardi "_UID", NULL, &lbuf); 87638ff4ffcSKristen Carlson Accardi if (ACPI_FAILURE(status)) 877ac122bb6SIlya A. Volynets-Evenbakh return 0; 87838ff4ffcSKristen Carlson Accardi 87927663c58SMatthew Wilcox return snprintf(buf, PAGE_SIZE, "%llx\n", lbuf); 880ac122bb6SIlya A. Volynets-Evenbakh } 881e5685b9dSAdrian Bunk static DEVICE_ATTR(uid, S_IRUGO, show_dock_uid, NULL); 882ac122bb6SIlya A. Volynets-Evenbakh 8838652b00fSShaohua Li static ssize_t show_dock_type(struct device *dev, 8848652b00fSShaohua Li struct device_attribute *attr, char *buf) 8858652b00fSShaohua Li { 886fe06fba2SAlex Chiang struct dock_station *dock_station = dev->platform_data; 8878652b00fSShaohua Li char *type; 8888652b00fSShaohua Li 8898652b00fSShaohua Li if (dock_station->flags & DOCK_IS_DOCK) 8908652b00fSShaohua Li type = "dock_station"; 8918652b00fSShaohua Li else if (dock_station->flags & DOCK_IS_ATA) 8928652b00fSShaohua Li type = "ata_bay"; 8938652b00fSShaohua Li else if (dock_station->flags & DOCK_IS_BAT) 8948652b00fSShaohua Li type = "battery_bay"; 8958652b00fSShaohua Li else 8968652b00fSShaohua Li type = "unknown"; 8978652b00fSShaohua Li 8988652b00fSShaohua Li return snprintf(buf, PAGE_SIZE, "%s\n", type); 8998652b00fSShaohua Li } 9008652b00fSShaohua Li static DEVICE_ATTR(type, S_IRUGO, show_dock_type, NULL); 9018652b00fSShaohua Li 9025f46c2f2SAlex Chiang static struct attribute *dock_attributes[] = { 9035f46c2f2SAlex Chiang &dev_attr_docked.attr, 9045f46c2f2SAlex Chiang &dev_attr_flags.attr, 9055f46c2f2SAlex Chiang &dev_attr_undock.attr, 9065f46c2f2SAlex Chiang &dev_attr_uid.attr, 9075f46c2f2SAlex Chiang &dev_attr_type.attr, 9085f46c2f2SAlex Chiang NULL 9095f46c2f2SAlex Chiang }; 9105f46c2f2SAlex Chiang 9115f46c2f2SAlex Chiang static struct attribute_group dock_attribute_group = { 9125f46c2f2SAlex Chiang .attrs = dock_attributes 9135f46c2f2SAlex Chiang }; 9145f46c2f2SAlex Chiang 915c8f7a62cSLen Brown /** 916c8f7a62cSLen Brown * dock_add - add a new dock station 917c8f7a62cSLen Brown * @handle: the dock station handle 918c8f7a62cSLen Brown * 919c8f7a62cSLen Brown * allocated and initialize a new dock station device. Find all devices 920c8f7a62cSLen Brown * that are on the dock station, and register for dock event notifications. 921c8f7a62cSLen Brown */ 922d38a5edfSUwe Kleine-König static int __init dock_add(acpi_handle handle) 923c8f7a62cSLen Brown { 924fe06fba2SAlex Chiang int ret, id; 925fe06fba2SAlex Chiang struct dock_station ds, *dock_station; 926747479a3SAlex Chiang struct platform_device *dd; 927c8f7a62cSLen Brown 928fe06fba2SAlex Chiang id = dock_station_count; 92949c6fb2eSAlex Chiang memset(&ds, 0, sizeof(ds)); 930747479a3SAlex Chiang dd = platform_device_register_data(NULL, "dock", id, &ds, sizeof(ds)); 931747479a3SAlex Chiang if (IS_ERR(dd)) 932747479a3SAlex Chiang return PTR_ERR(dd); 9339751cb72SAlex Chiang 934747479a3SAlex Chiang dock_station = dd->dev.platform_data; 935747479a3SAlex Chiang 936c8f7a62cSLen Brown dock_station->handle = handle; 937747479a3SAlex Chiang dock_station->dock_device = dd; 938c8f7a62cSLen Brown dock_station->last_dock_time = jiffies - HZ; 939c8f7a62cSLen Brown 940c8f7a62cSLen Brown mutex_init(&dock_station->hp_lock); 941747479a3SAlex Chiang spin_lock_init(&dock_station->dd_lock); 942747479a3SAlex Chiang INIT_LIST_HEAD(&dock_station->sibling); 943747479a3SAlex Chiang INIT_LIST_HEAD(&dock_station->hotplug_devices); 944c8f7a62cSLen Brown ATOMIC_INIT_NOTIFIER_HEAD(&dock_notifier_list); 945747479a3SAlex Chiang INIT_LIST_HEAD(&dock_station->dependent_devices); 946a0cd35fdSKristen Carlson Accardi 9479ef2a9a9SKristen Carlson Accardi /* we want the dock device to send uevents */ 948747479a3SAlex Chiang dev_set_uevent_suppress(&dd->dev, 0); 9499ef2a9a9SKristen Carlson Accardi 950db350b08SShaohua Li if (is_dock(handle)) 951db350b08SShaohua Li dock_station->flags |= DOCK_IS_DOCK; 952db350b08SShaohua Li if (is_ata(handle)) 953db350b08SShaohua Li dock_station->flags |= DOCK_IS_ATA; 954db350b08SShaohua Li if (is_battery(handle)) 955db350b08SShaohua Li dock_station->flags |= DOCK_IS_BAT; 956db350b08SShaohua Li 957747479a3SAlex Chiang ret = sysfs_create_group(&dd->dev.kobj, &dock_attribute_group); 9588652b00fSShaohua Li if (ret) 9595f46c2f2SAlex Chiang goto err_unregister; 960671adbecSKristen Carlson Accardi 961c8f7a62cSLen Brown /* Find dependent devices */ 962c8f7a62cSLen Brown acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT, 9632263576cSLin Ming ACPI_UINT32_MAX, find_dock_devices, NULL, 9642263576cSLin Ming dock_station, NULL); 965c8f7a62cSLen Brown 966c8f7a62cSLen Brown /* add the dock station as a device dependent on itself */ 967f69cfdd2SAlex Chiang ret = add_dock_dependent_device(dock_station, handle); 968f69cfdd2SAlex Chiang if (ret) 9695f46c2f2SAlex Chiang goto err_rmgroup; 970c8f7a62cSLen Brown 971db350b08SShaohua Li dock_station_count++; 97250d716e4SAlex Chiang list_add(&dock_station->sibling, &dock_stations); 973c8f7a62cSLen Brown return 0; 974c8f7a62cSLen Brown 9755f46c2f2SAlex Chiang err_rmgroup: 976747479a3SAlex Chiang sysfs_remove_group(&dd->dev.kobj, &dock_attribute_group); 9775f46c2f2SAlex Chiang err_unregister: 978747479a3SAlex Chiang platform_device_unregister(dd); 979cd73018fSToshi Kani acpi_handle_err(handle, "%s encountered error %d\n", __func__, ret); 980c8f7a62cSLen Brown return ret; 981c8f7a62cSLen Brown } 982c8f7a62cSLen Brown 983c8f7a62cSLen Brown /** 984c8f7a62cSLen Brown * dock_remove - free up resources related to the dock station 985c8f7a62cSLen Brown */ 986747479a3SAlex Chiang static int dock_remove(struct dock_station *ds) 987c8f7a62cSLen Brown { 988c8f7a62cSLen Brown struct dock_dependent_device *dd, *tmp; 989747479a3SAlex Chiang struct platform_device *dock_device = ds->dock_device; 990c8f7a62cSLen Brown 991db350b08SShaohua Li if (!dock_station_count) 992c8f7a62cSLen Brown return 0; 993c8f7a62cSLen Brown 994c8f7a62cSLen Brown /* remove dependent devices */ 995747479a3SAlex Chiang list_for_each_entry_safe(dd, tmp, &ds->dependent_devices, list) 996c8f7a62cSLen Brown kfree(dd); 997c8f7a62cSLen Brown 998747479a3SAlex Chiang list_del(&ds->sibling); 999fe06fba2SAlex Chiang 1000671adbecSKristen Carlson Accardi /* cleanup sysfs */ 10015f46c2f2SAlex Chiang sysfs_remove_group(&dock_device->dev.kobj, &dock_attribute_group); 10020f6f2804SKristen Carlson Accardi platform_device_unregister(dock_device); 1003671adbecSKristen Carlson Accardi 1004c8f7a62cSLen Brown return 0; 1005c8f7a62cSLen Brown } 1006c8f7a62cSLen Brown 1007c8f7a62cSLen Brown /** 10088ab0ab25SToshi Kani * find_dock_and_bay - look for dock stations and bays 1009c8f7a62cSLen Brown * @handle: acpi handle of a device 1010c8f7a62cSLen Brown * @lvl: unused 10118ab0ab25SToshi Kani * @context: unused 1012c8f7a62cSLen Brown * @rv: unused 1013c8f7a62cSLen Brown * 10148ab0ab25SToshi Kani * This is called by acpi_walk_namespace to look for dock stations and bays. 1015c8f7a62cSLen Brown */ 1016d38a5edfSUwe Kleine-König static __init acpi_status 10178ab0ab25SToshi Kani find_dock_and_bay(acpi_handle handle, u32 lvl, void *context, void **rv) 1018c8f7a62cSLen Brown { 10198ab0ab25SToshi Kani if (is_dock(handle) || is_ejectable_bay(handle)) 10201ee4d61fSZhang Rui dock_add(handle); 1021747479a3SAlex Chiang 10221ee4d61fSZhang Rui return AE_OK; 1023c8f7a62cSLen Brown } 1024c8f7a62cSLen Brown 1025c8f7a62cSLen Brown static int __init dock_init(void) 1026c8f7a62cSLen Brown { 1027816c2edaSLen Brown if (acpi_disabled) 1028816c2edaSLen Brown return 0; 1029816c2edaSLen Brown 10308ab0ab25SToshi Kani /* look for dock stations and bays */ 1031c8f7a62cSLen Brown acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT, 10328ab0ab25SToshi Kani ACPI_UINT32_MAX, find_dock_and_bay, NULL, NULL, NULL); 1033c8f7a62cSLen Brown 1034db350b08SShaohua Li if (!dock_station_count) { 1035cd73018fSToshi Kani pr_info(PREFIX "No dock devices found.\n"); 1036db350b08SShaohua Li return 0; 1037db350b08SShaohua Li } 1038c8f7a62cSLen Brown 10396bd00a61SShaohua Li register_acpi_bus_notifier(&dock_acpi_notifier); 1040cd73018fSToshi Kani pr_info(PREFIX "%s: %d docks/bays found\n", 1041db350b08SShaohua Li ACPI_DOCK_DRIVER_DESCRIPTION, dock_station_count); 1042c8f7a62cSLen Brown return 0; 1043c8f7a62cSLen Brown } 1044c8f7a62cSLen Brown 1045c8f7a62cSLen Brown static void __exit dock_exit(void) 1046c8f7a62cSLen Brown { 1047747479a3SAlex Chiang struct dock_station *tmp, *dock_station; 1048db350b08SShaohua Li 10496bd00a61SShaohua Li unregister_acpi_bus_notifier(&dock_acpi_notifier); 105050d716e4SAlex Chiang list_for_each_entry_safe(dock_station, tmp, &dock_stations, sibling) 1051db350b08SShaohua Li dock_remove(dock_station); 1052c8f7a62cSLen Brown } 1053c8f7a62cSLen Brown 1054db350b08SShaohua Li /* 1055db350b08SShaohua Li * Must be called before drivers of devices in dock, otherwise we can't know 1056db350b08SShaohua Li * which devices are in a dock 1057db350b08SShaohua Li */ 1058db350b08SShaohua Li subsys_initcall(dock_init); 1059c8f7a62cSLen Brown module_exit(dock_exit); 1060