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/pci.h>
18 #include <linux/sched.h>
19 #include <linux/wait.h>
20 #include <linux/delay.h>
22 #include <linux/mei.h>
29 * mei_me_cl_by_uuid - locate index of me client
32 * returns me client index or -ENOENT if not found
34 int mei_me_cl_by_uuid(const struct mei_device *dev, const uuid_le *uuid)
38 for (i = 0; i < dev->me_clients_num; ++i)
39 if (uuid_le_cmp(*uuid,
40 dev->me_clients[i].props.protocol_name) == 0) {
50 * mei_me_cl_by_id return index to me_clients for client_id
52 * @dev: the device structure
53 * @client_id: me client id
55 * Locking: called under "dev->device_lock" lock
57 * returns index on success, -ENOENT on failure.
60 int mei_me_cl_by_id(struct mei_device *dev, u8 client_id)
63 for (i = 0; i < dev->me_clients_num; i++)
64 if (dev->me_clients[i].client_id == client_id)
66 if (WARN_ON(dev->me_clients[i].client_id != client_id))
69 if (i == dev->me_clients_num)
77 * mei_io_list_flush - removes list entry belonging to cl.
79 * @list: An instance of our list structure
82 void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl)
85 struct mei_cl_cb *next;
87 list_for_each_entry_safe(cb, next, &list->list, list) {
88 if (cb->cl && mei_cl_cmp_id(cl, cb->cl))
94 * mei_io_cb_free - free mei_cb_private related memory
96 * @cb: mei callback struct
98 void mei_io_cb_free(struct mei_cl_cb *cb)
103 kfree(cb->request_buffer.data);
104 kfree(cb->response_buffer.data);
109 * mei_io_cb_init - allocate and initialize io callback
112 * @fp: pointer to file structure
114 * returns mei_cl_cb pointer or NULL;
116 struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, struct file *fp)
118 struct mei_cl_cb *cb;
120 cb = kzalloc(sizeof(struct mei_cl_cb), GFP_KERNEL);
124 mei_io_list_init(cb);
126 cb->file_object = fp;
133 * mei_io_cb_alloc_req_buf - allocate request buffer
135 * @cb: io callback structure
136 * @length: size of the buffer
138 * returns 0 on success
139 * -EINVAL if cb is NULL
140 * -ENOMEM if allocation failed
142 int mei_io_cb_alloc_req_buf(struct mei_cl_cb *cb, size_t length)
150 cb->request_buffer.data = kmalloc(length, GFP_KERNEL);
151 if (!cb->request_buffer.data)
153 cb->request_buffer.size = length;
157 * mei_io_cb_alloc_resp_buf - allocate respose buffer
159 * @cb: io callback structure
160 * @length: size of the buffer
162 * returns 0 on success
163 * -EINVAL if cb is NULL
164 * -ENOMEM if allocation failed
166 int mei_io_cb_alloc_resp_buf(struct mei_cl_cb *cb, size_t length)
174 cb->response_buffer.data = kmalloc(length, GFP_KERNEL);
175 if (!cb->response_buffer.data)
177 cb->response_buffer.size = length;
184 * mei_cl_flush_queues - flushes queue lists belonging to cl.
188 int mei_cl_flush_queues(struct mei_cl *cl)
190 struct mei_device *dev;
192 if (WARN_ON(!cl || !cl->dev))
197 cl_dbg(dev, cl, "remove list entry belonging to cl\n");
198 mei_io_list_flush(&cl->dev->read_list, cl);
199 mei_io_list_flush(&cl->dev->write_list, cl);
200 mei_io_list_flush(&cl->dev->write_waiting_list, cl);
201 mei_io_list_flush(&cl->dev->ctrl_wr_list, cl);
202 mei_io_list_flush(&cl->dev->ctrl_rd_list, cl);
203 mei_io_list_flush(&cl->dev->amthif_cmd_list, cl);
204 mei_io_list_flush(&cl->dev->amthif_rd_complete_list, cl);
210 * mei_cl_init - initializes intialize cl.
212 * @cl: host client to be initialized
215 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev)
217 memset(cl, 0, sizeof(struct mei_cl));
218 init_waitqueue_head(&cl->wait);
219 init_waitqueue_head(&cl->rx_wait);
220 init_waitqueue_head(&cl->tx_wait);
221 INIT_LIST_HEAD(&cl->link);
222 INIT_LIST_HEAD(&cl->device_link);
223 cl->reading_state = MEI_IDLE;
224 cl->writing_state = MEI_IDLE;
229 * mei_cl_allocate - allocates cl structure and sets it up.
232 * returns The allocated file or NULL on failure
234 struct mei_cl *mei_cl_allocate(struct mei_device *dev)
238 cl = kmalloc(sizeof(struct mei_cl), GFP_KERNEL);
242 mei_cl_init(cl, dev);
248 * mei_cl_find_read_cb - find this cl's callback in the read list
252 * returns cb on success, NULL on error
254 struct mei_cl_cb *mei_cl_find_read_cb(struct mei_cl *cl)
256 struct mei_device *dev = cl->dev;
257 struct mei_cl_cb *cb = NULL;
258 struct mei_cl_cb *next = NULL;
260 list_for_each_entry_safe(cb, next, &dev->read_list.list, list)
261 if (mei_cl_cmp_id(cl, cb->cl))
266 /** mei_cl_link: allocte host id in the host map
269 * @id - fixed host id or -1 for genereting one
271 * returns 0 on success
272 * -EINVAL on incorrect values
273 * -ENONET if client not found
275 int mei_cl_link(struct mei_cl *cl, int id)
277 struct mei_device *dev;
279 if (WARN_ON(!cl || !cl->dev))
284 /* If Id is not asigned get one*/
285 if (id == MEI_HOST_CLIENT_ID_ANY)
286 id = find_first_zero_bit(dev->host_clients_map,
289 if (id >= MEI_CLIENTS_MAX) {
290 dev_err(&dev->pdev->dev, "id exceded %d", MEI_CLIENTS_MAX) ;
294 if (dev->open_handle_count >= MEI_MAX_OPEN_HANDLE_COUNT) {
295 dev_err(&dev->pdev->dev, "open_handle_count exceded %d",
296 MEI_MAX_OPEN_HANDLE_COUNT);
300 if (dev->open_handle_count >= MEI_MAX_OPEN_HANDLE_COUNT) {
301 dev_err(&dev->pdev->dev, "open_handle_count exceded %d",
302 MEI_MAX_OPEN_HANDLE_COUNT);
306 dev->open_handle_count++;
308 cl->host_client_id = id;
309 list_add_tail(&cl->link, &dev->file_list);
311 set_bit(id, dev->host_clients_map);
313 cl->state = MEI_FILE_INITIALIZING;
315 cl_dbg(dev, cl, "link cl\n");
320 * mei_cl_unlink - remove me_cl from the list
324 int mei_cl_unlink(struct mei_cl *cl)
326 struct mei_device *dev;
328 /* don't shout on error exit path */
332 /* wd and amthif might not be initialized */
338 cl_dbg(dev, cl, "unlink client");
340 list_del_init(&cl->link);
346 void mei_host_client_init(struct work_struct *work)
348 struct mei_device *dev = container_of(work,
349 struct mei_device, init_work);
350 struct mei_client_properties *client_props;
353 mutex_lock(&dev->device_lock);
355 bitmap_zero(dev->host_clients_map, MEI_CLIENTS_MAX);
356 dev->open_handle_count = 0;
359 * Reserving the first three client IDs
360 * 0: Reserved for MEI Bus Message communications
361 * 1: Reserved for Watchdog
362 * 2: Reserved for AMTHI
364 bitmap_set(dev->host_clients_map, 0, 3);
366 for (i = 0; i < dev->me_clients_num; i++) {
367 client_props = &dev->me_clients[i].props;
369 if (!uuid_le_cmp(client_props->protocol_name, mei_amthif_guid))
370 mei_amthif_host_init(dev);
371 else if (!uuid_le_cmp(client_props->protocol_name, mei_wd_guid))
372 mei_wd_host_init(dev);
373 else if (!uuid_le_cmp(client_props->protocol_name, mei_nfc_guid))
374 mei_nfc_host_init(dev);
378 dev->dev_state = MEI_DEV_ENABLED;
380 mutex_unlock(&dev->device_lock);
385 * mei_cl_disconnect - disconnect host clinet form the me one
389 * Locking: called under "dev->device_lock" lock
391 * returns 0 on success, <0 on failure.
393 int mei_cl_disconnect(struct mei_cl *cl)
395 struct mei_device *dev;
396 struct mei_cl_cb *cb;
399 if (WARN_ON(!cl || !cl->dev))
404 cl_dbg(dev, cl, "disconnecting");
406 if (cl->state != MEI_FILE_DISCONNECTING)
409 cb = mei_io_cb_init(cl, NULL);
413 cb->fop_type = MEI_FOP_CLOSE;
414 if (dev->hbuf_is_ready) {
415 dev->hbuf_is_ready = false;
416 if (mei_hbm_cl_disconnect_req(dev, cl)) {
418 cl_err(dev, cl, "failed to disconnect.\n");
421 mdelay(10); /* Wait for hardware disconnection ready */
422 list_add_tail(&cb->list, &dev->ctrl_rd_list.list);
424 cl_dbg(dev, cl, "add disconnect cb to control write list\n");
425 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
428 mutex_unlock(&dev->device_lock);
430 err = wait_event_timeout(dev->wait_recvd_msg,
431 MEI_FILE_DISCONNECTED == cl->state,
432 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
434 mutex_lock(&dev->device_lock);
435 if (MEI_FILE_DISCONNECTED == cl->state) {
437 cl_dbg(dev, cl, "successfully disconnected from FW client.\n");
440 if (MEI_FILE_DISCONNECTED != cl->state)
441 cl_err(dev, cl, "wrong status client disconnect.\n");
444 cl_dbg(dev, cl, "wait failed disconnect err=%08x\n",
447 cl_err(dev, cl, "failed to disconnect from FW client.\n");
450 mei_io_list_flush(&dev->ctrl_rd_list, cl);
451 mei_io_list_flush(&dev->ctrl_wr_list, cl);
459 * mei_cl_is_other_connecting - checks if other
460 * client with the same me client id is connecting
462 * @cl: private data of the file object
464 * returns ture if other client is connected, 0 - otherwise.
466 bool mei_cl_is_other_connecting(struct mei_cl *cl)
468 struct mei_device *dev;
472 if (WARN_ON(!cl || !cl->dev))
477 list_for_each_entry_safe(pos, next, &dev->file_list, link) {
478 if ((pos->state == MEI_FILE_CONNECTING) &&
479 (pos != cl) && cl->me_client_id == pos->me_client_id)
488 * mei_cl_connect - connect host clinet to the me one
492 * Locking: called under "dev->device_lock" lock
494 * returns 0 on success, <0 on failure.
496 int mei_cl_connect(struct mei_cl *cl, struct file *file)
498 struct mei_device *dev;
499 struct mei_cl_cb *cb;
502 if (WARN_ON(!cl || !cl->dev))
507 cb = mei_io_cb_init(cl, file);
513 cb->fop_type = MEI_FOP_IOCTL;
515 if (dev->hbuf_is_ready && !mei_cl_is_other_connecting(cl)) {
516 dev->hbuf_is_ready = false;
518 if (mei_hbm_cl_connect_req(dev, cl)) {
522 cl->timer_count = MEI_CONNECT_TIMEOUT;
523 list_add_tail(&cb->list, &dev->ctrl_rd_list.list);
525 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
528 mutex_unlock(&dev->device_lock);
529 rets = wait_event_timeout(dev->wait_recvd_msg,
530 (cl->state == MEI_FILE_CONNECTED ||
531 cl->state == MEI_FILE_DISCONNECTED),
532 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
533 mutex_lock(&dev->device_lock);
535 if (cl->state != MEI_FILE_CONNECTED) {
538 mei_io_list_flush(&dev->ctrl_rd_list, cl);
539 mei_io_list_flush(&dev->ctrl_wr_list, cl);
551 * mei_cl_flow_ctrl_creds - checks flow_control credits for cl.
553 * @cl: private data of the file object
555 * returns 1 if mei_flow_ctrl_creds >0, 0 - otherwise.
556 * -ENOENT if mei_cl is not present
557 * -EINVAL if single_recv_buf == 0
559 int mei_cl_flow_ctrl_creds(struct mei_cl *cl)
561 struct mei_device *dev;
564 if (WARN_ON(!cl || !cl->dev))
569 if (!dev->me_clients_num)
572 if (cl->mei_flow_ctrl_creds > 0)
575 for (i = 0; i < dev->me_clients_num; i++) {
576 struct mei_me_client *me_cl = &dev->me_clients[i];
577 if (me_cl->client_id == cl->me_client_id) {
578 if (me_cl->mei_flow_ctrl_creds) {
579 if (WARN_ON(me_cl->props.single_recv_buf == 0))
591 * mei_cl_flow_ctrl_reduce - reduces flow_control.
593 * @cl: private data of the file object
597 * -ENOENT when me client is not found
598 * -EINVAL when ctrl credits are <= 0
600 int mei_cl_flow_ctrl_reduce(struct mei_cl *cl)
602 struct mei_device *dev;
605 if (WARN_ON(!cl || !cl->dev))
610 if (!dev->me_clients_num)
613 for (i = 0; i < dev->me_clients_num; i++) {
614 struct mei_me_client *me_cl = &dev->me_clients[i];
615 if (me_cl->client_id == cl->me_client_id) {
616 if (me_cl->props.single_recv_buf != 0) {
617 if (WARN_ON(me_cl->mei_flow_ctrl_creds <= 0))
619 dev->me_clients[i].mei_flow_ctrl_creds--;
621 if (WARN_ON(cl->mei_flow_ctrl_creds <= 0))
623 cl->mei_flow_ctrl_creds--;
632 * mei_cl_read_start - the start read client message function.
636 * returns 0 on success, <0 on failure.
638 int mei_cl_read_start(struct mei_cl *cl, size_t length)
640 struct mei_device *dev;
641 struct mei_cl_cb *cb;
645 if (WARN_ON(!cl || !cl->dev))
650 if (!mei_cl_is_connected(cl))
654 cl_dbg(dev, cl, "read is pending.\n");
657 i = mei_me_cl_by_id(dev, cl->me_client_id);
659 cl_err(dev, cl, "no such me client %d\n", cl->me_client_id);
663 cb = mei_io_cb_init(cl, NULL);
667 /* always allocate at least client max message */
668 length = max_t(size_t, length, dev->me_clients[i].props.max_msg_length);
669 rets = mei_io_cb_alloc_resp_buf(cb, length);
673 cb->fop_type = MEI_FOP_READ;
675 if (dev->hbuf_is_ready) {
676 dev->hbuf_is_ready = false;
677 if (mei_hbm_cl_flow_control_req(dev, cl)) {
678 cl_err(dev, cl, "flow control send failed\n");
682 list_add_tail(&cb->list, &dev->read_list.list);
684 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
693 * mei_cl_irq_write_complete - write a message to device
694 * from the interrupt thread context
697 * @cb: callback block.
698 * @slots: free slots.
699 * @cmpl_list: complete list.
701 * returns 0, OK; otherwise error.
703 int mei_cl_irq_write_complete(struct mei_cl *cl, struct mei_cl_cb *cb,
704 s32 *slots, struct mei_cl_cb *cmpl_list)
706 struct mei_device *dev;
707 struct mei_msg_data *buf;
708 struct mei_msg_hdr mei_hdr;
714 if (WARN_ON(!cl || !cl->dev))
719 buf = &cb->request_buffer;
721 rets = mei_cl_flow_ctrl_creds(cl);
726 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
730 len = buf->size - cb->buf_idx;
731 msg_slots = mei_data2slots(len);
733 mei_hdr.host_addr = cl->host_client_id;
734 mei_hdr.me_addr = cl->me_client_id;
735 mei_hdr.reserved = 0;
737 if (*slots >= msg_slots) {
738 mei_hdr.length = len;
739 mei_hdr.msg_complete = 1;
740 /* Split the message only if we can write the whole host buffer */
741 } else if (*slots == dev->hbuf_depth) {
743 len = (*slots * sizeof(u32)) - sizeof(struct mei_msg_hdr);
744 mei_hdr.length = len;
745 mei_hdr.msg_complete = 0;
747 /* wait for next time the host buffer is empty */
751 cl_dbg(dev, cl, "buf: size = %d idx = %lu\n",
752 cb->request_buffer.size, cb->buf_idx);
755 rets = mei_write_message(dev, &mei_hdr, buf->data + cb->buf_idx);
758 list_move_tail(&cb->list, &cmpl_list->list);
763 cl->writing_state = MEI_WRITING;
764 cb->buf_idx += mei_hdr.length;
766 if (mei_hdr.msg_complete) {
767 if (mei_cl_flow_ctrl_reduce(cl))
769 list_move_tail(&cb->list, &dev->write_waiting_list.list);
776 * mei_cl_write - submit a write cb to mei device
777 assumes device_lock is locked
780 * @cl: write callback with filled data
782 * returns numbe of bytes sent on success, <0 on failure.
784 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking)
786 struct mei_device *dev;
787 struct mei_msg_data *buf;
788 struct mei_msg_hdr mei_hdr;
792 if (WARN_ON(!cl || !cl->dev))
801 buf = &cb->request_buffer;
803 cl_dbg(dev, cl, "mei_cl_write %d\n", buf->size);
806 cb->fop_type = MEI_FOP_WRITE;
808 rets = mei_cl_flow_ctrl_creds(cl);
812 /* Host buffer is not ready, we queue the request */
813 if (rets == 0 || !dev->hbuf_is_ready) {
815 /* unseting complete will enqueue the cb for write */
816 mei_hdr.msg_complete = 0;
821 dev->hbuf_is_ready = false;
823 /* Check for a maximum length */
824 if (buf->size > mei_hbuf_max_len(dev)) {
825 mei_hdr.length = mei_hbuf_max_len(dev);
826 mei_hdr.msg_complete = 0;
828 mei_hdr.length = buf->size;
829 mei_hdr.msg_complete = 1;
832 mei_hdr.host_addr = cl->host_client_id;
833 mei_hdr.me_addr = cl->me_client_id;
834 mei_hdr.reserved = 0;
837 rets = mei_write_message(dev, &mei_hdr, buf->data);
841 cl->writing_state = MEI_WRITING;
842 cb->buf_idx = mei_hdr.length;
846 if (mei_hdr.msg_complete) {
847 if (mei_cl_flow_ctrl_reduce(cl)) {
851 list_add_tail(&cb->list, &dev->write_waiting_list.list);
853 list_add_tail(&cb->list, &dev->write_list.list);
857 if (blocking && cl->writing_state != MEI_WRITE_COMPLETE) {
859 mutex_unlock(&dev->device_lock);
860 if (wait_event_interruptible(cl->tx_wait,
861 cl->writing_state == MEI_WRITE_COMPLETE)) {
862 if (signal_pending(current))
867 mutex_lock(&dev->device_lock);
875 * mei_cl_complete - processes completed operation for a client
877 * @cl: private data of the file object.
878 * @cb: callback block.
880 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb)
882 if (cb->fop_type == MEI_FOP_WRITE) {
885 cl->writing_state = MEI_WRITE_COMPLETE;
886 if (waitqueue_active(&cl->tx_wait))
887 wake_up_interruptible(&cl->tx_wait);
889 } else if (cb->fop_type == MEI_FOP_READ &&
890 MEI_READING == cl->reading_state) {
891 cl->reading_state = MEI_READ_COMPLETE;
892 if (waitqueue_active(&cl->rx_wait))
893 wake_up_interruptible(&cl->rx_wait);
895 mei_cl_bus_rx_event(cl);
902 * mei_cl_all_disconnect - disconnect forcefully all connected clients
907 void mei_cl_all_disconnect(struct mei_device *dev)
909 struct mei_cl *cl, *next;
911 list_for_each_entry_safe(cl, next, &dev->file_list, link) {
912 cl->state = MEI_FILE_DISCONNECTED;
913 cl->mei_flow_ctrl_creds = 0;
921 * mei_cl_all_wakeup - wake up all readers and writers they can be interrupted
925 void mei_cl_all_wakeup(struct mei_device *dev)
927 struct mei_cl *cl, *next;
928 list_for_each_entry_safe(cl, next, &dev->file_list, link) {
929 if (waitqueue_active(&cl->rx_wait)) {
930 cl_dbg(dev, cl, "Waking up reading client!\n");
931 wake_up_interruptible(&cl->rx_wait);
933 if (waitqueue_active(&cl->tx_wait)) {
934 cl_dbg(dev, cl, "Waking up writing client!\n");
935 wake_up_interruptible(&cl->tx_wait);
941 * mei_cl_all_write_clear - clear all pending writes
945 void mei_cl_all_write_clear(struct mei_device *dev)
947 struct mei_cl_cb *cb, *next;
949 list_for_each_entry_safe(cb, next, &dev->write_list.list, list) {