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