drivers/misc/mei/bus.c

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