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 mei_me_cl_put(me_cl);
280 up_write(&dev->me_clients_rwsem);
284 * mei_me_cl_rm_by_uuid_id - remove all me clients matching client id
286 * @dev: the device structure
287 * @uuid: me client uuid
290 * Locking: called under "dev->device_lock" lock
292 void mei_me_cl_rm_by_uuid_id(struct mei_device *dev, const uuid_le *uuid, u8 id)
294 struct mei_me_client *me_cl;
296 dev_dbg(dev->dev, "remove %pUl %d\n", uuid, id);
298 down_write(&dev->me_clients_rwsem);
299 me_cl = __mei_me_cl_by_uuid_id(dev, uuid, id);
300 __mei_me_cl_del(dev, me_cl);
301 mei_me_cl_put(me_cl);
302 up_write(&dev->me_clients_rwsem);
306 * mei_me_cl_rm_all - remove all me clients
308 * @dev: the device structure
310 * Locking: called under "dev->device_lock" lock
312 void mei_me_cl_rm_all(struct mei_device *dev)
314 struct mei_me_client *me_cl, *next;
316 down_write(&dev->me_clients_rwsem);
317 list_for_each_entry_safe(me_cl, next, &dev->me_clients, list)
318 __mei_me_cl_del(dev, me_cl);
319 up_write(&dev->me_clients_rwsem);
323 * mei_cl_cmp_id - tells if the clients are the same
325 * @cl1: host client 1
326 * @cl2: host client 2
328 * Return: true - if the clients has same host and me ids
331 static inline bool mei_cl_cmp_id(const struct mei_cl *cl1,
332 const struct mei_cl *cl2)
335 (cl1->host_client_id == cl2->host_client_id) &&
336 (mei_cl_me_id(cl1) == mei_cl_me_id(cl2));
340 * mei_io_cb_free - free mei_cb_private related memory
342 * @cb: mei callback struct
344 void mei_io_cb_free(struct mei_cl_cb *cb)
355 * mei_io_cb_init - allocate and initialize io callback
358 * @type: operation type
359 * @fp: pointer to file structure
361 * Return: mei_cl_cb pointer or NULL;
363 static struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl,
364 enum mei_cb_file_ops type,
365 const struct file *fp)
367 struct mei_cl_cb *cb;
369 cb = kzalloc(sizeof(struct mei_cl_cb), GFP_KERNEL);
373 INIT_LIST_HEAD(&cb->list);
382 * __mei_io_list_flush_cl - removes and frees cbs belonging to cl.
384 * @head: an instance of our list structure
385 * @cl: host client, can be NULL for flushing the whole list
386 * @free: whether to free the cbs
388 static void __mei_io_list_flush_cl(struct list_head *head,
389 const struct mei_cl *cl, bool free)
391 struct mei_cl_cb *cb, *next;
393 /* enable removing everything if no cl is specified */
394 list_for_each_entry_safe(cb, next, head, list) {
395 if (!cl || mei_cl_cmp_id(cl, cb->cl)) {
396 list_del_init(&cb->list);
404 * mei_io_list_flush_cl - removes list entry belonging to cl.
406 * @head: An instance of our list structure
409 static inline void mei_io_list_flush_cl(struct list_head *head,
410 const struct mei_cl *cl)
412 __mei_io_list_flush_cl(head, cl, false);
416 * mei_io_list_free_cl - removes cb belonging to cl and free them
418 * @head: An instance of our list structure
421 static inline void mei_io_list_free_cl(struct list_head *head,
422 const struct mei_cl *cl)
424 __mei_io_list_flush_cl(head, cl, true);
428 * mei_io_list_free_fp - free cb from a list that matches file pointer
431 * @fp: file pointer (matching cb file object), may be NULL
433 static void mei_io_list_free_fp(struct list_head *head, const struct file *fp)
435 struct mei_cl_cb *cb, *next;
437 list_for_each_entry_safe(cb, next, head, list)
438 if (!fp || fp == cb->fp)
443 * mei_cl_alloc_cb - a convenient wrapper for allocating read cb
446 * @length: size of the buffer
447 * @fop_type: operation type
448 * @fp: associated file pointer (might be NULL)
450 * Return: cb on success and NULL on failure
452 struct mei_cl_cb *mei_cl_alloc_cb(struct mei_cl *cl, size_t length,
453 enum mei_cb_file_ops fop_type,
454 const struct file *fp)
456 struct mei_cl_cb *cb;
458 cb = mei_io_cb_init(cl, fop_type, fp);
465 cb->buf.data = kmalloc(length, GFP_KERNEL);
470 cb->buf.size = length;
476 * mei_cl_enqueue_ctrl_wr_cb - a convenient wrapper for allocating
477 * and enqueuing of the control commands cb
480 * @length: size of the buffer
481 * @fop_type: operation type
482 * @fp: associated file pointer (might be NULL)
484 * Return: cb on success and NULL on failure
485 * Locking: called under "dev->device_lock" lock
487 struct mei_cl_cb *mei_cl_enqueue_ctrl_wr_cb(struct mei_cl *cl, size_t length,
488 enum mei_cb_file_ops fop_type,
489 const struct file *fp)
491 struct mei_cl_cb *cb;
493 /* for RX always allocate at least client's mtu */
495 length = max_t(size_t, length, mei_cl_mtu(cl));
497 cb = mei_cl_alloc_cb(cl, length, fop_type, fp);
501 list_add_tail(&cb->list, &cl->dev->ctrl_wr_list);
506 * mei_cl_read_cb - find this cl's callback in the read list
507 * for a specific file
510 * @fp: file pointer (matching cb file object), may be NULL
512 * Return: cb on success, NULL if cb is not found
514 struct mei_cl_cb *mei_cl_read_cb(const struct mei_cl *cl, const struct file *fp)
516 struct mei_cl_cb *cb;
518 list_for_each_entry(cb, &cl->rd_completed, list)
519 if (!fp || fp == cb->fp)
526 * mei_cl_flush_queues - flushes queue lists belonging to cl.
529 * @fp: file pointer (matching cb file object), may be NULL
531 * Return: 0 on success, -EINVAL if cl or cl->dev is NULL.
533 int mei_cl_flush_queues(struct mei_cl *cl, const struct file *fp)
535 struct mei_device *dev;
537 if (WARN_ON(!cl || !cl->dev))
542 cl_dbg(dev, cl, "remove list entry belonging to cl\n");
543 mei_io_list_free_cl(&cl->dev->write_list, cl);
544 mei_io_list_free_cl(&cl->dev->write_waiting_list, cl);
545 mei_io_list_flush_cl(&cl->dev->ctrl_wr_list, cl);
546 mei_io_list_flush_cl(&cl->dev->ctrl_rd_list, cl);
547 mei_io_list_free_fp(&cl->rd_pending, fp);
548 mei_io_list_free_fp(&cl->rd_completed, fp);
554 * mei_cl_init - initializes cl.
556 * @cl: host client to be initialized
559 static void mei_cl_init(struct mei_cl *cl, struct mei_device *dev)
561 memset(cl, 0, sizeof(struct mei_cl));
562 init_waitqueue_head(&cl->wait);
563 init_waitqueue_head(&cl->rx_wait);
564 init_waitqueue_head(&cl->tx_wait);
565 init_waitqueue_head(&cl->ev_wait);
566 INIT_LIST_HEAD(&cl->rd_completed);
567 INIT_LIST_HEAD(&cl->rd_pending);
568 INIT_LIST_HEAD(&cl->link);
569 cl->writing_state = MEI_IDLE;
570 cl->state = MEI_FILE_UNINITIALIZED;
575 * mei_cl_allocate - allocates cl structure and sets it up.
578 * Return: The allocated file or NULL on failure
580 struct mei_cl *mei_cl_allocate(struct mei_device *dev)
584 cl = kmalloc(sizeof(struct mei_cl), GFP_KERNEL);
588 mei_cl_init(cl, dev);
594 * mei_cl_link - allocate host id in the host map
598 * Return: 0 on success
599 * -EINVAL on incorrect values
600 * -EMFILE if open count exceeded.
602 int mei_cl_link(struct mei_cl *cl)
604 struct mei_device *dev;
607 if (WARN_ON(!cl || !cl->dev))
612 id = find_first_zero_bit(dev->host_clients_map, MEI_CLIENTS_MAX);
613 if (id >= MEI_CLIENTS_MAX) {
614 dev_err(dev->dev, "id exceeded %d", MEI_CLIENTS_MAX);
618 if (dev->open_handle_count >= MEI_MAX_OPEN_HANDLE_COUNT) {
619 dev_err(dev->dev, "open_handle_count exceeded %d",
620 MEI_MAX_OPEN_HANDLE_COUNT);
624 dev->open_handle_count++;
626 cl->host_client_id = id;
627 list_add_tail(&cl->link, &dev->file_list);
629 set_bit(id, dev->host_clients_map);
631 cl->state = MEI_FILE_INITIALIZING;
633 cl_dbg(dev, cl, "link cl\n");
638 * mei_cl_unlink - remove host client from the list
644 int mei_cl_unlink(struct mei_cl *cl)
646 struct mei_device *dev;
648 /* don't shout on error exit path */
652 if (WARN_ON(!cl->dev))
657 cl_dbg(dev, cl, "unlink client");
659 if (dev->open_handle_count > 0)
660 dev->open_handle_count--;
662 /* never clear the 0 bit */
663 if (cl->host_client_id)
664 clear_bit(cl->host_client_id, dev->host_clients_map);
666 list_del_init(&cl->link);
668 cl->state = MEI_FILE_UNINITIALIZED;
669 cl->writing_state = MEI_IDLE;
671 WARN_ON(!list_empty(&cl->rd_completed) ||
672 !list_empty(&cl->rd_pending) ||
673 !list_empty(&cl->link));
678 void mei_host_client_init(struct mei_device *dev)
680 dev->dev_state = MEI_DEV_ENABLED;
681 dev->reset_count = 0;
683 schedule_work(&dev->bus_rescan_work);
685 pm_runtime_mark_last_busy(dev->dev);
686 dev_dbg(dev->dev, "rpm: autosuspend\n");
687 pm_request_autosuspend(dev->dev);
691 * mei_hbuf_acquire - try to acquire host buffer
693 * @dev: the device structure
694 * Return: true if host buffer was acquired
696 bool mei_hbuf_acquire(struct mei_device *dev)
698 if (mei_pg_state(dev) == MEI_PG_ON ||
699 mei_pg_in_transition(dev)) {
700 dev_dbg(dev->dev, "device is in pg\n");
704 if (!dev->hbuf_is_ready) {
705 dev_dbg(dev->dev, "hbuf is not ready\n");
709 dev->hbuf_is_ready = false;
715 * mei_cl_wake_all - wake up readers, writers and event waiters so
716 * they can be interrupted
720 static void mei_cl_wake_all(struct mei_cl *cl)
722 struct mei_device *dev = cl->dev;
724 /* synchronized under device mutex */
725 if (waitqueue_active(&cl->rx_wait)) {
726 cl_dbg(dev, cl, "Waking up reading client!\n");
727 wake_up_interruptible(&cl->rx_wait);
729 /* synchronized under device mutex */
730 if (waitqueue_active(&cl->tx_wait)) {
731 cl_dbg(dev, cl, "Waking up writing client!\n");
732 wake_up_interruptible(&cl->tx_wait);
734 /* synchronized under device mutex */
735 if (waitqueue_active(&cl->ev_wait)) {
736 cl_dbg(dev, cl, "Waking up waiting for event clients!\n");
737 wake_up_interruptible(&cl->ev_wait);
739 /* synchronized under device mutex */
740 if (waitqueue_active(&cl->wait)) {
741 cl_dbg(dev, cl, "Waking up ctrl write clients!\n");
747 * mei_cl_set_disconnected - set disconnected state and clear
748 * associated states and resources
752 static void mei_cl_set_disconnected(struct mei_cl *cl)
754 struct mei_device *dev = cl->dev;
756 if (cl->state == MEI_FILE_DISCONNECTED ||
757 cl->state <= MEI_FILE_INITIALIZING)
760 cl->state = MEI_FILE_DISCONNECTED;
761 mei_io_list_free_cl(&dev->write_list, cl);
762 mei_io_list_free_cl(&dev->write_waiting_list, cl);
763 mei_io_list_flush_cl(&dev->ctrl_rd_list, cl);
764 mei_io_list_flush_cl(&dev->ctrl_wr_list, cl);
766 cl->rx_flow_ctrl_creds = 0;
767 cl->tx_flow_ctrl_creds = 0;
770 mei_cl_bus_module_put(cl);
775 if (!WARN_ON(cl->me_cl->connect_count == 0))
776 cl->me_cl->connect_count--;
778 if (cl->me_cl->connect_count == 0)
779 cl->me_cl->tx_flow_ctrl_creds = 0;
781 mei_me_cl_put(cl->me_cl);
785 static int mei_cl_set_connecting(struct mei_cl *cl, struct mei_me_client *me_cl)
787 if (!mei_me_cl_get(me_cl))
790 /* only one connection is allowed for fixed address clients */
791 if (me_cl->props.fixed_address) {
792 if (me_cl->connect_count) {
793 mei_me_cl_put(me_cl);
799 cl->state = MEI_FILE_CONNECTING;
800 cl->me_cl->connect_count++;
806 * mei_cl_send_disconnect - send disconnect request
809 * @cb: callback block
811 * Return: 0, OK; otherwise, error.
813 static int mei_cl_send_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb)
815 struct mei_device *dev;
820 ret = mei_hbm_cl_disconnect_req(dev, cl);
823 cl->state = MEI_FILE_DISCONNECT_REPLY;
827 list_move_tail(&cb->list, &dev->ctrl_rd_list);
828 cl->timer_count = MEI_CONNECT_TIMEOUT;
829 mei_schedule_stall_timer(dev);
835 * mei_cl_irq_disconnect - processes close related operation from
836 * interrupt thread context - send disconnect request
839 * @cb: callback block.
840 * @cmpl_list: complete list.
842 * Return: 0, OK; otherwise, error.
844 int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
845 struct list_head *cmpl_list)
847 struct mei_device *dev = cl->dev;
852 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
853 slots = mei_hbuf_empty_slots(dev);
855 if (slots < msg_slots)
858 ret = mei_cl_send_disconnect(cl, cb);
860 list_move_tail(&cb->list, cmpl_list);
866 * __mei_cl_disconnect - disconnect host client from the me one
867 * internal function runtime pm has to be already acquired
871 * Return: 0 on success, <0 on failure.
873 static int __mei_cl_disconnect(struct mei_cl *cl)
875 struct mei_device *dev;
876 struct mei_cl_cb *cb;
881 cl->state = MEI_FILE_DISCONNECTING;
883 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, MEI_FOP_DISCONNECT, NULL);
889 if (mei_hbuf_acquire(dev)) {
890 rets = mei_cl_send_disconnect(cl, cb);
892 cl_err(dev, cl, "failed to disconnect.\n");
897 mutex_unlock(&dev->device_lock);
898 wait_event_timeout(cl->wait,
899 cl->state == MEI_FILE_DISCONNECT_REPLY ||
900 cl->state == MEI_FILE_DISCONNECTED,
901 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
902 mutex_lock(&dev->device_lock);
905 if (cl->state != MEI_FILE_DISCONNECT_REPLY &&
906 cl->state != MEI_FILE_DISCONNECTED) {
907 cl_dbg(dev, cl, "timeout on disconnect from FW client.\n");
912 /* we disconnect also on error */
913 mei_cl_set_disconnected(cl);
915 cl_dbg(dev, cl, "successfully disconnected from FW client.\n");
922 * mei_cl_disconnect - disconnect host client from the me one
926 * Locking: called under "dev->device_lock" lock
928 * Return: 0 on success, <0 on failure.
930 int mei_cl_disconnect(struct mei_cl *cl)
932 struct mei_device *dev;
935 if (WARN_ON(!cl || !cl->dev))
940 cl_dbg(dev, cl, "disconnecting");
942 if (!mei_cl_is_connected(cl))
945 if (mei_cl_is_fixed_address(cl)) {
946 mei_cl_set_disconnected(cl);
950 rets = pm_runtime_get(dev->dev);
951 if (rets < 0 && rets != -EINPROGRESS) {
952 pm_runtime_put_noidle(dev->dev);
953 cl_err(dev, cl, "rpm: get failed %d\n", rets);
957 rets = __mei_cl_disconnect(cl);
959 cl_dbg(dev, cl, "rpm: autosuspend\n");
960 pm_runtime_mark_last_busy(dev->dev);
961 pm_runtime_put_autosuspend(dev->dev);
968 * mei_cl_is_other_connecting - checks if other
969 * client with the same me client id is connecting
971 * @cl: private data of the file object
973 * Return: true if other client is connected, false - otherwise.
975 static bool mei_cl_is_other_connecting(struct mei_cl *cl)
977 struct mei_device *dev;
978 struct mei_cl_cb *cb;
982 list_for_each_entry(cb, &dev->ctrl_rd_list, list) {
983 if (cb->fop_type == MEI_FOP_CONNECT &&
984 mei_cl_me_id(cl) == mei_cl_me_id(cb->cl))
992 * mei_cl_send_connect - send connect request
995 * @cb: callback block
997 * Return: 0, OK; otherwise, error.
999 static int mei_cl_send_connect(struct mei_cl *cl, struct mei_cl_cb *cb)
1001 struct mei_device *dev;
1006 ret = mei_hbm_cl_connect_req(dev, cl);
1009 cl->state = MEI_FILE_DISCONNECT_REPLY;
1013 list_move_tail(&cb->list, &dev->ctrl_rd_list);
1014 cl->timer_count = MEI_CONNECT_TIMEOUT;
1015 mei_schedule_stall_timer(dev);
1020 * mei_cl_irq_connect - send connect request in irq_thread context
1023 * @cb: callback block
1024 * @cmpl_list: complete list
1026 * Return: 0, OK; otherwise, error.
1028 int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
1029 struct list_head *cmpl_list)
1031 struct mei_device *dev = cl->dev;
1036 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1037 slots = mei_hbuf_empty_slots(dev);
1039 if (mei_cl_is_other_connecting(cl))
1042 if (slots < msg_slots)
1045 rets = mei_cl_send_connect(cl, cb);
1047 list_move_tail(&cb->list, cmpl_list);
1053 * mei_cl_connect - connect host client to the me one
1057 * @fp: pointer to file structure
1059 * Locking: called under "dev->device_lock" lock
1061 * Return: 0 on success, <0 on failure.
1063 int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl,
1064 const struct file *fp)
1066 struct mei_device *dev;
1067 struct mei_cl_cb *cb;
1070 if (WARN_ON(!cl || !cl->dev || !me_cl))
1075 if (!mei_cl_bus_module_get(cl))
1078 rets = mei_cl_set_connecting(cl, me_cl);
1082 if (mei_cl_is_fixed_address(cl)) {
1083 cl->state = MEI_FILE_CONNECTED;
1088 rets = pm_runtime_get(dev->dev);
1089 if (rets < 0 && rets != -EINPROGRESS) {
1090 pm_runtime_put_noidle(dev->dev);
1091 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1095 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, MEI_FOP_CONNECT, fp);
1101 /* run hbuf acquire last so we don't have to undo */
1102 if (!mei_cl_is_other_connecting(cl) && mei_hbuf_acquire(dev)) {
1103 rets = mei_cl_send_connect(cl, cb);
1108 mutex_unlock(&dev->device_lock);
1109 wait_event_timeout(cl->wait,
1110 (cl->state == MEI_FILE_CONNECTED ||
1111 cl->state == MEI_FILE_DISCONNECTED ||
1112 cl->state == MEI_FILE_DISCONNECT_REQUIRED ||
1113 cl->state == MEI_FILE_DISCONNECT_REPLY),
1114 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1115 mutex_lock(&dev->device_lock);
1117 if (!mei_cl_is_connected(cl)) {
1118 if (cl->state == MEI_FILE_DISCONNECT_REQUIRED) {
1119 mei_io_list_flush_cl(&dev->ctrl_rd_list, cl);
1120 mei_io_list_flush_cl(&dev->ctrl_wr_list, cl);
1121 /* ignore disconnect return valuue;
1122 * in case of failure reset will be invoked
1124 __mei_cl_disconnect(cl);
1129 /* timeout or something went really wrong */
1131 cl->status = -EFAULT;
1136 cl_dbg(dev, cl, "rpm: autosuspend\n");
1137 pm_runtime_mark_last_busy(dev->dev);
1138 pm_runtime_put_autosuspend(dev->dev);
1143 if (!mei_cl_is_connected(cl))
1144 mei_cl_set_disconnected(cl);
1150 * mei_cl_alloc_linked - allocate and link host client
1152 * @dev: the device structure
1154 * Return: cl on success ERR_PTR on failure
1156 struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev)
1161 cl = mei_cl_allocate(dev);
1167 ret = mei_cl_link(cl);
1174 return ERR_PTR(ret);
1178 * mei_cl_tx_flow_ctrl_creds - checks flow_control credits for cl.
1182 * Return: 1 if tx_flow_ctrl_creds >0, 0 - otherwise.
1184 static int mei_cl_tx_flow_ctrl_creds(struct mei_cl *cl)
1186 if (WARN_ON(!cl || !cl->me_cl))
1189 if (cl->tx_flow_ctrl_creds > 0)
1192 if (mei_cl_is_fixed_address(cl))
1195 if (mei_cl_is_single_recv_buf(cl)) {
1196 if (cl->me_cl->tx_flow_ctrl_creds > 0)
1203 * mei_cl_tx_flow_ctrl_creds_reduce - reduces transmit flow control credits
1210 * -EINVAL when ctrl credits are <= 0
1212 static int mei_cl_tx_flow_ctrl_creds_reduce(struct mei_cl *cl)
1214 if (WARN_ON(!cl || !cl->me_cl))
1217 if (mei_cl_is_fixed_address(cl))
1220 if (mei_cl_is_single_recv_buf(cl)) {
1221 if (WARN_ON(cl->me_cl->tx_flow_ctrl_creds <= 0))
1223 cl->me_cl->tx_flow_ctrl_creds--;
1225 if (WARN_ON(cl->tx_flow_ctrl_creds <= 0))
1227 cl->tx_flow_ctrl_creds--;
1233 * mei_cl_notify_fop2req - convert fop to proper request
1235 * @fop: client notification start response command
1237 * Return: MEI_HBM_NOTIFICATION_START/STOP
1239 u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop)
1241 if (fop == MEI_FOP_NOTIFY_START)
1242 return MEI_HBM_NOTIFICATION_START;
1244 return MEI_HBM_NOTIFICATION_STOP;
1248 * mei_cl_notify_req2fop - convert notification request top file operation type
1250 * @req: hbm notification request type
1252 * Return: MEI_FOP_NOTIFY_START/STOP
1254 enum mei_cb_file_ops mei_cl_notify_req2fop(u8 req)
1256 if (req == MEI_HBM_NOTIFICATION_START)
1257 return MEI_FOP_NOTIFY_START;
1259 return MEI_FOP_NOTIFY_STOP;
1263 * mei_cl_irq_notify - send notification request in irq_thread context
1266 * @cb: callback block.
1267 * @cmpl_list: complete list.
1269 * Return: 0 on such and error otherwise.
1271 int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb,
1272 struct list_head *cmpl_list)
1274 struct mei_device *dev = cl->dev;
1280 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1281 slots = mei_hbuf_empty_slots(dev);
1283 if (slots < msg_slots)
1286 request = mei_cl_notify_fop2req(cb->fop_type);
1287 ret = mei_hbm_cl_notify_req(dev, cl, request);
1290 list_move_tail(&cb->list, cmpl_list);
1294 list_move_tail(&cb->list, &dev->ctrl_rd_list);
1299 * mei_cl_notify_request - send notification stop/start request
1302 * @fp: associate request with file
1303 * @request: 1 for start or 0 for stop
1305 * Locking: called under "dev->device_lock" lock
1307 * Return: 0 on such and error otherwise.
1309 int mei_cl_notify_request(struct mei_cl *cl,
1310 const struct file *fp, u8 request)
1312 struct mei_device *dev;
1313 struct mei_cl_cb *cb;
1314 enum mei_cb_file_ops fop_type;
1317 if (WARN_ON(!cl || !cl->dev))
1322 if (!dev->hbm_f_ev_supported) {
1323 cl_dbg(dev, cl, "notifications not supported\n");
1327 if (!mei_cl_is_connected(cl))
1330 rets = pm_runtime_get(dev->dev);
1331 if (rets < 0 && rets != -EINPROGRESS) {
1332 pm_runtime_put_noidle(dev->dev);
1333 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1337 fop_type = mei_cl_notify_req2fop(request);
1338 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, fop_type, fp);
1344 if (mei_hbuf_acquire(dev)) {
1345 if (mei_hbm_cl_notify_req(dev, cl, request)) {
1349 list_move_tail(&cb->list, &dev->ctrl_rd_list);
1352 mutex_unlock(&dev->device_lock);
1353 wait_event_timeout(cl->wait,
1354 cl->notify_en == request || !mei_cl_is_connected(cl),
1355 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1356 mutex_lock(&dev->device_lock);
1358 if (cl->notify_en != request && !cl->status)
1359 cl->status = -EFAULT;
1364 cl_dbg(dev, cl, "rpm: autosuspend\n");
1365 pm_runtime_mark_last_busy(dev->dev);
1366 pm_runtime_put_autosuspend(dev->dev);
1373 * mei_cl_notify - raise notification
1377 * Locking: called under "dev->device_lock" lock
1379 void mei_cl_notify(struct mei_cl *cl)
1381 struct mei_device *dev;
1383 if (!cl || !cl->dev)
1391 cl_dbg(dev, cl, "notify event");
1392 cl->notify_ev = true;
1393 if (!mei_cl_bus_notify_event(cl))
1394 wake_up_interruptible(&cl->ev_wait);
1397 kill_fasync(&cl->ev_async, SIGIO, POLL_PRI);
1402 * mei_cl_notify_get - get or wait for notification event
1405 * @block: this request is blocking
1406 * @notify_ev: true if notification event was received
1408 * Locking: called under "dev->device_lock" lock
1410 * Return: 0 on such and error otherwise.
1412 int mei_cl_notify_get(struct mei_cl *cl, bool block, bool *notify_ev)
1414 struct mei_device *dev;
1419 if (WARN_ON(!cl || !cl->dev))
1424 if (!dev->hbm_f_ev_supported) {
1425 cl_dbg(dev, cl, "notifications not supported\n");
1429 if (!mei_cl_is_connected(cl))
1438 mutex_unlock(&dev->device_lock);
1439 rets = wait_event_interruptible(cl->ev_wait, cl->notify_ev);
1440 mutex_lock(&dev->device_lock);
1446 *notify_ev = cl->notify_ev;
1447 cl->notify_ev = false;
1452 * mei_cl_read_start - the start read client message function.
1455 * @length: number of bytes to read
1456 * @fp: pointer to file structure
1458 * Return: 0 on success, <0 on failure.
1460 int mei_cl_read_start(struct mei_cl *cl, size_t length, const struct file *fp)
1462 struct mei_device *dev;
1463 struct mei_cl_cb *cb;
1466 if (WARN_ON(!cl || !cl->dev))
1471 if (!mei_cl_is_connected(cl))
1474 if (!mei_me_cl_is_active(cl->me_cl)) {
1475 cl_err(dev, cl, "no such me client\n");
1479 if (mei_cl_is_fixed_address(cl))
1482 /* HW currently supports only one pending read */
1483 if (cl->rx_flow_ctrl_creds)
1486 cb = mei_cl_enqueue_ctrl_wr_cb(cl, length, MEI_FOP_READ, fp);
1490 rets = pm_runtime_get(dev->dev);
1491 if (rets < 0 && rets != -EINPROGRESS) {
1492 pm_runtime_put_noidle(dev->dev);
1493 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1498 if (mei_hbuf_acquire(dev)) {
1499 rets = mei_hbm_cl_flow_control_req(dev, cl);
1503 list_move_tail(&cb->list, &cl->rd_pending);
1505 cl->rx_flow_ctrl_creds++;
1508 cl_dbg(dev, cl, "rpm: autosuspend\n");
1509 pm_runtime_mark_last_busy(dev->dev);
1510 pm_runtime_put_autosuspend(dev->dev);
1519 * mei_cl_irq_write - write a message to device
1520 * from the interrupt thread context
1523 * @cb: callback block.
1524 * @cmpl_list: complete list.
1526 * Return: 0, OK; otherwise error.
1528 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
1529 struct list_head *cmpl_list)
1531 struct mei_device *dev;
1532 struct mei_msg_data *buf;
1533 struct mei_msg_hdr mei_hdr;
1540 if (WARN_ON(!cl || !cl->dev))
1547 first_chunk = cb->buf_idx == 0;
1549 rets = first_chunk ? mei_cl_tx_flow_ctrl_creds(cl) : 1;
1554 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1558 slots = mei_hbuf_empty_slots(dev);
1559 len = buf->size - cb->buf_idx;
1560 msg_slots = mei_data2slots(len);
1562 mei_hdr.host_addr = mei_cl_host_addr(cl);
1563 mei_hdr.me_addr = mei_cl_me_id(cl);
1564 mei_hdr.reserved = 0;
1565 mei_hdr.internal = cb->internal;
1567 if (slots >= msg_slots) {
1568 mei_hdr.length = len;
1569 mei_hdr.msg_complete = 1;
1570 /* Split the message only if we can write the whole host buffer */
1571 } else if (slots == dev->hbuf_depth) {
1573 len = (slots * sizeof(u32)) - sizeof(struct mei_msg_hdr);
1574 mei_hdr.length = len;
1575 mei_hdr.msg_complete = 0;
1577 /* wait for next time the host buffer is empty */
1581 cl_dbg(dev, cl, "buf: size = %zu idx = %zu\n",
1582 cb->buf.size, cb->buf_idx);
1584 rets = mei_write_message(dev, &mei_hdr, buf->data + cb->buf_idx);
1589 cl->writing_state = MEI_WRITING;
1590 cb->buf_idx += mei_hdr.length;
1591 cb->completed = mei_hdr.msg_complete == 1;
1594 if (mei_cl_tx_flow_ctrl_creds_reduce(cl)) {
1600 if (mei_hdr.msg_complete)
1601 list_move_tail(&cb->list, &dev->write_waiting_list);
1607 list_move_tail(&cb->list, cmpl_list);
1612 * mei_cl_write - submit a write cb to mei device
1613 * assumes device_lock is locked
1616 * @cb: write callback with filled data
1618 * Return: number of bytes sent on success, <0 on failure.
1620 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb)
1622 struct mei_device *dev;
1623 struct mei_msg_data *buf;
1624 struct mei_msg_hdr mei_hdr;
1629 if (WARN_ON(!cl || !cl->dev))
1639 blocking = cb->blocking;
1641 cl_dbg(dev, cl, "size=%d\n", size);
1643 rets = pm_runtime_get(dev->dev);
1644 if (rets < 0 && rets != -EINPROGRESS) {
1645 pm_runtime_put_noidle(dev->dev);
1646 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1651 cl->writing_state = MEI_IDLE;
1653 mei_hdr.host_addr = mei_cl_host_addr(cl);
1654 mei_hdr.me_addr = mei_cl_me_id(cl);
1655 mei_hdr.reserved = 0;
1656 mei_hdr.msg_complete = 0;
1657 mei_hdr.internal = cb->internal;
1659 rets = mei_cl_tx_flow_ctrl_creds(cl);
1664 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1668 if (!mei_hbuf_acquire(dev)) {
1669 cl_dbg(dev, cl, "Cannot acquire the host buffer: not sending.\n");
1674 /* Check for a maximum length */
1675 if (size > mei_hbuf_max_len(dev)) {
1676 mei_hdr.length = mei_hbuf_max_len(dev);
1677 mei_hdr.msg_complete = 0;
1679 mei_hdr.length = size;
1680 mei_hdr.msg_complete = 1;
1683 rets = mei_write_message(dev, &mei_hdr, buf->data);
1687 rets = mei_cl_tx_flow_ctrl_creds_reduce(cl);
1691 cl->writing_state = MEI_WRITING;
1692 cb->buf_idx = mei_hdr.length;
1693 cb->completed = mei_hdr.msg_complete == 1;
1696 if (mei_hdr.msg_complete)
1697 list_add_tail(&cb->list, &dev->write_waiting_list);
1699 list_add_tail(&cb->list, &dev->write_list);
1702 if (blocking && cl->writing_state != MEI_WRITE_COMPLETE) {
1704 mutex_unlock(&dev->device_lock);
1705 rets = wait_event_interruptible(cl->tx_wait,
1706 cl->writing_state == MEI_WRITE_COMPLETE ||
1707 (!mei_cl_is_connected(cl)));
1708 mutex_lock(&dev->device_lock);
1709 /* wait_event_interruptible returns -ERESTARTSYS */
1711 if (signal_pending(current))
1715 if (cl->writing_state != MEI_WRITE_COMPLETE) {
1723 cl_dbg(dev, cl, "rpm: autosuspend\n");
1724 pm_runtime_mark_last_busy(dev->dev);
1725 pm_runtime_put_autosuspend(dev->dev);
1734 * mei_cl_complete - processes completed operation for a client
1736 * @cl: private data of the file object.
1737 * @cb: callback block.
1739 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb)
1741 struct mei_device *dev = cl->dev;
1743 switch (cb->fop_type) {
1746 cl->writing_state = MEI_WRITE_COMPLETE;
1747 if (waitqueue_active(&cl->tx_wait)) {
1748 wake_up_interruptible(&cl->tx_wait);
1750 pm_runtime_mark_last_busy(dev->dev);
1751 pm_request_autosuspend(dev->dev);
1756 list_add_tail(&cb->list, &cl->rd_completed);
1757 if (!mei_cl_is_fixed_address(cl) &&
1758 !WARN_ON(!cl->rx_flow_ctrl_creds))
1759 cl->rx_flow_ctrl_creds--;
1760 if (!mei_cl_bus_rx_event(cl))
1761 wake_up_interruptible(&cl->rx_wait);
1764 case MEI_FOP_CONNECT:
1765 case MEI_FOP_DISCONNECT:
1766 case MEI_FOP_NOTIFY_STOP:
1767 case MEI_FOP_NOTIFY_START:
1768 if (waitqueue_active(&cl->wait))
1772 case MEI_FOP_DISCONNECT_RSP:
1774 mei_cl_set_disconnected(cl);
1783 * mei_cl_all_disconnect - disconnect forcefully all connected clients
1787 void mei_cl_all_disconnect(struct mei_device *dev)
1791 list_for_each_entry(cl, &dev->file_list, link)
1792 mei_cl_set_disconnected(cl);