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_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 static 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 static 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;
605 if (WARN_ON(!cl || !cl->dev))
610 id = find_first_zero_bit(dev->host_clients_map, MEI_CLIENTS_MAX);
611 if (id >= MEI_CLIENTS_MAX) {
612 dev_err(dev->dev, "id exceeded %d", MEI_CLIENTS_MAX);
616 if (dev->open_handle_count >= MEI_MAX_OPEN_HANDLE_COUNT) {
617 dev_err(dev->dev, "open_handle_count exceeded %d",
618 MEI_MAX_OPEN_HANDLE_COUNT);
622 dev->open_handle_count++;
624 cl->host_client_id = id;
625 list_add_tail(&cl->link, &dev->file_list);
627 set_bit(id, dev->host_clients_map);
629 cl->state = MEI_FILE_INITIALIZING;
631 cl_dbg(dev, cl, "link cl\n");
636 * mei_cl_unlink - remove host client from the list
642 int mei_cl_unlink(struct mei_cl *cl)
644 struct mei_device *dev;
646 /* don't shout on error exit path */
650 if (WARN_ON(!cl->dev))
655 cl_dbg(dev, cl, "unlink client");
657 if (dev->open_handle_count > 0)
658 dev->open_handle_count--;
660 /* never clear the 0 bit */
661 if (cl->host_client_id)
662 clear_bit(cl->host_client_id, dev->host_clients_map);
664 list_del_init(&cl->link);
666 cl->state = MEI_FILE_UNINITIALIZED;
667 cl->writing_state = MEI_IDLE;
669 WARN_ON(!list_empty(&cl->rd_completed) ||
670 !list_empty(&cl->rd_pending) ||
671 !list_empty(&cl->link));
676 void mei_host_client_init(struct mei_device *dev)
678 dev->dev_state = MEI_DEV_ENABLED;
679 dev->reset_count = 0;
681 schedule_work(&dev->bus_rescan_work);
683 pm_runtime_mark_last_busy(dev->dev);
684 dev_dbg(dev->dev, "rpm: autosuspend\n");
685 pm_request_autosuspend(dev->dev);
689 * mei_hbuf_acquire - try to acquire host buffer
691 * @dev: the device structure
692 * Return: true if host buffer was acquired
694 bool mei_hbuf_acquire(struct mei_device *dev)
696 if (mei_pg_state(dev) == MEI_PG_ON ||
697 mei_pg_in_transition(dev)) {
698 dev_dbg(dev->dev, "device is in pg\n");
702 if (!dev->hbuf_is_ready) {
703 dev_dbg(dev->dev, "hbuf is not ready\n");
707 dev->hbuf_is_ready = false;
713 * mei_cl_wake_all - wake up readers, writers and event waiters so
714 * they can be interrupted
718 static void mei_cl_wake_all(struct mei_cl *cl)
720 struct mei_device *dev = cl->dev;
722 /* synchronized under device mutex */
723 if (waitqueue_active(&cl->rx_wait)) {
724 cl_dbg(dev, cl, "Waking up reading client!\n");
725 wake_up_interruptible(&cl->rx_wait);
727 /* synchronized under device mutex */
728 if (waitqueue_active(&cl->tx_wait)) {
729 cl_dbg(dev, cl, "Waking up writing client!\n");
730 wake_up_interruptible(&cl->tx_wait);
732 /* synchronized under device mutex */
733 if (waitqueue_active(&cl->ev_wait)) {
734 cl_dbg(dev, cl, "Waking up waiting for event clients!\n");
735 wake_up_interruptible(&cl->ev_wait);
737 /* synchronized under device mutex */
738 if (waitqueue_active(&cl->wait)) {
739 cl_dbg(dev, cl, "Waking up ctrl write clients!\n");
745 * mei_cl_set_disconnected - set disconnected state and clear
746 * associated states and resources
750 static void mei_cl_set_disconnected(struct mei_cl *cl)
752 struct mei_device *dev = cl->dev;
754 if (cl->state == MEI_FILE_DISCONNECTED ||
755 cl->state <= MEI_FILE_INITIALIZING)
758 cl->state = MEI_FILE_DISCONNECTED;
759 mei_io_list_free_cl(&dev->write_list, cl);
760 mei_io_list_free_cl(&dev->write_waiting_list, cl);
761 mei_io_list_flush_cl(&dev->ctrl_rd_list, cl);
762 mei_io_list_flush_cl(&dev->ctrl_wr_list, cl);
764 cl->rx_flow_ctrl_creds = 0;
765 cl->tx_flow_ctrl_creds = 0;
768 mei_cl_bus_module_put(cl);
773 if (!WARN_ON(cl->me_cl->connect_count == 0))
774 cl->me_cl->connect_count--;
776 if (cl->me_cl->connect_count == 0)
777 cl->me_cl->tx_flow_ctrl_creds = 0;
779 mei_me_cl_put(cl->me_cl);
783 static int mei_cl_set_connecting(struct mei_cl *cl, struct mei_me_client *me_cl)
785 if (!mei_me_cl_get(me_cl))
788 /* only one connection is allowed for fixed address clients */
789 if (me_cl->props.fixed_address) {
790 if (me_cl->connect_count) {
791 mei_me_cl_put(me_cl);
797 cl->state = MEI_FILE_CONNECTING;
798 cl->me_cl->connect_count++;
804 * mei_cl_send_disconnect - send disconnect request
807 * @cb: callback block
809 * Return: 0, OK; otherwise, error.
811 static int mei_cl_send_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb)
813 struct mei_device *dev;
818 ret = mei_hbm_cl_disconnect_req(dev, cl);
821 cl->state = MEI_FILE_DISCONNECT_REPLY;
825 list_move_tail(&cb->list, &dev->ctrl_rd_list);
826 cl->timer_count = MEI_CONNECT_TIMEOUT;
827 mei_schedule_stall_timer(dev);
833 * mei_cl_irq_disconnect - processes close related operation from
834 * interrupt thread context - send disconnect request
837 * @cb: callback block.
838 * @cmpl_list: complete list.
840 * Return: 0, OK; otherwise, error.
842 int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
843 struct list_head *cmpl_list)
845 struct mei_device *dev = cl->dev;
850 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
851 slots = mei_hbuf_empty_slots(dev);
853 if (slots < msg_slots)
856 ret = mei_cl_send_disconnect(cl, cb);
858 list_move_tail(&cb->list, cmpl_list);
864 * __mei_cl_disconnect - disconnect host client from the me one
865 * internal function runtime pm has to be already acquired
869 * Return: 0 on success, <0 on failure.
871 static int __mei_cl_disconnect(struct mei_cl *cl)
873 struct mei_device *dev;
874 struct mei_cl_cb *cb;
879 cl->state = MEI_FILE_DISCONNECTING;
881 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, MEI_FOP_DISCONNECT, NULL);
887 if (mei_hbuf_acquire(dev)) {
888 rets = mei_cl_send_disconnect(cl, cb);
890 cl_err(dev, cl, "failed to disconnect.\n");
895 mutex_unlock(&dev->device_lock);
896 wait_event_timeout(cl->wait,
897 cl->state == MEI_FILE_DISCONNECT_REPLY ||
898 cl->state == MEI_FILE_DISCONNECTED,
899 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
900 mutex_lock(&dev->device_lock);
903 if (cl->state != MEI_FILE_DISCONNECT_REPLY &&
904 cl->state != MEI_FILE_DISCONNECTED) {
905 cl_dbg(dev, cl, "timeout on disconnect from FW client.\n");
910 /* we disconnect also on error */
911 mei_cl_set_disconnected(cl);
913 cl_dbg(dev, cl, "successfully disconnected from FW client.\n");
920 * mei_cl_disconnect - disconnect host client from the me one
924 * Locking: called under "dev->device_lock" lock
926 * Return: 0 on success, <0 on failure.
928 int mei_cl_disconnect(struct mei_cl *cl)
930 struct mei_device *dev;
933 if (WARN_ON(!cl || !cl->dev))
938 cl_dbg(dev, cl, "disconnecting");
940 if (!mei_cl_is_connected(cl))
943 if (mei_cl_is_fixed_address(cl)) {
944 mei_cl_set_disconnected(cl);
948 rets = pm_runtime_get(dev->dev);
949 if (rets < 0 && rets != -EINPROGRESS) {
950 pm_runtime_put_noidle(dev->dev);
951 cl_err(dev, cl, "rpm: get failed %d\n", rets);
955 rets = __mei_cl_disconnect(cl);
957 cl_dbg(dev, cl, "rpm: autosuspend\n");
958 pm_runtime_mark_last_busy(dev->dev);
959 pm_runtime_put_autosuspend(dev->dev);
966 * mei_cl_is_other_connecting - checks if other
967 * client with the same me client id is connecting
969 * @cl: private data of the file object
971 * Return: true if other client is connected, false - otherwise.
973 static bool mei_cl_is_other_connecting(struct mei_cl *cl)
975 struct mei_device *dev;
976 struct mei_cl_cb *cb;
980 list_for_each_entry(cb, &dev->ctrl_rd_list, list) {
981 if (cb->fop_type == MEI_FOP_CONNECT &&
982 mei_cl_me_id(cl) == mei_cl_me_id(cb->cl))
990 * mei_cl_send_connect - send connect request
993 * @cb: callback block
995 * Return: 0, OK; otherwise, error.
997 static int mei_cl_send_connect(struct mei_cl *cl, struct mei_cl_cb *cb)
999 struct mei_device *dev;
1004 ret = mei_hbm_cl_connect_req(dev, cl);
1007 cl->state = MEI_FILE_DISCONNECT_REPLY;
1011 list_move_tail(&cb->list, &dev->ctrl_rd_list);
1012 cl->timer_count = MEI_CONNECT_TIMEOUT;
1013 mei_schedule_stall_timer(dev);
1018 * mei_cl_irq_connect - send connect request in irq_thread context
1021 * @cb: callback block
1022 * @cmpl_list: complete list
1024 * Return: 0, OK; otherwise, error.
1026 int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
1027 struct list_head *cmpl_list)
1029 struct mei_device *dev = cl->dev;
1034 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1035 slots = mei_hbuf_empty_slots(dev);
1037 if (mei_cl_is_other_connecting(cl))
1040 if (slots < msg_slots)
1043 rets = mei_cl_send_connect(cl, cb);
1045 list_move_tail(&cb->list, cmpl_list);
1051 * mei_cl_connect - connect host client to the me one
1055 * @fp: pointer to file structure
1057 * Locking: called under "dev->device_lock" lock
1059 * Return: 0 on success, <0 on failure.
1061 int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl,
1062 const struct file *fp)
1064 struct mei_device *dev;
1065 struct mei_cl_cb *cb;
1068 if (WARN_ON(!cl || !cl->dev || !me_cl))
1073 if (!mei_cl_bus_module_get(cl))
1076 rets = mei_cl_set_connecting(cl, me_cl);
1080 if (mei_cl_is_fixed_address(cl)) {
1081 cl->state = MEI_FILE_CONNECTED;
1086 rets = pm_runtime_get(dev->dev);
1087 if (rets < 0 && rets != -EINPROGRESS) {
1088 pm_runtime_put_noidle(dev->dev);
1089 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1093 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, MEI_FOP_CONNECT, fp);
1099 /* run hbuf acquire last so we don't have to undo */
1100 if (!mei_cl_is_other_connecting(cl) && mei_hbuf_acquire(dev)) {
1101 rets = mei_cl_send_connect(cl, cb);
1106 mutex_unlock(&dev->device_lock);
1107 wait_event_timeout(cl->wait,
1108 (cl->state == MEI_FILE_CONNECTED ||
1109 cl->state == MEI_FILE_DISCONNECTED ||
1110 cl->state == MEI_FILE_DISCONNECT_REQUIRED ||
1111 cl->state == MEI_FILE_DISCONNECT_REPLY),
1112 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1113 mutex_lock(&dev->device_lock);
1115 if (!mei_cl_is_connected(cl)) {
1116 if (cl->state == MEI_FILE_DISCONNECT_REQUIRED) {
1117 mei_io_list_flush_cl(&dev->ctrl_rd_list, cl);
1118 mei_io_list_flush_cl(&dev->ctrl_wr_list, cl);
1119 /* ignore disconnect return valuue;
1120 * in case of failure reset will be invoked
1122 __mei_cl_disconnect(cl);
1127 /* timeout or something went really wrong */
1129 cl->status = -EFAULT;
1134 cl_dbg(dev, cl, "rpm: autosuspend\n");
1135 pm_runtime_mark_last_busy(dev->dev);
1136 pm_runtime_put_autosuspend(dev->dev);
1141 if (!mei_cl_is_connected(cl))
1142 mei_cl_set_disconnected(cl);
1148 * mei_cl_alloc_linked - allocate and link host client
1150 * @dev: the device structure
1152 * Return: cl on success ERR_PTR on failure
1154 struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev)
1159 cl = mei_cl_allocate(dev);
1165 ret = mei_cl_link(cl);
1172 return ERR_PTR(ret);
1176 * mei_cl_tx_flow_ctrl_creds - checks flow_control credits for cl.
1180 * Return: 1 if tx_flow_ctrl_creds >0, 0 - otherwise.
1182 static int mei_cl_tx_flow_ctrl_creds(struct mei_cl *cl)
1184 if (WARN_ON(!cl || !cl->me_cl))
1187 if (cl->tx_flow_ctrl_creds > 0)
1190 if (mei_cl_is_fixed_address(cl))
1193 if (mei_cl_is_single_recv_buf(cl)) {
1194 if (cl->me_cl->tx_flow_ctrl_creds > 0)
1201 * mei_cl_tx_flow_ctrl_creds_reduce - reduces transmit flow control credits
1208 * -EINVAL when ctrl credits are <= 0
1210 static int mei_cl_tx_flow_ctrl_creds_reduce(struct mei_cl *cl)
1212 if (WARN_ON(!cl || !cl->me_cl))
1215 if (mei_cl_is_fixed_address(cl))
1218 if (mei_cl_is_single_recv_buf(cl)) {
1219 if (WARN_ON(cl->me_cl->tx_flow_ctrl_creds <= 0))
1221 cl->me_cl->tx_flow_ctrl_creds--;
1223 if (WARN_ON(cl->tx_flow_ctrl_creds <= 0))
1225 cl->tx_flow_ctrl_creds--;
1231 * mei_cl_notify_fop2req - convert fop to proper request
1233 * @fop: client notification start response command
1235 * Return: MEI_HBM_NOTIFICATION_START/STOP
1237 u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop)
1239 if (fop == MEI_FOP_NOTIFY_START)
1240 return MEI_HBM_NOTIFICATION_START;
1242 return MEI_HBM_NOTIFICATION_STOP;
1246 * mei_cl_notify_req2fop - convert notification request top file operation type
1248 * @req: hbm notification request type
1250 * Return: MEI_FOP_NOTIFY_START/STOP
1252 enum mei_cb_file_ops mei_cl_notify_req2fop(u8 req)
1254 if (req == MEI_HBM_NOTIFICATION_START)
1255 return MEI_FOP_NOTIFY_START;
1257 return MEI_FOP_NOTIFY_STOP;
1261 * mei_cl_irq_notify - send notification request in irq_thread context
1264 * @cb: callback block.
1265 * @cmpl_list: complete list.
1267 * Return: 0 on such and error otherwise.
1269 int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb,
1270 struct list_head *cmpl_list)
1272 struct mei_device *dev = cl->dev;
1278 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1279 slots = mei_hbuf_empty_slots(dev);
1281 if (slots < msg_slots)
1284 request = mei_cl_notify_fop2req(cb->fop_type);
1285 ret = mei_hbm_cl_notify_req(dev, cl, request);
1288 list_move_tail(&cb->list, cmpl_list);
1292 list_move_tail(&cb->list, &dev->ctrl_rd_list);
1297 * mei_cl_notify_request - send notification stop/start request
1300 * @fp: associate request with file
1301 * @request: 1 for start or 0 for stop
1303 * Locking: called under "dev->device_lock" lock
1305 * Return: 0 on such and error otherwise.
1307 int mei_cl_notify_request(struct mei_cl *cl,
1308 const struct file *fp, u8 request)
1310 struct mei_device *dev;
1311 struct mei_cl_cb *cb;
1312 enum mei_cb_file_ops fop_type;
1315 if (WARN_ON(!cl || !cl->dev))
1320 if (!dev->hbm_f_ev_supported) {
1321 cl_dbg(dev, cl, "notifications not supported\n");
1325 if (!mei_cl_is_connected(cl))
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);
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 (!dev->hbm_f_ev_supported) {
1423 cl_dbg(dev, cl, "notifications not supported\n");
1427 if (!mei_cl_is_connected(cl))
1436 mutex_unlock(&dev->device_lock);
1437 rets = wait_event_interruptible(cl->ev_wait, cl->notify_ev);
1438 mutex_lock(&dev->device_lock);
1444 *notify_ev = cl->notify_ev;
1445 cl->notify_ev = false;
1450 * mei_cl_read_start - the start read client message function.
1453 * @length: number of bytes to read
1454 * @fp: pointer to file structure
1456 * Return: 0 on success, <0 on failure.
1458 int mei_cl_read_start(struct mei_cl *cl, size_t length, const struct file *fp)
1460 struct mei_device *dev;
1461 struct mei_cl_cb *cb;
1464 if (WARN_ON(!cl || !cl->dev))
1469 if (!mei_cl_is_connected(cl))
1472 if (!mei_me_cl_is_active(cl->me_cl)) {
1473 cl_err(dev, cl, "no such me client\n");
1477 if (mei_cl_is_fixed_address(cl))
1480 /* HW currently supports only one pending read */
1481 if (cl->rx_flow_ctrl_creds)
1484 cb = mei_cl_enqueue_ctrl_wr_cb(cl, length, MEI_FOP_READ, fp);
1488 rets = pm_runtime_get(dev->dev);
1489 if (rets < 0 && rets != -EINPROGRESS) {
1490 pm_runtime_put_noidle(dev->dev);
1491 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1496 if (mei_hbuf_acquire(dev)) {
1497 rets = mei_hbm_cl_flow_control_req(dev, cl);
1501 list_move_tail(&cb->list, &cl->rd_pending);
1503 cl->rx_flow_ctrl_creds++;
1506 cl_dbg(dev, cl, "rpm: autosuspend\n");
1507 pm_runtime_mark_last_busy(dev->dev);
1508 pm_runtime_put_autosuspend(dev->dev);
1517 * mei_cl_irq_write - write a message to device
1518 * from the interrupt thread context
1521 * @cb: callback block.
1522 * @cmpl_list: complete list.
1524 * Return: 0, OK; otherwise error.
1526 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
1527 struct list_head *cmpl_list)
1529 struct mei_device *dev;
1530 struct mei_msg_data *buf;
1531 struct mei_msg_hdr mei_hdr;
1538 if (WARN_ON(!cl || !cl->dev))
1545 first_chunk = cb->buf_idx == 0;
1547 rets = first_chunk ? mei_cl_tx_flow_ctrl_creds(cl) : 1;
1552 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1556 slots = mei_hbuf_empty_slots(dev);
1557 len = buf->size - cb->buf_idx;
1558 msg_slots = mei_data2slots(len);
1560 mei_hdr.host_addr = mei_cl_host_addr(cl);
1561 mei_hdr.me_addr = mei_cl_me_id(cl);
1562 mei_hdr.reserved = 0;
1563 mei_hdr.internal = cb->internal;
1565 if (slots >= msg_slots) {
1566 mei_hdr.length = len;
1567 mei_hdr.msg_complete = 1;
1568 /* Split the message only if we can write the whole host buffer */
1569 } else if (slots == dev->hbuf_depth) {
1571 len = (slots * sizeof(u32)) - sizeof(struct mei_msg_hdr);
1572 mei_hdr.length = len;
1573 mei_hdr.msg_complete = 0;
1575 /* wait for next time the host buffer is empty */
1579 cl_dbg(dev, cl, "buf: size = %zu idx = %zu\n",
1580 cb->buf.size, cb->buf_idx);
1582 rets = mei_write_message(dev, &mei_hdr, buf->data + cb->buf_idx);
1587 cl->writing_state = MEI_WRITING;
1588 cb->buf_idx += mei_hdr.length;
1589 cb->completed = mei_hdr.msg_complete == 1;
1592 if (mei_cl_tx_flow_ctrl_creds_reduce(cl)) {
1598 if (mei_hdr.msg_complete)
1599 list_move_tail(&cb->list, &dev->write_waiting_list);
1605 list_move_tail(&cb->list, cmpl_list);
1610 * mei_cl_write - submit a write cb to mei device
1611 * assumes device_lock is locked
1614 * @cb: write callback with filled data
1616 * Return: number of bytes sent on success, <0 on failure.
1618 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb)
1620 struct mei_device *dev;
1621 struct mei_msg_data *buf;
1622 struct mei_msg_hdr mei_hdr;
1627 if (WARN_ON(!cl || !cl->dev))
1637 blocking = cb->blocking;
1639 cl_dbg(dev, cl, "size=%d\n", size);
1641 rets = pm_runtime_get(dev->dev);
1642 if (rets < 0 && rets != -EINPROGRESS) {
1643 pm_runtime_put_noidle(dev->dev);
1644 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1649 cl->writing_state = MEI_IDLE;
1651 mei_hdr.host_addr = mei_cl_host_addr(cl);
1652 mei_hdr.me_addr = mei_cl_me_id(cl);
1653 mei_hdr.reserved = 0;
1654 mei_hdr.msg_complete = 0;
1655 mei_hdr.internal = cb->internal;
1657 rets = mei_cl_tx_flow_ctrl_creds(cl);
1662 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1666 if (!mei_hbuf_acquire(dev)) {
1667 cl_dbg(dev, cl, "Cannot acquire the host buffer: not sending.\n");
1672 /* Check for a maximum length */
1673 if (size > mei_hbuf_max_len(dev)) {
1674 mei_hdr.length = mei_hbuf_max_len(dev);
1675 mei_hdr.msg_complete = 0;
1677 mei_hdr.length = size;
1678 mei_hdr.msg_complete = 1;
1681 rets = mei_write_message(dev, &mei_hdr, buf->data);
1685 rets = mei_cl_tx_flow_ctrl_creds_reduce(cl);
1689 cl->writing_state = MEI_WRITING;
1690 cb->buf_idx = mei_hdr.length;
1691 cb->completed = mei_hdr.msg_complete == 1;
1694 if (mei_hdr.msg_complete)
1695 list_add_tail(&cb->list, &dev->write_waiting_list);
1697 list_add_tail(&cb->list, &dev->write_list);
1700 if (blocking && cl->writing_state != MEI_WRITE_COMPLETE) {
1702 mutex_unlock(&dev->device_lock);
1703 rets = wait_event_interruptible(cl->tx_wait,
1704 cl->writing_state == MEI_WRITE_COMPLETE ||
1705 (!mei_cl_is_connected(cl)));
1706 mutex_lock(&dev->device_lock);
1707 /* wait_event_interruptible returns -ERESTARTSYS */
1709 if (signal_pending(current))
1713 if (cl->writing_state != MEI_WRITE_COMPLETE) {
1721 cl_dbg(dev, cl, "rpm: autosuspend\n");
1722 pm_runtime_mark_last_busy(dev->dev);
1723 pm_runtime_put_autosuspend(dev->dev);
1732 * mei_cl_complete - processes completed operation for a client
1734 * @cl: private data of the file object.
1735 * @cb: callback block.
1737 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb)
1739 struct mei_device *dev = cl->dev;
1741 switch (cb->fop_type) {
1744 cl->writing_state = MEI_WRITE_COMPLETE;
1745 if (waitqueue_active(&cl->tx_wait)) {
1746 wake_up_interruptible(&cl->tx_wait);
1748 pm_runtime_mark_last_busy(dev->dev);
1749 pm_request_autosuspend(dev->dev);
1754 list_add_tail(&cb->list, &cl->rd_completed);
1755 if (!mei_cl_is_fixed_address(cl) &&
1756 !WARN_ON(!cl->rx_flow_ctrl_creds))
1757 cl->rx_flow_ctrl_creds--;
1758 if (!mei_cl_bus_rx_event(cl))
1759 wake_up_interruptible(&cl->rx_wait);
1762 case MEI_FOP_CONNECT:
1763 case MEI_FOP_DISCONNECT:
1764 case MEI_FOP_NOTIFY_STOP:
1765 case MEI_FOP_NOTIFY_START:
1766 if (waitqueue_active(&cl->wait))
1770 case MEI_FOP_DISCONNECT_RSP:
1772 mei_cl_set_disconnected(cl);
1781 * mei_cl_all_disconnect - disconnect forcefully all connected clients
1785 void mei_cl_all_disconnect(struct mei_device *dev)
1789 list_for_each_entry(cl, &dev->file_list, link)
1790 mei_cl_set_disconnected(cl);