drivers/tty/serdev/core.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (C) 2016-2017 Linaro Ltd., Rob Herring <robh@kernel.org>
   4  *
   5  * Based on drivers/spmi/spmi.c:
   6  * Copyright (c) 2012-2015, The Linux Foundation. All rights reserved.
   7  */
   8
   9 #include <linux/acpi.h>
  10 #include <linux/errno.h>
  11 #include <linux/idr.h>
  12 #include <linux/kernel.h>
  13 #include <linux/module.h>
  14 #include <linux/of.h>
  15 #include <linux/of_device.h>
  16 #include <linux/pm_domain.h>
  17 #include <linux/pm_runtime.h>
  18 #include <linux/sched.h>
  19 #include <linux/serdev.h>
  20 #include <linux/slab.h>
  21 #include <linux/platform_data/x86/apple.h>
  22
  23 static bool is_registered;
  24 static DEFINE_IDA(ctrl_ida);
  25
  26 static ssize_t modalias_show(struct device *dev,
  27                              struct device_attribute *attr, char *buf)
  28 {
  29         int len;
  30
  31         len = acpi_device_modalias(dev, buf, PAGE_SIZE - 1);
  32         if (len != -ENODEV)
  33                 return len;
  34
  35         return of_device_modalias(dev, buf, PAGE_SIZE);
  36 }
  37 static DEVICE_ATTR_RO(modalias);
  38
  39 static struct attribute *serdev_device_attrs[] = {
  40         &dev_attr_modalias.attr,
  41         NULL,
  42 };
  43 ATTRIBUTE_GROUPS(serdev_device);
  44
  45 static int serdev_device_uevent(struct device *dev, struct kobj_uevent_env *env)
  46 {
  47         int rc;
  48
  49         /* TODO: platform modalias */
  50
  51         rc = acpi_device_uevent_modalias(dev, env);
  52         if (rc != -ENODEV)
  53                 return rc;
  54
  55         return of_device_uevent_modalias(dev, env);
  56 }
  57
  58 static void serdev_device_release(struct device *dev)
  59 {
  60         struct serdev_device *serdev = to_serdev_device(dev);
  61         kfree(serdev);
  62 }
  63
  64 static const struct device_type serdev_device_type = {
  65         .groups         = serdev_device_groups,
  66         .uevent         = serdev_device_uevent,
  67         .release        = serdev_device_release,
  68 };
  69
  70 static bool is_serdev_device(const struct device *dev)
  71 {
  72         return dev->type == &serdev_device_type;
  73 }
  74
  75 static void serdev_ctrl_release(struct device *dev)
  76 {
  77         struct serdev_controller *ctrl = to_serdev_controller(dev);
  78         ida_simple_remove(&ctrl_ida, ctrl->nr);
  79         kfree(ctrl);
  80 }
  81
  82 static const struct device_type serdev_ctrl_type = {
  83         .release        = serdev_ctrl_release,
  84 };
  85
  86 static int serdev_device_match(struct device *dev, struct device_driver *drv)
  87 {
  88         if (!is_serdev_device(dev))
  89                 return 0;
  90
  91         /* TODO: platform matching */
  92         if (acpi_driver_match_device(dev, drv))
  93                 return 1;
  94
  95         return of_driver_match_device(dev, drv);
  96 }
  97
  98 /**
  99  * serdev_device_add() - add a device previously constructed via serdev_device_alloc()
 100  * @serdev:     serdev_device to be added
 101  */
 102 int serdev_device_add(struct serdev_device *serdev)
 103 {
 104         struct serdev_controller *ctrl = serdev->ctrl;
 105         struct device *parent = serdev->dev.parent;
 106         int err;
 107
 108         dev_set_name(&serdev->dev, "%s-%d", dev_name(parent), serdev->nr);
 109
 110         /* Only a single slave device is currently supported. */
 111         if (ctrl->serdev) {
 112                 dev_err(&serdev->dev, "controller busy\n");
 113                 return -EBUSY;
 114         }
 115         ctrl->serdev = serdev;
 116
 117         err = device_add(&serdev->dev);
 118         if (err < 0) {
 119                 dev_err(&serdev->dev, "Can't add %s, status %pe\n",
 120                         dev_name(&serdev->dev), ERR_PTR(err));
 121                 goto err_clear_serdev;
 122         }
 123
 124         dev_dbg(&serdev->dev, "device %s registered\n", dev_name(&serdev->dev));
 125
 126         return 0;
 127
 128 err_clear_serdev:
 129         ctrl->serdev = NULL;
 130         return err;
 131 }
 132 EXPORT_SYMBOL_GPL(serdev_device_add);
 133
 134 /**
 135  * serdev_device_remove(): remove an serdev device
 136  * @serdev:     serdev_device to be removed
 137  */
 138 void serdev_device_remove(struct serdev_device *serdev)
 139 {
 140         struct serdev_controller *ctrl = serdev->ctrl;
 141
 142         device_unregister(&serdev->dev);
 143         ctrl->serdev = NULL;
 144 }
 145 EXPORT_SYMBOL_GPL(serdev_device_remove);
 146
 147 int serdev_device_open(struct serdev_device *serdev)
 148 {
 149         struct serdev_controller *ctrl = serdev->ctrl;
 150         int ret;
 151
 152         if (!ctrl || !ctrl->ops->open)
 153                 return -EINVAL;
 154
 155         ret = ctrl->ops->open(ctrl);
 156         if (ret)
 157                 return ret;
 158
 159         ret = pm_runtime_get_sync(&ctrl->dev);
 160         if (ret < 0) {
 161                 pm_runtime_put_noidle(&ctrl->dev);
 162                 goto err_close;
 163         }
 164
 165         return 0;
 166
 167 err_close:
 168         if (ctrl->ops->close)
 169                 ctrl->ops->close(ctrl);
 170
 171         return ret;
 172 }
 173 EXPORT_SYMBOL_GPL(serdev_device_open);
 174
 175 void serdev_device_close(struct serdev_device *serdev)
 176 {
 177         struct serdev_controller *ctrl = serdev->ctrl;
 178
 179         if (!ctrl || !ctrl->ops->close)
 180                 return;
 181
 182         pm_runtime_put(&ctrl->dev);
 183
 184         ctrl->ops->close(ctrl);
 185 }
 186 EXPORT_SYMBOL_GPL(serdev_device_close);
 187
 188 static void devm_serdev_device_release(struct device *dev, void *dr)
 189 {
 190         serdev_device_close(*(struct serdev_device **)dr);
 191 }
 192
 193 int devm_serdev_device_open(struct device *dev, struct serdev_device *serdev)
 194 {
 195         struct serdev_device **dr;
 196         int ret;
 197
 198         dr = devres_alloc(devm_serdev_device_release, sizeof(*dr), GFP_KERNEL);
 199         if (!dr)
 200                 return -ENOMEM;
 201
 202         ret = serdev_device_open(serdev);
 203         if (ret) {
 204                 devres_free(dr);
 205                 return ret;
 206         }
 207
 208         *dr = serdev;
 209         devres_add(dev, dr);
 210
 211         return 0;
 212 }
 213 EXPORT_SYMBOL_GPL(devm_serdev_device_open);
 214
 215 void serdev_device_write_wakeup(struct serdev_device *serdev)
 216 {
 217         complete(&serdev->write_comp);
 218 }
 219 EXPORT_SYMBOL_GPL(serdev_device_write_wakeup);
 220
 221 /**
 222  * serdev_device_write_buf() - write data asynchronously
 223  * @serdev:     serdev device
 224  * @buf:        data to be written
 225  * @count:      number of bytes to write
 226  *
 227  * Write data to the device asynchronously.
 228  *
 229  * Note that any accepted data has only been buffered by the controller; use
 230  * serdev_device_wait_until_sent() to make sure the controller write buffer
 231  * has actually been emptied.
 232  *
 233  * Return: The number of bytes written (less than count if not enough room in
 234  * the write buffer), or a negative errno on errors.
 235  */
 236 int serdev_device_write_buf(struct serdev_device *serdev,
 237                             const unsigned char *buf, size_t count)
 238 {
 239         struct serdev_controller *ctrl = serdev->ctrl;
 240
 241         if (!ctrl || !ctrl->ops->write_buf)
 242                 return -EINVAL;
 243
 244         return ctrl->ops->write_buf(ctrl, buf, count);
 245 }
 246 EXPORT_SYMBOL_GPL(serdev_device_write_buf);
 247
 248 /**
 249  * serdev_device_write() - write data synchronously
 250  * @serdev:     serdev device
 251  * @buf:        data to be written
 252  * @count:      number of bytes to write
 253  * @timeout:    timeout in jiffies, or 0 to wait indefinitely
 254  *
 255  * Write data to the device synchronously by repeatedly calling
 256  * serdev_device_write() until the controller has accepted all data (unless
 257  * interrupted by a timeout or a signal).
 258  *
 259  * Note that any accepted data has only been buffered by the controller; use
 260  * serdev_device_wait_until_sent() to make sure the controller write buffer
 261  * has actually been emptied.
 262  *
 263  * Note that this function depends on serdev_device_write_wakeup() being
 264  * called in the serdev driver write_wakeup() callback.
 265  *
 266  * Return: The number of bytes written (less than count if interrupted),
 267  * -ETIMEDOUT or -ERESTARTSYS if interrupted before any bytes were written, or
 268  * a negative errno on errors.
 269  */
 270 int serdev_device_write(struct serdev_device *serdev,
 271                         const unsigned char *buf, size_t count,
 272                         long timeout)
 273 {
 274         struct serdev_controller *ctrl = serdev->ctrl;
 275         int written = 0;
 276         int ret;
 277
 278         if (!ctrl || !ctrl->ops->write_buf || !serdev->ops->write_wakeup)
 279                 return -EINVAL;
 280
 281         if (timeout == 0)
 282                 timeout = MAX_SCHEDULE_TIMEOUT;
 283
 284         mutex_lock(&serdev->write_lock);
 285         do {
 286                 reinit_completion(&serdev->write_comp);
 287
 288                 ret = ctrl->ops->write_buf(ctrl, buf, count);
 289                 if (ret < 0)
 290                         break;
 291
 292                 written += ret;
 293                 buf += ret;
 294                 count -= ret;
 295
 296                 if (count == 0)
 297                         break;
 298
 299                 timeout = wait_for_completion_interruptible_timeout(&serdev->write_comp,
 300                                                                     timeout);
 301         } while (timeout > 0);
 302         mutex_unlock(&serdev->write_lock);
 303
 304         if (ret < 0)
 305                 return ret;
 306
 307         if (timeout <= 0 && written == 0) {
 308                 if (timeout == -ERESTARTSYS)
 309                         return -ERESTARTSYS;
 310                 else
 311                         return -ETIMEDOUT;
 312         }
 313
 314         return written;
 315 }
 316 EXPORT_SYMBOL_GPL(serdev_device_write);
 317
 318 void serdev_device_write_flush(struct serdev_device *serdev)
 319 {
 320         struct serdev_controller *ctrl = serdev->ctrl;
 321
 322         if (!ctrl || !ctrl->ops->write_flush)
 323                 return;
 324
 325         ctrl->ops->write_flush(ctrl);
 326 }
 327 EXPORT_SYMBOL_GPL(serdev_device_write_flush);
 328
 329 int serdev_device_write_room(struct serdev_device *serdev)
 330 {
 331         struct serdev_controller *ctrl = serdev->ctrl;
 332
 333         if (!ctrl || !ctrl->ops->write_room)
 334                 return 0;
 335
 336         return serdev->ctrl->ops->write_room(ctrl);
 337 }
 338 EXPORT_SYMBOL_GPL(serdev_device_write_room);
 339
 340 unsigned int serdev_device_set_baudrate(struct serdev_device *serdev, unsigned int speed)
 341 {
 342         struct serdev_controller *ctrl = serdev->ctrl;
 343
 344         if (!ctrl || !ctrl->ops->set_baudrate)
 345                 return 0;
 346
 347         return ctrl->ops->set_baudrate(ctrl, speed);
 348
 349 }
 350 EXPORT_SYMBOL_GPL(serdev_device_set_baudrate);
 351
 352 void serdev_device_set_flow_control(struct serdev_device *serdev, bool enable)
 353 {
 354         struct serdev_controller *ctrl = serdev->ctrl;
 355
 356         if (!ctrl || !ctrl->ops->set_flow_control)
 357                 return;
 358
 359         ctrl->ops->set_flow_control(ctrl, enable);
 360 }
 361 EXPORT_SYMBOL_GPL(serdev_device_set_flow_control);
 362
 363 int serdev_device_set_parity(struct serdev_device *serdev,
 364                              enum serdev_parity parity)
 365 {
 366         struct serdev_controller *ctrl = serdev->ctrl;
 367
 368         if (!ctrl || !ctrl->ops->set_parity)
 369                 return -ENOTSUPP;
 370
 371         return ctrl->ops->set_parity(ctrl, parity);
 372 }
 373 EXPORT_SYMBOL_GPL(serdev_device_set_parity);
 374
 375 void serdev_device_wait_until_sent(struct serdev_device *serdev, long timeout)
 376 {
 377         struct serdev_controller *ctrl = serdev->ctrl;
 378
 379         if (!ctrl || !ctrl->ops->wait_until_sent)
 380                 return;
 381
 382         ctrl->ops->wait_until_sent(ctrl, timeout);
 383 }
 384 EXPORT_SYMBOL_GPL(serdev_device_wait_until_sent);
 385
 386 int serdev_device_get_tiocm(struct serdev_device *serdev)
 387 {
 388         struct serdev_controller *ctrl = serdev->ctrl;
 389
 390         if (!ctrl || !ctrl->ops->get_tiocm)
 391                 return -ENOTSUPP;
 392
 393         return ctrl->ops->get_tiocm(ctrl);
 394 }
 395 EXPORT_SYMBOL_GPL(serdev_device_get_tiocm);
 396
 397 int serdev_device_set_tiocm(struct serdev_device *serdev, int set, int clear)
 398 {
 399         struct serdev_controller *ctrl = serdev->ctrl;
 400
 401         if (!ctrl || !ctrl->ops->set_tiocm)
 402                 return -ENOTSUPP;
 403
 404         return ctrl->ops->set_tiocm(ctrl, set, clear);
 405 }
 406 EXPORT_SYMBOL_GPL(serdev_device_set_tiocm);
 407
 408 static int serdev_drv_probe(struct device *dev)
 409 {
 410         const struct serdev_device_driver *sdrv = to_serdev_device_driver(dev->driver);
 411         int ret;
 412
 413         ret = dev_pm_domain_attach(dev, true);
 414         if (ret)
 415                 return ret;
 416
 417         ret = sdrv->probe(to_serdev_device(dev));
 418         if (ret)
 419                 dev_pm_domain_detach(dev, true);
 420
 421         return ret;
 422 }
 423
 424 static void serdev_drv_remove(struct device *dev)
 425 {
 426         const struct serdev_device_driver *sdrv = to_serdev_device_driver(dev->driver);
 427         if (sdrv->remove)
 428                 sdrv->remove(to_serdev_device(dev));
 429
 430         dev_pm_domain_detach(dev, true);
 431 }
 432
 433 static struct bus_type serdev_bus_type = {
 434         .name           = "serial",
 435         .match          = serdev_device_match,
 436         .probe          = serdev_drv_probe,
 437         .remove         = serdev_drv_remove,
 438 };
 439
 440 /**
 441  * serdev_device_alloc() - Allocate a new serdev device
 442  * @ctrl:       associated controller
 443  *
 444  * Caller is responsible for either calling serdev_device_add() to add the
 445  * newly allocated controller, or calling serdev_device_put() to discard it.
 446  */
 447 struct serdev_device *serdev_device_alloc(struct serdev_controller *ctrl)
 448 {
 449         struct serdev_device *serdev;
 450
 451         serdev = kzalloc(sizeof(*serdev), GFP_KERNEL);
 452         if (!serdev)
 453                 return NULL;
 454
 455         serdev->ctrl = ctrl;
 456         device_initialize(&serdev->dev);
 457         serdev->dev.parent = &ctrl->dev;
 458         serdev->dev.bus = &serdev_bus_type;
 459         serdev->dev.type = &serdev_device_type;
 460         init_completion(&serdev->write_comp);
 461         mutex_init(&serdev->write_lock);
 462         return serdev;
 463 }
 464 EXPORT_SYMBOL_GPL(serdev_device_alloc);
 465
 466 /**
 467  * serdev_controller_alloc() - Allocate a new serdev controller
 468  * @parent:     parent device
 469  * @size:       size of private data
 470  *
 471  * Caller is responsible for either calling serdev_controller_add() to add the
 472  * newly allocated controller, or calling serdev_controller_put() to discard it.
 473  * The allocated private data region may be accessed via
 474  * serdev_controller_get_drvdata()
 475  */
 476 struct serdev_controller *serdev_controller_alloc(struct device *parent,
 477                                               size_t size)
 478 {
 479         struct serdev_controller *ctrl;
 480         int id;
 481
 482         if (WARN_ON(!parent))
 483                 return NULL;
 484
 485         ctrl = kzalloc(sizeof(*ctrl) + size, GFP_KERNEL);
 486         if (!ctrl)
 487                 return NULL;
 488
 489         id = ida_simple_get(&ctrl_ida, 0, 0, GFP_KERNEL);
 490         if (id < 0) {
 491                 dev_err(parent,
 492                         "unable to allocate serdev controller identifier.\n");
 493                 goto err_free;
 494         }
 495
 496         ctrl->nr = id;
 497
 498         device_initialize(&ctrl->dev);
 499         ctrl->dev.type = &serdev_ctrl_type;
 500         ctrl->dev.bus = &serdev_bus_type;
 501         ctrl->dev.parent = parent;
 502         ctrl->dev.of_node = parent->of_node;
 503         serdev_controller_set_drvdata(ctrl, &ctrl[1]);
 504
 505         dev_set_name(&ctrl->dev, "serial%d", id);
 506
 507         pm_runtime_no_callbacks(&ctrl->dev);
 508         pm_suspend_ignore_children(&ctrl->dev, true);
 509
 510         dev_dbg(&ctrl->dev, "allocated controller 0x%p id %d\n", ctrl, id);
 511         return ctrl;
 512
 513 err_free:
 514         kfree(ctrl);
 515
 516         return NULL;
 517 }
 518 EXPORT_SYMBOL_GPL(serdev_controller_alloc);
 519
 520 static int of_serdev_register_devices(struct serdev_controller *ctrl)
 521 {
 522         struct device_node *node;
 523         struct serdev_device *serdev = NULL;
 524         int err;
 525         bool found = false;
 526
 527         for_each_available_child_of_node(ctrl->dev.of_node, node) {
 528                 if (!of_get_property(node, "compatible", NULL))
 529                         continue;
 530
 531                 dev_dbg(&ctrl->dev, "adding child %pOF\n", node);
 532
 533                 serdev = serdev_device_alloc(ctrl);
 534                 if (!serdev)
 535                         continue;
 536
 537                 serdev->dev.of_node = node;
 538
 539                 err = serdev_device_add(serdev);
 540                 if (err) {
 541                         dev_err(&serdev->dev,
 542                                 "failure adding device. status %pe\n",
 543                                 ERR_PTR(err));
 544                         serdev_device_put(serdev);
 545                 } else
 546                         found = true;
 547         }
 548         if (!found)
 549                 return -ENODEV;
 550
 551         return 0;
 552 }
 553
 554 #ifdef CONFIG_ACPI
 555
 556 #define SERDEV_ACPI_MAX_SCAN_DEPTH 32
 557
 558 struct acpi_serdev_lookup {
 559         acpi_handle device_handle;
 560         acpi_handle controller_handle;
 561         int n;
 562         int index;
 563 };
 564
 565 /**
 566  * serdev_acpi_get_uart_resource - Gets UARTSerialBus resource if type matches
 567  * @ares:       ACPI resource
 568  * @uart:       Pointer to UARTSerialBus resource will be returned here
 569  *
 570  * Checks if the given ACPI resource is of type UARTSerialBus.
 571  * In this case, returns a pointer to it to the caller.
 572  *
 573  * Return: True if resource type is of UARTSerialBus, otherwise false.
 574  */
 575 bool serdev_acpi_get_uart_resource(struct acpi_resource *ares,
 576                                    struct acpi_resource_uart_serialbus **uart)
 577 {
 578         struct acpi_resource_uart_serialbus *sb;
 579
 580         if (ares->type != ACPI_RESOURCE_TYPE_SERIAL_BUS)
 581                 return false;
 582
 583         sb = &ares->data.uart_serial_bus;
 584         if (sb->type != ACPI_RESOURCE_SERIAL_TYPE_UART)
 585                 return false;
 586
 587         *uart = sb;
 588         return true;
 589 }
 590 EXPORT_SYMBOL_GPL(serdev_acpi_get_uart_resource);
 591
 592 static int acpi_serdev_parse_resource(struct acpi_resource *ares, void *data)
 593 {
 594         struct acpi_serdev_lookup *lookup = data;
 595         struct acpi_resource_uart_serialbus *sb;
 596         acpi_status status;
 597
 598         if (!serdev_acpi_get_uart_resource(ares, &sb))
 599                 return 1;
 600
 601         if (lookup->index != -1 && lookup->n++ != lookup->index)
 602                 return 1;
 603
 604         status = acpi_get_handle(lookup->device_handle,
 605                                  sb->resource_source.string_ptr,
 606                                  &lookup->controller_handle);
 607         if (ACPI_FAILURE(status))
 608                 return 1;
 609
 610         /*
 611          * NOTE: Ideally, we would also want to retrieve other properties here,
 612          * once setting them before opening the device is supported by serdev.
 613          */
 614
 615         return 1;
 616 }
 617
 618 static int acpi_serdev_do_lookup(struct acpi_device *adev,
 619                                  struct acpi_serdev_lookup *lookup)
 620 {
 621         struct list_head resource_list;
 622         int ret;
 623
 624         lookup->device_handle = acpi_device_handle(adev);
 625         lookup->controller_handle = NULL;
 626         lookup->n = 0;
 627
 628         INIT_LIST_HEAD(&resource_list);
 629         ret = acpi_dev_get_resources(adev, &resource_list,
 630                                      acpi_serdev_parse_resource, lookup);
 631         acpi_dev_free_resource_list(&resource_list);
 632
 633         if (ret < 0)
 634                 return -EINVAL;
 635
 636         return 0;
 637 }
 638
 639 static int acpi_serdev_check_resources(struct serdev_controller *ctrl,
 640                                        struct acpi_device *adev)
 641 {
 642         struct acpi_serdev_lookup lookup;
 643         int ret;
 644
 645         if (acpi_bus_get_status(adev) || !adev->status.present)
 646                 return -EINVAL;
 647
 648         /* Look for UARTSerialBusV2 resource */
 649         lookup.index = -1;      // we only care for the last device
 650
 651         ret = acpi_serdev_do_lookup(adev, &lookup);
 652         if (ret)
 653                 return ret;
 654
 655         /*
 656          * Apple machines provide an empty resource template, so on those
 657          * machines just look for immediate children with a "baud" property
 658          * (from the _DSM method) instead.
 659          */
 660         if (!lookup.controller_handle && x86_apple_machine &&
 661             !acpi_dev_get_property(adev, "baud", ACPI_TYPE_BUFFER, NULL))
 662                 acpi_get_parent(adev->handle, &lookup.controller_handle);
 663
 664         /* Make sure controller and ResourceSource handle match */
 665         if (ACPI_HANDLE(ctrl->dev.parent) != lookup.controller_handle)
 666                 return -ENODEV;
 667
 668         return 0;
 669 }
 670
 671 static acpi_status acpi_serdev_register_device(struct serdev_controller *ctrl,
 672                                                struct acpi_device *adev)
 673 {
 674         struct serdev_device *serdev;
 675         int err;
 676
 677         serdev = serdev_device_alloc(ctrl);
 678         if (!serdev) {
 679                 dev_err(&ctrl->dev, "failed to allocate serdev device for %s\n",
 680                         dev_name(&adev->dev));
 681                 return AE_NO_MEMORY;
 682         }
 683
 684         ACPI_COMPANION_SET(&serdev->dev, adev);
 685         acpi_device_set_enumerated(adev);
 686
 687         err = serdev_device_add(serdev);
 688         if (err) {
 689                 dev_err(&serdev->dev,
 690                         "failure adding ACPI serdev device. status %pe\n",
 691                         ERR_PTR(err));
 692                 serdev_device_put(serdev);
 693         }
 694
 695         return AE_OK;
 696 }
 697
 698 static const struct acpi_device_id serdev_acpi_devices_blacklist[] = {
 699         { "INT3511", 0 },
 700         { "INT3512", 0 },
 701         { },
 702 };
 703
 704 static acpi_status acpi_serdev_add_device(acpi_handle handle, u32 level,
 705                                           void *data, void **return_value)
 706 {
 707         struct serdev_controller *ctrl = data;
 708         struct acpi_device *adev;
 709
 710         if (acpi_bus_get_device(handle, &adev))
 711                 return AE_OK;
 712
 713         if (acpi_device_enumerated(adev))
 714                 return AE_OK;
 715
 716         /* Skip if black listed */
 717         if (!acpi_match_device_ids(adev, serdev_acpi_devices_blacklist))
 718                 return AE_OK;
 719
 720         if (acpi_serdev_check_resources(ctrl, adev))
 721                 return AE_OK;
 722
 723         return acpi_serdev_register_device(ctrl, adev);
 724 }
 725
 726
 727 static int acpi_serdev_register_devices(struct serdev_controller *ctrl)
 728 {
 729         acpi_status status;
 730
 731         if (!has_acpi_companion(ctrl->dev.parent))
 732                 return -ENODEV;
 733
 734         status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
 735                                      SERDEV_ACPI_MAX_SCAN_DEPTH,
 736                                      acpi_serdev_add_device, NULL, ctrl, NULL);
 737         if (ACPI_FAILURE(status))
 738                 dev_warn(&ctrl->dev, "failed to enumerate serdev slaves\n");
 739
 740         if (!ctrl->serdev)
 741                 return -ENODEV;
 742
 743         return 0;
 744 }
 745 #else
 746 static inline int acpi_serdev_register_devices(struct serdev_controller *ctrl)
 747 {
 748         return -ENODEV;
 749 }
 750 #endif /* CONFIG_ACPI */
 751
 752 /**
 753  * serdev_controller_add() - Add an serdev controller
 754  * @ctrl:       controller to be registered.
 755  *
 756  * Register a controller previously allocated via serdev_controller_alloc() with
 757  * the serdev core.
 758  */
 759 int serdev_controller_add(struct serdev_controller *ctrl)
 760 {
 761         int ret_of, ret_acpi, ret;
 762
 763         /* Can't register until after driver model init */
 764         if (WARN_ON(!is_registered))
 765                 return -EAGAIN;
 766
 767         ret = device_add(&ctrl->dev);
 768         if (ret)
 769                 return ret;
 770
 771         pm_runtime_enable(&ctrl->dev);
 772
 773         ret_of = of_serdev_register_devices(ctrl);
 774         ret_acpi = acpi_serdev_register_devices(ctrl);
 775         if (ret_of && ret_acpi) {
 776                 dev_dbg(&ctrl->dev, "no devices registered: of:%pe acpi:%pe\n",
 777                         ERR_PTR(ret_of), ERR_PTR(ret_acpi));
 778                 ret = -ENODEV;
 779                 goto err_rpm_disable;
 780         }
 781
 782         dev_dbg(&ctrl->dev, "serdev%d registered: dev:%p\n",
 783                 ctrl->nr, &ctrl->dev);
 784         return 0;
 785
 786 err_rpm_disable:
 787         pm_runtime_disable(&ctrl->dev);
 788         device_del(&ctrl->dev);
 789         return ret;
 790 };
 791 EXPORT_SYMBOL_GPL(serdev_controller_add);
 792
 793 /* Remove a device associated with a controller */
 794 static int serdev_remove_device(struct device *dev, void *data)
 795 {
 796         struct serdev_device *serdev = to_serdev_device(dev);
 797         if (dev->type == &serdev_device_type)
 798                 serdev_device_remove(serdev);
 799         return 0;
 800 }
 801
 802 /**
 803  * serdev_controller_remove(): remove an serdev controller
 804  * @ctrl:       controller to remove
 805  *
 806  * Remove a serdev controller.  Caller is responsible for calling
 807  * serdev_controller_put() to discard the allocated controller.
 808  */
 809 void serdev_controller_remove(struct serdev_controller *ctrl)
 810 {
 811         if (!ctrl)
 812                 return;
 813
 814         device_for_each_child(&ctrl->dev, NULL, serdev_remove_device);
 815         pm_runtime_disable(&ctrl->dev);
 816         device_del(&ctrl->dev);
 817 }
 818 EXPORT_SYMBOL_GPL(serdev_controller_remove);
 819
 820 /**
 821  * __serdev_device_driver_register() - Register client driver with serdev core
 822  * @sdrv:       client driver to be associated with client-device.
 823  * @owner:      client driver owner to set.
 824  *
 825  * This API will register the client driver with the serdev framework.
 826  * It is typically called from the driver's module-init function.
 827  */
 828 int __serdev_device_driver_register(struct serdev_device_driver *sdrv, struct module *owner)
 829 {
 830         sdrv->driver.bus = &serdev_bus_type;
 831         sdrv->driver.owner = owner;
 832
 833         /* force drivers to async probe so I/O is possible in probe */
 834         sdrv->driver.probe_type = PROBE_PREFER_ASYNCHRONOUS;
 835
 836         return driver_register(&sdrv->driver);
 837 }
 838 EXPORT_SYMBOL_GPL(__serdev_device_driver_register);
 839
 840 static void __exit serdev_exit(void)
 841 {
 842         bus_unregister(&serdev_bus_type);
 843         ida_destroy(&ctrl_ida);
 844 }
 845 module_exit(serdev_exit);
 846
 847 static int __init serdev_init(void)
 848 {
 849         int ret;
 850
 851         ret = bus_register(&serdev_bus_type);
 852         if (ret)
 853                 return ret;
 854
 855         is_registered = true;
 856         return 0;
 857 }
 858 /* Must be before serial drivers register */
 859 postcore_initcall(serdev_init);
 860
 861 MODULE_AUTHOR("Rob Herring <robh@kernel.org>");
 862 MODULE_LICENSE("GPL v2");
 863 MODULE_DESCRIPTION("Serial attached device bus");