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_waitqueue_head(&cl->ev_wait);
559 INIT_LIST_HEAD(&cl->rd_completed);
560 INIT_LIST_HEAD(&cl->rd_pending);
561 INIT_LIST_HEAD(&cl->link);
562 cl->writing_state = MEI_IDLE;
563 cl->state = MEI_FILE_INITIALIZING;
568 * mei_cl_allocate - allocates cl structure and sets it up.
571 * Return: The allocated file or NULL on failure
573 struct mei_cl *mei_cl_allocate(struct mei_device *dev)
577 cl = kmalloc(sizeof(struct mei_cl), GFP_KERNEL);
581 mei_cl_init(cl, dev);
587 * mei_cl_link - allocate host id in the host map
590 * @id: fixed host id or MEI_HOST_CLIENT_ID_ANY (-1) for generic one
592 * Return: 0 on success
593 * -EINVAL on incorrect values
594 * -EMFILE if open count exceeded.
596 int mei_cl_link(struct mei_cl *cl, int id)
598 struct mei_device *dev;
599 long open_handle_count;
601 if (WARN_ON(!cl || !cl->dev))
606 /* If Id is not assigned get one*/
607 if (id == MEI_HOST_CLIENT_ID_ANY)
608 id = find_first_zero_bit(dev->host_clients_map,
611 if (id >= MEI_CLIENTS_MAX) {
612 dev_err(dev->dev, "id exceeded %d", MEI_CLIENTS_MAX);
616 open_handle_count = dev->open_handle_count + dev->iamthif_open_count;
617 if (open_handle_count >= MEI_MAX_OPEN_HANDLE_COUNT) {
618 dev_err(dev->dev, "open_handle_count exceeded %d",
619 MEI_MAX_OPEN_HANDLE_COUNT);
623 dev->open_handle_count++;
625 cl->host_client_id = id;
626 list_add_tail(&cl->link, &dev->file_list);
628 set_bit(id, dev->host_clients_map);
630 cl->state = MEI_FILE_INITIALIZING;
632 cl_dbg(dev, cl, "link cl\n");
637 * mei_cl_unlink - remove host client from the list
643 int mei_cl_unlink(struct mei_cl *cl)
645 struct mei_device *dev;
647 /* don't shout on error exit path */
651 /* wd and amthif might not be initialized */
657 cl_dbg(dev, cl, "unlink client");
659 if (dev->open_handle_count > 0)
660 dev->open_handle_count--;
662 /* never clear the 0 bit */
663 if (cl->host_client_id)
664 clear_bit(cl->host_client_id, dev->host_clients_map);
666 list_del_init(&cl->link);
668 cl->state = MEI_FILE_INITIALIZING;
674 void mei_host_client_init(struct work_struct *work)
676 struct mei_device *dev =
677 container_of(work, struct mei_device, init_work);
678 struct mei_me_client *me_cl;
680 mutex_lock(&dev->device_lock);
683 me_cl = mei_me_cl_by_uuid(dev, &mei_amthif_guid);
685 mei_amthif_host_init(dev, me_cl);
686 mei_me_cl_put(me_cl);
688 me_cl = mei_me_cl_by_uuid(dev, &mei_wd_guid);
690 mei_wd_host_init(dev, me_cl);
691 mei_me_cl_put(me_cl);
693 dev->dev_state = MEI_DEV_ENABLED;
694 dev->reset_count = 0;
695 mutex_unlock(&dev->device_lock);
697 mei_cl_bus_rescan(dev);
699 pm_runtime_mark_last_busy(dev->dev);
700 dev_dbg(dev->dev, "rpm: autosuspend\n");
701 pm_runtime_autosuspend(dev->dev);
705 * mei_hbuf_acquire - try to acquire host buffer
707 * @dev: the device structure
708 * Return: true if host buffer was acquired
710 bool mei_hbuf_acquire(struct mei_device *dev)
712 if (mei_pg_state(dev) == MEI_PG_ON ||
713 mei_pg_in_transition(dev)) {
714 dev_dbg(dev->dev, "device is in pg\n");
718 if (!dev->hbuf_is_ready) {
719 dev_dbg(dev->dev, "hbuf is not ready\n");
723 dev->hbuf_is_ready = false;
729 * mei_cl_set_disconnected - set disconnected state and clear
730 * associated states and resources
734 void mei_cl_set_disconnected(struct mei_cl *cl)
736 struct mei_device *dev = cl->dev;
738 if (cl->state == MEI_FILE_DISCONNECTED ||
739 cl->state == MEI_FILE_INITIALIZING)
742 cl->state = MEI_FILE_DISCONNECTED;
743 mei_io_list_flush(&dev->ctrl_rd_list, cl);
744 mei_io_list_flush(&dev->ctrl_wr_list, cl);
745 cl->mei_flow_ctrl_creds = 0;
751 if (!WARN_ON(cl->me_cl->connect_count == 0))
752 cl->me_cl->connect_count--;
754 if (cl->me_cl->connect_count == 0)
755 cl->me_cl->mei_flow_ctrl_creds = 0;
757 mei_me_cl_put(cl->me_cl);
761 static int mei_cl_set_connecting(struct mei_cl *cl, struct mei_me_client *me_cl)
763 if (!mei_me_cl_get(me_cl))
766 /* only one connection is allowed for fixed address clients */
767 if (me_cl->props.fixed_address) {
768 if (me_cl->connect_count) {
769 mei_me_cl_put(me_cl);
775 cl->state = MEI_FILE_CONNECTING;
776 cl->me_cl->connect_count++;
782 * mei_cl_send_disconnect - send disconnect request
785 * @cb: callback block
787 * Return: 0, OK; otherwise, error.
789 static int mei_cl_send_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb)
791 struct mei_device *dev;
796 ret = mei_hbm_cl_disconnect_req(dev, cl);
799 cl->state = MEI_FILE_DISCONNECT_REPLY;
803 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
804 cl->timer_count = MEI_CONNECT_TIMEOUT;
810 * mei_cl_irq_disconnect - processes close related operation from
811 * interrupt thread context - send disconnect request
814 * @cb: callback block.
815 * @cmpl_list: complete list.
817 * Return: 0, OK; otherwise, error.
819 int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
820 struct mei_cl_cb *cmpl_list)
822 struct mei_device *dev = cl->dev;
827 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
828 slots = mei_hbuf_empty_slots(dev);
830 if (slots < msg_slots)
833 ret = mei_cl_send_disconnect(cl, cb);
835 list_move_tail(&cb->list, &cmpl_list->list);
841 * __mei_cl_disconnect - disconnect host client from the me one
842 * internal function runtime pm has to be already acquired
846 * Return: 0 on success, <0 on failure.
848 static int __mei_cl_disconnect(struct mei_cl *cl)
850 struct mei_device *dev;
851 struct mei_cl_cb *cb;
856 if (WARN_ON(!pm_runtime_active(dev->dev)))
859 cl->state = MEI_FILE_DISCONNECTING;
861 cb = mei_io_cb_init(cl, MEI_FOP_DISCONNECT, NULL);
862 rets = cb ? 0 : -ENOMEM;
866 cl_dbg(dev, cl, "add disconnect cb to control write list\n");
867 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
869 if (mei_hbuf_acquire(dev)) {
870 rets = mei_cl_send_disconnect(cl, cb);
872 cl_err(dev, cl, "failed to disconnect.\n");
877 mutex_unlock(&dev->device_lock);
878 wait_event_timeout(cl->wait, cl->state == MEI_FILE_DISCONNECT_REPLY,
879 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
880 mutex_lock(&dev->device_lock);
883 if (cl->state != MEI_FILE_DISCONNECT_REPLY) {
884 cl_dbg(dev, cl, "timeout on disconnect from FW client.\n");
889 /* we disconnect also on error */
890 mei_cl_set_disconnected(cl);
892 cl_dbg(dev, cl, "successfully disconnected from FW client.\n");
899 * mei_cl_disconnect - disconnect host client from the me one
903 * Locking: called under "dev->device_lock" lock
905 * Return: 0 on success, <0 on failure.
907 int mei_cl_disconnect(struct mei_cl *cl)
909 struct mei_device *dev;
912 if (WARN_ON(!cl || !cl->dev))
917 cl_dbg(dev, cl, "disconnecting");
919 if (!mei_cl_is_connected(cl))
922 if (mei_cl_is_fixed_address(cl)) {
923 mei_cl_set_disconnected(cl);
927 rets = pm_runtime_get(dev->dev);
928 if (rets < 0 && rets != -EINPROGRESS) {
929 pm_runtime_put_noidle(dev->dev);
930 cl_err(dev, cl, "rpm: get failed %d\n", rets);
934 rets = __mei_cl_disconnect(cl);
936 cl_dbg(dev, cl, "rpm: autosuspend\n");
937 pm_runtime_mark_last_busy(dev->dev);
938 pm_runtime_put_autosuspend(dev->dev);
945 * mei_cl_is_other_connecting - checks if other
946 * client with the same me client id is connecting
948 * @cl: private data of the file object
950 * Return: true if other client is connected, false - otherwise.
952 static bool mei_cl_is_other_connecting(struct mei_cl *cl)
954 struct mei_device *dev;
955 struct mei_cl_cb *cb;
959 list_for_each_entry(cb, &dev->ctrl_rd_list.list, list) {
960 if (cb->fop_type == MEI_FOP_CONNECT &&
961 mei_cl_me_id(cl) == mei_cl_me_id(cb->cl))
969 * mei_cl_send_connect - send connect request
972 * @cb: callback block
974 * Return: 0, OK; otherwise, error.
976 static int mei_cl_send_connect(struct mei_cl *cl, struct mei_cl_cb *cb)
978 struct mei_device *dev;
983 ret = mei_hbm_cl_connect_req(dev, cl);
986 cl->state = MEI_FILE_DISCONNECT_REPLY;
990 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
991 cl->timer_count = MEI_CONNECT_TIMEOUT;
996 * mei_cl_irq_connect - send connect request in irq_thread context
999 * @cb: callback block
1000 * @cmpl_list: complete list
1002 * Return: 0, OK; otherwise, error.
1004 int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
1005 struct mei_cl_cb *cmpl_list)
1007 struct mei_device *dev = cl->dev;
1012 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1013 slots = mei_hbuf_empty_slots(dev);
1015 if (mei_cl_is_other_connecting(cl))
1018 if (slots < msg_slots)
1021 rets = mei_cl_send_connect(cl, cb);
1023 list_move_tail(&cb->list, &cmpl_list->list);
1029 * mei_cl_connect - connect host client to the me one
1033 * @file: pointer to file structure
1035 * Locking: called under "dev->device_lock" lock
1037 * Return: 0 on success, <0 on failure.
1039 int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl,
1042 struct mei_device *dev;
1043 struct mei_cl_cb *cb;
1046 if (WARN_ON(!cl || !cl->dev || !me_cl))
1051 rets = mei_cl_set_connecting(cl, me_cl);
1055 if (mei_cl_is_fixed_address(cl)) {
1056 cl->state = MEI_FILE_CONNECTED;
1060 rets = pm_runtime_get(dev->dev);
1061 if (rets < 0 && rets != -EINPROGRESS) {
1062 pm_runtime_put_noidle(dev->dev);
1063 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1067 cb = mei_io_cb_init(cl, MEI_FOP_CONNECT, file);
1068 rets = cb ? 0 : -ENOMEM;
1072 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
1074 /* run hbuf acquire last so we don't have to undo */
1075 if (!mei_cl_is_other_connecting(cl) && mei_hbuf_acquire(dev)) {
1076 rets = mei_cl_send_connect(cl, cb);
1081 mutex_unlock(&dev->device_lock);
1082 wait_event_timeout(cl->wait,
1083 (cl->state == MEI_FILE_CONNECTED ||
1084 cl->state == MEI_FILE_DISCONNECT_REQUIRED ||
1085 cl->state == MEI_FILE_DISCONNECT_REPLY),
1086 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1087 mutex_lock(&dev->device_lock);
1089 if (!mei_cl_is_connected(cl)) {
1090 if (cl->state == MEI_FILE_DISCONNECT_REQUIRED) {
1091 mei_io_list_flush(&dev->ctrl_rd_list, cl);
1092 mei_io_list_flush(&dev->ctrl_wr_list, cl);
1093 /* ignore disconnect return valuue;
1094 * in case of failure reset will be invoked
1096 __mei_cl_disconnect(cl);
1101 /* timeout or something went really wrong */
1103 cl->status = -EFAULT;
1108 cl_dbg(dev, cl, "rpm: autosuspend\n");
1109 pm_runtime_mark_last_busy(dev->dev);
1110 pm_runtime_put_autosuspend(dev->dev);
1115 if (!mei_cl_is_connected(cl))
1116 mei_cl_set_disconnected(cl);
1122 * mei_cl_alloc_linked - allocate and link host client
1124 * @dev: the device structure
1125 * @id: fixed host id or MEI_HOST_CLIENT_ID_ANY (-1) for generic one
1127 * Return: cl on success ERR_PTR on failure
1129 struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev, int id)
1134 cl = mei_cl_allocate(dev);
1140 ret = mei_cl_link(cl, id);
1147 return ERR_PTR(ret);
1153 * mei_cl_flow_ctrl_creds - checks flow_control credits for cl.
1155 * @cl: private data of the file object
1157 * Return: 1 if mei_flow_ctrl_creds >0, 0 - otherwise.
1159 int mei_cl_flow_ctrl_creds(struct mei_cl *cl)
1163 if (WARN_ON(!cl || !cl->me_cl))
1166 if (cl->mei_flow_ctrl_creds > 0)
1169 if (mei_cl_is_fixed_address(cl)) {
1170 rets = mei_cl_read_start(cl, mei_cl_mtu(cl), NULL);
1171 if (rets && rets != -EBUSY)
1176 if (mei_cl_is_single_recv_buf(cl)) {
1177 if (cl->me_cl->mei_flow_ctrl_creds > 0)
1184 * mei_cl_flow_ctrl_reduce - reduces flow_control.
1186 * @cl: private data of the file object
1190 * -EINVAL when ctrl credits are <= 0
1192 int mei_cl_flow_ctrl_reduce(struct mei_cl *cl)
1194 if (WARN_ON(!cl || !cl->me_cl))
1197 if (mei_cl_is_fixed_address(cl))
1200 if (mei_cl_is_single_recv_buf(cl)) {
1201 if (WARN_ON(cl->me_cl->mei_flow_ctrl_creds <= 0))
1203 cl->me_cl->mei_flow_ctrl_creds--;
1205 if (WARN_ON(cl->mei_flow_ctrl_creds <= 0))
1207 cl->mei_flow_ctrl_creds--;
1213 * mei_cl_notify_fop2req - convert fop to proper request
1215 * @fop: client notification start response command
1217 * Return: MEI_HBM_NOTIFICATION_START/STOP
1219 u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop)
1221 if (fop == MEI_FOP_NOTIFY_START)
1222 return MEI_HBM_NOTIFICATION_START;
1224 return MEI_HBM_NOTIFICATION_STOP;
1228 * mei_cl_notify_req2fop - convert notification request top file operation type
1230 * @req: hbm notification request type
1232 * Return: MEI_FOP_NOTIFY_START/STOP
1234 enum mei_cb_file_ops mei_cl_notify_req2fop(u8 req)
1236 if (req == MEI_HBM_NOTIFICATION_START)
1237 return MEI_FOP_NOTIFY_START;
1239 return MEI_FOP_NOTIFY_STOP;
1243 * mei_cl_irq_notify - send notification request in irq_thread context
1246 * @cb: callback block.
1247 * @cmpl_list: complete list.
1249 * Return: 0 on such and error otherwise.
1251 int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb,
1252 struct mei_cl_cb *cmpl_list)
1254 struct mei_device *dev = cl->dev;
1260 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1261 slots = mei_hbuf_empty_slots(dev);
1263 if (slots < msg_slots)
1266 request = mei_cl_notify_fop2req(cb->fop_type);
1267 ret = mei_hbm_cl_notify_req(dev, cl, request);
1270 list_move_tail(&cb->list, &cmpl_list->list);
1274 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
1279 * mei_cl_notify_request - send notification stop/start request
1282 * @file: associate request with file
1283 * @request: 1 for start or 0 for stop
1285 * Locking: called under "dev->device_lock" lock
1287 * Return: 0 on such and error otherwise.
1289 int mei_cl_notify_request(struct mei_cl *cl, struct file *file, u8 request)
1291 struct mei_device *dev;
1292 struct mei_cl_cb *cb;
1293 enum mei_cb_file_ops fop_type;
1296 if (WARN_ON(!cl || !cl->dev))
1301 if (!dev->hbm_f_ev_supported) {
1302 cl_dbg(dev, cl, "notifications not supported\n");
1306 rets = pm_runtime_get(dev->dev);
1307 if (rets < 0 && rets != -EINPROGRESS) {
1308 pm_runtime_put_noidle(dev->dev);
1309 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1313 fop_type = mei_cl_notify_req2fop(request);
1314 cb = mei_io_cb_init(cl, fop_type, file);
1320 if (mei_hbuf_acquire(dev)) {
1321 if (mei_hbm_cl_notify_req(dev, cl, request)) {
1325 list_add_tail(&cb->list, &dev->ctrl_rd_list.list);
1327 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
1330 mutex_unlock(&dev->device_lock);
1331 wait_event_timeout(cl->wait, cl->notify_en == request,
1332 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1333 mutex_lock(&dev->device_lock);
1335 if (cl->notify_en != request) {
1336 mei_io_list_flush(&dev->ctrl_rd_list, cl);
1337 mei_io_list_flush(&dev->ctrl_wr_list, cl);
1339 cl->status = -EFAULT;
1345 cl_dbg(dev, cl, "rpm: autosuspend\n");
1346 pm_runtime_mark_last_busy(dev->dev);
1347 pm_runtime_put_autosuspend(dev->dev);
1354 * mei_cl_notify_get - get or wait for notification event
1357 * @block: this request is blocking
1358 * @notify_ev: true if notification event was received
1360 * Locking: called under "dev->device_lock" lock
1362 * Return: 0 on such and error otherwise.
1364 int mei_cl_notify_get(struct mei_cl *cl, bool block, bool *notify_ev)
1366 struct mei_device *dev;
1371 if (WARN_ON(!cl || !cl->dev))
1376 if (!mei_cl_is_connected(cl))
1385 mutex_unlock(&dev->device_lock);
1386 rets = wait_event_interruptible(cl->ev_wait, cl->notify_ev);
1387 mutex_lock(&dev->device_lock);
1393 *notify_ev = cl->notify_ev;
1394 cl->notify_ev = false;
1399 * mei_cl_read_start - the start read client message function.
1402 * @length: number of bytes to read
1403 * @fp: pointer to file structure
1405 * Return: 0 on success, <0 on failure.
1407 int mei_cl_read_start(struct mei_cl *cl, size_t length, struct file *fp)
1409 struct mei_device *dev;
1410 struct mei_cl_cb *cb;
1413 if (WARN_ON(!cl || !cl->dev))
1418 if (!mei_cl_is_connected(cl))
1421 /* HW currently supports only one pending read */
1422 if (!list_empty(&cl->rd_pending))
1425 if (!mei_me_cl_is_active(cl->me_cl)) {
1426 cl_err(dev, cl, "no such me client\n");
1430 /* always allocate at least client max message */
1431 length = max_t(size_t, length, mei_cl_mtu(cl));
1432 cb = mei_cl_alloc_cb(cl, length, MEI_FOP_READ, fp);
1436 if (mei_cl_is_fixed_address(cl)) {
1437 list_add_tail(&cb->list, &cl->rd_pending);
1441 rets = pm_runtime_get(dev->dev);
1442 if (rets < 0 && rets != -EINPROGRESS) {
1443 pm_runtime_put_noidle(dev->dev);
1444 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1448 if (mei_hbuf_acquire(dev)) {
1449 rets = mei_hbm_cl_flow_control_req(dev, cl);
1453 list_add_tail(&cb->list, &cl->rd_pending);
1456 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
1460 cl_dbg(dev, cl, "rpm: autosuspend\n");
1461 pm_runtime_mark_last_busy(dev->dev);
1462 pm_runtime_put_autosuspend(dev->dev);
1471 * mei_cl_irq_write - write a message to device
1472 * from the interrupt thread context
1475 * @cb: callback block.
1476 * @cmpl_list: complete list.
1478 * Return: 0, OK; otherwise error.
1480 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
1481 struct mei_cl_cb *cmpl_list)
1483 struct mei_device *dev;
1484 struct mei_msg_data *buf;
1485 struct mei_msg_hdr mei_hdr;
1492 if (WARN_ON(!cl || !cl->dev))
1499 first_chunk = cb->buf_idx == 0;
1501 rets = first_chunk ? mei_cl_flow_ctrl_creds(cl) : 1;
1506 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1510 slots = mei_hbuf_empty_slots(dev);
1511 len = buf->size - cb->buf_idx;
1512 msg_slots = mei_data2slots(len);
1514 mei_hdr.host_addr = mei_cl_host_addr(cl);
1515 mei_hdr.me_addr = mei_cl_me_id(cl);
1516 mei_hdr.reserved = 0;
1517 mei_hdr.internal = cb->internal;
1519 if (slots >= msg_slots) {
1520 mei_hdr.length = len;
1521 mei_hdr.msg_complete = 1;
1522 /* Split the message only if we can write the whole host buffer */
1523 } else if (slots == dev->hbuf_depth) {
1525 len = (slots * sizeof(u32)) - sizeof(struct mei_msg_hdr);
1526 mei_hdr.length = len;
1527 mei_hdr.msg_complete = 0;
1529 /* wait for next time the host buffer is empty */
1533 cl_dbg(dev, cl, "buf: size = %d idx = %lu\n",
1534 cb->buf.size, cb->buf_idx);
1536 rets = mei_write_message(dev, &mei_hdr, buf->data + cb->buf_idx);
1539 list_move_tail(&cb->list, &cmpl_list->list);
1544 cl->writing_state = MEI_WRITING;
1545 cb->buf_idx += mei_hdr.length;
1546 cb->completed = mei_hdr.msg_complete == 1;
1549 if (mei_cl_flow_ctrl_reduce(cl))
1553 if (mei_hdr.msg_complete)
1554 list_move_tail(&cb->list, &dev->write_waiting_list.list);
1560 * mei_cl_write - submit a write cb to mei device
1561 * assumes device_lock is locked
1564 * @cb: write callback with filled data
1565 * @blocking: block until completed
1567 * Return: number of bytes sent on success, <0 on failure.
1569 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking)
1571 struct mei_device *dev;
1572 struct mei_msg_data *buf;
1573 struct mei_msg_hdr mei_hdr;
1578 if (WARN_ON(!cl || !cl->dev))
1589 cl_dbg(dev, cl, "size=%d\n", size);
1591 rets = pm_runtime_get(dev->dev);
1592 if (rets < 0 && rets != -EINPROGRESS) {
1593 pm_runtime_put_noidle(dev->dev);
1594 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1599 cl->writing_state = MEI_IDLE;
1601 mei_hdr.host_addr = mei_cl_host_addr(cl);
1602 mei_hdr.me_addr = mei_cl_me_id(cl);
1603 mei_hdr.reserved = 0;
1604 mei_hdr.msg_complete = 0;
1605 mei_hdr.internal = cb->internal;
1607 rets = mei_cl_flow_ctrl_creds(cl);
1612 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1616 if (!mei_hbuf_acquire(dev)) {
1617 cl_dbg(dev, cl, "Cannot acquire the host buffer: not sending.\n");
1622 /* Check for a maximum length */
1623 if (size > mei_hbuf_max_len(dev)) {
1624 mei_hdr.length = mei_hbuf_max_len(dev);
1625 mei_hdr.msg_complete = 0;
1627 mei_hdr.length = size;
1628 mei_hdr.msg_complete = 1;
1631 rets = mei_write_message(dev, &mei_hdr, buf->data);
1635 rets = mei_cl_flow_ctrl_reduce(cl);
1639 cl->writing_state = MEI_WRITING;
1640 cb->buf_idx = mei_hdr.length;
1641 cb->completed = mei_hdr.msg_complete == 1;
1644 if (mei_hdr.msg_complete)
1645 list_add_tail(&cb->list, &dev->write_waiting_list.list);
1647 list_add_tail(&cb->list, &dev->write_list.list);
1650 if (blocking && cl->writing_state != MEI_WRITE_COMPLETE) {
1652 mutex_unlock(&dev->device_lock);
1653 rets = wait_event_interruptible(cl->tx_wait,
1654 cl->writing_state == MEI_WRITE_COMPLETE);
1655 mutex_lock(&dev->device_lock);
1656 /* wait_event_interruptible returns -ERESTARTSYS */
1658 if (signal_pending(current))
1666 cl_dbg(dev, cl, "rpm: autosuspend\n");
1667 pm_runtime_mark_last_busy(dev->dev);
1668 pm_runtime_put_autosuspend(dev->dev);
1675 * mei_cl_complete - processes completed operation for a client
1677 * @cl: private data of the file object.
1678 * @cb: callback block.
1680 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb)
1682 struct mei_device *dev = cl->dev;
1684 switch (cb->fop_type) {
1687 cl->writing_state = MEI_WRITE_COMPLETE;
1688 if (waitqueue_active(&cl->tx_wait)) {
1689 wake_up_interruptible(&cl->tx_wait);
1691 pm_runtime_mark_last_busy(dev->dev);
1692 pm_request_autosuspend(dev->dev);
1697 list_add_tail(&cb->list, &cl->rd_completed);
1698 if (waitqueue_active(&cl->rx_wait))
1699 wake_up_interruptible_all(&cl->rx_wait);
1701 mei_cl_bus_rx_event(cl);
1704 case MEI_FOP_CONNECT:
1705 case MEI_FOP_DISCONNECT:
1706 case MEI_FOP_NOTIFY_STOP:
1707 case MEI_FOP_NOTIFY_START:
1708 if (waitqueue_active(&cl->wait))
1719 * mei_cl_all_disconnect - disconnect forcefully all connected clients
1723 void mei_cl_all_disconnect(struct mei_device *dev)
1727 list_for_each_entry(cl, &dev->file_list, link)
1728 mei_cl_set_disconnected(cl);
1733 * mei_cl_all_wakeup - wake up all readers and writers they can be interrupted
1737 void mei_cl_all_wakeup(struct mei_device *dev)
1741 list_for_each_entry(cl, &dev->file_list, link) {
1742 if (waitqueue_active(&cl->rx_wait)) {
1743 cl_dbg(dev, cl, "Waking up reading client!\n");
1744 wake_up_interruptible(&cl->rx_wait);
1746 if (waitqueue_active(&cl->tx_wait)) {
1747 cl_dbg(dev, cl, "Waking up writing client!\n");
1748 wake_up_interruptible(&cl->tx_wait);
1751 /* synchronized under device mutex */
1752 if (waitqueue_active(&cl->ev_wait)) {
1753 cl_dbg(dev, cl, "Waking up waiting for event clients!\n");
1754 wake_up_interruptible(&cl->ev_wait);
1760 * mei_cl_all_write_clear - clear all pending writes
1764 void mei_cl_all_write_clear(struct mei_device *dev)
1766 mei_io_list_free(&dev->write_list, NULL);
1767 mei_io_list_free(&dev->write_waiting_list, NULL);