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/signal.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_tx_cb_queue - queue tx callback
355 * Locking: called under "dev->device_lock" lock
357 * @cb: mei callback struct
358 * @head: an instance of list to queue on
360 static inline void mei_tx_cb_enqueue(struct mei_cl_cb *cb,
361 struct list_head *head)
363 list_add_tail(&cb->list, head);
364 cb->cl->tx_cb_queued++;
368 * mei_tx_cb_dequeue - dequeue tx callback
370 * Locking: called under "dev->device_lock" lock
372 * @cb: mei callback struct to dequeue and free
374 static inline void mei_tx_cb_dequeue(struct mei_cl_cb *cb)
376 if (!WARN_ON(cb->cl->tx_cb_queued == 0))
377 cb->cl->tx_cb_queued--;
383 * mei_io_cb_init - allocate and initialize io callback
386 * @type: operation type
387 * @fp: pointer to file structure
389 * Return: mei_cl_cb pointer or NULL;
391 static struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl,
392 enum mei_cb_file_ops type,
393 const struct file *fp)
395 struct mei_cl_cb *cb;
397 cb = kzalloc(sizeof(struct mei_cl_cb), GFP_KERNEL);
401 INIT_LIST_HEAD(&cb->list);
410 * mei_io_list_flush_cl - removes cbs belonging to the cl.
412 * @head: an instance of our list structure
415 static void mei_io_list_flush_cl(struct list_head *head,
416 const struct mei_cl *cl)
418 struct mei_cl_cb *cb, *next;
420 list_for_each_entry_safe(cb, next, head, list) {
421 if (mei_cl_cmp_id(cl, cb->cl))
422 list_del_init(&cb->list);
427 * mei_io_tx_list_free_cl - removes cb belonging to the cl and free them
429 * @head: An instance of our list structure
432 static void mei_io_tx_list_free_cl(struct list_head *head,
433 const struct mei_cl *cl)
435 struct mei_cl_cb *cb, *next;
437 list_for_each_entry_safe(cb, next, head, list) {
438 if (mei_cl_cmp_id(cl, cb->cl))
439 mei_tx_cb_dequeue(cb);
444 * mei_io_list_free_fp - free cb from a list that matches file pointer
447 * @fp: file pointer (matching cb file object), may be NULL
449 static void mei_io_list_free_fp(struct list_head *head, const struct file *fp)
451 struct mei_cl_cb *cb, *next;
453 list_for_each_entry_safe(cb, next, head, list)
454 if (!fp || fp == cb->fp)
459 * mei_cl_alloc_cb - a convenient wrapper for allocating read cb
462 * @length: size of the buffer
463 * @fop_type: operation type
464 * @fp: associated file pointer (might be NULL)
466 * Return: cb on success and NULL on failure
468 struct mei_cl_cb *mei_cl_alloc_cb(struct mei_cl *cl, size_t length,
469 enum mei_cb_file_ops fop_type,
470 const struct file *fp)
472 struct mei_cl_cb *cb;
474 cb = mei_io_cb_init(cl, fop_type, fp);
481 cb->buf.data = kmalloc(length, GFP_KERNEL);
486 cb->buf.size = length;
492 * mei_cl_enqueue_ctrl_wr_cb - a convenient wrapper for allocating
493 * and enqueuing of the control commands cb
496 * @length: size of the buffer
497 * @fop_type: operation type
498 * @fp: associated file pointer (might be NULL)
500 * Return: cb on success and NULL on failure
501 * Locking: called under "dev->device_lock" lock
503 struct mei_cl_cb *mei_cl_enqueue_ctrl_wr_cb(struct mei_cl *cl, size_t length,
504 enum mei_cb_file_ops fop_type,
505 const struct file *fp)
507 struct mei_cl_cb *cb;
509 /* for RX always allocate at least client's mtu */
511 length = max_t(size_t, length, mei_cl_mtu(cl));
513 cb = mei_cl_alloc_cb(cl, length, fop_type, fp);
517 list_add_tail(&cb->list, &cl->dev->ctrl_wr_list);
522 * mei_cl_read_cb - find this cl's callback in the read list
523 * for a specific file
526 * @fp: file pointer (matching cb file object), may be NULL
528 * Return: cb on success, NULL if cb is not found
530 struct mei_cl_cb *mei_cl_read_cb(const struct mei_cl *cl, const struct file *fp)
532 struct mei_cl_cb *cb;
534 list_for_each_entry(cb, &cl->rd_completed, list)
535 if (!fp || fp == cb->fp)
542 * mei_cl_flush_queues - flushes queue lists belonging to cl.
545 * @fp: file pointer (matching cb file object), may be NULL
547 * Return: 0 on success, -EINVAL if cl or cl->dev is NULL.
549 int mei_cl_flush_queues(struct mei_cl *cl, const struct file *fp)
551 struct mei_device *dev;
553 if (WARN_ON(!cl || !cl->dev))
558 cl_dbg(dev, cl, "remove list entry belonging to cl\n");
559 mei_io_tx_list_free_cl(&cl->dev->write_list, cl);
560 mei_io_tx_list_free_cl(&cl->dev->write_waiting_list, cl);
561 mei_io_list_flush_cl(&cl->dev->ctrl_wr_list, cl);
562 mei_io_list_flush_cl(&cl->dev->ctrl_rd_list, cl);
563 mei_io_list_free_fp(&cl->rd_pending, fp);
564 mei_io_list_free_fp(&cl->rd_completed, fp);
570 * mei_cl_init - initializes cl.
572 * @cl: host client to be initialized
575 static void mei_cl_init(struct mei_cl *cl, struct mei_device *dev)
577 memset(cl, 0, sizeof(struct mei_cl));
578 init_waitqueue_head(&cl->wait);
579 init_waitqueue_head(&cl->rx_wait);
580 init_waitqueue_head(&cl->tx_wait);
581 init_waitqueue_head(&cl->ev_wait);
582 INIT_LIST_HEAD(&cl->rd_completed);
583 INIT_LIST_HEAD(&cl->rd_pending);
584 INIT_LIST_HEAD(&cl->link);
585 cl->writing_state = MEI_IDLE;
586 cl->state = MEI_FILE_UNINITIALIZED;
591 * mei_cl_allocate - allocates cl structure and sets it up.
594 * Return: The allocated file or NULL on failure
596 struct mei_cl *mei_cl_allocate(struct mei_device *dev)
600 cl = kmalloc(sizeof(struct mei_cl), GFP_KERNEL);
604 mei_cl_init(cl, dev);
610 * mei_cl_link - allocate host id in the host map
614 * Return: 0 on success
615 * -EINVAL on incorrect values
616 * -EMFILE if open count exceeded.
618 int mei_cl_link(struct mei_cl *cl)
620 struct mei_device *dev;
623 if (WARN_ON(!cl || !cl->dev))
628 id = find_first_zero_bit(dev->host_clients_map, MEI_CLIENTS_MAX);
629 if (id >= MEI_CLIENTS_MAX) {
630 dev_err(dev->dev, "id exceeded %d", MEI_CLIENTS_MAX);
634 if (dev->open_handle_count >= MEI_MAX_OPEN_HANDLE_COUNT) {
635 dev_err(dev->dev, "open_handle_count exceeded %d",
636 MEI_MAX_OPEN_HANDLE_COUNT);
640 dev->open_handle_count++;
642 cl->host_client_id = id;
643 list_add_tail(&cl->link, &dev->file_list);
645 set_bit(id, dev->host_clients_map);
647 cl->state = MEI_FILE_INITIALIZING;
649 cl_dbg(dev, cl, "link cl\n");
654 * mei_cl_unlink - remove host client from the list
660 int mei_cl_unlink(struct mei_cl *cl)
662 struct mei_device *dev;
664 /* don't shout on error exit path */
668 if (WARN_ON(!cl->dev))
673 cl_dbg(dev, cl, "unlink client");
675 if (dev->open_handle_count > 0)
676 dev->open_handle_count--;
678 /* never clear the 0 bit */
679 if (cl->host_client_id)
680 clear_bit(cl->host_client_id, dev->host_clients_map);
682 list_del_init(&cl->link);
684 cl->state = MEI_FILE_UNINITIALIZED;
685 cl->writing_state = MEI_IDLE;
687 WARN_ON(!list_empty(&cl->rd_completed) ||
688 !list_empty(&cl->rd_pending) ||
689 !list_empty(&cl->link));
694 void mei_host_client_init(struct mei_device *dev)
696 dev->dev_state = MEI_DEV_ENABLED;
697 dev->reset_count = 0;
699 schedule_work(&dev->bus_rescan_work);
701 pm_runtime_mark_last_busy(dev->dev);
702 dev_dbg(dev->dev, "rpm: autosuspend\n");
703 pm_request_autosuspend(dev->dev);
707 * mei_hbuf_acquire - try to acquire host buffer
709 * @dev: the device structure
710 * Return: true if host buffer was acquired
712 bool mei_hbuf_acquire(struct mei_device *dev)
714 if (mei_pg_state(dev) == MEI_PG_ON ||
715 mei_pg_in_transition(dev)) {
716 dev_dbg(dev->dev, "device is in pg\n");
720 if (!dev->hbuf_is_ready) {
721 dev_dbg(dev->dev, "hbuf is not ready\n");
725 dev->hbuf_is_ready = false;
731 * mei_cl_wake_all - wake up readers, writers and event waiters so
732 * they can be interrupted
736 static void mei_cl_wake_all(struct mei_cl *cl)
738 struct mei_device *dev = cl->dev;
740 /* synchronized under device mutex */
741 if (waitqueue_active(&cl->rx_wait)) {
742 cl_dbg(dev, cl, "Waking up reading client!\n");
743 wake_up_interruptible(&cl->rx_wait);
745 /* synchronized under device mutex */
746 if (waitqueue_active(&cl->tx_wait)) {
747 cl_dbg(dev, cl, "Waking up writing client!\n");
748 wake_up_interruptible(&cl->tx_wait);
750 /* synchronized under device mutex */
751 if (waitqueue_active(&cl->ev_wait)) {
752 cl_dbg(dev, cl, "Waking up waiting for event clients!\n");
753 wake_up_interruptible(&cl->ev_wait);
755 /* synchronized under device mutex */
756 if (waitqueue_active(&cl->wait)) {
757 cl_dbg(dev, cl, "Waking up ctrl write clients!\n");
763 * mei_cl_set_disconnected - set disconnected state and clear
764 * associated states and resources
768 static void mei_cl_set_disconnected(struct mei_cl *cl)
770 struct mei_device *dev = cl->dev;
772 if (cl->state == MEI_FILE_DISCONNECTED ||
773 cl->state <= MEI_FILE_INITIALIZING)
776 cl->state = MEI_FILE_DISCONNECTED;
777 mei_io_tx_list_free_cl(&dev->write_list, cl);
778 mei_io_tx_list_free_cl(&dev->write_waiting_list, cl);
779 mei_io_list_flush_cl(&dev->ctrl_rd_list, cl);
780 mei_io_list_flush_cl(&dev->ctrl_wr_list, cl);
782 cl->rx_flow_ctrl_creds = 0;
783 cl->tx_flow_ctrl_creds = 0;
789 if (!WARN_ON(cl->me_cl->connect_count == 0))
790 cl->me_cl->connect_count--;
792 if (cl->me_cl->connect_count == 0)
793 cl->me_cl->tx_flow_ctrl_creds = 0;
795 mei_me_cl_put(cl->me_cl);
799 static int mei_cl_set_connecting(struct mei_cl *cl, struct mei_me_client *me_cl)
801 if (!mei_me_cl_get(me_cl))
804 /* only one connection is allowed for fixed address clients */
805 if (me_cl->props.fixed_address) {
806 if (me_cl->connect_count) {
807 mei_me_cl_put(me_cl);
813 cl->state = MEI_FILE_CONNECTING;
814 cl->me_cl->connect_count++;
820 * mei_cl_send_disconnect - send disconnect request
823 * @cb: callback block
825 * Return: 0, OK; otherwise, error.
827 static int mei_cl_send_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb)
829 struct mei_device *dev;
834 ret = mei_hbm_cl_disconnect_req(dev, cl);
837 cl->state = MEI_FILE_DISCONNECT_REPLY;
841 list_move_tail(&cb->list, &dev->ctrl_rd_list);
842 cl->timer_count = MEI_CONNECT_TIMEOUT;
843 mei_schedule_stall_timer(dev);
849 * mei_cl_irq_disconnect - processes close related operation from
850 * interrupt thread context - send disconnect request
853 * @cb: callback block.
854 * @cmpl_list: complete list.
856 * Return: 0, OK; otherwise, error.
858 int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
859 struct list_head *cmpl_list)
861 struct mei_device *dev = cl->dev;
866 msg_slots = mei_hbm2slots(sizeof(struct hbm_client_connect_request));
867 slots = mei_hbuf_empty_slots(dev);
871 if ((u32)slots < msg_slots)
874 ret = mei_cl_send_disconnect(cl, cb);
876 list_move_tail(&cb->list, cmpl_list);
882 * __mei_cl_disconnect - disconnect host client from the me one
883 * internal function runtime pm has to be already acquired
887 * Return: 0 on success, <0 on failure.
889 static int __mei_cl_disconnect(struct mei_cl *cl)
891 struct mei_device *dev;
892 struct mei_cl_cb *cb;
897 cl->state = MEI_FILE_DISCONNECTING;
899 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, MEI_FOP_DISCONNECT, NULL);
905 if (mei_hbuf_acquire(dev)) {
906 rets = mei_cl_send_disconnect(cl, cb);
908 cl_err(dev, cl, "failed to disconnect.\n");
913 mutex_unlock(&dev->device_lock);
914 wait_event_timeout(cl->wait,
915 cl->state == MEI_FILE_DISCONNECT_REPLY ||
916 cl->state == MEI_FILE_DISCONNECTED,
917 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
918 mutex_lock(&dev->device_lock);
921 if (cl->state != MEI_FILE_DISCONNECT_REPLY &&
922 cl->state != MEI_FILE_DISCONNECTED) {
923 cl_dbg(dev, cl, "timeout on disconnect from FW client.\n");
928 /* we disconnect also on error */
929 mei_cl_set_disconnected(cl);
931 cl_dbg(dev, cl, "successfully disconnected from FW client.\n");
938 * mei_cl_disconnect - disconnect host client from the me one
942 * Locking: called under "dev->device_lock" lock
944 * Return: 0 on success, <0 on failure.
946 int mei_cl_disconnect(struct mei_cl *cl)
948 struct mei_device *dev;
951 if (WARN_ON(!cl || !cl->dev))
956 cl_dbg(dev, cl, "disconnecting");
958 if (!mei_cl_is_connected(cl))
961 if (mei_cl_is_fixed_address(cl)) {
962 mei_cl_set_disconnected(cl);
966 if (dev->dev_state == MEI_DEV_POWER_DOWN) {
967 cl_dbg(dev, cl, "Device is powering down, don't bother with disconnection\n");
968 mei_cl_set_disconnected(cl);
972 rets = pm_runtime_get(dev->dev);
973 if (rets < 0 && rets != -EINPROGRESS) {
974 pm_runtime_put_noidle(dev->dev);
975 cl_err(dev, cl, "rpm: get failed %d\n", rets);
979 rets = __mei_cl_disconnect(cl);
981 cl_dbg(dev, cl, "rpm: autosuspend\n");
982 pm_runtime_mark_last_busy(dev->dev);
983 pm_runtime_put_autosuspend(dev->dev);
990 * mei_cl_is_other_connecting - checks if other
991 * client with the same me client id is connecting
993 * @cl: private data of the file object
995 * Return: true if other client is connected, false - otherwise.
997 static bool mei_cl_is_other_connecting(struct mei_cl *cl)
999 struct mei_device *dev;
1000 struct mei_cl_cb *cb;
1004 list_for_each_entry(cb, &dev->ctrl_rd_list, list) {
1005 if (cb->fop_type == MEI_FOP_CONNECT &&
1006 mei_cl_me_id(cl) == mei_cl_me_id(cb->cl))
1014 * mei_cl_send_connect - send connect request
1017 * @cb: callback block
1019 * Return: 0, OK; otherwise, error.
1021 static int mei_cl_send_connect(struct mei_cl *cl, struct mei_cl_cb *cb)
1023 struct mei_device *dev;
1028 ret = mei_hbm_cl_connect_req(dev, cl);
1031 cl->state = MEI_FILE_DISCONNECT_REPLY;
1035 list_move_tail(&cb->list, &dev->ctrl_rd_list);
1036 cl->timer_count = MEI_CONNECT_TIMEOUT;
1037 mei_schedule_stall_timer(dev);
1042 * mei_cl_irq_connect - send connect request in irq_thread context
1045 * @cb: callback block
1046 * @cmpl_list: complete list
1048 * Return: 0, OK; otherwise, error.
1050 int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
1051 struct list_head *cmpl_list)
1053 struct mei_device *dev = cl->dev;
1058 if (mei_cl_is_other_connecting(cl))
1061 msg_slots = mei_hbm2slots(sizeof(struct hbm_client_connect_request));
1062 slots = mei_hbuf_empty_slots(dev);
1066 if ((u32)slots < msg_slots)
1069 rets = mei_cl_send_connect(cl, cb);
1071 list_move_tail(&cb->list, cmpl_list);
1077 * mei_cl_connect - connect host client to the me one
1081 * @fp: pointer to file structure
1083 * Locking: called under "dev->device_lock" lock
1085 * Return: 0 on success, <0 on failure.
1087 int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl,
1088 const struct file *fp)
1090 struct mei_device *dev;
1091 struct mei_cl_cb *cb;
1094 if (WARN_ON(!cl || !cl->dev || !me_cl))
1099 rets = mei_cl_set_connecting(cl, me_cl);
1103 if (mei_cl_is_fixed_address(cl)) {
1104 cl->state = MEI_FILE_CONNECTED;
1109 rets = pm_runtime_get(dev->dev);
1110 if (rets < 0 && rets != -EINPROGRESS) {
1111 pm_runtime_put_noidle(dev->dev);
1112 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1116 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, MEI_FOP_CONNECT, fp);
1122 /* run hbuf acquire last so we don't have to undo */
1123 if (!mei_cl_is_other_connecting(cl) && mei_hbuf_acquire(dev)) {
1124 rets = mei_cl_send_connect(cl, cb);
1129 mutex_unlock(&dev->device_lock);
1130 wait_event_timeout(cl->wait,
1131 (cl->state == MEI_FILE_CONNECTED ||
1132 cl->state == MEI_FILE_DISCONNECTED ||
1133 cl->state == MEI_FILE_DISCONNECT_REQUIRED ||
1134 cl->state == MEI_FILE_DISCONNECT_REPLY),
1135 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1136 mutex_lock(&dev->device_lock);
1138 if (!mei_cl_is_connected(cl)) {
1139 if (cl->state == MEI_FILE_DISCONNECT_REQUIRED) {
1140 mei_io_list_flush_cl(&dev->ctrl_rd_list, cl);
1141 mei_io_list_flush_cl(&dev->ctrl_wr_list, cl);
1142 /* ignore disconnect return valuue;
1143 * in case of failure reset will be invoked
1145 __mei_cl_disconnect(cl);
1150 /* timeout or something went really wrong */
1152 cl->status = -EFAULT;
1157 cl_dbg(dev, cl, "rpm: autosuspend\n");
1158 pm_runtime_mark_last_busy(dev->dev);
1159 pm_runtime_put_autosuspend(dev->dev);
1164 if (!mei_cl_is_connected(cl))
1165 mei_cl_set_disconnected(cl);
1171 * mei_cl_alloc_linked - allocate and link host client
1173 * @dev: the device structure
1175 * Return: cl on success ERR_PTR on failure
1177 struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev)
1182 cl = mei_cl_allocate(dev);
1188 ret = mei_cl_link(cl);
1195 return ERR_PTR(ret);
1199 * mei_cl_tx_flow_ctrl_creds - checks flow_control credits for cl.
1203 * Return: 1 if tx_flow_ctrl_creds >0, 0 - otherwise.
1205 static int mei_cl_tx_flow_ctrl_creds(struct mei_cl *cl)
1207 if (WARN_ON(!cl || !cl->me_cl))
1210 if (cl->tx_flow_ctrl_creds > 0)
1213 if (mei_cl_is_fixed_address(cl))
1216 if (mei_cl_is_single_recv_buf(cl)) {
1217 if (cl->me_cl->tx_flow_ctrl_creds > 0)
1224 * mei_cl_tx_flow_ctrl_creds_reduce - reduces transmit flow control credits
1231 * -EINVAL when ctrl credits are <= 0
1233 static int mei_cl_tx_flow_ctrl_creds_reduce(struct mei_cl *cl)
1235 if (WARN_ON(!cl || !cl->me_cl))
1238 if (mei_cl_is_fixed_address(cl))
1241 if (mei_cl_is_single_recv_buf(cl)) {
1242 if (WARN_ON(cl->me_cl->tx_flow_ctrl_creds <= 0))
1244 cl->me_cl->tx_flow_ctrl_creds--;
1246 if (WARN_ON(cl->tx_flow_ctrl_creds <= 0))
1248 cl->tx_flow_ctrl_creds--;
1254 * mei_cl_notify_fop2req - convert fop to proper request
1256 * @fop: client notification start response command
1258 * Return: MEI_HBM_NOTIFICATION_START/STOP
1260 u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop)
1262 if (fop == MEI_FOP_NOTIFY_START)
1263 return MEI_HBM_NOTIFICATION_START;
1265 return MEI_HBM_NOTIFICATION_STOP;
1269 * mei_cl_notify_req2fop - convert notification request top file operation type
1271 * @req: hbm notification request type
1273 * Return: MEI_FOP_NOTIFY_START/STOP
1275 enum mei_cb_file_ops mei_cl_notify_req2fop(u8 req)
1277 if (req == MEI_HBM_NOTIFICATION_START)
1278 return MEI_FOP_NOTIFY_START;
1280 return MEI_FOP_NOTIFY_STOP;
1284 * mei_cl_irq_notify - send notification request in irq_thread context
1287 * @cb: callback block.
1288 * @cmpl_list: complete list.
1290 * Return: 0 on such and error otherwise.
1292 int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb,
1293 struct list_head *cmpl_list)
1295 struct mei_device *dev = cl->dev;
1301 msg_slots = mei_hbm2slots(sizeof(struct hbm_client_connect_request));
1302 slots = mei_hbuf_empty_slots(dev);
1306 if ((u32)slots < msg_slots)
1309 request = mei_cl_notify_fop2req(cb->fop_type);
1310 ret = mei_hbm_cl_notify_req(dev, cl, request);
1313 list_move_tail(&cb->list, cmpl_list);
1317 list_move_tail(&cb->list, &dev->ctrl_rd_list);
1322 * mei_cl_notify_request - send notification stop/start request
1325 * @fp: associate request with file
1326 * @request: 1 for start or 0 for stop
1328 * Locking: called under "dev->device_lock" lock
1330 * Return: 0 on such and error otherwise.
1332 int mei_cl_notify_request(struct mei_cl *cl,
1333 const struct file *fp, u8 request)
1335 struct mei_device *dev;
1336 struct mei_cl_cb *cb;
1337 enum mei_cb_file_ops fop_type;
1340 if (WARN_ON(!cl || !cl->dev))
1345 if (!dev->hbm_f_ev_supported) {
1346 cl_dbg(dev, cl, "notifications not supported\n");
1350 if (!mei_cl_is_connected(cl))
1353 rets = pm_runtime_get(dev->dev);
1354 if (rets < 0 && rets != -EINPROGRESS) {
1355 pm_runtime_put_noidle(dev->dev);
1356 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1360 fop_type = mei_cl_notify_req2fop(request);
1361 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, fop_type, fp);
1367 if (mei_hbuf_acquire(dev)) {
1368 if (mei_hbm_cl_notify_req(dev, cl, request)) {
1372 list_move_tail(&cb->list, &dev->ctrl_rd_list);
1375 mutex_unlock(&dev->device_lock);
1376 wait_event_timeout(cl->wait,
1377 cl->notify_en == request || !mei_cl_is_connected(cl),
1378 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1379 mutex_lock(&dev->device_lock);
1381 if (cl->notify_en != request && !cl->status)
1382 cl->status = -EFAULT;
1387 cl_dbg(dev, cl, "rpm: autosuspend\n");
1388 pm_runtime_mark_last_busy(dev->dev);
1389 pm_runtime_put_autosuspend(dev->dev);
1396 * mei_cl_notify - raise notification
1400 * Locking: called under "dev->device_lock" lock
1402 void mei_cl_notify(struct mei_cl *cl)
1404 struct mei_device *dev;
1406 if (!cl || !cl->dev)
1414 cl_dbg(dev, cl, "notify event");
1415 cl->notify_ev = true;
1416 if (!mei_cl_bus_notify_event(cl))
1417 wake_up_interruptible(&cl->ev_wait);
1420 kill_fasync(&cl->ev_async, SIGIO, POLL_PRI);
1425 * mei_cl_notify_get - get or wait for notification event
1428 * @block: this request is blocking
1429 * @notify_ev: true if notification event was received
1431 * Locking: called under "dev->device_lock" lock
1433 * Return: 0 on such and error otherwise.
1435 int mei_cl_notify_get(struct mei_cl *cl, bool block, bool *notify_ev)
1437 struct mei_device *dev;
1442 if (WARN_ON(!cl || !cl->dev))
1447 if (!dev->hbm_f_ev_supported) {
1448 cl_dbg(dev, cl, "notifications not supported\n");
1452 if (!mei_cl_is_connected(cl))
1461 mutex_unlock(&dev->device_lock);
1462 rets = wait_event_interruptible(cl->ev_wait, cl->notify_ev);
1463 mutex_lock(&dev->device_lock);
1469 *notify_ev = cl->notify_ev;
1470 cl->notify_ev = false;
1475 * mei_cl_read_start - the start read client message function.
1478 * @length: number of bytes to read
1479 * @fp: pointer to file structure
1481 * Return: 0 on success, <0 on failure.
1483 int mei_cl_read_start(struct mei_cl *cl, size_t length, const struct file *fp)
1485 struct mei_device *dev;
1486 struct mei_cl_cb *cb;
1489 if (WARN_ON(!cl || !cl->dev))
1494 if (!mei_cl_is_connected(cl))
1497 if (!mei_me_cl_is_active(cl->me_cl)) {
1498 cl_err(dev, cl, "no such me client\n");
1502 if (mei_cl_is_fixed_address(cl))
1505 /* HW currently supports only one pending read */
1506 if (cl->rx_flow_ctrl_creds)
1509 cb = mei_cl_enqueue_ctrl_wr_cb(cl, length, MEI_FOP_READ, fp);
1513 rets = pm_runtime_get(dev->dev);
1514 if (rets < 0 && rets != -EINPROGRESS) {
1515 pm_runtime_put_noidle(dev->dev);
1516 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1521 if (mei_hbuf_acquire(dev)) {
1522 rets = mei_hbm_cl_flow_control_req(dev, cl);
1526 list_move_tail(&cb->list, &cl->rd_pending);
1528 cl->rx_flow_ctrl_creds++;
1531 cl_dbg(dev, cl, "rpm: autosuspend\n");
1532 pm_runtime_mark_last_busy(dev->dev);
1533 pm_runtime_put_autosuspend(dev->dev);
1542 * mei_msg_hdr_init - initialize mei message header
1544 * @mei_hdr: mei message header
1545 * @cb: message callback structure
1547 static void mei_msg_hdr_init(struct mei_msg_hdr *mei_hdr, struct mei_cl_cb *cb)
1549 mei_hdr->host_addr = mei_cl_host_addr(cb->cl);
1550 mei_hdr->me_addr = mei_cl_me_id(cb->cl);
1551 mei_hdr->length = 0;
1552 mei_hdr->reserved = 0;
1553 mei_hdr->msg_complete = 0;
1554 mei_hdr->dma_ring = 0;
1555 mei_hdr->internal = cb->internal;
1559 * mei_cl_irq_write - write a message to device
1560 * from the interrupt thread context
1563 * @cb: callback block.
1564 * @cmpl_list: complete list.
1566 * Return: 0, OK; otherwise error.
1568 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
1569 struct list_head *cmpl_list)
1571 struct mei_device *dev;
1572 struct mei_msg_data *buf;
1573 struct mei_msg_hdr mei_hdr;
1574 size_t hdr_len = sizeof(mei_hdr);
1581 if (WARN_ON(!cl || !cl->dev))
1588 first_chunk = cb->buf_idx == 0;
1590 rets = first_chunk ? mei_cl_tx_flow_ctrl_creds(cl) : 1;
1595 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1599 len = buf->size - cb->buf_idx;
1600 hbuf_slots = mei_hbuf_empty_slots(dev);
1601 if (hbuf_slots < 0) {
1606 hbuf_len = mei_slots2data(hbuf_slots);
1608 mei_msg_hdr_init(&mei_hdr, cb);
1611 * Split the message only if we can write the whole host buffer
1612 * otherwise wait for next time the host buffer is empty.
1614 if (len + hdr_len <= hbuf_len) {
1615 mei_hdr.length = len;
1616 mei_hdr.msg_complete = 1;
1617 } else if ((u32)hbuf_slots == mei_hbuf_depth(dev)) {
1618 mei_hdr.length = hbuf_len - hdr_len;
1623 cl_dbg(dev, cl, "buf: size = %zu idx = %zu\n",
1624 cb->buf.size, cb->buf_idx);
1626 rets = mei_write_message(dev, &mei_hdr, hdr_len,
1627 buf->data + cb->buf_idx, mei_hdr.length);
1632 cl->writing_state = MEI_WRITING;
1633 cb->buf_idx += mei_hdr.length;
1636 if (mei_cl_tx_flow_ctrl_creds_reduce(cl)) {
1642 if (mei_hdr.msg_complete)
1643 list_move_tail(&cb->list, &dev->write_waiting_list);
1649 list_move_tail(&cb->list, cmpl_list);
1654 * mei_cl_write - submit a write cb to mei device
1655 * assumes device_lock is locked
1658 * @cb: write callback with filled data
1660 * Return: number of bytes sent on success, <0 on failure.
1662 ssize_t mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb)
1664 struct mei_device *dev;
1665 struct mei_msg_data *buf;
1666 struct mei_msg_hdr mei_hdr;
1667 size_t hdr_len = sizeof(mei_hdr);
1674 if (WARN_ON(!cl || !cl->dev))
1684 blocking = cb->blocking;
1686 cl_dbg(dev, cl, "len=%zd\n", len);
1688 rets = pm_runtime_get(dev->dev);
1689 if (rets < 0 && rets != -EINPROGRESS) {
1690 pm_runtime_put_noidle(dev->dev);
1691 cl_err(dev, cl, "rpm: get failed %zd\n", rets);
1696 cl->writing_state = MEI_IDLE;
1699 rets = mei_cl_tx_flow_ctrl_creds(cl);
1703 mei_msg_hdr_init(&mei_hdr, cb);
1706 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1711 if (!mei_hbuf_acquire(dev)) {
1712 cl_dbg(dev, cl, "Cannot acquire the host buffer: not sending.\n");
1717 hbuf_slots = mei_hbuf_empty_slots(dev);
1718 if (hbuf_slots < 0) {
1723 hbuf_len = mei_slots2data(hbuf_slots);
1725 if (len + hdr_len <= hbuf_len) {
1726 mei_hdr.length = len;
1727 mei_hdr.msg_complete = 1;
1729 mei_hdr.length = hbuf_len - hdr_len;
1732 rets = mei_write_message(dev, &mei_hdr, hdr_len,
1733 buf->data, mei_hdr.length);
1737 rets = mei_cl_tx_flow_ctrl_creds_reduce(cl);
1741 cl->writing_state = MEI_WRITING;
1742 cb->buf_idx = mei_hdr.length;
1745 if (mei_hdr.msg_complete)
1746 mei_tx_cb_enqueue(cb, &dev->write_waiting_list);
1748 mei_tx_cb_enqueue(cb, &dev->write_list);
1751 if (blocking && cl->writing_state != MEI_WRITE_COMPLETE) {
1753 mutex_unlock(&dev->device_lock);
1754 rets = wait_event_interruptible(cl->tx_wait,
1755 cl->writing_state == MEI_WRITE_COMPLETE ||
1756 (!mei_cl_is_connected(cl)));
1757 mutex_lock(&dev->device_lock);
1758 /* wait_event_interruptible returns -ERESTARTSYS */
1760 if (signal_pending(current))
1764 if (cl->writing_state != MEI_WRITE_COMPLETE) {
1772 cl_dbg(dev, cl, "rpm: autosuspend\n");
1773 pm_runtime_mark_last_busy(dev->dev);
1774 pm_runtime_put_autosuspend(dev->dev);
1783 * mei_cl_complete - processes completed operation for a client
1785 * @cl: private data of the file object.
1786 * @cb: callback block.
1788 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb)
1790 struct mei_device *dev = cl->dev;
1792 switch (cb->fop_type) {
1794 mei_tx_cb_dequeue(cb);
1795 cl->writing_state = MEI_WRITE_COMPLETE;
1796 if (waitqueue_active(&cl->tx_wait)) {
1797 wake_up_interruptible(&cl->tx_wait);
1799 pm_runtime_mark_last_busy(dev->dev);
1800 pm_request_autosuspend(dev->dev);
1805 list_add_tail(&cb->list, &cl->rd_completed);
1806 if (!mei_cl_is_fixed_address(cl) &&
1807 !WARN_ON(!cl->rx_flow_ctrl_creds))
1808 cl->rx_flow_ctrl_creds--;
1809 if (!mei_cl_bus_rx_event(cl))
1810 wake_up_interruptible(&cl->rx_wait);
1813 case MEI_FOP_CONNECT:
1814 case MEI_FOP_DISCONNECT:
1815 case MEI_FOP_NOTIFY_STOP:
1816 case MEI_FOP_NOTIFY_START:
1817 if (waitqueue_active(&cl->wait))
1821 case MEI_FOP_DISCONNECT_RSP:
1823 mei_cl_set_disconnected(cl);
1832 * mei_cl_all_disconnect - disconnect forcefully all connected clients
1836 void mei_cl_all_disconnect(struct mei_device *dev)
1840 list_for_each_entry(cl, &dev->file_list, link)
1841 mei_cl_set_disconnected(cl);