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 * @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 * @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_INITIALIZING
;
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_INITIALIZING
;
680 void mei_host_client_init(struct mei_device
*dev
)
682 dev
->dev_state
= MEI_DEV_ENABLED
;
683 dev
->reset_count
= 0;
685 schedule_work(&dev
->bus_rescan_work
);
687 pm_runtime_mark_last_busy(dev
->dev
);
688 dev_dbg(dev
->dev
, "rpm: autosuspend\n");
689 pm_runtime_autosuspend(dev
->dev
);
693 * mei_hbuf_acquire - try to acquire host buffer
695 * @dev: the device structure
696 * Return: true if host buffer was acquired
698 bool mei_hbuf_acquire(struct mei_device
*dev
)
700 if (mei_pg_state(dev
) == MEI_PG_ON
||
701 mei_pg_in_transition(dev
)) {
702 dev_dbg(dev
->dev
, "device is in pg\n");
706 if (!dev
->hbuf_is_ready
) {
707 dev_dbg(dev
->dev
, "hbuf is not ready\n");
711 dev
->hbuf_is_ready
= false;
717 * mei_cl_wake_all - wake up readers, writers and event waiters so
718 * they can be interrupted
722 static void mei_cl_wake_all(struct mei_cl
*cl
)
724 struct mei_device
*dev
= cl
->dev
;
726 /* synchronized under device mutex */
727 if (waitqueue_active(&cl
->rx_wait
)) {
728 cl_dbg(dev
, cl
, "Waking up reading client!\n");
729 wake_up_interruptible(&cl
->rx_wait
);
731 /* synchronized under device mutex */
732 if (waitqueue_active(&cl
->tx_wait
)) {
733 cl_dbg(dev
, cl
, "Waking up writing client!\n");
734 wake_up_interruptible(&cl
->tx_wait
);
736 /* synchronized under device mutex */
737 if (waitqueue_active(&cl
->ev_wait
)) {
738 cl_dbg(dev
, cl
, "Waking up waiting for event clients!\n");
739 wake_up_interruptible(&cl
->ev_wait
);
741 /* synchronized under device mutex */
742 if (waitqueue_active(&cl
->wait
)) {
743 cl_dbg(dev
, cl
, "Waking up ctrl write clients!\n");
749 * mei_cl_set_disconnected - set disconnected state and clear
750 * associated states and resources
754 void mei_cl_set_disconnected(struct mei_cl
*cl
)
756 struct mei_device
*dev
= cl
->dev
;
758 if (cl
->state
== MEI_FILE_DISCONNECTED
||
759 cl
->state
== MEI_FILE_INITIALIZING
)
762 cl
->state
= MEI_FILE_DISCONNECTED
;
763 mei_io_list_free(&dev
->write_list
, cl
);
764 mei_io_list_free(&dev
->write_waiting_list
, cl
);
765 mei_io_list_flush(&dev
->ctrl_rd_list
, cl
);
766 mei_io_list_flush(&dev
->ctrl_wr_list
, cl
);
768 cl
->rx_flow_ctrl_creds
= 0;
769 cl
->tx_flow_ctrl_creds
= 0;
775 if (!WARN_ON(cl
->me_cl
->connect_count
== 0))
776 cl
->me_cl
->connect_count
--;
778 if (cl
->me_cl
->connect_count
== 0)
779 cl
->me_cl
->tx_flow_ctrl_creds
= 0;
781 mei_me_cl_put(cl
->me_cl
);
785 static int mei_cl_set_connecting(struct mei_cl
*cl
, struct mei_me_client
*me_cl
)
787 if (!mei_me_cl_get(me_cl
))
790 /* only one connection is allowed for fixed address clients */
791 if (me_cl
->props
.fixed_address
) {
792 if (me_cl
->connect_count
) {
793 mei_me_cl_put(me_cl
);
799 cl
->state
= MEI_FILE_CONNECTING
;
800 cl
->me_cl
->connect_count
++;
806 * mei_cl_send_disconnect - send disconnect request
809 * @cb: callback block
811 * Return: 0, OK; otherwise, error.
813 static int mei_cl_send_disconnect(struct mei_cl
*cl
, struct mei_cl_cb
*cb
)
815 struct mei_device
*dev
;
820 ret
= mei_hbm_cl_disconnect_req(dev
, cl
);
823 cl
->state
= MEI_FILE_DISCONNECT_REPLY
;
827 list_move_tail(&cb
->list
, &dev
->ctrl_rd_list
.list
);
828 cl
->timer_count
= MEI_CONNECT_TIMEOUT
;
829 mei_schedule_stall_timer(dev
);
835 * mei_cl_irq_disconnect - processes close related operation from
836 * interrupt thread context - send disconnect request
839 * @cb: callback block.
840 * @cmpl_list: complete list.
842 * Return: 0, OK; otherwise, error.
844 int mei_cl_irq_disconnect(struct mei_cl
*cl
, struct mei_cl_cb
*cb
,
845 struct mei_cl_cb
*cmpl_list
)
847 struct mei_device
*dev
= cl
->dev
;
852 msg_slots
= mei_data2slots(sizeof(struct hbm_client_connect_request
));
853 slots
= mei_hbuf_empty_slots(dev
);
855 if (slots
< msg_slots
)
858 ret
= mei_cl_send_disconnect(cl
, cb
);
860 list_move_tail(&cb
->list
, &cmpl_list
->list
);
866 * __mei_cl_disconnect - disconnect host client from the me one
867 * internal function runtime pm has to be already acquired
871 * Return: 0 on success, <0 on failure.
873 static int __mei_cl_disconnect(struct mei_cl
*cl
)
875 struct mei_device
*dev
;
876 struct mei_cl_cb
*cb
;
881 cl
->state
= MEI_FILE_DISCONNECTING
;
883 cb
= mei_cl_enqueue_ctrl_wr_cb(cl
, 0, MEI_FOP_DISCONNECT
, NULL
);
889 if (mei_hbuf_acquire(dev
)) {
890 rets
= mei_cl_send_disconnect(cl
, cb
);
892 cl_err(dev
, cl
, "failed to disconnect.\n");
897 mutex_unlock(&dev
->device_lock
);
898 wait_event_timeout(cl
->wait
,
899 cl
->state
== MEI_FILE_DISCONNECT_REPLY
||
900 cl
->state
== MEI_FILE_DISCONNECTED
,
901 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT
));
902 mutex_lock(&dev
->device_lock
);
905 if (cl
->state
!= MEI_FILE_DISCONNECT_REPLY
&&
906 cl
->state
!= MEI_FILE_DISCONNECTED
) {
907 cl_dbg(dev
, cl
, "timeout on disconnect from FW client.\n");
912 /* we disconnect also on error */
913 mei_cl_set_disconnected(cl
);
915 cl_dbg(dev
, cl
, "successfully disconnected from FW client.\n");
922 * mei_cl_disconnect - disconnect host client from the me one
926 * Locking: called under "dev->device_lock" lock
928 * Return: 0 on success, <0 on failure.
930 int mei_cl_disconnect(struct mei_cl
*cl
)
932 struct mei_device
*dev
;
935 if (WARN_ON(!cl
|| !cl
->dev
))
940 cl_dbg(dev
, cl
, "disconnecting");
942 if (!mei_cl_is_connected(cl
))
945 if (mei_cl_is_fixed_address(cl
)) {
946 mei_cl_set_disconnected(cl
);
950 rets
= pm_runtime_get(dev
->dev
);
951 if (rets
< 0 && rets
!= -EINPROGRESS
) {
952 pm_runtime_put_noidle(dev
->dev
);
953 cl_err(dev
, cl
, "rpm: get failed %d\n", rets
);
957 rets
= __mei_cl_disconnect(cl
);
959 cl_dbg(dev
, cl
, "rpm: autosuspend\n");
960 pm_runtime_mark_last_busy(dev
->dev
);
961 pm_runtime_put_autosuspend(dev
->dev
);
968 * mei_cl_is_other_connecting - checks if other
969 * client with the same me client id is connecting
971 * @cl: private data of the file object
973 * Return: true if other client is connected, false - otherwise.
975 static bool mei_cl_is_other_connecting(struct mei_cl
*cl
)
977 struct mei_device
*dev
;
978 struct mei_cl_cb
*cb
;
982 list_for_each_entry(cb
, &dev
->ctrl_rd_list
.list
, list
) {
983 if (cb
->fop_type
== MEI_FOP_CONNECT
&&
984 mei_cl_me_id(cl
) == mei_cl_me_id(cb
->cl
))
992 * mei_cl_send_connect - send connect request
995 * @cb: callback block
997 * Return: 0, OK; otherwise, error.
999 static int mei_cl_send_connect(struct mei_cl
*cl
, struct mei_cl_cb
*cb
)
1001 struct mei_device
*dev
;
1006 ret
= mei_hbm_cl_connect_req(dev
, cl
);
1009 cl
->state
= MEI_FILE_DISCONNECT_REPLY
;
1013 list_move_tail(&cb
->list
, &dev
->ctrl_rd_list
.list
);
1014 cl
->timer_count
= MEI_CONNECT_TIMEOUT
;
1015 mei_schedule_stall_timer(dev
);
1020 * mei_cl_irq_connect - send connect request in irq_thread context
1023 * @cb: callback block
1024 * @cmpl_list: complete list
1026 * Return: 0, OK; otherwise, error.
1028 int mei_cl_irq_connect(struct mei_cl
*cl
, struct mei_cl_cb
*cb
,
1029 struct mei_cl_cb
*cmpl_list
)
1031 struct mei_device
*dev
= cl
->dev
;
1036 msg_slots
= mei_data2slots(sizeof(struct hbm_client_connect_request
));
1037 slots
= mei_hbuf_empty_slots(dev
);
1039 if (mei_cl_is_other_connecting(cl
))
1042 if (slots
< msg_slots
)
1045 rets
= mei_cl_send_connect(cl
, cb
);
1047 list_move_tail(&cb
->list
, &cmpl_list
->list
);
1053 * mei_cl_connect - connect host client to the me one
1057 * @fp: pointer to file structure
1059 * Locking: called under "dev->device_lock" lock
1061 * Return: 0 on success, <0 on failure.
1063 int mei_cl_connect(struct mei_cl
*cl
, struct mei_me_client
*me_cl
,
1064 const struct file
*fp
)
1066 struct mei_device
*dev
;
1067 struct mei_cl_cb
*cb
;
1070 if (WARN_ON(!cl
|| !cl
->dev
|| !me_cl
))
1075 rets
= mei_cl_set_connecting(cl
, me_cl
);
1079 if (mei_cl_is_fixed_address(cl
)) {
1080 cl
->state
= MEI_FILE_CONNECTED
;
1084 rets
= pm_runtime_get(dev
->dev
);
1085 if (rets
< 0 && rets
!= -EINPROGRESS
) {
1086 pm_runtime_put_noidle(dev
->dev
);
1087 cl_err(dev
, cl
, "rpm: get failed %d\n", rets
);
1091 cb
= mei_cl_enqueue_ctrl_wr_cb(cl
, 0, MEI_FOP_CONNECT
, fp
);
1097 /* run hbuf acquire last so we don't have to undo */
1098 if (!mei_cl_is_other_connecting(cl
) && mei_hbuf_acquire(dev
)) {
1099 rets
= mei_cl_send_connect(cl
, cb
);
1104 mutex_unlock(&dev
->device_lock
);
1105 wait_event_timeout(cl
->wait
,
1106 (cl
->state
== MEI_FILE_CONNECTED
||
1107 cl
->state
== MEI_FILE_DISCONNECTED
||
1108 cl
->state
== MEI_FILE_DISCONNECT_REQUIRED
||
1109 cl
->state
== MEI_FILE_DISCONNECT_REPLY
),
1110 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT
));
1111 mutex_lock(&dev
->device_lock
);
1113 if (!mei_cl_is_connected(cl
)) {
1114 if (cl
->state
== MEI_FILE_DISCONNECT_REQUIRED
) {
1115 mei_io_list_flush(&dev
->ctrl_rd_list
, cl
);
1116 mei_io_list_flush(&dev
->ctrl_wr_list
, cl
);
1117 /* ignore disconnect return valuue;
1118 * in case of failure reset will be invoked
1120 __mei_cl_disconnect(cl
);
1125 /* timeout or something went really wrong */
1127 cl
->status
= -EFAULT
;
1132 cl_dbg(dev
, cl
, "rpm: autosuspend\n");
1133 pm_runtime_mark_last_busy(dev
->dev
);
1134 pm_runtime_put_autosuspend(dev
->dev
);
1139 if (!mei_cl_is_connected(cl
))
1140 mei_cl_set_disconnected(cl
);
1146 * mei_cl_alloc_linked - allocate and link host client
1148 * @dev: the device structure
1150 * Return: cl on success ERR_PTR on failure
1152 struct mei_cl
*mei_cl_alloc_linked(struct mei_device
*dev
)
1157 cl
= mei_cl_allocate(dev
);
1163 ret
= mei_cl_link(cl
);
1170 return ERR_PTR(ret
);
1174 * mei_cl_tx_flow_ctrl_creds - checks flow_control credits for cl.
1178 * Return: 1 if tx_flow_ctrl_creds >0, 0 - otherwise.
1180 static int mei_cl_tx_flow_ctrl_creds(struct mei_cl
*cl
)
1182 if (WARN_ON(!cl
|| !cl
->me_cl
))
1185 if (cl
->tx_flow_ctrl_creds
> 0)
1188 if (mei_cl_is_fixed_address(cl
))
1191 if (mei_cl_is_single_recv_buf(cl
)) {
1192 if (cl
->me_cl
->tx_flow_ctrl_creds
> 0)
1199 * mei_cl_tx_flow_ctrl_creds_reduce - reduces transmit flow control credits
1206 * -EINVAL when ctrl credits are <= 0
1208 static int mei_cl_tx_flow_ctrl_creds_reduce(struct mei_cl
*cl
)
1210 if (WARN_ON(!cl
|| !cl
->me_cl
))
1213 if (mei_cl_is_fixed_address(cl
))
1216 if (mei_cl_is_single_recv_buf(cl
)) {
1217 if (WARN_ON(cl
->me_cl
->tx_flow_ctrl_creds
<= 0))
1219 cl
->me_cl
->tx_flow_ctrl_creds
--;
1221 if (WARN_ON(cl
->tx_flow_ctrl_creds
<= 0))
1223 cl
->tx_flow_ctrl_creds
--;
1229 * mei_cl_notify_fop2req - convert fop to proper request
1231 * @fop: client notification start response command
1233 * Return: MEI_HBM_NOTIFICATION_START/STOP
1235 u8
mei_cl_notify_fop2req(enum mei_cb_file_ops fop
)
1237 if (fop
== MEI_FOP_NOTIFY_START
)
1238 return MEI_HBM_NOTIFICATION_START
;
1240 return MEI_HBM_NOTIFICATION_STOP
;
1244 * mei_cl_notify_req2fop - convert notification request top file operation type
1246 * @req: hbm notification request type
1248 * Return: MEI_FOP_NOTIFY_START/STOP
1250 enum mei_cb_file_ops
mei_cl_notify_req2fop(u8 req
)
1252 if (req
== MEI_HBM_NOTIFICATION_START
)
1253 return MEI_FOP_NOTIFY_START
;
1255 return MEI_FOP_NOTIFY_STOP
;
1259 * mei_cl_irq_notify - send notification request in irq_thread context
1262 * @cb: callback block.
1263 * @cmpl_list: complete list.
1265 * Return: 0 on such and error otherwise.
1267 int mei_cl_irq_notify(struct mei_cl
*cl
, struct mei_cl_cb
*cb
,
1268 struct mei_cl_cb
*cmpl_list
)
1270 struct mei_device
*dev
= cl
->dev
;
1276 msg_slots
= mei_data2slots(sizeof(struct hbm_client_connect_request
));
1277 slots
= mei_hbuf_empty_slots(dev
);
1279 if (slots
< msg_slots
)
1282 request
= mei_cl_notify_fop2req(cb
->fop_type
);
1283 ret
= mei_hbm_cl_notify_req(dev
, cl
, request
);
1286 list_move_tail(&cb
->list
, &cmpl_list
->list
);
1290 list_move_tail(&cb
->list
, &dev
->ctrl_rd_list
.list
);
1295 * mei_cl_notify_request - send notification stop/start request
1298 * @fp: associate request with file
1299 * @request: 1 for start or 0 for stop
1301 * Locking: called under "dev->device_lock" lock
1303 * Return: 0 on such and error otherwise.
1305 int mei_cl_notify_request(struct mei_cl
*cl
,
1306 const struct file
*fp
, u8 request
)
1308 struct mei_device
*dev
;
1309 struct mei_cl_cb
*cb
;
1310 enum mei_cb_file_ops fop_type
;
1313 if (WARN_ON(!cl
|| !cl
->dev
))
1318 if (!dev
->hbm_f_ev_supported
) {
1319 cl_dbg(dev
, cl
, "notifications not supported\n");
1323 rets
= pm_runtime_get(dev
->dev
);
1324 if (rets
< 0 && rets
!= -EINPROGRESS
) {
1325 pm_runtime_put_noidle(dev
->dev
);
1326 cl_err(dev
, cl
, "rpm: get failed %d\n", rets
);
1330 fop_type
= mei_cl_notify_req2fop(request
);
1331 cb
= mei_cl_enqueue_ctrl_wr_cb(cl
, 0, fop_type
, fp
);
1337 if (mei_hbuf_acquire(dev
)) {
1338 if (mei_hbm_cl_notify_req(dev
, cl
, request
)) {
1342 list_move_tail(&cb
->list
, &dev
->ctrl_rd_list
.list
);
1345 mutex_unlock(&dev
->device_lock
);
1346 wait_event_timeout(cl
->wait
,
1347 cl
->notify_en
== request
|| !mei_cl_is_connected(cl
),
1348 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT
));
1349 mutex_lock(&dev
->device_lock
);
1351 if (cl
->notify_en
!= request
&& !cl
->status
)
1352 cl
->status
= -EFAULT
;
1357 cl_dbg(dev
, cl
, "rpm: autosuspend\n");
1358 pm_runtime_mark_last_busy(dev
->dev
);
1359 pm_runtime_put_autosuspend(dev
->dev
);
1366 * mei_cl_notify - raise notification
1370 * Locking: called under "dev->device_lock" lock
1372 void mei_cl_notify(struct mei_cl
*cl
)
1374 struct mei_device
*dev
;
1376 if (!cl
|| !cl
->dev
)
1384 cl_dbg(dev
, cl
, "notify event");
1385 cl
->notify_ev
= true;
1386 if (!mei_cl_bus_notify_event(cl
))
1387 wake_up_interruptible(&cl
->ev_wait
);
1390 kill_fasync(&cl
->ev_async
, SIGIO
, POLL_PRI
);
1395 * mei_cl_notify_get - get or wait for notification event
1398 * @block: this request is blocking
1399 * @notify_ev: true if notification event was received
1401 * Locking: called under "dev->device_lock" lock
1403 * Return: 0 on such and error otherwise.
1405 int mei_cl_notify_get(struct mei_cl
*cl
, bool block
, bool *notify_ev
)
1407 struct mei_device
*dev
;
1412 if (WARN_ON(!cl
|| !cl
->dev
))
1417 if (!mei_cl_is_connected(cl
))
1426 mutex_unlock(&dev
->device_lock
);
1427 rets
= wait_event_interruptible(cl
->ev_wait
, cl
->notify_ev
);
1428 mutex_lock(&dev
->device_lock
);
1434 *notify_ev
= cl
->notify_ev
;
1435 cl
->notify_ev
= false;
1440 * mei_cl_read_start - the start read client message function.
1443 * @length: number of bytes to read
1444 * @fp: pointer to file structure
1446 * Return: 0 on success, <0 on failure.
1448 int mei_cl_read_start(struct mei_cl
*cl
, size_t length
, const struct file
*fp
)
1450 struct mei_device
*dev
;
1451 struct mei_cl_cb
*cb
;
1454 if (WARN_ON(!cl
|| !cl
->dev
))
1459 if (!mei_cl_is_connected(cl
))
1462 if (!mei_me_cl_is_active(cl
->me_cl
)) {
1463 cl_err(dev
, cl
, "no such me client\n");
1467 if (mei_cl_is_fixed_address(cl
) || cl
== &dev
->iamthif_cl
)
1470 /* HW currently supports only one pending read */
1471 if (cl
->rx_flow_ctrl_creds
)
1474 cb
= mei_cl_enqueue_ctrl_wr_cb(cl
, length
, MEI_FOP_READ
, fp
);
1478 rets
= pm_runtime_get(dev
->dev
);
1479 if (rets
< 0 && rets
!= -EINPROGRESS
) {
1480 pm_runtime_put_noidle(dev
->dev
);
1481 cl_err(dev
, cl
, "rpm: get failed %d\n", rets
);
1486 if (mei_hbuf_acquire(dev
)) {
1487 rets
= mei_hbm_cl_flow_control_req(dev
, cl
);
1491 list_move_tail(&cb
->list
, &cl
->rd_pending
);
1493 cl
->rx_flow_ctrl_creds
++;
1496 cl_dbg(dev
, cl
, "rpm: autosuspend\n");
1497 pm_runtime_mark_last_busy(dev
->dev
);
1498 pm_runtime_put_autosuspend(dev
->dev
);
1507 * mei_cl_irq_write - write a message to device
1508 * from the interrupt thread context
1511 * @cb: callback block.
1512 * @cmpl_list: complete list.
1514 * Return: 0, OK; otherwise error.
1516 int mei_cl_irq_write(struct mei_cl
*cl
, struct mei_cl_cb
*cb
,
1517 struct mei_cl_cb
*cmpl_list
)
1519 struct mei_device
*dev
;
1520 struct mei_msg_data
*buf
;
1521 struct mei_msg_hdr mei_hdr
;
1528 if (WARN_ON(!cl
|| !cl
->dev
))
1535 first_chunk
= cb
->buf_idx
== 0;
1537 rets
= first_chunk
? mei_cl_tx_flow_ctrl_creds(cl
) : 1;
1542 cl_dbg(dev
, cl
, "No flow control credentials: not sending.\n");
1546 slots
= mei_hbuf_empty_slots(dev
);
1547 len
= buf
->size
- cb
->buf_idx
;
1548 msg_slots
= mei_data2slots(len
);
1550 mei_hdr
.host_addr
= mei_cl_host_addr(cl
);
1551 mei_hdr
.me_addr
= mei_cl_me_id(cl
);
1552 mei_hdr
.reserved
= 0;
1553 mei_hdr
.internal
= cb
->internal
;
1555 if (slots
>= msg_slots
) {
1556 mei_hdr
.length
= len
;
1557 mei_hdr
.msg_complete
= 1;
1558 /* Split the message only if we can write the whole host buffer */
1559 } else if (slots
== dev
->hbuf_depth
) {
1561 len
= (slots
* sizeof(u32
)) - sizeof(struct mei_msg_hdr
);
1562 mei_hdr
.length
= len
;
1563 mei_hdr
.msg_complete
= 0;
1565 /* wait for next time the host buffer is empty */
1569 cl_dbg(dev
, cl
, "buf: size = %zu idx = %zu\n",
1570 cb
->buf
.size
, cb
->buf_idx
);
1572 rets
= mei_write_message(dev
, &mei_hdr
, buf
->data
+ cb
->buf_idx
);
1575 list_move_tail(&cb
->list
, &cmpl_list
->list
);
1580 cl
->writing_state
= MEI_WRITING
;
1581 cb
->buf_idx
+= mei_hdr
.length
;
1582 cb
->completed
= mei_hdr
.msg_complete
== 1;
1585 if (mei_cl_tx_flow_ctrl_creds_reduce(cl
))
1589 if (mei_hdr
.msg_complete
)
1590 list_move_tail(&cb
->list
, &dev
->write_waiting_list
.list
);
1596 * mei_cl_write - submit a write cb to mei device
1597 * assumes device_lock is locked
1600 * @cb: write callback with filled data
1601 * @blocking: block until completed
1603 * Return: number of bytes sent on success, <0 on failure.
1605 int mei_cl_write(struct mei_cl
*cl
, struct mei_cl_cb
*cb
, bool blocking
)
1607 struct mei_device
*dev
;
1608 struct mei_msg_data
*buf
;
1609 struct mei_msg_hdr mei_hdr
;
1614 if (WARN_ON(!cl
|| !cl
->dev
))
1625 cl_dbg(dev
, cl
, "size=%d\n", size
);
1627 rets
= pm_runtime_get(dev
->dev
);
1628 if (rets
< 0 && rets
!= -EINPROGRESS
) {
1629 pm_runtime_put_noidle(dev
->dev
);
1630 cl_err(dev
, cl
, "rpm: get failed %d\n", rets
);
1635 cl
->writing_state
= MEI_IDLE
;
1637 mei_hdr
.host_addr
= mei_cl_host_addr(cl
);
1638 mei_hdr
.me_addr
= mei_cl_me_id(cl
);
1639 mei_hdr
.reserved
= 0;
1640 mei_hdr
.msg_complete
= 0;
1641 mei_hdr
.internal
= cb
->internal
;
1643 rets
= mei_cl_tx_flow_ctrl_creds(cl
);
1648 cl_dbg(dev
, cl
, "No flow control credentials: not sending.\n");
1652 if (!mei_hbuf_acquire(dev
)) {
1653 cl_dbg(dev
, cl
, "Cannot acquire the host buffer: not sending.\n");
1658 /* Check for a maximum length */
1659 if (size
> mei_hbuf_max_len(dev
)) {
1660 mei_hdr
.length
= mei_hbuf_max_len(dev
);
1661 mei_hdr
.msg_complete
= 0;
1663 mei_hdr
.length
= size
;
1664 mei_hdr
.msg_complete
= 1;
1667 rets
= mei_write_message(dev
, &mei_hdr
, buf
->data
);
1671 rets
= mei_cl_tx_flow_ctrl_creds_reduce(cl
);
1675 cl
->writing_state
= MEI_WRITING
;
1676 cb
->buf_idx
= mei_hdr
.length
;
1677 cb
->completed
= mei_hdr
.msg_complete
== 1;
1680 if (mei_hdr
.msg_complete
)
1681 list_add_tail(&cb
->list
, &dev
->write_waiting_list
.list
);
1683 list_add_tail(&cb
->list
, &dev
->write_list
.list
);
1686 if (blocking
&& cl
->writing_state
!= MEI_WRITE_COMPLETE
) {
1688 mutex_unlock(&dev
->device_lock
);
1689 rets
= wait_event_interruptible(cl
->tx_wait
,
1690 cl
->writing_state
== MEI_WRITE_COMPLETE
||
1691 (!mei_cl_is_connected(cl
)));
1692 mutex_lock(&dev
->device_lock
);
1693 /* wait_event_interruptible returns -ERESTARTSYS */
1695 if (signal_pending(current
))
1699 if (cl
->writing_state
!= MEI_WRITE_COMPLETE
) {
1707 cl_dbg(dev
, cl
, "rpm: autosuspend\n");
1708 pm_runtime_mark_last_busy(dev
->dev
);
1709 pm_runtime_put_autosuspend(dev
->dev
);
1718 * mei_cl_complete - processes completed operation for a client
1720 * @cl: private data of the file object.
1721 * @cb: callback block.
1723 void mei_cl_complete(struct mei_cl
*cl
, struct mei_cl_cb
*cb
)
1725 struct mei_device
*dev
= cl
->dev
;
1727 switch (cb
->fop_type
) {
1730 cl
->writing_state
= MEI_WRITE_COMPLETE
;
1731 if (waitqueue_active(&cl
->tx_wait
)) {
1732 wake_up_interruptible(&cl
->tx_wait
);
1734 pm_runtime_mark_last_busy(dev
->dev
);
1735 pm_request_autosuspend(dev
->dev
);
1740 list_add_tail(&cb
->list
, &cl
->rd_completed
);
1741 if (!mei_cl_is_fixed_address(cl
) &&
1742 !WARN_ON(!cl
->rx_flow_ctrl_creds
))
1743 cl
->rx_flow_ctrl_creds
--;
1744 if (!mei_cl_bus_rx_event(cl
))
1745 wake_up_interruptible(&cl
->rx_wait
);
1748 case MEI_FOP_CONNECT
:
1749 case MEI_FOP_DISCONNECT
:
1750 case MEI_FOP_NOTIFY_STOP
:
1751 case MEI_FOP_NOTIFY_START
:
1752 if (waitqueue_active(&cl
->wait
))
1756 case MEI_FOP_DISCONNECT_RSP
:
1758 mei_cl_set_disconnected(cl
);
1767 * mei_cl_all_disconnect - disconnect forcefully all connected clients
1771 void mei_cl_all_disconnect(struct mei_device
*dev
)
1775 list_for_each_entry(cl
, &dev
->file_list
, link
)
1776 mei_cl_set_disconnected(cl
);