drivers/acpi/dock.c

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