1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2012-2019, Intel Corporation. All rights reserved.
4 * Intel Management Engine Interface (Intel MEI) Linux driver
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>
21 #define to_mei_cl_driver(d) container_of(d, struct mei_cl_driver, driver)
24 * __mei_cl_send - internal client send (write)
27 * @buf: buffer to send
28 * @length: buffer length
32 * Return: written size bytes or < 0 on error
34 ssize_t __mei_cl_send(struct mei_cl *cl, const u8 *buf, size_t length, u8 vtag,
37 struct mei_device *bus;
41 if (WARN_ON(!cl || !cl->dev))
46 mutex_lock(&bus->device_lock);
47 if (bus->dev_state != MEI_DEV_ENABLED &&
48 bus->dev_state != MEI_DEV_POWERING_DOWN) {
53 if (!mei_cl_is_connected(cl)) {
58 /* Check if we have an ME client device */
59 if (!mei_me_cl_is_active(cl->me_cl)) {
65 /* Check if vtag is supported by client */
66 rets = mei_cl_vt_support_check(cl);
71 if (length > mei_cl_mtu(cl)) {
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);
83 if (signal_pending(current))
87 if (!mei_cl_is_connected(cl)) {
93 cb = mei_cl_alloc_cb(cl, length, MEI_FOP_WRITE, NULL);
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);
104 rets = mei_cl_write(cl, cb);
107 mutex_unlock(&bus->device_lock);
113 * __mei_cl_recv - internal client receive (read)
116 * @buf: buffer to receive
117 * @length: buffer length
120 * @timeout: recv timeout, 0 for infinite timeout
122 * Return: read size in bytes of < 0 on error
124 ssize_t __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length, u8 *vtag,
125 unsigned int mode, unsigned long timeout)
127 struct mei_device *bus;
128 struct mei_cl_cb *cb;
131 bool nonblock = !!(mode & MEI_CL_IO_RX_NONBLOCK);
133 if (WARN_ON(!cl || !cl->dev))
138 mutex_lock(&bus->device_lock);
139 if (bus->dev_state != MEI_DEV_ENABLED &&
140 bus->dev_state != MEI_DEV_POWERING_DOWN) {
145 cb = mei_cl_read_cb(cl, NULL);
149 rets = mei_cl_read_start(cl, length, NULL);
150 if (rets && rets != -EBUSY)
158 /* wait on event only if there is no other waiter */
159 /* synchronized under device mutex */
160 if (!waitqueue_active(&cl->rx_wait)) {
162 mutex_unlock(&bus->device_lock);
165 rets = wait_event_interruptible_timeout
167 mei_cl_read_cb(cl, NULL) ||
168 (!mei_cl_is_connected(cl)),
169 msecs_to_jiffies(timeout));
173 if (signal_pending(current))
178 if (wait_event_interruptible
180 mei_cl_read_cb(cl, NULL) ||
181 (!mei_cl_is_connected(cl)))) {
182 if (signal_pending(current))
188 mutex_lock(&bus->device_lock);
190 if (!mei_cl_is_connected(cl)) {
196 cb = mei_cl_read_cb(cl, NULL);
208 r_length = min_t(size_t, length, cb->buf_idx);
209 memcpy(buf, cb->buf.data, r_length);
215 mei_cl_del_rd_completed(cl, cb);
217 mutex_unlock(&bus->device_lock);
223 * mei_cldev_send_vtag - me device send with vtag (write)
225 * @cldev: me client device
226 * @buf: buffer to send
227 * @length: buffer length
231 * * written size in bytes
235 ssize_t mei_cldev_send_vtag(struct mei_cl_device *cldev, const u8 *buf,
236 size_t length, u8 vtag)
238 struct mei_cl *cl = cldev->cl;
240 return __mei_cl_send(cl, buf, length, vtag, MEI_CL_IO_TX_BLOCKING);
242 EXPORT_SYMBOL_GPL(mei_cldev_send_vtag);
245 * mei_cldev_recv_vtag - client receive with vtag (read)
247 * @cldev: me client device
248 * @buf: buffer to receive
249 * @length: buffer length
253 * * read size in bytes
257 ssize_t mei_cldev_recv_vtag(struct mei_cl_device *cldev, u8 *buf, size_t length,
260 struct mei_cl *cl = cldev->cl;
262 return __mei_cl_recv(cl, buf, length, vtag, 0, 0);
264 EXPORT_SYMBOL_GPL(mei_cldev_recv_vtag);
267 * mei_cldev_recv_nonblock_vtag - non block client receive with vtag (read)
269 * @cldev: me client device
270 * @buf: buffer to receive
271 * @length: buffer length
275 * * read size in bytes
276 * * -EAGAIN if function will block.
277 * * < 0 on other error
279 ssize_t mei_cldev_recv_nonblock_vtag(struct mei_cl_device *cldev, u8 *buf,
280 size_t length, u8 *vtag)
282 struct mei_cl *cl = cldev->cl;
284 return __mei_cl_recv(cl, buf, length, vtag, MEI_CL_IO_RX_NONBLOCK, 0);
286 EXPORT_SYMBOL_GPL(mei_cldev_recv_nonblock_vtag);
289 * mei_cldev_send - me device send (write)
291 * @cldev: me client device
292 * @buf: buffer to send
293 * @length: buffer length
296 * * written size in bytes
299 ssize_t mei_cldev_send(struct mei_cl_device *cldev, const u8 *buf, size_t length)
301 return mei_cldev_send_vtag(cldev, buf, length, 0);
303 EXPORT_SYMBOL_GPL(mei_cldev_send);
306 * mei_cldev_recv - client receive (read)
308 * @cldev: me client device
309 * @buf: buffer to receive
310 * @length: buffer length
312 * Return: read size in bytes of < 0 on error
314 ssize_t mei_cldev_recv(struct mei_cl_device *cldev, u8 *buf, size_t length)
316 return mei_cldev_recv_vtag(cldev, buf, length, NULL);
318 EXPORT_SYMBOL_GPL(mei_cldev_recv);
321 * mei_cldev_recv_nonblock - non block client receive (read)
323 * @cldev: me client device
324 * @buf: buffer to receive
325 * @length: buffer length
327 * Return: read size in bytes of < 0 on error
328 * -EAGAIN if function will block.
330 ssize_t mei_cldev_recv_nonblock(struct mei_cl_device *cldev, u8 *buf,
333 return mei_cldev_recv_nonblock_vtag(cldev, buf, length, NULL);
335 EXPORT_SYMBOL_GPL(mei_cldev_recv_nonblock);
338 * mei_cl_bus_rx_work - dispatch rx event for a bus device
342 static void mei_cl_bus_rx_work(struct work_struct *work)
344 struct mei_cl_device *cldev;
345 struct mei_device *bus;
347 cldev = container_of(work, struct mei_cl_device, rx_work);
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);
361 * mei_cl_bus_notif_work - dispatch FW notif event for a bus device
365 static void mei_cl_bus_notif_work(struct work_struct *work)
367 struct mei_cl_device *cldev;
369 cldev = container_of(work, struct mei_cl_device, notif_work);
372 cldev->notif_cb(cldev);
376 * mei_cl_bus_notify_event - schedule notify cb on bus client
380 * Return: true if event was scheduled
381 * false if the client is not waiting for event
383 bool mei_cl_bus_notify_event(struct mei_cl *cl)
385 struct mei_cl_device *cldev = cl->cldev;
387 if (!cldev || !cldev->notif_cb)
393 schedule_work(&cldev->notif_work);
395 cl->notify_ev = false;
401 * mei_cl_bus_rx_event - schedule rx event
405 * Return: true if event was scheduled
406 * false if the client is not waiting for event
408 bool mei_cl_bus_rx_event(struct mei_cl *cl)
410 struct mei_cl_device *cldev = cl->cldev;
412 if (!cldev || !cldev->rx_cb)
415 schedule_work(&cldev->rx_work);
421 * mei_cldev_register_rx_cb - register Rx event callback
423 * @cldev: me client devices
424 * @rx_cb: callback function
426 * Return: 0 on success
427 * -EALREADY if an callback is already registered
430 int mei_cldev_register_rx_cb(struct mei_cl_device *cldev, mei_cldev_cb_t rx_cb)
432 struct mei_device *bus = cldev->bus;
440 cldev->rx_cb = rx_cb;
441 INIT_WORK(&cldev->rx_work, mei_cl_bus_rx_work);
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);
448 mutex_unlock(&bus->device_lock);
449 if (ret && ret != -EBUSY) {
450 cancel_work_sync(&cldev->rx_work);
457 EXPORT_SYMBOL_GPL(mei_cldev_register_rx_cb);
460 * mei_cldev_register_notif_cb - register FW notification event callback
462 * @cldev: me client devices
463 * @notif_cb: callback function
465 * Return: 0 on success
466 * -EALREADY if an callback is already registered
469 int mei_cldev_register_notif_cb(struct mei_cl_device *cldev,
470 mei_cldev_cb_t notif_cb)
472 struct mei_device *bus = cldev->bus;
481 cldev->notif_cb = notif_cb;
482 INIT_WORK(&cldev->notif_work, mei_cl_bus_notif_work);
484 mutex_lock(&bus->device_lock);
485 ret = mei_cl_notify_request(cldev->cl, NULL, 1);
486 mutex_unlock(&bus->device_lock);
488 cancel_work_sync(&cldev->notif_work);
489 cldev->notif_cb = NULL;
495 EXPORT_SYMBOL_GPL(mei_cldev_register_notif_cb);
498 * mei_cldev_get_drvdata - driver data getter
500 * @cldev: mei client device
502 * Return: driver private data
504 void *mei_cldev_get_drvdata(const struct mei_cl_device *cldev)
506 return dev_get_drvdata(&cldev->dev);
508 EXPORT_SYMBOL_GPL(mei_cldev_get_drvdata);
511 * mei_cldev_set_drvdata - driver data setter
513 * @cldev: mei client device
514 * @data: data to store
516 void mei_cldev_set_drvdata(struct mei_cl_device *cldev, void *data)
518 dev_set_drvdata(&cldev->dev, data);
520 EXPORT_SYMBOL_GPL(mei_cldev_set_drvdata);
523 * mei_cldev_uuid - return uuid of the underlying me client
525 * @cldev: mei client device
527 * Return: me client uuid
529 const uuid_le *mei_cldev_uuid(const struct mei_cl_device *cldev)
531 return mei_me_cl_uuid(cldev->me_cl);
533 EXPORT_SYMBOL_GPL(mei_cldev_uuid);
536 * mei_cldev_ver - return protocol version of the underlying me client
538 * @cldev: mei client device
540 * Return: me client protocol version
542 u8 mei_cldev_ver(const struct mei_cl_device *cldev)
544 return mei_me_cl_ver(cldev->me_cl);
546 EXPORT_SYMBOL_GPL(mei_cldev_ver);
549 * mei_cldev_enabled - check whether the device is enabled
551 * @cldev: mei client device
553 * Return: true if me client is initialized and connected
555 bool mei_cldev_enabled(const struct mei_cl_device *cldev)
557 return mei_cl_is_connected(cldev->cl);
559 EXPORT_SYMBOL_GPL(mei_cldev_enabled);
562 * mei_cl_bus_module_get - acquire module of the underlying
565 * @cldev: mei client device
567 * Return: true on success; false if the module was removed.
569 static bool mei_cl_bus_module_get(struct mei_cl_device *cldev)
571 return try_module_get(cldev->bus->dev->driver->owner);
575 * mei_cl_bus_module_put - release the underlying hw module.
577 * @cldev: mei client device
579 static void mei_cl_bus_module_put(struct mei_cl_device *cldev)
581 module_put(cldev->bus->dev->driver->owner);
585 * mei_cl_bus_vtag - get bus vtag entry wrapper
586 * The tag for bus client is always first.
590 * Return: bus vtag or NULL
592 static inline struct mei_cl_vtag *mei_cl_bus_vtag(struct mei_cl *cl)
594 return list_first_entry_or_null(&cl->vtag_map,
595 struct mei_cl_vtag, list);
599 * mei_cl_bus_vtag_alloc - add bus client entry to vtag map
601 * @cldev: me client device
605 * * -ENOMEM if memory allocation failed
607 static int mei_cl_bus_vtag_alloc(struct mei_cl_device *cldev)
609 struct mei_cl *cl = cldev->cl;
610 struct mei_cl_vtag *cl_vtag;
613 * Bail out if the client does not supports vtags
614 * or has already allocated one
616 if (mei_cl_vt_support_check(cl) || mei_cl_bus_vtag(cl))
619 cl_vtag = mei_cl_vtag_alloc(NULL, 0);
623 list_add_tail(&cl_vtag->list, &cl->vtag_map);
629 * mei_cl_bus_vtag_free - remove the bus entry from vtag map
631 * @cldev: me client device
633 static void mei_cl_bus_vtag_free(struct mei_cl_device *cldev)
635 struct mei_cl *cl = cldev->cl;
636 struct mei_cl_vtag *cl_vtag;
638 cl_vtag = mei_cl_bus_vtag(cl);
642 list_del(&cl_vtag->list);
646 void *mei_cldev_dma_map(struct mei_cl_device *cldev, u8 buffer_id, size_t size)
648 struct mei_device *bus;
652 if (!cldev || !buffer_id || !size)
653 return ERR_PTR(-EINVAL);
655 if (!IS_ALIGNED(size, MEI_FW_PAGE_SIZE)) {
656 dev_err(&cldev->dev, "Map size should be aligned to %lu\n",
658 return ERR_PTR(-EINVAL);
664 mutex_lock(&bus->device_lock);
665 if (cl->state == MEI_FILE_UNINITIALIZED) {
666 ret = mei_cl_link(cl);
669 /* update pointers */
673 ret = mei_cl_dma_alloc_and_map(cl, NULL, buffer_id, size);
675 mutex_unlock(&bus->device_lock);
678 return cl->dma.vaddr;
680 EXPORT_SYMBOL_GPL(mei_cldev_dma_map);
682 int mei_cldev_dma_unmap(struct mei_cl_device *cldev)
684 struct mei_device *bus;
694 mutex_lock(&bus->device_lock);
695 ret = mei_cl_dma_unmap(cl, NULL);
697 mei_cl_flush_queues(cl, NULL);
699 mutex_unlock(&bus->device_lock);
702 EXPORT_SYMBOL_GPL(mei_cldev_dma_unmap);
705 * mei_cldev_enable - enable me client device
706 * create connection with me client
708 * @cldev: me client device
710 * Return: 0 on success and < 0 on error
712 int mei_cldev_enable(struct mei_cl_device *cldev)
714 struct mei_device *bus = cldev->bus;
720 mutex_lock(&bus->device_lock);
721 if (cl->state == MEI_FILE_UNINITIALIZED) {
722 ret = mei_cl_link(cl);
725 /* update pointers */
729 if (mei_cl_is_connected(cl)) {
734 if (!mei_me_cl_is_active(cldev->me_cl)) {
735 dev_err(&cldev->dev, "me client is not active\n");
740 ret = mei_cl_bus_vtag_alloc(cldev);
744 ret = mei_cl_connect(cl, cldev->me_cl, NULL);
746 dev_err(&cldev->dev, "cannot connect\n");
747 mei_cl_bus_vtag_free(cldev);
751 mutex_unlock(&bus->device_lock);
755 EXPORT_SYMBOL_GPL(mei_cldev_enable);
758 * mei_cldev_unregister_callbacks - internal wrapper for unregistering
761 * @cldev: client device
763 static void mei_cldev_unregister_callbacks(struct mei_cl_device *cldev)
766 cancel_work_sync(&cldev->rx_work);
770 if (cldev->notif_cb) {
771 cancel_work_sync(&cldev->notif_work);
772 cldev->notif_cb = NULL;
777 * mei_cldev_disable - disable me client device
778 * disconnect form the me client
780 * @cldev: me client device
782 * Return: 0 on success and < 0 on error
784 int mei_cldev_disable(struct mei_cl_device *cldev)
786 struct mei_device *bus;
797 mei_cldev_unregister_callbacks(cldev);
799 mutex_lock(&bus->device_lock);
801 mei_cl_bus_vtag_free(cldev);
803 if (!mei_cl_is_connected(cl)) {
804 dev_dbg(bus->dev, "Already disconnected\n");
809 err = mei_cl_disconnect(cl);
811 dev_err(bus->dev, "Could not disconnect from the ME client\n");
814 /* Flush queues and remove any pending read unless we have mapped DMA */
815 if (!cl->dma_mapped) {
816 mei_cl_flush_queues(cl, NULL);
820 mutex_unlock(&bus->device_lock);
823 EXPORT_SYMBOL_GPL(mei_cldev_disable);
826 * mei_cl_device_find - find matching entry in the driver id table
828 * @cldev: me client device
829 * @cldrv: me client driver
831 * Return: id on success; NULL if no id is matching
834 struct mei_cl_device_id *mei_cl_device_find(const struct mei_cl_device *cldev,
835 const struct mei_cl_driver *cldrv)
837 const struct mei_cl_device_id *id;
842 uuid = mei_me_cl_uuid(cldev->me_cl);
843 version = mei_me_cl_ver(cldev->me_cl);
845 id = cldrv->id_table;
846 while (uuid_le_cmp(NULL_UUID_LE, id->uuid)) {
847 if (!uuid_le_cmp(*uuid, id->uuid)) {
851 if (strncmp(cldev->name, id->name,
855 if (id->version != MEI_CL_VERSION_ANY)
856 if (id->version != version)
869 * mei_cl_device_match - device match function
874 * Return: 1 if matching device was found 0 otherwise
876 static int mei_cl_device_match(struct device *dev, struct device_driver *drv)
878 const struct mei_cl_device *cldev = to_mei_cl_device(dev);
879 const struct mei_cl_driver *cldrv = to_mei_cl_driver(drv);
880 const struct mei_cl_device_id *found_id;
885 if (!cldev->do_match)
888 if (!cldrv || !cldrv->id_table)
891 found_id = mei_cl_device_find(cldev, cldrv);
899 * mei_cl_device_probe - bus probe function
903 * Return: 0 on success; < 0 otherwise
905 static int mei_cl_device_probe(struct device *dev)
907 struct mei_cl_device *cldev;
908 struct mei_cl_driver *cldrv;
909 const struct mei_cl_device_id *id;
912 cldev = to_mei_cl_device(dev);
913 cldrv = to_mei_cl_driver(dev->driver);
918 if (!cldrv || !cldrv->probe)
921 id = mei_cl_device_find(cldev, cldrv);
925 if (!mei_cl_bus_module_get(cldev)) {
926 dev_err(&cldev->dev, "get hw module failed");
930 ret = cldrv->probe(cldev, id);
932 mei_cl_bus_module_put(cldev);
936 __module_get(THIS_MODULE);
941 * mei_cl_device_remove - remove device from the bus
945 * Return: 0 on success; < 0 otherwise
947 static void mei_cl_device_remove(struct device *dev)
949 struct mei_cl_device *cldev = to_mei_cl_device(dev);
950 struct mei_cl_driver *cldrv = to_mei_cl_driver(dev->driver);
953 cldrv->remove(cldev);
955 mei_cldev_unregister_callbacks(cldev);
957 mei_cl_bus_module_put(cldev);
958 module_put(THIS_MODULE);
961 static ssize_t name_show(struct device *dev, struct device_attribute *a,
964 struct mei_cl_device *cldev = to_mei_cl_device(dev);
966 return scnprintf(buf, PAGE_SIZE, "%s", cldev->name);
968 static DEVICE_ATTR_RO(name);
970 static ssize_t uuid_show(struct device *dev, struct device_attribute *a,
973 struct mei_cl_device *cldev = to_mei_cl_device(dev);
974 const uuid_le *uuid = mei_me_cl_uuid(cldev->me_cl);
976 return sprintf(buf, "%pUl", uuid);
978 static DEVICE_ATTR_RO(uuid);
980 static ssize_t version_show(struct device *dev, struct device_attribute *a,
983 struct mei_cl_device *cldev = to_mei_cl_device(dev);
984 u8 version = mei_me_cl_ver(cldev->me_cl);
986 return sprintf(buf, "%02X", version);
988 static DEVICE_ATTR_RO(version);
990 static ssize_t modalias_show(struct device *dev, struct device_attribute *a,
993 struct mei_cl_device *cldev = to_mei_cl_device(dev);
994 const uuid_le *uuid = mei_me_cl_uuid(cldev->me_cl);
995 u8 version = mei_me_cl_ver(cldev->me_cl);
997 return scnprintf(buf, PAGE_SIZE, "mei:%s:%pUl:%02X:",
998 cldev->name, uuid, version);
1000 static DEVICE_ATTR_RO(modalias);
1002 static ssize_t max_conn_show(struct device *dev, struct device_attribute *a,
1005 struct mei_cl_device *cldev = to_mei_cl_device(dev);
1006 u8 maxconn = mei_me_cl_max_conn(cldev->me_cl);
1008 return sprintf(buf, "%d", maxconn);
1010 static DEVICE_ATTR_RO(max_conn);
1012 static ssize_t fixed_show(struct device *dev, struct device_attribute *a,
1015 struct mei_cl_device *cldev = to_mei_cl_device(dev);
1016 u8 fixed = mei_me_cl_fixed(cldev->me_cl);
1018 return sprintf(buf, "%d", fixed);
1020 static DEVICE_ATTR_RO(fixed);
1022 static ssize_t vtag_show(struct device *dev, struct device_attribute *a,
1025 struct mei_cl_device *cldev = to_mei_cl_device(dev);
1026 bool vt = mei_me_cl_vt(cldev->me_cl);
1028 return sprintf(buf, "%d", vt);
1030 static DEVICE_ATTR_RO(vtag);
1032 static ssize_t max_len_show(struct device *dev, struct device_attribute *a,
1035 struct mei_cl_device *cldev = to_mei_cl_device(dev);
1036 u32 maxlen = mei_me_cl_max_len(cldev->me_cl);
1038 return sprintf(buf, "%u", maxlen);
1040 static DEVICE_ATTR_RO(max_len);
1042 static struct attribute *mei_cldev_attrs[] = {
1043 &dev_attr_name.attr,
1044 &dev_attr_uuid.attr,
1045 &dev_attr_version.attr,
1046 &dev_attr_modalias.attr,
1047 &dev_attr_max_conn.attr,
1048 &dev_attr_fixed.attr,
1049 &dev_attr_vtag.attr,
1050 &dev_attr_max_len.attr,
1053 ATTRIBUTE_GROUPS(mei_cldev);
1056 * mei_cl_device_uevent - me client bus uevent handler
1059 * @env: uevent kobject
1061 * Return: 0 on success -ENOMEM on when add_uevent_var fails
1063 static int mei_cl_device_uevent(struct device *dev, struct kobj_uevent_env *env)
1065 struct mei_cl_device *cldev = to_mei_cl_device(dev);
1066 const uuid_le *uuid = mei_me_cl_uuid(cldev->me_cl);
1067 u8 version = mei_me_cl_ver(cldev->me_cl);
1069 if (add_uevent_var(env, "MEI_CL_VERSION=%d", version))
1072 if (add_uevent_var(env, "MEI_CL_UUID=%pUl", uuid))
1075 if (add_uevent_var(env, "MEI_CL_NAME=%s", cldev->name))
1078 if (add_uevent_var(env, "MODALIAS=mei:%s:%pUl:%02X:",
1079 cldev->name, uuid, version))
1085 static struct bus_type mei_cl_bus_type = {
1087 .dev_groups = mei_cldev_groups,
1088 .match = mei_cl_device_match,
1089 .probe = mei_cl_device_probe,
1090 .remove = mei_cl_device_remove,
1091 .uevent = mei_cl_device_uevent,
1094 static struct mei_device *mei_dev_bus_get(struct mei_device *bus)
1097 get_device(bus->dev);
1102 static void mei_dev_bus_put(struct mei_device *bus)
1105 put_device(bus->dev);
1108 static void mei_cl_bus_dev_release(struct device *dev)
1110 struct mei_cl_device *cldev = to_mei_cl_device(dev);
1115 mei_cl_flush_queues(cldev->cl, NULL);
1116 mei_me_cl_put(cldev->me_cl);
1117 mei_dev_bus_put(cldev->bus);
1118 mei_cl_unlink(cldev->cl);
1123 static const struct device_type mei_cl_device_type = {
1124 .release = mei_cl_bus_dev_release,
1128 * mei_cl_bus_set_name - set device name for me client device
1129 * <controller>-<client device>
1130 * Example: 0000:00:16.0-55213584-9a29-4916-badf-0fb7ed682aeb
1132 * @cldev: me client device
1134 static inline void mei_cl_bus_set_name(struct mei_cl_device *cldev)
1136 dev_set_name(&cldev->dev, "%s-%pUl",
1137 dev_name(cldev->bus->dev),
1138 mei_me_cl_uuid(cldev->me_cl));
1142 * mei_cl_bus_dev_alloc - initialize and allocate mei client device
1147 * Return: allocated device structur or NULL on allocation failure
1149 static struct mei_cl_device *mei_cl_bus_dev_alloc(struct mei_device *bus,
1150 struct mei_me_client *me_cl)
1152 struct mei_cl_device *cldev;
1155 cldev = kzalloc(sizeof(*cldev), GFP_KERNEL);
1159 cl = mei_cl_allocate(bus);
1165 device_initialize(&cldev->dev);
1166 cldev->dev.parent = bus->dev;
1167 cldev->dev.bus = &mei_cl_bus_type;
1168 cldev->dev.type = &mei_cl_device_type;
1169 cldev->bus = mei_dev_bus_get(bus);
1170 cldev->me_cl = mei_me_cl_get(me_cl);
1172 mei_cl_bus_set_name(cldev);
1173 cldev->is_added = 0;
1174 INIT_LIST_HEAD(&cldev->bus_list);
1180 * mei_cl_bus_dev_setup - setup me client device
1181 * run fix up routines and set the device name
1184 * @cldev: me client device
1186 * Return: true if the device is eligible for enumeration
1188 static bool mei_cl_bus_dev_setup(struct mei_device *bus,
1189 struct mei_cl_device *cldev)
1191 cldev->do_match = 1;
1192 mei_cl_bus_dev_fixup(cldev);
1194 /* the device name can change during fix up */
1195 if (cldev->do_match)
1196 mei_cl_bus_set_name(cldev);
1198 return cldev->do_match == 1;
1202 * mei_cl_bus_dev_add - add me client devices
1204 * @cldev: me client device
1206 * Return: 0 on success; < 0 on failre
1208 static int mei_cl_bus_dev_add(struct mei_cl_device *cldev)
1212 dev_dbg(cldev->bus->dev, "adding %pUL:%02X\n",
1213 mei_me_cl_uuid(cldev->me_cl),
1214 mei_me_cl_ver(cldev->me_cl));
1215 ret = device_add(&cldev->dev);
1217 cldev->is_added = 1;
1223 * mei_cl_bus_dev_stop - stop the driver
1225 * @cldev: me client device
1227 static void mei_cl_bus_dev_stop(struct mei_cl_device *cldev)
1229 if (cldev->is_added)
1230 device_release_driver(&cldev->dev);
1234 * mei_cl_bus_dev_destroy - destroy me client devices object
1236 * @cldev: me client device
1238 * Locking: called under "dev->cl_bus_lock" lock
1240 static void mei_cl_bus_dev_destroy(struct mei_cl_device *cldev)
1243 WARN_ON(!mutex_is_locked(&cldev->bus->cl_bus_lock));
1245 if (!cldev->is_added)
1248 device_del(&cldev->dev);
1250 list_del_init(&cldev->bus_list);
1252 cldev->is_added = 0;
1253 put_device(&cldev->dev);
1257 * mei_cl_bus_remove_device - remove a devices form the bus
1259 * @cldev: me client device
1261 static void mei_cl_bus_remove_device(struct mei_cl_device *cldev)
1263 mei_cl_bus_dev_stop(cldev);
1264 mei_cl_bus_dev_destroy(cldev);
1268 * mei_cl_bus_remove_devices - remove all devices form the bus
1272 void mei_cl_bus_remove_devices(struct mei_device *bus)
1274 struct mei_cl_device *cldev, *next;
1276 mutex_lock(&bus->cl_bus_lock);
1277 list_for_each_entry_safe(cldev, next, &bus->device_list, bus_list)
1278 mei_cl_bus_remove_device(cldev);
1279 mutex_unlock(&bus->cl_bus_lock);
1284 * mei_cl_bus_dev_init - allocate and initializes an mei client devices
1285 * based on me client
1290 * Locking: called under "dev->cl_bus_lock" lock
1292 static void mei_cl_bus_dev_init(struct mei_device *bus,
1293 struct mei_me_client *me_cl)
1295 struct mei_cl_device *cldev;
1297 WARN_ON(!mutex_is_locked(&bus->cl_bus_lock));
1299 dev_dbg(bus->dev, "initializing %pUl", mei_me_cl_uuid(me_cl));
1301 if (me_cl->bus_added)
1304 cldev = mei_cl_bus_dev_alloc(bus, me_cl);
1308 me_cl->bus_added = true;
1309 list_add_tail(&cldev->bus_list, &bus->device_list);
1314 * mei_cl_bus_rescan - scan me clients list and add create
1315 * devices for eligible clients
1319 static void mei_cl_bus_rescan(struct mei_device *bus)
1321 struct mei_cl_device *cldev, *n;
1322 struct mei_me_client *me_cl;
1324 mutex_lock(&bus->cl_bus_lock);
1326 down_read(&bus->me_clients_rwsem);
1327 list_for_each_entry(me_cl, &bus->me_clients, list)
1328 mei_cl_bus_dev_init(bus, me_cl);
1329 up_read(&bus->me_clients_rwsem);
1331 list_for_each_entry_safe(cldev, n, &bus->device_list, bus_list) {
1333 if (!mei_me_cl_is_active(cldev->me_cl)) {
1334 mei_cl_bus_remove_device(cldev);
1338 if (cldev->is_added)
1341 if (mei_cl_bus_dev_setup(bus, cldev))
1342 mei_cl_bus_dev_add(cldev);
1344 list_del_init(&cldev->bus_list);
1345 put_device(&cldev->dev);
1348 mutex_unlock(&bus->cl_bus_lock);
1350 dev_dbg(bus->dev, "rescan end");
1353 void mei_cl_bus_rescan_work(struct work_struct *work)
1355 struct mei_device *bus =
1356 container_of(work, struct mei_device, bus_rescan_work);
1358 mei_cl_bus_rescan(bus);
1361 int __mei_cldev_driver_register(struct mei_cl_driver *cldrv,
1362 struct module *owner)
1366 cldrv->driver.name = cldrv->name;
1367 cldrv->driver.owner = owner;
1368 cldrv->driver.bus = &mei_cl_bus_type;
1370 err = driver_register(&cldrv->driver);
1374 pr_debug("mei: driver [%s] registered\n", cldrv->driver.name);
1378 EXPORT_SYMBOL_GPL(__mei_cldev_driver_register);
1380 void mei_cldev_driver_unregister(struct mei_cl_driver *cldrv)
1382 driver_unregister(&cldrv->driver);
1384 pr_debug("mei: driver [%s] unregistered\n", cldrv->driver.name);
1386 EXPORT_SYMBOL_GPL(mei_cldev_driver_unregister);
1389 int __init mei_cl_bus_init(void)
1391 return bus_register(&mei_cl_bus_type);
1394 void __exit mei_cl_bus_exit(void)
1396 bus_unregister(&mei_cl_bus_type);