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 * @file: 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 * @size: 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_req_buf - allocate respose buffer
159 * @cb - io callback structure
160 * @size: 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.
186 * @dev: the device structure
189 int mei_cl_flush_queues(struct mei_cl *cl)
191 if (WARN_ON(!cl || !cl->dev))
194 dev_dbg(&cl->dev->pdev->dev, "remove list entry belonging to cl\n");
195 mei_io_list_flush(&cl->dev->read_list, cl);
196 mei_io_list_flush(&cl->dev->write_list, cl);
197 mei_io_list_flush(&cl->dev->write_waiting_list, cl);
198 mei_io_list_flush(&cl->dev->ctrl_wr_list, cl);
199 mei_io_list_flush(&cl->dev->ctrl_rd_list, cl);
200 mei_io_list_flush(&cl->dev->amthif_cmd_list, cl);
201 mei_io_list_flush(&cl->dev->amthif_rd_complete_list, cl);
207 * mei_cl_init - initializes intialize cl.
209 * @cl: host client to be initialized
212 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev)
214 memset(cl, 0, sizeof(struct mei_cl));
215 init_waitqueue_head(&cl->wait);
216 init_waitqueue_head(&cl->rx_wait);
217 init_waitqueue_head(&cl->tx_wait);
218 INIT_LIST_HEAD(&cl->link);
219 INIT_LIST_HEAD(&cl->device_link);
220 cl->reading_state = MEI_IDLE;
221 cl->writing_state = MEI_IDLE;
226 * mei_cl_allocate - allocates cl structure and sets it up.
229 * returns The allocated file or NULL on failure
231 struct mei_cl *mei_cl_allocate(struct mei_device *dev)
235 cl = kmalloc(sizeof(struct mei_cl), GFP_KERNEL);
239 mei_cl_init(cl, dev);
245 * mei_cl_find_read_cb - find this cl's callback in the read list
247 * @dev: device structure
248 * returns cb on success, NULL on error
250 struct mei_cl_cb *mei_cl_find_read_cb(struct mei_cl *cl)
252 struct mei_device *dev = cl->dev;
253 struct mei_cl_cb *cb = NULL;
254 struct mei_cl_cb *next = NULL;
256 list_for_each_entry_safe(cb, next, &dev->read_list.list, list)
257 if (mei_cl_cmp_id(cl, cb->cl))
262 /** mei_cl_link: allocte host id in the host map
265 * @id - fixed host id or -1 for genereting one
266 * returns 0 on success
267 * -EINVAL on incorrect values
268 * -ENONET if client not found
270 int mei_cl_link(struct mei_cl *cl, int id)
272 struct mei_device *dev;
274 if (WARN_ON(!cl || !cl->dev))
279 /* If Id is not asigned get one*/
280 if (id == MEI_HOST_CLIENT_ID_ANY)
281 id = find_first_zero_bit(dev->host_clients_map,
284 if (id >= MEI_CLIENTS_MAX) {
285 dev_err(&dev->pdev->dev, "id exceded %d", MEI_CLIENTS_MAX) ;
289 dev->open_handle_count++;
291 cl->host_client_id = id;
292 list_add_tail(&cl->link, &dev->file_list);
294 set_bit(id, dev->host_clients_map);
296 cl->state = MEI_FILE_INITIALIZING;
298 dev_dbg(&dev->pdev->dev, "link cl host id = %d\n", cl->host_client_id);
303 * mei_cl_unlink - remove me_cl from the list
305 * @dev: the device structure
307 int mei_cl_unlink(struct mei_cl *cl)
309 struct mei_device *dev;
310 struct mei_cl *pos, *next;
312 /* don't shout on error exit path */
316 /* wd and amthif might not be initialized */
322 list_for_each_entry_safe(pos, next, &dev->file_list, link) {
323 if (cl->host_client_id == pos->host_client_id) {
324 dev_dbg(&dev->pdev->dev, "remove host client = %d, ME client = %d\n",
325 pos->host_client_id, pos->me_client_id);
326 list_del_init(&pos->link);
334 void mei_host_client_init(struct work_struct *work)
336 struct mei_device *dev = container_of(work,
337 struct mei_device, init_work);
338 struct mei_client_properties *client_props;
341 mutex_lock(&dev->device_lock);
343 bitmap_zero(dev->host_clients_map, MEI_CLIENTS_MAX);
344 dev->open_handle_count = 0;
347 * Reserving the first three client IDs
348 * 0: Reserved for MEI Bus Message communications
349 * 1: Reserved for Watchdog
350 * 2: Reserved for AMTHI
352 bitmap_set(dev->host_clients_map, 0, 3);
354 for (i = 0; i < dev->me_clients_num; i++) {
355 client_props = &dev->me_clients[i].props;
357 if (!uuid_le_cmp(client_props->protocol_name, mei_amthif_guid))
358 mei_amthif_host_init(dev);
359 else if (!uuid_le_cmp(client_props->protocol_name, mei_wd_guid))
360 mei_wd_host_init(dev);
361 else if (!uuid_le_cmp(client_props->protocol_name, mei_nfc_guid))
362 mei_nfc_host_init(dev);
366 dev->dev_state = MEI_DEV_ENABLED;
368 mutex_unlock(&dev->device_lock);
373 * mei_cl_disconnect - disconnect host clinet form the me one
377 * Locking: called under "dev->device_lock" lock
379 * returns 0 on success, <0 on failure.
381 int mei_cl_disconnect(struct mei_cl *cl)
383 struct mei_device *dev;
384 struct mei_cl_cb *cb;
387 if (WARN_ON(!cl || !cl->dev))
392 if (cl->state != MEI_FILE_DISCONNECTING)
395 cb = mei_io_cb_init(cl, NULL);
399 cb->fop_type = MEI_FOP_CLOSE;
400 if (dev->hbuf_is_ready) {
401 dev->hbuf_is_ready = false;
402 if (mei_hbm_cl_disconnect_req(dev, cl)) {
404 dev_err(&dev->pdev->dev, "failed to disconnect.\n");
407 mdelay(10); /* Wait for hardware disconnection ready */
408 list_add_tail(&cb->list, &dev->ctrl_rd_list.list);
410 dev_dbg(&dev->pdev->dev, "add disconnect cb to control write list\n");
411 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
414 mutex_unlock(&dev->device_lock);
416 err = wait_event_timeout(dev->wait_recvd_msg,
417 MEI_FILE_DISCONNECTED == cl->state,
418 mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
420 mutex_lock(&dev->device_lock);
421 if (MEI_FILE_DISCONNECTED == cl->state) {
423 dev_dbg(&dev->pdev->dev, "successfully disconnected from FW client.\n");
426 if (MEI_FILE_DISCONNECTED != cl->state)
427 dev_dbg(&dev->pdev->dev, "wrong status client disconnect.\n");
430 dev_dbg(&dev->pdev->dev,
431 "wait failed disconnect err=%08x\n",
434 dev_dbg(&dev->pdev->dev, "failed to disconnect from FW client.\n");
437 mei_io_list_flush(&dev->ctrl_rd_list, cl);
438 mei_io_list_flush(&dev->ctrl_wr_list, cl);
446 * mei_cl_is_other_connecting - checks if other
447 * client with the same me client id is connecting
449 * @cl: private data of the file object
451 * returns ture if other client is connected, 0 - otherwise.
453 bool mei_cl_is_other_connecting(struct mei_cl *cl)
455 struct mei_device *dev;
459 if (WARN_ON(!cl || !cl->dev))
464 list_for_each_entry_safe(pos, next, &dev->file_list, link) {
465 if ((pos->state == MEI_FILE_CONNECTING) &&
466 (pos != cl) && cl->me_client_id == pos->me_client_id)
475 * mei_cl_connect - connect host clinet to the me one
479 * Locking: called under "dev->device_lock" lock
481 * returns 0 on success, <0 on failure.
483 int mei_cl_connect(struct mei_cl *cl, struct file *file)
485 struct mei_device *dev;
486 struct mei_cl_cb *cb;
487 long timeout = mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT);
490 if (WARN_ON(!cl || !cl->dev))
495 cb = mei_io_cb_init(cl, file);
501 cb->fop_type = MEI_FOP_IOCTL;
503 if (dev->hbuf_is_ready && !mei_cl_is_other_connecting(cl)) {
504 dev->hbuf_is_ready = false;
506 if (mei_hbm_cl_connect_req(dev, cl)) {
510 cl->timer_count = MEI_CONNECT_TIMEOUT;
511 list_add_tail(&cb->list, &dev->ctrl_rd_list.list);
513 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
516 mutex_unlock(&dev->device_lock);
517 rets = wait_event_timeout(dev->wait_recvd_msg,
518 (cl->state == MEI_FILE_CONNECTED ||
519 cl->state == MEI_FILE_DISCONNECTED),
521 mutex_lock(&dev->device_lock);
523 if (cl->state != MEI_FILE_CONNECTED) {
526 mei_io_list_flush(&dev->ctrl_rd_list, cl);
527 mei_io_list_flush(&dev->ctrl_wr_list, cl);
539 * mei_cl_flow_ctrl_creds - checks flow_control credits for cl.
541 * @dev: the device structure
542 * @cl: private data of the file object
544 * returns 1 if mei_flow_ctrl_creds >0, 0 - otherwise.
545 * -ENOENT if mei_cl is not present
546 * -EINVAL if single_recv_buf == 0
548 int mei_cl_flow_ctrl_creds(struct mei_cl *cl)
550 struct mei_device *dev;
553 if (WARN_ON(!cl || !cl->dev))
558 if (!dev->me_clients_num)
561 if (cl->mei_flow_ctrl_creds > 0)
564 for (i = 0; i < dev->me_clients_num; i++) {
565 struct mei_me_client *me_cl = &dev->me_clients[i];
566 if (me_cl->client_id == cl->me_client_id) {
567 if (me_cl->mei_flow_ctrl_creds) {
568 if (WARN_ON(me_cl->props.single_recv_buf == 0))
580 * mei_cl_flow_ctrl_reduce - reduces flow_control.
582 * @dev: the device structure
583 * @cl: private data of the file object
586 * -ENOENT when me client is not found
587 * -EINVAL when ctrl credits are <= 0
589 int mei_cl_flow_ctrl_reduce(struct mei_cl *cl)
591 struct mei_device *dev;
594 if (WARN_ON(!cl || !cl->dev))
599 if (!dev->me_clients_num)
602 for (i = 0; i < dev->me_clients_num; i++) {
603 struct mei_me_client *me_cl = &dev->me_clients[i];
604 if (me_cl->client_id == cl->me_client_id) {
605 if (me_cl->props.single_recv_buf != 0) {
606 if (WARN_ON(me_cl->mei_flow_ctrl_creds <= 0))
608 dev->me_clients[i].mei_flow_ctrl_creds--;
610 if (WARN_ON(cl->mei_flow_ctrl_creds <= 0))
612 cl->mei_flow_ctrl_creds--;
621 * mei_cl_start_read - the start read client message function.
625 * returns 0 on success, <0 on failure.
627 int mei_cl_read_start(struct mei_cl *cl, size_t length)
629 struct mei_device *dev;
630 struct mei_cl_cb *cb;
634 if (WARN_ON(!cl || !cl->dev))
639 if (cl->state != MEI_FILE_CONNECTED)
642 if (dev->dev_state != MEI_DEV_ENABLED)
646 dev_dbg(&dev->pdev->dev, "read is pending.\n");
649 i = mei_me_cl_by_id(dev, cl->me_client_id);
651 dev_err(&dev->pdev->dev, "no such me client %d\n",
656 cb = mei_io_cb_init(cl, NULL);
660 /* always allocate at least client max message */
661 length = max_t(size_t, length, dev->me_clients[i].props.max_msg_length);
662 rets = mei_io_cb_alloc_resp_buf(cb, length);
666 cb->fop_type = MEI_FOP_READ;
668 if (dev->hbuf_is_ready) {
669 dev->hbuf_is_ready = false;
670 if (mei_hbm_cl_flow_control_req(dev, cl)) {
674 list_add_tail(&cb->list, &dev->read_list.list);
676 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
685 * mei_cl_write - submit a write cb to mei device
686 assumes device_lock is locked
689 * @cl: write callback with filled data
691 * returns numbe of bytes sent on success, <0 on failure.
693 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking)
695 struct mei_device *dev;
696 struct mei_msg_data *buf;
697 struct mei_msg_hdr mei_hdr;
701 if (WARN_ON(!cl || !cl->dev))
710 buf = &cb->request_buffer;
712 dev_dbg(&dev->pdev->dev, "mei_cl_write %d\n", buf->size);
715 cb->fop_type = MEI_FOP_WRITE;
717 rets = mei_cl_flow_ctrl_creds(cl);
721 /* Host buffer is not ready, we queue the request */
722 if (rets == 0 || !dev->hbuf_is_ready) {
724 /* unseting complete will enqueue the cb for write */
725 mei_hdr.msg_complete = 0;
726 cl->writing_state = MEI_WRITING;
731 dev->hbuf_is_ready = false;
733 /* Check for a maximum length */
734 if (buf->size > mei_hbuf_max_len(dev)) {
735 mei_hdr.length = mei_hbuf_max_len(dev);
736 mei_hdr.msg_complete = 0;
738 mei_hdr.length = buf->size;
739 mei_hdr.msg_complete = 1;
742 mei_hdr.host_addr = cl->host_client_id;
743 mei_hdr.me_addr = cl->me_client_id;
744 mei_hdr.reserved = 0;
746 dev_dbg(&dev->pdev->dev, "write " MEI_HDR_FMT "\n",
747 MEI_HDR_PRM(&mei_hdr));
750 if (mei_write_message(dev, &mei_hdr, buf->data)) {
755 cl->writing_state = MEI_WRITING;
756 cb->buf_idx = mei_hdr.length;
760 if (mei_hdr.msg_complete) {
761 if (mei_cl_flow_ctrl_reduce(cl)) {
765 list_add_tail(&cb->list, &dev->write_waiting_list.list);
767 list_add_tail(&cb->list, &dev->write_list.list);
771 if (blocking && cl->writing_state != MEI_WRITE_COMPLETE) {
773 mutex_unlock(&dev->device_lock);
774 if (wait_event_interruptible(cl->tx_wait,
775 cl->writing_state == MEI_WRITE_COMPLETE)) {
776 if (signal_pending(current))
781 mutex_lock(&dev->device_lock);
790 * mei_cl_all_disconnect - disconnect forcefully all connected clients
795 void mei_cl_all_disconnect(struct mei_device *dev)
797 struct mei_cl *cl, *next;
799 list_for_each_entry_safe(cl, next, &dev->file_list, link) {
800 cl->state = MEI_FILE_DISCONNECTED;
801 cl->mei_flow_ctrl_creds = 0;
809 * mei_cl_all_read_wakeup - wake up all readings so they can be interrupted
813 void mei_cl_all_read_wakeup(struct mei_device *dev)
815 struct mei_cl *cl, *next;
816 list_for_each_entry_safe(cl, next, &dev->file_list, link) {
817 if (waitqueue_active(&cl->rx_wait)) {
818 dev_dbg(&dev->pdev->dev, "Waking up client!\n");
819 wake_up_interruptible(&cl->rx_wait);
825 * mei_cl_all_write_clear - clear all pending writes
829 void mei_cl_all_write_clear(struct mei_device *dev)
831 struct mei_cl_cb *cb, *next;
833 list_for_each_entry_safe(cb, next, &dev->write_list.list, list) {