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 cl->state = MEI_FILE_DISCONNECTING;
858 cb = mei_io_cb_init(cl, MEI_FOP_DISCONNECT, NULL);
859 rets = cb ? 0 : -ENOMEM;
863 cl_dbg(dev, cl, "add disconnect cb to control write list\n");
864 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
866 if (mei_hbuf_acquire(dev)) {
867 rets = mei_cl_send_disconnect(cl, cb);
869 cl_err(dev, cl, "failed to disconnect.\n");
874 mutex_unlock(&dev->device_lock);
875 wait_event_timeout(cl->wait, cl->state == MEI_FILE_DISCONNECT_REPLY,
876 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
877 mutex_lock(&dev->device_lock);
880 if (cl->state != MEI_FILE_DISCONNECT_REPLY) {
881 cl_dbg(dev, cl, "timeout on disconnect from FW client.\n");
886 /* we disconnect also on error */
887 mei_cl_set_disconnected(cl);
889 cl_dbg(dev, cl, "successfully disconnected from FW client.\n");
896 * mei_cl_disconnect - disconnect host client from the me one
900 * Locking: called under "dev->device_lock" lock
902 * Return: 0 on success, <0 on failure.
904 int mei_cl_disconnect(struct mei_cl *cl)
906 struct mei_device *dev;
909 if (WARN_ON(!cl || !cl->dev))
914 cl_dbg(dev, cl, "disconnecting");
916 if (!mei_cl_is_connected(cl))
919 if (mei_cl_is_fixed_address(cl)) {
920 mei_cl_set_disconnected(cl);
924 rets = pm_runtime_get(dev->dev);
925 if (rets < 0 && rets != -EINPROGRESS) {
926 pm_runtime_put_noidle(dev->dev);
927 cl_err(dev, cl, "rpm: get failed %d\n", rets);
931 rets = __mei_cl_disconnect(cl);
933 cl_dbg(dev, cl, "rpm: autosuspend\n");
934 pm_runtime_mark_last_busy(dev->dev);
935 pm_runtime_put_autosuspend(dev->dev);
942 * mei_cl_is_other_connecting - checks if other
943 * client with the same me client id is connecting
945 * @cl: private data of the file object
947 * Return: true if other client is connected, false - otherwise.
949 static bool mei_cl_is_other_connecting(struct mei_cl *cl)
951 struct mei_device *dev;
952 struct mei_cl_cb *cb;
956 list_for_each_entry(cb, &dev->ctrl_rd_list.list, list) {
957 if (cb->fop_type == MEI_FOP_CONNECT &&
958 mei_cl_me_id(cl) == mei_cl_me_id(cb->cl))
966 * mei_cl_send_connect - send connect request
969 * @cb: callback block
971 * Return: 0, OK; otherwise, error.
973 static int mei_cl_send_connect(struct mei_cl *cl, struct mei_cl_cb *cb)
975 struct mei_device *dev;
980 ret = mei_hbm_cl_connect_req(dev, cl);
983 cl->state = MEI_FILE_DISCONNECT_REPLY;
987 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
988 cl->timer_count = MEI_CONNECT_TIMEOUT;
993 * mei_cl_irq_connect - send connect request in irq_thread context
996 * @cb: callback block
997 * @cmpl_list: complete list
999 * Return: 0, OK; otherwise, error.
1001 int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
1002 struct mei_cl_cb *cmpl_list)
1004 struct mei_device *dev = cl->dev;
1009 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1010 slots = mei_hbuf_empty_slots(dev);
1012 if (mei_cl_is_other_connecting(cl))
1015 if (slots < msg_slots)
1018 rets = mei_cl_send_connect(cl, cb);
1020 list_move_tail(&cb->list, &cmpl_list->list);
1026 * mei_cl_connect - connect host client to the me one
1030 * @file: pointer to file structure
1032 * Locking: called under "dev->device_lock" lock
1034 * Return: 0 on success, <0 on failure.
1036 int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl,
1039 struct mei_device *dev;
1040 struct mei_cl_cb *cb;
1043 if (WARN_ON(!cl || !cl->dev || !me_cl))
1048 rets = mei_cl_set_connecting(cl, me_cl);
1052 if (mei_cl_is_fixed_address(cl)) {
1053 cl->state = MEI_FILE_CONNECTED;
1057 rets = pm_runtime_get(dev->dev);
1058 if (rets < 0 && rets != -EINPROGRESS) {
1059 pm_runtime_put_noidle(dev->dev);
1060 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1064 cb = mei_io_cb_init(cl, MEI_FOP_CONNECT, file);
1065 rets = cb ? 0 : -ENOMEM;
1069 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
1071 /* run hbuf acquire last so we don't have to undo */
1072 if (!mei_cl_is_other_connecting(cl) && mei_hbuf_acquire(dev)) {
1073 rets = mei_cl_send_connect(cl, cb);
1078 mutex_unlock(&dev->device_lock);
1079 wait_event_timeout(cl->wait,
1080 (cl->state == MEI_FILE_CONNECTED ||
1081 cl->state == MEI_FILE_DISCONNECT_REQUIRED ||
1082 cl->state == MEI_FILE_DISCONNECT_REPLY),
1083 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1084 mutex_lock(&dev->device_lock);
1086 if (!mei_cl_is_connected(cl)) {
1087 if (cl->state == MEI_FILE_DISCONNECT_REQUIRED) {
1088 mei_io_list_flush(&dev->ctrl_rd_list, cl);
1089 mei_io_list_flush(&dev->ctrl_wr_list, cl);
1090 /* ignore disconnect return valuue;
1091 * in case of failure reset will be invoked
1093 __mei_cl_disconnect(cl);
1098 /* timeout or something went really wrong */
1100 cl->status = -EFAULT;
1105 cl_dbg(dev, cl, "rpm: autosuspend\n");
1106 pm_runtime_mark_last_busy(dev->dev);
1107 pm_runtime_put_autosuspend(dev->dev);
1112 if (!mei_cl_is_connected(cl))
1113 mei_cl_set_disconnected(cl);
1119 * mei_cl_alloc_linked - allocate and link host client
1121 * @dev: the device structure
1122 * @id: fixed host id or MEI_HOST_CLIENT_ID_ANY (-1) for generic one
1124 * Return: cl on success ERR_PTR on failure
1126 struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev, int id)
1131 cl = mei_cl_allocate(dev);
1137 ret = mei_cl_link(cl, id);
1144 return ERR_PTR(ret);
1150 * mei_cl_flow_ctrl_creds - checks flow_control credits for cl.
1152 * @cl: private data of the file object
1154 * Return: 1 if mei_flow_ctrl_creds >0, 0 - otherwise.
1156 int mei_cl_flow_ctrl_creds(struct mei_cl *cl)
1160 if (WARN_ON(!cl || !cl->me_cl))
1163 if (cl->mei_flow_ctrl_creds > 0)
1166 if (mei_cl_is_fixed_address(cl)) {
1167 rets = mei_cl_read_start(cl, mei_cl_mtu(cl), NULL);
1168 if (rets && rets != -EBUSY)
1173 if (mei_cl_is_single_recv_buf(cl)) {
1174 if (cl->me_cl->mei_flow_ctrl_creds > 0)
1181 * mei_cl_flow_ctrl_reduce - reduces flow_control.
1183 * @cl: private data of the file object
1187 * -EINVAL when ctrl credits are <= 0
1189 int mei_cl_flow_ctrl_reduce(struct mei_cl *cl)
1191 if (WARN_ON(!cl || !cl->me_cl))
1194 if (mei_cl_is_fixed_address(cl))
1197 if (mei_cl_is_single_recv_buf(cl)) {
1198 if (WARN_ON(cl->me_cl->mei_flow_ctrl_creds <= 0))
1200 cl->me_cl->mei_flow_ctrl_creds--;
1202 if (WARN_ON(cl->mei_flow_ctrl_creds <= 0))
1204 cl->mei_flow_ctrl_creds--;
1210 * mei_cl_notify_fop2req - convert fop to proper request
1212 * @fop: client notification start response command
1214 * Return: MEI_HBM_NOTIFICATION_START/STOP
1216 u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop)
1218 if (fop == MEI_FOP_NOTIFY_START)
1219 return MEI_HBM_NOTIFICATION_START;
1221 return MEI_HBM_NOTIFICATION_STOP;
1225 * mei_cl_notify_req2fop - convert notification request top file operation type
1227 * @req: hbm notification request type
1229 * Return: MEI_FOP_NOTIFY_START/STOP
1231 enum mei_cb_file_ops mei_cl_notify_req2fop(u8 req)
1233 if (req == MEI_HBM_NOTIFICATION_START)
1234 return MEI_FOP_NOTIFY_START;
1236 return MEI_FOP_NOTIFY_STOP;
1240 * mei_cl_irq_notify - send notification request in irq_thread context
1243 * @cb: callback block.
1244 * @cmpl_list: complete list.
1246 * Return: 0 on such and error otherwise.
1248 int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb,
1249 struct mei_cl_cb *cmpl_list)
1251 struct mei_device *dev = cl->dev;
1257 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1258 slots = mei_hbuf_empty_slots(dev);
1260 if (slots < msg_slots)
1263 request = mei_cl_notify_fop2req(cb->fop_type);
1264 ret = mei_hbm_cl_notify_req(dev, cl, request);
1267 list_move_tail(&cb->list, &cmpl_list->list);
1271 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
1276 * mei_cl_notify_request - send notification stop/start request
1279 * @file: associate request with file
1280 * @request: 1 for start or 0 for stop
1282 * Locking: called under "dev->device_lock" lock
1284 * Return: 0 on such and error otherwise.
1286 int mei_cl_notify_request(struct mei_cl *cl, struct file *file, u8 request)
1288 struct mei_device *dev;
1289 struct mei_cl_cb *cb;
1290 enum mei_cb_file_ops fop_type;
1293 if (WARN_ON(!cl || !cl->dev))
1298 if (!dev->hbm_f_ev_supported) {
1299 cl_dbg(dev, cl, "notifications not supported\n");
1303 rets = pm_runtime_get(dev->dev);
1304 if (rets < 0 && rets != -EINPROGRESS) {
1305 pm_runtime_put_noidle(dev->dev);
1306 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1310 fop_type = mei_cl_notify_req2fop(request);
1311 cb = mei_io_cb_init(cl, fop_type, file);
1317 if (mei_hbuf_acquire(dev)) {
1318 if (mei_hbm_cl_notify_req(dev, cl, request)) {
1322 list_add_tail(&cb->list, &dev->ctrl_rd_list.list);
1324 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
1327 mutex_unlock(&dev->device_lock);
1328 wait_event_timeout(cl->wait, cl->notify_en == request,
1329 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1330 mutex_lock(&dev->device_lock);
1332 if (cl->notify_en != request) {
1333 mei_io_list_flush(&dev->ctrl_rd_list, cl);
1334 mei_io_list_flush(&dev->ctrl_wr_list, cl);
1336 cl->status = -EFAULT;
1342 cl_dbg(dev, cl, "rpm: autosuspend\n");
1343 pm_runtime_mark_last_busy(dev->dev);
1344 pm_runtime_put_autosuspend(dev->dev);
1351 * mei_cl_notify - raise notification
1355 * Locking: called under "dev->device_lock" lock
1357 void mei_cl_notify(struct mei_cl *cl)
1359 struct mei_device *dev;
1361 if (!cl || !cl->dev)
1369 cl_dbg(dev, cl, "notify event");
1370 cl->notify_ev = true;
1371 wake_up_interruptible_all(&cl->ev_wait);
1374 kill_fasync(&cl->ev_async, SIGIO, POLL_PRI);
1376 mei_cl_bus_notify_event(cl);
1380 * mei_cl_notify_get - get or wait for notification event
1383 * @block: this request is blocking
1384 * @notify_ev: true if notification event was received
1386 * Locking: called under "dev->device_lock" lock
1388 * Return: 0 on such and error otherwise.
1390 int mei_cl_notify_get(struct mei_cl *cl, bool block, bool *notify_ev)
1392 struct mei_device *dev;
1397 if (WARN_ON(!cl || !cl->dev))
1402 if (!mei_cl_is_connected(cl))
1411 mutex_unlock(&dev->device_lock);
1412 rets = wait_event_interruptible(cl->ev_wait, cl->notify_ev);
1413 mutex_lock(&dev->device_lock);
1419 *notify_ev = cl->notify_ev;
1420 cl->notify_ev = false;
1425 * mei_cl_read_start - the start read client message function.
1428 * @length: number of bytes to read
1429 * @fp: pointer to file structure
1431 * Return: 0 on success, <0 on failure.
1433 int mei_cl_read_start(struct mei_cl *cl, size_t length, struct file *fp)
1435 struct mei_device *dev;
1436 struct mei_cl_cb *cb;
1439 if (WARN_ON(!cl || !cl->dev))
1444 if (!mei_cl_is_connected(cl))
1447 /* HW currently supports only one pending read */
1448 if (!list_empty(&cl->rd_pending))
1451 if (!mei_me_cl_is_active(cl->me_cl)) {
1452 cl_err(dev, cl, "no such me client\n");
1456 /* always allocate at least client max message */
1457 length = max_t(size_t, length, mei_cl_mtu(cl));
1458 cb = mei_cl_alloc_cb(cl, length, MEI_FOP_READ, fp);
1462 if (mei_cl_is_fixed_address(cl)) {
1463 list_add_tail(&cb->list, &cl->rd_pending);
1467 rets = pm_runtime_get(dev->dev);
1468 if (rets < 0 && rets != -EINPROGRESS) {
1469 pm_runtime_put_noidle(dev->dev);
1470 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1474 if (mei_hbuf_acquire(dev)) {
1475 rets = mei_hbm_cl_flow_control_req(dev, cl);
1479 list_add_tail(&cb->list, &cl->rd_pending);
1482 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
1486 cl_dbg(dev, cl, "rpm: autosuspend\n");
1487 pm_runtime_mark_last_busy(dev->dev);
1488 pm_runtime_put_autosuspend(dev->dev);
1497 * mei_cl_irq_write - write a message to device
1498 * from the interrupt thread context
1501 * @cb: callback block.
1502 * @cmpl_list: complete list.
1504 * Return: 0, OK; otherwise error.
1506 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
1507 struct mei_cl_cb *cmpl_list)
1509 struct mei_device *dev;
1510 struct mei_msg_data *buf;
1511 struct mei_msg_hdr mei_hdr;
1518 if (WARN_ON(!cl || !cl->dev))
1525 first_chunk = cb->buf_idx == 0;
1527 rets = first_chunk ? mei_cl_flow_ctrl_creds(cl) : 1;
1532 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1536 slots = mei_hbuf_empty_slots(dev);
1537 len = buf->size - cb->buf_idx;
1538 msg_slots = mei_data2slots(len);
1540 mei_hdr.host_addr = mei_cl_host_addr(cl);
1541 mei_hdr.me_addr = mei_cl_me_id(cl);
1542 mei_hdr.reserved = 0;
1543 mei_hdr.internal = cb->internal;
1545 if (slots >= msg_slots) {
1546 mei_hdr.length = len;
1547 mei_hdr.msg_complete = 1;
1548 /* Split the message only if we can write the whole host buffer */
1549 } else if (slots == dev->hbuf_depth) {
1551 len = (slots * sizeof(u32)) - sizeof(struct mei_msg_hdr);
1552 mei_hdr.length = len;
1553 mei_hdr.msg_complete = 0;
1555 /* wait for next time the host buffer is empty */
1559 cl_dbg(dev, cl, "buf: size = %d idx = %lu\n",
1560 cb->buf.size, cb->buf_idx);
1562 rets = mei_write_message(dev, &mei_hdr, buf->data + cb->buf_idx);
1565 list_move_tail(&cb->list, &cmpl_list->list);
1570 cl->writing_state = MEI_WRITING;
1571 cb->buf_idx += mei_hdr.length;
1572 cb->completed = mei_hdr.msg_complete == 1;
1575 if (mei_cl_flow_ctrl_reduce(cl))
1579 if (mei_hdr.msg_complete)
1580 list_move_tail(&cb->list, &dev->write_waiting_list.list);
1586 * mei_cl_write - submit a write cb to mei device
1587 * assumes device_lock is locked
1590 * @cb: write callback with filled data
1591 * @blocking: block until completed
1593 * Return: number of bytes sent on success, <0 on failure.
1595 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking)
1597 struct mei_device *dev;
1598 struct mei_msg_data *buf;
1599 struct mei_msg_hdr mei_hdr;
1604 if (WARN_ON(!cl || !cl->dev))
1615 cl_dbg(dev, cl, "size=%d\n", size);
1617 rets = pm_runtime_get(dev->dev);
1618 if (rets < 0 && rets != -EINPROGRESS) {
1619 pm_runtime_put_noidle(dev->dev);
1620 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1625 cl->writing_state = MEI_IDLE;
1627 mei_hdr.host_addr = mei_cl_host_addr(cl);
1628 mei_hdr.me_addr = mei_cl_me_id(cl);
1629 mei_hdr.reserved = 0;
1630 mei_hdr.msg_complete = 0;
1631 mei_hdr.internal = cb->internal;
1633 rets = mei_cl_flow_ctrl_creds(cl);
1638 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1642 if (!mei_hbuf_acquire(dev)) {
1643 cl_dbg(dev, cl, "Cannot acquire the host buffer: not sending.\n");
1648 /* Check for a maximum length */
1649 if (size > mei_hbuf_max_len(dev)) {
1650 mei_hdr.length = mei_hbuf_max_len(dev);
1651 mei_hdr.msg_complete = 0;
1653 mei_hdr.length = size;
1654 mei_hdr.msg_complete = 1;
1657 rets = mei_write_message(dev, &mei_hdr, buf->data);
1661 rets = mei_cl_flow_ctrl_reduce(cl);
1665 cl->writing_state = MEI_WRITING;
1666 cb->buf_idx = mei_hdr.length;
1667 cb->completed = mei_hdr.msg_complete == 1;
1670 if (mei_hdr.msg_complete)
1671 list_add_tail(&cb->list, &dev->write_waiting_list.list);
1673 list_add_tail(&cb->list, &dev->write_list.list);
1676 if (blocking && cl->writing_state != MEI_WRITE_COMPLETE) {
1678 mutex_unlock(&dev->device_lock);
1679 rets = wait_event_interruptible(cl->tx_wait,
1680 cl->writing_state == MEI_WRITE_COMPLETE);
1681 mutex_lock(&dev->device_lock);
1682 /* wait_event_interruptible returns -ERESTARTSYS */
1684 if (signal_pending(current))
1692 cl_dbg(dev, cl, "rpm: autosuspend\n");
1693 pm_runtime_mark_last_busy(dev->dev);
1694 pm_runtime_put_autosuspend(dev->dev);
1701 * mei_cl_complete - processes completed operation for a client
1703 * @cl: private data of the file object.
1704 * @cb: callback block.
1706 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb)
1708 struct mei_device *dev = cl->dev;
1710 switch (cb->fop_type) {
1713 cl->writing_state = MEI_WRITE_COMPLETE;
1714 if (waitqueue_active(&cl->tx_wait)) {
1715 wake_up_interruptible(&cl->tx_wait);
1717 pm_runtime_mark_last_busy(dev->dev);
1718 pm_request_autosuspend(dev->dev);
1723 list_add_tail(&cb->list, &cl->rd_completed);
1724 if (waitqueue_active(&cl->rx_wait))
1725 wake_up_interruptible_all(&cl->rx_wait);
1727 mei_cl_bus_rx_event(cl);
1730 case MEI_FOP_CONNECT:
1731 case MEI_FOP_DISCONNECT:
1732 case MEI_FOP_NOTIFY_STOP:
1733 case MEI_FOP_NOTIFY_START:
1734 if (waitqueue_active(&cl->wait))
1745 * mei_cl_all_disconnect - disconnect forcefully all connected clients
1749 void mei_cl_all_disconnect(struct mei_device *dev)
1753 list_for_each_entry(cl, &dev->file_list, link)
1754 mei_cl_set_disconnected(cl);
1759 * mei_cl_all_wakeup - wake up all readers and writers they can be interrupted
1763 void mei_cl_all_wakeup(struct mei_device *dev)
1767 list_for_each_entry(cl, &dev->file_list, link) {
1768 if (waitqueue_active(&cl->rx_wait)) {
1769 cl_dbg(dev, cl, "Waking up reading client!\n");
1770 wake_up_interruptible(&cl->rx_wait);
1772 if (waitqueue_active(&cl->tx_wait)) {
1773 cl_dbg(dev, cl, "Waking up writing client!\n");
1774 wake_up_interruptible(&cl->tx_wait);
1777 /* synchronized under device mutex */
1778 if (waitqueue_active(&cl->ev_wait)) {
1779 cl_dbg(dev, cl, "Waking up waiting for event clients!\n");
1780 wake_up_interruptible(&cl->ev_wait);
1786 * mei_cl_all_write_clear - clear all pending writes
1790 void mei_cl_all_write_clear(struct mei_device *dev)
1792 mei_io_list_free(&dev->write_list, NULL);
1793 mei_io_list_free(&dev->write_waiting_list, NULL);