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 struct mei_cl_cb
*mei_io_cb_init(struct mei_cl
*cl
, enum mei_cb_file_ops type
,
364 struct mei_cl_cb
*cb
;
366 cb
= kzalloc(sizeof(struct mei_cl_cb
), GFP_KERNEL
);
370 INIT_LIST_HEAD(&cb
->list
);
371 cb
->file_object
= fp
;
379 * __mei_io_list_flush - removes and frees cbs belonging to cl.
381 * @list: an instance of our list structure
382 * @cl: host client, can be NULL for flushing the whole list
383 * @free: whether to free the cbs
385 static void __mei_io_list_flush(struct mei_cl_cb
*list
,
386 struct mei_cl
*cl
, bool free
)
388 struct mei_cl_cb
*cb
, *next
;
390 /* enable removing everything if no cl is specified */
391 list_for_each_entry_safe(cb
, next
, &list
->list
, list
) {
392 if (!cl
|| mei_cl_cmp_id(cl
, cb
->cl
)) {
393 list_del_init(&cb
->list
);
401 * mei_io_list_flush - removes list entry belonging to cl.
403 * @list: An instance of our list structure
406 void mei_io_list_flush(struct mei_cl_cb
*list
, struct mei_cl
*cl
)
408 __mei_io_list_flush(list
, cl
, false);
412 * mei_io_list_free - removes cb belonging to cl and free them
414 * @list: An instance of our list structure
417 static inline void mei_io_list_free(struct mei_cl_cb
*list
, struct mei_cl
*cl
)
419 __mei_io_list_flush(list
, cl
, true);
423 * mei_io_cb_alloc_buf - allocate callback buffer
425 * @cb: io callback structure
426 * @length: size of the buffer
428 * Return: 0 on success
429 * -EINVAL if cb is NULL
430 * -ENOMEM if allocation failed
432 int mei_io_cb_alloc_buf(struct mei_cl_cb
*cb
, size_t length
)
440 cb
->buf
.data
= kmalloc(length
, GFP_KERNEL
);
443 cb
->buf
.size
= length
;
448 * mei_cl_alloc_cb - a convenient wrapper for allocating read cb
451 * @length: size of the buffer
452 * @type: operation type
453 * @fp: associated file pointer (might be NULL)
455 * Return: cb on success and NULL on failure
457 struct mei_cl_cb
*mei_cl_alloc_cb(struct mei_cl
*cl
, size_t length
,
458 enum mei_cb_file_ops type
, struct file
*fp
)
460 struct mei_cl_cb
*cb
;
462 cb
= mei_io_cb_init(cl
, type
, fp
);
466 if (mei_io_cb_alloc_buf(cb
, length
)) {
475 * mei_cl_read_cb - find this cl's callback in the read list
476 * for a specific file
479 * @fp: file pointer (matching cb file object), may be NULL
481 * Return: cb on success, NULL if cb is not found
483 struct mei_cl_cb
*mei_cl_read_cb(const struct mei_cl
*cl
, const struct file
*fp
)
485 struct mei_cl_cb
*cb
;
487 list_for_each_entry(cb
, &cl
->rd_completed
, list
)
488 if (!fp
|| fp
== cb
->file_object
)
495 * mei_cl_read_cb_flush - free client's read pending and completed cbs
496 * for a specific file
499 * @fp: file pointer (matching cb file object), may be NULL
501 void mei_cl_read_cb_flush(const struct mei_cl
*cl
, const struct file
*fp
)
503 struct mei_cl_cb
*cb
, *next
;
505 list_for_each_entry_safe(cb
, next
, &cl
->rd_completed
, list
)
506 if (!fp
|| fp
== cb
->file_object
)
510 list_for_each_entry_safe(cb
, next
, &cl
->rd_pending
, list
)
511 if (!fp
|| fp
== cb
->file_object
)
516 * mei_cl_flush_queues - flushes queue lists belonging to cl.
519 * @fp: file pointer (matching cb file object), may be NULL
521 * Return: 0 on success, -EINVAL if cl or cl->dev is NULL.
523 int mei_cl_flush_queues(struct mei_cl
*cl
, const struct file
*fp
)
525 struct mei_device
*dev
;
527 if (WARN_ON(!cl
|| !cl
->dev
))
532 cl_dbg(dev
, cl
, "remove list entry belonging to cl\n");
533 mei_io_list_free(&cl
->dev
->write_list
, cl
);
534 mei_io_list_free(&cl
->dev
->write_waiting_list
, cl
);
535 mei_io_list_flush(&cl
->dev
->ctrl_wr_list
, cl
);
536 mei_io_list_flush(&cl
->dev
->ctrl_rd_list
, cl
);
537 mei_io_list_flush(&cl
->dev
->amthif_cmd_list
, cl
);
538 mei_io_list_flush(&cl
->dev
->amthif_rd_complete_list
, cl
);
540 mei_cl_read_cb_flush(cl
, fp
);
547 * mei_cl_init - initializes cl.
549 * @cl: host client to be initialized
552 void mei_cl_init(struct mei_cl
*cl
, struct mei_device
*dev
)
554 memset(cl
, 0, sizeof(struct mei_cl
));
555 init_waitqueue_head(&cl
->wait
);
556 init_waitqueue_head(&cl
->rx_wait
);
557 init_waitqueue_head(&cl
->tx_wait
);
558 INIT_LIST_HEAD(&cl
->rd_completed
);
559 INIT_LIST_HEAD(&cl
->rd_pending
);
560 INIT_LIST_HEAD(&cl
->link
);
561 INIT_LIST_HEAD(&cl
->device_link
);
562 cl
->writing_state
= MEI_IDLE
;
563 cl
->state
= MEI_FILE_INITIALIZING
;
568 * mei_cl_allocate - allocates cl structure and sets it up.
571 * Return: The allocated file or NULL on failure
573 struct mei_cl
*mei_cl_allocate(struct mei_device
*dev
)
577 cl
= kmalloc(sizeof(struct mei_cl
), GFP_KERNEL
);
581 mei_cl_init(cl
, dev
);
587 * mei_cl_link - allocate host id in the host map
590 * @id: fixed host id or MEI_HOST_CLIENT_ID_ANY (-1) for generic one
592 * Return: 0 on success
593 * -EINVAL on incorrect values
594 * -EMFILE if open count exceeded.
596 int mei_cl_link(struct mei_cl
*cl
, int id
)
598 struct mei_device
*dev
;
599 long open_handle_count
;
601 if (WARN_ON(!cl
|| !cl
->dev
))
606 /* If Id is not assigned get one*/
607 if (id
== MEI_HOST_CLIENT_ID_ANY
)
608 id
= find_first_zero_bit(dev
->host_clients_map
,
611 if (id
>= MEI_CLIENTS_MAX
) {
612 dev_err(dev
->dev
, "id exceeded %d", MEI_CLIENTS_MAX
);
616 open_handle_count
= dev
->open_handle_count
+ dev
->iamthif_open_count
;
617 if (open_handle_count
>= MEI_MAX_OPEN_HANDLE_COUNT
) {
618 dev_err(dev
->dev
, "open_handle_count exceeded %d",
619 MEI_MAX_OPEN_HANDLE_COUNT
);
623 dev
->open_handle_count
++;
625 cl
->host_client_id
= id
;
626 list_add_tail(&cl
->link
, &dev
->file_list
);
628 set_bit(id
, dev
->host_clients_map
);
630 cl
->state
= MEI_FILE_INITIALIZING
;
632 cl_dbg(dev
, cl
, "link cl\n");
637 * mei_cl_unlink - remove host client from the list
643 int mei_cl_unlink(struct mei_cl
*cl
)
645 struct mei_device
*dev
;
647 /* don't shout on error exit path */
651 /* wd and amthif might not be initialized */
657 cl_dbg(dev
, cl
, "unlink client");
659 if (dev
->open_handle_count
> 0)
660 dev
->open_handle_count
--;
662 /* never clear the 0 bit */
663 if (cl
->host_client_id
)
664 clear_bit(cl
->host_client_id
, dev
->host_clients_map
);
666 list_del_init(&cl
->link
);
668 cl
->state
= MEI_FILE_INITIALIZING
;
674 void mei_host_client_init(struct work_struct
*work
)
676 struct mei_device
*dev
=
677 container_of(work
, struct mei_device
, init_work
);
678 struct mei_me_client
*me_cl
;
680 mutex_lock(&dev
->device_lock
);
683 me_cl
= mei_me_cl_by_uuid(dev
, &mei_amthif_guid
);
685 mei_amthif_host_init(dev
, me_cl
);
686 mei_me_cl_put(me_cl
);
688 me_cl
= mei_me_cl_by_uuid(dev
, &mei_wd_guid
);
690 mei_wd_host_init(dev
, me_cl
);
691 mei_me_cl_put(me_cl
);
693 me_cl
= mei_me_cl_by_uuid(dev
, &mei_nfc_guid
);
695 mei_nfc_host_init(dev
, me_cl
);
696 mei_me_cl_put(me_cl
);
699 dev
->dev_state
= MEI_DEV_ENABLED
;
700 dev
->reset_count
= 0;
701 mutex_unlock(&dev
->device_lock
);
703 pm_runtime_mark_last_busy(dev
->dev
);
704 dev_dbg(dev
->dev
, "rpm: autosuspend\n");
705 pm_runtime_autosuspend(dev
->dev
);
709 * mei_hbuf_acquire - try to acquire host buffer
711 * @dev: the device structure
712 * Return: true if host buffer was acquired
714 bool mei_hbuf_acquire(struct mei_device
*dev
)
716 if (mei_pg_state(dev
) == MEI_PG_ON
||
717 mei_pg_in_transition(dev
)) {
718 dev_dbg(dev
->dev
, "device is in pg\n");
722 if (!dev
->hbuf_is_ready
) {
723 dev_dbg(dev
->dev
, "hbuf is not ready\n");
727 dev
->hbuf_is_ready
= false;
733 * mei_cl_set_disconnected - set disconnected state and clear
734 * associated states and resources
738 void mei_cl_set_disconnected(struct mei_cl
*cl
)
740 struct mei_device
*dev
= cl
->dev
;
742 if (cl
->state
== MEI_FILE_DISCONNECTED
||
743 cl
->state
== MEI_FILE_INITIALIZING
)
746 cl
->state
= MEI_FILE_DISCONNECTED
;
747 mei_io_list_flush(&dev
->ctrl_rd_list
, cl
);
748 mei_io_list_flush(&dev
->ctrl_wr_list
, cl
);
749 cl
->mei_flow_ctrl_creds
= 0;
755 if (!WARN_ON(cl
->me_cl
->connect_count
== 0))
756 cl
->me_cl
->connect_count
--;
758 if (cl
->me_cl
->connect_count
== 0)
759 cl
->me_cl
->mei_flow_ctrl_creds
= 0;
761 mei_me_cl_put(cl
->me_cl
);
765 static int mei_cl_set_connecting(struct mei_cl
*cl
, struct mei_me_client
*me_cl
)
767 if (!mei_me_cl_get(me_cl
))
770 /* only one connection is allowed for fixed address clients */
771 if (me_cl
->props
.fixed_address
) {
772 if (me_cl
->connect_count
) {
773 mei_me_cl_put(me_cl
);
779 cl
->state
= MEI_FILE_CONNECTING
;
780 cl
->me_cl
->connect_count
++;
786 * mei_cl_send_disconnect - send disconnect request
789 * @cb: callback block
791 * Return: 0, OK; otherwise, error.
793 static int mei_cl_send_disconnect(struct mei_cl
*cl
, struct mei_cl_cb
*cb
)
795 struct mei_device
*dev
;
800 ret
= mei_hbm_cl_disconnect_req(dev
, cl
);
803 cl
->state
= MEI_FILE_DISCONNECT_REPLY
;
807 list_move_tail(&cb
->list
, &dev
->ctrl_rd_list
.list
);
808 cl
->timer_count
= MEI_CONNECT_TIMEOUT
;
814 * mei_cl_irq_disconnect - processes close related operation from
815 * interrupt thread context - send disconnect request
818 * @cb: callback block.
819 * @cmpl_list: complete list.
821 * Return: 0, OK; otherwise, error.
823 int mei_cl_irq_disconnect(struct mei_cl
*cl
, struct mei_cl_cb
*cb
,
824 struct mei_cl_cb
*cmpl_list
)
826 struct mei_device
*dev
= cl
->dev
;
831 msg_slots
= mei_data2slots(sizeof(struct hbm_client_connect_request
));
832 slots
= mei_hbuf_empty_slots(dev
);
834 if (slots
< msg_slots
)
837 ret
= mei_cl_send_disconnect(cl
, cb
);
839 list_move_tail(&cb
->list
, &cmpl_list
->list
);
847 * mei_cl_disconnect - disconnect host client from the me one
851 * Locking: called under "dev->device_lock" lock
853 * Return: 0 on success, <0 on failure.
855 int mei_cl_disconnect(struct mei_cl
*cl
)
857 struct mei_device
*dev
;
858 struct mei_cl_cb
*cb
;
861 if (WARN_ON(!cl
|| !cl
->dev
))
866 cl_dbg(dev
, cl
, "disconnecting");
868 if (!mei_cl_is_connected(cl
))
871 if (mei_cl_is_fixed_address(cl
)) {
872 mei_cl_set_disconnected(cl
);
876 rets
= pm_runtime_get(dev
->dev
);
877 if (rets
< 0 && rets
!= -EINPROGRESS
) {
878 pm_runtime_put_noidle(dev
->dev
);
879 cl_err(dev
, cl
, "rpm: get failed %d\n", rets
);
883 cl
->state
= MEI_FILE_DISCONNECTING
;
885 cb
= mei_io_cb_init(cl
, MEI_FOP_DISCONNECT
, NULL
);
886 rets
= cb
? 0 : -ENOMEM
;
890 cl_dbg(dev
, cl
, "add disconnect cb to control write list\n");
891 list_add_tail(&cb
->list
, &dev
->ctrl_wr_list
.list
);
893 if (mei_hbuf_acquire(dev
)) {
894 rets
= mei_cl_send_disconnect(cl
, cb
);
896 cl_err(dev
, cl
, "failed to disconnect.\n");
901 mutex_unlock(&dev
->device_lock
);
902 wait_event_timeout(cl
->wait
, cl
->state
== MEI_FILE_DISCONNECT_REPLY
,
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_dbg(dev
, cl
, "timeout on disconnect from FW client.\n");
913 /* we disconnect also on error */
914 mei_cl_set_disconnected(cl
);
916 cl_dbg(dev
, cl
, "successfully disconnected from FW client.\n");
918 cl_dbg(dev
, cl
, "rpm: autosuspend\n");
919 pm_runtime_mark_last_busy(dev
->dev
);
920 pm_runtime_put_autosuspend(dev
->dev
);
928 * mei_cl_is_other_connecting - checks if other
929 * client with the same me client id is connecting
931 * @cl: private data of the file object
933 * Return: true if other client is connected, false - otherwise.
935 static bool mei_cl_is_other_connecting(struct mei_cl
*cl
)
937 struct mei_device
*dev
;
938 struct mei_cl_cb
*cb
;
942 list_for_each_entry(cb
, &dev
->ctrl_rd_list
.list
, list
) {
943 if (cb
->fop_type
== MEI_FOP_CONNECT
&&
944 mei_cl_me_id(cl
) == mei_cl_me_id(cb
->cl
))
952 * mei_cl_send_connect - send connect request
955 * @cb: callback block
957 * Return: 0, OK; otherwise, error.
959 static int mei_cl_send_connect(struct mei_cl
*cl
, struct mei_cl_cb
*cb
)
961 struct mei_device
*dev
;
966 ret
= mei_hbm_cl_connect_req(dev
, cl
);
969 cl
->state
= MEI_FILE_DISCONNECT_REPLY
;
973 list_move_tail(&cb
->list
, &dev
->ctrl_rd_list
.list
);
974 cl
->timer_count
= MEI_CONNECT_TIMEOUT
;
979 * mei_cl_irq_connect - send connect request in irq_thread context
982 * @cb: callback block
983 * @cmpl_list: complete list
985 * Return: 0, OK; otherwise, error.
987 int mei_cl_irq_connect(struct mei_cl
*cl
, struct mei_cl_cb
*cb
,
988 struct mei_cl_cb
*cmpl_list
)
990 struct mei_device
*dev
= cl
->dev
;
995 msg_slots
= mei_data2slots(sizeof(struct hbm_client_connect_request
));
996 slots
= mei_hbuf_empty_slots(dev
);
998 if (mei_cl_is_other_connecting(cl
))
1001 if (slots
< msg_slots
)
1004 rets
= mei_cl_send_connect(cl
, cb
);
1006 list_move_tail(&cb
->list
, &cmpl_list
->list
);
1012 * mei_cl_connect - connect host client to the me one
1016 * @file: pointer to file structure
1018 * Locking: called under "dev->device_lock" lock
1020 * Return: 0 on success, <0 on failure.
1022 int mei_cl_connect(struct mei_cl
*cl
, struct mei_me_client
*me_cl
,
1025 struct mei_device
*dev
;
1026 struct mei_cl_cb
*cb
;
1029 if (WARN_ON(!cl
|| !cl
->dev
|| !me_cl
))
1034 rets
= mei_cl_set_connecting(cl
, me_cl
);
1038 if (mei_cl_is_fixed_address(cl
)) {
1039 cl
->state
= MEI_FILE_CONNECTED
;
1043 rets
= pm_runtime_get(dev
->dev
);
1044 if (rets
< 0 && rets
!= -EINPROGRESS
) {
1045 pm_runtime_put_noidle(dev
->dev
);
1046 cl_err(dev
, cl
, "rpm: get failed %d\n", rets
);
1050 cb
= mei_io_cb_init(cl
, MEI_FOP_CONNECT
, file
);
1051 rets
= cb
? 0 : -ENOMEM
;
1055 list_add_tail(&cb
->list
, &dev
->ctrl_wr_list
.list
);
1057 /* run hbuf acquire last so we don't have to undo */
1058 if (!mei_cl_is_other_connecting(cl
) && mei_hbuf_acquire(dev
)) {
1059 rets
= mei_cl_send_connect(cl
, cb
);
1064 mutex_unlock(&dev
->device_lock
);
1065 wait_event_timeout(cl
->wait
,
1066 (cl
->state
== MEI_FILE_CONNECTED
||
1067 cl
->state
== MEI_FILE_DISCONNECT_REPLY
),
1068 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT
));
1069 mutex_lock(&dev
->device_lock
);
1071 if (!mei_cl_is_connected(cl
)) {
1072 /* timeout or something went really wrong */
1074 cl
->status
= -EFAULT
;
1079 cl_dbg(dev
, cl
, "rpm: autosuspend\n");
1080 pm_runtime_mark_last_busy(dev
->dev
);
1081 pm_runtime_put_autosuspend(dev
->dev
);
1086 if (!mei_cl_is_connected(cl
))
1087 mei_cl_set_disconnected(cl
);
1093 * mei_cl_alloc_linked - allocate and link host client
1095 * @dev: the device structure
1096 * @id: fixed host id or MEI_HOST_CLIENT_ID_ANY (-1) for generic one
1098 * Return: cl on success ERR_PTR on failure
1100 struct mei_cl
*mei_cl_alloc_linked(struct mei_device
*dev
, int id
)
1105 cl
= mei_cl_allocate(dev
);
1111 ret
= mei_cl_link(cl
, id
);
1118 return ERR_PTR(ret
);
1124 * mei_cl_flow_ctrl_creds - checks flow_control credits for cl.
1126 * @cl: private data of the file object
1128 * Return: 1 if mei_flow_ctrl_creds >0, 0 - otherwise.
1130 int mei_cl_flow_ctrl_creds(struct mei_cl
*cl
)
1134 if (WARN_ON(!cl
|| !cl
->me_cl
))
1137 if (cl
->mei_flow_ctrl_creds
> 0)
1140 if (mei_cl_is_fixed_address(cl
)) {
1141 rets
= mei_cl_read_start(cl
, mei_cl_mtu(cl
), NULL
);
1142 if (rets
&& rets
!= -EBUSY
)
1147 if (mei_cl_is_single_recv_buf(cl
)) {
1148 if (cl
->me_cl
->mei_flow_ctrl_creds
> 0)
1155 * mei_cl_flow_ctrl_reduce - reduces flow_control.
1157 * @cl: private data of the file object
1161 * -EINVAL when ctrl credits are <= 0
1163 int mei_cl_flow_ctrl_reduce(struct mei_cl
*cl
)
1165 if (WARN_ON(!cl
|| !cl
->me_cl
))
1168 if (mei_cl_is_fixed_address(cl
))
1171 if (mei_cl_is_single_recv_buf(cl
)) {
1172 if (WARN_ON(cl
->me_cl
->mei_flow_ctrl_creds
<= 0))
1174 cl
->me_cl
->mei_flow_ctrl_creds
--;
1176 if (WARN_ON(cl
->mei_flow_ctrl_creds
<= 0))
1178 cl
->mei_flow_ctrl_creds
--;
1184 * mei_cl_read_start - the start read client message function.
1187 * @length: number of bytes to read
1188 * @fp: pointer to file structure
1190 * Return: 0 on success, <0 on failure.
1192 int mei_cl_read_start(struct mei_cl
*cl
, size_t length
, struct file
*fp
)
1194 struct mei_device
*dev
;
1195 struct mei_cl_cb
*cb
;
1198 if (WARN_ON(!cl
|| !cl
->dev
))
1203 if (!mei_cl_is_connected(cl
))
1206 /* HW currently supports only one pending read */
1207 if (!list_empty(&cl
->rd_pending
))
1210 if (!mei_me_cl_is_active(cl
->me_cl
)) {
1211 cl_err(dev
, cl
, "no such me client\n");
1215 /* always allocate at least client max message */
1216 length
= max_t(size_t, length
, mei_cl_mtu(cl
));
1217 cb
= mei_cl_alloc_cb(cl
, length
, MEI_FOP_READ
, fp
);
1221 if (mei_cl_is_fixed_address(cl
)) {
1222 list_add_tail(&cb
->list
, &cl
->rd_pending
);
1226 rets
= pm_runtime_get(dev
->dev
);
1227 if (rets
< 0 && rets
!= -EINPROGRESS
) {
1228 pm_runtime_put_noidle(dev
->dev
);
1229 cl_err(dev
, cl
, "rpm: get failed %d\n", rets
);
1233 if (mei_hbuf_acquire(dev
)) {
1234 rets
= mei_hbm_cl_flow_control_req(dev
, cl
);
1238 list_add_tail(&cb
->list
, &cl
->rd_pending
);
1241 list_add_tail(&cb
->list
, &dev
->ctrl_wr_list
.list
);
1245 cl_dbg(dev
, cl
, "rpm: autosuspend\n");
1246 pm_runtime_mark_last_busy(dev
->dev
);
1247 pm_runtime_put_autosuspend(dev
->dev
);
1256 * mei_cl_irq_write - write a message to device
1257 * from the interrupt thread context
1260 * @cb: callback block.
1261 * @cmpl_list: complete list.
1263 * Return: 0, OK; otherwise error.
1265 int mei_cl_irq_write(struct mei_cl
*cl
, struct mei_cl_cb
*cb
,
1266 struct mei_cl_cb
*cmpl_list
)
1268 struct mei_device
*dev
;
1269 struct mei_msg_data
*buf
;
1270 struct mei_msg_hdr mei_hdr
;
1277 if (WARN_ON(!cl
|| !cl
->dev
))
1284 first_chunk
= cb
->buf_idx
== 0;
1286 rets
= first_chunk
? mei_cl_flow_ctrl_creds(cl
) : 1;
1291 cl_dbg(dev
, cl
, "No flow control credentials: not sending.\n");
1295 slots
= mei_hbuf_empty_slots(dev
);
1296 len
= buf
->size
- cb
->buf_idx
;
1297 msg_slots
= mei_data2slots(len
);
1299 mei_hdr
.host_addr
= mei_cl_host_addr(cl
);
1300 mei_hdr
.me_addr
= mei_cl_me_id(cl
);
1301 mei_hdr
.reserved
= 0;
1302 mei_hdr
.internal
= cb
->internal
;
1304 if (slots
>= msg_slots
) {
1305 mei_hdr
.length
= len
;
1306 mei_hdr
.msg_complete
= 1;
1307 /* Split the message only if we can write the whole host buffer */
1308 } else if (slots
== dev
->hbuf_depth
) {
1310 len
= (slots
* sizeof(u32
)) - sizeof(struct mei_msg_hdr
);
1311 mei_hdr
.length
= len
;
1312 mei_hdr
.msg_complete
= 0;
1314 /* wait for next time the host buffer is empty */
1318 cl_dbg(dev
, cl
, "buf: size = %d idx = %lu\n",
1319 cb
->buf
.size
, cb
->buf_idx
);
1321 rets
= mei_write_message(dev
, &mei_hdr
, buf
->data
+ cb
->buf_idx
);
1324 list_move_tail(&cb
->list
, &cmpl_list
->list
);
1329 cl
->writing_state
= MEI_WRITING
;
1330 cb
->buf_idx
+= mei_hdr
.length
;
1331 cb
->completed
= mei_hdr
.msg_complete
== 1;
1334 if (mei_cl_flow_ctrl_reduce(cl
))
1338 if (mei_hdr
.msg_complete
)
1339 list_move_tail(&cb
->list
, &dev
->write_waiting_list
.list
);
1345 * mei_cl_write - submit a write cb to mei device
1346 * assumes device_lock is locked
1349 * @cb: write callback with filled data
1350 * @blocking: block until completed
1352 * Return: number of bytes sent on success, <0 on failure.
1354 int mei_cl_write(struct mei_cl
*cl
, struct mei_cl_cb
*cb
, bool blocking
)
1356 struct mei_device
*dev
;
1357 struct mei_msg_data
*buf
;
1358 struct mei_msg_hdr mei_hdr
;
1362 if (WARN_ON(!cl
|| !cl
->dev
))
1373 cl_dbg(dev
, cl
, "size=%d\n", buf
->size
);
1375 rets
= pm_runtime_get(dev
->dev
);
1376 if (rets
< 0 && rets
!= -EINPROGRESS
) {
1377 pm_runtime_put_noidle(dev
->dev
);
1378 cl_err(dev
, cl
, "rpm: get failed %d\n", rets
);
1383 cl
->writing_state
= MEI_IDLE
;
1385 mei_hdr
.host_addr
= mei_cl_host_addr(cl
);
1386 mei_hdr
.me_addr
= mei_cl_me_id(cl
);
1387 mei_hdr
.reserved
= 0;
1388 mei_hdr
.msg_complete
= 0;
1389 mei_hdr
.internal
= cb
->internal
;
1391 rets
= mei_cl_flow_ctrl_creds(cl
);
1396 cl_dbg(dev
, cl
, "No flow control credentials: not sending.\n");
1400 if (!mei_hbuf_acquire(dev
)) {
1401 cl_dbg(dev
, cl
, "Cannot acquire the host buffer: not sending.\n");
1406 /* Check for a maximum length */
1407 if (buf
->size
> mei_hbuf_max_len(dev
)) {
1408 mei_hdr
.length
= mei_hbuf_max_len(dev
);
1409 mei_hdr
.msg_complete
= 0;
1411 mei_hdr
.length
= buf
->size
;
1412 mei_hdr
.msg_complete
= 1;
1415 rets
= mei_write_message(dev
, &mei_hdr
, buf
->data
);
1419 rets
= mei_cl_flow_ctrl_reduce(cl
);
1423 cl
->writing_state
= MEI_WRITING
;
1424 cb
->buf_idx
= mei_hdr
.length
;
1425 cb
->completed
= mei_hdr
.msg_complete
== 1;
1428 if (mei_hdr
.msg_complete
)
1429 list_add_tail(&cb
->list
, &dev
->write_waiting_list
.list
);
1431 list_add_tail(&cb
->list
, &dev
->write_list
.list
);
1433 if (blocking
&& cl
->writing_state
!= MEI_WRITE_COMPLETE
) {
1435 mutex_unlock(&dev
->device_lock
);
1436 rets
= wait_event_interruptible(cl
->tx_wait
,
1437 cl
->writing_state
== MEI_WRITE_COMPLETE
);
1438 mutex_lock(&dev
->device_lock
);
1439 /* wait_event_interruptible returns -ERESTARTSYS */
1441 if (signal_pending(current
))
1449 cl_dbg(dev
, cl
, "rpm: autosuspend\n");
1450 pm_runtime_mark_last_busy(dev
->dev
);
1451 pm_runtime_put_autosuspend(dev
->dev
);
1458 * mei_cl_complete - processes completed operation for a client
1460 * @cl: private data of the file object.
1461 * @cb: callback block.
1463 void mei_cl_complete(struct mei_cl
*cl
, struct mei_cl_cb
*cb
)
1465 struct mei_device
*dev
= cl
->dev
;
1467 switch (cb
->fop_type
) {
1470 cl
->writing_state
= MEI_WRITE_COMPLETE
;
1471 if (waitqueue_active(&cl
->tx_wait
)) {
1472 wake_up_interruptible(&cl
->tx_wait
);
1474 pm_runtime_mark_last_busy(dev
->dev
);
1475 pm_request_autosuspend(dev
->dev
);
1480 list_add_tail(&cb
->list
, &cl
->rd_completed
);
1481 if (waitqueue_active(&cl
->rx_wait
))
1482 wake_up_interruptible_all(&cl
->rx_wait
);
1484 mei_cl_bus_rx_event(cl
);
1487 case MEI_FOP_CONNECT
:
1488 case MEI_FOP_DISCONNECT
:
1489 if (waitqueue_active(&cl
->wait
))
1500 * mei_cl_all_disconnect - disconnect forcefully all connected clients
1504 void mei_cl_all_disconnect(struct mei_device
*dev
)
1508 list_for_each_entry(cl
, &dev
->file_list
, link
)
1509 mei_cl_set_disconnected(cl
);
1514 * mei_cl_all_wakeup - wake up all readers and writers they can be interrupted
1518 void mei_cl_all_wakeup(struct mei_device
*dev
)
1522 list_for_each_entry(cl
, &dev
->file_list
, link
) {
1523 if (waitqueue_active(&cl
->rx_wait
)) {
1524 cl_dbg(dev
, cl
, "Waking up reading client!\n");
1525 wake_up_interruptible(&cl
->rx_wait
);
1527 if (waitqueue_active(&cl
->tx_wait
)) {
1528 cl_dbg(dev
, cl
, "Waking up writing client!\n");
1529 wake_up_interruptible(&cl
->tx_wait
);
1535 * mei_cl_all_write_clear - clear all pending writes
1539 void mei_cl_all_write_clear(struct mei_device
*dev
)
1541 mei_io_list_free(&dev
->write_list
, NULL
);
1542 mei_io_list_free(&dev
->write_waiting_list
, NULL
);