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_cl - removes and frees cbs belonging to cl.
382 * @head: 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_cl(struct list_head *head,
387 const 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, head, list) {
393 if (!cl || mei_cl_cmp_id(cl, cb->cl)) {
394 list_del_init(&cb->list);
402 * mei_io_list_flush_cl - removes list entry belonging to cl.
404 * @head: An instance of our list structure
407 static inline void mei_io_list_flush_cl(struct list_head *head,
408 const struct mei_cl *cl)
410 __mei_io_list_flush_cl(head, cl, false);
414 * mei_io_list_free_cl - removes cb belonging to cl and free them
416 * @head: An instance of our list structure
419 static inline void mei_io_list_free_cl(struct list_head *head,
420 const struct mei_cl *cl)
422 __mei_io_list_flush_cl(head, cl, true);
426 * mei_io_list_free_fp - free cb from a list that matches file pointer
429 * @fp: file pointer (matching cb file object), may be NULL
431 void mei_io_list_free_fp(struct list_head *head, const struct file *fp)
433 struct mei_cl_cb *cb, *next;
435 list_for_each_entry_safe(cb, next, head, list)
436 if (!fp || fp == cb->fp)
441 * mei_cl_alloc_cb - a convenient wrapper for allocating read cb
444 * @length: size of the buffer
445 * @fop_type: operation type
446 * @fp: associated file pointer (might be NULL)
448 * Return: cb on success and NULL on failure
450 struct mei_cl_cb *mei_cl_alloc_cb(struct mei_cl *cl, size_t length,
451 enum mei_cb_file_ops fop_type,
452 const struct file *fp)
454 struct mei_cl_cb *cb;
456 cb = mei_io_cb_init(cl, fop_type, fp);
463 cb->buf.data = kmalloc(length, GFP_KERNEL);
468 cb->buf.size = length;
474 * mei_cl_enqueue_ctrl_wr_cb - a convenient wrapper for allocating
475 * and enqueuing of the control commands cb
478 * @length: size of the buffer
479 * @fop_type: operation type
480 * @fp: associated file pointer (might be NULL)
482 * Return: cb on success and NULL on failure
483 * Locking: called under "dev->device_lock" lock
485 struct mei_cl_cb *mei_cl_enqueue_ctrl_wr_cb(struct mei_cl *cl, size_t length,
486 enum mei_cb_file_ops fop_type,
487 const struct file *fp)
489 struct mei_cl_cb *cb;
491 /* for RX always allocate at least client's mtu */
493 length = max_t(size_t, length, mei_cl_mtu(cl));
495 cb = mei_cl_alloc_cb(cl, length, fop_type, fp);
499 list_add_tail(&cb->list, &cl->dev->ctrl_wr_list);
504 * mei_cl_read_cb - find this cl's callback in the read list
505 * for a specific file
508 * @fp: file pointer (matching cb file object), may be NULL
510 * Return: cb on success, NULL if cb is not found
512 struct mei_cl_cb *mei_cl_read_cb(const struct mei_cl *cl, const struct file *fp)
514 struct mei_cl_cb *cb;
516 list_for_each_entry(cb, &cl->rd_completed, list)
517 if (!fp || fp == cb->fp)
524 * mei_cl_flush_queues - flushes queue lists belonging to cl.
527 * @fp: file pointer (matching cb file object), may be NULL
529 * Return: 0 on success, -EINVAL if cl or cl->dev is NULL.
531 int mei_cl_flush_queues(struct mei_cl *cl, const struct file *fp)
533 struct mei_device *dev;
535 if (WARN_ON(!cl || !cl->dev))
540 cl_dbg(dev, cl, "remove list entry belonging to cl\n");
541 mei_io_list_free_cl(&cl->dev->write_list, cl);
542 mei_io_list_free_cl(&cl->dev->write_waiting_list, cl);
543 mei_io_list_flush_cl(&cl->dev->ctrl_wr_list, cl);
544 mei_io_list_flush_cl(&cl->dev->ctrl_rd_list, cl);
545 mei_io_list_free_fp(&cl->rd_pending, fp);
546 mei_io_list_free_fp(&cl->rd_completed, fp);
552 * mei_cl_init - initializes cl.
554 * @cl: host client to be initialized
557 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev)
559 memset(cl, 0, sizeof(struct mei_cl));
560 init_waitqueue_head(&cl->wait);
561 init_waitqueue_head(&cl->rx_wait);
562 init_waitqueue_head(&cl->tx_wait);
563 init_waitqueue_head(&cl->ev_wait);
564 INIT_LIST_HEAD(&cl->rd_completed);
565 INIT_LIST_HEAD(&cl->rd_pending);
566 INIT_LIST_HEAD(&cl->link);
567 cl->writing_state = MEI_IDLE;
568 cl->state = MEI_FILE_UNINITIALIZED;
573 * mei_cl_allocate - allocates cl structure and sets it up.
576 * Return: The allocated file or NULL on failure
578 struct mei_cl *mei_cl_allocate(struct mei_device *dev)
582 cl = kmalloc(sizeof(struct mei_cl), GFP_KERNEL);
586 mei_cl_init(cl, dev);
592 * mei_cl_link - allocate host id in the host map
596 * Return: 0 on success
597 * -EINVAL on incorrect values
598 * -EMFILE if open count exceeded.
600 int mei_cl_link(struct mei_cl *cl)
602 struct mei_device *dev;
603 long open_handle_count;
606 if (WARN_ON(!cl || !cl->dev))
611 id = find_first_zero_bit(dev->host_clients_map, MEI_CLIENTS_MAX);
612 if (id >= MEI_CLIENTS_MAX) {
613 dev_err(dev->dev, "id exceeded %d", MEI_CLIENTS_MAX);
617 open_handle_count = dev->open_handle_count + dev->iamthif_open_count;
618 if (open_handle_count >= MEI_MAX_OPEN_HANDLE_COUNT) {
619 dev_err(dev->dev, "open_handle_count exceeded %d",
620 MEI_MAX_OPEN_HANDLE_COUNT);
624 dev->open_handle_count++;
626 cl->host_client_id = id;
627 list_add_tail(&cl->link, &dev->file_list);
629 set_bit(id, dev->host_clients_map);
631 cl->state = MEI_FILE_INITIALIZING;
633 cl_dbg(dev, cl, "link cl\n");
638 * mei_cl_unlink - remove host client from the list
644 int mei_cl_unlink(struct mei_cl *cl)
646 struct mei_device *dev;
648 /* don't shout on error exit path */
652 /* amthif might not be initialized */
658 cl_dbg(dev, cl, "unlink client");
660 if (dev->open_handle_count > 0)
661 dev->open_handle_count--;
663 /* never clear the 0 bit */
664 if (cl->host_client_id)
665 clear_bit(cl->host_client_id, dev->host_clients_map);
667 list_del_init(&cl->link);
669 cl->state = MEI_FILE_UNINITIALIZED;
670 cl->writing_state = MEI_IDLE;
672 WARN_ON(!list_empty(&cl->rd_completed) ||
673 !list_empty(&cl->rd_pending) ||
674 !list_empty(&cl->link));
679 void mei_host_client_init(struct mei_device *dev)
681 dev->dev_state = MEI_DEV_ENABLED;
682 dev->reset_count = 0;
684 schedule_work(&dev->bus_rescan_work);
686 pm_runtime_mark_last_busy(dev->dev);
687 dev_dbg(dev->dev, "rpm: autosuspend\n");
688 pm_request_autosuspend(dev->dev);
692 * mei_hbuf_acquire - try to acquire host buffer
694 * @dev: the device structure
695 * Return: true if host buffer was acquired
697 bool mei_hbuf_acquire(struct mei_device *dev)
699 if (mei_pg_state(dev) == MEI_PG_ON ||
700 mei_pg_in_transition(dev)) {
701 dev_dbg(dev->dev, "device is in pg\n");
705 if (!dev->hbuf_is_ready) {
706 dev_dbg(dev->dev, "hbuf is not ready\n");
710 dev->hbuf_is_ready = false;
716 * mei_cl_wake_all - wake up readers, writers and event waiters so
717 * they can be interrupted
721 static void mei_cl_wake_all(struct mei_cl *cl)
723 struct mei_device *dev = cl->dev;
725 /* synchronized under device mutex */
726 if (waitqueue_active(&cl->rx_wait)) {
727 cl_dbg(dev, cl, "Waking up reading client!\n");
728 wake_up_interruptible(&cl->rx_wait);
730 /* synchronized under device mutex */
731 if (waitqueue_active(&cl->tx_wait)) {
732 cl_dbg(dev, cl, "Waking up writing client!\n");
733 wake_up_interruptible(&cl->tx_wait);
735 /* synchronized under device mutex */
736 if (waitqueue_active(&cl->ev_wait)) {
737 cl_dbg(dev, cl, "Waking up waiting for event clients!\n");
738 wake_up_interruptible(&cl->ev_wait);
740 /* synchronized under device mutex */
741 if (waitqueue_active(&cl->wait)) {
742 cl_dbg(dev, cl, "Waking up ctrl write clients!\n");
748 * mei_cl_set_disconnected - set disconnected state and clear
749 * associated states and resources
753 static void mei_cl_set_disconnected(struct mei_cl *cl)
755 struct mei_device *dev = cl->dev;
757 if (cl->state == MEI_FILE_DISCONNECTED ||
758 cl->state <= MEI_FILE_INITIALIZING)
761 cl->state = MEI_FILE_DISCONNECTED;
762 mei_io_list_free_cl(&dev->write_list, cl);
763 mei_io_list_free_cl(&dev->write_waiting_list, cl);
764 mei_io_list_flush_cl(&dev->ctrl_rd_list, cl);
765 mei_io_list_flush_cl(&dev->ctrl_wr_list, cl);
766 mei_io_list_free_cl(&dev->amthif_cmd_list, cl);
768 cl->rx_flow_ctrl_creds = 0;
769 cl->tx_flow_ctrl_creds = 0;
772 mei_cl_bus_module_put(cl);
777 if (!WARN_ON(cl->me_cl->connect_count == 0))
778 cl->me_cl->connect_count--;
780 if (cl->me_cl->connect_count == 0)
781 cl->me_cl->tx_flow_ctrl_creds = 0;
783 mei_me_cl_put(cl->me_cl);
787 static int mei_cl_set_connecting(struct mei_cl *cl, struct mei_me_client *me_cl)
789 if (!mei_me_cl_get(me_cl))
792 /* only one connection is allowed for fixed address clients */
793 if (me_cl->props.fixed_address) {
794 if (me_cl->connect_count) {
795 mei_me_cl_put(me_cl);
801 cl->state = MEI_FILE_CONNECTING;
802 cl->me_cl->connect_count++;
808 * mei_cl_send_disconnect - send disconnect request
811 * @cb: callback block
813 * Return: 0, OK; otherwise, error.
815 static int mei_cl_send_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb)
817 struct mei_device *dev;
822 ret = mei_hbm_cl_disconnect_req(dev, cl);
825 cl->state = MEI_FILE_DISCONNECT_REPLY;
829 list_move_tail(&cb->list, &dev->ctrl_rd_list);
830 cl->timer_count = MEI_CONNECT_TIMEOUT;
831 mei_schedule_stall_timer(dev);
837 * mei_cl_irq_disconnect - processes close related operation from
838 * interrupt thread context - send disconnect request
841 * @cb: callback block.
842 * @cmpl_list: complete list.
844 * Return: 0, OK; otherwise, error.
846 int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
847 struct list_head *cmpl_list)
849 struct mei_device *dev = cl->dev;
854 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
855 slots = mei_hbuf_empty_slots(dev);
857 if (slots < msg_slots)
860 ret = mei_cl_send_disconnect(cl, cb);
862 list_move_tail(&cb->list, cmpl_list);
868 * __mei_cl_disconnect - disconnect host client from the me one
869 * internal function runtime pm has to be already acquired
873 * Return: 0 on success, <0 on failure.
875 static int __mei_cl_disconnect(struct mei_cl *cl)
877 struct mei_device *dev;
878 struct mei_cl_cb *cb;
883 cl->state = MEI_FILE_DISCONNECTING;
885 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, MEI_FOP_DISCONNECT, NULL);
891 if (mei_hbuf_acquire(dev)) {
892 rets = mei_cl_send_disconnect(cl, cb);
894 cl_err(dev, cl, "failed to disconnect.\n");
899 mutex_unlock(&dev->device_lock);
900 wait_event_timeout(cl->wait,
901 cl->state == MEI_FILE_DISCONNECT_REPLY ||
902 cl->state == MEI_FILE_DISCONNECTED,
903 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
904 mutex_lock(&dev->device_lock);
907 if (cl->state != MEI_FILE_DISCONNECT_REPLY &&
908 cl->state != MEI_FILE_DISCONNECTED) {
909 cl_dbg(dev, cl, "timeout on disconnect from FW client.\n");
914 /* we disconnect also on error */
915 mei_cl_set_disconnected(cl);
917 cl_dbg(dev, cl, "successfully disconnected from FW client.\n");
924 * mei_cl_disconnect - disconnect host client from the me one
928 * Locking: called under "dev->device_lock" lock
930 * Return: 0 on success, <0 on failure.
932 int mei_cl_disconnect(struct mei_cl *cl)
934 struct mei_device *dev;
937 if (WARN_ON(!cl || !cl->dev))
942 cl_dbg(dev, cl, "disconnecting");
944 if (!mei_cl_is_connected(cl))
947 if (mei_cl_is_fixed_address(cl)) {
948 mei_cl_set_disconnected(cl);
952 rets = pm_runtime_get(dev->dev);
953 if (rets < 0 && rets != -EINPROGRESS) {
954 pm_runtime_put_noidle(dev->dev);
955 cl_err(dev, cl, "rpm: get failed %d\n", rets);
959 rets = __mei_cl_disconnect(cl);
961 cl_dbg(dev, cl, "rpm: autosuspend\n");
962 pm_runtime_mark_last_busy(dev->dev);
963 pm_runtime_put_autosuspend(dev->dev);
970 * mei_cl_is_other_connecting - checks if other
971 * client with the same me client id is connecting
973 * @cl: private data of the file object
975 * Return: true if other client is connected, false - otherwise.
977 static bool mei_cl_is_other_connecting(struct mei_cl *cl)
979 struct mei_device *dev;
980 struct mei_cl_cb *cb;
984 list_for_each_entry(cb, &dev->ctrl_rd_list, list) {
985 if (cb->fop_type == MEI_FOP_CONNECT &&
986 mei_cl_me_id(cl) == mei_cl_me_id(cb->cl))
994 * mei_cl_send_connect - send connect request
997 * @cb: callback block
999 * Return: 0, OK; otherwise, error.
1001 static int mei_cl_send_connect(struct mei_cl *cl, struct mei_cl_cb *cb)
1003 struct mei_device *dev;
1008 ret = mei_hbm_cl_connect_req(dev, cl);
1011 cl->state = MEI_FILE_DISCONNECT_REPLY;
1015 list_move_tail(&cb->list, &dev->ctrl_rd_list);
1016 cl->timer_count = MEI_CONNECT_TIMEOUT;
1017 mei_schedule_stall_timer(dev);
1022 * mei_cl_irq_connect - send connect request in irq_thread context
1025 * @cb: callback block
1026 * @cmpl_list: complete list
1028 * Return: 0, OK; otherwise, error.
1030 int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
1031 struct list_head *cmpl_list)
1033 struct mei_device *dev = cl->dev;
1038 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1039 slots = mei_hbuf_empty_slots(dev);
1041 if (mei_cl_is_other_connecting(cl))
1044 if (slots < msg_slots)
1047 rets = mei_cl_send_connect(cl, cb);
1049 list_move_tail(&cb->list, cmpl_list);
1055 * mei_cl_connect - connect host client to the me one
1059 * @fp: pointer to file structure
1061 * Locking: called under "dev->device_lock" lock
1063 * Return: 0 on success, <0 on failure.
1065 int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl,
1066 const struct file *fp)
1068 struct mei_device *dev;
1069 struct mei_cl_cb *cb;
1072 if (WARN_ON(!cl || !cl->dev || !me_cl))
1077 if (!mei_cl_bus_module_get(cl))
1080 rets = mei_cl_set_connecting(cl, me_cl);
1084 if (mei_cl_is_fixed_address(cl)) {
1085 cl->state = MEI_FILE_CONNECTED;
1090 rets = pm_runtime_get(dev->dev);
1091 if (rets < 0 && rets != -EINPROGRESS) {
1092 pm_runtime_put_noidle(dev->dev);
1093 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1097 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, MEI_FOP_CONNECT, fp);
1103 /* run hbuf acquire last so we don't have to undo */
1104 if (!mei_cl_is_other_connecting(cl) && mei_hbuf_acquire(dev)) {
1105 rets = mei_cl_send_connect(cl, cb);
1110 mutex_unlock(&dev->device_lock);
1111 wait_event_timeout(cl->wait,
1112 (cl->state == MEI_FILE_CONNECTED ||
1113 cl->state == MEI_FILE_DISCONNECTED ||
1114 cl->state == MEI_FILE_DISCONNECT_REQUIRED ||
1115 cl->state == MEI_FILE_DISCONNECT_REPLY),
1116 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1117 mutex_lock(&dev->device_lock);
1119 if (!mei_cl_is_connected(cl)) {
1120 if (cl->state == MEI_FILE_DISCONNECT_REQUIRED) {
1121 mei_io_list_flush_cl(&dev->ctrl_rd_list, cl);
1122 mei_io_list_flush_cl(&dev->ctrl_wr_list, cl);
1123 /* ignore disconnect return valuue;
1124 * in case of failure reset will be invoked
1126 __mei_cl_disconnect(cl);
1131 /* timeout or something went really wrong */
1133 cl->status = -EFAULT;
1138 cl_dbg(dev, cl, "rpm: autosuspend\n");
1139 pm_runtime_mark_last_busy(dev->dev);
1140 pm_runtime_put_autosuspend(dev->dev);
1145 if (!mei_cl_is_connected(cl))
1146 mei_cl_set_disconnected(cl);
1152 * mei_cl_alloc_linked - allocate and link host client
1154 * @dev: the device structure
1156 * Return: cl on success ERR_PTR on failure
1158 struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev)
1163 cl = mei_cl_allocate(dev);
1169 ret = mei_cl_link(cl);
1176 return ERR_PTR(ret);
1180 * mei_cl_tx_flow_ctrl_creds - checks flow_control credits for cl.
1184 * Return: 1 if tx_flow_ctrl_creds >0, 0 - otherwise.
1186 static int mei_cl_tx_flow_ctrl_creds(struct mei_cl *cl)
1188 if (WARN_ON(!cl || !cl->me_cl))
1191 if (cl->tx_flow_ctrl_creds > 0)
1194 if (mei_cl_is_fixed_address(cl))
1197 if (mei_cl_is_single_recv_buf(cl)) {
1198 if (cl->me_cl->tx_flow_ctrl_creds > 0)
1205 * mei_cl_tx_flow_ctrl_creds_reduce - reduces transmit flow control credits
1212 * -EINVAL when ctrl credits are <= 0
1214 static int mei_cl_tx_flow_ctrl_creds_reduce(struct mei_cl *cl)
1216 if (WARN_ON(!cl || !cl->me_cl))
1219 if (mei_cl_is_fixed_address(cl))
1222 if (mei_cl_is_single_recv_buf(cl)) {
1223 if (WARN_ON(cl->me_cl->tx_flow_ctrl_creds <= 0))
1225 cl->me_cl->tx_flow_ctrl_creds--;
1227 if (WARN_ON(cl->tx_flow_ctrl_creds <= 0))
1229 cl->tx_flow_ctrl_creds--;
1235 * mei_cl_notify_fop2req - convert fop to proper request
1237 * @fop: client notification start response command
1239 * Return: MEI_HBM_NOTIFICATION_START/STOP
1241 u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop)
1243 if (fop == MEI_FOP_NOTIFY_START)
1244 return MEI_HBM_NOTIFICATION_START;
1246 return MEI_HBM_NOTIFICATION_STOP;
1250 * mei_cl_notify_req2fop - convert notification request top file operation type
1252 * @req: hbm notification request type
1254 * Return: MEI_FOP_NOTIFY_START/STOP
1256 enum mei_cb_file_ops mei_cl_notify_req2fop(u8 req)
1258 if (req == MEI_HBM_NOTIFICATION_START)
1259 return MEI_FOP_NOTIFY_START;
1261 return MEI_FOP_NOTIFY_STOP;
1265 * mei_cl_irq_notify - send notification request in irq_thread context
1268 * @cb: callback block.
1269 * @cmpl_list: complete list.
1271 * Return: 0 on such and error otherwise.
1273 int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb,
1274 struct list_head *cmpl_list)
1276 struct mei_device *dev = cl->dev;
1282 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1283 slots = mei_hbuf_empty_slots(dev);
1285 if (slots < msg_slots)
1288 request = mei_cl_notify_fop2req(cb->fop_type);
1289 ret = mei_hbm_cl_notify_req(dev, cl, request);
1292 list_move_tail(&cb->list, cmpl_list);
1296 list_move_tail(&cb->list, &dev->ctrl_rd_list);
1301 * mei_cl_notify_request - send notification stop/start request
1304 * @fp: associate request with file
1305 * @request: 1 for start or 0 for stop
1307 * Locking: called under "dev->device_lock" lock
1309 * Return: 0 on such and error otherwise.
1311 int mei_cl_notify_request(struct mei_cl *cl,
1312 const struct file *fp, u8 request)
1314 struct mei_device *dev;
1315 struct mei_cl_cb *cb;
1316 enum mei_cb_file_ops fop_type;
1319 if (WARN_ON(!cl || !cl->dev))
1324 if (!dev->hbm_f_ev_supported) {
1325 cl_dbg(dev, cl, "notifications not supported\n");
1329 if (!mei_cl_is_connected(cl))
1332 rets = pm_runtime_get(dev->dev);
1333 if (rets < 0 && rets != -EINPROGRESS) {
1334 pm_runtime_put_noidle(dev->dev);
1335 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1339 fop_type = mei_cl_notify_req2fop(request);
1340 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, fop_type, fp);
1346 if (mei_hbuf_acquire(dev)) {
1347 if (mei_hbm_cl_notify_req(dev, cl, request)) {
1351 list_move_tail(&cb->list, &dev->ctrl_rd_list);
1354 mutex_unlock(&dev->device_lock);
1355 wait_event_timeout(cl->wait,
1356 cl->notify_en == request || !mei_cl_is_connected(cl),
1357 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1358 mutex_lock(&dev->device_lock);
1360 if (cl->notify_en != request && !cl->status)
1361 cl->status = -EFAULT;
1366 cl_dbg(dev, cl, "rpm: autosuspend\n");
1367 pm_runtime_mark_last_busy(dev->dev);
1368 pm_runtime_put_autosuspend(dev->dev);
1375 * mei_cl_notify - raise notification
1379 * Locking: called under "dev->device_lock" lock
1381 void mei_cl_notify(struct mei_cl *cl)
1383 struct mei_device *dev;
1385 if (!cl || !cl->dev)
1393 cl_dbg(dev, cl, "notify event");
1394 cl->notify_ev = true;
1395 if (!mei_cl_bus_notify_event(cl))
1396 wake_up_interruptible(&cl->ev_wait);
1399 kill_fasync(&cl->ev_async, SIGIO, POLL_PRI);
1404 * mei_cl_notify_get - get or wait for notification event
1407 * @block: this request is blocking
1408 * @notify_ev: true if notification event was received
1410 * Locking: called under "dev->device_lock" lock
1412 * Return: 0 on such and error otherwise.
1414 int mei_cl_notify_get(struct mei_cl *cl, bool block, bool *notify_ev)
1416 struct mei_device *dev;
1421 if (WARN_ON(!cl || !cl->dev))
1426 if (!dev->hbm_f_ev_supported) {
1427 cl_dbg(dev, cl, "notifications not supported\n");
1431 if (!mei_cl_is_connected(cl))
1440 mutex_unlock(&dev->device_lock);
1441 rets = wait_event_interruptible(cl->ev_wait, cl->notify_ev);
1442 mutex_lock(&dev->device_lock);
1448 *notify_ev = cl->notify_ev;
1449 cl->notify_ev = false;
1454 * mei_cl_read_start - the start read client message function.
1457 * @length: number of bytes to read
1458 * @fp: pointer to file structure
1460 * Return: 0 on success, <0 on failure.
1462 int mei_cl_read_start(struct mei_cl *cl, size_t length, const struct file *fp)
1464 struct mei_device *dev;
1465 struct mei_cl_cb *cb;
1468 if (WARN_ON(!cl || !cl->dev))
1473 if (!mei_cl_is_connected(cl))
1476 if (!mei_me_cl_is_active(cl->me_cl)) {
1477 cl_err(dev, cl, "no such me client\n");
1481 if (mei_cl_is_fixed_address(cl) || cl == &dev->iamthif_cl)
1484 /* HW currently supports only one pending read */
1485 if (cl->rx_flow_ctrl_creds)
1488 cb = mei_cl_enqueue_ctrl_wr_cb(cl, length, MEI_FOP_READ, fp);
1492 rets = pm_runtime_get(dev->dev);
1493 if (rets < 0 && rets != -EINPROGRESS) {
1494 pm_runtime_put_noidle(dev->dev);
1495 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1500 if (mei_hbuf_acquire(dev)) {
1501 rets = mei_hbm_cl_flow_control_req(dev, cl);
1505 list_move_tail(&cb->list, &cl->rd_pending);
1507 cl->rx_flow_ctrl_creds++;
1510 cl_dbg(dev, cl, "rpm: autosuspend\n");
1511 pm_runtime_mark_last_busy(dev->dev);
1512 pm_runtime_put_autosuspend(dev->dev);
1521 * mei_cl_irq_write - write a message to device
1522 * from the interrupt thread context
1525 * @cb: callback block.
1526 * @cmpl_list: complete list.
1528 * Return: 0, OK; otherwise error.
1530 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
1531 struct list_head *cmpl_list)
1533 struct mei_device *dev;
1534 struct mei_msg_data *buf;
1535 struct mei_msg_hdr mei_hdr;
1542 if (WARN_ON(!cl || !cl->dev))
1549 first_chunk = cb->buf_idx == 0;
1551 rets = first_chunk ? mei_cl_tx_flow_ctrl_creds(cl) : 1;
1556 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1560 slots = mei_hbuf_empty_slots(dev);
1561 len = buf->size - cb->buf_idx;
1562 msg_slots = mei_data2slots(len);
1564 mei_hdr.host_addr = mei_cl_host_addr(cl);
1565 mei_hdr.me_addr = mei_cl_me_id(cl);
1566 mei_hdr.reserved = 0;
1567 mei_hdr.internal = cb->internal;
1569 if (slots >= msg_slots) {
1570 mei_hdr.length = len;
1571 mei_hdr.msg_complete = 1;
1572 /* Split the message only if we can write the whole host buffer */
1573 } else if (slots == dev->hbuf_depth) {
1575 len = (slots * sizeof(u32)) - sizeof(struct mei_msg_hdr);
1576 mei_hdr.length = len;
1577 mei_hdr.msg_complete = 0;
1579 /* wait for next time the host buffer is empty */
1583 cl_dbg(dev, cl, "buf: size = %zu idx = %zu\n",
1584 cb->buf.size, cb->buf_idx);
1586 rets = mei_write_message(dev, &mei_hdr, buf->data + cb->buf_idx);
1591 cl->writing_state = MEI_WRITING;
1592 cb->buf_idx += mei_hdr.length;
1593 cb->completed = mei_hdr.msg_complete == 1;
1596 if (mei_cl_tx_flow_ctrl_creds_reduce(cl)) {
1602 if (mei_hdr.msg_complete)
1603 list_move_tail(&cb->list, &dev->write_waiting_list);
1609 list_move_tail(&cb->list, cmpl_list);
1614 * mei_cl_write - submit a write cb to mei device
1615 * assumes device_lock is locked
1618 * @cb: write callback with filled data
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)
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))
1641 blocking = cb->blocking;
1643 cl_dbg(dev, cl, "size=%d\n", size);
1645 rets = pm_runtime_get(dev->dev);
1646 if (rets < 0 && rets != -EINPROGRESS) {
1647 pm_runtime_put_noidle(dev->dev);
1648 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1653 cl->writing_state = MEI_IDLE;
1655 mei_hdr.host_addr = mei_cl_host_addr(cl);
1656 mei_hdr.me_addr = mei_cl_me_id(cl);
1657 mei_hdr.reserved = 0;
1658 mei_hdr.msg_complete = 0;
1659 mei_hdr.internal = cb->internal;
1661 rets = mei_cl_tx_flow_ctrl_creds(cl);
1666 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1670 if (!mei_hbuf_acquire(dev)) {
1671 cl_dbg(dev, cl, "Cannot acquire the host buffer: not sending.\n");
1676 /* Check for a maximum length */
1677 if (size > mei_hbuf_max_len(dev)) {
1678 mei_hdr.length = mei_hbuf_max_len(dev);
1679 mei_hdr.msg_complete = 0;
1681 mei_hdr.length = size;
1682 mei_hdr.msg_complete = 1;
1685 rets = mei_write_message(dev, &mei_hdr, buf->data);
1689 rets = mei_cl_tx_flow_ctrl_creds_reduce(cl);
1693 cl->writing_state = MEI_WRITING;
1694 cb->buf_idx = mei_hdr.length;
1695 cb->completed = mei_hdr.msg_complete == 1;
1698 if (mei_hdr.msg_complete)
1699 list_add_tail(&cb->list, &dev->write_waiting_list);
1701 list_add_tail(&cb->list, &dev->write_list);
1704 if (blocking && cl->writing_state != MEI_WRITE_COMPLETE) {
1706 mutex_unlock(&dev->device_lock);
1707 rets = wait_event_interruptible(cl->tx_wait,
1708 cl->writing_state == MEI_WRITE_COMPLETE ||
1709 (!mei_cl_is_connected(cl)));
1710 mutex_lock(&dev->device_lock);
1711 /* wait_event_interruptible returns -ERESTARTSYS */
1713 if (signal_pending(current))
1717 if (cl->writing_state != MEI_WRITE_COMPLETE) {
1725 cl_dbg(dev, cl, "rpm: autosuspend\n");
1726 pm_runtime_mark_last_busy(dev->dev);
1727 pm_runtime_put_autosuspend(dev->dev);
1736 * mei_cl_complete - processes completed operation for a client
1738 * @cl: private data of the file object.
1739 * @cb: callback block.
1741 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb)
1743 struct mei_device *dev = cl->dev;
1745 switch (cb->fop_type) {
1748 cl->writing_state = MEI_WRITE_COMPLETE;
1749 if (waitqueue_active(&cl->tx_wait)) {
1750 wake_up_interruptible(&cl->tx_wait);
1752 pm_runtime_mark_last_busy(dev->dev);
1753 pm_request_autosuspend(dev->dev);
1758 list_add_tail(&cb->list, &cl->rd_completed);
1759 if (!mei_cl_is_fixed_address(cl) &&
1760 !WARN_ON(!cl->rx_flow_ctrl_creds))
1761 cl->rx_flow_ctrl_creds--;
1762 if (!mei_cl_bus_rx_event(cl))
1763 wake_up_interruptible(&cl->rx_wait);
1766 case MEI_FOP_CONNECT:
1767 case MEI_FOP_DISCONNECT:
1768 case MEI_FOP_NOTIFY_STOP:
1769 case MEI_FOP_NOTIFY_START:
1770 if (waitqueue_active(&cl->wait))
1774 case MEI_FOP_DISCONNECT_RSP:
1776 mei_cl_set_disconnected(cl);
1785 * mei_cl_all_disconnect - disconnect forcefully all connected clients
1789 void mei_cl_all_disconnect(struct mei_device *dev)
1793 list_for_each_entry(cl, &dev->file_list, link)
1794 mei_cl_set_disconnected(cl);