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 struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, enum mei_cb_file_ops type,
366 struct mei_cl_cb *cb;
368 cb = kzalloc(sizeof(struct mei_cl_cb), GFP_KERNEL);
372 INIT_LIST_HEAD(&cb->list);
373 cb->file_object = fp;
381 * __mei_io_list_flush - removes and frees cbs belonging to cl.
383 * @list: an instance of our list structure
384 * @cl: host client, can be NULL for flushing the whole list
385 * @free: whether to free the cbs
387 static void __mei_io_list_flush(struct mei_cl_cb *list,
388 struct mei_cl *cl, bool free)
390 struct mei_cl_cb *cb, *next;
392 /* enable removing everything if no cl is specified */
393 list_for_each_entry_safe(cb, next, &list->list, list) {
394 if (!cl || mei_cl_cmp_id(cl, cb->cl)) {
395 list_del_init(&cb->list);
403 * mei_io_list_flush - removes list entry belonging to cl.
405 * @list: An instance of our list structure
408 void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl)
410 __mei_io_list_flush(list, cl, false);
414 * mei_io_list_free - removes cb belonging to cl and free them
416 * @list: An instance of our list structure
419 static inline void mei_io_list_free(struct mei_cl_cb *list, struct mei_cl *cl)
421 __mei_io_list_flush(list, cl, true);
425 * mei_io_cb_alloc_buf - allocate callback buffer
427 * @cb: io callback structure
428 * @length: size of the buffer
430 * Return: 0 on success
431 * -EINVAL if cb is NULL
432 * -ENOMEM if allocation failed
434 int mei_io_cb_alloc_buf(struct mei_cl_cb *cb, size_t length)
442 cb->buf.data = kmalloc(length, GFP_KERNEL);
445 cb->buf.size = length;
450 * mei_cl_alloc_cb - a convenient wrapper for allocating read cb
453 * @length: size of the buffer
454 * @type: operation type
455 * @fp: associated file pointer (might be NULL)
457 * Return: cb on success and NULL on failure
459 struct mei_cl_cb *mei_cl_alloc_cb(struct mei_cl *cl, size_t length,
460 enum mei_cb_file_ops type, struct file *fp)
462 struct mei_cl_cb *cb;
464 cb = mei_io_cb_init(cl, type, fp);
468 if (mei_io_cb_alloc_buf(cb, length)) {
477 * mei_cl_read_cb - find this cl's callback in the read list
478 * for a specific file
481 * @fp: file pointer (matching cb file object), may be NULL
483 * Return: cb on success, NULL if cb is not found
485 struct mei_cl_cb *mei_cl_read_cb(const struct mei_cl *cl, const struct file *fp)
487 struct mei_cl_cb *cb;
489 list_for_each_entry(cb, &cl->rd_completed, list)
490 if (!fp || fp == cb->file_object)
497 * mei_cl_read_cb_flush - free client's read pending and completed cbs
498 * for a specific file
501 * @fp: file pointer (matching cb file object), may be NULL
503 void mei_cl_read_cb_flush(const struct mei_cl *cl, const struct file *fp)
505 struct mei_cl_cb *cb, *next;
507 list_for_each_entry_safe(cb, next, &cl->rd_completed, list)
508 if (!fp || fp == cb->file_object)
512 list_for_each_entry_safe(cb, next, &cl->rd_pending, list)
513 if (!fp || fp == cb->file_object)
518 * mei_cl_flush_queues - flushes queue lists belonging to cl.
521 * @fp: file pointer (matching cb file object), may be NULL
523 * Return: 0 on success, -EINVAL if cl or cl->dev is NULL.
525 int mei_cl_flush_queues(struct mei_cl *cl, const struct file *fp)
527 struct mei_device *dev;
529 if (WARN_ON(!cl || !cl->dev))
534 cl_dbg(dev, cl, "remove list entry belonging to cl\n");
535 mei_io_list_free(&cl->dev->write_list, cl);
536 mei_io_list_free(&cl->dev->write_waiting_list, cl);
537 mei_io_list_flush(&cl->dev->ctrl_wr_list, cl);
538 mei_io_list_flush(&cl->dev->ctrl_rd_list, cl);
539 mei_io_list_flush(&cl->dev->amthif_cmd_list, cl);
540 mei_io_list_flush(&cl->dev->amthif_rd_complete_list, cl);
542 mei_cl_read_cb_flush(cl, fp);
549 * mei_cl_init - initializes cl.
551 * @cl: host client to be initialized
554 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev)
556 memset(cl, 0, sizeof(struct mei_cl));
557 init_waitqueue_head(&cl->wait);
558 init_waitqueue_head(&cl->rx_wait);
559 init_waitqueue_head(&cl->tx_wait);
560 init_waitqueue_head(&cl->ev_wait);
561 INIT_LIST_HEAD(&cl->rd_completed);
562 INIT_LIST_HEAD(&cl->rd_pending);
563 INIT_LIST_HEAD(&cl->link);
564 cl->writing_state = MEI_IDLE;
565 cl->state = MEI_FILE_INITIALIZING;
570 * mei_cl_allocate - allocates cl structure and sets it up.
573 * Return: The allocated file or NULL on failure
575 struct mei_cl *mei_cl_allocate(struct mei_device *dev)
579 cl = kmalloc(sizeof(struct mei_cl), GFP_KERNEL);
583 mei_cl_init(cl, dev);
589 * mei_cl_link - allocate host id in the host map
592 * @id: fixed host id or MEI_HOST_CLIENT_ID_ANY (-1) for generic one
594 * Return: 0 on success
595 * -EINVAL on incorrect values
596 * -EMFILE if open count exceeded.
598 int mei_cl_link(struct mei_cl *cl, int id)
600 struct mei_device *dev;
601 long open_handle_count;
603 if (WARN_ON(!cl || !cl->dev))
608 /* If Id is not assigned get one*/
609 if (id == MEI_HOST_CLIENT_ID_ANY)
610 id = find_first_zero_bit(dev->host_clients_map,
613 if (id >= MEI_CLIENTS_MAX) {
614 dev_err(dev->dev, "id exceeded %d", MEI_CLIENTS_MAX);
618 open_handle_count = dev->open_handle_count + dev->iamthif_open_count;
619 if (open_handle_count >= MEI_MAX_OPEN_HANDLE_COUNT) {
620 dev_err(dev->dev, "open_handle_count exceeded %d",
621 MEI_MAX_OPEN_HANDLE_COUNT);
625 dev->open_handle_count++;
627 cl->host_client_id = id;
628 list_add_tail(&cl->link, &dev->file_list);
630 set_bit(id, dev->host_clients_map);
632 cl->state = MEI_FILE_INITIALIZING;
634 cl_dbg(dev, cl, "link cl\n");
639 * mei_cl_unlink - remove host client from the list
645 int mei_cl_unlink(struct mei_cl *cl)
647 struct mei_device *dev;
649 /* don't shout on error exit path */
653 /* wd and amthif might not be initialized */
659 cl_dbg(dev, cl, "unlink client");
661 if (dev->open_handle_count > 0)
662 dev->open_handle_count--;
664 /* never clear the 0 bit */
665 if (cl->host_client_id)
666 clear_bit(cl->host_client_id, dev->host_clients_map);
668 list_del_init(&cl->link);
670 cl->state = MEI_FILE_INITIALIZING;
676 void mei_host_client_init(struct work_struct *work)
678 struct mei_device *dev =
679 container_of(work, struct mei_device, init_work);
680 struct mei_me_client *me_cl;
682 mutex_lock(&dev->device_lock);
685 me_cl = mei_me_cl_by_uuid(dev, &mei_amthif_guid);
687 mei_amthif_host_init(dev, me_cl);
688 mei_me_cl_put(me_cl);
690 me_cl = mei_me_cl_by_uuid(dev, &mei_wd_guid);
692 mei_wd_host_init(dev, me_cl);
693 mei_me_cl_put(me_cl);
695 dev->dev_state = MEI_DEV_ENABLED;
696 dev->reset_count = 0;
697 mutex_unlock(&dev->device_lock);
699 mei_cl_bus_rescan(dev);
701 pm_runtime_mark_last_busy(dev->dev);
702 dev_dbg(dev->dev, "rpm: autosuspend\n");
703 pm_request_autosuspend(dev->dev);
707 * mei_hbuf_acquire - try to acquire host buffer
709 * @dev: the device structure
710 * Return: true if host buffer was acquired
712 bool mei_hbuf_acquire(struct mei_device *dev)
714 if (mei_pg_state(dev) == MEI_PG_ON ||
715 mei_pg_in_transition(dev)) {
716 dev_dbg(dev->dev, "device is in pg\n");
720 if (!dev->hbuf_is_ready) {
721 dev_dbg(dev->dev, "hbuf is not ready\n");
725 dev->hbuf_is_ready = false;
731 * mei_cl_set_disconnected - set disconnected state and clear
732 * associated states and resources
736 void mei_cl_set_disconnected(struct mei_cl *cl)
738 struct mei_device *dev = cl->dev;
740 if (cl->state == MEI_FILE_DISCONNECTED ||
741 cl->state == MEI_FILE_INITIALIZING)
744 cl->state = MEI_FILE_DISCONNECTED;
745 mei_io_list_flush(&dev->ctrl_rd_list, cl);
746 mei_io_list_flush(&dev->ctrl_wr_list, cl);
747 cl->mei_flow_ctrl_creds = 0;
753 if (!WARN_ON(cl->me_cl->connect_count == 0))
754 cl->me_cl->connect_count--;
756 if (cl->me_cl->connect_count == 0)
757 cl->me_cl->mei_flow_ctrl_creds = 0;
759 mei_me_cl_put(cl->me_cl);
763 static int mei_cl_set_connecting(struct mei_cl *cl, struct mei_me_client *me_cl)
765 if (!mei_me_cl_get(me_cl))
768 /* only one connection is allowed for fixed address clients */
769 if (me_cl->props.fixed_address) {
770 if (me_cl->connect_count) {
771 mei_me_cl_put(me_cl);
777 cl->state = MEI_FILE_CONNECTING;
778 cl->me_cl->connect_count++;
784 * mei_cl_send_disconnect - send disconnect request
787 * @cb: callback block
789 * Return: 0, OK; otherwise, error.
791 static int mei_cl_send_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb)
793 struct mei_device *dev;
798 ret = mei_hbm_cl_disconnect_req(dev, cl);
801 cl->state = MEI_FILE_DISCONNECT_REPLY;
805 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
806 cl->timer_count = MEI_CONNECT_TIMEOUT;
812 * mei_cl_irq_disconnect - processes close related operation from
813 * interrupt thread context - send disconnect request
816 * @cb: callback block.
817 * @cmpl_list: complete list.
819 * Return: 0, OK; otherwise, error.
821 int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
822 struct mei_cl_cb *cmpl_list)
824 struct mei_device *dev = cl->dev;
829 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
830 slots = mei_hbuf_empty_slots(dev);
832 if (slots < msg_slots)
835 ret = mei_cl_send_disconnect(cl, cb);
837 list_move_tail(&cb->list, &cmpl_list->list);
843 * __mei_cl_disconnect - disconnect host client from the me one
844 * internal function runtime pm has to be already acquired
848 * Return: 0 on success, <0 on failure.
850 static int __mei_cl_disconnect(struct mei_cl *cl)
852 struct mei_device *dev;
853 struct mei_cl_cb *cb;
858 cl->state = MEI_FILE_DISCONNECTING;
860 cb = mei_io_cb_init(cl, MEI_FOP_DISCONNECT, NULL);
861 rets = cb ? 0 : -ENOMEM;
865 cl_dbg(dev, cl, "add disconnect cb to control write list\n");
866 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
868 if (mei_hbuf_acquire(dev)) {
869 rets = mei_cl_send_disconnect(cl, cb);
871 cl_err(dev, cl, "failed to disconnect.\n");
876 mutex_unlock(&dev->device_lock);
877 wait_event_timeout(cl->wait, cl->state == MEI_FILE_DISCONNECT_REPLY,
878 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
879 mutex_lock(&dev->device_lock);
882 if (cl->state != MEI_FILE_DISCONNECT_REPLY) {
883 cl_dbg(dev, cl, "timeout on disconnect from FW client.\n");
888 /* we disconnect also on error */
889 mei_cl_set_disconnected(cl);
891 cl_dbg(dev, cl, "successfully disconnected from FW client.\n");
898 * mei_cl_disconnect - disconnect host client from the me one
902 * Locking: called under "dev->device_lock" lock
904 * Return: 0 on success, <0 on failure.
906 int mei_cl_disconnect(struct mei_cl *cl)
908 struct mei_device *dev;
911 if (WARN_ON(!cl || !cl->dev))
916 cl_dbg(dev, cl, "disconnecting");
918 if (!mei_cl_is_connected(cl))
921 if (mei_cl_is_fixed_address(cl)) {
922 mei_cl_set_disconnected(cl);
926 rets = pm_runtime_get(dev->dev);
927 if (rets < 0 && rets != -EINPROGRESS) {
928 pm_runtime_put_noidle(dev->dev);
929 cl_err(dev, cl, "rpm: get failed %d\n", rets);
933 rets = __mei_cl_disconnect(cl);
935 cl_dbg(dev, cl, "rpm: autosuspend\n");
936 pm_runtime_mark_last_busy(dev->dev);
937 pm_runtime_put_autosuspend(dev->dev);
944 * mei_cl_is_other_connecting - checks if other
945 * client with the same me client id is connecting
947 * @cl: private data of the file object
949 * Return: true if other client is connected, false - otherwise.
951 static bool mei_cl_is_other_connecting(struct mei_cl *cl)
953 struct mei_device *dev;
954 struct mei_cl_cb *cb;
958 list_for_each_entry(cb, &dev->ctrl_rd_list.list, list) {
959 if (cb->fop_type == MEI_FOP_CONNECT &&
960 mei_cl_me_id(cl) == mei_cl_me_id(cb->cl))
968 * mei_cl_send_connect - send connect request
971 * @cb: callback block
973 * Return: 0, OK; otherwise, error.
975 static int mei_cl_send_connect(struct mei_cl *cl, struct mei_cl_cb *cb)
977 struct mei_device *dev;
982 ret = mei_hbm_cl_connect_req(dev, cl);
985 cl->state = MEI_FILE_DISCONNECT_REPLY;
989 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
990 cl->timer_count = MEI_CONNECT_TIMEOUT;
995 * mei_cl_irq_connect - send connect request in irq_thread context
998 * @cb: callback block
999 * @cmpl_list: complete list
1001 * Return: 0, OK; otherwise, error.
1003 int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
1004 struct mei_cl_cb *cmpl_list)
1006 struct mei_device *dev = cl->dev;
1011 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1012 slots = mei_hbuf_empty_slots(dev);
1014 if (mei_cl_is_other_connecting(cl))
1017 if (slots < msg_slots)
1020 rets = mei_cl_send_connect(cl, cb);
1022 list_move_tail(&cb->list, &cmpl_list->list);
1028 * mei_cl_connect - connect host client to the me one
1032 * @file: pointer to file structure
1034 * Locking: called under "dev->device_lock" lock
1036 * Return: 0 on success, <0 on failure.
1038 int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl,
1041 struct mei_device *dev;
1042 struct mei_cl_cb *cb;
1045 if (WARN_ON(!cl || !cl->dev || !me_cl))
1050 rets = mei_cl_set_connecting(cl, me_cl);
1054 if (mei_cl_is_fixed_address(cl)) {
1055 cl->state = MEI_FILE_CONNECTED;
1059 rets = pm_runtime_get(dev->dev);
1060 if (rets < 0 && rets != -EINPROGRESS) {
1061 pm_runtime_put_noidle(dev->dev);
1062 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1066 cb = mei_io_cb_init(cl, MEI_FOP_CONNECT, file);
1067 rets = cb ? 0 : -ENOMEM;
1071 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
1073 /* run hbuf acquire last so we don't have to undo */
1074 if (!mei_cl_is_other_connecting(cl) && mei_hbuf_acquire(dev)) {
1075 rets = mei_cl_send_connect(cl, cb);
1080 mutex_unlock(&dev->device_lock);
1081 wait_event_timeout(cl->wait,
1082 (cl->state == MEI_FILE_CONNECTED ||
1083 cl->state == MEI_FILE_DISCONNECT_REQUIRED ||
1084 cl->state == MEI_FILE_DISCONNECT_REPLY),
1085 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1086 mutex_lock(&dev->device_lock);
1088 if (!mei_cl_is_connected(cl)) {
1089 if (cl->state == MEI_FILE_DISCONNECT_REQUIRED) {
1090 mei_io_list_flush(&dev->ctrl_rd_list, cl);
1091 mei_io_list_flush(&dev->ctrl_wr_list, cl);
1092 /* ignore disconnect return valuue;
1093 * in case of failure reset will be invoked
1095 __mei_cl_disconnect(cl);
1100 /* timeout or something went really wrong */
1102 cl->status = -EFAULT;
1107 cl_dbg(dev, cl, "rpm: autosuspend\n");
1108 pm_runtime_mark_last_busy(dev->dev);
1109 pm_runtime_put_autosuspend(dev->dev);
1114 if (!mei_cl_is_connected(cl))
1115 mei_cl_set_disconnected(cl);
1121 * mei_cl_alloc_linked - allocate and link host client
1123 * @dev: the device structure
1124 * @id: fixed host id or MEI_HOST_CLIENT_ID_ANY (-1) for generic one
1126 * Return: cl on success ERR_PTR on failure
1128 struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev, int id)
1133 cl = mei_cl_allocate(dev);
1139 ret = mei_cl_link(cl, id);
1146 return ERR_PTR(ret);
1152 * mei_cl_flow_ctrl_creds - checks flow_control credits for cl.
1154 * @cl: private data of the file object
1156 * Return: 1 if mei_flow_ctrl_creds >0, 0 - otherwise.
1158 int mei_cl_flow_ctrl_creds(struct mei_cl *cl)
1162 if (WARN_ON(!cl || !cl->me_cl))
1165 if (cl->mei_flow_ctrl_creds > 0)
1168 if (mei_cl_is_fixed_address(cl)) {
1169 rets = mei_cl_read_start(cl, mei_cl_mtu(cl), NULL);
1170 if (rets && rets != -EBUSY)
1175 if (mei_cl_is_single_recv_buf(cl)) {
1176 if (cl->me_cl->mei_flow_ctrl_creds > 0)
1183 * mei_cl_flow_ctrl_reduce - reduces flow_control.
1185 * @cl: private data of the file object
1189 * -EINVAL when ctrl credits are <= 0
1191 int mei_cl_flow_ctrl_reduce(struct mei_cl *cl)
1193 if (WARN_ON(!cl || !cl->me_cl))
1196 if (mei_cl_is_fixed_address(cl))
1199 if (mei_cl_is_single_recv_buf(cl)) {
1200 if (WARN_ON(cl->me_cl->mei_flow_ctrl_creds <= 0))
1202 cl->me_cl->mei_flow_ctrl_creds--;
1204 if (WARN_ON(cl->mei_flow_ctrl_creds <= 0))
1206 cl->mei_flow_ctrl_creds--;
1212 * mei_cl_notify_fop2req - convert fop to proper request
1214 * @fop: client notification start response command
1216 * Return: MEI_HBM_NOTIFICATION_START/STOP
1218 u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop)
1220 if (fop == MEI_FOP_NOTIFY_START)
1221 return MEI_HBM_NOTIFICATION_START;
1223 return MEI_HBM_NOTIFICATION_STOP;
1227 * mei_cl_notify_req2fop - convert notification request top file operation type
1229 * @req: hbm notification request type
1231 * Return: MEI_FOP_NOTIFY_START/STOP
1233 enum mei_cb_file_ops mei_cl_notify_req2fop(u8 req)
1235 if (req == MEI_HBM_NOTIFICATION_START)
1236 return MEI_FOP_NOTIFY_START;
1238 return MEI_FOP_NOTIFY_STOP;
1242 * mei_cl_irq_notify - send notification request in irq_thread context
1245 * @cb: callback block.
1246 * @cmpl_list: complete list.
1248 * Return: 0 on such and error otherwise.
1250 int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb,
1251 struct mei_cl_cb *cmpl_list)
1253 struct mei_device *dev = cl->dev;
1259 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1260 slots = mei_hbuf_empty_slots(dev);
1262 if (slots < msg_slots)
1265 request = mei_cl_notify_fop2req(cb->fop_type);
1266 ret = mei_hbm_cl_notify_req(dev, cl, request);
1269 list_move_tail(&cb->list, &cmpl_list->list);
1273 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
1278 * mei_cl_notify_request - send notification stop/start request
1281 * @file: associate request with file
1282 * @request: 1 for start or 0 for stop
1284 * Locking: called under "dev->device_lock" lock
1286 * Return: 0 on such and error otherwise.
1288 int mei_cl_notify_request(struct mei_cl *cl, struct file *file, u8 request)
1290 struct mei_device *dev;
1291 struct mei_cl_cb *cb;
1292 enum mei_cb_file_ops fop_type;
1295 if (WARN_ON(!cl || !cl->dev))
1300 if (!dev->hbm_f_ev_supported) {
1301 cl_dbg(dev, cl, "notifications not supported\n");
1305 if (!mei_cl_is_connected(cl))
1308 rets = pm_runtime_get(dev->dev);
1309 if (rets < 0 && rets != -EINPROGRESS) {
1310 pm_runtime_put_noidle(dev->dev);
1311 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1315 fop_type = mei_cl_notify_req2fop(request);
1316 cb = mei_io_cb_init(cl, fop_type, file);
1322 if (mei_hbuf_acquire(dev)) {
1323 if (mei_hbm_cl_notify_req(dev, cl, request)) {
1327 list_add_tail(&cb->list, &dev->ctrl_rd_list.list);
1329 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
1332 mutex_unlock(&dev->device_lock);
1333 wait_event_timeout(cl->wait, cl->notify_en == request,
1334 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1335 mutex_lock(&dev->device_lock);
1337 if (cl->notify_en != request) {
1338 mei_io_list_flush(&dev->ctrl_rd_list, cl);
1339 mei_io_list_flush(&dev->ctrl_wr_list, cl);
1341 cl->status = -EFAULT;
1347 cl_dbg(dev, cl, "rpm: autosuspend\n");
1348 pm_runtime_mark_last_busy(dev->dev);
1349 pm_runtime_put_autosuspend(dev->dev);
1356 * mei_cl_notify - raise notification
1360 * Locking: called under "dev->device_lock" lock
1362 void mei_cl_notify(struct mei_cl *cl)
1364 struct mei_device *dev;
1366 if (!cl || !cl->dev)
1374 cl_dbg(dev, cl, "notify event");
1375 cl->notify_ev = true;
1376 wake_up_interruptible_all(&cl->ev_wait);
1379 kill_fasync(&cl->ev_async, SIGIO, POLL_PRI);
1381 mei_cl_bus_notify_event(cl);
1385 * mei_cl_notify_get - get or wait for notification event
1388 * @block: this request is blocking
1389 * @notify_ev: true if notification event was received
1391 * Locking: called under "dev->device_lock" lock
1393 * Return: 0 on such and error otherwise.
1395 int mei_cl_notify_get(struct mei_cl *cl, bool block, bool *notify_ev)
1397 struct mei_device *dev;
1402 if (WARN_ON(!cl || !cl->dev))
1407 if (!mei_cl_is_connected(cl))
1416 mutex_unlock(&dev->device_lock);
1417 rets = wait_event_interruptible(cl->ev_wait, cl->notify_ev);
1418 mutex_lock(&dev->device_lock);
1424 *notify_ev = cl->notify_ev;
1425 cl->notify_ev = false;
1430 * mei_cl_read_start - the start read client message function.
1433 * @length: number of bytes to read
1434 * @fp: pointer to file structure
1436 * Return: 0 on success, <0 on failure.
1438 int mei_cl_read_start(struct mei_cl *cl, size_t length, struct file *fp)
1440 struct mei_device *dev;
1441 struct mei_cl_cb *cb;
1444 if (WARN_ON(!cl || !cl->dev))
1449 if (!mei_cl_is_connected(cl))
1452 /* HW currently supports only one pending read */
1453 if (!list_empty(&cl->rd_pending))
1456 if (!mei_me_cl_is_active(cl->me_cl)) {
1457 cl_err(dev, cl, "no such me client\n");
1461 /* always allocate at least client max message */
1462 length = max_t(size_t, length, mei_cl_mtu(cl));
1463 cb = mei_cl_alloc_cb(cl, length, MEI_FOP_READ, fp);
1467 if (mei_cl_is_fixed_address(cl)) {
1468 list_add_tail(&cb->list, &cl->rd_pending);
1472 rets = pm_runtime_get(dev->dev);
1473 if (rets < 0 && rets != -EINPROGRESS) {
1474 pm_runtime_put_noidle(dev->dev);
1475 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1479 if (mei_hbuf_acquire(dev)) {
1480 rets = mei_hbm_cl_flow_control_req(dev, cl);
1484 list_add_tail(&cb->list, &cl->rd_pending);
1487 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
1491 cl_dbg(dev, cl, "rpm: autosuspend\n");
1492 pm_runtime_mark_last_busy(dev->dev);
1493 pm_runtime_put_autosuspend(dev->dev);
1502 * mei_cl_irq_write - write a message to device
1503 * from the interrupt thread context
1506 * @cb: callback block.
1507 * @cmpl_list: complete list.
1509 * Return: 0, OK; otherwise error.
1511 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
1512 struct mei_cl_cb *cmpl_list)
1514 struct mei_device *dev;
1515 struct mei_msg_data *buf;
1516 struct mei_msg_hdr mei_hdr;
1523 if (WARN_ON(!cl || !cl->dev))
1530 first_chunk = cb->buf_idx == 0;
1532 rets = first_chunk ? mei_cl_flow_ctrl_creds(cl) : 1;
1537 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1541 slots = mei_hbuf_empty_slots(dev);
1542 len = buf->size - cb->buf_idx;
1543 msg_slots = mei_data2slots(len);
1545 mei_hdr.host_addr = mei_cl_host_addr(cl);
1546 mei_hdr.me_addr = mei_cl_me_id(cl);
1547 mei_hdr.reserved = 0;
1548 mei_hdr.internal = cb->internal;
1550 if (slots >= msg_slots) {
1551 mei_hdr.length = len;
1552 mei_hdr.msg_complete = 1;
1553 /* Split the message only if we can write the whole host buffer */
1554 } else if (slots == dev->hbuf_depth) {
1556 len = (slots * sizeof(u32)) - sizeof(struct mei_msg_hdr);
1557 mei_hdr.length = len;
1558 mei_hdr.msg_complete = 0;
1560 /* wait for next time the host buffer is empty */
1564 cl_dbg(dev, cl, "buf: size = %d idx = %lu\n",
1565 cb->buf.size, cb->buf_idx);
1567 rets = mei_write_message(dev, &mei_hdr, buf->data + cb->buf_idx);
1570 list_move_tail(&cb->list, &cmpl_list->list);
1575 cl->writing_state = MEI_WRITING;
1576 cb->buf_idx += mei_hdr.length;
1577 cb->completed = mei_hdr.msg_complete == 1;
1580 if (mei_cl_flow_ctrl_reduce(cl))
1584 if (mei_hdr.msg_complete)
1585 list_move_tail(&cb->list, &dev->write_waiting_list.list);
1591 * mei_cl_write - submit a write cb to mei device
1592 * assumes device_lock is locked
1595 * @cb: write callback with filled data
1596 * @blocking: block until completed
1598 * Return: number of bytes sent on success, <0 on failure.
1600 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking)
1602 struct mei_device *dev;
1603 struct mei_msg_data *buf;
1604 struct mei_msg_hdr mei_hdr;
1609 if (WARN_ON(!cl || !cl->dev))
1620 cl_dbg(dev, cl, "size=%d\n", size);
1622 rets = pm_runtime_get(dev->dev);
1623 if (rets < 0 && rets != -EINPROGRESS) {
1624 pm_runtime_put_noidle(dev->dev);
1625 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1630 cl->writing_state = MEI_IDLE;
1632 mei_hdr.host_addr = mei_cl_host_addr(cl);
1633 mei_hdr.me_addr = mei_cl_me_id(cl);
1634 mei_hdr.reserved = 0;
1635 mei_hdr.msg_complete = 0;
1636 mei_hdr.internal = cb->internal;
1638 rets = mei_cl_flow_ctrl_creds(cl);
1643 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1647 if (!mei_hbuf_acquire(dev)) {
1648 cl_dbg(dev, cl, "Cannot acquire the host buffer: not sending.\n");
1653 /* Check for a maximum length */
1654 if (size > mei_hbuf_max_len(dev)) {
1655 mei_hdr.length = mei_hbuf_max_len(dev);
1656 mei_hdr.msg_complete = 0;
1658 mei_hdr.length = size;
1659 mei_hdr.msg_complete = 1;
1662 rets = mei_write_message(dev, &mei_hdr, buf->data);
1666 rets = mei_cl_flow_ctrl_reduce(cl);
1670 cl->writing_state = MEI_WRITING;
1671 cb->buf_idx = mei_hdr.length;
1672 cb->completed = mei_hdr.msg_complete == 1;
1675 if (mei_hdr.msg_complete)
1676 list_add_tail(&cb->list, &dev->write_waiting_list.list);
1678 list_add_tail(&cb->list, &dev->write_list.list);
1681 if (blocking && cl->writing_state != MEI_WRITE_COMPLETE) {
1683 mutex_unlock(&dev->device_lock);
1684 rets = wait_event_interruptible(cl->tx_wait,
1685 cl->writing_state == MEI_WRITE_COMPLETE);
1686 mutex_lock(&dev->device_lock);
1687 /* wait_event_interruptible returns -ERESTARTSYS */
1689 if (signal_pending(current))
1697 cl_dbg(dev, cl, "rpm: autosuspend\n");
1698 pm_runtime_mark_last_busy(dev->dev);
1699 pm_runtime_put_autosuspend(dev->dev);
1706 * mei_cl_complete - processes completed operation for a client
1708 * @cl: private data of the file object.
1709 * @cb: callback block.
1711 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb)
1713 struct mei_device *dev = cl->dev;
1715 switch (cb->fop_type) {
1718 cl->writing_state = MEI_WRITE_COMPLETE;
1719 if (waitqueue_active(&cl->tx_wait)) {
1720 wake_up_interruptible(&cl->tx_wait);
1722 pm_runtime_mark_last_busy(dev->dev);
1723 pm_request_autosuspend(dev->dev);
1728 list_add_tail(&cb->list, &cl->rd_completed);
1729 if (waitqueue_active(&cl->rx_wait))
1730 wake_up_interruptible_all(&cl->rx_wait);
1732 mei_cl_bus_rx_event(cl);
1735 case MEI_FOP_CONNECT:
1736 case MEI_FOP_DISCONNECT:
1737 case MEI_FOP_NOTIFY_STOP:
1738 case MEI_FOP_NOTIFY_START:
1739 if (waitqueue_active(&cl->wait))
1743 case MEI_FOP_DISCONNECT_RSP:
1745 mei_cl_set_disconnected(cl);
1754 * mei_cl_all_disconnect - disconnect forcefully all connected clients
1758 void mei_cl_all_disconnect(struct mei_device *dev)
1762 list_for_each_entry(cl, &dev->file_list, link)
1763 mei_cl_set_disconnected(cl);
1768 * mei_cl_all_wakeup - wake up all readers and writers they can be interrupted
1772 void mei_cl_all_wakeup(struct mei_device *dev)
1776 list_for_each_entry(cl, &dev->file_list, link) {
1777 if (waitqueue_active(&cl->rx_wait)) {
1778 cl_dbg(dev, cl, "Waking up reading client!\n");
1779 wake_up_interruptible(&cl->rx_wait);
1781 if (waitqueue_active(&cl->tx_wait)) {
1782 cl_dbg(dev, cl, "Waking up writing client!\n");
1783 wake_up_interruptible(&cl->tx_wait);
1786 /* synchronized under device mutex */
1787 if (waitqueue_active(&cl->ev_wait)) {
1788 cl_dbg(dev, cl, "Waking up waiting for event clients!\n");
1789 wake_up_interruptible(&cl->ev_wait);
1795 * mei_cl_all_write_clear - clear all pending writes
1799 void mei_cl_all_write_clear(struct mei_device *dev)
1801 mei_io_list_free(&dev->write_list, NULL);
1802 mei_io_list_free(&dev->write_waiting_list, NULL);