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