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 up_write(&dev->me_clients_rwsem);
283 * mei_me_cl_rm_by_uuid_id - remove all me clients matching client id
285 * @dev: the device structure
286 * @uuid: me client uuid
289 * Locking: called under "dev->device_lock" lock
291 void mei_me_cl_rm_by_uuid_id(struct mei_device *dev, const uuid_le *uuid, u8 id)
293 struct mei_me_client *me_cl;
295 dev_dbg(dev->dev, "remove %pUl %d\n", uuid, id);
297 down_write(&dev->me_clients_rwsem);
298 me_cl = __mei_me_cl_by_uuid_id(dev, uuid, id);
299 __mei_me_cl_del(dev, me_cl);
300 up_write(&dev->me_clients_rwsem);
304 * mei_me_cl_rm_all - remove all me clients
306 * @dev: the device structure
308 * Locking: called under "dev->device_lock" lock
310 void mei_me_cl_rm_all(struct mei_device *dev)
312 struct mei_me_client *me_cl, *next;
314 down_write(&dev->me_clients_rwsem);
315 list_for_each_entry_safe(me_cl, next, &dev->me_clients, list)
316 __mei_me_cl_del(dev, me_cl);
317 up_write(&dev->me_clients_rwsem);
321 * mei_cl_cmp_id - tells if the clients are the same
323 * @cl1: host client 1
324 * @cl2: host client 2
326 * Return: true - if the clients has same host and me ids
329 static inline bool mei_cl_cmp_id(const struct mei_cl *cl1,
330 const struct mei_cl *cl2)
333 (cl1->host_client_id == cl2->host_client_id) &&
334 (mei_cl_me_id(cl1) == mei_cl_me_id(cl2));
338 * mei_io_cb_free - free mei_cb_private related memory
340 * @cb: mei callback struct
342 void mei_io_cb_free(struct mei_cl_cb *cb)
353 * mei_io_cb_init - allocate and initialize io callback
356 * @type: operation type
357 * @fp: pointer to file structure
359 * Return: mei_cl_cb pointer or NULL;
361 struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, enum mei_cb_file_ops type,
364 struct mei_cl_cb *cb;
366 cb = kzalloc(sizeof(struct mei_cl_cb), GFP_KERNEL);
370 INIT_LIST_HEAD(&cb->list);
371 cb->file_object = fp;
379 * __mei_io_list_flush - removes and frees cbs belonging to cl.
381 * @list: an instance of our list structure
382 * @cl: host client, can be NULL for flushing the whole list
383 * @free: whether to free the cbs
385 static void __mei_io_list_flush(struct mei_cl_cb *list,
386 struct mei_cl *cl, bool free)
388 struct mei_cl_cb *cb, *next;
390 /* enable removing everything if no cl is specified */
391 list_for_each_entry_safe(cb, next, &list->list, list) {
392 if (!cl || mei_cl_cmp_id(cl, cb->cl)) {
393 list_del_init(&cb->list);
401 * mei_io_list_flush - removes list entry belonging to cl.
403 * @list: An instance of our list structure
406 void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl)
408 __mei_io_list_flush(list, cl, false);
412 * mei_io_list_free - removes cb belonging to cl and free them
414 * @list: An instance of our list structure
417 static inline void mei_io_list_free(struct mei_cl_cb *list, struct mei_cl *cl)
419 __mei_io_list_flush(list, cl, true);
423 * mei_io_cb_alloc_buf - allocate callback buffer
425 * @cb: io callback structure
426 * @length: size of the buffer
428 * Return: 0 on success
429 * -EINVAL if cb is NULL
430 * -ENOMEM if allocation failed
432 int mei_io_cb_alloc_buf(struct mei_cl_cb *cb, size_t length)
440 cb->buf.data = kmalloc(length, GFP_KERNEL);
443 cb->buf.size = length;
448 * mei_cl_alloc_cb - a convenient wrapper for allocating read cb
451 * @length: size of the buffer
452 * @type: operation type
453 * @fp: associated file pointer (might be NULL)
455 * Return: cb on success and NULL on failure
457 struct mei_cl_cb *mei_cl_alloc_cb(struct mei_cl *cl, size_t length,
458 enum mei_cb_file_ops type, struct file *fp)
460 struct mei_cl_cb *cb;
462 cb = mei_io_cb_init(cl, type, fp);
466 if (mei_io_cb_alloc_buf(cb, length)) {
475 * mei_cl_read_cb - find this cl's callback in the read list
476 * for a specific file
479 * @fp: file pointer (matching cb file object), may be NULL
481 * Return: cb on success, NULL if cb is not found
483 struct mei_cl_cb *mei_cl_read_cb(const struct mei_cl *cl, const struct file *fp)
485 struct mei_cl_cb *cb;
487 list_for_each_entry(cb, &cl->rd_completed, list)
488 if (!fp || fp == cb->file_object)
495 * mei_cl_read_cb_flush - free client's read pending and completed cbs
496 * for a specific file
499 * @fp: file pointer (matching cb file object), may be NULL
501 void mei_cl_read_cb_flush(const struct mei_cl *cl, const struct file *fp)
503 struct mei_cl_cb *cb, *next;
505 list_for_each_entry_safe(cb, next, &cl->rd_completed, list)
506 if (!fp || fp == cb->file_object)
510 list_for_each_entry_safe(cb, next, &cl->rd_pending, list)
511 if (!fp || fp == cb->file_object)
516 * mei_cl_flush_queues - flushes queue lists belonging to cl.
519 * @fp: file pointer (matching cb file object), may be NULL
521 * Return: 0 on success, -EINVAL if cl or cl->dev is NULL.
523 int mei_cl_flush_queues(struct mei_cl *cl, const struct file *fp)
525 struct mei_device *dev;
527 if (WARN_ON(!cl || !cl->dev))
532 cl_dbg(dev, cl, "remove list entry belonging to cl\n");
533 mei_io_list_free(&cl->dev->write_list, cl);
534 mei_io_list_free(&cl->dev->write_waiting_list, cl);
535 mei_io_list_flush(&cl->dev->ctrl_wr_list, cl);
536 mei_io_list_flush(&cl->dev->ctrl_rd_list, cl);
537 mei_io_list_flush(&cl->dev->amthif_cmd_list, cl);
538 mei_io_list_flush(&cl->dev->amthif_rd_complete_list, cl);
540 mei_cl_read_cb_flush(cl, fp);
547 * mei_cl_init - initializes cl.
549 * @cl: host client to be initialized
552 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev)
554 memset(cl, 0, sizeof(struct mei_cl));
555 init_waitqueue_head(&cl->wait);
556 init_waitqueue_head(&cl->rx_wait);
557 init_waitqueue_head(&cl->tx_wait);
558 INIT_LIST_HEAD(&cl->rd_completed);
559 INIT_LIST_HEAD(&cl->rd_pending);
560 INIT_LIST_HEAD(&cl->link);
561 cl->writing_state = MEI_IDLE;
562 cl->state = MEI_FILE_INITIALIZING;
567 * mei_cl_allocate - allocates cl structure and sets it up.
570 * Return: The allocated file or NULL on failure
572 struct mei_cl *mei_cl_allocate(struct mei_device *dev)
576 cl = kmalloc(sizeof(struct mei_cl), GFP_KERNEL);
580 mei_cl_init(cl, dev);
586 * mei_cl_link - allocate host id in the host map
589 * @id: fixed host id or MEI_HOST_CLIENT_ID_ANY (-1) for generic one
591 * Return: 0 on success
592 * -EINVAL on incorrect values
593 * -EMFILE if open count exceeded.
595 int mei_cl_link(struct mei_cl *cl, int id)
597 struct mei_device *dev;
598 long open_handle_count;
600 if (WARN_ON(!cl || !cl->dev))
605 /* If Id is not assigned get one*/
606 if (id == MEI_HOST_CLIENT_ID_ANY)
607 id = find_first_zero_bit(dev->host_clients_map,
610 if (id >= MEI_CLIENTS_MAX) {
611 dev_err(dev->dev, "id exceeded %d", MEI_CLIENTS_MAX);
615 open_handle_count = dev->open_handle_count + dev->iamthif_open_count;
616 if (open_handle_count >= MEI_MAX_OPEN_HANDLE_COUNT) {
617 dev_err(dev->dev, "open_handle_count exceeded %d",
618 MEI_MAX_OPEN_HANDLE_COUNT);
622 dev->open_handle_count++;
624 cl->host_client_id = id;
625 list_add_tail(&cl->link, &dev->file_list);
627 set_bit(id, dev->host_clients_map);
629 cl->state = MEI_FILE_INITIALIZING;
631 cl_dbg(dev, cl, "link cl\n");
636 * mei_cl_unlink - remove host client from the list
642 int mei_cl_unlink(struct mei_cl *cl)
644 struct mei_device *dev;
646 /* don't shout on error exit path */
650 /* wd and amthif might not be initialized */
656 cl_dbg(dev, cl, "unlink client");
658 if (dev->open_handle_count > 0)
659 dev->open_handle_count--;
661 /* never clear the 0 bit */
662 if (cl->host_client_id)
663 clear_bit(cl->host_client_id, dev->host_clients_map);
665 list_del_init(&cl->link);
667 cl->state = MEI_FILE_INITIALIZING;
673 void mei_host_client_init(struct work_struct *work)
675 struct mei_device *dev =
676 container_of(work, struct mei_device, init_work);
677 struct mei_me_client *me_cl;
679 mutex_lock(&dev->device_lock);
682 me_cl = mei_me_cl_by_uuid(dev, &mei_amthif_guid);
684 mei_amthif_host_init(dev, me_cl);
685 mei_me_cl_put(me_cl);
687 me_cl = mei_me_cl_by_uuid(dev, &mei_wd_guid);
689 mei_wd_host_init(dev, me_cl);
690 mei_me_cl_put(me_cl);
692 dev->dev_state = MEI_DEV_ENABLED;
693 dev->reset_count = 0;
694 mutex_unlock(&dev->device_lock);
696 mei_cl_bus_rescan(dev);
698 pm_runtime_mark_last_busy(dev->dev);
699 dev_dbg(dev->dev, "rpm: autosuspend\n");
700 pm_runtime_autosuspend(dev->dev);
704 * mei_hbuf_acquire - try to acquire host buffer
706 * @dev: the device structure
707 * Return: true if host buffer was acquired
709 bool mei_hbuf_acquire(struct mei_device *dev)
711 if (mei_pg_state(dev) == MEI_PG_ON ||
712 mei_pg_in_transition(dev)) {
713 dev_dbg(dev->dev, "device is in pg\n");
717 if (!dev->hbuf_is_ready) {
718 dev_dbg(dev->dev, "hbuf is not ready\n");
722 dev->hbuf_is_ready = false;
728 * mei_cl_set_disconnected - set disconnected state and clear
729 * associated states and resources
733 void mei_cl_set_disconnected(struct mei_cl *cl)
735 struct mei_device *dev = cl->dev;
737 if (cl->state == MEI_FILE_DISCONNECTED ||
738 cl->state == MEI_FILE_INITIALIZING)
741 cl->state = MEI_FILE_DISCONNECTED;
742 mei_io_list_flush(&dev->ctrl_rd_list, cl);
743 mei_io_list_flush(&dev->ctrl_wr_list, cl);
744 cl->mei_flow_ctrl_creds = 0;
750 if (!WARN_ON(cl->me_cl->connect_count == 0))
751 cl->me_cl->connect_count--;
753 if (cl->me_cl->connect_count == 0)
754 cl->me_cl->mei_flow_ctrl_creds = 0;
756 mei_me_cl_put(cl->me_cl);
760 static int mei_cl_set_connecting(struct mei_cl *cl, struct mei_me_client *me_cl)
762 if (!mei_me_cl_get(me_cl))
765 /* only one connection is allowed for fixed address clients */
766 if (me_cl->props.fixed_address) {
767 if (me_cl->connect_count) {
768 mei_me_cl_put(me_cl);
774 cl->state = MEI_FILE_CONNECTING;
775 cl->me_cl->connect_count++;
781 * mei_cl_send_disconnect - send disconnect request
784 * @cb: callback block
786 * Return: 0, OK; otherwise, error.
788 static int mei_cl_send_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb)
790 struct mei_device *dev;
795 ret = mei_hbm_cl_disconnect_req(dev, cl);
798 cl->state = MEI_FILE_DISCONNECT_REPLY;
802 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
803 cl->timer_count = MEI_CONNECT_TIMEOUT;
809 * mei_cl_irq_disconnect - processes close related operation from
810 * interrupt thread context - send disconnect request
813 * @cb: callback block.
814 * @cmpl_list: complete list.
816 * Return: 0, OK; otherwise, error.
818 int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
819 struct mei_cl_cb *cmpl_list)
821 struct mei_device *dev = cl->dev;
826 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
827 slots = mei_hbuf_empty_slots(dev);
829 if (slots < msg_slots)
832 ret = mei_cl_send_disconnect(cl, cb);
834 list_move_tail(&cb->list, &cmpl_list->list);
840 * __mei_cl_disconnect - disconnect host client from the me one
841 * internal function runtime pm has to be already acquired
845 * Return: 0 on success, <0 on failure.
847 static int __mei_cl_disconnect(struct mei_cl *cl)
849 struct mei_device *dev;
850 struct mei_cl_cb *cb;
855 if (WARN_ON(!pm_runtime_active(dev->dev)))
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_read_start - the start read client message function.
1215 * @length: number of bytes to read
1216 * @fp: pointer to file structure
1218 * Return: 0 on success, <0 on failure.
1220 int mei_cl_read_start(struct mei_cl *cl, size_t length, struct file *fp)
1222 struct mei_device *dev;
1223 struct mei_cl_cb *cb;
1226 if (WARN_ON(!cl || !cl->dev))
1231 if (!mei_cl_is_connected(cl))
1234 /* HW currently supports only one pending read */
1235 if (!list_empty(&cl->rd_pending))
1238 if (!mei_me_cl_is_active(cl->me_cl)) {
1239 cl_err(dev, cl, "no such me client\n");
1243 /* always allocate at least client max message */
1244 length = max_t(size_t, length, mei_cl_mtu(cl));
1245 cb = mei_cl_alloc_cb(cl, length, MEI_FOP_READ, fp);
1249 if (mei_cl_is_fixed_address(cl)) {
1250 list_add_tail(&cb->list, &cl->rd_pending);
1254 rets = pm_runtime_get(dev->dev);
1255 if (rets < 0 && rets != -EINPROGRESS) {
1256 pm_runtime_put_noidle(dev->dev);
1257 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1261 if (mei_hbuf_acquire(dev)) {
1262 rets = mei_hbm_cl_flow_control_req(dev, cl);
1266 list_add_tail(&cb->list, &cl->rd_pending);
1269 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
1273 cl_dbg(dev, cl, "rpm: autosuspend\n");
1274 pm_runtime_mark_last_busy(dev->dev);
1275 pm_runtime_put_autosuspend(dev->dev);
1284 * mei_cl_irq_write - write a message to device
1285 * from the interrupt thread context
1288 * @cb: callback block.
1289 * @cmpl_list: complete list.
1291 * Return: 0, OK; otherwise error.
1293 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
1294 struct mei_cl_cb *cmpl_list)
1296 struct mei_device *dev;
1297 struct mei_msg_data *buf;
1298 struct mei_msg_hdr mei_hdr;
1305 if (WARN_ON(!cl || !cl->dev))
1312 first_chunk = cb->buf_idx == 0;
1314 rets = first_chunk ? mei_cl_flow_ctrl_creds(cl) : 1;
1319 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1323 slots = mei_hbuf_empty_slots(dev);
1324 len = buf->size - cb->buf_idx;
1325 msg_slots = mei_data2slots(len);
1327 mei_hdr.host_addr = mei_cl_host_addr(cl);
1328 mei_hdr.me_addr = mei_cl_me_id(cl);
1329 mei_hdr.reserved = 0;
1330 mei_hdr.internal = cb->internal;
1332 if (slots >= msg_slots) {
1333 mei_hdr.length = len;
1334 mei_hdr.msg_complete = 1;
1335 /* Split the message only if we can write the whole host buffer */
1336 } else if (slots == dev->hbuf_depth) {
1338 len = (slots * sizeof(u32)) - sizeof(struct mei_msg_hdr);
1339 mei_hdr.length = len;
1340 mei_hdr.msg_complete = 0;
1342 /* wait for next time the host buffer is empty */
1346 cl_dbg(dev, cl, "buf: size = %d idx = %lu\n",
1347 cb->buf.size, cb->buf_idx);
1349 rets = mei_write_message(dev, &mei_hdr, buf->data + cb->buf_idx);
1352 list_move_tail(&cb->list, &cmpl_list->list);
1357 cl->writing_state = MEI_WRITING;
1358 cb->buf_idx += mei_hdr.length;
1359 cb->completed = mei_hdr.msg_complete == 1;
1362 if (mei_cl_flow_ctrl_reduce(cl))
1366 if (mei_hdr.msg_complete)
1367 list_move_tail(&cb->list, &dev->write_waiting_list.list);
1373 * mei_cl_write - submit a write cb to mei device
1374 * assumes device_lock is locked
1377 * @cb: write callback with filled data
1378 * @blocking: block until completed
1380 * Return: number of bytes sent on success, <0 on failure.
1382 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking)
1384 struct mei_device *dev;
1385 struct mei_msg_data *buf;
1386 struct mei_msg_hdr mei_hdr;
1391 if (WARN_ON(!cl || !cl->dev))
1402 cl_dbg(dev, cl, "size=%d\n", size);
1404 rets = pm_runtime_get(dev->dev);
1405 if (rets < 0 && rets != -EINPROGRESS) {
1406 pm_runtime_put_noidle(dev->dev);
1407 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1412 cl->writing_state = MEI_IDLE;
1414 mei_hdr.host_addr = mei_cl_host_addr(cl);
1415 mei_hdr.me_addr = mei_cl_me_id(cl);
1416 mei_hdr.reserved = 0;
1417 mei_hdr.msg_complete = 0;
1418 mei_hdr.internal = cb->internal;
1420 rets = mei_cl_flow_ctrl_creds(cl);
1425 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1429 if (!mei_hbuf_acquire(dev)) {
1430 cl_dbg(dev, cl, "Cannot acquire the host buffer: not sending.\n");
1435 /* Check for a maximum length */
1436 if (size > mei_hbuf_max_len(dev)) {
1437 mei_hdr.length = mei_hbuf_max_len(dev);
1438 mei_hdr.msg_complete = 0;
1440 mei_hdr.length = size;
1441 mei_hdr.msg_complete = 1;
1444 rets = mei_write_message(dev, &mei_hdr, buf->data);
1448 rets = mei_cl_flow_ctrl_reduce(cl);
1452 cl->writing_state = MEI_WRITING;
1453 cb->buf_idx = mei_hdr.length;
1454 cb->completed = mei_hdr.msg_complete == 1;
1457 if (mei_hdr.msg_complete)
1458 list_add_tail(&cb->list, &dev->write_waiting_list.list);
1460 list_add_tail(&cb->list, &dev->write_list.list);
1463 if (blocking && cl->writing_state != MEI_WRITE_COMPLETE) {
1465 mutex_unlock(&dev->device_lock);
1466 rets = wait_event_interruptible(cl->tx_wait,
1467 cl->writing_state == MEI_WRITE_COMPLETE);
1468 mutex_lock(&dev->device_lock);
1469 /* wait_event_interruptible returns -ERESTARTSYS */
1471 if (signal_pending(current))
1479 cl_dbg(dev, cl, "rpm: autosuspend\n");
1480 pm_runtime_mark_last_busy(dev->dev);
1481 pm_runtime_put_autosuspend(dev->dev);
1488 * mei_cl_complete - processes completed operation for a client
1490 * @cl: private data of the file object.
1491 * @cb: callback block.
1493 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb)
1495 struct mei_device *dev = cl->dev;
1497 switch (cb->fop_type) {
1500 cl->writing_state = MEI_WRITE_COMPLETE;
1501 if (waitqueue_active(&cl->tx_wait)) {
1502 wake_up_interruptible(&cl->tx_wait);
1504 pm_runtime_mark_last_busy(dev->dev);
1505 pm_request_autosuspend(dev->dev);
1510 list_add_tail(&cb->list, &cl->rd_completed);
1511 if (waitqueue_active(&cl->rx_wait))
1512 wake_up_interruptible_all(&cl->rx_wait);
1514 mei_cl_bus_rx_event(cl);
1517 case MEI_FOP_CONNECT:
1518 case MEI_FOP_DISCONNECT:
1519 if (waitqueue_active(&cl->wait))
1530 * mei_cl_all_disconnect - disconnect forcefully all connected clients
1534 void mei_cl_all_disconnect(struct mei_device *dev)
1538 list_for_each_entry(cl, &dev->file_list, link)
1539 mei_cl_set_disconnected(cl);
1544 * mei_cl_all_wakeup - wake up all readers and writers they can be interrupted
1548 void mei_cl_all_wakeup(struct mei_device *dev)
1552 list_for_each_entry(cl, &dev->file_list, link) {
1553 if (waitqueue_active(&cl->rx_wait)) {
1554 cl_dbg(dev, cl, "Waking up reading client!\n");
1555 wake_up_interruptible(&cl->rx_wait);
1557 if (waitqueue_active(&cl->tx_wait)) {
1558 cl_dbg(dev, cl, "Waking up writing client!\n");
1559 wake_up_interruptible(&cl->tx_wait);
1565 * mei_cl_all_write_clear - clear all pending writes
1569 void mei_cl_all_write_clear(struct mei_device *dev)
1571 mei_io_list_free(&dev->write_list, NULL);
1572 mei_io_list_free(&dev->write_waiting_list, NULL);