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,
362 const struct file *fp)
364 struct mei_cl_cb *cb;
366 cb = kzalloc(sizeof(struct mei_cl_cb), GFP_KERNEL);
370 INIT_LIST_HEAD(&cb->list);
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,
459 const struct file *fp)
461 struct mei_cl_cb *cb;
463 cb = mei_io_cb_init(cl, type, fp);
467 if (mei_io_cb_alloc_buf(cb, length)) {
476 * mei_cl_read_cb - find this cl's callback in the read list
477 * for a specific file
480 * @fp: file pointer (matching cb file object), may be NULL
482 * Return: cb on success, NULL if cb is not found
484 struct mei_cl_cb *mei_cl_read_cb(const struct mei_cl *cl, const struct file *fp)
486 struct mei_cl_cb *cb;
488 list_for_each_entry(cb, &cl->rd_completed, list)
489 if (!fp || fp == cb->fp)
496 * mei_cl_read_cb_flush - free client's read pending and completed cbs
497 * for a specific file
500 * @fp: file pointer (matching cb file object), may be NULL
502 void mei_cl_read_cb_flush(const struct mei_cl *cl, const struct file *fp)
504 struct mei_cl_cb *cb, *next;
506 list_for_each_entry_safe(cb, next, &cl->rd_completed, list)
507 if (!fp || fp == cb->fp)
511 list_for_each_entry_safe(cb, next, &cl->rd_pending, list)
512 if (!fp || fp == cb->fp)
517 * mei_cl_flush_queues - flushes queue lists belonging to cl.
520 * @fp: file pointer (matching cb file object), may be NULL
522 * Return: 0 on success, -EINVAL if cl or cl->dev is NULL.
524 int mei_cl_flush_queues(struct mei_cl *cl, const struct file *fp)
526 struct mei_device *dev;
528 if (WARN_ON(!cl || !cl->dev))
533 cl_dbg(dev, cl, "remove list entry belonging to cl\n");
534 mei_io_list_free(&cl->dev->write_list, cl);
535 mei_io_list_free(&cl->dev->write_waiting_list, cl);
536 mei_io_list_flush(&cl->dev->ctrl_wr_list, cl);
537 mei_io_list_flush(&cl->dev->ctrl_rd_list, cl);
538 mei_io_list_flush(&cl->dev->amthif_cmd_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
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)
597 struct mei_device *dev;
598 long open_handle_count;
601 if (WARN_ON(!cl || !cl->dev))
606 id = find_first_zero_bit(dev->host_clients_map, MEI_CLIENTS_MAX);
607 if (id >= MEI_CLIENTS_MAX) {
608 dev_err(dev->dev, "id exceeded %d", MEI_CLIENTS_MAX);
612 open_handle_count = dev->open_handle_count + dev->iamthif_open_count;
613 if (open_handle_count >= MEI_MAX_OPEN_HANDLE_COUNT) {
614 dev_err(dev->dev, "open_handle_count exceeded %d",
615 MEI_MAX_OPEN_HANDLE_COUNT);
619 dev->open_handle_count++;
621 cl->host_client_id = id;
622 list_add_tail(&cl->link, &dev->file_list);
624 set_bit(id, dev->host_clients_map);
626 cl->state = MEI_FILE_INITIALIZING;
628 cl_dbg(dev, cl, "link cl\n");
633 * mei_cl_unlink - remove host client from the list
639 int mei_cl_unlink(struct mei_cl *cl)
641 struct mei_device *dev;
643 /* don't shout on error exit path */
647 /* amthif might not be initialized */
653 cl_dbg(dev, cl, "unlink client");
655 if (dev->open_handle_count > 0)
656 dev->open_handle_count--;
658 /* never clear the 0 bit */
659 if (cl->host_client_id)
660 clear_bit(cl->host_client_id, dev->host_clients_map);
662 list_del_init(&cl->link);
664 cl->state = MEI_FILE_INITIALIZING;
669 void mei_host_client_init(struct mei_device *dev)
671 dev->dev_state = MEI_DEV_ENABLED;
672 dev->reset_count = 0;
674 schedule_work(&dev->bus_rescan_work);
676 pm_runtime_mark_last_busy(dev->dev);
677 dev_dbg(dev->dev, "rpm: autosuspend\n");
678 pm_runtime_autosuspend(dev->dev);
682 * mei_hbuf_acquire - try to acquire host buffer
684 * @dev: the device structure
685 * Return: true if host buffer was acquired
687 bool mei_hbuf_acquire(struct mei_device *dev)
689 if (mei_pg_state(dev) == MEI_PG_ON ||
690 mei_pg_in_transition(dev)) {
691 dev_dbg(dev->dev, "device is in pg\n");
695 if (!dev->hbuf_is_ready) {
696 dev_dbg(dev->dev, "hbuf is not ready\n");
700 dev->hbuf_is_ready = false;
706 * mei_cl_wake_all - wake up readers, writers and event waiters so
707 * they can be interrupted
711 static void mei_cl_wake_all(struct mei_cl *cl)
713 struct mei_device *dev = cl->dev;
715 /* synchronized under device mutex */
716 if (waitqueue_active(&cl->rx_wait)) {
717 cl_dbg(dev, cl, "Waking up reading client!\n");
718 wake_up_interruptible(&cl->rx_wait);
720 /* synchronized under device mutex */
721 if (waitqueue_active(&cl->tx_wait)) {
722 cl_dbg(dev, cl, "Waking up writing client!\n");
723 wake_up_interruptible(&cl->tx_wait);
725 /* synchronized under device mutex */
726 if (waitqueue_active(&cl->ev_wait)) {
727 cl_dbg(dev, cl, "Waking up waiting for event clients!\n");
728 wake_up_interruptible(&cl->ev_wait);
730 /* synchronized under device mutex */
731 if (waitqueue_active(&cl->wait)) {
732 cl_dbg(dev, cl, "Waking up ctrl write clients!\n");
733 wake_up_interruptible(&cl->wait);
738 * mei_cl_set_disconnected - set disconnected state and clear
739 * associated states and resources
743 void mei_cl_set_disconnected(struct mei_cl *cl)
745 struct mei_device *dev = cl->dev;
747 if (cl->state == MEI_FILE_DISCONNECTED ||
748 cl->state == MEI_FILE_INITIALIZING)
751 cl->state = MEI_FILE_DISCONNECTED;
752 mei_io_list_free(&dev->write_list, cl);
753 mei_io_list_free(&dev->write_waiting_list, cl);
754 mei_io_list_flush(&dev->ctrl_rd_list, cl);
755 mei_io_list_flush(&dev->ctrl_wr_list, cl);
757 cl->mei_flow_ctrl_creds = 0;
763 if (!WARN_ON(cl->me_cl->connect_count == 0))
764 cl->me_cl->connect_count--;
766 if (cl->me_cl->connect_count == 0)
767 cl->me_cl->mei_flow_ctrl_creds = 0;
769 mei_me_cl_put(cl->me_cl);
773 static int mei_cl_set_connecting(struct mei_cl *cl, struct mei_me_client *me_cl)
775 if (!mei_me_cl_get(me_cl))
778 /* only one connection is allowed for fixed address clients */
779 if (me_cl->props.fixed_address) {
780 if (me_cl->connect_count) {
781 mei_me_cl_put(me_cl);
787 cl->state = MEI_FILE_CONNECTING;
788 cl->me_cl->connect_count++;
794 * mei_cl_send_disconnect - send disconnect request
797 * @cb: callback block
799 * Return: 0, OK; otherwise, error.
801 static int mei_cl_send_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb)
803 struct mei_device *dev;
808 ret = mei_hbm_cl_disconnect_req(dev, cl);
811 cl->state = MEI_FILE_DISCONNECT_REPLY;
815 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
816 cl->timer_count = MEI_CONNECT_TIMEOUT;
822 * mei_cl_irq_disconnect - processes close related operation from
823 * interrupt thread context - send disconnect request
826 * @cb: callback block.
827 * @cmpl_list: complete list.
829 * Return: 0, OK; otherwise, error.
831 int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
832 struct mei_cl_cb *cmpl_list)
834 struct mei_device *dev = cl->dev;
839 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
840 slots = mei_hbuf_empty_slots(dev);
842 if (slots < msg_slots)
845 ret = mei_cl_send_disconnect(cl, cb);
847 list_move_tail(&cb->list, &cmpl_list->list);
853 * __mei_cl_disconnect - disconnect host client from the me one
854 * internal function runtime pm has to be already acquired
858 * Return: 0 on success, <0 on failure.
860 static int __mei_cl_disconnect(struct mei_cl *cl)
862 struct mei_device *dev;
863 struct mei_cl_cb *cb;
868 cl->state = MEI_FILE_DISCONNECTING;
870 cb = mei_io_cb_init(cl, MEI_FOP_DISCONNECT, NULL);
871 rets = cb ? 0 : -ENOMEM;
875 cl_dbg(dev, cl, "add disconnect cb to control write list\n");
876 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
878 if (mei_hbuf_acquire(dev)) {
879 rets = mei_cl_send_disconnect(cl, cb);
881 cl_err(dev, cl, "failed to disconnect.\n");
886 mutex_unlock(&dev->device_lock);
887 wait_event_timeout(cl->wait,
888 cl->state == MEI_FILE_DISCONNECT_REPLY ||
889 cl->state == MEI_FILE_DISCONNECTED,
890 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
891 mutex_lock(&dev->device_lock);
894 if (cl->state != MEI_FILE_DISCONNECT_REPLY &&
895 cl->state != MEI_FILE_DISCONNECTED) {
896 cl_dbg(dev, cl, "timeout on disconnect from FW client.\n");
901 /* we disconnect also on error */
902 mei_cl_set_disconnected(cl);
904 cl_dbg(dev, cl, "successfully disconnected from FW client.\n");
911 * mei_cl_disconnect - disconnect host client from the me one
915 * Locking: called under "dev->device_lock" lock
917 * Return: 0 on success, <0 on failure.
919 int mei_cl_disconnect(struct mei_cl *cl)
921 struct mei_device *dev;
924 if (WARN_ON(!cl || !cl->dev))
929 cl_dbg(dev, cl, "disconnecting");
931 if (!mei_cl_is_connected(cl))
934 if (mei_cl_is_fixed_address(cl)) {
935 mei_cl_set_disconnected(cl);
939 rets = pm_runtime_get(dev->dev);
940 if (rets < 0 && rets != -EINPROGRESS) {
941 pm_runtime_put_noidle(dev->dev);
942 cl_err(dev, cl, "rpm: get failed %d\n", rets);
946 rets = __mei_cl_disconnect(cl);
948 cl_dbg(dev, cl, "rpm: autosuspend\n");
949 pm_runtime_mark_last_busy(dev->dev);
950 pm_runtime_put_autosuspend(dev->dev);
957 * mei_cl_is_other_connecting - checks if other
958 * client with the same me client id is connecting
960 * @cl: private data of the file object
962 * Return: true if other client is connected, false - otherwise.
964 static bool mei_cl_is_other_connecting(struct mei_cl *cl)
966 struct mei_device *dev;
967 struct mei_cl_cb *cb;
971 list_for_each_entry(cb, &dev->ctrl_rd_list.list, list) {
972 if (cb->fop_type == MEI_FOP_CONNECT &&
973 mei_cl_me_id(cl) == mei_cl_me_id(cb->cl))
981 * mei_cl_send_connect - send connect request
984 * @cb: callback block
986 * Return: 0, OK; otherwise, error.
988 static int mei_cl_send_connect(struct mei_cl *cl, struct mei_cl_cb *cb)
990 struct mei_device *dev;
995 ret = mei_hbm_cl_connect_req(dev, cl);
998 cl->state = MEI_FILE_DISCONNECT_REPLY;
1002 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
1003 cl->timer_count = MEI_CONNECT_TIMEOUT;
1008 * mei_cl_irq_connect - send connect request in irq_thread context
1011 * @cb: callback block
1012 * @cmpl_list: complete list
1014 * Return: 0, OK; otherwise, error.
1016 int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
1017 struct mei_cl_cb *cmpl_list)
1019 struct mei_device *dev = cl->dev;
1024 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1025 slots = mei_hbuf_empty_slots(dev);
1027 if (mei_cl_is_other_connecting(cl))
1030 if (slots < msg_slots)
1033 rets = mei_cl_send_connect(cl, cb);
1035 list_move_tail(&cb->list, &cmpl_list->list);
1041 * mei_cl_connect - connect host client to the me one
1045 * @file: pointer to file structure
1047 * Locking: called under "dev->device_lock" lock
1049 * Return: 0 on success, <0 on failure.
1051 int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl,
1052 const struct file *file)
1054 struct mei_device *dev;
1055 struct mei_cl_cb *cb;
1058 if (WARN_ON(!cl || !cl->dev || !me_cl))
1063 rets = mei_cl_set_connecting(cl, me_cl);
1067 if (mei_cl_is_fixed_address(cl)) {
1068 cl->state = MEI_FILE_CONNECTED;
1072 rets = pm_runtime_get(dev->dev);
1073 if (rets < 0 && rets != -EINPROGRESS) {
1074 pm_runtime_put_noidle(dev->dev);
1075 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1079 cb = mei_io_cb_init(cl, MEI_FOP_CONNECT, file);
1080 rets = cb ? 0 : -ENOMEM;
1084 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
1086 /* run hbuf acquire last so we don't have to undo */
1087 if (!mei_cl_is_other_connecting(cl) && mei_hbuf_acquire(dev)) {
1088 rets = mei_cl_send_connect(cl, cb);
1093 mutex_unlock(&dev->device_lock);
1094 wait_event_timeout(cl->wait,
1095 (cl->state == MEI_FILE_CONNECTED ||
1096 cl->state == MEI_FILE_DISCONNECTED ||
1097 cl->state == MEI_FILE_DISCONNECT_REQUIRED ||
1098 cl->state == MEI_FILE_DISCONNECT_REPLY),
1099 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1100 mutex_lock(&dev->device_lock);
1102 if (!mei_cl_is_connected(cl)) {
1103 if (cl->state == MEI_FILE_DISCONNECT_REQUIRED) {
1104 mei_io_list_flush(&dev->ctrl_rd_list, cl);
1105 mei_io_list_flush(&dev->ctrl_wr_list, cl);
1106 /* ignore disconnect return valuue;
1107 * in case of failure reset will be invoked
1109 __mei_cl_disconnect(cl);
1114 /* timeout or something went really wrong */
1116 cl->status = -EFAULT;
1121 cl_dbg(dev, cl, "rpm: autosuspend\n");
1122 pm_runtime_mark_last_busy(dev->dev);
1123 pm_runtime_put_autosuspend(dev->dev);
1128 if (!mei_cl_is_connected(cl))
1129 mei_cl_set_disconnected(cl);
1135 * mei_cl_alloc_linked - allocate and link host client
1137 * @dev: the device structure
1139 * Return: cl on success ERR_PTR on failure
1141 struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev)
1146 cl = mei_cl_allocate(dev);
1152 ret = mei_cl_link(cl);
1159 return ERR_PTR(ret);
1165 * mei_cl_flow_ctrl_creds - checks flow_control credits for cl.
1168 * @fp: the file pointer associated with the pointer
1170 * Return: 1 if mei_flow_ctrl_creds >0, 0 - otherwise.
1172 static int mei_cl_flow_ctrl_creds(struct mei_cl *cl, const struct file *fp)
1176 if (WARN_ON(!cl || !cl->me_cl))
1179 if (cl->mei_flow_ctrl_creds > 0)
1182 if (mei_cl_is_fixed_address(cl)) {
1183 rets = mei_cl_read_start(cl, mei_cl_mtu(cl), fp);
1184 if (rets && rets != -EBUSY)
1189 if (mei_cl_is_single_recv_buf(cl)) {
1190 if (cl->me_cl->mei_flow_ctrl_creds > 0)
1197 * mei_cl_flow_ctrl_reduce - reduces flow_control.
1199 * @cl: private data of the file object
1203 * -EINVAL when ctrl credits are <= 0
1205 static int mei_cl_flow_ctrl_reduce(struct mei_cl *cl)
1207 if (WARN_ON(!cl || !cl->me_cl))
1210 if (mei_cl_is_fixed_address(cl))
1213 if (mei_cl_is_single_recv_buf(cl)) {
1214 if (WARN_ON(cl->me_cl->mei_flow_ctrl_creds <= 0))
1216 cl->me_cl->mei_flow_ctrl_creds--;
1218 if (WARN_ON(cl->mei_flow_ctrl_creds <= 0))
1220 cl->mei_flow_ctrl_creds--;
1226 * mei_cl_notify_fop2req - convert fop to proper request
1228 * @fop: client notification start response command
1230 * Return: MEI_HBM_NOTIFICATION_START/STOP
1232 u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop)
1234 if (fop == MEI_FOP_NOTIFY_START)
1235 return MEI_HBM_NOTIFICATION_START;
1237 return MEI_HBM_NOTIFICATION_STOP;
1241 * mei_cl_notify_req2fop - convert notification request top file operation type
1243 * @req: hbm notification request type
1245 * Return: MEI_FOP_NOTIFY_START/STOP
1247 enum mei_cb_file_ops mei_cl_notify_req2fop(u8 req)
1249 if (req == MEI_HBM_NOTIFICATION_START)
1250 return MEI_FOP_NOTIFY_START;
1252 return MEI_FOP_NOTIFY_STOP;
1256 * mei_cl_irq_notify - send notification request in irq_thread context
1259 * @cb: callback block.
1260 * @cmpl_list: complete list.
1262 * Return: 0 on such and error otherwise.
1264 int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb,
1265 struct mei_cl_cb *cmpl_list)
1267 struct mei_device *dev = cl->dev;
1273 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1274 slots = mei_hbuf_empty_slots(dev);
1276 if (slots < msg_slots)
1279 request = mei_cl_notify_fop2req(cb->fop_type);
1280 ret = mei_hbm_cl_notify_req(dev, cl, request);
1283 list_move_tail(&cb->list, &cmpl_list->list);
1287 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
1292 * mei_cl_notify_request - send notification stop/start request
1295 * @file: associate request with file
1296 * @request: 1 for start or 0 for stop
1298 * Locking: called under "dev->device_lock" lock
1300 * Return: 0 on such and error otherwise.
1302 int mei_cl_notify_request(struct mei_cl *cl,
1303 const struct file *file, u8 request)
1305 struct mei_device *dev;
1306 struct mei_cl_cb *cb;
1307 enum mei_cb_file_ops fop_type;
1310 if (WARN_ON(!cl || !cl->dev))
1315 if (!dev->hbm_f_ev_supported) {
1316 cl_dbg(dev, cl, "notifications not supported\n");
1320 rets = pm_runtime_get(dev->dev);
1321 if (rets < 0 && rets != -EINPROGRESS) {
1322 pm_runtime_put_noidle(dev->dev);
1323 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1327 fop_type = mei_cl_notify_req2fop(request);
1328 cb = mei_io_cb_init(cl, fop_type, file);
1334 if (mei_hbuf_acquire(dev)) {
1335 if (mei_hbm_cl_notify_req(dev, cl, request)) {
1339 list_add_tail(&cb->list, &dev->ctrl_rd_list.list);
1341 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
1344 mutex_unlock(&dev->device_lock);
1345 wait_event_timeout(cl->wait,
1346 cl->notify_en == request || !mei_cl_is_connected(cl),
1347 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1348 mutex_lock(&dev->device_lock);
1350 if (cl->notify_en != request && !cl->status)
1351 cl->status = -EFAULT;
1356 cl_dbg(dev, cl, "rpm: autosuspend\n");
1357 pm_runtime_mark_last_busy(dev->dev);
1358 pm_runtime_put_autosuspend(dev->dev);
1365 * mei_cl_notify - raise notification
1369 * Locking: called under "dev->device_lock" lock
1371 void mei_cl_notify(struct mei_cl *cl)
1373 struct mei_device *dev;
1375 if (!cl || !cl->dev)
1383 cl_dbg(dev, cl, "notify event");
1384 cl->notify_ev = true;
1385 if (!mei_cl_bus_notify_event(cl))
1386 wake_up_interruptible(&cl->ev_wait);
1389 kill_fasync(&cl->ev_async, SIGIO, POLL_PRI);
1394 * mei_cl_notify_get - get or wait for notification event
1397 * @block: this request is blocking
1398 * @notify_ev: true if notification event was received
1400 * Locking: called under "dev->device_lock" lock
1402 * Return: 0 on such and error otherwise.
1404 int mei_cl_notify_get(struct mei_cl *cl, bool block, bool *notify_ev)
1406 struct mei_device *dev;
1411 if (WARN_ON(!cl || !cl->dev))
1416 if (!mei_cl_is_connected(cl))
1425 mutex_unlock(&dev->device_lock);
1426 rets = wait_event_interruptible(cl->ev_wait, cl->notify_ev);
1427 mutex_lock(&dev->device_lock);
1433 *notify_ev = cl->notify_ev;
1434 cl->notify_ev = false;
1439 * mei_cl_is_read_fc_cb - check if read cb is waiting for flow control
1440 * for given host client
1444 * Return: true, if found at least one cb.
1446 static bool mei_cl_is_read_fc_cb(struct mei_cl *cl)
1448 struct mei_device *dev = cl->dev;
1449 struct mei_cl_cb *cb;
1451 list_for_each_entry(cb, &dev->ctrl_wr_list.list, list)
1452 if (cb->fop_type == MEI_FOP_READ && cb->cl == cl)
1458 * mei_cl_read_start - the start read client message function.
1461 * @length: number of bytes to read
1462 * @fp: pointer to file structure
1464 * Return: 0 on success, <0 on failure.
1466 int mei_cl_read_start(struct mei_cl *cl, size_t length, const struct file *fp)
1468 struct mei_device *dev;
1469 struct mei_cl_cb *cb;
1472 if (WARN_ON(!cl || !cl->dev))
1477 if (!mei_cl_is_connected(cl))
1480 /* HW currently supports only one pending read */
1481 if (!list_empty(&cl->rd_pending) || mei_cl_is_read_fc_cb(cl))
1484 if (!mei_me_cl_is_active(cl->me_cl)) {
1485 cl_err(dev, cl, "no such me client\n");
1489 /* always allocate at least client max message */
1490 length = max_t(size_t, length, mei_cl_mtu(cl));
1491 cb = mei_cl_alloc_cb(cl, length, MEI_FOP_READ, fp);
1495 if (mei_cl_is_fixed_address(cl)) {
1496 list_add_tail(&cb->list, &cl->rd_pending);
1500 rets = pm_runtime_get(dev->dev);
1501 if (rets < 0 && rets != -EINPROGRESS) {
1502 pm_runtime_put_noidle(dev->dev);
1503 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1507 if (mei_hbuf_acquire(dev)) {
1508 rets = mei_hbm_cl_flow_control_req(dev, cl);
1512 list_add_tail(&cb->list, &cl->rd_pending);
1515 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
1519 cl_dbg(dev, cl, "rpm: autosuspend\n");
1520 pm_runtime_mark_last_busy(dev->dev);
1521 pm_runtime_put_autosuspend(dev->dev);
1530 * mei_cl_irq_write - write a message to device
1531 * from the interrupt thread context
1534 * @cb: callback block.
1535 * @cmpl_list: complete list.
1537 * Return: 0, OK; otherwise error.
1539 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
1540 struct mei_cl_cb *cmpl_list)
1542 struct mei_device *dev;
1543 struct mei_msg_data *buf;
1544 struct mei_msg_hdr mei_hdr;
1551 if (WARN_ON(!cl || !cl->dev))
1558 first_chunk = cb->buf_idx == 0;
1560 rets = first_chunk ? mei_cl_flow_ctrl_creds(cl, cb->fp) : 1;
1565 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1569 slots = mei_hbuf_empty_slots(dev);
1570 len = buf->size - cb->buf_idx;
1571 msg_slots = mei_data2slots(len);
1573 mei_hdr.host_addr = mei_cl_host_addr(cl);
1574 mei_hdr.me_addr = mei_cl_me_id(cl);
1575 mei_hdr.reserved = 0;
1576 mei_hdr.internal = cb->internal;
1578 if (slots >= msg_slots) {
1579 mei_hdr.length = len;
1580 mei_hdr.msg_complete = 1;
1581 /* Split the message only if we can write the whole host buffer */
1582 } else if (slots == dev->hbuf_depth) {
1584 len = (slots * sizeof(u32)) - sizeof(struct mei_msg_hdr);
1585 mei_hdr.length = len;
1586 mei_hdr.msg_complete = 0;
1588 /* wait for next time the host buffer is empty */
1592 cl_dbg(dev, cl, "buf: size = %zu idx = %zu\n",
1593 cb->buf.size, cb->buf_idx);
1595 rets = mei_write_message(dev, &mei_hdr, buf->data + cb->buf_idx);
1598 list_move_tail(&cb->list, &cmpl_list->list);
1603 cl->writing_state = MEI_WRITING;
1604 cb->buf_idx += mei_hdr.length;
1605 cb->completed = mei_hdr.msg_complete == 1;
1608 if (mei_cl_flow_ctrl_reduce(cl))
1612 if (mei_hdr.msg_complete)
1613 list_move_tail(&cb->list, &dev->write_waiting_list.list);
1619 * mei_cl_write - submit a write cb to mei device
1620 * assumes device_lock is locked
1623 * @cb: write callback with filled data
1624 * @blocking: block until completed
1626 * Return: number of bytes sent on success, <0 on failure.
1628 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking)
1630 struct mei_device *dev;
1631 struct mei_msg_data *buf;
1632 struct mei_msg_hdr mei_hdr;
1637 if (WARN_ON(!cl || !cl->dev))
1648 cl_dbg(dev, cl, "size=%d\n", size);
1650 rets = pm_runtime_get(dev->dev);
1651 if (rets < 0 && rets != -EINPROGRESS) {
1652 pm_runtime_put_noidle(dev->dev);
1653 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1658 cl->writing_state = MEI_IDLE;
1660 mei_hdr.host_addr = mei_cl_host_addr(cl);
1661 mei_hdr.me_addr = mei_cl_me_id(cl);
1662 mei_hdr.reserved = 0;
1663 mei_hdr.msg_complete = 0;
1664 mei_hdr.internal = cb->internal;
1666 rets = mei_cl_flow_ctrl_creds(cl, cb->fp);
1671 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1675 if (!mei_hbuf_acquire(dev)) {
1676 cl_dbg(dev, cl, "Cannot acquire the host buffer: not sending.\n");
1681 /* Check for a maximum length */
1682 if (size > mei_hbuf_max_len(dev)) {
1683 mei_hdr.length = mei_hbuf_max_len(dev);
1684 mei_hdr.msg_complete = 0;
1686 mei_hdr.length = size;
1687 mei_hdr.msg_complete = 1;
1690 rets = mei_write_message(dev, &mei_hdr, buf->data);
1694 rets = mei_cl_flow_ctrl_reduce(cl);
1698 cl->writing_state = MEI_WRITING;
1699 cb->buf_idx = mei_hdr.length;
1700 cb->completed = mei_hdr.msg_complete == 1;
1703 if (mei_hdr.msg_complete)
1704 list_add_tail(&cb->list, &dev->write_waiting_list.list);
1706 list_add_tail(&cb->list, &dev->write_list.list);
1709 if (blocking && cl->writing_state != MEI_WRITE_COMPLETE) {
1711 mutex_unlock(&dev->device_lock);
1712 rets = wait_event_interruptible(cl->tx_wait,
1713 cl->writing_state == MEI_WRITE_COMPLETE ||
1714 (!mei_cl_is_connected(cl)));
1715 mutex_lock(&dev->device_lock);
1716 /* wait_event_interruptible returns -ERESTARTSYS */
1718 if (signal_pending(current))
1722 if (cl->writing_state != MEI_WRITE_COMPLETE) {
1730 cl_dbg(dev, cl, "rpm: autosuspend\n");
1731 pm_runtime_mark_last_busy(dev->dev);
1732 pm_runtime_put_autosuspend(dev->dev);
1741 * mei_cl_complete - processes completed operation for a client
1743 * @cl: private data of the file object.
1744 * @cb: callback block.
1746 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb)
1748 struct mei_device *dev = cl->dev;
1750 switch (cb->fop_type) {
1753 cl->writing_state = MEI_WRITE_COMPLETE;
1754 if (waitqueue_active(&cl->tx_wait)) {
1755 wake_up_interruptible(&cl->tx_wait);
1757 pm_runtime_mark_last_busy(dev->dev);
1758 pm_request_autosuspend(dev->dev);
1763 list_add_tail(&cb->list, &cl->rd_completed);
1764 if (!mei_cl_bus_rx_event(cl))
1765 wake_up_interruptible(&cl->rx_wait);
1768 case MEI_FOP_CONNECT:
1769 case MEI_FOP_DISCONNECT:
1770 case MEI_FOP_NOTIFY_STOP:
1771 case MEI_FOP_NOTIFY_START:
1772 if (waitqueue_active(&cl->wait))
1776 case MEI_FOP_DISCONNECT_RSP:
1778 mei_cl_set_disconnected(cl);
1787 * mei_cl_all_disconnect - disconnect forcefully all connected clients
1791 void mei_cl_all_disconnect(struct mei_device *dev)
1795 list_for_each_entry(cl, &dev->file_list, link)
1796 mei_cl_set_disconnected(cl);