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);
733 * mei_cl_set_disconnected - set disconnected state and clear
734 * associated states and resources
738 void mei_cl_set_disconnected(struct mei_cl *cl)
740 struct mei_device *dev = cl->dev;
742 if (cl->state == MEI_FILE_DISCONNECTED ||
743 cl->state == MEI_FILE_INITIALIZING)
746 cl->state = MEI_FILE_DISCONNECTED;
747 mei_io_list_free(&dev->write_list, cl);
748 mei_io_list_free(&dev->write_waiting_list, cl);
749 mei_io_list_flush(&dev->ctrl_rd_list, cl);
750 mei_io_list_flush(&dev->ctrl_wr_list, cl);
752 cl->mei_flow_ctrl_creds = 0;
758 if (!WARN_ON(cl->me_cl->connect_count == 0))
759 cl->me_cl->connect_count--;
761 if (cl->me_cl->connect_count == 0)
762 cl->me_cl->mei_flow_ctrl_creds = 0;
764 mei_me_cl_put(cl->me_cl);
768 static int mei_cl_set_connecting(struct mei_cl *cl, struct mei_me_client *me_cl)
770 if (!mei_me_cl_get(me_cl))
773 /* only one connection is allowed for fixed address clients */
774 if (me_cl->props.fixed_address) {
775 if (me_cl->connect_count) {
776 mei_me_cl_put(me_cl);
782 cl->state = MEI_FILE_CONNECTING;
783 cl->me_cl->connect_count++;
789 * mei_cl_send_disconnect - send disconnect request
792 * @cb: callback block
794 * Return: 0, OK; otherwise, error.
796 static int mei_cl_send_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb)
798 struct mei_device *dev;
803 ret = mei_hbm_cl_disconnect_req(dev, cl);
806 cl->state = MEI_FILE_DISCONNECT_REPLY;
810 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
811 cl->timer_count = MEI_CONNECT_TIMEOUT;
817 * mei_cl_irq_disconnect - processes close related operation from
818 * interrupt thread context - send disconnect request
821 * @cb: callback block.
822 * @cmpl_list: complete list.
824 * Return: 0, OK; otherwise, error.
826 int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
827 struct mei_cl_cb *cmpl_list)
829 struct mei_device *dev = cl->dev;
834 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
835 slots = mei_hbuf_empty_slots(dev);
837 if (slots < msg_slots)
840 ret = mei_cl_send_disconnect(cl, cb);
842 list_move_tail(&cb->list, &cmpl_list->list);
848 * __mei_cl_disconnect - disconnect host client from the me one
849 * internal function runtime pm has to be already acquired
853 * Return: 0 on success, <0 on failure.
855 static int __mei_cl_disconnect(struct mei_cl *cl)
857 struct mei_device *dev;
858 struct mei_cl_cb *cb;
863 cl->state = MEI_FILE_DISCONNECTING;
865 cb = mei_io_cb_init(cl, MEI_FOP_DISCONNECT, NULL);
866 rets = cb ? 0 : -ENOMEM;
870 cl_dbg(dev, cl, "add disconnect cb to control write list\n");
871 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
873 if (mei_hbuf_acquire(dev)) {
874 rets = mei_cl_send_disconnect(cl, cb);
876 cl_err(dev, cl, "failed to disconnect.\n");
881 mutex_unlock(&dev->device_lock);
882 wait_event_timeout(cl->wait, cl->state == MEI_FILE_DISCONNECT_REPLY,
883 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
884 mutex_lock(&dev->device_lock);
887 if (cl->state != MEI_FILE_DISCONNECT_REPLY) {
888 cl_dbg(dev, cl, "timeout on disconnect from FW client.\n");
893 /* we disconnect also on error */
894 mei_cl_set_disconnected(cl);
896 cl_dbg(dev, cl, "successfully disconnected from FW client.\n");
903 * mei_cl_disconnect - disconnect host client from the me one
907 * Locking: called under "dev->device_lock" lock
909 * Return: 0 on success, <0 on failure.
911 int mei_cl_disconnect(struct mei_cl *cl)
913 struct mei_device *dev;
916 if (WARN_ON(!cl || !cl->dev))
921 cl_dbg(dev, cl, "disconnecting");
923 if (!mei_cl_is_connected(cl))
926 if (mei_cl_is_fixed_address(cl)) {
927 mei_cl_set_disconnected(cl);
931 rets = pm_runtime_get(dev->dev);
932 if (rets < 0 && rets != -EINPROGRESS) {
933 pm_runtime_put_noidle(dev->dev);
934 cl_err(dev, cl, "rpm: get failed %d\n", rets);
938 rets = __mei_cl_disconnect(cl);
940 cl_dbg(dev, cl, "rpm: autosuspend\n");
941 pm_runtime_mark_last_busy(dev->dev);
942 pm_runtime_put_autosuspend(dev->dev);
949 * mei_cl_is_other_connecting - checks if other
950 * client with the same me client id is connecting
952 * @cl: private data of the file object
954 * Return: true if other client is connected, false - otherwise.
956 static bool mei_cl_is_other_connecting(struct mei_cl *cl)
958 struct mei_device *dev;
959 struct mei_cl_cb *cb;
963 list_for_each_entry(cb, &dev->ctrl_rd_list.list, list) {
964 if (cb->fop_type == MEI_FOP_CONNECT &&
965 mei_cl_me_id(cl) == mei_cl_me_id(cb->cl))
973 * mei_cl_send_connect - send connect request
976 * @cb: callback block
978 * Return: 0, OK; otherwise, error.
980 static int mei_cl_send_connect(struct mei_cl *cl, struct mei_cl_cb *cb)
982 struct mei_device *dev;
987 ret = mei_hbm_cl_connect_req(dev, cl);
990 cl->state = MEI_FILE_DISCONNECT_REPLY;
994 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
995 cl->timer_count = MEI_CONNECT_TIMEOUT;
1000 * mei_cl_irq_connect - send connect request in irq_thread context
1003 * @cb: callback block
1004 * @cmpl_list: complete list
1006 * Return: 0, OK; otherwise, error.
1008 int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
1009 struct mei_cl_cb *cmpl_list)
1011 struct mei_device *dev = cl->dev;
1016 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1017 slots = mei_hbuf_empty_slots(dev);
1019 if (mei_cl_is_other_connecting(cl))
1022 if (slots < msg_slots)
1025 rets = mei_cl_send_connect(cl, cb);
1027 list_move_tail(&cb->list, &cmpl_list->list);
1033 * mei_cl_connect - connect host client to the me one
1037 * @file: pointer to file structure
1039 * Locking: called under "dev->device_lock" lock
1041 * Return: 0 on success, <0 on failure.
1043 int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl,
1044 const struct file *file)
1046 struct mei_device *dev;
1047 struct mei_cl_cb *cb;
1050 if (WARN_ON(!cl || !cl->dev || !me_cl))
1055 rets = mei_cl_set_connecting(cl, me_cl);
1059 if (mei_cl_is_fixed_address(cl)) {
1060 cl->state = MEI_FILE_CONNECTED;
1064 rets = pm_runtime_get(dev->dev);
1065 if (rets < 0 && rets != -EINPROGRESS) {
1066 pm_runtime_put_noidle(dev->dev);
1067 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1071 cb = mei_io_cb_init(cl, MEI_FOP_CONNECT, file);
1072 rets = cb ? 0 : -ENOMEM;
1076 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
1078 /* run hbuf acquire last so we don't have to undo */
1079 if (!mei_cl_is_other_connecting(cl) && mei_hbuf_acquire(dev)) {
1080 rets = mei_cl_send_connect(cl, cb);
1085 mutex_unlock(&dev->device_lock);
1086 wait_event_timeout(cl->wait,
1087 (cl->state == MEI_FILE_CONNECTED ||
1088 cl->state == MEI_FILE_DISCONNECT_REQUIRED ||
1089 cl->state == MEI_FILE_DISCONNECT_REPLY),
1090 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1091 mutex_lock(&dev->device_lock);
1093 if (!mei_cl_is_connected(cl)) {
1094 if (cl->state == MEI_FILE_DISCONNECT_REQUIRED) {
1095 mei_io_list_flush(&dev->ctrl_rd_list, cl);
1096 mei_io_list_flush(&dev->ctrl_wr_list, cl);
1097 /* ignore disconnect return valuue;
1098 * in case of failure reset will be invoked
1100 __mei_cl_disconnect(cl);
1105 /* timeout or something went really wrong */
1107 cl->status = -EFAULT;
1112 cl_dbg(dev, cl, "rpm: autosuspend\n");
1113 pm_runtime_mark_last_busy(dev->dev);
1114 pm_runtime_put_autosuspend(dev->dev);
1119 if (!mei_cl_is_connected(cl))
1120 mei_cl_set_disconnected(cl);
1126 * mei_cl_alloc_linked - allocate and link host client
1128 * @dev: the device structure
1130 * Return: cl on success ERR_PTR on failure
1132 struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev)
1137 cl = mei_cl_allocate(dev);
1143 ret = mei_cl_link(cl);
1150 return ERR_PTR(ret);
1156 * mei_cl_flow_ctrl_creds - checks flow_control credits for cl.
1159 * @fp: the file pointer associated with the pointer
1161 * Return: 1 if mei_flow_ctrl_creds >0, 0 - otherwise.
1163 static int mei_cl_flow_ctrl_creds(struct mei_cl *cl, const struct file *fp)
1167 if (WARN_ON(!cl || !cl->me_cl))
1170 if (cl->mei_flow_ctrl_creds > 0)
1173 if (mei_cl_is_fixed_address(cl)) {
1174 rets = mei_cl_read_start(cl, mei_cl_mtu(cl), fp);
1175 if (rets && rets != -EBUSY)
1180 if (mei_cl_is_single_recv_buf(cl)) {
1181 if (cl->me_cl->mei_flow_ctrl_creds > 0)
1188 * mei_cl_flow_ctrl_reduce - reduces flow_control.
1190 * @cl: private data of the file object
1194 * -EINVAL when ctrl credits are <= 0
1196 static int mei_cl_flow_ctrl_reduce(struct mei_cl *cl)
1198 if (WARN_ON(!cl || !cl->me_cl))
1201 if (mei_cl_is_fixed_address(cl))
1204 if (mei_cl_is_single_recv_buf(cl)) {
1205 if (WARN_ON(cl->me_cl->mei_flow_ctrl_creds <= 0))
1207 cl->me_cl->mei_flow_ctrl_creds--;
1209 if (WARN_ON(cl->mei_flow_ctrl_creds <= 0))
1211 cl->mei_flow_ctrl_creds--;
1217 * mei_cl_notify_fop2req - convert fop to proper request
1219 * @fop: client notification start response command
1221 * Return: MEI_HBM_NOTIFICATION_START/STOP
1223 u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop)
1225 if (fop == MEI_FOP_NOTIFY_START)
1226 return MEI_HBM_NOTIFICATION_START;
1228 return MEI_HBM_NOTIFICATION_STOP;
1232 * mei_cl_notify_req2fop - convert notification request top file operation type
1234 * @req: hbm notification request type
1236 * Return: MEI_FOP_NOTIFY_START/STOP
1238 enum mei_cb_file_ops mei_cl_notify_req2fop(u8 req)
1240 if (req == MEI_HBM_NOTIFICATION_START)
1241 return MEI_FOP_NOTIFY_START;
1243 return MEI_FOP_NOTIFY_STOP;
1247 * mei_cl_irq_notify - send notification request in irq_thread context
1250 * @cb: callback block.
1251 * @cmpl_list: complete list.
1253 * Return: 0 on such and error otherwise.
1255 int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb,
1256 struct mei_cl_cb *cmpl_list)
1258 struct mei_device *dev = cl->dev;
1264 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1265 slots = mei_hbuf_empty_slots(dev);
1267 if (slots < msg_slots)
1270 request = mei_cl_notify_fop2req(cb->fop_type);
1271 ret = mei_hbm_cl_notify_req(dev, cl, request);
1274 list_move_tail(&cb->list, &cmpl_list->list);
1278 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
1283 * mei_cl_notify_request - send notification stop/start request
1286 * @file: associate request with file
1287 * @request: 1 for start or 0 for stop
1289 * Locking: called under "dev->device_lock" lock
1291 * Return: 0 on such and error otherwise.
1293 int mei_cl_notify_request(struct mei_cl *cl,
1294 const struct file *file, u8 request)
1296 struct mei_device *dev;
1297 struct mei_cl_cb *cb;
1298 enum mei_cb_file_ops fop_type;
1301 if (WARN_ON(!cl || !cl->dev))
1306 if (!dev->hbm_f_ev_supported) {
1307 cl_dbg(dev, cl, "notifications not supported\n");
1311 rets = pm_runtime_get(dev->dev);
1312 if (rets < 0 && rets != -EINPROGRESS) {
1313 pm_runtime_put_noidle(dev->dev);
1314 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1318 fop_type = mei_cl_notify_req2fop(request);
1319 cb = mei_io_cb_init(cl, fop_type, file);
1325 if (mei_hbuf_acquire(dev)) {
1326 if (mei_hbm_cl_notify_req(dev, cl, request)) {
1330 list_add_tail(&cb->list, &dev->ctrl_rd_list.list);
1332 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
1335 mutex_unlock(&dev->device_lock);
1336 wait_event_timeout(cl->wait, cl->notify_en == request,
1337 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1338 mutex_lock(&dev->device_lock);
1340 if (cl->notify_en != request) {
1341 mei_io_list_flush(&dev->ctrl_rd_list, cl);
1342 mei_io_list_flush(&dev->ctrl_wr_list, cl);
1344 cl->status = -EFAULT;
1350 cl_dbg(dev, cl, "rpm: autosuspend\n");
1351 pm_runtime_mark_last_busy(dev->dev);
1352 pm_runtime_put_autosuspend(dev->dev);
1359 * mei_cl_notify - raise notification
1363 * Locking: called under "dev->device_lock" lock
1365 void mei_cl_notify(struct mei_cl *cl)
1367 struct mei_device *dev;
1369 if (!cl || !cl->dev)
1377 cl_dbg(dev, cl, "notify event");
1378 cl->notify_ev = true;
1379 if (!mei_cl_bus_notify_event(cl))
1380 wake_up_interruptible(&cl->ev_wait);
1383 kill_fasync(&cl->ev_async, SIGIO, POLL_PRI);
1388 * mei_cl_notify_get - get or wait for notification event
1391 * @block: this request is blocking
1392 * @notify_ev: true if notification event was received
1394 * Locking: called under "dev->device_lock" lock
1396 * Return: 0 on such and error otherwise.
1398 int mei_cl_notify_get(struct mei_cl *cl, bool block, bool *notify_ev)
1400 struct mei_device *dev;
1405 if (WARN_ON(!cl || !cl->dev))
1410 if (!mei_cl_is_connected(cl))
1419 mutex_unlock(&dev->device_lock);
1420 rets = wait_event_interruptible(cl->ev_wait, cl->notify_ev);
1421 mutex_lock(&dev->device_lock);
1427 *notify_ev = cl->notify_ev;
1428 cl->notify_ev = false;
1433 * mei_cl_is_read_fc_cb - check if read cb is waiting for flow control
1434 * for given host client
1438 * Return: true, if found at least one cb.
1440 static bool mei_cl_is_read_fc_cb(struct mei_cl *cl)
1442 struct mei_device *dev = cl->dev;
1443 struct mei_cl_cb *cb;
1445 list_for_each_entry(cb, &dev->ctrl_wr_list.list, list)
1446 if (cb->fop_type == MEI_FOP_READ && cb->cl == cl)
1452 * mei_cl_read_start - the start read client message function.
1455 * @length: number of bytes to read
1456 * @fp: pointer to file structure
1458 * Return: 0 on success, <0 on failure.
1460 int mei_cl_read_start(struct mei_cl *cl, size_t length, const struct file *fp)
1462 struct mei_device *dev;
1463 struct mei_cl_cb *cb;
1466 if (WARN_ON(!cl || !cl->dev))
1471 if (!mei_cl_is_connected(cl))
1474 /* HW currently supports only one pending read */
1475 if (!list_empty(&cl->rd_pending) || mei_cl_is_read_fc_cb(cl))
1478 if (!mei_me_cl_is_active(cl->me_cl)) {
1479 cl_err(dev, cl, "no such me client\n");
1483 /* always allocate at least client max message */
1484 length = max_t(size_t, length, mei_cl_mtu(cl));
1485 cb = mei_cl_alloc_cb(cl, length, MEI_FOP_READ, fp);
1489 if (mei_cl_is_fixed_address(cl)) {
1490 list_add_tail(&cb->list, &cl->rd_pending);
1494 rets = pm_runtime_get(dev->dev);
1495 if (rets < 0 && rets != -EINPROGRESS) {
1496 pm_runtime_put_noidle(dev->dev);
1497 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1501 if (mei_hbuf_acquire(dev)) {
1502 rets = mei_hbm_cl_flow_control_req(dev, cl);
1506 list_add_tail(&cb->list, &cl->rd_pending);
1509 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
1513 cl_dbg(dev, cl, "rpm: autosuspend\n");
1514 pm_runtime_mark_last_busy(dev->dev);
1515 pm_runtime_put_autosuspend(dev->dev);
1524 * mei_cl_irq_write - write a message to device
1525 * from the interrupt thread context
1528 * @cb: callback block.
1529 * @cmpl_list: complete list.
1531 * Return: 0, OK; otherwise error.
1533 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
1534 struct mei_cl_cb *cmpl_list)
1536 struct mei_device *dev;
1537 struct mei_msg_data *buf;
1538 struct mei_msg_hdr mei_hdr;
1545 if (WARN_ON(!cl || !cl->dev))
1552 first_chunk = cb->buf_idx == 0;
1554 rets = first_chunk ? mei_cl_flow_ctrl_creds(cl, cb->fp) : 1;
1559 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1563 slots = mei_hbuf_empty_slots(dev);
1564 len = buf->size - cb->buf_idx;
1565 msg_slots = mei_data2slots(len);
1567 mei_hdr.host_addr = mei_cl_host_addr(cl);
1568 mei_hdr.me_addr = mei_cl_me_id(cl);
1569 mei_hdr.reserved = 0;
1570 mei_hdr.internal = cb->internal;
1572 if (slots >= msg_slots) {
1573 mei_hdr.length = len;
1574 mei_hdr.msg_complete = 1;
1575 /* Split the message only if we can write the whole host buffer */
1576 } else if (slots == dev->hbuf_depth) {
1578 len = (slots * sizeof(u32)) - sizeof(struct mei_msg_hdr);
1579 mei_hdr.length = len;
1580 mei_hdr.msg_complete = 0;
1582 /* wait for next time the host buffer is empty */
1586 cl_dbg(dev, cl, "buf: size = %zd idx = %zd\n",
1587 cb->buf.size, cb->buf_idx);
1589 rets = mei_write_message(dev, &mei_hdr, buf->data + cb->buf_idx);
1592 list_move_tail(&cb->list, &cmpl_list->list);
1597 cl->writing_state = MEI_WRITING;
1598 cb->buf_idx += mei_hdr.length;
1599 cb->completed = mei_hdr.msg_complete == 1;
1602 if (mei_cl_flow_ctrl_reduce(cl))
1606 if (mei_hdr.msg_complete)
1607 list_move_tail(&cb->list, &dev->write_waiting_list.list);
1613 * mei_cl_write - submit a write cb to mei device
1614 * assumes device_lock is locked
1617 * @cb: write callback with filled data
1618 * @blocking: block until completed
1620 * Return: number of bytes sent on success, <0 on failure.
1622 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking)
1624 struct mei_device *dev;
1625 struct mei_msg_data *buf;
1626 struct mei_msg_hdr mei_hdr;
1631 if (WARN_ON(!cl || !cl->dev))
1642 cl_dbg(dev, cl, "size=%d\n", size);
1644 rets = pm_runtime_get(dev->dev);
1645 if (rets < 0 && rets != -EINPROGRESS) {
1646 pm_runtime_put_noidle(dev->dev);
1647 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1652 cl->writing_state = MEI_IDLE;
1654 mei_hdr.host_addr = mei_cl_host_addr(cl);
1655 mei_hdr.me_addr = mei_cl_me_id(cl);
1656 mei_hdr.reserved = 0;
1657 mei_hdr.msg_complete = 0;
1658 mei_hdr.internal = cb->internal;
1660 rets = mei_cl_flow_ctrl_creds(cl, cb->fp);
1665 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1669 if (!mei_hbuf_acquire(dev)) {
1670 cl_dbg(dev, cl, "Cannot acquire the host buffer: not sending.\n");
1675 /* Check for a maximum length */
1676 if (size > mei_hbuf_max_len(dev)) {
1677 mei_hdr.length = mei_hbuf_max_len(dev);
1678 mei_hdr.msg_complete = 0;
1680 mei_hdr.length = size;
1681 mei_hdr.msg_complete = 1;
1684 rets = mei_write_message(dev, &mei_hdr, buf->data);
1688 rets = mei_cl_flow_ctrl_reduce(cl);
1692 cl->writing_state = MEI_WRITING;
1693 cb->buf_idx = mei_hdr.length;
1694 cb->completed = mei_hdr.msg_complete == 1;
1697 if (mei_hdr.msg_complete)
1698 list_add_tail(&cb->list, &dev->write_waiting_list.list);
1700 list_add_tail(&cb->list, &dev->write_list.list);
1703 if (blocking && cl->writing_state != MEI_WRITE_COMPLETE) {
1705 mutex_unlock(&dev->device_lock);
1706 rets = wait_event_interruptible(cl->tx_wait,
1707 cl->writing_state == MEI_WRITE_COMPLETE ||
1708 (!mei_cl_is_connected(cl)));
1709 mutex_lock(&dev->device_lock);
1710 /* wait_event_interruptible returns -ERESTARTSYS */
1712 if (signal_pending(current))
1716 if (cl->writing_state != MEI_WRITE_COMPLETE) {
1724 cl_dbg(dev, cl, "rpm: autosuspend\n");
1725 pm_runtime_mark_last_busy(dev->dev);
1726 pm_runtime_put_autosuspend(dev->dev);
1735 * mei_cl_complete - processes completed operation for a client
1737 * @cl: private data of the file object.
1738 * @cb: callback block.
1740 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb)
1742 struct mei_device *dev = cl->dev;
1744 switch (cb->fop_type) {
1747 cl->writing_state = MEI_WRITE_COMPLETE;
1748 if (waitqueue_active(&cl->tx_wait)) {
1749 wake_up_interruptible(&cl->tx_wait);
1751 pm_runtime_mark_last_busy(dev->dev);
1752 pm_request_autosuspend(dev->dev);
1757 list_add_tail(&cb->list, &cl->rd_completed);
1758 if (!mei_cl_bus_rx_event(cl))
1759 wake_up_interruptible(&cl->rx_wait);
1762 case MEI_FOP_CONNECT:
1763 case MEI_FOP_DISCONNECT:
1764 case MEI_FOP_NOTIFY_STOP:
1765 case MEI_FOP_NOTIFY_START:
1766 if (waitqueue_active(&cl->wait))
1777 * mei_cl_all_disconnect - disconnect forcefully all connected clients
1781 void mei_cl_all_disconnect(struct mei_device *dev)
1785 list_for_each_entry(cl, &dev->file_list, link)
1786 mei_cl_set_disconnected(cl);