drivers/misc/mei/bus.c

   1 /*
   2  * Intel Management Engine Interface (Intel MEI) Linux driver
   3  * Copyright (c) 2012-2013, Intel Corporation.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms and conditions of the GNU General Public License,
   7  * version 2, as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  *
  14  */
  15
  16 #include <linux/module.h>
  17 #include <linux/device.h>
  18 #include <linux/kernel.h>
  19 #include <linux/sched/signal.h>
  20 #include <linux/init.h>
  21 #include <linux/errno.h>
  22 #include <linux/slab.h>
  23 #include <linux/mutex.h>
  24 #include <linux/interrupt.h>
  25 #include <linux/mei_cl_bus.h>
  26
  27 #include "mei_dev.h"
  28 #include "client.h"
  29
  30 #define to_mei_cl_driver(d) container_of(d, struct mei_cl_driver, driver)
  31 #define to_mei_cl_device(d) container_of(d, struct mei_cl_device, dev)
  32
  33 /**
  34  * __mei_cl_send - internal client send (write)
  35  *
  36  * @cl: host client
  37  * @buf: buffer to send
  38  * @length: buffer length
  39  * @mode: sending mode
  40  *
  41  * Return: written size bytes or < 0 on error
  42  */
  43 ssize_t __mei_cl_send(struct mei_cl *cl, u8 *buf, size_t length,
  44                       unsigned int mode)
  45 {
  46         struct mei_device *bus;
  47         struct mei_cl_cb *cb;
  48         ssize_t rets;
  49
  50         if (WARN_ON(!cl || !cl->dev))
  51                 return -ENODEV;
  52
  53         bus = cl->dev;
  54
  55         mutex_lock(&bus->device_lock);
  56         if (bus->dev_state != MEI_DEV_ENABLED) {
  57                 rets = -ENODEV;
  58                 goto out;
  59         }
  60
  61         if (!mei_cl_is_connected(cl)) {
  62                 rets = -ENODEV;
  63                 goto out;
  64         }
  65
  66         /* Check if we have an ME client device */
  67         if (!mei_me_cl_is_active(cl->me_cl)) {
  68                 rets = -ENOTTY;
  69                 goto out;
  70         }
  71
  72         if (length > mei_cl_mtu(cl)) {
  73                 rets = -EFBIG;
  74                 goto out;
  75         }
  76
  77         while (cl->tx_cb_queued >= bus->tx_queue_limit) {
  78                 mutex_unlock(&bus->device_lock);
  79                 rets = wait_event_interruptible(cl->tx_wait,
  80                                 cl->writing_state == MEI_WRITE_COMPLETE ||
  81                                 (!mei_cl_is_connected(cl)));
  82                 mutex_lock(&bus->device_lock);
  83                 if (rets) {
  84                         if (signal_pending(current))
  85                                 rets = -EINTR;
  86                         goto out;
  87                 }
  88                 if (!mei_cl_is_connected(cl)) {
  89                         rets = -ENODEV;
  90                         goto out;
  91                 }
  92         }
  93
  94         cb = mei_cl_alloc_cb(cl, length, MEI_FOP_WRITE, NULL);
  95         if (!cb) {
  96                 rets = -ENOMEM;
  97                 goto out;
  98         }
  99
 100         cb->internal = !!(mode & MEI_CL_IO_TX_INTERNAL);
 101         cb->blocking = !!(mode & MEI_CL_IO_TX_BLOCKING);
 102         memcpy(cb->buf.data, buf, length);
 103
 104         rets = mei_cl_write(cl, cb);
 105
 106 out:
 107         mutex_unlock(&bus->device_lock);
 108
 109         return rets;
 110 }
 111
 112 /**
 113  * __mei_cl_recv - internal client receive (read)
 114  *
 115  * @cl: host client
 116  * @buf: buffer to receive
 117  * @length: buffer length
 118  * @mode: io mode
 119  * @timeout: recv timeout, 0 for infinite timeout
 120  *
 121  * Return: read size in bytes of < 0 on error
 122  */
 123 ssize_t __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length,
 124                       unsigned int mode, unsigned long timeout)
 125 {
 126         struct mei_device *bus;
 127         struct mei_cl_cb *cb;
 128         size_t r_length;
 129         ssize_t rets;
 130         bool nonblock = !!(mode & MEI_CL_IO_RX_NONBLOCK);
 131
 132         if (WARN_ON(!cl || !cl->dev))
 133                 return -ENODEV;
 134
 135         bus = cl->dev;
 136
 137         mutex_lock(&bus->device_lock);
 138         if (bus->dev_state != MEI_DEV_ENABLED) {
 139                 rets = -ENODEV;
 140                 goto out;
 141         }
 142
 143         cb = mei_cl_read_cb(cl, NULL);
 144         if (cb)
 145                 goto copy;
 146
 147         rets = mei_cl_read_start(cl, length, NULL);
 148         if (rets && rets != -EBUSY)
 149                 goto out;
 150
 151         if (nonblock) {
 152                 rets = -EAGAIN;
 153                 goto out;
 154         }
 155
 156         /* wait on event only if there is no other waiter */
 157         /* synchronized under device mutex */
 158         if (!waitqueue_active(&cl->rx_wait)) {
 159
 160                 mutex_unlock(&bus->device_lock);
 161
 162                 if (timeout) {
 163                         rets = wait_event_interruptible_timeout
 164                                         (cl->rx_wait,
 165                                         (!list_empty(&cl->rd_completed)) ||
 166                                         (!mei_cl_is_connected(cl)),
 167                                         msecs_to_jiffies(timeout));
 168                         if (rets == 0)
 169                                 return -ETIME;
 170                         if (rets < 0) {
 171                                 if (signal_pending(current))
 172                                         return -EINTR;
 173                                 return -ERESTARTSYS;
 174                         }
 175                 } else {
 176                         if (wait_event_interruptible
 177                                         (cl->rx_wait,
 178                                         (!list_empty(&cl->rd_completed)) ||
 179                                         (!mei_cl_is_connected(cl)))) {
 180                                 if (signal_pending(current))
 181                                         return -EINTR;
 182                                 return -ERESTARTSYS;
 183                         }
 184                 }
 185
 186                 mutex_lock(&bus->device_lock);
 187
 188                 if (!mei_cl_is_connected(cl)) {
 189                         rets = -ENODEV;
 190                         goto out;
 191                 }
 192         }
 193
 194         cb = mei_cl_read_cb(cl, NULL);
 195         if (!cb) {
 196                 rets = 0;
 197                 goto out;
 198         }
 199
 200 copy:
 201         if (cb->status) {
 202                 rets = cb->status;
 203                 goto free;
 204         }
 205
 206         r_length = min_t(size_t, length, cb->buf_idx);
 207         memcpy(buf, cb->buf.data, r_length);
 208         rets = r_length;
 209
 210 free:
 211         mei_io_cb_free(cb);
 212 out:
 213         mutex_unlock(&bus->device_lock);
 214
 215         return rets;
 216 }
 217
 218 /**
 219  * mei_cldev_send - me device send  (write)
 220  *
 221  * @cldev: me client device
 222  * @buf: buffer to send
 223  * @length: buffer length
 224  *
 225  * Return: written size in bytes or < 0 on error
 226  */
 227 ssize_t mei_cldev_send(struct mei_cl_device *cldev, u8 *buf, size_t length)
 228 {
 229         struct mei_cl *cl = cldev->cl;
 230
 231         return __mei_cl_send(cl, buf, length, MEI_CL_IO_TX_BLOCKING);
 232 }
 233 EXPORT_SYMBOL_GPL(mei_cldev_send);
 234
 235 /**
 236  * mei_cldev_recv_nonblock - non block client receive (read)
 237  *
 238  * @cldev: me client device
 239  * @buf: buffer to receive
 240  * @length: buffer length
 241  *
 242  * Return: read size in bytes of < 0 on error
 243  *         -EAGAIN if function will block.
 244  */
 245 ssize_t mei_cldev_recv_nonblock(struct mei_cl_device *cldev, u8 *buf,
 246                                 size_t length)
 247 {
 248         struct mei_cl *cl = cldev->cl;
 249
 250         return __mei_cl_recv(cl, buf, length, MEI_CL_IO_RX_NONBLOCK, 0);
 251 }
 252 EXPORT_SYMBOL_GPL(mei_cldev_recv_nonblock);
 253
 254 /**
 255  * mei_cldev_recv - client receive (read)
 256  *
 257  * @cldev: me client device
 258  * @buf: buffer to receive
 259  * @length: buffer length
 260  *
 261  * Return: read size in bytes of < 0 on error
 262  */
 263 ssize_t mei_cldev_recv(struct mei_cl_device *cldev, u8 *buf, size_t length)
 264 {
 265         struct mei_cl *cl = cldev->cl;
 266
 267         return __mei_cl_recv(cl, buf, length, 0, 0);
 268 }
 269 EXPORT_SYMBOL_GPL(mei_cldev_recv);
 270
 271 /**
 272  * mei_cl_bus_rx_work - dispatch rx event for a bus device
 273  *
 274  * @work: work
 275  */
 276 static void mei_cl_bus_rx_work(struct work_struct *work)
 277 {
 278         struct mei_cl_device *cldev;
 279         struct mei_device *bus;
 280
 281         cldev = container_of(work, struct mei_cl_device, rx_work);
 282
 283         bus = cldev->bus;
 284
 285         if (cldev->rx_cb)
 286                 cldev->rx_cb(cldev);
 287
 288         mutex_lock(&bus->device_lock);
 289         mei_cl_read_start(cldev->cl, mei_cl_mtu(cldev->cl), NULL);
 290         mutex_unlock(&bus->device_lock);
 291 }
 292
 293 /**
 294  * mei_cl_bus_notif_work - dispatch FW notif event for a bus device
 295  *
 296  * @work: work
 297  */
 298 static void mei_cl_bus_notif_work(struct work_struct *work)
 299 {
 300         struct mei_cl_device *cldev;
 301
 302         cldev = container_of(work, struct mei_cl_device, notif_work);
 303
 304         if (cldev->notif_cb)
 305                 cldev->notif_cb(cldev);
 306 }
 307
 308 /**
 309  * mei_cl_bus_notify_event - schedule notify cb on bus client
 310  *
 311  * @cl: host client
 312  *
 313  * Return: true if event was scheduled
 314  *         false if the client is not waiting for event
 315  */
 316 bool mei_cl_bus_notify_event(struct mei_cl *cl)
 317 {
 318         struct mei_cl_device *cldev = cl->cldev;
 319
 320         if (!cldev || !cldev->notif_cb)
 321                 return false;
 322
 323         if (!cl->notify_ev)
 324                 return false;
 325
 326         schedule_work(&cldev->notif_work);
 327
 328         cl->notify_ev = false;
 329
 330         return true;
 331 }
 332
 333 /**
 334  * mei_cl_bus_rx_event - schedule rx event
 335  *
 336  * @cl: host client
 337  *
 338  * Return: true if event was scheduled
 339  *         false if the client is not waiting for event
 340  */
 341 bool mei_cl_bus_rx_event(struct mei_cl *cl)
 342 {
 343         struct mei_cl_device *cldev = cl->cldev;
 344
 345         if (!cldev || !cldev->rx_cb)
 346                 return false;
 347
 348         schedule_work(&cldev->rx_work);
 349
 350         return true;
 351 }
 352
 353 /**
 354  * mei_cldev_register_rx_cb - register Rx event callback
 355  *
 356  * @cldev: me client devices
 357  * @rx_cb: callback function
 358  *
 359  * Return: 0 on success
 360  *         -EALREADY if an callback is already registered
 361  *         <0 on other errors
 362  */
 363 int mei_cldev_register_rx_cb(struct mei_cl_device *cldev, mei_cldev_cb_t rx_cb)
 364 {
 365         struct mei_device *bus = cldev->bus;
 366         int ret;
 367
 368         if (!rx_cb)
 369                 return -EINVAL;
 370         if (cldev->rx_cb)
 371                 return -EALREADY;
 372
 373         cldev->rx_cb = rx_cb;
 374         INIT_WORK(&cldev->rx_work, mei_cl_bus_rx_work);
 375
 376         mutex_lock(&bus->device_lock);
 377         ret = mei_cl_read_start(cldev->cl, mei_cl_mtu(cldev->cl), NULL);
 378         mutex_unlock(&bus->device_lock);
 379         if (ret && ret != -EBUSY)
 380                 return ret;
 381
 382         return 0;
 383 }
 384 EXPORT_SYMBOL_GPL(mei_cldev_register_rx_cb);
 385
 386 /**
 387  * mei_cldev_register_notif_cb - register FW notification event callback
 388  *
 389  * @cldev: me client devices
 390  * @notif_cb: callback function
 391  *
 392  * Return: 0 on success
 393  *         -EALREADY if an callback is already registered
 394  *         <0 on other errors
 395  */
 396 int mei_cldev_register_notif_cb(struct mei_cl_device *cldev,
 397                                 mei_cldev_cb_t notif_cb)
 398 {
 399         struct mei_device *bus = cldev->bus;
 400         int ret;
 401
 402         if (!notif_cb)
 403                 return -EINVAL;
 404
 405         if (cldev->notif_cb)
 406                 return -EALREADY;
 407
 408         cldev->notif_cb = notif_cb;
 409         INIT_WORK(&cldev->notif_work, mei_cl_bus_notif_work);
 410
 411         mutex_lock(&bus->device_lock);
 412         ret = mei_cl_notify_request(cldev->cl, NULL, 1);
 413         mutex_unlock(&bus->device_lock);
 414         if (ret)
 415                 return ret;
 416
 417         return 0;
 418 }
 419 EXPORT_SYMBOL_GPL(mei_cldev_register_notif_cb);
 420
 421 /**
 422  * mei_cldev_get_drvdata - driver data getter
 423  *
 424  * @cldev: mei client device
 425  *
 426  * Return: driver private data
 427  */
 428 void *mei_cldev_get_drvdata(const struct mei_cl_device *cldev)
 429 {
 430         return dev_get_drvdata(&cldev->dev);
 431 }
 432 EXPORT_SYMBOL_GPL(mei_cldev_get_drvdata);
 433
 434 /**
 435  * mei_cldev_set_drvdata - driver data setter
 436  *
 437  * @cldev: mei client device
 438  * @data: data to store
 439  */
 440 void mei_cldev_set_drvdata(struct mei_cl_device *cldev, void *data)
 441 {
 442         dev_set_drvdata(&cldev->dev, data);
 443 }
 444 EXPORT_SYMBOL_GPL(mei_cldev_set_drvdata);
 445
 446 /**
 447  * mei_cldev_uuid - return uuid of the underlying me client
 448  *
 449  * @cldev: mei client device
 450  *
 451  * Return: me client uuid
 452  */
 453 const uuid_le *mei_cldev_uuid(const struct mei_cl_device *cldev)
 454 {
 455         return mei_me_cl_uuid(cldev->me_cl);
 456 }
 457 EXPORT_SYMBOL_GPL(mei_cldev_uuid);
 458
 459 /**
 460  * mei_cldev_ver - return protocol version of the underlying me client
 461  *
 462  * @cldev: mei client device
 463  *
 464  * Return: me client protocol version
 465  */
 466 u8 mei_cldev_ver(const struct mei_cl_device *cldev)
 467 {
 468         return mei_me_cl_ver(cldev->me_cl);
 469 }
 470 EXPORT_SYMBOL_GPL(mei_cldev_ver);
 471
 472 /**
 473  * mei_cldev_enabled - check whether the device is enabled
 474  *
 475  * @cldev: mei client device
 476  *
 477  * Return: true if me client is initialized and connected
 478  */
 479 bool mei_cldev_enabled(struct mei_cl_device *cldev)
 480 {
 481         return mei_cl_is_connected(cldev->cl);
 482 }
 483 EXPORT_SYMBOL_GPL(mei_cldev_enabled);
 484
 485 /**
 486  * mei_cl_bus_module_get - acquire module of the underlying
 487  *    hw driver.
 488  *
 489  * @cldev: mei client device
 490  *
 491  * Return: true on success; false if the module was removed.
 492  */
 493 static bool mei_cl_bus_module_get(struct mei_cl_device *cldev)
 494 {
 495         return try_module_get(cldev->bus->dev->driver->owner);
 496 }
 497
 498 /**
 499  * mei_cl_bus_module_put -  release the underlying hw module.
 500  *
 501  * @cldev: mei client device
 502  */
 503 static void mei_cl_bus_module_put(struct mei_cl_device *cldev)
 504 {
 505         module_put(cldev->bus->dev->driver->owner);
 506 }
 507
 508 /**
 509  * mei_cldev_enable - enable me client device
 510  *     create connection with me client
 511  *
 512  * @cldev: me client device
 513  *
 514  * Return: 0 on success and < 0 on error
 515  */
 516 int mei_cldev_enable(struct mei_cl_device *cldev)
 517 {
 518         struct mei_device *bus = cldev->bus;
 519         struct mei_cl *cl;
 520         int ret;
 521
 522         cl = cldev->cl;
 523
 524         mutex_lock(&bus->device_lock);
 525         if (cl->state == MEI_FILE_UNINITIALIZED) {
 526                 ret = mei_cl_link(cl);
 527                 if (ret)
 528                         goto out;
 529                 /* update pointers */
 530                 cl->cldev = cldev;
 531         }
 532
 533         if (mei_cl_is_connected(cl)) {
 534                 ret = 0;
 535                 goto out;
 536         }
 537
 538         if (!mei_me_cl_is_active(cldev->me_cl)) {
 539                 dev_err(&cldev->dev, "me client is not active\n");
 540                 ret = -ENOTTY;
 541                 goto out;
 542         }
 543
 544         ret = mei_cl_connect(cl, cldev->me_cl, NULL);
 545         if (ret < 0)
 546                 dev_err(&cldev->dev, "cannot connect\n");
 547
 548 out:
 549         mutex_unlock(&bus->device_lock);
 550
 551         return ret;
 552 }
 553 EXPORT_SYMBOL_GPL(mei_cldev_enable);
 554
 555 /**
 556  * mei_cldev_unregister_callbacks - internal wrapper for unregistering
 557  *  callbacks.
 558  *
 559  * @cldev: client device
 560  */
 561 static void mei_cldev_unregister_callbacks(struct mei_cl_device *cldev)
 562 {
 563         if (cldev->rx_cb) {
 564                 cancel_work_sync(&cldev->rx_work);
 565                 cldev->rx_cb = NULL;
 566         }
 567
 568         if (cldev->notif_cb) {
 569                 cancel_work_sync(&cldev->notif_work);
 570                 cldev->notif_cb = NULL;
 571         }
 572 }
 573
 574 /**
 575  * mei_cldev_disable - disable me client device
 576  *     disconnect form the me client
 577  *
 578  * @cldev: me client device
 579  *
 580  * Return: 0 on success and < 0 on error
 581  */
 582 int mei_cldev_disable(struct mei_cl_device *cldev)
 583 {
 584         struct mei_device *bus;
 585         struct mei_cl *cl;
 586         int err;
 587
 588         if (!cldev)
 589                 return -ENODEV;
 590
 591         cl = cldev->cl;
 592
 593         bus = cldev->bus;
 594
 595         mei_cldev_unregister_callbacks(cldev);
 596
 597         mutex_lock(&bus->device_lock);
 598
 599         if (!mei_cl_is_connected(cl)) {
 600                 dev_dbg(bus->dev, "Already disconnected\n");
 601                 err = 0;
 602                 goto out;
 603         }
 604
 605         err = mei_cl_disconnect(cl);
 606         if (err < 0)
 607                 dev_err(bus->dev, "Could not disconnect from the ME client\n");
 608
 609 out:
 610         /* Flush queues and remove any pending read */
 611         mei_cl_flush_queues(cl, NULL);
 612         mei_cl_unlink(cl);
 613
 614         mutex_unlock(&bus->device_lock);
 615         return err;
 616 }
 617 EXPORT_SYMBOL_GPL(mei_cldev_disable);
 618
 619 /**
 620  * mei_cl_device_find - find matching entry in the driver id table
 621  *
 622  * @cldev: me client device
 623  * @cldrv: me client driver
 624  *
 625  * Return: id on success; NULL if no id is matching
 626  */
 627 static const
 628 struct mei_cl_device_id *mei_cl_device_find(struct mei_cl_device *cldev,
 629                                             struct mei_cl_driver *cldrv)
 630 {
 631         const struct mei_cl_device_id *id;
 632         const uuid_le *uuid;
 633         u8 version;
 634         bool match;
 635
 636         uuid = mei_me_cl_uuid(cldev->me_cl);
 637         version = mei_me_cl_ver(cldev->me_cl);
 638
 639         id = cldrv->id_table;
 640         while (uuid_le_cmp(NULL_UUID_LE, id->uuid)) {
 641                 if (!uuid_le_cmp(*uuid, id->uuid)) {
 642                         match = true;
 643
 644                         if (cldev->name[0])
 645                                 if (strncmp(cldev->name, id->name,
 646                                             sizeof(id->name)))
 647                                         match = false;
 648
 649                         if (id->version != MEI_CL_VERSION_ANY)
 650                                 if (id->version != version)
 651                                         match = false;
 652                         if (match)
 653                                 return id;
 654                 }
 655
 656                 id++;
 657         }
 658
 659         return NULL;
 660 }
 661
 662 /**
 663  * mei_cl_device_match  - device match function
 664  *
 665  * @dev: device
 666  * @drv: driver
 667  *
 668  * Return:  1 if matching device was found 0 otherwise
 669  */
 670 static int mei_cl_device_match(struct device *dev, struct device_driver *drv)
 671 {
 672         struct mei_cl_device *cldev = to_mei_cl_device(dev);
 673         struct mei_cl_driver *cldrv = to_mei_cl_driver(drv);
 674         const struct mei_cl_device_id *found_id;
 675
 676         if (!cldev)
 677                 return 0;
 678
 679         if (!cldev->do_match)
 680                 return 0;
 681
 682         if (!cldrv || !cldrv->id_table)
 683                 return 0;
 684
 685         found_id = mei_cl_device_find(cldev, cldrv);
 686         if (found_id)
 687                 return 1;
 688
 689         return 0;
 690 }
 691
 692 /**
 693  * mei_cl_device_probe - bus probe function
 694  *
 695  * @dev: device
 696  *
 697  * Return:  0 on success; < 0 otherwise
 698  */
 699 static int mei_cl_device_probe(struct device *dev)
 700 {
 701         struct mei_cl_device *cldev;
 702         struct mei_cl_driver *cldrv;
 703         const struct mei_cl_device_id *id;
 704         int ret;
 705
 706         cldev = to_mei_cl_device(dev);
 707         cldrv = to_mei_cl_driver(dev->driver);
 708
 709         if (!cldev)
 710                 return 0;
 711
 712         if (!cldrv || !cldrv->probe)
 713                 return -ENODEV;
 714
 715         id = mei_cl_device_find(cldev, cldrv);
 716         if (!id)
 717                 return -ENODEV;
 718
 719         if (!mei_cl_bus_module_get(cldev)) {
 720                 dev_err(&cldev->dev, "get hw module failed");
 721                 return -ENODEV;
 722         }
 723
 724         ret = cldrv->probe(cldev, id);
 725         if (ret) {
 726                 mei_cl_bus_module_put(cldev);
 727                 return ret;
 728         }
 729
 730         __module_get(THIS_MODULE);
 731         return 0;
 732 }
 733
 734 /**
 735  * mei_cl_device_remove - remove device from the bus
 736  *
 737  * @dev: device
 738  *
 739  * Return:  0 on success; < 0 otherwise
 740  */
 741 static int mei_cl_device_remove(struct device *dev)
 742 {
 743         struct mei_cl_device *cldev = to_mei_cl_device(dev);
 744         struct mei_cl_driver *cldrv;
 745         int ret = 0;
 746
 747         if (!cldev || !dev->driver)
 748                 return 0;
 749
 750         cldrv = to_mei_cl_driver(dev->driver);
 751         if (cldrv->remove)
 752                 ret = cldrv->remove(cldev);
 753
 754         mei_cldev_unregister_callbacks(cldev);
 755
 756         mei_cl_bus_module_put(cldev);
 757         module_put(THIS_MODULE);
 758
 759         return ret;
 760 }
 761
 762 static ssize_t name_show(struct device *dev, struct device_attribute *a,
 763                              char *buf)
 764 {
 765         struct mei_cl_device *cldev = to_mei_cl_device(dev);
 766
 767         return scnprintf(buf, PAGE_SIZE, "%s", cldev->name);
 768 }
 769 static DEVICE_ATTR_RO(name);
 770
 771 static ssize_t uuid_show(struct device *dev, struct device_attribute *a,
 772                              char *buf)
 773 {
 774         struct mei_cl_device *cldev = to_mei_cl_device(dev);
 775         const uuid_le *uuid = mei_me_cl_uuid(cldev->me_cl);
 776
 777         return scnprintf(buf, PAGE_SIZE, "%pUl", uuid);
 778 }
 779 static DEVICE_ATTR_RO(uuid);
 780
 781 static ssize_t version_show(struct device *dev, struct device_attribute *a,
 782                              char *buf)
 783 {
 784         struct mei_cl_device *cldev = to_mei_cl_device(dev);
 785         u8 version = mei_me_cl_ver(cldev->me_cl);
 786
 787         return scnprintf(buf, PAGE_SIZE, "%02X", version);
 788 }
 789 static DEVICE_ATTR_RO(version);
 790
 791 static ssize_t modalias_show(struct device *dev, struct device_attribute *a,
 792                              char *buf)
 793 {
 794         struct mei_cl_device *cldev = to_mei_cl_device(dev);
 795         const uuid_le *uuid = mei_me_cl_uuid(cldev->me_cl);
 796         u8 version = mei_me_cl_ver(cldev->me_cl);
 797
 798         return scnprintf(buf, PAGE_SIZE, "mei:%s:%pUl:%02X:",
 799                          cldev->name, uuid, version);
 800 }
 801 static DEVICE_ATTR_RO(modalias);
 802
 803 static struct attribute *mei_cldev_attrs[] = {
 804         &dev_attr_name.attr,
 805         &dev_attr_uuid.attr,
 806         &dev_attr_version.attr,
 807         &dev_attr_modalias.attr,
 808         NULL,
 809 };
 810 ATTRIBUTE_GROUPS(mei_cldev);
 811
 812 /**
 813  * mei_cl_device_uevent - me client bus uevent handler
 814  *
 815  * @dev: device
 816  * @env: uevent kobject
 817  *
 818  * Return: 0 on success -ENOMEM on when add_uevent_var fails
 819  */
 820 static int mei_cl_device_uevent(struct device *dev, struct kobj_uevent_env *env)
 821 {
 822         struct mei_cl_device *cldev = to_mei_cl_device(dev);
 823         const uuid_le *uuid = mei_me_cl_uuid(cldev->me_cl);
 824         u8 version = mei_me_cl_ver(cldev->me_cl);
 825
 826         if (add_uevent_var(env, "MEI_CL_VERSION=%d", version))
 827                 return -ENOMEM;
 828
 829         if (add_uevent_var(env, "MEI_CL_UUID=%pUl", uuid))
 830                 return -ENOMEM;
 831
 832         if (add_uevent_var(env, "MEI_CL_NAME=%s", cldev->name))
 833                 return -ENOMEM;
 834
 835         if (add_uevent_var(env, "MODALIAS=mei:%s:%pUl:%02X:",
 836                            cldev->name, uuid, version))
 837                 return -ENOMEM;
 838
 839         return 0;
 840 }
 841
 842 static struct bus_type mei_cl_bus_type = {
 843         .name           = "mei",
 844         .dev_groups     = mei_cldev_groups,
 845         .match          = mei_cl_device_match,
 846         .probe          = mei_cl_device_probe,
 847         .remove         = mei_cl_device_remove,
 848         .uevent         = mei_cl_device_uevent,
 849 };
 850
 851 static struct mei_device *mei_dev_bus_get(struct mei_device *bus)
 852 {
 853         if (bus)
 854                 get_device(bus->dev);
 855
 856         return bus;
 857 }
 858
 859 static void mei_dev_bus_put(struct mei_device *bus)
 860 {
 861         if (bus)
 862                 put_device(bus->dev);
 863 }
 864
 865 static void mei_cl_bus_dev_release(struct device *dev)
 866 {
 867         struct mei_cl_device *cldev = to_mei_cl_device(dev);
 868
 869         if (!cldev)
 870                 return;
 871
 872         mei_me_cl_put(cldev->me_cl);
 873         mei_dev_bus_put(cldev->bus);
 874         mei_cl_unlink(cldev->cl);
 875         kfree(cldev->cl);
 876         kfree(cldev);
 877 }
 878
 879 static const struct device_type mei_cl_device_type = {
 880         .release = mei_cl_bus_dev_release,
 881 };
 882
 883 /**
 884  * mei_cl_bus_set_name - set device name for me client device
 885  *  <controller>-<client device>
 886  *  Example: 0000:00:16.0-55213584-9a29-4916-badf-0fb7ed682aeb
 887  *
 888  * @cldev: me client device
 889  */
 890 static inline void mei_cl_bus_set_name(struct mei_cl_device *cldev)
 891 {
 892         dev_set_name(&cldev->dev, "%s-%pUl",
 893                      dev_name(cldev->bus->dev),
 894                      mei_me_cl_uuid(cldev->me_cl));
 895 }
 896
 897 /**
 898  * mei_cl_bus_dev_alloc - initialize and allocate mei client device
 899  *
 900  * @bus: mei device
 901  * @me_cl: me client
 902  *
 903  * Return: allocated device structur or NULL on allocation failure
 904  */
 905 static struct mei_cl_device *mei_cl_bus_dev_alloc(struct mei_device *bus,
 906                                                   struct mei_me_client *me_cl)
 907 {
 908         struct mei_cl_device *cldev;
 909         struct mei_cl *cl;
 910
 911         cldev = kzalloc(sizeof(struct mei_cl_device), GFP_KERNEL);
 912         if (!cldev)
 913                 return NULL;
 914
 915         cl = mei_cl_allocate(bus);
 916         if (!cl) {
 917                 kfree(cldev);
 918                 return NULL;
 919         }
 920
 921         device_initialize(&cldev->dev);
 922         cldev->dev.parent = bus->dev;
 923         cldev->dev.bus    = &mei_cl_bus_type;
 924         cldev->dev.type   = &mei_cl_device_type;
 925         cldev->bus        = mei_dev_bus_get(bus);
 926         cldev->me_cl      = mei_me_cl_get(me_cl);
 927         cldev->cl         = cl;
 928         mei_cl_bus_set_name(cldev);
 929         cldev->is_added   = 0;
 930         INIT_LIST_HEAD(&cldev->bus_list);
 931
 932         return cldev;
 933 }
 934
 935 /**
 936  * mei_cl_dev_setup - setup me client device
 937  *    run fix up routines and set the device name
 938  *
 939  * @bus: mei device
 940  * @cldev: me client device
 941  *
 942  * Return: true if the device is eligible for enumeration
 943  */
 944 static bool mei_cl_bus_dev_setup(struct mei_device *bus,
 945                                  struct mei_cl_device *cldev)
 946 {
 947         cldev->do_match = 1;
 948         mei_cl_bus_dev_fixup(cldev);
 949
 950         /* the device name can change during fix up */
 951         if (cldev->do_match)
 952                 mei_cl_bus_set_name(cldev);
 953
 954         return cldev->do_match == 1;
 955 }
 956
 957 /**
 958  * mei_cl_bus_dev_add - add me client devices
 959  *
 960  * @cldev: me client device
 961  *
 962  * Return: 0 on success; < 0 on failre
 963  */
 964 static int mei_cl_bus_dev_add(struct mei_cl_device *cldev)
 965 {
 966         int ret;
 967
 968         dev_dbg(cldev->bus->dev, "adding %pUL:%02X\n",
 969                 mei_me_cl_uuid(cldev->me_cl),
 970                 mei_me_cl_ver(cldev->me_cl));
 971         ret = device_add(&cldev->dev);
 972         if (!ret)
 973                 cldev->is_added = 1;
 974
 975         return ret;
 976 }
 977
 978 /**
 979  * mei_cl_bus_dev_stop - stop the driver
 980  *
 981  * @cldev: me client device
 982  */
 983 static void mei_cl_bus_dev_stop(struct mei_cl_device *cldev)
 984 {
 985         if (cldev->is_added)
 986                 device_release_driver(&cldev->dev);
 987 }
 988
 989 /**
 990  * mei_cl_bus_dev_destroy - destroy me client devices object
 991  *
 992  * @cldev: me client device
 993  *
 994  * Locking: called under "dev->cl_bus_lock" lock
 995  */
 996 static void mei_cl_bus_dev_destroy(struct mei_cl_device *cldev)
 997 {
 998
 999         WARN_ON(!mutex_is_locked(&cldev->bus->cl_bus_lock));
1000
1001         if (!cldev->is_added)
1002                 return;
1003
1004         device_del(&cldev->dev);
1005
1006         list_del_init(&cldev->bus_list);
1007
1008         cldev->is_added = 0;
1009         put_device(&cldev->dev);
1010 }
1011
1012 /**
1013  * mei_cl_bus_remove_device - remove a devices form the bus
1014  *
1015  * @cldev: me client device
1016  */
1017 static void mei_cl_bus_remove_device(struct mei_cl_device *cldev)
1018 {
1019         mei_cl_bus_dev_stop(cldev);
1020         mei_cl_bus_dev_destroy(cldev);
1021 }
1022
1023 /**
1024  * mei_cl_bus_remove_devices - remove all devices form the bus
1025  *
1026  * @bus: mei device
1027  */
1028 void mei_cl_bus_remove_devices(struct mei_device *bus)
1029 {
1030         struct mei_cl_device *cldev, *next;
1031
1032         mutex_lock(&bus->cl_bus_lock);
1033         list_for_each_entry_safe(cldev, next, &bus->device_list, bus_list)
1034                 mei_cl_bus_remove_device(cldev);
1035         mutex_unlock(&bus->cl_bus_lock);
1036 }
1037
1038
1039 /**
1040  * mei_cl_bus_dev_init - allocate and initializes an mei client devices
1041  *     based on me client
1042  *
1043  * @bus: mei device
1044  * @me_cl: me client
1045  *
1046  * Locking: called under "dev->cl_bus_lock" lock
1047  */
1048 static void mei_cl_bus_dev_init(struct mei_device *bus,
1049                                 struct mei_me_client *me_cl)
1050 {
1051         struct mei_cl_device *cldev;
1052
1053         WARN_ON(!mutex_is_locked(&bus->cl_bus_lock));
1054
1055         dev_dbg(bus->dev, "initializing %pUl", mei_me_cl_uuid(me_cl));
1056
1057         if (me_cl->bus_added)
1058                 return;
1059
1060         cldev = mei_cl_bus_dev_alloc(bus, me_cl);
1061         if (!cldev)
1062                 return;
1063
1064         me_cl->bus_added = true;
1065         list_add_tail(&cldev->bus_list, &bus->device_list);
1066
1067 }
1068
1069 /**
1070  * mei_cl_bus_rescan - scan me clients list and add create
1071  *    devices for eligible clients
1072  *
1073  * @bus: mei device
1074  */
1075 static void mei_cl_bus_rescan(struct mei_device *bus)
1076 {
1077         struct mei_cl_device *cldev, *n;
1078         struct mei_me_client *me_cl;
1079
1080         mutex_lock(&bus->cl_bus_lock);
1081
1082         down_read(&bus->me_clients_rwsem);
1083         list_for_each_entry(me_cl, &bus->me_clients, list)
1084                 mei_cl_bus_dev_init(bus, me_cl);
1085         up_read(&bus->me_clients_rwsem);
1086
1087         list_for_each_entry_safe(cldev, n, &bus->device_list, bus_list) {
1088
1089                 if (!mei_me_cl_is_active(cldev->me_cl)) {
1090                         mei_cl_bus_remove_device(cldev);
1091                         continue;
1092                 }
1093
1094                 if (cldev->is_added)
1095                         continue;
1096
1097                 if (mei_cl_bus_dev_setup(bus, cldev))
1098                         mei_cl_bus_dev_add(cldev);
1099                 else {
1100                         list_del_init(&cldev->bus_list);
1101                         put_device(&cldev->dev);
1102                 }
1103         }
1104         mutex_unlock(&bus->cl_bus_lock);
1105
1106         dev_dbg(bus->dev, "rescan end");
1107 }
1108
1109 void mei_cl_bus_rescan_work(struct work_struct *work)
1110 {
1111         struct mei_device *bus =
1112                 container_of(work, struct mei_device, bus_rescan_work);
1113
1114         mei_cl_bus_rescan(bus);
1115 }
1116
1117 int __mei_cldev_driver_register(struct mei_cl_driver *cldrv,
1118                                 struct module *owner)
1119 {
1120         int err;
1121
1122         cldrv->driver.name = cldrv->name;
1123         cldrv->driver.owner = owner;
1124         cldrv->driver.bus = &mei_cl_bus_type;
1125
1126         err = driver_register(&cldrv->driver);
1127         if (err)
1128                 return err;
1129
1130         pr_debug("mei: driver [%s] registered\n", cldrv->driver.name);
1131
1132         return 0;
1133 }
1134 EXPORT_SYMBOL_GPL(__mei_cldev_driver_register);
1135
1136 void mei_cldev_driver_unregister(struct mei_cl_driver *cldrv)
1137 {
1138         driver_unregister(&cldrv->driver);
1139
1140         pr_debug("mei: driver [%s] unregistered\n", cldrv->driver.name);
1141 }
1142 EXPORT_SYMBOL_GPL(mei_cldev_driver_unregister);
1143
1144
1145 int __init mei_cl_bus_init(void)
1146 {
1147         return bus_register(&mei_cl_bus_type);
1148 }
1149
1150 void __exit mei_cl_bus_exit(void)
1151 {
1152         bus_unregister(&mei_cl_bus_type);
1153 }