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.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 - removes and frees cbs belonging to cl.
384 * @list: 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(struct mei_cl_cb *list,
389 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, &list->list, list) {
395 if (!cl || mei_cl_cmp_id(cl, cb->cl)) {
396 list_del_init(&cb->list);
404 * mei_io_list_flush - removes list entry belonging to cl.
406 * @list: An instance of our list structure
409 void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl)
411 __mei_io_list_flush(list, cl, false);
415 * mei_io_list_free - removes cb belonging to cl and free them
417 * @list: An instance of our list structure
420 static inline void mei_io_list_free(struct mei_cl_cb *list, struct mei_cl *cl)
422 __mei_io_list_flush(list, cl, true);
426 * mei_cl_alloc_cb - a convenient wrapper for allocating read cb
429 * @length: size of the buffer
430 * @fop_type: operation type
431 * @fp: associated file pointer (might be NULL)
433 * Return: cb on success and NULL on failure
435 struct mei_cl_cb *mei_cl_alloc_cb(struct mei_cl *cl, size_t length,
436 enum mei_cb_file_ops fop_type,
437 const struct file *fp)
439 struct mei_cl_cb *cb;
441 cb = mei_io_cb_init(cl, fop_type, fp);
448 cb->buf.data = kmalloc(length, GFP_KERNEL);
453 cb->buf.size = length;
459 * mei_cl_enqueue_ctrl_wr_cb - a convenient wrapper for allocating
460 * and enqueuing of the control commands cb
463 * @length: size of the buffer
464 * @fop_type: operation type
465 * @fp: associated file pointer (might be NULL)
467 * Return: cb on success and NULL on failure
468 * Locking: called under "dev->device_lock" lock
470 struct mei_cl_cb *mei_cl_enqueue_ctrl_wr_cb(struct mei_cl *cl, size_t length,
471 enum mei_cb_file_ops fop_type,
472 const struct file *fp)
474 struct mei_cl_cb *cb;
476 /* for RX always allocate at least client's mtu */
478 length = max_t(size_t, length, mei_cl_mtu(cl));
480 cb = mei_cl_alloc_cb(cl, length, fop_type, fp);
484 list_add_tail(&cb->list, &cl->dev->ctrl_wr_list.list);
489 * mei_cl_read_cb - find this cl's callback in the read list
490 * for a specific file
493 * @fp: file pointer (matching cb file object), may be NULL
495 * Return: cb on success, NULL if cb is not found
497 struct mei_cl_cb *mei_cl_read_cb(const struct mei_cl *cl, const struct file *fp)
499 struct mei_cl_cb *cb;
501 list_for_each_entry(cb, &cl->rd_completed, list)
502 if (!fp || fp == cb->fp)
509 * mei_cl_read_cb_flush - free client's read pending and completed cbs
510 * for a specific file
513 * @fp: file pointer (matching cb file object), may be NULL
515 void mei_cl_read_cb_flush(const struct mei_cl *cl, const struct file *fp)
517 struct mei_cl_cb *cb, *next;
519 list_for_each_entry_safe(cb, next, &cl->rd_completed, list)
520 if (!fp || fp == cb->fp)
524 list_for_each_entry_safe(cb, next, &cl->rd_pending, list)
525 if (!fp || fp == cb->fp)
530 * mei_cl_flush_queues - flushes queue lists belonging to cl.
533 * @fp: file pointer (matching cb file object), may be NULL
535 * Return: 0 on success, -EINVAL if cl or cl->dev is NULL.
537 int mei_cl_flush_queues(struct mei_cl *cl, const struct file *fp)
539 struct mei_device *dev;
541 if (WARN_ON(!cl || !cl->dev))
546 cl_dbg(dev, cl, "remove list entry belonging to cl\n");
547 mei_io_list_free(&cl->dev->write_list, cl);
548 mei_io_list_free(&cl->dev->write_waiting_list, cl);
549 mei_io_list_flush(&cl->dev->ctrl_wr_list, cl);
550 mei_io_list_flush(&cl->dev->ctrl_rd_list, cl);
551 mei_io_list_flush(&cl->dev->amthif_cmd_list, cl);
553 mei_cl_read_cb_flush(cl, fp);
560 * mei_cl_init - initializes cl.
562 * @cl: host client to be initialized
565 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev)
567 memset(cl, 0, sizeof(struct mei_cl));
568 init_waitqueue_head(&cl->wait);
569 init_waitqueue_head(&cl->rx_wait);
570 init_waitqueue_head(&cl->tx_wait);
571 init_waitqueue_head(&cl->ev_wait);
572 INIT_LIST_HEAD(&cl->rd_completed);
573 INIT_LIST_HEAD(&cl->rd_pending);
574 INIT_LIST_HEAD(&cl->link);
575 cl->writing_state = MEI_IDLE;
576 cl->state = MEI_FILE_INITIALIZING;
581 * mei_cl_allocate - allocates cl structure and sets it up.
584 * Return: The allocated file or NULL on failure
586 struct mei_cl *mei_cl_allocate(struct mei_device *dev)
590 cl = kmalloc(sizeof(struct mei_cl), GFP_KERNEL);
594 mei_cl_init(cl, dev);
600 * mei_cl_link - allocate host id in the host map
604 * Return: 0 on success
605 * -EINVAL on incorrect values
606 * -EMFILE if open count exceeded.
608 int mei_cl_link(struct mei_cl *cl)
610 struct mei_device *dev;
611 long open_handle_count;
614 if (WARN_ON(!cl || !cl->dev))
619 id = find_first_zero_bit(dev->host_clients_map, MEI_CLIENTS_MAX);
620 if (id >= MEI_CLIENTS_MAX) {
621 dev_err(dev->dev, "id exceeded %d", MEI_CLIENTS_MAX);
625 open_handle_count = dev->open_handle_count + dev->iamthif_open_count;
626 if (open_handle_count >= MEI_MAX_OPEN_HANDLE_COUNT) {
627 dev_err(dev->dev, "open_handle_count exceeded %d",
628 MEI_MAX_OPEN_HANDLE_COUNT);
632 dev->open_handle_count++;
634 cl->host_client_id = id;
635 list_add_tail(&cl->link, &dev->file_list);
637 set_bit(id, dev->host_clients_map);
639 cl->state = MEI_FILE_INITIALIZING;
641 cl_dbg(dev, cl, "link cl\n");
646 * mei_cl_unlink - remove host client from the list
652 int mei_cl_unlink(struct mei_cl *cl)
654 struct mei_device *dev;
656 /* don't shout on error exit path */
660 /* amthif might not be initialized */
666 cl_dbg(dev, cl, "unlink client");
668 if (dev->open_handle_count > 0)
669 dev->open_handle_count--;
671 /* never clear the 0 bit */
672 if (cl->host_client_id)
673 clear_bit(cl->host_client_id, dev->host_clients_map);
675 list_del_init(&cl->link);
677 cl->state = MEI_FILE_INITIALIZING;
682 void mei_host_client_init(struct mei_device *dev)
684 dev->dev_state = MEI_DEV_ENABLED;
685 dev->reset_count = 0;
687 schedule_work(&dev->bus_rescan_work);
689 pm_runtime_mark_last_busy(dev->dev);
690 dev_dbg(dev->dev, "rpm: autosuspend\n");
691 pm_request_autosuspend(dev->dev);
695 * mei_hbuf_acquire - try to acquire host buffer
697 * @dev: the device structure
698 * Return: true if host buffer was acquired
700 bool mei_hbuf_acquire(struct mei_device *dev)
702 if (mei_pg_state(dev) == MEI_PG_ON ||
703 mei_pg_in_transition(dev)) {
704 dev_dbg(dev->dev, "device is in pg\n");
708 if (!dev->hbuf_is_ready) {
709 dev_dbg(dev->dev, "hbuf is not ready\n");
713 dev->hbuf_is_ready = false;
719 * mei_cl_wake_all - wake up readers, writers and event waiters so
720 * they can be interrupted
724 static void mei_cl_wake_all(struct mei_cl *cl)
726 struct mei_device *dev = cl->dev;
728 /* synchronized under device mutex */
729 if (waitqueue_active(&cl->rx_wait)) {
730 cl_dbg(dev, cl, "Waking up reading client!\n");
731 wake_up_interruptible(&cl->rx_wait);
733 /* synchronized under device mutex */
734 if (waitqueue_active(&cl->tx_wait)) {
735 cl_dbg(dev, cl, "Waking up writing client!\n");
736 wake_up_interruptible(&cl->tx_wait);
738 /* synchronized under device mutex */
739 if (waitqueue_active(&cl->ev_wait)) {
740 cl_dbg(dev, cl, "Waking up waiting for event clients!\n");
741 wake_up_interruptible(&cl->ev_wait);
743 /* synchronized under device mutex */
744 if (waitqueue_active(&cl->wait)) {
745 cl_dbg(dev, cl, "Waking up ctrl write clients!\n");
751 * mei_cl_set_disconnected - set disconnected state and clear
752 * associated states and resources
756 void mei_cl_set_disconnected(struct mei_cl *cl)
758 struct mei_device *dev = cl->dev;
760 if (cl->state == MEI_FILE_DISCONNECTED ||
761 cl->state == MEI_FILE_INITIALIZING)
764 cl->state = MEI_FILE_DISCONNECTED;
765 mei_io_list_free(&dev->write_list, cl);
766 mei_io_list_free(&dev->write_waiting_list, cl);
767 mei_io_list_flush(&dev->ctrl_rd_list, cl);
768 mei_io_list_flush(&dev->ctrl_wr_list, cl);
770 cl->rx_flow_ctrl_creds = 0;
771 cl->tx_flow_ctrl_creds = 0;
777 if (!WARN_ON(cl->me_cl->connect_count == 0))
778 cl->me_cl->connect_count--;
780 if (cl->me_cl->connect_count == 0)
781 cl->me_cl->tx_flow_ctrl_creds = 0;
783 mei_me_cl_put(cl->me_cl);
787 static int mei_cl_set_connecting(struct mei_cl *cl, struct mei_me_client *me_cl)
789 if (!mei_me_cl_get(me_cl))
792 /* only one connection is allowed for fixed address clients */
793 if (me_cl->props.fixed_address) {
794 if (me_cl->connect_count) {
795 mei_me_cl_put(me_cl);
801 cl->state = MEI_FILE_CONNECTING;
802 cl->me_cl->connect_count++;
808 * mei_cl_send_disconnect - send disconnect request
811 * @cb: callback block
813 * Return: 0, OK; otherwise, error.
815 static int mei_cl_send_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb)
817 struct mei_device *dev;
822 ret = mei_hbm_cl_disconnect_req(dev, cl);
825 cl->state = MEI_FILE_DISCONNECT_REPLY;
829 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
830 cl->timer_count = MEI_CONNECT_TIMEOUT;
831 mei_schedule_stall_timer(dev);
837 * mei_cl_irq_disconnect - processes close related operation from
838 * interrupt thread context - send disconnect request
841 * @cb: callback block.
842 * @cmpl_list: complete list.
844 * Return: 0, OK; otherwise, error.
846 int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
847 struct mei_cl_cb *cmpl_list)
849 struct mei_device *dev = cl->dev;
854 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
855 slots = mei_hbuf_empty_slots(dev);
857 if (slots < msg_slots)
860 ret = mei_cl_send_disconnect(cl, cb);
862 list_move_tail(&cb->list, &cmpl_list->list);
868 * __mei_cl_disconnect - disconnect host client from the me one
869 * internal function runtime pm has to be already acquired
873 * Return: 0 on success, <0 on failure.
875 static int __mei_cl_disconnect(struct mei_cl *cl)
877 struct mei_device *dev;
878 struct mei_cl_cb *cb;
883 cl->state = MEI_FILE_DISCONNECTING;
885 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, MEI_FOP_DISCONNECT, NULL);
891 if (mei_hbuf_acquire(dev)) {
892 rets = mei_cl_send_disconnect(cl, cb);
894 cl_err(dev, cl, "failed to disconnect.\n");
899 mutex_unlock(&dev->device_lock);
900 wait_event_timeout(cl->wait,
901 cl->state == MEI_FILE_DISCONNECT_REPLY ||
902 cl->state == MEI_FILE_DISCONNECTED,
903 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
904 mutex_lock(&dev->device_lock);
907 if (cl->state != MEI_FILE_DISCONNECT_REPLY &&
908 cl->state != MEI_FILE_DISCONNECTED) {
909 cl_dbg(dev, cl, "timeout on disconnect from FW client.\n");
914 /* we disconnect also on error */
915 mei_cl_set_disconnected(cl);
917 cl_dbg(dev, cl, "successfully disconnected from FW client.\n");
924 * mei_cl_disconnect - disconnect host client from the me one
928 * Locking: called under "dev->device_lock" lock
930 * Return: 0 on success, <0 on failure.
932 int mei_cl_disconnect(struct mei_cl *cl)
934 struct mei_device *dev;
937 if (WARN_ON(!cl || !cl->dev))
942 cl_dbg(dev, cl, "disconnecting");
944 if (!mei_cl_is_connected(cl))
947 if (mei_cl_is_fixed_address(cl)) {
948 mei_cl_set_disconnected(cl);
952 rets = pm_runtime_get(dev->dev);
953 if (rets < 0 && rets != -EINPROGRESS) {
954 pm_runtime_put_noidle(dev->dev);
955 cl_err(dev, cl, "rpm: get failed %d\n", rets);
959 rets = __mei_cl_disconnect(cl);
961 cl_dbg(dev, cl, "rpm: autosuspend\n");
962 pm_runtime_mark_last_busy(dev->dev);
963 pm_runtime_put_autosuspend(dev->dev);
970 * mei_cl_is_other_connecting - checks if other
971 * client with the same me client id is connecting
973 * @cl: private data of the file object
975 * Return: true if other client is connected, false - otherwise.
977 static bool mei_cl_is_other_connecting(struct mei_cl *cl)
979 struct mei_device *dev;
980 struct mei_cl_cb *cb;
984 list_for_each_entry(cb, &dev->ctrl_rd_list.list, list) {
985 if (cb->fop_type == MEI_FOP_CONNECT &&
986 mei_cl_me_id(cl) == mei_cl_me_id(cb->cl))
994 * mei_cl_send_connect - send connect request
997 * @cb: callback block
999 * Return: 0, OK; otherwise, error.
1001 static int mei_cl_send_connect(struct mei_cl *cl, struct mei_cl_cb *cb)
1003 struct mei_device *dev;
1008 ret = mei_hbm_cl_connect_req(dev, cl);
1011 cl->state = MEI_FILE_DISCONNECT_REPLY;
1015 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
1016 cl->timer_count = MEI_CONNECT_TIMEOUT;
1017 mei_schedule_stall_timer(dev);
1022 * mei_cl_irq_connect - send connect request in irq_thread context
1025 * @cb: callback block
1026 * @cmpl_list: complete list
1028 * Return: 0, OK; otherwise, error.
1030 int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
1031 struct mei_cl_cb *cmpl_list)
1033 struct mei_device *dev = cl->dev;
1038 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1039 slots = mei_hbuf_empty_slots(dev);
1041 if (mei_cl_is_other_connecting(cl))
1044 if (slots < msg_slots)
1047 rets = mei_cl_send_connect(cl, cb);
1049 list_move_tail(&cb->list, &cmpl_list->list);
1055 * mei_cl_connect - connect host client to the me one
1059 * @fp: pointer to file structure
1061 * Locking: called under "dev->device_lock" lock
1063 * Return: 0 on success, <0 on failure.
1065 int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl,
1066 const struct file *fp)
1068 struct mei_device *dev;
1069 struct mei_cl_cb *cb;
1072 if (WARN_ON(!cl || !cl->dev || !me_cl))
1077 rets = mei_cl_set_connecting(cl, me_cl);
1081 if (mei_cl_is_fixed_address(cl)) {
1082 cl->state = MEI_FILE_CONNECTED;
1086 rets = pm_runtime_get(dev->dev);
1087 if (rets < 0 && rets != -EINPROGRESS) {
1088 pm_runtime_put_noidle(dev->dev);
1089 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1093 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, MEI_FOP_CONNECT, fp);
1099 /* run hbuf acquire last so we don't have to undo */
1100 if (!mei_cl_is_other_connecting(cl) && mei_hbuf_acquire(dev)) {
1101 rets = mei_cl_send_connect(cl, cb);
1106 mutex_unlock(&dev->device_lock);
1107 wait_event_timeout(cl->wait,
1108 (cl->state == MEI_FILE_CONNECTED ||
1109 cl->state == MEI_FILE_DISCONNECTED ||
1110 cl->state == MEI_FILE_DISCONNECT_REQUIRED ||
1111 cl->state == MEI_FILE_DISCONNECT_REPLY),
1112 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1113 mutex_lock(&dev->device_lock);
1115 if (!mei_cl_is_connected(cl)) {
1116 if (cl->state == MEI_FILE_DISCONNECT_REQUIRED) {
1117 mei_io_list_flush(&dev->ctrl_rd_list, cl);
1118 mei_io_list_flush(&dev->ctrl_wr_list, cl);
1119 /* ignore disconnect return valuue;
1120 * in case of failure reset will be invoked
1122 __mei_cl_disconnect(cl);
1127 /* timeout or something went really wrong */
1129 cl->status = -EFAULT;
1134 cl_dbg(dev, cl, "rpm: autosuspend\n");
1135 pm_runtime_mark_last_busy(dev->dev);
1136 pm_runtime_put_autosuspend(dev->dev);
1141 if (!mei_cl_is_connected(cl))
1142 mei_cl_set_disconnected(cl);
1148 * mei_cl_alloc_linked - allocate and link host client
1150 * @dev: the device structure
1152 * Return: cl on success ERR_PTR on failure
1154 struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev)
1159 cl = mei_cl_allocate(dev);
1165 ret = mei_cl_link(cl);
1172 return ERR_PTR(ret);
1176 * mei_cl_tx_flow_ctrl_creds - checks flow_control credits for cl.
1180 * Return: 1 if tx_flow_ctrl_creds >0, 0 - otherwise.
1182 static int mei_cl_tx_flow_ctrl_creds(struct mei_cl *cl)
1184 if (WARN_ON(!cl || !cl->me_cl))
1187 if (cl->tx_flow_ctrl_creds > 0)
1190 if (mei_cl_is_fixed_address(cl))
1193 if (mei_cl_is_single_recv_buf(cl)) {
1194 if (cl->me_cl->tx_flow_ctrl_creds > 0)
1201 * mei_cl_tx_flow_ctrl_creds_reduce - reduces transmit flow control credits
1208 * -EINVAL when ctrl credits are <= 0
1210 static int mei_cl_tx_flow_ctrl_creds_reduce(struct mei_cl *cl)
1212 if (WARN_ON(!cl || !cl->me_cl))
1215 if (mei_cl_is_fixed_address(cl))
1218 if (mei_cl_is_single_recv_buf(cl)) {
1219 if (WARN_ON(cl->me_cl->tx_flow_ctrl_creds <= 0))
1221 cl->me_cl->tx_flow_ctrl_creds--;
1223 if (WARN_ON(cl->tx_flow_ctrl_creds <= 0))
1225 cl->tx_flow_ctrl_creds--;
1231 * mei_cl_notify_fop2req - convert fop to proper request
1233 * @fop: client notification start response command
1235 * Return: MEI_HBM_NOTIFICATION_START/STOP
1237 u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop)
1239 if (fop == MEI_FOP_NOTIFY_START)
1240 return MEI_HBM_NOTIFICATION_START;
1242 return MEI_HBM_NOTIFICATION_STOP;
1246 * mei_cl_notify_req2fop - convert notification request top file operation type
1248 * @req: hbm notification request type
1250 * Return: MEI_FOP_NOTIFY_START/STOP
1252 enum mei_cb_file_ops mei_cl_notify_req2fop(u8 req)
1254 if (req == MEI_HBM_NOTIFICATION_START)
1255 return MEI_FOP_NOTIFY_START;
1257 return MEI_FOP_NOTIFY_STOP;
1261 * mei_cl_irq_notify - send notification request in irq_thread context
1264 * @cb: callback block.
1265 * @cmpl_list: complete list.
1267 * Return: 0 on such and error otherwise.
1269 int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb,
1270 struct mei_cl_cb *cmpl_list)
1272 struct mei_device *dev = cl->dev;
1278 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1279 slots = mei_hbuf_empty_slots(dev);
1281 if (slots < msg_slots)
1284 request = mei_cl_notify_fop2req(cb->fop_type);
1285 ret = mei_hbm_cl_notify_req(dev, cl, request);
1288 list_move_tail(&cb->list, &cmpl_list->list);
1292 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
1297 * mei_cl_notify_request - send notification stop/start request
1300 * @fp: associate request with file
1301 * @request: 1 for start or 0 for stop
1303 * Locking: called under "dev->device_lock" lock
1305 * Return: 0 on such and error otherwise.
1307 int mei_cl_notify_request(struct mei_cl *cl,
1308 const struct file *fp, u8 request)
1310 struct mei_device *dev;
1311 struct mei_cl_cb *cb;
1312 enum mei_cb_file_ops fop_type;
1315 if (WARN_ON(!cl || !cl->dev))
1320 if (!dev->hbm_f_ev_supported) {
1321 cl_dbg(dev, cl, "notifications not supported\n");
1325 if (!mei_cl_is_connected(cl))
1328 rets = pm_runtime_get(dev->dev);
1329 if (rets < 0 && rets != -EINPROGRESS) {
1330 pm_runtime_put_noidle(dev->dev);
1331 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1335 fop_type = mei_cl_notify_req2fop(request);
1336 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, fop_type, fp);
1342 if (mei_hbuf_acquire(dev)) {
1343 if (mei_hbm_cl_notify_req(dev, cl, request)) {
1347 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
1350 mutex_unlock(&dev->device_lock);
1351 wait_event_timeout(cl->wait,
1352 cl->notify_en == request || !mei_cl_is_connected(cl),
1353 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1354 mutex_lock(&dev->device_lock);
1356 if (cl->notify_en != request && !cl->status)
1357 cl->status = -EFAULT;
1362 cl_dbg(dev, cl, "rpm: autosuspend\n");
1363 pm_runtime_mark_last_busy(dev->dev);
1364 pm_runtime_put_autosuspend(dev->dev);
1371 * mei_cl_notify - raise notification
1375 * Locking: called under "dev->device_lock" lock
1377 void mei_cl_notify(struct mei_cl *cl)
1379 struct mei_device *dev;
1381 if (!cl || !cl->dev)
1389 cl_dbg(dev, cl, "notify event");
1390 cl->notify_ev = true;
1391 if (!mei_cl_bus_notify_event(cl))
1392 wake_up_interruptible(&cl->ev_wait);
1395 kill_fasync(&cl->ev_async, SIGIO, POLL_PRI);
1400 * mei_cl_notify_get - get or wait for notification event
1403 * @block: this request is blocking
1404 * @notify_ev: true if notification event was received
1406 * Locking: called under "dev->device_lock" lock
1408 * Return: 0 on such and error otherwise.
1410 int mei_cl_notify_get(struct mei_cl *cl, bool block, bool *notify_ev)
1412 struct mei_device *dev;
1417 if (WARN_ON(!cl || !cl->dev))
1422 if (!mei_cl_is_connected(cl))
1431 mutex_unlock(&dev->device_lock);
1432 rets = wait_event_interruptible(cl->ev_wait, cl->notify_ev);
1433 mutex_lock(&dev->device_lock);
1439 *notify_ev = cl->notify_ev;
1440 cl->notify_ev = false;
1445 * mei_cl_read_start - the start read client message function.
1448 * @length: number of bytes to read
1449 * @fp: pointer to file structure
1451 * Return: 0 on success, <0 on failure.
1453 int mei_cl_read_start(struct mei_cl *cl, size_t length, const struct file *fp)
1455 struct mei_device *dev;
1456 struct mei_cl_cb *cb;
1459 if (WARN_ON(!cl || !cl->dev))
1464 if (!mei_cl_is_connected(cl))
1467 if (!mei_me_cl_is_active(cl->me_cl)) {
1468 cl_err(dev, cl, "no such me client\n");
1472 if (mei_cl_is_fixed_address(cl) || cl == &dev->iamthif_cl)
1475 /* HW currently supports only one pending read */
1476 if (cl->rx_flow_ctrl_creds)
1479 cb = mei_cl_enqueue_ctrl_wr_cb(cl, length, MEI_FOP_READ, fp);
1483 rets = pm_runtime_get(dev->dev);
1484 if (rets < 0 && rets != -EINPROGRESS) {
1485 pm_runtime_put_noidle(dev->dev);
1486 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1491 if (mei_hbuf_acquire(dev)) {
1492 rets = mei_hbm_cl_flow_control_req(dev, cl);
1496 list_move_tail(&cb->list, &cl->rd_pending);
1498 cl->rx_flow_ctrl_creds++;
1501 cl_dbg(dev, cl, "rpm: autosuspend\n");
1502 pm_runtime_mark_last_busy(dev->dev);
1503 pm_runtime_put_autosuspend(dev->dev);
1512 * mei_cl_irq_write - write a message to device
1513 * from the interrupt thread context
1516 * @cb: callback block.
1517 * @cmpl_list: complete list.
1519 * Return: 0, OK; otherwise error.
1521 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
1522 struct mei_cl_cb *cmpl_list)
1524 struct mei_device *dev;
1525 struct mei_msg_data *buf;
1526 struct mei_msg_hdr mei_hdr;
1533 if (WARN_ON(!cl || !cl->dev))
1540 first_chunk = cb->buf_idx == 0;
1542 rets = first_chunk ? mei_cl_tx_flow_ctrl_creds(cl) : 1;
1547 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1551 slots = mei_hbuf_empty_slots(dev);
1552 len = buf->size - cb->buf_idx;
1553 msg_slots = mei_data2slots(len);
1555 mei_hdr.host_addr = mei_cl_host_addr(cl);
1556 mei_hdr.me_addr = mei_cl_me_id(cl);
1557 mei_hdr.reserved = 0;
1558 mei_hdr.internal = cb->internal;
1560 if (slots >= msg_slots) {
1561 mei_hdr.length = len;
1562 mei_hdr.msg_complete = 1;
1563 /* Split the message only if we can write the whole host buffer */
1564 } else if (slots == dev->hbuf_depth) {
1566 len = (slots * sizeof(u32)) - sizeof(struct mei_msg_hdr);
1567 mei_hdr.length = len;
1568 mei_hdr.msg_complete = 0;
1570 /* wait for next time the host buffer is empty */
1574 cl_dbg(dev, cl, "buf: size = %zu idx = %zu\n",
1575 cb->buf.size, cb->buf_idx);
1577 rets = mei_write_message(dev, &mei_hdr, buf->data + cb->buf_idx);
1582 cl->writing_state = MEI_WRITING;
1583 cb->buf_idx += mei_hdr.length;
1584 cb->completed = mei_hdr.msg_complete == 1;
1587 if (mei_cl_tx_flow_ctrl_creds_reduce(cl)) {
1593 if (mei_hdr.msg_complete)
1594 list_move_tail(&cb->list, &dev->write_waiting_list.list);
1600 list_move_tail(&cb->list, &cmpl_list->list);
1605 * mei_cl_write - submit a write cb to mei device
1606 * assumes device_lock is locked
1609 * @cb: write callback with filled data
1610 * @blocking: block until completed
1612 * Return: number of bytes sent on success, <0 on failure.
1614 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking)
1616 struct mei_device *dev;
1617 struct mei_msg_data *buf;
1618 struct mei_msg_hdr mei_hdr;
1623 if (WARN_ON(!cl || !cl->dev))
1634 cl_dbg(dev, cl, "size=%d\n", size);
1636 rets = pm_runtime_get(dev->dev);
1637 if (rets < 0 && rets != -EINPROGRESS) {
1638 pm_runtime_put_noidle(dev->dev);
1639 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1644 cl->writing_state = MEI_IDLE;
1646 mei_hdr.host_addr = mei_cl_host_addr(cl);
1647 mei_hdr.me_addr = mei_cl_me_id(cl);
1648 mei_hdr.reserved = 0;
1649 mei_hdr.msg_complete = 0;
1650 mei_hdr.internal = cb->internal;
1652 rets = mei_cl_tx_flow_ctrl_creds(cl);
1657 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1661 if (!mei_hbuf_acquire(dev)) {
1662 cl_dbg(dev, cl, "Cannot acquire the host buffer: not sending.\n");
1667 /* Check for a maximum length */
1668 if (size > mei_hbuf_max_len(dev)) {
1669 mei_hdr.length = mei_hbuf_max_len(dev);
1670 mei_hdr.msg_complete = 0;
1672 mei_hdr.length = size;
1673 mei_hdr.msg_complete = 1;
1676 rets = mei_write_message(dev, &mei_hdr, buf->data);
1680 rets = mei_cl_tx_flow_ctrl_creds_reduce(cl);
1684 cl->writing_state = MEI_WRITING;
1685 cb->buf_idx = mei_hdr.length;
1686 cb->completed = mei_hdr.msg_complete == 1;
1689 if (mei_hdr.msg_complete)
1690 list_add_tail(&cb->list, &dev->write_waiting_list.list);
1692 list_add_tail(&cb->list, &dev->write_list.list);
1695 if (blocking && cl->writing_state != MEI_WRITE_COMPLETE) {
1697 mutex_unlock(&dev->device_lock);
1698 rets = wait_event_interruptible(cl->tx_wait,
1699 cl->writing_state == MEI_WRITE_COMPLETE ||
1700 (!mei_cl_is_connected(cl)));
1701 mutex_lock(&dev->device_lock);
1702 /* wait_event_interruptible returns -ERESTARTSYS */
1704 if (signal_pending(current))
1708 if (cl->writing_state != MEI_WRITE_COMPLETE) {
1716 cl_dbg(dev, cl, "rpm: autosuspend\n");
1717 pm_runtime_mark_last_busy(dev->dev);
1718 pm_runtime_put_autosuspend(dev->dev);
1727 * mei_cl_complete - processes completed operation for a client
1729 * @cl: private data of the file object.
1730 * @cb: callback block.
1732 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb)
1734 struct mei_device *dev = cl->dev;
1736 switch (cb->fop_type) {
1739 cl->writing_state = MEI_WRITE_COMPLETE;
1740 if (waitqueue_active(&cl->tx_wait)) {
1741 wake_up_interruptible(&cl->tx_wait);
1743 pm_runtime_mark_last_busy(dev->dev);
1744 pm_request_autosuspend(dev->dev);
1749 list_add_tail(&cb->list, &cl->rd_completed);
1750 if (!mei_cl_is_fixed_address(cl) &&
1751 !WARN_ON(!cl->rx_flow_ctrl_creds))
1752 cl->rx_flow_ctrl_creds--;
1753 if (!mei_cl_bus_rx_event(cl))
1754 wake_up_interruptible(&cl->rx_wait);
1757 case MEI_FOP_CONNECT:
1758 case MEI_FOP_DISCONNECT:
1759 case MEI_FOP_NOTIFY_STOP:
1760 case MEI_FOP_NOTIFY_START:
1761 if (waitqueue_active(&cl->wait))
1765 case MEI_FOP_DISCONNECT_RSP:
1767 mei_cl_set_disconnected(cl);
1776 * mei_cl_all_disconnect - disconnect forcefully all connected clients
1780 void mei_cl_all_disconnect(struct mei_device *dev)
1784 list_for_each_entry(cl, &dev->file_list, link)
1785 mei_cl_set_disconnected(cl);