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/scatterlist.h>
17 #include <linux/mei_cl_bus.h>
22 #define to_mei_cl_driver(d) container_of(d, struct mei_cl_driver, driver)
25 * __mei_cl_send - internal client send (write)
28 * @buf: buffer to send
29 * @length: buffer length
33 * Return: written size bytes or < 0 on error
35 ssize_t __mei_cl_send(struct mei_cl *cl, const u8 *buf, size_t length, u8 vtag,
38 return __mei_cl_send_timeout(cl, buf, length, vtag, mode, MAX_SCHEDULE_TIMEOUT);
42 * __mei_cl_send_timeout - internal client send (write)
45 * @buf: buffer to send
46 * @length: buffer length
49 * @timeout: send timeout in milliseconds.
50 * effective only for blocking writes: the MEI_CL_IO_TX_BLOCKING mode bit is set.
51 * set timeout to the MAX_SCHEDULE_TIMEOUT to maixum allowed wait.
53 * Return: written size bytes or < 0 on error
55 ssize_t __mei_cl_send_timeout(struct mei_cl *cl, const u8 *buf, size_t length, u8 vtag,
56 unsigned int mode, unsigned long timeout)
58 struct mei_device *bus;
62 if (WARN_ON(!cl || !cl->dev))
67 mutex_lock(&bus->device_lock);
68 if (bus->dev_state != MEI_DEV_ENABLED &&
69 bus->dev_state != MEI_DEV_POWERING_DOWN) {
74 if (!mei_cl_is_connected(cl)) {
79 /* Check if we have an ME client device */
80 if (!mei_me_cl_is_active(cl->me_cl)) {
86 /* Check if vtag is supported by client */
87 rets = mei_cl_vt_support_check(cl);
92 if (length > mei_cl_mtu(cl)) {
97 while (cl->tx_cb_queued >= bus->tx_queue_limit) {
98 mutex_unlock(&bus->device_lock);
99 rets = wait_event_interruptible(cl->tx_wait,
100 cl->writing_state == MEI_WRITE_COMPLETE ||
101 (!mei_cl_is_connected(cl)));
102 mutex_lock(&bus->device_lock);
104 if (signal_pending(current))
108 if (!mei_cl_is_connected(cl)) {
114 cb = mei_cl_alloc_cb(cl, length, MEI_FOP_WRITE, NULL);
121 cb->internal = !!(mode & MEI_CL_IO_TX_INTERNAL);
122 cb->blocking = !!(mode & MEI_CL_IO_TX_BLOCKING);
123 memcpy(cb->buf.data, buf, length);
124 /* hack we point data to header */
125 if (mode & MEI_CL_IO_SGL) {
126 cb->ext_hdr = (struct mei_ext_hdr *)cb->buf.data;
131 rets = mei_cl_write(cl, cb, timeout);
133 if (mode & MEI_CL_IO_SGL && rets == 0)
137 mutex_unlock(&bus->device_lock);
143 * __mei_cl_recv - internal client receive (read)
146 * @buf: buffer to receive
147 * @length: buffer length
150 * @timeout: recv timeout, 0 for infinite timeout
152 * Return: read size in bytes of < 0 on error
154 ssize_t __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length, u8 *vtag,
155 unsigned int mode, unsigned long timeout)
157 struct mei_device *bus;
158 struct mei_cl_cb *cb;
161 bool nonblock = !!(mode & MEI_CL_IO_RX_NONBLOCK);
163 if (WARN_ON(!cl || !cl->dev))
168 mutex_lock(&bus->device_lock);
169 if (bus->dev_state != MEI_DEV_ENABLED &&
170 bus->dev_state != MEI_DEV_POWERING_DOWN) {
175 cb = mei_cl_read_cb(cl, NULL);
179 rets = mei_cl_read_start(cl, length, NULL);
180 if (rets && rets != -EBUSY)
188 /* wait on event only if there is no other waiter */
189 /* synchronized under device mutex */
190 if (!waitqueue_active(&cl->rx_wait)) {
192 mutex_unlock(&bus->device_lock);
195 rets = wait_event_interruptible_timeout
197 mei_cl_read_cb(cl, NULL) ||
198 (!mei_cl_is_connected(cl)),
199 msecs_to_jiffies(timeout));
203 if (signal_pending(current))
208 if (wait_event_interruptible
210 mei_cl_read_cb(cl, NULL) ||
211 (!mei_cl_is_connected(cl)))) {
212 if (signal_pending(current))
218 mutex_lock(&bus->device_lock);
220 if (!mei_cl_is_connected(cl)) {
226 cb = mei_cl_read_cb(cl, NULL);
238 /* for the GSC type - copy the extended header to the buffer */
239 if (cb->ext_hdr && cb->ext_hdr->type == MEI_EXT_HDR_GSC) {
240 r_length = min_t(size_t, length, cb->ext_hdr->length * sizeof(u32));
241 memcpy(buf, cb->ext_hdr, r_length);
243 r_length = min_t(size_t, length, cb->buf_idx);
244 memcpy(buf, cb->buf.data, r_length);
252 mei_cl_del_rd_completed(cl, cb);
254 mutex_unlock(&bus->device_lock);
260 * mei_cldev_send_vtag - me device send with vtag (write)
262 * @cldev: me client device
263 * @buf: buffer to send
264 * @length: buffer length
268 * * written size in bytes
272 ssize_t mei_cldev_send_vtag(struct mei_cl_device *cldev, const u8 *buf,
273 size_t length, u8 vtag)
275 struct mei_cl *cl = cldev->cl;
277 return __mei_cl_send(cl, buf, length, vtag, MEI_CL_IO_TX_BLOCKING);
279 EXPORT_SYMBOL_GPL(mei_cldev_send_vtag);
282 * mei_cldev_recv_vtag - client receive with vtag (read)
284 * @cldev: me client device
285 * @buf: buffer to receive
286 * @length: buffer length
290 * * read size in bytes
294 ssize_t mei_cldev_recv_vtag(struct mei_cl_device *cldev, u8 *buf, size_t length,
297 struct mei_cl *cl = cldev->cl;
299 return __mei_cl_recv(cl, buf, length, vtag, 0, 0);
301 EXPORT_SYMBOL_GPL(mei_cldev_recv_vtag);
304 * mei_cldev_recv_nonblock_vtag - non block client receive with vtag (read)
306 * @cldev: me client device
307 * @buf: buffer to receive
308 * @length: buffer length
312 * * read size in bytes
313 * * -EAGAIN if function will block.
314 * * < 0 on other error
316 ssize_t mei_cldev_recv_nonblock_vtag(struct mei_cl_device *cldev, u8 *buf,
317 size_t length, u8 *vtag)
319 struct mei_cl *cl = cldev->cl;
321 return __mei_cl_recv(cl, buf, length, vtag, MEI_CL_IO_RX_NONBLOCK, 0);
323 EXPORT_SYMBOL_GPL(mei_cldev_recv_nonblock_vtag);
326 * mei_cldev_send - me device send (write)
328 * @cldev: me client device
329 * @buf: buffer to send
330 * @length: buffer length
333 * * written size in bytes
336 ssize_t mei_cldev_send(struct mei_cl_device *cldev, const u8 *buf, size_t length)
338 return mei_cldev_send_vtag(cldev, buf, length, 0);
340 EXPORT_SYMBOL_GPL(mei_cldev_send);
343 * mei_cldev_recv - client receive (read)
345 * @cldev: me client device
346 * @buf: buffer to receive
347 * @length: buffer length
349 * Return: read size in bytes of < 0 on error
351 ssize_t mei_cldev_recv(struct mei_cl_device *cldev, u8 *buf, size_t length)
353 return mei_cldev_recv_vtag(cldev, buf, length, NULL);
355 EXPORT_SYMBOL_GPL(mei_cldev_recv);
358 * mei_cldev_recv_nonblock - non block client receive (read)
360 * @cldev: me client device
361 * @buf: buffer to receive
362 * @length: buffer length
364 * Return: read size in bytes of < 0 on error
365 * -EAGAIN if function will block.
367 ssize_t mei_cldev_recv_nonblock(struct mei_cl_device *cldev, u8 *buf,
370 return mei_cldev_recv_nonblock_vtag(cldev, buf, length, NULL);
372 EXPORT_SYMBOL_GPL(mei_cldev_recv_nonblock);
375 * mei_cl_bus_rx_work - dispatch rx event for a bus device
379 static void mei_cl_bus_rx_work(struct work_struct *work)
381 struct mei_cl_device *cldev;
382 struct mei_device *bus;
384 cldev = container_of(work, struct mei_cl_device, rx_work);
391 mutex_lock(&bus->device_lock);
392 if (mei_cl_is_connected(cldev->cl))
393 mei_cl_read_start(cldev->cl, mei_cl_mtu(cldev->cl), NULL);
394 mutex_unlock(&bus->device_lock);
398 * mei_cl_bus_notif_work - dispatch FW notif event for a bus device
402 static void mei_cl_bus_notif_work(struct work_struct *work)
404 struct mei_cl_device *cldev;
406 cldev = container_of(work, struct mei_cl_device, notif_work);
409 cldev->notif_cb(cldev);
413 * mei_cl_bus_notify_event - schedule notify cb on bus client
417 * Return: true if event was scheduled
418 * false if the client is not waiting for event
420 bool mei_cl_bus_notify_event(struct mei_cl *cl)
422 struct mei_cl_device *cldev = cl->cldev;
424 if (!cldev || !cldev->notif_cb)
430 schedule_work(&cldev->notif_work);
432 cl->notify_ev = false;
438 * mei_cl_bus_rx_event - schedule rx event
442 * Return: true if event was scheduled
443 * false if the client is not waiting for event
445 bool mei_cl_bus_rx_event(struct mei_cl *cl)
447 struct mei_cl_device *cldev = cl->cldev;
449 if (!cldev || !cldev->rx_cb)
452 schedule_work(&cldev->rx_work);
458 * mei_cldev_register_rx_cb - register Rx event callback
460 * @cldev: me client devices
461 * @rx_cb: callback function
463 * Return: 0 on success
464 * -EALREADY if an callback is already registered
467 int mei_cldev_register_rx_cb(struct mei_cl_device *cldev, mei_cldev_cb_t rx_cb)
469 struct mei_device *bus = cldev->bus;
477 cldev->rx_cb = rx_cb;
478 INIT_WORK(&cldev->rx_work, mei_cl_bus_rx_work);
480 mutex_lock(&bus->device_lock);
481 if (mei_cl_is_connected(cldev->cl))
482 ret = mei_cl_read_start(cldev->cl, mei_cl_mtu(cldev->cl), NULL);
485 mutex_unlock(&bus->device_lock);
486 if (ret && ret != -EBUSY) {
487 cancel_work_sync(&cldev->rx_work);
494 EXPORT_SYMBOL_GPL(mei_cldev_register_rx_cb);
497 * mei_cldev_register_notif_cb - register FW notification event callback
499 * @cldev: me client devices
500 * @notif_cb: callback function
502 * Return: 0 on success
503 * -EALREADY if an callback is already registered
506 int mei_cldev_register_notif_cb(struct mei_cl_device *cldev,
507 mei_cldev_cb_t notif_cb)
509 struct mei_device *bus = cldev->bus;
518 cldev->notif_cb = notif_cb;
519 INIT_WORK(&cldev->notif_work, mei_cl_bus_notif_work);
521 mutex_lock(&bus->device_lock);
522 ret = mei_cl_notify_request(cldev->cl, NULL, 1);
523 mutex_unlock(&bus->device_lock);
525 cancel_work_sync(&cldev->notif_work);
526 cldev->notif_cb = NULL;
532 EXPORT_SYMBOL_GPL(mei_cldev_register_notif_cb);
535 * mei_cldev_get_drvdata - driver data getter
537 * @cldev: mei client device
539 * Return: driver private data
541 void *mei_cldev_get_drvdata(const struct mei_cl_device *cldev)
543 return dev_get_drvdata(&cldev->dev);
545 EXPORT_SYMBOL_GPL(mei_cldev_get_drvdata);
548 * mei_cldev_set_drvdata - driver data setter
550 * @cldev: mei client device
551 * @data: data to store
553 void mei_cldev_set_drvdata(struct mei_cl_device *cldev, void *data)
555 dev_set_drvdata(&cldev->dev, data);
557 EXPORT_SYMBOL_GPL(mei_cldev_set_drvdata);
560 * mei_cldev_uuid - return uuid of the underlying me client
562 * @cldev: mei client device
564 * Return: me client uuid
566 const uuid_le *mei_cldev_uuid(const struct mei_cl_device *cldev)
568 return mei_me_cl_uuid(cldev->me_cl);
570 EXPORT_SYMBOL_GPL(mei_cldev_uuid);
573 * mei_cldev_ver - return protocol version of the underlying me client
575 * @cldev: mei client device
577 * Return: me client protocol version
579 u8 mei_cldev_ver(const struct mei_cl_device *cldev)
581 return mei_me_cl_ver(cldev->me_cl);
583 EXPORT_SYMBOL_GPL(mei_cldev_ver);
586 * mei_cldev_enabled - check whether the device is enabled
588 * @cldev: mei client device
590 * Return: true if me client is initialized and connected
592 bool mei_cldev_enabled(const struct mei_cl_device *cldev)
594 return mei_cl_is_connected(cldev->cl);
596 EXPORT_SYMBOL_GPL(mei_cldev_enabled);
599 * mei_cl_bus_module_get - acquire module of the underlying
602 * @cldev: mei client device
604 * Return: true on success; false if the module was removed.
606 static bool mei_cl_bus_module_get(struct mei_cl_device *cldev)
608 return try_module_get(cldev->bus->dev->driver->owner);
612 * mei_cl_bus_module_put - release the underlying hw module.
614 * @cldev: mei client device
616 static void mei_cl_bus_module_put(struct mei_cl_device *cldev)
618 module_put(cldev->bus->dev->driver->owner);
622 * mei_cl_bus_vtag - get bus vtag entry wrapper
623 * The tag for bus client is always first.
627 * Return: bus vtag or NULL
629 static inline struct mei_cl_vtag *mei_cl_bus_vtag(struct mei_cl *cl)
631 return list_first_entry_or_null(&cl->vtag_map,
632 struct mei_cl_vtag, list);
636 * mei_cl_bus_vtag_alloc - add bus client entry to vtag map
638 * @cldev: me client device
642 * * -ENOMEM if memory allocation failed
644 static int mei_cl_bus_vtag_alloc(struct mei_cl_device *cldev)
646 struct mei_cl *cl = cldev->cl;
647 struct mei_cl_vtag *cl_vtag;
650 * Bail out if the client does not supports vtags
651 * or has already allocated one
653 if (mei_cl_vt_support_check(cl) || mei_cl_bus_vtag(cl))
656 cl_vtag = mei_cl_vtag_alloc(NULL, 0);
660 list_add_tail(&cl_vtag->list, &cl->vtag_map);
666 * mei_cl_bus_vtag_free - remove the bus entry from vtag map
668 * @cldev: me client device
670 static void mei_cl_bus_vtag_free(struct mei_cl_device *cldev)
672 struct mei_cl *cl = cldev->cl;
673 struct mei_cl_vtag *cl_vtag;
675 cl_vtag = mei_cl_bus_vtag(cl);
679 list_del(&cl_vtag->list);
683 void *mei_cldev_dma_map(struct mei_cl_device *cldev, u8 buffer_id, size_t size)
685 struct mei_device *bus;
689 if (!cldev || !buffer_id || !size)
690 return ERR_PTR(-EINVAL);
692 if (!IS_ALIGNED(size, MEI_FW_PAGE_SIZE)) {
693 dev_err(&cldev->dev, "Map size should be aligned to %lu\n",
695 return ERR_PTR(-EINVAL);
701 mutex_lock(&bus->device_lock);
702 if (cl->state == MEI_FILE_UNINITIALIZED) {
703 ret = mei_cl_link(cl);
706 /* update pointers */
710 ret = mei_cl_dma_alloc_and_map(cl, NULL, buffer_id, size);
712 mutex_unlock(&bus->device_lock);
715 return cl->dma.vaddr;
717 EXPORT_SYMBOL_GPL(mei_cldev_dma_map);
719 int mei_cldev_dma_unmap(struct mei_cl_device *cldev)
721 struct mei_device *bus;
731 mutex_lock(&bus->device_lock);
732 ret = mei_cl_dma_unmap(cl, NULL);
734 mei_cl_flush_queues(cl, NULL);
736 mutex_unlock(&bus->device_lock);
739 EXPORT_SYMBOL_GPL(mei_cldev_dma_unmap);
742 * mei_cldev_enable - enable me client device
743 * create connection with me client
745 * @cldev: me client device
747 * Return: 0 on success and < 0 on error
749 int mei_cldev_enable(struct mei_cl_device *cldev)
751 struct mei_device *bus = cldev->bus;
757 mutex_lock(&bus->device_lock);
758 if (cl->state == MEI_FILE_UNINITIALIZED) {
759 ret = mei_cl_link(cl);
762 /* update pointers */
766 if (mei_cl_is_connected(cl)) {
771 if (!mei_me_cl_is_active(cldev->me_cl)) {
772 dev_err(&cldev->dev, "me client is not active\n");
777 ret = mei_cl_bus_vtag_alloc(cldev);
781 ret = mei_cl_connect(cl, cldev->me_cl, NULL);
783 dev_err(&cldev->dev, "cannot connect\n");
784 mei_cl_bus_vtag_free(cldev);
788 mutex_unlock(&bus->device_lock);
792 EXPORT_SYMBOL_GPL(mei_cldev_enable);
795 * mei_cldev_unregister_callbacks - internal wrapper for unregistering
798 * @cldev: client device
800 static void mei_cldev_unregister_callbacks(struct mei_cl_device *cldev)
803 cancel_work_sync(&cldev->rx_work);
807 if (cldev->notif_cb) {
808 cancel_work_sync(&cldev->notif_work);
809 cldev->notif_cb = NULL;
814 * mei_cldev_disable - disable me client device
815 * disconnect form the me client
817 * @cldev: me client device
819 * Return: 0 on success and < 0 on error
821 int mei_cldev_disable(struct mei_cl_device *cldev)
823 struct mei_device *bus;
834 mei_cldev_unregister_callbacks(cldev);
836 mutex_lock(&bus->device_lock);
838 mei_cl_bus_vtag_free(cldev);
840 if (!mei_cl_is_connected(cl)) {
841 dev_dbg(bus->dev, "Already disconnected\n");
846 err = mei_cl_disconnect(cl);
848 dev_err(bus->dev, "Could not disconnect from the ME client\n");
851 /* Flush queues and remove any pending read unless we have mapped DMA */
852 if (!cl->dma_mapped) {
853 mei_cl_flush_queues(cl, NULL);
857 mutex_unlock(&bus->device_lock);
860 EXPORT_SYMBOL_GPL(mei_cldev_disable);
863 * mei_cldev_send_gsc_command - sends a gsc command, by sending
864 * a gsl mei message to gsc and receiving reply from gsc
866 * @cldev: me client device
867 * @client_id: client id to send the command to
868 * @fence_id: fence id to send the command to
869 * @sg_in: scatter gather list containing addresses for rx message buffer
870 * @total_in_len: total length of data in 'in' sg, can be less than the sum of buffers sizes
871 * @sg_out: scatter gather list containing addresses for tx message buffer
874 * * written size in bytes
877 ssize_t mei_cldev_send_gsc_command(struct mei_cl_device *cldev,
878 u8 client_id, u32 fence_id,
879 struct scatterlist *sg_in,
881 struct scatterlist *sg_out)
884 struct mei_device *bus;
887 struct mei_ext_hdr_gsc_h2f *ext_hdr;
888 size_t buf_sz = sizeof(struct mei_ext_hdr_gsc_h2f);
889 int sg_out_nents, sg_in_nents;
891 struct scatterlist *sg;
892 struct mei_ext_hdr_gsc_f2h rx_msg;
895 if (!cldev || !sg_in || !sg_out)
901 dev_dbg(bus->dev, "client_id %u, fence_id %u\n", client_id, fence_id);
903 if (!bus->hbm_f_gsc_supported)
906 sg_out_nents = sg_nents(sg_out);
907 sg_in_nents = sg_nents(sg_in);
908 /* at least one entry in tx and rx sgls must be present */
909 if (sg_out_nents <= 0 || sg_in_nents <= 0)
912 buf_sz += (sg_out_nents + sg_in_nents) * sizeof(struct mei_gsc_sgl);
913 ext_hdr = kzalloc(buf_sz, GFP_KERNEL);
917 /* construct the GSC message */
918 ext_hdr->hdr.type = MEI_EXT_HDR_GSC;
919 ext_hdr->hdr.length = buf_sz / sizeof(u32); /* length is in dw */
921 ext_hdr->client_id = client_id;
922 ext_hdr->addr_type = GSC_ADDRESS_TYPE_PHYSICAL_SGL;
923 ext_hdr->fence_id = fence_id;
924 ext_hdr->input_address_count = sg_in_nents;
925 ext_hdr->output_address_count = sg_out_nents;
926 ext_hdr->reserved[0] = 0;
927 ext_hdr->reserved[1] = 0;
929 /* copy in-sgl to the message */
930 for (i = 0, sg = sg_in; i < sg_in_nents; i++, sg++) {
931 ext_hdr->sgl[i].low = lower_32_bits(sg_dma_address(sg));
932 ext_hdr->sgl[i].high = upper_32_bits(sg_dma_address(sg));
933 sg_len = min_t(unsigned int, sg_dma_len(sg), PAGE_SIZE);
934 ext_hdr->sgl[i].length = (sg_len <= total_in_len) ? sg_len : total_in_len;
935 total_in_len -= ext_hdr->sgl[i].length;
938 /* copy out-sgl to the message */
939 for (i = sg_in_nents, sg = sg_out; i < sg_in_nents + sg_out_nents; i++, sg++) {
940 ext_hdr->sgl[i].low = lower_32_bits(sg_dma_address(sg));
941 ext_hdr->sgl[i].high = upper_32_bits(sg_dma_address(sg));
942 sg_len = min_t(unsigned int, sg_dma_len(sg), PAGE_SIZE);
943 ext_hdr->sgl[i].length = sg_len;
946 /* send the message to GSC */
947 ret = __mei_cl_send(cl, (u8 *)ext_hdr, buf_sz, 0, MEI_CL_IO_SGL);
949 dev_err(bus->dev, "__mei_cl_send failed, returned %zd\n", ret);
953 dev_err(bus->dev, "__mei_cl_send returned %zd instead of expected %zd\n",
959 /* receive the reply from GSC, note that at this point sg_in should contain the reply */
960 ret = __mei_cl_recv(cl, (u8 *)&rx_msg, sizeof(rx_msg), NULL, MEI_CL_IO_SGL, 0);
962 if (ret != sizeof(rx_msg)) {
963 dev_err(bus->dev, "__mei_cl_recv returned %zd instead of expected %zd\n",
964 ret, sizeof(rx_msg));
970 /* check rx_msg.client_id and rx_msg.fence_id match the ones we send */
971 if (rx_msg.client_id != client_id || rx_msg.fence_id != fence_id) {
972 dev_err(bus->dev, "received client_id/fence_id %u/%u instead of %u/%u sent\n",
973 rx_msg.client_id, rx_msg.fence_id, client_id, fence_id);
978 dev_dbg(bus->dev, "gsc command: successfully written %u bytes\n", rx_msg.written);
979 ret = rx_msg.written;
985 EXPORT_SYMBOL_GPL(mei_cldev_send_gsc_command);
988 * mei_cl_device_find - find matching entry in the driver id table
990 * @cldev: me client device
991 * @cldrv: me client driver
993 * Return: id on success; NULL if no id is matching
996 struct mei_cl_device_id *mei_cl_device_find(const struct mei_cl_device *cldev,
997 const struct mei_cl_driver *cldrv)
999 const struct mei_cl_device_id *id;
1000 const uuid_le *uuid;
1004 uuid = mei_me_cl_uuid(cldev->me_cl);
1005 version = mei_me_cl_ver(cldev->me_cl);
1007 id = cldrv->id_table;
1008 while (uuid_le_cmp(NULL_UUID_LE, id->uuid)) {
1009 if (!uuid_le_cmp(*uuid, id->uuid)) {
1013 if (strncmp(cldev->name, id->name,
1017 if (id->version != MEI_CL_VERSION_ANY)
1018 if (id->version != version)
1031 * mei_cl_device_match - device match function
1036 * Return: 1 if matching device was found 0 otherwise
1038 static int mei_cl_device_match(struct device *dev, struct device_driver *drv)
1040 const struct mei_cl_device *cldev = to_mei_cl_device(dev);
1041 const struct mei_cl_driver *cldrv = to_mei_cl_driver(drv);
1042 const struct mei_cl_device_id *found_id;
1047 if (!cldev->do_match)
1050 if (!cldrv || !cldrv->id_table)
1053 found_id = mei_cl_device_find(cldev, cldrv);
1061 * mei_cl_device_probe - bus probe function
1065 * Return: 0 on success; < 0 otherwise
1067 static int mei_cl_device_probe(struct device *dev)
1069 struct mei_cl_device *cldev;
1070 struct mei_cl_driver *cldrv;
1071 const struct mei_cl_device_id *id;
1074 cldev = to_mei_cl_device(dev);
1075 cldrv = to_mei_cl_driver(dev->driver);
1080 if (!cldrv || !cldrv->probe)
1083 id = mei_cl_device_find(cldev, cldrv);
1087 if (!mei_cl_bus_module_get(cldev)) {
1088 dev_err(&cldev->dev, "get hw module failed");
1092 ret = cldrv->probe(cldev, id);
1094 mei_cl_bus_module_put(cldev);
1098 __module_get(THIS_MODULE);
1103 * mei_cl_device_remove - remove device from the bus
1107 * Return: 0 on success; < 0 otherwise
1109 static void mei_cl_device_remove(struct device *dev)
1111 struct mei_cl_device *cldev = to_mei_cl_device(dev);
1112 struct mei_cl_driver *cldrv = to_mei_cl_driver(dev->driver);
1115 cldrv->remove(cldev);
1117 mei_cldev_unregister_callbacks(cldev);
1119 mei_cl_bus_module_put(cldev);
1120 module_put(THIS_MODULE);
1123 static ssize_t name_show(struct device *dev, struct device_attribute *a,
1126 struct mei_cl_device *cldev = to_mei_cl_device(dev);
1128 return scnprintf(buf, PAGE_SIZE, "%s", cldev->name);
1130 static DEVICE_ATTR_RO(name);
1132 static ssize_t uuid_show(struct device *dev, struct device_attribute *a,
1135 struct mei_cl_device *cldev = to_mei_cl_device(dev);
1136 const uuid_le *uuid = mei_me_cl_uuid(cldev->me_cl);
1138 return sprintf(buf, "%pUl", uuid);
1140 static DEVICE_ATTR_RO(uuid);
1142 static ssize_t version_show(struct device *dev, struct device_attribute *a,
1145 struct mei_cl_device *cldev = to_mei_cl_device(dev);
1146 u8 version = mei_me_cl_ver(cldev->me_cl);
1148 return sprintf(buf, "%02X", version);
1150 static DEVICE_ATTR_RO(version);
1152 static ssize_t modalias_show(struct device *dev, struct device_attribute *a,
1155 struct mei_cl_device *cldev = to_mei_cl_device(dev);
1156 const uuid_le *uuid = mei_me_cl_uuid(cldev->me_cl);
1157 u8 version = mei_me_cl_ver(cldev->me_cl);
1159 return scnprintf(buf, PAGE_SIZE, "mei:%s:%pUl:%02X:",
1160 cldev->name, uuid, version);
1162 static DEVICE_ATTR_RO(modalias);
1164 static ssize_t max_conn_show(struct device *dev, struct device_attribute *a,
1167 struct mei_cl_device *cldev = to_mei_cl_device(dev);
1168 u8 maxconn = mei_me_cl_max_conn(cldev->me_cl);
1170 return sprintf(buf, "%d", maxconn);
1172 static DEVICE_ATTR_RO(max_conn);
1174 static ssize_t fixed_show(struct device *dev, struct device_attribute *a,
1177 struct mei_cl_device *cldev = to_mei_cl_device(dev);
1178 u8 fixed = mei_me_cl_fixed(cldev->me_cl);
1180 return sprintf(buf, "%d", fixed);
1182 static DEVICE_ATTR_RO(fixed);
1184 static ssize_t vtag_show(struct device *dev, struct device_attribute *a,
1187 struct mei_cl_device *cldev = to_mei_cl_device(dev);
1188 bool vt = mei_me_cl_vt(cldev->me_cl);
1190 return sprintf(buf, "%d", vt);
1192 static DEVICE_ATTR_RO(vtag);
1194 static ssize_t max_len_show(struct device *dev, struct device_attribute *a,
1197 struct mei_cl_device *cldev = to_mei_cl_device(dev);
1198 u32 maxlen = mei_me_cl_max_len(cldev->me_cl);
1200 return sprintf(buf, "%u", maxlen);
1202 static DEVICE_ATTR_RO(max_len);
1204 static struct attribute *mei_cldev_attrs[] = {
1205 &dev_attr_name.attr,
1206 &dev_attr_uuid.attr,
1207 &dev_attr_version.attr,
1208 &dev_attr_modalias.attr,
1209 &dev_attr_max_conn.attr,
1210 &dev_attr_fixed.attr,
1211 &dev_attr_vtag.attr,
1212 &dev_attr_max_len.attr,
1215 ATTRIBUTE_GROUPS(mei_cldev);
1218 * mei_cl_device_uevent - me client bus uevent handler
1221 * @env: uevent kobject
1223 * Return: 0 on success -ENOMEM on when add_uevent_var fails
1225 static int mei_cl_device_uevent(struct device *dev, struct kobj_uevent_env *env)
1227 struct mei_cl_device *cldev = to_mei_cl_device(dev);
1228 const uuid_le *uuid = mei_me_cl_uuid(cldev->me_cl);
1229 u8 version = mei_me_cl_ver(cldev->me_cl);
1231 if (add_uevent_var(env, "MEI_CL_VERSION=%d", version))
1234 if (add_uevent_var(env, "MEI_CL_UUID=%pUl", uuid))
1237 if (add_uevent_var(env, "MEI_CL_NAME=%s", cldev->name))
1240 if (add_uevent_var(env, "MODALIAS=mei:%s:%pUl:%02X:",
1241 cldev->name, uuid, version))
1247 static struct bus_type mei_cl_bus_type = {
1249 .dev_groups = mei_cldev_groups,
1250 .match = mei_cl_device_match,
1251 .probe = mei_cl_device_probe,
1252 .remove = mei_cl_device_remove,
1253 .uevent = mei_cl_device_uevent,
1256 static struct mei_device *mei_dev_bus_get(struct mei_device *bus)
1259 get_device(bus->dev);
1264 static void mei_dev_bus_put(struct mei_device *bus)
1267 put_device(bus->dev);
1270 static void mei_cl_bus_dev_release(struct device *dev)
1272 struct mei_cl_device *cldev = to_mei_cl_device(dev);
1277 mei_cl_flush_queues(cldev->cl, NULL);
1278 mei_me_cl_put(cldev->me_cl);
1279 mei_dev_bus_put(cldev->bus);
1280 mei_cl_unlink(cldev->cl);
1285 static const struct device_type mei_cl_device_type = {
1286 .release = mei_cl_bus_dev_release,
1290 * mei_cl_bus_set_name - set device name for me client device
1291 * <controller>-<client device>
1292 * Example: 0000:00:16.0-55213584-9a29-4916-badf-0fb7ed682aeb
1294 * @cldev: me client device
1296 static inline void mei_cl_bus_set_name(struct mei_cl_device *cldev)
1298 dev_set_name(&cldev->dev, "%s-%pUl",
1299 dev_name(cldev->bus->dev),
1300 mei_me_cl_uuid(cldev->me_cl));
1304 * mei_cl_bus_dev_alloc - initialize and allocate mei client device
1309 * Return: allocated device structur or NULL on allocation failure
1311 static struct mei_cl_device *mei_cl_bus_dev_alloc(struct mei_device *bus,
1312 struct mei_me_client *me_cl)
1314 struct mei_cl_device *cldev;
1317 cldev = kzalloc(sizeof(*cldev), GFP_KERNEL);
1321 cl = mei_cl_allocate(bus);
1327 device_initialize(&cldev->dev);
1328 cldev->dev.parent = bus->dev;
1329 cldev->dev.bus = &mei_cl_bus_type;
1330 cldev->dev.type = &mei_cl_device_type;
1331 cldev->bus = mei_dev_bus_get(bus);
1332 cldev->me_cl = mei_me_cl_get(me_cl);
1334 mei_cl_bus_set_name(cldev);
1335 cldev->is_added = 0;
1336 INIT_LIST_HEAD(&cldev->bus_list);
1342 * mei_cl_bus_dev_setup - setup me client device
1343 * run fix up routines and set the device name
1346 * @cldev: me client device
1348 * Return: true if the device is eligible for enumeration
1350 static bool mei_cl_bus_dev_setup(struct mei_device *bus,
1351 struct mei_cl_device *cldev)
1353 cldev->do_match = 1;
1354 mei_cl_bus_dev_fixup(cldev);
1356 /* the device name can change during fix up */
1357 if (cldev->do_match)
1358 mei_cl_bus_set_name(cldev);
1360 return cldev->do_match == 1;
1364 * mei_cl_bus_dev_add - add me client devices
1366 * @cldev: me client device
1368 * Return: 0 on success; < 0 on failre
1370 static int mei_cl_bus_dev_add(struct mei_cl_device *cldev)
1374 dev_dbg(cldev->bus->dev, "adding %pUL:%02X\n",
1375 mei_me_cl_uuid(cldev->me_cl),
1376 mei_me_cl_ver(cldev->me_cl));
1377 ret = device_add(&cldev->dev);
1379 cldev->is_added = 1;
1385 * mei_cl_bus_dev_stop - stop the driver
1387 * @cldev: me client device
1389 static void mei_cl_bus_dev_stop(struct mei_cl_device *cldev)
1391 if (cldev->is_added)
1392 device_release_driver(&cldev->dev);
1396 * mei_cl_bus_dev_destroy - destroy me client devices object
1398 * @cldev: me client device
1400 * Locking: called under "dev->cl_bus_lock" lock
1402 static void mei_cl_bus_dev_destroy(struct mei_cl_device *cldev)
1405 WARN_ON(!mutex_is_locked(&cldev->bus->cl_bus_lock));
1407 if (!cldev->is_added)
1410 device_del(&cldev->dev);
1412 list_del_init(&cldev->bus_list);
1414 cldev->is_added = 0;
1415 put_device(&cldev->dev);
1419 * mei_cl_bus_remove_device - remove a devices form the bus
1421 * @cldev: me client device
1423 static void mei_cl_bus_remove_device(struct mei_cl_device *cldev)
1425 mei_cl_bus_dev_stop(cldev);
1426 mei_cl_bus_dev_destroy(cldev);
1430 * mei_cl_bus_remove_devices - remove all devices form the bus
1434 void mei_cl_bus_remove_devices(struct mei_device *bus)
1436 struct mei_cl_device *cldev, *next;
1438 mutex_lock(&bus->cl_bus_lock);
1439 list_for_each_entry_safe(cldev, next, &bus->device_list, bus_list)
1440 mei_cl_bus_remove_device(cldev);
1441 mutex_unlock(&bus->cl_bus_lock);
1446 * mei_cl_bus_dev_init - allocate and initializes an mei client devices
1447 * based on me client
1452 * Locking: called under "dev->cl_bus_lock" lock
1454 static void mei_cl_bus_dev_init(struct mei_device *bus,
1455 struct mei_me_client *me_cl)
1457 struct mei_cl_device *cldev;
1459 WARN_ON(!mutex_is_locked(&bus->cl_bus_lock));
1461 dev_dbg(bus->dev, "initializing %pUl", mei_me_cl_uuid(me_cl));
1463 if (me_cl->bus_added)
1466 cldev = mei_cl_bus_dev_alloc(bus, me_cl);
1470 me_cl->bus_added = true;
1471 list_add_tail(&cldev->bus_list, &bus->device_list);
1476 * mei_cl_bus_rescan - scan me clients list and add create
1477 * devices for eligible clients
1481 static void mei_cl_bus_rescan(struct mei_device *bus)
1483 struct mei_cl_device *cldev, *n;
1484 struct mei_me_client *me_cl;
1486 mutex_lock(&bus->cl_bus_lock);
1488 down_read(&bus->me_clients_rwsem);
1489 list_for_each_entry(me_cl, &bus->me_clients, list)
1490 mei_cl_bus_dev_init(bus, me_cl);
1491 up_read(&bus->me_clients_rwsem);
1493 list_for_each_entry_safe(cldev, n, &bus->device_list, bus_list) {
1495 if (!mei_me_cl_is_active(cldev->me_cl)) {
1496 mei_cl_bus_remove_device(cldev);
1500 if (cldev->is_added)
1503 if (mei_cl_bus_dev_setup(bus, cldev))
1504 mei_cl_bus_dev_add(cldev);
1506 list_del_init(&cldev->bus_list);
1507 put_device(&cldev->dev);
1510 mutex_unlock(&bus->cl_bus_lock);
1512 dev_dbg(bus->dev, "rescan end");
1515 void mei_cl_bus_rescan_work(struct work_struct *work)
1517 struct mei_device *bus =
1518 container_of(work, struct mei_device, bus_rescan_work);
1520 mei_cl_bus_rescan(bus);
1523 int __mei_cldev_driver_register(struct mei_cl_driver *cldrv,
1524 struct module *owner)
1528 cldrv->driver.name = cldrv->name;
1529 cldrv->driver.owner = owner;
1530 cldrv->driver.bus = &mei_cl_bus_type;
1532 err = driver_register(&cldrv->driver);
1536 pr_debug("mei: driver [%s] registered\n", cldrv->driver.name);
1540 EXPORT_SYMBOL_GPL(__mei_cldev_driver_register);
1542 void mei_cldev_driver_unregister(struct mei_cl_driver *cldrv)
1544 driver_unregister(&cldrv->driver);
1546 pr_debug("mei: driver [%s] unregistered\n", cldrv->driver.name);
1548 EXPORT_SYMBOL_GPL(mei_cldev_driver_unregister);
1551 int __init mei_cl_bus_init(void)
1553 return bus_register(&mei_cl_bus_type);
1556 void __exit mei_cl_bus_exit(void)
1558 bus_unregister(&mei_cl_bus_type);