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 static struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl,
362 enum mei_cb_file_ops type,
363 const struct file *fp)
365 struct mei_cl_cb *cb;
367 cb = kzalloc(sizeof(struct mei_cl_cb), GFP_KERNEL);
371 INIT_LIST_HEAD(&cb->list);
380 * __mei_io_list_flush - removes and frees cbs belonging to cl.
382 * @list: an instance of our list structure
383 * @cl: host client, can be NULL for flushing the whole list
384 * @free: whether to free the cbs
386 static void __mei_io_list_flush(struct mei_cl_cb *list,
387 struct mei_cl *cl, bool free)
389 struct mei_cl_cb *cb, *next;
391 /* enable removing everything if no cl is specified */
392 list_for_each_entry_safe(cb, next, &list->list, list) {
393 if (!cl || mei_cl_cmp_id(cl, cb->cl)) {
394 list_del_init(&cb->list);
402 * mei_io_list_flush - removes list entry belonging to cl.
404 * @list: An instance of our list structure
407 void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl)
409 __mei_io_list_flush(list, cl, false);
413 * mei_io_list_free - removes cb belonging to cl and free them
415 * @list: An instance of our list structure
418 static inline void mei_io_list_free(struct mei_cl_cb *list, struct mei_cl *cl)
420 __mei_io_list_flush(list, cl, true);
424 * mei_cl_alloc_cb - a convenient wrapper for allocating read cb
427 * @length: size of the buffer
428 * @fop_type: operation type
429 * @fp: associated file pointer (might be NULL)
431 * Return: cb on success and NULL on failure
433 struct mei_cl_cb *mei_cl_alloc_cb(struct mei_cl *cl, size_t length,
434 enum mei_cb_file_ops fop_type,
435 const struct file *fp)
437 struct mei_cl_cb *cb;
439 cb = mei_io_cb_init(cl, fop_type, fp);
446 cb->buf.data = kmalloc(length, GFP_KERNEL);
451 cb->buf.size = length;
457 * mei_cl_enqueue_ctrl_wr_cb - a convenient wrapper for allocating
458 * and enqueuing of the control commands cb
461 * @length: size of the buffer
462 * @fop_type: operation type
463 * @fp: associated file pointer (might be NULL)
465 * Return: cb on success and NULL on failure
466 * Locking: called under "dev->device_lock" lock
468 struct mei_cl_cb *mei_cl_enqueue_ctrl_wr_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 /* for RX always allocate at least client's mtu */
476 length = max_t(size_t, length, mei_cl_mtu(cl));
478 cb = mei_cl_alloc_cb(cl, length, fop_type, fp);
482 list_add_tail(&cb->list, &cl->dev->ctrl_wr_list.list);
487 * mei_cl_read_cb - find this cl's callback in the read list
488 * for a specific file
491 * @fp: file pointer (matching cb file object), may be NULL
493 * Return: cb on success, NULL if cb is not found
495 struct mei_cl_cb *mei_cl_read_cb(const struct mei_cl *cl, const struct file *fp)
497 struct mei_cl_cb *cb;
499 list_for_each_entry(cb, &cl->rd_completed, list)
500 if (!fp || fp == cb->fp)
507 * mei_cl_read_cb_flush - free client's read pending and completed cbs
508 * for a specific file
511 * @fp: file pointer (matching cb file object), may be NULL
513 void mei_cl_read_cb_flush(const struct mei_cl *cl, const struct file *fp)
515 struct mei_cl_cb *cb, *next;
517 list_for_each_entry_safe(cb, next, &cl->rd_completed, list)
518 if (!fp || fp == cb->fp)
522 list_for_each_entry_safe(cb, next, &cl->rd_pending, list)
523 if (!fp || fp == cb->fp)
528 * mei_cl_flush_queues - flushes queue lists belonging to cl.
531 * @fp: file pointer (matching cb file object), may be NULL
533 * Return: 0 on success, -EINVAL if cl or cl->dev is NULL.
535 int mei_cl_flush_queues(struct mei_cl *cl, const struct file *fp)
537 struct mei_device *dev;
539 if (WARN_ON(!cl || !cl->dev))
544 cl_dbg(dev, cl, "remove list entry belonging to cl\n");
545 mei_io_list_free(&cl->dev->write_list, cl);
546 mei_io_list_free(&cl->dev->write_waiting_list, cl);
547 mei_io_list_flush(&cl->dev->ctrl_wr_list, cl);
548 mei_io_list_flush(&cl->dev->ctrl_rd_list, cl);
549 mei_io_list_flush(&cl->dev->amthif_cmd_list, cl);
551 mei_cl_read_cb_flush(cl, fp);
558 * mei_cl_init - initializes cl.
560 * @cl: host client to be initialized
563 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev)
565 memset(cl, 0, sizeof(struct mei_cl));
566 init_waitqueue_head(&cl->wait);
567 init_waitqueue_head(&cl->rx_wait);
568 init_waitqueue_head(&cl->tx_wait);
569 init_waitqueue_head(&cl->ev_wait);
570 INIT_LIST_HEAD(&cl->rd_completed);
571 INIT_LIST_HEAD(&cl->rd_pending);
572 INIT_LIST_HEAD(&cl->link);
573 cl->writing_state = MEI_IDLE;
574 cl->state = MEI_FILE_UNINITIALIZED;
579 * mei_cl_allocate - allocates cl structure and sets it up.
582 * Return: The allocated file or NULL on failure
584 struct mei_cl *mei_cl_allocate(struct mei_device *dev)
588 cl = kmalloc(sizeof(struct mei_cl), GFP_KERNEL);
592 mei_cl_init(cl, dev);
598 * mei_cl_link - allocate host id in the host map
602 * Return: 0 on success
603 * -EINVAL on incorrect values
604 * -EMFILE if open count exceeded.
606 int mei_cl_link(struct mei_cl *cl)
608 struct mei_device *dev;
609 long open_handle_count;
612 if (WARN_ON(!cl || !cl->dev))
617 id = find_first_zero_bit(dev->host_clients_map, MEI_CLIENTS_MAX);
618 if (id >= MEI_CLIENTS_MAX) {
619 dev_err(dev->dev, "id exceeded %d", MEI_CLIENTS_MAX);
623 open_handle_count = dev->open_handle_count + dev->iamthif_open_count;
624 if (open_handle_count >= MEI_MAX_OPEN_HANDLE_COUNT) {
625 dev_err(dev->dev, "open_handle_count exceeded %d",
626 MEI_MAX_OPEN_HANDLE_COUNT);
630 dev->open_handle_count++;
632 cl->host_client_id = id;
633 list_add_tail(&cl->link, &dev->file_list);
635 set_bit(id, dev->host_clients_map);
637 cl->state = MEI_FILE_INITIALIZING;
639 cl_dbg(dev, cl, "link cl\n");
644 * mei_cl_unlink - remove host client from the list
650 int mei_cl_unlink(struct mei_cl *cl)
652 struct mei_device *dev;
654 /* don't shout on error exit path */
658 /* amthif might not be initialized */
664 cl_dbg(dev, cl, "unlink client");
666 if (dev->open_handle_count > 0)
667 dev->open_handle_count--;
669 /* never clear the 0 bit */
670 if (cl->host_client_id)
671 clear_bit(cl->host_client_id, dev->host_clients_map);
673 list_del_init(&cl->link);
675 cl->state = MEI_FILE_UNINITIALIZED;
676 cl->writing_state = MEI_IDLE;
678 WARN_ON(!list_empty(&cl->rd_completed) ||
679 !list_empty(&cl->rd_pending) ||
680 !list_empty(&cl->link));
685 void mei_host_client_init(struct mei_device *dev)
687 dev->dev_state = MEI_DEV_ENABLED;
688 dev->reset_count = 0;
690 schedule_work(&dev->bus_rescan_work);
692 pm_runtime_mark_last_busy(dev->dev);
693 dev_dbg(dev->dev, "rpm: autosuspend\n");
694 pm_request_autosuspend(dev->dev);
698 * mei_hbuf_acquire - try to acquire host buffer
700 * @dev: the device structure
701 * Return: true if host buffer was acquired
703 bool mei_hbuf_acquire(struct mei_device *dev)
705 if (mei_pg_state(dev) == MEI_PG_ON ||
706 mei_pg_in_transition(dev)) {
707 dev_dbg(dev->dev, "device is in pg\n");
711 if (!dev->hbuf_is_ready) {
712 dev_dbg(dev->dev, "hbuf is not ready\n");
716 dev->hbuf_is_ready = false;
722 * mei_cl_wake_all - wake up readers, writers and event waiters so
723 * they can be interrupted
727 static void mei_cl_wake_all(struct mei_cl *cl)
729 struct mei_device *dev = cl->dev;
731 /* synchronized under device mutex */
732 if (waitqueue_active(&cl->rx_wait)) {
733 cl_dbg(dev, cl, "Waking up reading client!\n");
734 wake_up_interruptible(&cl->rx_wait);
736 /* synchronized under device mutex */
737 if (waitqueue_active(&cl->tx_wait)) {
738 cl_dbg(dev, cl, "Waking up writing client!\n");
739 wake_up_interruptible(&cl->tx_wait);
741 /* synchronized under device mutex */
742 if (waitqueue_active(&cl->ev_wait)) {
743 cl_dbg(dev, cl, "Waking up waiting for event clients!\n");
744 wake_up_interruptible(&cl->ev_wait);
746 /* synchronized under device mutex */
747 if (waitqueue_active(&cl->wait)) {
748 cl_dbg(dev, cl, "Waking up ctrl write clients!\n");
754 * mei_cl_set_disconnected - set disconnected state and clear
755 * associated states and resources
759 void mei_cl_set_disconnected(struct mei_cl *cl)
761 struct mei_device *dev = cl->dev;
763 if (cl->state == MEI_FILE_DISCONNECTED ||
764 cl->state <= MEI_FILE_INITIALIZING)
767 cl->state = MEI_FILE_DISCONNECTED;
768 mei_io_list_free(&dev->write_list, cl);
769 mei_io_list_free(&dev->write_waiting_list, cl);
770 mei_io_list_flush(&dev->ctrl_rd_list, cl);
771 mei_io_list_flush(&dev->ctrl_wr_list, cl);
773 cl->rx_flow_ctrl_creds = 0;
774 cl->tx_flow_ctrl_creds = 0;
780 if (!WARN_ON(cl->me_cl->connect_count == 0))
781 cl->me_cl->connect_count--;
783 if (cl->me_cl->connect_count == 0)
784 cl->me_cl->tx_flow_ctrl_creds = 0;
786 mei_me_cl_put(cl->me_cl);
790 static int mei_cl_set_connecting(struct mei_cl *cl, struct mei_me_client *me_cl)
792 if (!mei_me_cl_get(me_cl))
795 /* only one connection is allowed for fixed address clients */
796 if (me_cl->props.fixed_address) {
797 if (me_cl->connect_count) {
798 mei_me_cl_put(me_cl);
804 cl->state = MEI_FILE_CONNECTING;
805 cl->me_cl->connect_count++;
811 * mei_cl_send_disconnect - send disconnect request
814 * @cb: callback block
816 * Return: 0, OK; otherwise, error.
818 static int mei_cl_send_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb)
820 struct mei_device *dev;
825 ret = mei_hbm_cl_disconnect_req(dev, cl);
828 cl->state = MEI_FILE_DISCONNECT_REPLY;
832 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
833 cl->timer_count = MEI_CONNECT_TIMEOUT;
834 mei_schedule_stall_timer(dev);
840 * mei_cl_irq_disconnect - processes close related operation from
841 * interrupt thread context - send disconnect request
844 * @cb: callback block.
845 * @cmpl_list: complete list.
847 * Return: 0, OK; otherwise, error.
849 int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
850 struct mei_cl_cb *cmpl_list)
852 struct mei_device *dev = cl->dev;
857 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
858 slots = mei_hbuf_empty_slots(dev);
860 if (slots < msg_slots)
863 ret = mei_cl_send_disconnect(cl, cb);
865 list_move_tail(&cb->list, &cmpl_list->list);
871 * __mei_cl_disconnect - disconnect host client from the me one
872 * internal function runtime pm has to be already acquired
876 * Return: 0 on success, <0 on failure.
878 static int __mei_cl_disconnect(struct mei_cl *cl)
880 struct mei_device *dev;
881 struct mei_cl_cb *cb;
886 cl->state = MEI_FILE_DISCONNECTING;
888 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, MEI_FOP_DISCONNECT, NULL);
894 if (mei_hbuf_acquire(dev)) {
895 rets = mei_cl_send_disconnect(cl, cb);
897 cl_err(dev, cl, "failed to disconnect.\n");
902 mutex_unlock(&dev->device_lock);
903 wait_event_timeout(cl->wait,
904 cl->state == MEI_FILE_DISCONNECT_REPLY ||
905 cl->state == MEI_FILE_DISCONNECTED,
906 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
907 mutex_lock(&dev->device_lock);
910 if (cl->state != MEI_FILE_DISCONNECT_REPLY &&
911 cl->state != MEI_FILE_DISCONNECTED) {
912 cl_dbg(dev, cl, "timeout on disconnect from FW client.\n");
917 /* we disconnect also on error */
918 mei_cl_set_disconnected(cl);
920 cl_dbg(dev, cl, "successfully disconnected from FW client.\n");
927 * mei_cl_disconnect - disconnect host client from the me one
931 * Locking: called under "dev->device_lock" lock
933 * Return: 0 on success, <0 on failure.
935 int mei_cl_disconnect(struct mei_cl *cl)
937 struct mei_device *dev;
940 if (WARN_ON(!cl || !cl->dev))
945 cl_dbg(dev, cl, "disconnecting");
947 if (!mei_cl_is_connected(cl))
950 if (mei_cl_is_fixed_address(cl)) {
951 mei_cl_set_disconnected(cl);
955 rets = pm_runtime_get(dev->dev);
956 if (rets < 0 && rets != -EINPROGRESS) {
957 pm_runtime_put_noidle(dev->dev);
958 cl_err(dev, cl, "rpm: get failed %d\n", rets);
962 rets = __mei_cl_disconnect(cl);
964 cl_dbg(dev, cl, "rpm: autosuspend\n");
965 pm_runtime_mark_last_busy(dev->dev);
966 pm_runtime_put_autosuspend(dev->dev);
973 * mei_cl_is_other_connecting - checks if other
974 * client with the same me client id is connecting
976 * @cl: private data of the file object
978 * Return: true if other client is connected, false - otherwise.
980 static bool mei_cl_is_other_connecting(struct mei_cl *cl)
982 struct mei_device *dev;
983 struct mei_cl_cb *cb;
987 list_for_each_entry(cb, &dev->ctrl_rd_list.list, list) {
988 if (cb->fop_type == MEI_FOP_CONNECT &&
989 mei_cl_me_id(cl) == mei_cl_me_id(cb->cl))
997 * mei_cl_send_connect - send connect request
1000 * @cb: callback block
1002 * Return: 0, OK; otherwise, error.
1004 static int mei_cl_send_connect(struct mei_cl *cl, struct mei_cl_cb *cb)
1006 struct mei_device *dev;
1011 ret = mei_hbm_cl_connect_req(dev, cl);
1014 cl->state = MEI_FILE_DISCONNECT_REPLY;
1018 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
1019 cl->timer_count = MEI_CONNECT_TIMEOUT;
1020 mei_schedule_stall_timer(dev);
1025 * mei_cl_irq_connect - send connect request in irq_thread context
1028 * @cb: callback block
1029 * @cmpl_list: complete list
1031 * Return: 0, OK; otherwise, error.
1033 int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
1034 struct mei_cl_cb *cmpl_list)
1036 struct mei_device *dev = cl->dev;
1041 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1042 slots = mei_hbuf_empty_slots(dev);
1044 if (mei_cl_is_other_connecting(cl))
1047 if (slots < msg_slots)
1050 rets = mei_cl_send_connect(cl, cb);
1052 list_move_tail(&cb->list, &cmpl_list->list);
1058 * mei_cl_connect - connect host client to the me one
1062 * @fp: pointer to file structure
1064 * Locking: called under "dev->device_lock" lock
1066 * Return: 0 on success, <0 on failure.
1068 int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl,
1069 const struct file *fp)
1071 struct mei_device *dev;
1072 struct mei_cl_cb *cb;
1075 if (WARN_ON(!cl || !cl->dev || !me_cl))
1080 rets = mei_cl_set_connecting(cl, me_cl);
1084 if (mei_cl_is_fixed_address(cl)) {
1085 cl->state = MEI_FILE_CONNECTED;
1089 rets = pm_runtime_get(dev->dev);
1090 if (rets < 0 && rets != -EINPROGRESS) {
1091 pm_runtime_put_noidle(dev->dev);
1092 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1096 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, MEI_FOP_CONNECT, fp);
1102 /* run hbuf acquire last so we don't have to undo */
1103 if (!mei_cl_is_other_connecting(cl) && mei_hbuf_acquire(dev)) {
1104 rets = mei_cl_send_connect(cl, cb);
1109 mutex_unlock(&dev->device_lock);
1110 wait_event_timeout(cl->wait,
1111 (cl->state == MEI_FILE_CONNECTED ||
1112 cl->state == MEI_FILE_DISCONNECTED ||
1113 cl->state == MEI_FILE_DISCONNECT_REQUIRED ||
1114 cl->state == MEI_FILE_DISCONNECT_REPLY),
1115 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1116 mutex_lock(&dev->device_lock);
1118 if (!mei_cl_is_connected(cl)) {
1119 if (cl->state == MEI_FILE_DISCONNECT_REQUIRED) {
1120 mei_io_list_flush(&dev->ctrl_rd_list, cl);
1121 mei_io_list_flush(&dev->ctrl_wr_list, cl);
1122 /* ignore disconnect return valuue;
1123 * in case of failure reset will be invoked
1125 __mei_cl_disconnect(cl);
1130 /* timeout or something went really wrong */
1132 cl->status = -EFAULT;
1137 cl_dbg(dev, cl, "rpm: autosuspend\n");
1138 pm_runtime_mark_last_busy(dev->dev);
1139 pm_runtime_put_autosuspend(dev->dev);
1144 if (!mei_cl_is_connected(cl))
1145 mei_cl_set_disconnected(cl);
1151 * mei_cl_alloc_linked - allocate and link host client
1153 * @dev: the device structure
1155 * Return: cl on success ERR_PTR on failure
1157 struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev)
1162 cl = mei_cl_allocate(dev);
1168 ret = mei_cl_link(cl);
1175 return ERR_PTR(ret);
1179 * mei_cl_tx_flow_ctrl_creds - checks flow_control credits for cl.
1183 * Return: 1 if tx_flow_ctrl_creds >0, 0 - otherwise.
1185 static int mei_cl_tx_flow_ctrl_creds(struct mei_cl *cl)
1187 if (WARN_ON(!cl || !cl->me_cl))
1190 if (cl->tx_flow_ctrl_creds > 0)
1193 if (mei_cl_is_fixed_address(cl))
1196 if (mei_cl_is_single_recv_buf(cl)) {
1197 if (cl->me_cl->tx_flow_ctrl_creds > 0)
1204 * mei_cl_tx_flow_ctrl_creds_reduce - reduces transmit flow control credits
1211 * -EINVAL when ctrl credits are <= 0
1213 static int mei_cl_tx_flow_ctrl_creds_reduce(struct mei_cl *cl)
1215 if (WARN_ON(!cl || !cl->me_cl))
1218 if (mei_cl_is_fixed_address(cl))
1221 if (mei_cl_is_single_recv_buf(cl)) {
1222 if (WARN_ON(cl->me_cl->tx_flow_ctrl_creds <= 0))
1224 cl->me_cl->tx_flow_ctrl_creds--;
1226 if (WARN_ON(cl->tx_flow_ctrl_creds <= 0))
1228 cl->tx_flow_ctrl_creds--;
1234 * mei_cl_notify_fop2req - convert fop to proper request
1236 * @fop: client notification start response command
1238 * Return: MEI_HBM_NOTIFICATION_START/STOP
1240 u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop)
1242 if (fop == MEI_FOP_NOTIFY_START)
1243 return MEI_HBM_NOTIFICATION_START;
1245 return MEI_HBM_NOTIFICATION_STOP;
1249 * mei_cl_notify_req2fop - convert notification request top file operation type
1251 * @req: hbm notification request type
1253 * Return: MEI_FOP_NOTIFY_START/STOP
1255 enum mei_cb_file_ops mei_cl_notify_req2fop(u8 req)
1257 if (req == MEI_HBM_NOTIFICATION_START)
1258 return MEI_FOP_NOTIFY_START;
1260 return MEI_FOP_NOTIFY_STOP;
1264 * mei_cl_irq_notify - send notification request in irq_thread context
1267 * @cb: callback block.
1268 * @cmpl_list: complete list.
1270 * Return: 0 on such and error otherwise.
1272 int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb,
1273 struct mei_cl_cb *cmpl_list)
1275 struct mei_device *dev = cl->dev;
1281 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1282 slots = mei_hbuf_empty_slots(dev);
1284 if (slots < msg_slots)
1287 request = mei_cl_notify_fop2req(cb->fop_type);
1288 ret = mei_hbm_cl_notify_req(dev, cl, request);
1291 list_move_tail(&cb->list, &cmpl_list->list);
1295 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
1300 * mei_cl_notify_request - send notification stop/start request
1303 * @fp: associate request with file
1304 * @request: 1 for start or 0 for stop
1306 * Locking: called under "dev->device_lock" lock
1308 * Return: 0 on such and error otherwise.
1310 int mei_cl_notify_request(struct mei_cl *cl,
1311 const struct file *fp, u8 request)
1313 struct mei_device *dev;
1314 struct mei_cl_cb *cb;
1315 enum mei_cb_file_ops fop_type;
1318 if (WARN_ON(!cl || !cl->dev))
1323 if (!dev->hbm_f_ev_supported) {
1324 cl_dbg(dev, cl, "notifications not supported\n");
1328 rets = pm_runtime_get(dev->dev);
1329 if (rets < 0 && rets != -EINPROGRESS) {
1330 pm_runtime_put_noidle(dev->dev);
1331 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1335 fop_type = mei_cl_notify_req2fop(request);
1336 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, fop_type, fp);
1342 if (mei_hbuf_acquire(dev)) {
1343 if (mei_hbm_cl_notify_req(dev, cl, request)) {
1347 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
1350 mutex_unlock(&dev->device_lock);
1351 wait_event_timeout(cl->wait,
1352 cl->notify_en == request || !mei_cl_is_connected(cl),
1353 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1354 mutex_lock(&dev->device_lock);
1356 if (cl->notify_en != request && !cl->status)
1357 cl->status = -EFAULT;
1362 cl_dbg(dev, cl, "rpm: autosuspend\n");
1363 pm_runtime_mark_last_busy(dev->dev);
1364 pm_runtime_put_autosuspend(dev->dev);
1371 * mei_cl_notify - raise notification
1375 * Locking: called under "dev->device_lock" lock
1377 void mei_cl_notify(struct mei_cl *cl)
1379 struct mei_device *dev;
1381 if (!cl || !cl->dev)
1389 cl_dbg(dev, cl, "notify event");
1390 cl->notify_ev = true;
1391 if (!mei_cl_bus_notify_event(cl))
1392 wake_up_interruptible(&cl->ev_wait);
1395 kill_fasync(&cl->ev_async, SIGIO, POLL_PRI);
1400 * mei_cl_notify_get - get or wait for notification event
1403 * @block: this request is blocking
1404 * @notify_ev: true if notification event was received
1406 * Locking: called under "dev->device_lock" lock
1408 * Return: 0 on such and error otherwise.
1410 int mei_cl_notify_get(struct mei_cl *cl, bool block, bool *notify_ev)
1412 struct mei_device *dev;
1417 if (WARN_ON(!cl || !cl->dev))
1422 if (!mei_cl_is_connected(cl))
1431 mutex_unlock(&dev->device_lock);
1432 rets = wait_event_interruptible(cl->ev_wait, cl->notify_ev);
1433 mutex_lock(&dev->device_lock);
1439 *notify_ev = cl->notify_ev;
1440 cl->notify_ev = false;
1445 * mei_cl_read_start - the start read client message function.
1448 * @length: number of bytes to read
1449 * @fp: pointer to file structure
1451 * Return: 0 on success, <0 on failure.
1453 int mei_cl_read_start(struct mei_cl *cl, size_t length, const struct file *fp)
1455 struct mei_device *dev;
1456 struct mei_cl_cb *cb;
1459 if (WARN_ON(!cl || !cl->dev))
1464 if (!mei_cl_is_connected(cl))
1467 if (!mei_me_cl_is_active(cl->me_cl)) {
1468 cl_err(dev, cl, "no such me client\n");
1472 if (mei_cl_is_fixed_address(cl) || cl == &dev->iamthif_cl)
1475 /* HW currently supports only one pending read */
1476 if (cl->rx_flow_ctrl_creds)
1479 cb = mei_cl_enqueue_ctrl_wr_cb(cl, length, MEI_FOP_READ, fp);
1483 rets = pm_runtime_get(dev->dev);
1484 if (rets < 0 && rets != -EINPROGRESS) {
1485 pm_runtime_put_noidle(dev->dev);
1486 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1491 if (mei_hbuf_acquire(dev)) {
1492 rets = mei_hbm_cl_flow_control_req(dev, cl);
1496 list_move_tail(&cb->list, &cl->rd_pending);
1498 cl->rx_flow_ctrl_creds++;
1501 cl_dbg(dev, cl, "rpm: autosuspend\n");
1502 pm_runtime_mark_last_busy(dev->dev);
1503 pm_runtime_put_autosuspend(dev->dev);
1512 * mei_cl_irq_write - write a message to device
1513 * from the interrupt thread context
1516 * @cb: callback block.
1517 * @cmpl_list: complete list.
1519 * Return: 0, OK; otherwise error.
1521 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
1522 struct mei_cl_cb *cmpl_list)
1524 struct mei_device *dev;
1525 struct mei_msg_data *buf;
1526 struct mei_msg_hdr mei_hdr;
1533 if (WARN_ON(!cl || !cl->dev))
1540 first_chunk = cb->buf_idx == 0;
1542 rets = first_chunk ? mei_cl_tx_flow_ctrl_creds(cl) : 1;
1547 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1551 slots = mei_hbuf_empty_slots(dev);
1552 len = buf->size - cb->buf_idx;
1553 msg_slots = mei_data2slots(len);
1555 mei_hdr.host_addr = mei_cl_host_addr(cl);
1556 mei_hdr.me_addr = mei_cl_me_id(cl);
1557 mei_hdr.reserved = 0;
1558 mei_hdr.internal = cb->internal;
1560 if (slots >= msg_slots) {
1561 mei_hdr.length = len;
1562 mei_hdr.msg_complete = 1;
1563 /* Split the message only if we can write the whole host buffer */
1564 } else if (slots == dev->hbuf_depth) {
1566 len = (slots * sizeof(u32)) - sizeof(struct mei_msg_hdr);
1567 mei_hdr.length = len;
1568 mei_hdr.msg_complete = 0;
1570 /* wait for next time the host buffer is empty */
1574 cl_dbg(dev, cl, "buf: size = %zu idx = %zu\n",
1575 cb->buf.size, cb->buf_idx);
1577 rets = mei_write_message(dev, &mei_hdr, buf->data + cb->buf_idx);
1580 list_move_tail(&cb->list, &cmpl_list->list);
1585 cl->writing_state = MEI_WRITING;
1586 cb->buf_idx += mei_hdr.length;
1587 cb->completed = mei_hdr.msg_complete == 1;
1590 if (mei_cl_tx_flow_ctrl_creds_reduce(cl))
1594 if (mei_hdr.msg_complete)
1595 list_move_tail(&cb->list, &dev->write_waiting_list.list);
1601 * mei_cl_write - submit a write cb to mei device
1602 * assumes device_lock is locked
1605 * @cb: write callback with filled data
1607 * Return: number of bytes sent on success, <0 on failure.
1609 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb)
1611 struct mei_device *dev;
1612 struct mei_msg_data *buf;
1613 struct mei_msg_hdr mei_hdr;
1618 if (WARN_ON(!cl || !cl->dev))
1628 blocking = cb->blocking;
1630 cl_dbg(dev, cl, "size=%d\n", size);
1632 rets = pm_runtime_get(dev->dev);
1633 if (rets < 0 && rets != -EINPROGRESS) {
1634 pm_runtime_put_noidle(dev->dev);
1635 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1640 cl->writing_state = MEI_IDLE;
1642 mei_hdr.host_addr = mei_cl_host_addr(cl);
1643 mei_hdr.me_addr = mei_cl_me_id(cl);
1644 mei_hdr.reserved = 0;
1645 mei_hdr.msg_complete = 0;
1646 mei_hdr.internal = cb->internal;
1648 rets = mei_cl_tx_flow_ctrl_creds(cl);
1653 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1657 if (!mei_hbuf_acquire(dev)) {
1658 cl_dbg(dev, cl, "Cannot acquire the host buffer: not sending.\n");
1663 /* Check for a maximum length */
1664 if (size > mei_hbuf_max_len(dev)) {
1665 mei_hdr.length = mei_hbuf_max_len(dev);
1666 mei_hdr.msg_complete = 0;
1668 mei_hdr.length = size;
1669 mei_hdr.msg_complete = 1;
1672 rets = mei_write_message(dev, &mei_hdr, buf->data);
1676 rets = mei_cl_tx_flow_ctrl_creds_reduce(cl);
1680 cl->writing_state = MEI_WRITING;
1681 cb->buf_idx = mei_hdr.length;
1682 cb->completed = mei_hdr.msg_complete == 1;
1685 if (mei_hdr.msg_complete)
1686 list_add_tail(&cb->list, &dev->write_waiting_list.list);
1688 list_add_tail(&cb->list, &dev->write_list.list);
1691 if (blocking && cl->writing_state != MEI_WRITE_COMPLETE) {
1693 mutex_unlock(&dev->device_lock);
1694 rets = wait_event_interruptible(cl->tx_wait,
1695 cl->writing_state == MEI_WRITE_COMPLETE ||
1696 (!mei_cl_is_connected(cl)));
1697 mutex_lock(&dev->device_lock);
1698 /* wait_event_interruptible returns -ERESTARTSYS */
1700 if (signal_pending(current))
1704 if (cl->writing_state != MEI_WRITE_COMPLETE) {
1712 cl_dbg(dev, cl, "rpm: autosuspend\n");
1713 pm_runtime_mark_last_busy(dev->dev);
1714 pm_runtime_put_autosuspend(dev->dev);
1723 * mei_cl_complete - processes completed operation for a client
1725 * @cl: private data of the file object.
1726 * @cb: callback block.
1728 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb)
1730 struct mei_device *dev = cl->dev;
1732 switch (cb->fop_type) {
1735 cl->writing_state = MEI_WRITE_COMPLETE;
1736 if (waitqueue_active(&cl->tx_wait)) {
1737 wake_up_interruptible(&cl->tx_wait);
1739 pm_runtime_mark_last_busy(dev->dev);
1740 pm_request_autosuspend(dev->dev);
1745 list_add_tail(&cb->list, &cl->rd_completed);
1746 if (!mei_cl_is_fixed_address(cl) &&
1747 !WARN_ON(!cl->rx_flow_ctrl_creds))
1748 cl->rx_flow_ctrl_creds--;
1749 if (!mei_cl_bus_rx_event(cl))
1750 wake_up_interruptible(&cl->rx_wait);
1753 case MEI_FOP_CONNECT:
1754 case MEI_FOP_DISCONNECT:
1755 case MEI_FOP_NOTIFY_STOP:
1756 case MEI_FOP_NOTIFY_START:
1757 if (waitqueue_active(&cl->wait))
1761 case MEI_FOP_DISCONNECT_RSP:
1763 mei_cl_set_disconnected(cl);
1772 * mei_cl_all_disconnect - disconnect forcefully all connected clients
1776 void mei_cl_all_disconnect(struct mei_device *dev)
1780 list_for_each_entry(cl, &dev->file_list, link)
1781 mei_cl_set_disconnected(cl);