drivers/input/serio/serio.c

   1 /*
   2  *  The Serio abstraction module
   3  *
   4  *  Copyright (c) 1999-2004 Vojtech Pavlik
   5  *  Copyright (c) 2004 Dmitry Torokhov
   6  *  Copyright (c) 2003 Daniele Bellucci
   7  */
   8
   9 /*
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  23  *
  24  * Should you need to contact me, the author, you can do so either by
  25  * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
  26  * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
  27  */
  28
  29 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  30
  31 #include <linux/stddef.h>
  32 #include <linux/module.h>
  33 #include <linux/serio.h>
  34 #include <linux/errno.h>
  35 #include <linux/sched.h>
  36 #include <linux/slab.h>
  37 #include <linux/workqueue.h>
  38 #include <linux/mutex.h>
  39
  40 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
  41 MODULE_DESCRIPTION("Serio abstraction core");
  42 MODULE_LICENSE("GPL");
  43
  44 /*
  45  * serio_mutex protects entire serio subsystem and is taken every time
  46  * serio port or driver registered or unregistered.
  47  */
  48 static DEFINE_MUTEX(serio_mutex);
  49
  50 static LIST_HEAD(serio_list);
  51
  52 static struct bus_type serio_bus;
  53
  54 static void serio_add_port(struct serio *serio);
  55 static int serio_reconnect_port(struct serio *serio);
  56 static void serio_disconnect_port(struct serio *serio);
  57 static void serio_reconnect_subtree(struct serio *serio);
  58 static void serio_attach_driver(struct serio_driver *drv);
  59
  60 static int serio_connect_driver(struct serio *serio, struct serio_driver *drv)
  61 {
  62         int retval;
  63
  64         mutex_lock(&serio->drv_mutex);
  65         retval = drv->connect(serio, drv);
  66         mutex_unlock(&serio->drv_mutex);
  67
  68         return retval;
  69 }
  70
  71 static int serio_reconnect_driver(struct serio *serio)
  72 {
  73         int retval = -1;
  74
  75         mutex_lock(&serio->drv_mutex);
  76         if (serio->drv && serio->drv->reconnect)
  77                 retval = serio->drv->reconnect(serio);
  78         mutex_unlock(&serio->drv_mutex);
  79
  80         return retval;
  81 }
  82
  83 static void serio_disconnect_driver(struct serio *serio)
  84 {
  85         mutex_lock(&serio->drv_mutex);
  86         if (serio->drv)
  87                 serio->drv->disconnect(serio);
  88         mutex_unlock(&serio->drv_mutex);
  89 }
  90
  91 static int serio_match_port(const struct serio_device_id *ids, struct serio *serio)
  92 {
  93         while (ids->type || ids->proto) {
  94                 if ((ids->type == SERIO_ANY || ids->type == serio->id.type) &&
  95                     (ids->proto == SERIO_ANY || ids->proto == serio->id.proto) &&
  96                     (ids->extra == SERIO_ANY || ids->extra == serio->id.extra) &&
  97                     (ids->id == SERIO_ANY || ids->id == serio->id.id))
  98                         return 1;
  99                 ids++;
 100         }
 101         return 0;
 102 }
 103
 104 /*
 105  * Basic serio -> driver core mappings
 106  */
 107
 108 static int serio_bind_driver(struct serio *serio, struct serio_driver *drv)
 109 {
 110         int error;
 111
 112         if (serio_match_port(drv->id_table, serio)) {
 113
 114                 serio->dev.driver = &drv->driver;
 115                 if (serio_connect_driver(serio, drv)) {
 116                         serio->dev.driver = NULL;
 117                         return -ENODEV;
 118                 }
 119
 120                 error = device_bind_driver(&serio->dev);
 121                 if (error) {
 122                         dev_warn(&serio->dev,
 123                                  "device_bind_driver() failed for %s (%s) and %s, error: %d\n",
 124                                  serio->phys, serio->name,
 125                                  drv->description, error);
 126                         serio_disconnect_driver(serio);
 127                         serio->dev.driver = NULL;
 128                         return error;
 129                 }
 130         }
 131         return 0;
 132 }
 133
 134 static void serio_find_driver(struct serio *serio)
 135 {
 136         int error;
 137
 138         error = device_attach(&serio->dev);
 139         if (error < 0)
 140                 dev_warn(&serio->dev,
 141                          "device_attach() failed for %s (%s), error: %d\n",
 142                          serio->phys, serio->name, error);
 143 }
 144
 145
 146 /*
 147  * Serio event processing.
 148  */
 149
 150 enum serio_event_type {
 151         SERIO_RESCAN_PORT,
 152         SERIO_RECONNECT_PORT,
 153         SERIO_RECONNECT_SUBTREE,
 154         SERIO_REGISTER_PORT,
 155         SERIO_ATTACH_DRIVER,
 156 };
 157
 158 struct serio_event {
 159         enum serio_event_type type;
 160         void *object;
 161         struct module *owner;
 162         struct list_head node;
 163 };
 164
 165 static DEFINE_SPINLOCK(serio_event_lock);       /* protects serio_event_list */
 166 static LIST_HEAD(serio_event_list);
 167
 168 static struct serio_event *serio_get_event(void)
 169 {
 170         struct serio_event *event = NULL;
 171         unsigned long flags;
 172
 173         spin_lock_irqsave(&serio_event_lock, flags);
 174
 175         if (!list_empty(&serio_event_list)) {
 176                 event = list_first_entry(&serio_event_list,
 177                                          struct serio_event, node);
 178                 list_del_init(&event->node);
 179         }
 180
 181         spin_unlock_irqrestore(&serio_event_lock, flags);
 182         return event;
 183 }
 184
 185 static void serio_free_event(struct serio_event *event)
 186 {
 187         module_put(event->owner);
 188         kfree(event);
 189 }
 190
 191 static void serio_remove_duplicate_events(void *object,
 192                                           enum serio_event_type type)
 193 {
 194         struct serio_event *e, *next;
 195         unsigned long flags;
 196
 197         spin_lock_irqsave(&serio_event_lock, flags);
 198
 199         list_for_each_entry_safe(e, next, &serio_event_list, node) {
 200                 if (object == e->object) {
 201                         /*
 202                          * If this event is of different type we should not
 203                          * look further - we only suppress duplicate events
 204                          * that were sent back-to-back.
 205                          */
 206                         if (type != e->type)
 207                                 break;
 208
 209                         list_del_init(&e->node);
 210                         serio_free_event(e);
 211                 }
 212         }
 213
 214         spin_unlock_irqrestore(&serio_event_lock, flags);
 215 }
 216
 217 static void serio_handle_event(struct work_struct *work)
 218 {
 219         struct serio_event *event;
 220
 221         mutex_lock(&serio_mutex);
 222
 223         while ((event = serio_get_event())) {
 224
 225                 switch (event->type) {
 226
 227                 case SERIO_REGISTER_PORT:
 228                         serio_add_port(event->object);
 229                         break;
 230
 231                 case SERIO_RECONNECT_PORT:
 232                         serio_reconnect_port(event->object);
 233                         break;
 234
 235                 case SERIO_RESCAN_PORT:
 236                         serio_disconnect_port(event->object);
 237                         serio_find_driver(event->object);
 238                         break;
 239
 240                 case SERIO_RECONNECT_SUBTREE:
 241                         serio_reconnect_subtree(event->object);
 242                         break;
 243
 244                 case SERIO_ATTACH_DRIVER:
 245                         serio_attach_driver(event->object);
 246                         break;
 247                 }
 248
 249                 serio_remove_duplicate_events(event->object, event->type);
 250                 serio_free_event(event);
 251         }
 252
 253         mutex_unlock(&serio_mutex);
 254 }
 255
 256 static DECLARE_WORK(serio_event_work, serio_handle_event);
 257
 258 static int serio_queue_event(void *object, struct module *owner,
 259                              enum serio_event_type event_type)
 260 {
 261         unsigned long flags;
 262         struct serio_event *event;
 263         int retval = 0;
 264
 265         spin_lock_irqsave(&serio_event_lock, flags);
 266
 267         /*
 268          * Scan event list for the other events for the same serio port,
 269          * starting with the most recent one. If event is the same we
 270          * do not need add new one. If event is of different type we
 271          * need to add this event and should not look further because
 272          * we need to preseve sequence of distinct events.
 273          */
 274         list_for_each_entry_reverse(event, &serio_event_list, node) {
 275                 if (event->object == object) {
 276                         if (event->type == event_type)
 277                                 goto out;
 278                         break;
 279                 }
 280         }
 281
 282         event = kmalloc(sizeof(struct serio_event), GFP_ATOMIC);
 283         if (!event) {
 284                 pr_err("Not enough memory to queue event %d\n", event_type);
 285                 retval = -ENOMEM;
 286                 goto out;
 287         }
 288
 289         if (!try_module_get(owner)) {
 290                 pr_warning("Can't get module reference, dropping event %d\n",
 291                            event_type);
 292                 kfree(event);
 293                 retval = -EINVAL;
 294                 goto out;
 295         }
 296
 297         event->type = event_type;
 298         event->object = object;
 299         event->owner = owner;
 300
 301         list_add_tail(&event->node, &serio_event_list);
 302         queue_work(system_long_wq, &serio_event_work);
 303
 304 out:
 305         spin_unlock_irqrestore(&serio_event_lock, flags);
 306         return retval;
 307 }
 308
 309 /*
 310  * Remove all events that have been submitted for a given
 311  * object, be it serio port or driver.
 312  */
 313 static void serio_remove_pending_events(void *object)
 314 {
 315         struct serio_event *event, *next;
 316         unsigned long flags;
 317
 318         spin_lock_irqsave(&serio_event_lock, flags);
 319
 320         list_for_each_entry_safe(event, next, &serio_event_list, node) {
 321                 if (event->object == object) {
 322                         list_del_init(&event->node);
 323                         serio_free_event(event);
 324                 }
 325         }
 326
 327         spin_unlock_irqrestore(&serio_event_lock, flags);
 328 }
 329
 330 /*
 331  * Locate child serio port (if any) that has not been fully registered yet.
 332  *
 333  * Children are registered by driver's connect() handler so there can't be a
 334  * grandchild pending registration together with a child.
 335  */
 336 static struct serio *serio_get_pending_child(struct serio *parent)
 337 {
 338         struct serio_event *event;
 339         struct serio *serio, *child = NULL;
 340         unsigned long flags;
 341
 342         spin_lock_irqsave(&serio_event_lock, flags);
 343
 344         list_for_each_entry(event, &serio_event_list, node) {
 345                 if (event->type == SERIO_REGISTER_PORT) {
 346                         serio = event->object;
 347                         if (serio->parent == parent) {
 348                                 child = serio;
 349                                 break;
 350                         }
 351                 }
 352         }
 353
 354         spin_unlock_irqrestore(&serio_event_lock, flags);
 355         return child;
 356 }
 357
 358 /*
 359  * Serio port operations
 360  */
 361
 362 static ssize_t serio_show_description(struct device *dev, struct device_attribute *attr, char *buf)
 363 {
 364         struct serio *serio = to_serio_port(dev);
 365         return sprintf(buf, "%s\n", serio->name);
 366 }
 367
 368 static ssize_t serio_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
 369 {
 370         struct serio *serio = to_serio_port(dev);
 371
 372         return sprintf(buf, "serio:ty%02Xpr%02Xid%02Xex%02X\n",
 373                         serio->id.type, serio->id.proto, serio->id.id, serio->id.extra);
 374 }
 375
 376 static ssize_t serio_show_id_type(struct device *dev, struct device_attribute *attr, char *buf)
 377 {
 378         struct serio *serio = to_serio_port(dev);
 379         return sprintf(buf, "%02x\n", serio->id.type);
 380 }
 381
 382 static ssize_t serio_show_id_proto(struct device *dev, struct device_attribute *attr, char *buf)
 383 {
 384         struct serio *serio = to_serio_port(dev);
 385         return sprintf(buf, "%02x\n", serio->id.proto);
 386 }
 387
 388 static ssize_t serio_show_id_id(struct device *dev, struct device_attribute *attr, char *buf)
 389 {
 390         struct serio *serio = to_serio_port(dev);
 391         return sprintf(buf, "%02x\n", serio->id.id);
 392 }
 393
 394 static ssize_t serio_show_id_extra(struct device *dev, struct device_attribute *attr, char *buf)
 395 {
 396         struct serio *serio = to_serio_port(dev);
 397         return sprintf(buf, "%02x\n", serio->id.extra);
 398 }
 399
 400 static DEVICE_ATTR(type, S_IRUGO, serio_show_id_type, NULL);
 401 static DEVICE_ATTR(proto, S_IRUGO, serio_show_id_proto, NULL);
 402 static DEVICE_ATTR(id, S_IRUGO, serio_show_id_id, NULL);
 403 static DEVICE_ATTR(extra, S_IRUGO, serio_show_id_extra, NULL);
 404
 405 static struct attribute *serio_device_id_attrs[] = {
 406         &dev_attr_type.attr,
 407         &dev_attr_proto.attr,
 408         &dev_attr_id.attr,
 409         &dev_attr_extra.attr,
 410         NULL
 411 };
 412
 413 static struct attribute_group serio_id_attr_group = {
 414         .name   = "id",
 415         .attrs  = serio_device_id_attrs,
 416 };
 417
 418 static const struct attribute_group *serio_device_attr_groups[] = {
 419         &serio_id_attr_group,
 420         NULL
 421 };
 422
 423 static ssize_t serio_rebind_driver(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
 424 {
 425         struct serio *serio = to_serio_port(dev);
 426         struct device_driver *drv;
 427         int error;
 428
 429         error = mutex_lock_interruptible(&serio_mutex);
 430         if (error)
 431                 return error;
 432
 433         if (!strncmp(buf, "none", count)) {
 434                 serio_disconnect_port(serio);
 435         } else if (!strncmp(buf, "reconnect", count)) {
 436                 serio_reconnect_subtree(serio);
 437         } else if (!strncmp(buf, "rescan", count)) {
 438                 serio_disconnect_port(serio);
 439                 serio_find_driver(serio);
 440                 serio_remove_duplicate_events(serio, SERIO_RESCAN_PORT);
 441         } else if ((drv = driver_find(buf, &serio_bus)) != NULL) {
 442                 serio_disconnect_port(serio);
 443                 error = serio_bind_driver(serio, to_serio_driver(drv));
 444                 serio_remove_duplicate_events(serio, SERIO_RESCAN_PORT);
 445         } else {
 446                 error = -EINVAL;
 447         }
 448
 449         mutex_unlock(&serio_mutex);
 450
 451         return error ? error : count;
 452 }
 453
 454 static ssize_t serio_show_bind_mode(struct device *dev, struct device_attribute *attr, char *buf)
 455 {
 456         struct serio *serio = to_serio_port(dev);
 457         return sprintf(buf, "%s\n", serio->manual_bind ? "manual" : "auto");
 458 }
 459
 460 static ssize_t serio_set_bind_mode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
 461 {
 462         struct serio *serio = to_serio_port(dev);
 463         int retval;
 464
 465         retval = count;
 466         if (!strncmp(buf, "manual", count)) {
 467                 serio->manual_bind = true;
 468         } else if (!strncmp(buf, "auto", count)) {
 469                 serio->manual_bind = false;
 470         } else {
 471                 retval = -EINVAL;
 472         }
 473
 474         return retval;
 475 }
 476
 477 static ssize_t firmware_id_show(struct device *dev, struct device_attribute *attr, char *buf)
 478 {
 479         struct serio *serio = to_serio_port(dev);
 480
 481         return sprintf(buf, "%s\n", serio->firmware_id);
 482 }
 483
 484 static struct device_attribute serio_device_attrs[] = {
 485         __ATTR(description, S_IRUGO, serio_show_description, NULL),
 486         __ATTR(modalias, S_IRUGO, serio_show_modalias, NULL),
 487         __ATTR(drvctl, S_IWUSR, NULL, serio_rebind_driver),
 488         __ATTR(bind_mode, S_IWUSR | S_IRUGO, serio_show_bind_mode, serio_set_bind_mode),
 489         __ATTR(firmware_id, S_IRUGO, firmware_id_show, NULL),
 490         __ATTR_NULL
 491 };
 492
 493
 494 static void serio_release_port(struct device *dev)
 495 {
 496         struct serio *serio = to_serio_port(dev);
 497
 498         kfree(serio);
 499         module_put(THIS_MODULE);
 500 }
 501
 502 /*
 503  * Prepare serio port for registration.
 504  */
 505 static void serio_init_port(struct serio *serio)
 506 {
 507         static atomic_t serio_no = ATOMIC_INIT(0);
 508
 509         __module_get(THIS_MODULE);
 510
 511         INIT_LIST_HEAD(&serio->node);
 512         INIT_LIST_HEAD(&serio->child_node);
 513         INIT_LIST_HEAD(&serio->children);
 514         spin_lock_init(&serio->lock);
 515         mutex_init(&serio->drv_mutex);
 516         device_initialize(&serio->dev);
 517         dev_set_name(&serio->dev, "serio%lu",
 518                      (unsigned long)atomic_inc_return(&serio_no) - 1);
 519         serio->dev.bus = &serio_bus;
 520         serio->dev.release = serio_release_port;
 521         serio->dev.groups = serio_device_attr_groups;
 522         if (serio->parent) {
 523                 serio->dev.parent = &serio->parent->dev;
 524                 serio->depth = serio->parent->depth + 1;
 525         } else
 526                 serio->depth = 0;
 527         lockdep_set_subclass(&serio->lock, serio->depth);
 528 }
 529
 530 /*
 531  * Complete serio port registration.
 532  * Driver core will attempt to find appropriate driver for the port.
 533  */
 534 static void serio_add_port(struct serio *serio)
 535 {
 536         struct serio *parent = serio->parent;
 537         int error;
 538
 539         if (parent) {
 540                 serio_pause_rx(parent);
 541                 list_add_tail(&serio->child_node, &parent->children);
 542                 serio_continue_rx(parent);
 543         }
 544
 545         list_add_tail(&serio->node, &serio_list);
 546
 547         if (serio->start)
 548                 serio->start(serio);
 549
 550         error = device_add(&serio->dev);
 551         if (error)
 552                 dev_err(&serio->dev,
 553                         "device_add() failed for %s (%s), error: %d\n",
 554                         serio->phys, serio->name, error);
 555 }
 556
 557 /*
 558  * serio_destroy_port() completes unregistration process and removes
 559  * port from the system
 560  */
 561 static void serio_destroy_port(struct serio *serio)
 562 {
 563         struct serio *child;
 564
 565         while ((child = serio_get_pending_child(serio)) != NULL) {
 566                 serio_remove_pending_events(child);
 567                 put_device(&child->dev);
 568         }
 569
 570         if (serio->stop)
 571                 serio->stop(serio);
 572
 573         if (serio->parent) {
 574                 serio_pause_rx(serio->parent);
 575                 list_del_init(&serio->child_node);
 576                 serio_continue_rx(serio->parent);
 577                 serio->parent = NULL;
 578         }
 579
 580         if (device_is_registered(&serio->dev))
 581                 device_del(&serio->dev);
 582
 583         list_del_init(&serio->node);
 584         serio_remove_pending_events(serio);
 585         put_device(&serio->dev);
 586 }
 587
 588 /*
 589  * Reconnect serio port (re-initialize attached device).
 590  * If reconnect fails (old device is no longer attached or
 591  * there was no device to begin with) we do full rescan in
 592  * hope of finding a driver for the port.
 593  */
 594 static int serio_reconnect_port(struct serio *serio)
 595 {
 596         int error = serio_reconnect_driver(serio);
 597
 598         if (error) {
 599                 serio_disconnect_port(serio);
 600                 serio_find_driver(serio);
 601         }
 602
 603         return error;
 604 }
 605
 606 /*
 607  * Reconnect serio port and all its children (re-initialize attached
 608  * devices).
 609  */
 610 static void serio_reconnect_subtree(struct serio *root)
 611 {
 612         struct serio *s = root;
 613         int error;
 614
 615         do {
 616                 error = serio_reconnect_port(s);
 617                 if (!error) {
 618                         /*
 619                          * Reconnect was successful, move on to do the
 620                          * first child.
 621                          */
 622                         if (!list_empty(&s->children)) {
 623                                 s = list_first_entry(&s->children,
 624                                                      struct serio, child_node);
 625                                 continue;
 626                         }
 627                 }
 628
 629                 /*
 630                  * Either it was a leaf node or reconnect failed and it
 631                  * became a leaf node. Continue reconnecting starting with
 632                  * the next sibling of the parent node.
 633                  */
 634                 while (s != root) {
 635                         struct serio *parent = s->parent;
 636
 637                         if (!list_is_last(&s->child_node, &parent->children)) {
 638                                 s = list_entry(s->child_node.next,
 639                                                struct serio, child_node);
 640                                 break;
 641                         }
 642
 643                         s = parent;
 644                 }
 645         } while (s != root);
 646 }
 647
 648 /*
 649  * serio_disconnect_port() unbinds a port from its driver. As a side effect
 650  * all children ports are unbound and destroyed.
 651  */
 652 static void serio_disconnect_port(struct serio *serio)
 653 {
 654         struct serio *s = serio;
 655
 656         /*
 657          * Children ports should be disconnected and destroyed
 658          * first; we travel the tree in depth-first order.
 659          */
 660         while (!list_empty(&serio->children)) {
 661
 662                 /* Locate a leaf */
 663                 while (!list_empty(&s->children))
 664                         s = list_first_entry(&s->children,
 665                                              struct serio, child_node);
 666
 667                 /*
 668                  * Prune this leaf node unless it is the one we
 669                  * started with.
 670                  */
 671                 if (s != serio) {
 672                         struct serio *parent = s->parent;
 673
 674                         device_release_driver(&s->dev);
 675                         serio_destroy_port(s);
 676
 677                         s = parent;
 678                 }
 679         }
 680
 681         /*
 682          * OK, no children left, now disconnect this port.
 683          */
 684         device_release_driver(&serio->dev);
 685 }
 686
 687 void serio_rescan(struct serio *serio)
 688 {
 689         serio_queue_event(serio, NULL, SERIO_RESCAN_PORT);
 690 }
 691 EXPORT_SYMBOL(serio_rescan);
 692
 693 void serio_reconnect(struct serio *serio)
 694 {
 695         serio_queue_event(serio, NULL, SERIO_RECONNECT_SUBTREE);
 696 }
 697 EXPORT_SYMBOL(serio_reconnect);
 698
 699 /*
 700  * Submits register request to kseriod for subsequent execution.
 701  * Note that port registration is always asynchronous.
 702  */
 703 void __serio_register_port(struct serio *serio, struct module *owner)
 704 {
 705         serio_init_port(serio);
 706         serio_queue_event(serio, owner, SERIO_REGISTER_PORT);
 707 }
 708 EXPORT_SYMBOL(__serio_register_port);
 709
 710 /*
 711  * Synchronously unregisters serio port.
 712  */
 713 void serio_unregister_port(struct serio *serio)
 714 {
 715         mutex_lock(&serio_mutex);
 716         serio_disconnect_port(serio);
 717         serio_destroy_port(serio);
 718         mutex_unlock(&serio_mutex);
 719 }
 720 EXPORT_SYMBOL(serio_unregister_port);
 721
 722 /*
 723  * Safely unregisters children ports if they are present.
 724  */
 725 void serio_unregister_child_port(struct serio *serio)
 726 {
 727         struct serio *s, *next;
 728
 729         mutex_lock(&serio_mutex);
 730         list_for_each_entry_safe(s, next, &serio->children, child_node) {
 731                 serio_disconnect_port(s);
 732                 serio_destroy_port(s);
 733         }
 734         mutex_unlock(&serio_mutex);
 735 }
 736 EXPORT_SYMBOL(serio_unregister_child_port);
 737
 738
 739 /*
 740  * Serio driver operations
 741  */
 742
 743 static ssize_t description_show(struct device_driver *drv, char *buf)
 744 {
 745         struct serio_driver *driver = to_serio_driver(drv);
 746         return sprintf(buf, "%s\n", driver->description ? driver->description : "(none)");
 747 }
 748 static DRIVER_ATTR_RO(description);
 749
 750 static ssize_t bind_mode_show(struct device_driver *drv, char *buf)
 751 {
 752         struct serio_driver *serio_drv = to_serio_driver(drv);
 753         return sprintf(buf, "%s\n", serio_drv->manual_bind ? "manual" : "auto");
 754 }
 755
 756 static ssize_t bind_mode_store(struct device_driver *drv, const char *buf, size_t count)
 757 {
 758         struct serio_driver *serio_drv = to_serio_driver(drv);
 759         int retval;
 760
 761         retval = count;
 762         if (!strncmp(buf, "manual", count)) {
 763                 serio_drv->manual_bind = true;
 764         } else if (!strncmp(buf, "auto", count)) {
 765                 serio_drv->manual_bind = false;
 766         } else {
 767                 retval = -EINVAL;
 768         }
 769
 770         return retval;
 771 }
 772 static DRIVER_ATTR_RW(bind_mode);
 773
 774 static struct attribute *serio_driver_attrs[] = {
 775         &driver_attr_description.attr,
 776         &driver_attr_bind_mode.attr,
 777         NULL,
 778 };
 779 ATTRIBUTE_GROUPS(serio_driver);
 780
 781 static int serio_driver_probe(struct device *dev)
 782 {
 783         struct serio *serio = to_serio_port(dev);
 784         struct serio_driver *drv = to_serio_driver(dev->driver);
 785
 786         return serio_connect_driver(serio, drv);
 787 }
 788
 789 static int serio_driver_remove(struct device *dev)
 790 {
 791         struct serio *serio = to_serio_port(dev);
 792
 793         serio_disconnect_driver(serio);
 794         return 0;
 795 }
 796
 797 static void serio_cleanup(struct serio *serio)
 798 {
 799         mutex_lock(&serio->drv_mutex);
 800         if (serio->drv && serio->drv->cleanup)
 801                 serio->drv->cleanup(serio);
 802         mutex_unlock(&serio->drv_mutex);
 803 }
 804
 805 static void serio_shutdown(struct device *dev)
 806 {
 807         struct serio *serio = to_serio_port(dev);
 808
 809         serio_cleanup(serio);
 810 }
 811
 812 static void serio_attach_driver(struct serio_driver *drv)
 813 {
 814         int error;
 815
 816         error = driver_attach(&drv->driver);
 817         if (error)
 818                 pr_warning("driver_attach() failed for %s with error %d\n",
 819                            drv->driver.name, error);
 820 }
 821
 822 int __serio_register_driver(struct serio_driver *drv, struct module *owner, const char *mod_name)
 823 {
 824         bool manual_bind = drv->manual_bind;
 825         int error;
 826
 827         drv->driver.bus = &serio_bus;
 828         drv->driver.owner = owner;
 829         drv->driver.mod_name = mod_name;
 830
 831         /*
 832          * Temporarily disable automatic binding because probing
 833          * takes long time and we are better off doing it in kseriod
 834          */
 835         drv->manual_bind = true;
 836
 837         error = driver_register(&drv->driver);
 838         if (error) {
 839                 pr_err("driver_register() failed for %s, error: %d\n",
 840                         drv->driver.name, error);
 841                 return error;
 842         }
 843
 844         /*
 845          * Restore original bind mode and let kseriod bind the
 846          * driver to free ports
 847          */
 848         if (!manual_bind) {
 849                 drv->manual_bind = false;
 850                 error = serio_queue_event(drv, NULL, SERIO_ATTACH_DRIVER);
 851                 if (error) {
 852                         driver_unregister(&drv->driver);
 853                         return error;
 854                 }
 855         }
 856
 857         return 0;
 858 }
 859 EXPORT_SYMBOL(__serio_register_driver);
 860
 861 void serio_unregister_driver(struct serio_driver *drv)
 862 {
 863         struct serio *serio;
 864
 865         mutex_lock(&serio_mutex);
 866
 867         drv->manual_bind = true;        /* so serio_find_driver ignores it */
 868         serio_remove_pending_events(drv);
 869
 870 start_over:
 871         list_for_each_entry(serio, &serio_list, node) {
 872                 if (serio->drv == drv) {
 873                         serio_disconnect_port(serio);
 874                         serio_find_driver(serio);
 875                         /* we could've deleted some ports, restart */
 876                         goto start_over;
 877                 }
 878         }
 879
 880         driver_unregister(&drv->driver);
 881         mutex_unlock(&serio_mutex);
 882 }
 883 EXPORT_SYMBOL(serio_unregister_driver);
 884
 885 static void serio_set_drv(struct serio *serio, struct serio_driver *drv)
 886 {
 887         serio_pause_rx(serio);
 888         serio->drv = drv;
 889         serio_continue_rx(serio);
 890 }
 891
 892 static int serio_bus_match(struct device *dev, struct device_driver *drv)
 893 {
 894         struct serio *serio = to_serio_port(dev);
 895         struct serio_driver *serio_drv = to_serio_driver(drv);
 896
 897         if (serio->manual_bind || serio_drv->manual_bind)
 898                 return 0;
 899
 900         return serio_match_port(serio_drv->id_table, serio);
 901 }
 902
 903 #define SERIO_ADD_UEVENT_VAR(fmt, val...)                               \
 904         do {                                                            \
 905                 int err = add_uevent_var(env, fmt, val);                \
 906                 if (err)                                                \
 907                         return err;                                     \
 908         } while (0)
 909
 910 static int serio_uevent(struct device *dev, struct kobj_uevent_env *env)
 911 {
 912         struct serio *serio;
 913
 914         if (!dev)
 915                 return -ENODEV;
 916
 917         serio = to_serio_port(dev);
 918
 919         SERIO_ADD_UEVENT_VAR("SERIO_TYPE=%02x", serio->id.type);
 920         SERIO_ADD_UEVENT_VAR("SERIO_PROTO=%02x", serio->id.proto);
 921         SERIO_ADD_UEVENT_VAR("SERIO_ID=%02x", serio->id.id);
 922         SERIO_ADD_UEVENT_VAR("SERIO_EXTRA=%02x", serio->id.extra);
 923
 924         SERIO_ADD_UEVENT_VAR("MODALIAS=serio:ty%02Xpr%02Xid%02Xex%02X",
 925                                 serio->id.type, serio->id.proto, serio->id.id, serio->id.extra);
 926
 927         if (serio->firmware_id[0])
 928                 SERIO_ADD_UEVENT_VAR("SERIO_FIRMWARE_ID=%s",
 929                                      serio->firmware_id);
 930
 931         return 0;
 932 }
 933 #undef SERIO_ADD_UEVENT_VAR
 934
 935 #ifdef CONFIG_PM
 936 static int serio_suspend(struct device *dev)
 937 {
 938         struct serio *serio = to_serio_port(dev);
 939
 940         serio_cleanup(serio);
 941
 942         return 0;
 943 }
 944
 945 static int serio_resume(struct device *dev)
 946 {
 947         struct serio *serio = to_serio_port(dev);
 948
 949         /*
 950          * Driver reconnect can take a while, so better let kseriod
 951          * deal with it.
 952          */
 953         serio_queue_event(serio, NULL, SERIO_RECONNECT_PORT);
 954
 955         return 0;
 956 }
 957
 958 static const struct dev_pm_ops serio_pm_ops = {
 959         .suspend        = serio_suspend,
 960         .resume         = serio_resume,
 961         .poweroff       = serio_suspend,
 962         .restore        = serio_resume,
 963 };
 964 #endif /* CONFIG_PM */
 965
 966 /* called from serio_driver->connect/disconnect methods under serio_mutex */
 967 int serio_open(struct serio *serio, struct serio_driver *drv)
 968 {
 969         serio_set_drv(serio, drv);
 970
 971         if (serio->open && serio->open(serio)) {
 972                 serio_set_drv(serio, NULL);
 973                 return -1;
 974         }
 975         return 0;
 976 }
 977 EXPORT_SYMBOL(serio_open);
 978
 979 /* called from serio_driver->connect/disconnect methods under serio_mutex */
 980 void serio_close(struct serio *serio)
 981 {
 982         if (serio->close)
 983                 serio->close(serio);
 984
 985         serio_set_drv(serio, NULL);
 986 }
 987 EXPORT_SYMBOL(serio_close);
 988
 989 irqreturn_t serio_interrupt(struct serio *serio,
 990                 unsigned char data, unsigned int dfl)
 991 {
 992         unsigned long flags;
 993         irqreturn_t ret = IRQ_NONE;
 994
 995         spin_lock_irqsave(&serio->lock, flags);
 996
 997         if (likely(serio->drv)) {
 998                 ret = serio->drv->interrupt(serio, data, dfl);
 999         } else if (!dfl && device_is_registered(&serio->dev)) {
1000                 serio_rescan(serio);
1001                 ret = IRQ_HANDLED;
1002         }
1003
1004         spin_unlock_irqrestore(&serio->lock, flags);
1005
1006         return ret;
1007 }
1008 EXPORT_SYMBOL(serio_interrupt);
1009
1010 static struct bus_type serio_bus = {
1011         .name           = "serio",
1012         .dev_attrs      = serio_device_attrs,
1013         .drv_groups     = serio_driver_groups,
1014         .match          = serio_bus_match,
1015         .uevent         = serio_uevent,
1016         .probe          = serio_driver_probe,
1017         .remove         = serio_driver_remove,
1018         .shutdown       = serio_shutdown,
1019 #ifdef CONFIG_PM
1020         .pm             = &serio_pm_ops,
1021 #endif
1022 };
1023
1024 static int __init serio_init(void)
1025 {
1026         int error;
1027
1028         error = bus_register(&serio_bus);
1029         if (error) {
1030                 pr_err("Failed to register serio bus, error: %d\n", error);
1031                 return error;
1032         }
1033
1034         return 0;
1035 }
1036
1037 static void __exit serio_exit(void)
1038 {
1039         bus_unregister(&serio_bus);
1040
1041         /*
1042          * There should not be any outstanding events but work may
1043          * still be scheduled so simply cancel it.
1044          */
1045         cancel_work_sync(&serio_event_work);
1046 }
1047
1048 subsys_initcall(serio_init);
1049 module_exit(serio_exit);