3 * Intel Management Engine Interface (Intel MEI) Linux driver
4 * Copyright (c) 2003-2012, Intel Corporation.
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms and conditions of the GNU General Public License,
8 * version 2, as published by the Free Software Foundation.
10 * This program is distributed in the hope it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
17 #include <linux/sched/signal.h>
18 #include <linux/wait.h>
19 #include <linux/delay.h>
20 #include <linux/slab.h>
21 #include <linux/pm_runtime.h>
23 #include <linux/mei.h>
30 * mei_me_cl_init - initialize me client
34 void mei_me_cl_init(struct mei_me_client *me_cl)
36 INIT_LIST_HEAD(&me_cl->list);
37 kref_init(&me_cl->refcnt);
41 * mei_me_cl_get - increases me client refcount
45 * Locking: called under "dev->device_lock" lock
47 * Return: me client or NULL
49 struct mei_me_client *mei_me_cl_get(struct mei_me_client *me_cl)
51 if (me_cl && kref_get_unless_zero(&me_cl->refcnt))
58 * mei_me_cl_release - free me client
60 * Locking: called under "dev->device_lock" lock
62 * @ref: me_client refcount
64 static void mei_me_cl_release(struct kref *ref)
66 struct mei_me_client *me_cl =
67 container_of(ref, struct mei_me_client, refcnt);
73 * mei_me_cl_put - decrease me client refcount and free client if necessary
75 * Locking: called under "dev->device_lock" lock
79 void mei_me_cl_put(struct mei_me_client *me_cl)
82 kref_put(&me_cl->refcnt, mei_me_cl_release);
86 * __mei_me_cl_del - delete me client from the list and decrease
92 * Locking: dev->me_clients_rwsem
94 static void __mei_me_cl_del(struct mei_device *dev, struct mei_me_client *me_cl)
99 list_del_init(&me_cl->list);
100 mei_me_cl_put(me_cl);
104 * mei_me_cl_del - delete me client from the list and decrease
110 void mei_me_cl_del(struct mei_device *dev, struct mei_me_client *me_cl)
112 down_write(&dev->me_clients_rwsem);
113 __mei_me_cl_del(dev, me_cl);
114 up_write(&dev->me_clients_rwsem);
118 * mei_me_cl_add - add me client to the list
123 void mei_me_cl_add(struct mei_device *dev, struct mei_me_client *me_cl)
125 down_write(&dev->me_clients_rwsem);
126 list_add(&me_cl->list, &dev->me_clients);
127 up_write(&dev->me_clients_rwsem);
131 * __mei_me_cl_by_uuid - locate me client by uuid
132 * increases ref count
135 * @uuid: me client uuid
137 * Return: me client or NULL if not found
139 * Locking: dev->me_clients_rwsem
141 static struct mei_me_client *__mei_me_cl_by_uuid(struct mei_device *dev,
144 struct mei_me_client *me_cl;
147 WARN_ON(!rwsem_is_locked(&dev->me_clients_rwsem));
149 list_for_each_entry(me_cl, &dev->me_clients, list) {
150 pn = &me_cl->props.protocol_name;
151 if (uuid_le_cmp(*uuid, *pn) == 0)
152 return mei_me_cl_get(me_cl);
159 * mei_me_cl_by_uuid - locate me client by uuid
160 * increases ref count
163 * @uuid: me client uuid
165 * Return: me client or NULL if not found
167 * Locking: dev->me_clients_rwsem
169 struct mei_me_client *mei_me_cl_by_uuid(struct mei_device *dev,
172 struct mei_me_client *me_cl;
174 down_read(&dev->me_clients_rwsem);
175 me_cl = __mei_me_cl_by_uuid(dev, uuid);
176 up_read(&dev->me_clients_rwsem);
182 * mei_me_cl_by_id - locate me client by client id
183 * increases ref count
185 * @dev: the device structure
186 * @client_id: me client id
188 * Return: me client or NULL if not found
190 * Locking: dev->me_clients_rwsem
192 struct mei_me_client *mei_me_cl_by_id(struct mei_device *dev, u8 client_id)
195 struct mei_me_client *__me_cl, *me_cl = NULL;
197 down_read(&dev->me_clients_rwsem);
198 list_for_each_entry(__me_cl, &dev->me_clients, list) {
199 if (__me_cl->client_id == client_id) {
200 me_cl = mei_me_cl_get(__me_cl);
204 up_read(&dev->me_clients_rwsem);
210 * __mei_me_cl_by_uuid_id - locate me client by client id and uuid
211 * increases ref count
213 * @dev: the device structure
214 * @uuid: me client uuid
215 * @client_id: me client id
217 * Return: me client or null if not found
219 * Locking: dev->me_clients_rwsem
221 static struct mei_me_client *__mei_me_cl_by_uuid_id(struct mei_device *dev,
222 const uuid_le *uuid, u8 client_id)
224 struct mei_me_client *me_cl;
227 WARN_ON(!rwsem_is_locked(&dev->me_clients_rwsem));
229 list_for_each_entry(me_cl, &dev->me_clients, list) {
230 pn = &me_cl->props.protocol_name;
231 if (uuid_le_cmp(*uuid, *pn) == 0 &&
232 me_cl->client_id == client_id)
233 return mei_me_cl_get(me_cl);
241 * mei_me_cl_by_uuid_id - locate me client by client id and uuid
242 * increases ref count
244 * @dev: the device structure
245 * @uuid: me client uuid
246 * @client_id: me client id
248 * Return: me client or null if not found
250 struct mei_me_client *mei_me_cl_by_uuid_id(struct mei_device *dev,
251 const uuid_le *uuid, u8 client_id)
253 struct mei_me_client *me_cl;
255 down_read(&dev->me_clients_rwsem);
256 me_cl = __mei_me_cl_by_uuid_id(dev, uuid, client_id);
257 up_read(&dev->me_clients_rwsem);
263 * mei_me_cl_rm_by_uuid - remove all me clients matching uuid
265 * @dev: the device structure
266 * @uuid: me client uuid
268 * Locking: called under "dev->device_lock" lock
270 void mei_me_cl_rm_by_uuid(struct mei_device *dev, const uuid_le *uuid)
272 struct mei_me_client *me_cl;
274 dev_dbg(dev->dev, "remove %pUl\n", uuid);
276 down_write(&dev->me_clients_rwsem);
277 me_cl = __mei_me_cl_by_uuid(dev, uuid);
278 __mei_me_cl_del(dev, me_cl);
279 up_write(&dev->me_clients_rwsem);
283 * mei_me_cl_rm_by_uuid_id - remove all me clients matching client id
285 * @dev: the device structure
286 * @uuid: me client uuid
289 * Locking: called under "dev->device_lock" lock
291 void mei_me_cl_rm_by_uuid_id(struct mei_device *dev, const uuid_le *uuid, u8 id)
293 struct mei_me_client *me_cl;
295 dev_dbg(dev->dev, "remove %pUl %d\n", uuid, id);
297 down_write(&dev->me_clients_rwsem);
298 me_cl = __mei_me_cl_by_uuid_id(dev, uuid, id);
299 __mei_me_cl_del(dev, me_cl);
300 up_write(&dev->me_clients_rwsem);
304 * mei_me_cl_rm_all - remove all me clients
306 * @dev: the device structure
308 * Locking: called under "dev->device_lock" lock
310 void mei_me_cl_rm_all(struct mei_device *dev)
312 struct mei_me_client *me_cl, *next;
314 down_write(&dev->me_clients_rwsem);
315 list_for_each_entry_safe(me_cl, next, &dev->me_clients, list)
316 __mei_me_cl_del(dev, me_cl);
317 up_write(&dev->me_clients_rwsem);
321 * mei_io_cb_free - free mei_cb_private related memory
323 * @cb: mei callback struct
325 void mei_io_cb_free(struct mei_cl_cb *cb)
336 * mei_tx_cb_queue - queue tx callback
338 * Locking: called under "dev->device_lock" lock
340 * @cb: mei callback struct
341 * @head: an instance of list to queue on
343 static inline void mei_tx_cb_enqueue(struct mei_cl_cb *cb,
344 struct list_head *head)
346 list_add_tail(&cb->list, head);
347 cb->cl->tx_cb_queued++;
351 * mei_tx_cb_dequeue - dequeue tx callback
353 * Locking: called under "dev->device_lock" lock
355 * @cb: mei callback struct to dequeue and free
357 static inline void mei_tx_cb_dequeue(struct mei_cl_cb *cb)
359 if (!WARN_ON(cb->cl->tx_cb_queued == 0))
360 cb->cl->tx_cb_queued--;
366 * mei_io_cb_init - allocate and initialize io callback
369 * @type: operation type
370 * @fp: pointer to file structure
372 * Return: mei_cl_cb pointer or NULL;
374 static struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl,
375 enum mei_cb_file_ops type,
376 const struct file *fp)
378 struct mei_cl_cb *cb;
380 cb = kzalloc(sizeof(struct mei_cl_cb), GFP_KERNEL);
384 INIT_LIST_HEAD(&cb->list);
393 * mei_io_list_flush_cl - removes cbs belonging to the cl.
395 * @head: an instance of our list structure
398 static void mei_io_list_flush_cl(struct list_head *head,
399 const struct mei_cl *cl)
401 struct mei_cl_cb *cb, *next;
403 list_for_each_entry_safe(cb, next, head, list) {
405 list_del_init(&cb->list);
410 * mei_io_tx_list_free_cl - removes cb belonging to the cl and free them
412 * @head: An instance of our list structure
415 static void mei_io_tx_list_free_cl(struct list_head *head,
416 const struct mei_cl *cl)
418 struct mei_cl_cb *cb, *next;
420 list_for_each_entry_safe(cb, next, head, list) {
422 mei_tx_cb_dequeue(cb);
427 * mei_io_list_free_fp - free cb from a list that matches file pointer
430 * @fp: file pointer (matching cb file object), may be NULL
432 static void mei_io_list_free_fp(struct list_head *head, const struct file *fp)
434 struct mei_cl_cb *cb, *next;
436 list_for_each_entry_safe(cb, next, head, list)
437 if (!fp || fp == cb->fp)
442 * mei_cl_alloc_cb - a convenient wrapper for allocating read cb
445 * @length: size of the buffer
446 * @fop_type: operation type
447 * @fp: associated file pointer (might be NULL)
449 * Return: cb on success and NULL on failure
451 struct mei_cl_cb *mei_cl_alloc_cb(struct mei_cl *cl, size_t length,
452 enum mei_cb_file_ops fop_type,
453 const struct file *fp)
455 struct mei_cl_cb *cb;
457 cb = mei_io_cb_init(cl, fop_type, fp);
464 cb->buf.data = kmalloc(roundup(length, MEI_SLOT_SIZE), GFP_KERNEL);
469 cb->buf.size = length;
475 * mei_cl_enqueue_ctrl_wr_cb - a convenient wrapper for allocating
476 * and enqueuing of the control commands cb
479 * @length: size of the buffer
480 * @fop_type: operation type
481 * @fp: associated file pointer (might be NULL)
483 * Return: cb on success and NULL on failure
484 * Locking: called under "dev->device_lock" lock
486 struct mei_cl_cb *mei_cl_enqueue_ctrl_wr_cb(struct mei_cl *cl, size_t length,
487 enum mei_cb_file_ops fop_type,
488 const struct file *fp)
490 struct mei_cl_cb *cb;
492 /* for RX always allocate at least client's mtu */
494 length = max_t(size_t, length, mei_cl_mtu(cl));
496 cb = mei_cl_alloc_cb(cl, length, fop_type, fp);
500 list_add_tail(&cb->list, &cl->dev->ctrl_wr_list);
505 * mei_cl_read_cb - find this cl's callback in the read list
506 * for a specific file
509 * @fp: file pointer (matching cb file object), may be NULL
511 * Return: cb on success, NULL if cb is not found
513 struct mei_cl_cb *mei_cl_read_cb(const struct mei_cl *cl, const struct file *fp)
515 struct mei_cl_cb *cb;
517 list_for_each_entry(cb, &cl->rd_completed, list)
518 if (!fp || fp == cb->fp)
525 * mei_cl_flush_queues - flushes queue lists belonging to cl.
528 * @fp: file pointer (matching cb file object), may be NULL
530 * Return: 0 on success, -EINVAL if cl or cl->dev is NULL.
532 int mei_cl_flush_queues(struct mei_cl *cl, const struct file *fp)
534 struct mei_device *dev;
536 if (WARN_ON(!cl || !cl->dev))
541 cl_dbg(dev, cl, "remove list entry belonging to cl\n");
542 mei_io_tx_list_free_cl(&cl->dev->write_list, cl);
543 mei_io_tx_list_free_cl(&cl->dev->write_waiting_list, cl);
544 mei_io_list_flush_cl(&cl->dev->ctrl_wr_list, cl);
545 mei_io_list_flush_cl(&cl->dev->ctrl_rd_list, cl);
546 mei_io_list_free_fp(&cl->rd_pending, fp);
547 mei_io_list_free_fp(&cl->rd_completed, fp);
553 * mei_cl_init - initializes cl.
555 * @cl: host client to be initialized
558 static void mei_cl_init(struct mei_cl *cl, struct mei_device *dev)
560 memset(cl, 0, sizeof(struct mei_cl));
561 init_waitqueue_head(&cl->wait);
562 init_waitqueue_head(&cl->rx_wait);
563 init_waitqueue_head(&cl->tx_wait);
564 init_waitqueue_head(&cl->ev_wait);
565 INIT_LIST_HEAD(&cl->rd_completed);
566 INIT_LIST_HEAD(&cl->rd_pending);
567 INIT_LIST_HEAD(&cl->link);
568 cl->writing_state = MEI_IDLE;
569 cl->state = MEI_FILE_UNINITIALIZED;
574 * mei_cl_allocate - allocates cl structure and sets it up.
577 * Return: The allocated file or NULL on failure
579 struct mei_cl *mei_cl_allocate(struct mei_device *dev)
583 cl = kmalloc(sizeof(struct mei_cl), GFP_KERNEL);
587 mei_cl_init(cl, dev);
593 * mei_cl_link - allocate host id in the host map
597 * Return: 0 on success
598 * -EINVAL on incorrect values
599 * -EMFILE if open count exceeded.
601 int mei_cl_link(struct mei_cl *cl)
603 struct mei_device *dev;
606 if (WARN_ON(!cl || !cl->dev))
611 id = find_first_zero_bit(dev->host_clients_map, MEI_CLIENTS_MAX);
612 if (id >= MEI_CLIENTS_MAX) {
613 dev_err(dev->dev, "id exceeded %d", MEI_CLIENTS_MAX);
617 if (dev->open_handle_count >= MEI_MAX_OPEN_HANDLE_COUNT) {
618 dev_err(dev->dev, "open_handle_count exceeded %d",
619 MEI_MAX_OPEN_HANDLE_COUNT);
623 dev->open_handle_count++;
625 cl->host_client_id = id;
626 list_add_tail(&cl->link, &dev->file_list);
628 set_bit(id, dev->host_clients_map);
630 cl->state = MEI_FILE_INITIALIZING;
632 cl_dbg(dev, cl, "link cl\n");
637 * mei_cl_unlink - remove host client from the list
643 int mei_cl_unlink(struct mei_cl *cl)
645 struct mei_device *dev;
647 /* don't shout on error exit path */
651 if (WARN_ON(!cl->dev))
656 cl_dbg(dev, cl, "unlink client");
658 if (dev->open_handle_count > 0)
659 dev->open_handle_count--;
661 /* never clear the 0 bit */
662 if (cl->host_client_id)
663 clear_bit(cl->host_client_id, dev->host_clients_map);
665 list_del_init(&cl->link);
667 cl->state = MEI_FILE_UNINITIALIZED;
668 cl->writing_state = MEI_IDLE;
670 WARN_ON(!list_empty(&cl->rd_completed) ||
671 !list_empty(&cl->rd_pending) ||
672 !list_empty(&cl->link));
677 void mei_host_client_init(struct mei_device *dev)
679 dev->dev_state = MEI_DEV_ENABLED;
680 dev->reset_count = 0;
682 schedule_work(&dev->bus_rescan_work);
684 pm_runtime_mark_last_busy(dev->dev);
685 dev_dbg(dev->dev, "rpm: autosuspend\n");
686 pm_request_autosuspend(dev->dev);
690 * mei_hbuf_acquire - try to acquire host buffer
692 * @dev: the device structure
693 * Return: true if host buffer was acquired
695 bool mei_hbuf_acquire(struct mei_device *dev)
697 if (mei_pg_state(dev) == MEI_PG_ON ||
698 mei_pg_in_transition(dev)) {
699 dev_dbg(dev->dev, "device is in pg\n");
703 if (!dev->hbuf_is_ready) {
704 dev_dbg(dev->dev, "hbuf is not ready\n");
708 dev->hbuf_is_ready = false;
714 * mei_cl_wake_all - wake up readers, writers and event waiters so
715 * they can be interrupted
719 static void mei_cl_wake_all(struct mei_cl *cl)
721 struct mei_device *dev = cl->dev;
723 /* synchronized under device mutex */
724 if (waitqueue_active(&cl->rx_wait)) {
725 cl_dbg(dev, cl, "Waking up reading client!\n");
726 wake_up_interruptible(&cl->rx_wait);
728 /* synchronized under device mutex */
729 if (waitqueue_active(&cl->tx_wait)) {
730 cl_dbg(dev, cl, "Waking up writing client!\n");
731 wake_up_interruptible(&cl->tx_wait);
733 /* synchronized under device mutex */
734 if (waitqueue_active(&cl->ev_wait)) {
735 cl_dbg(dev, cl, "Waking up waiting for event clients!\n");
736 wake_up_interruptible(&cl->ev_wait);
738 /* synchronized under device mutex */
739 if (waitqueue_active(&cl->wait)) {
740 cl_dbg(dev, cl, "Waking up ctrl write clients!\n");
746 * mei_cl_set_disconnected - set disconnected state and clear
747 * associated states and resources
751 static void mei_cl_set_disconnected(struct mei_cl *cl)
753 struct mei_device *dev = cl->dev;
755 if (cl->state == MEI_FILE_DISCONNECTED ||
756 cl->state <= MEI_FILE_INITIALIZING)
759 cl->state = MEI_FILE_DISCONNECTED;
760 mei_io_tx_list_free_cl(&dev->write_list, cl);
761 mei_io_tx_list_free_cl(&dev->write_waiting_list, cl);
762 mei_io_list_flush_cl(&dev->ctrl_rd_list, cl);
763 mei_io_list_flush_cl(&dev->ctrl_wr_list, cl);
765 cl->rx_flow_ctrl_creds = 0;
766 cl->tx_flow_ctrl_creds = 0;
772 if (!WARN_ON(cl->me_cl->connect_count == 0))
773 cl->me_cl->connect_count--;
775 if (cl->me_cl->connect_count == 0)
776 cl->me_cl->tx_flow_ctrl_creds = 0;
778 mei_me_cl_put(cl->me_cl);
782 static int mei_cl_set_connecting(struct mei_cl *cl, struct mei_me_client *me_cl)
784 if (!mei_me_cl_get(me_cl))
787 /* only one connection is allowed for fixed address clients */
788 if (me_cl->props.fixed_address) {
789 if (me_cl->connect_count) {
790 mei_me_cl_put(me_cl);
796 cl->state = MEI_FILE_CONNECTING;
797 cl->me_cl->connect_count++;
803 * mei_cl_send_disconnect - send disconnect request
806 * @cb: callback block
808 * Return: 0, OK; otherwise, error.
810 static int mei_cl_send_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb)
812 struct mei_device *dev;
817 ret = mei_hbm_cl_disconnect_req(dev, cl);
820 cl->state = MEI_FILE_DISCONNECT_REPLY;
824 list_move_tail(&cb->list, &dev->ctrl_rd_list);
825 cl->timer_count = MEI_CONNECT_TIMEOUT;
826 mei_schedule_stall_timer(dev);
832 * mei_cl_irq_disconnect - processes close related operation from
833 * interrupt thread context - send disconnect request
836 * @cb: callback block.
837 * @cmpl_list: complete list.
839 * Return: 0, OK; otherwise, error.
841 int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
842 struct list_head *cmpl_list)
844 struct mei_device *dev = cl->dev;
849 msg_slots = mei_hbm2slots(sizeof(struct hbm_client_connect_request));
850 slots = mei_hbuf_empty_slots(dev);
854 if ((u32)slots < msg_slots)
857 ret = mei_cl_send_disconnect(cl, cb);
859 list_move_tail(&cb->list, cmpl_list);
865 * __mei_cl_disconnect - disconnect host client from the me one
866 * internal function runtime pm has to be already acquired
870 * Return: 0 on success, <0 on failure.
872 static int __mei_cl_disconnect(struct mei_cl *cl)
874 struct mei_device *dev;
875 struct mei_cl_cb *cb;
880 cl->state = MEI_FILE_DISCONNECTING;
882 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, MEI_FOP_DISCONNECT, NULL);
888 if (mei_hbuf_acquire(dev)) {
889 rets = mei_cl_send_disconnect(cl, cb);
891 cl_err(dev, cl, "failed to disconnect.\n");
896 mutex_unlock(&dev->device_lock);
897 wait_event_timeout(cl->wait,
898 cl->state == MEI_FILE_DISCONNECT_REPLY ||
899 cl->state == MEI_FILE_DISCONNECTED,
900 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
901 mutex_lock(&dev->device_lock);
904 if (cl->state != MEI_FILE_DISCONNECT_REPLY &&
905 cl->state != MEI_FILE_DISCONNECTED) {
906 cl_dbg(dev, cl, "timeout on disconnect from FW client.\n");
911 /* we disconnect also on error */
912 mei_cl_set_disconnected(cl);
914 cl_dbg(dev, cl, "successfully disconnected from FW client.\n");
921 * mei_cl_disconnect - disconnect host client from the me one
925 * Locking: called under "dev->device_lock" lock
927 * Return: 0 on success, <0 on failure.
929 int mei_cl_disconnect(struct mei_cl *cl)
931 struct mei_device *dev;
934 if (WARN_ON(!cl || !cl->dev))
939 cl_dbg(dev, cl, "disconnecting");
941 if (!mei_cl_is_connected(cl))
944 if (mei_cl_is_fixed_address(cl)) {
945 mei_cl_set_disconnected(cl);
949 if (dev->dev_state == MEI_DEV_POWER_DOWN) {
950 cl_dbg(dev, cl, "Device is powering down, don't bother with disconnection\n");
951 mei_cl_set_disconnected(cl);
955 rets = pm_runtime_get(dev->dev);
956 if (rets < 0 && rets != -EINPROGRESS) {
957 pm_runtime_put_noidle(dev->dev);
958 cl_err(dev, cl, "rpm: get failed %d\n", rets);
962 rets = __mei_cl_disconnect(cl);
964 cl_dbg(dev, cl, "rpm: autosuspend\n");
965 pm_runtime_mark_last_busy(dev->dev);
966 pm_runtime_put_autosuspend(dev->dev);
973 * mei_cl_is_other_connecting - checks if other
974 * client with the same me client id is connecting
976 * @cl: private data of the file object
978 * Return: true if other client is connected, false - otherwise.
980 static bool mei_cl_is_other_connecting(struct mei_cl *cl)
982 struct mei_device *dev;
983 struct mei_cl_cb *cb;
987 list_for_each_entry(cb, &dev->ctrl_rd_list, list) {
988 if (cb->fop_type == MEI_FOP_CONNECT &&
989 mei_cl_me_id(cl) == mei_cl_me_id(cb->cl))
997 * mei_cl_send_connect - send connect request
1000 * @cb: callback block
1002 * Return: 0, OK; otherwise, error.
1004 static int mei_cl_send_connect(struct mei_cl *cl, struct mei_cl_cb *cb)
1006 struct mei_device *dev;
1011 ret = mei_hbm_cl_connect_req(dev, cl);
1014 cl->state = MEI_FILE_DISCONNECT_REPLY;
1018 list_move_tail(&cb->list, &dev->ctrl_rd_list);
1019 cl->timer_count = MEI_CONNECT_TIMEOUT;
1020 mei_schedule_stall_timer(dev);
1025 * mei_cl_irq_connect - send connect request in irq_thread context
1028 * @cb: callback block
1029 * @cmpl_list: complete list
1031 * Return: 0, OK; otherwise, error.
1033 int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
1034 struct list_head *cmpl_list)
1036 struct mei_device *dev = cl->dev;
1041 if (mei_cl_is_other_connecting(cl))
1044 msg_slots = mei_hbm2slots(sizeof(struct hbm_client_connect_request));
1045 slots = mei_hbuf_empty_slots(dev);
1049 if ((u32)slots < msg_slots)
1052 rets = mei_cl_send_connect(cl, cb);
1054 list_move_tail(&cb->list, cmpl_list);
1060 * mei_cl_connect - connect host client to the me one
1064 * @fp: pointer to file structure
1066 * Locking: called under "dev->device_lock" lock
1068 * Return: 0 on success, <0 on failure.
1070 int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl,
1071 const struct file *fp)
1073 struct mei_device *dev;
1074 struct mei_cl_cb *cb;
1077 if (WARN_ON(!cl || !cl->dev || !me_cl))
1082 rets = mei_cl_set_connecting(cl, me_cl);
1086 if (mei_cl_is_fixed_address(cl)) {
1087 cl->state = MEI_FILE_CONNECTED;
1092 rets = pm_runtime_get(dev->dev);
1093 if (rets < 0 && rets != -EINPROGRESS) {
1094 pm_runtime_put_noidle(dev->dev);
1095 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1099 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, MEI_FOP_CONNECT, fp);
1105 /* run hbuf acquire last so we don't have to undo */
1106 if (!mei_cl_is_other_connecting(cl) && mei_hbuf_acquire(dev)) {
1107 rets = mei_cl_send_connect(cl, cb);
1112 mutex_unlock(&dev->device_lock);
1113 wait_event_timeout(cl->wait,
1114 (cl->state == MEI_FILE_CONNECTED ||
1115 cl->state == MEI_FILE_DISCONNECTED ||
1116 cl->state == MEI_FILE_DISCONNECT_REQUIRED ||
1117 cl->state == MEI_FILE_DISCONNECT_REPLY),
1118 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1119 mutex_lock(&dev->device_lock);
1121 if (!mei_cl_is_connected(cl)) {
1122 if (cl->state == MEI_FILE_DISCONNECT_REQUIRED) {
1123 mei_io_list_flush_cl(&dev->ctrl_rd_list, cl);
1124 mei_io_list_flush_cl(&dev->ctrl_wr_list, cl);
1125 /* ignore disconnect return valuue;
1126 * in case of failure reset will be invoked
1128 __mei_cl_disconnect(cl);
1133 /* timeout or something went really wrong */
1135 cl->status = -EFAULT;
1140 cl_dbg(dev, cl, "rpm: autosuspend\n");
1141 pm_runtime_mark_last_busy(dev->dev);
1142 pm_runtime_put_autosuspend(dev->dev);
1147 if (!mei_cl_is_connected(cl))
1148 mei_cl_set_disconnected(cl);
1154 * mei_cl_alloc_linked - allocate and link host client
1156 * @dev: the device structure
1158 * Return: cl on success ERR_PTR on failure
1160 struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev)
1165 cl = mei_cl_allocate(dev);
1171 ret = mei_cl_link(cl);
1178 return ERR_PTR(ret);
1182 * mei_cl_tx_flow_ctrl_creds - checks flow_control credits for cl.
1186 * Return: 1 if tx_flow_ctrl_creds >0, 0 - otherwise.
1188 static int mei_cl_tx_flow_ctrl_creds(struct mei_cl *cl)
1190 if (WARN_ON(!cl || !cl->me_cl))
1193 if (cl->tx_flow_ctrl_creds > 0)
1196 if (mei_cl_is_fixed_address(cl))
1199 if (mei_cl_is_single_recv_buf(cl)) {
1200 if (cl->me_cl->tx_flow_ctrl_creds > 0)
1207 * mei_cl_tx_flow_ctrl_creds_reduce - reduces transmit flow control credits
1214 * -EINVAL when ctrl credits are <= 0
1216 static int mei_cl_tx_flow_ctrl_creds_reduce(struct mei_cl *cl)
1218 if (WARN_ON(!cl || !cl->me_cl))
1221 if (mei_cl_is_fixed_address(cl))
1224 if (mei_cl_is_single_recv_buf(cl)) {
1225 if (WARN_ON(cl->me_cl->tx_flow_ctrl_creds <= 0))
1227 cl->me_cl->tx_flow_ctrl_creds--;
1229 if (WARN_ON(cl->tx_flow_ctrl_creds <= 0))
1231 cl->tx_flow_ctrl_creds--;
1237 * mei_cl_notify_fop2req - convert fop to proper request
1239 * @fop: client notification start response command
1241 * Return: MEI_HBM_NOTIFICATION_START/STOP
1243 u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop)
1245 if (fop == MEI_FOP_NOTIFY_START)
1246 return MEI_HBM_NOTIFICATION_START;
1248 return MEI_HBM_NOTIFICATION_STOP;
1252 * mei_cl_notify_req2fop - convert notification request top file operation type
1254 * @req: hbm notification request type
1256 * Return: MEI_FOP_NOTIFY_START/STOP
1258 enum mei_cb_file_ops mei_cl_notify_req2fop(u8 req)
1260 if (req == MEI_HBM_NOTIFICATION_START)
1261 return MEI_FOP_NOTIFY_START;
1263 return MEI_FOP_NOTIFY_STOP;
1267 * mei_cl_irq_notify - send notification request in irq_thread context
1270 * @cb: callback block.
1271 * @cmpl_list: complete list.
1273 * Return: 0 on such and error otherwise.
1275 int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb,
1276 struct list_head *cmpl_list)
1278 struct mei_device *dev = cl->dev;
1284 msg_slots = mei_hbm2slots(sizeof(struct hbm_client_connect_request));
1285 slots = mei_hbuf_empty_slots(dev);
1289 if ((u32)slots < msg_slots)
1292 request = mei_cl_notify_fop2req(cb->fop_type);
1293 ret = mei_hbm_cl_notify_req(dev, cl, request);
1296 list_move_tail(&cb->list, cmpl_list);
1300 list_move_tail(&cb->list, &dev->ctrl_rd_list);
1305 * mei_cl_notify_request - send notification stop/start request
1308 * @fp: associate request with file
1309 * @request: 1 for start or 0 for stop
1311 * Locking: called under "dev->device_lock" lock
1313 * Return: 0 on such and error otherwise.
1315 int mei_cl_notify_request(struct mei_cl *cl,
1316 const struct file *fp, u8 request)
1318 struct mei_device *dev;
1319 struct mei_cl_cb *cb;
1320 enum mei_cb_file_ops fop_type;
1323 if (WARN_ON(!cl || !cl->dev))
1328 if (!dev->hbm_f_ev_supported) {
1329 cl_dbg(dev, cl, "notifications not supported\n");
1333 if (!mei_cl_is_connected(cl))
1336 rets = pm_runtime_get(dev->dev);
1337 if (rets < 0 && rets != -EINPROGRESS) {
1338 pm_runtime_put_noidle(dev->dev);
1339 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1343 fop_type = mei_cl_notify_req2fop(request);
1344 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, fop_type, fp);
1350 if (mei_hbuf_acquire(dev)) {
1351 if (mei_hbm_cl_notify_req(dev, cl, request)) {
1355 list_move_tail(&cb->list, &dev->ctrl_rd_list);
1358 mutex_unlock(&dev->device_lock);
1359 wait_event_timeout(cl->wait,
1360 cl->notify_en == request ||
1362 !mei_cl_is_connected(cl),
1363 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1364 mutex_lock(&dev->device_lock);
1366 if (cl->notify_en != request && !cl->status)
1367 cl->status = -EFAULT;
1372 cl_dbg(dev, cl, "rpm: autosuspend\n");
1373 pm_runtime_mark_last_busy(dev->dev);
1374 pm_runtime_put_autosuspend(dev->dev);
1381 * mei_cl_notify - raise notification
1385 * Locking: called under "dev->device_lock" lock
1387 void mei_cl_notify(struct mei_cl *cl)
1389 struct mei_device *dev;
1391 if (!cl || !cl->dev)
1399 cl_dbg(dev, cl, "notify event");
1400 cl->notify_ev = true;
1401 if (!mei_cl_bus_notify_event(cl))
1402 wake_up_interruptible(&cl->ev_wait);
1405 kill_fasync(&cl->ev_async, SIGIO, POLL_PRI);
1410 * mei_cl_notify_get - get or wait for notification event
1413 * @block: this request is blocking
1414 * @notify_ev: true if notification event was received
1416 * Locking: called under "dev->device_lock" lock
1418 * Return: 0 on such and error otherwise.
1420 int mei_cl_notify_get(struct mei_cl *cl, bool block, bool *notify_ev)
1422 struct mei_device *dev;
1427 if (WARN_ON(!cl || !cl->dev))
1432 if (!dev->hbm_f_ev_supported) {
1433 cl_dbg(dev, cl, "notifications not supported\n");
1437 if (!mei_cl_is_connected(cl))
1446 mutex_unlock(&dev->device_lock);
1447 rets = wait_event_interruptible(cl->ev_wait, cl->notify_ev);
1448 mutex_lock(&dev->device_lock);
1454 *notify_ev = cl->notify_ev;
1455 cl->notify_ev = false;
1460 * mei_cl_read_start - the start read client message function.
1463 * @length: number of bytes to read
1464 * @fp: pointer to file structure
1466 * Return: 0 on success, <0 on failure.
1468 int mei_cl_read_start(struct mei_cl *cl, size_t length, const struct file *fp)
1470 struct mei_device *dev;
1471 struct mei_cl_cb *cb;
1474 if (WARN_ON(!cl || !cl->dev))
1479 if (!mei_cl_is_connected(cl))
1482 if (!mei_me_cl_is_active(cl->me_cl)) {
1483 cl_err(dev, cl, "no such me client\n");
1487 if (mei_cl_is_fixed_address(cl))
1490 /* HW currently supports only one pending read */
1491 if (cl->rx_flow_ctrl_creds)
1494 cb = mei_cl_enqueue_ctrl_wr_cb(cl, length, MEI_FOP_READ, fp);
1498 rets = pm_runtime_get(dev->dev);
1499 if (rets < 0 && rets != -EINPROGRESS) {
1500 pm_runtime_put_noidle(dev->dev);
1501 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1506 if (mei_hbuf_acquire(dev)) {
1507 rets = mei_hbm_cl_flow_control_req(dev, cl);
1511 list_move_tail(&cb->list, &cl->rd_pending);
1513 cl->rx_flow_ctrl_creds++;
1516 cl_dbg(dev, cl, "rpm: autosuspend\n");
1517 pm_runtime_mark_last_busy(dev->dev);
1518 pm_runtime_put_autosuspend(dev->dev);
1527 * mei_msg_hdr_init - initialize mei message header
1529 * @mei_hdr: mei message header
1530 * @cb: message callback structure
1532 static void mei_msg_hdr_init(struct mei_msg_hdr *mei_hdr, struct mei_cl_cb *cb)
1534 mei_hdr->host_addr = mei_cl_host_addr(cb->cl);
1535 mei_hdr->me_addr = mei_cl_me_id(cb->cl);
1536 mei_hdr->length = 0;
1537 mei_hdr->reserved = 0;
1538 mei_hdr->msg_complete = 0;
1539 mei_hdr->dma_ring = 0;
1540 mei_hdr->internal = cb->internal;
1544 * mei_cl_irq_write - write a message to device
1545 * from the interrupt thread context
1548 * @cb: callback block.
1549 * @cmpl_list: complete list.
1551 * Return: 0, OK; otherwise error.
1553 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
1554 struct list_head *cmpl_list)
1556 struct mei_device *dev;
1557 struct mei_msg_data *buf;
1558 struct mei_msg_hdr mei_hdr;
1559 size_t hdr_len = sizeof(mei_hdr);
1561 size_t hbuf_len, dr_len;
1569 if (WARN_ON(!cl || !cl->dev))
1576 first_chunk = cb->buf_idx == 0;
1578 rets = first_chunk ? mei_cl_tx_flow_ctrl_creds(cl) : 1;
1583 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1587 len = buf->size - cb->buf_idx;
1588 data = buf->data + cb->buf_idx;
1589 hbuf_slots = mei_hbuf_empty_slots(dev);
1590 if (hbuf_slots < 0) {
1595 hbuf_len = mei_slots2data(hbuf_slots);
1596 dr_slots = mei_dma_ring_empty_slots(dev);
1597 dr_len = mei_slots2data(dr_slots);
1599 mei_msg_hdr_init(&mei_hdr, cb);
1602 * Split the message only if we can write the whole host buffer
1603 * otherwise wait for next time the host buffer is empty.
1605 if (len + hdr_len <= hbuf_len) {
1606 mei_hdr.length = len;
1607 mei_hdr.msg_complete = 1;
1608 } else if (dr_slots && hbuf_len >= hdr_len + sizeof(dma_len)) {
1609 mei_hdr.dma_ring = 1;
1613 mei_hdr.msg_complete = 1;
1615 mei_hdr.length = sizeof(dma_len);
1618 } else if ((u32)hbuf_slots == mei_hbuf_depth(dev)) {
1619 len = hbuf_len - hdr_len;
1620 mei_hdr.length = len;
1625 if (mei_hdr.dma_ring)
1626 mei_dma_ring_write(dev, buf->data + cb->buf_idx, len);
1628 rets = mei_write_message(dev, &mei_hdr, hdr_len, data, mei_hdr.length);
1633 cl->writing_state = MEI_WRITING;
1637 if (mei_cl_tx_flow_ctrl_creds_reduce(cl)) {
1643 if (mei_hdr.msg_complete)
1644 list_move_tail(&cb->list, &dev->write_waiting_list);
1650 list_move_tail(&cb->list, cmpl_list);
1655 * mei_cl_write - submit a write cb to mei device
1656 * assumes device_lock is locked
1659 * @cb: write callback with filled data
1661 * Return: number of bytes sent on success, <0 on failure.
1663 ssize_t mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb)
1665 struct mei_device *dev;
1666 struct mei_msg_data *buf;
1667 struct mei_msg_hdr mei_hdr;
1668 size_t hdr_len = sizeof(mei_hdr);
1669 size_t len, hbuf_len, dr_len;
1677 if (WARN_ON(!cl || !cl->dev))
1688 cl_dbg(dev, cl, "len=%zd\n", len);
1690 blocking = cb->blocking;
1693 rets = pm_runtime_get(dev->dev);
1694 if (rets < 0 && rets != -EINPROGRESS) {
1695 pm_runtime_put_noidle(dev->dev);
1696 cl_err(dev, cl, "rpm: get failed %zd\n", rets);
1701 cl->writing_state = MEI_IDLE;
1704 rets = mei_cl_tx_flow_ctrl_creds(cl);
1708 mei_msg_hdr_init(&mei_hdr, cb);
1711 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1716 if (!mei_hbuf_acquire(dev)) {
1717 cl_dbg(dev, cl, "Cannot acquire the host buffer: not sending.\n");
1722 hbuf_slots = mei_hbuf_empty_slots(dev);
1723 if (hbuf_slots < 0) {
1728 hbuf_len = mei_slots2data(hbuf_slots);
1729 dr_slots = mei_dma_ring_empty_slots(dev);
1730 dr_len = mei_slots2data(dr_slots);
1732 if (len + hdr_len <= hbuf_len) {
1733 mei_hdr.length = len;
1734 mei_hdr.msg_complete = 1;
1735 } else if (dr_slots && hbuf_len >= hdr_len + sizeof(dma_len)) {
1736 mei_hdr.dma_ring = 1;
1740 mei_hdr.msg_complete = 1;
1742 mei_hdr.length = sizeof(dma_len);
1746 len = hbuf_len - hdr_len;
1747 mei_hdr.length = len;
1750 if (mei_hdr.dma_ring)
1751 mei_dma_ring_write(dev, buf->data, len);
1753 rets = mei_write_message(dev, &mei_hdr, hdr_len,
1754 data, mei_hdr.length);
1758 rets = mei_cl_tx_flow_ctrl_creds_reduce(cl);
1762 cl->writing_state = MEI_WRITING;
1764 /* restore return value */
1768 if (mei_hdr.msg_complete)
1769 mei_tx_cb_enqueue(cb, &dev->write_waiting_list);
1771 mei_tx_cb_enqueue(cb, &dev->write_list);
1774 if (blocking && cl->writing_state != MEI_WRITE_COMPLETE) {
1776 mutex_unlock(&dev->device_lock);
1777 rets = wait_event_interruptible(cl->tx_wait,
1778 cl->writing_state == MEI_WRITE_COMPLETE ||
1779 (!mei_cl_is_connected(cl)));
1780 mutex_lock(&dev->device_lock);
1781 /* wait_event_interruptible returns -ERESTARTSYS */
1783 if (signal_pending(current))
1787 if (cl->writing_state != MEI_WRITE_COMPLETE) {
1795 cl_dbg(dev, cl, "rpm: autosuspend\n");
1796 pm_runtime_mark_last_busy(dev->dev);
1797 pm_runtime_put_autosuspend(dev->dev);
1806 * mei_cl_complete - processes completed operation for a client
1808 * @cl: private data of the file object.
1809 * @cb: callback block.
1811 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb)
1813 struct mei_device *dev = cl->dev;
1815 switch (cb->fop_type) {
1817 mei_tx_cb_dequeue(cb);
1818 cl->writing_state = MEI_WRITE_COMPLETE;
1819 if (waitqueue_active(&cl->tx_wait)) {
1820 wake_up_interruptible(&cl->tx_wait);
1822 pm_runtime_mark_last_busy(dev->dev);
1823 pm_request_autosuspend(dev->dev);
1828 list_add_tail(&cb->list, &cl->rd_completed);
1829 if (!mei_cl_is_fixed_address(cl) &&
1830 !WARN_ON(!cl->rx_flow_ctrl_creds))
1831 cl->rx_flow_ctrl_creds--;
1832 if (!mei_cl_bus_rx_event(cl))
1833 wake_up_interruptible(&cl->rx_wait);
1836 case MEI_FOP_CONNECT:
1837 case MEI_FOP_DISCONNECT:
1838 case MEI_FOP_NOTIFY_STOP:
1839 case MEI_FOP_NOTIFY_START:
1840 if (waitqueue_active(&cl->wait))
1844 case MEI_FOP_DISCONNECT_RSP:
1846 mei_cl_set_disconnected(cl);
1855 * mei_cl_all_disconnect - disconnect forcefully all connected clients
1859 void mei_cl_all_disconnect(struct mei_device *dev)
1863 list_for_each_entry(cl, &dev->file_list, link)
1864 mei_cl_set_disconnected(cl);