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/kernel.h>
19 #include <linux/errno.h>
20 #include <linux/types.h>
21 #include <linux/fcntl.h>
22 #include <linux/aio.h>
23 #include <linux/pci.h>
24 #include <linux/init.h>
25 #include <linux/ioctl.h>
26 #include <linux/cdev.h>
27 #include <linux/list.h>
28 #include <linux/delay.h>
29 #include <linux/sched.h>
30 #include <linux/uuid.h>
31 #include <linux/jiffies.h>
32 #include <linux/uaccess.h>
34 #include <linux/mei.h>
41 const uuid_le mei_amthif_guid = UUID_LE(0x12f80028, 0xb4b7, 0x4b2d,
42 0xac, 0xa8, 0x46, 0xe0,
43 0xff, 0x65, 0x81, 0x4c);
46 * mei_amthif_reset_params - initializes mei device iamthif
48 * @dev: the device structure
50 void mei_amthif_reset_params(struct mei_device *dev)
52 /* reset iamthif parameters. */
53 dev->iamthif_current_cb = NULL;
54 dev->iamthif_msg_buf_size = 0;
55 dev->iamthif_msg_buf_index = 0;
56 dev->iamthif_canceled = false;
57 dev->iamthif_ioctl = false;
58 dev->iamthif_state = MEI_IAMTHIF_IDLE;
59 dev->iamthif_timer = 0;
63 * mei_amthif_host_init - mei initialization amthif client.
65 * @dev: the device structure
68 int mei_amthif_host_init(struct mei_device *dev)
70 struct mei_cl *cl = &dev->iamthif_cl;
71 unsigned char *msg_buf;
74 dev->iamthif_state = MEI_IAMTHIF_IDLE;
78 i = mei_me_cl_by_uuid(dev, &mei_amthif_guid);
80 dev_info(&dev->pdev->dev, "amthif: failed to find the client\n");
84 cl->me_client_id = dev->me_clients[i].client_id;
86 /* Assign iamthif_mtu to the value received from ME */
88 dev->iamthif_mtu = dev->me_clients[i].props.max_msg_length;
89 dev_dbg(&dev->pdev->dev, "IAMTHIF_MTU = %d\n",
90 dev->me_clients[i].props.max_msg_length);
92 kfree(dev->iamthif_msg_buf);
93 dev->iamthif_msg_buf = NULL;
95 /* allocate storage for ME message buffer */
96 msg_buf = kcalloc(dev->iamthif_mtu,
97 sizeof(unsigned char), GFP_KERNEL);
99 dev_err(&dev->pdev->dev, "amthif: memory allocation for ME message buffer failed.\n");
103 dev->iamthif_msg_buf = msg_buf;
105 ret = mei_cl_link(cl, MEI_IAMTHIF_HOST_CLIENT_ID);
108 dev_err(&dev->pdev->dev, "amthif: failed link client\n");
112 cl->state = MEI_FILE_CONNECTING;
114 if (mei_hbm_cl_connect_req(dev, cl)) {
115 dev_dbg(&dev->pdev->dev, "amthif: Failed to connect to ME client\n");
116 cl->state = MEI_FILE_DISCONNECTED;
117 cl->host_client_id = 0;
119 cl->timer_count = MEI_CONNECT_TIMEOUT;
125 * mei_amthif_find_read_list_entry - finds a amthilist entry for current file
127 * @dev: the device structure
128 * @file: pointer to file object
130 * returns returned a list entry on success, NULL on failure.
132 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
135 struct mei_cl_cb *pos = NULL;
136 struct mei_cl_cb *next = NULL;
138 list_for_each_entry_safe(pos, next,
139 &dev->amthif_rd_complete_list.list, list) {
140 if (pos->cl && pos->cl == &dev->iamthif_cl &&
141 pos->file_object == file)
149 * mei_amthif_read - read data from AMTHIF client
151 * @dev: the device structure
152 * @if_num: minor number
153 * @file: pointer to file object
154 * @*ubuf: pointer to user data in user space
155 * @length: data length to read
156 * @offset: data read offset
158 * Locking: called under "dev->device_lock" lock
161 * returned data length on success,
162 * zero if no data to read,
163 * negative on failure.
165 int mei_amthif_read(struct mei_device *dev, struct file *file,
166 char __user *ubuf, size_t length, loff_t *offset)
170 struct mei_cl_cb *cb = NULL;
171 struct mei_cl *cl = file->private_data;
172 unsigned long timeout;
175 /* Only Posible if we are in timeout */
176 if (!cl || cl != &dev->iamthif_cl) {
177 dev_dbg(&dev->pdev->dev, "bad file ext.\n");
181 i = mei_me_cl_by_id(dev, dev->iamthif_cl.me_client_id);
184 dev_dbg(&dev->pdev->dev, "amthif client not found.\n");
187 dev_dbg(&dev->pdev->dev, "checking amthif data\n");
188 cb = mei_amthif_find_read_list_entry(dev, file);
190 /* Check for if we can block or not*/
191 if (cb == NULL && file->f_flags & O_NONBLOCK)
195 dev_dbg(&dev->pdev->dev, "waiting for amthif data\n");
197 /* unlock the Mutex */
198 mutex_unlock(&dev->device_lock);
200 wait_ret = wait_event_interruptible(dev->iamthif_cl.wait,
201 (cb = mei_amthif_find_read_list_entry(dev, file)));
203 /* Locking again the Mutex */
204 mutex_lock(&dev->device_lock);
209 dev_dbg(&dev->pdev->dev, "woke up from sleep\n");
213 dev_dbg(&dev->pdev->dev, "Got amthif data\n");
214 dev->iamthif_timer = 0;
217 timeout = cb->read_time +
218 mei_secs_to_jiffies(MEI_IAMTHIF_READ_TIMER);
219 dev_dbg(&dev->pdev->dev, "amthif timeout = %lud\n",
222 if (time_after(jiffies, timeout)) {
223 dev_dbg(&dev->pdev->dev, "amthif Time out\n");
224 /* 15 sec for the message has expired */
230 /* if the whole message will fit remove it from the list */
231 if (cb->buf_idx >= *offset && length >= (cb->buf_idx - *offset))
233 else if (cb->buf_idx > 0 && cb->buf_idx <= *offset) {
234 /* end of the message has been reached */
239 /* else means that not full buffer will be read and do not
240 * remove message from deletion list
243 dev_dbg(&dev->pdev->dev, "amthif cb->response_buffer size - %d\n",
244 cb->response_buffer.size);
245 dev_dbg(&dev->pdev->dev, "amthif cb->buf_idx - %lu\n", cb->buf_idx);
247 /* length is being turncated to PAGE_SIZE, however,
248 * the buf_idx may point beyond */
249 length = min_t(size_t, length, (cb->buf_idx - *offset));
251 if (copy_to_user(ubuf, cb->response_buffer.data + *offset, length))
255 if ((*offset + length) < cb->buf_idx) {
261 dev_dbg(&dev->pdev->dev, "free amthif cb memory.\n");
269 * mei_amthif_send_cmd - send amthif command to the ME
271 * @dev: the device structure
272 * @cb: mei call back struct
274 * returns 0 on success, <0 on failure.
277 static int mei_amthif_send_cmd(struct mei_device *dev, struct mei_cl_cb *cb)
279 struct mei_msg_hdr mei_hdr;
285 dev_dbg(&dev->pdev->dev, "write data to amthif client.\n");
287 dev->iamthif_state = MEI_IAMTHIF_WRITING;
288 dev->iamthif_current_cb = cb;
289 dev->iamthif_file_object = cb->file_object;
290 dev->iamthif_canceled = false;
291 dev->iamthif_ioctl = true;
292 dev->iamthif_msg_buf_size = cb->request_buffer.size;
293 memcpy(dev->iamthif_msg_buf, cb->request_buffer.data,
294 cb->request_buffer.size);
296 ret = mei_cl_flow_ctrl_creds(&dev->iamthif_cl);
300 if (ret && dev->hbuf_is_ready) {
302 dev->hbuf_is_ready = false;
303 if (cb->request_buffer.size > mei_hbuf_max_len(dev)) {
304 mei_hdr.length = mei_hbuf_max_len(dev);
305 mei_hdr.msg_complete = 0;
307 mei_hdr.length = cb->request_buffer.size;
308 mei_hdr.msg_complete = 1;
311 mei_hdr.host_addr = dev->iamthif_cl.host_client_id;
312 mei_hdr.me_addr = dev->iamthif_cl.me_client_id;
313 mei_hdr.reserved = 0;
314 dev->iamthif_msg_buf_index += mei_hdr.length;
315 if (mei_write_message(dev, &mei_hdr,
316 (unsigned char *)dev->iamthif_msg_buf))
319 if (mei_hdr.msg_complete) {
320 if (mei_cl_flow_ctrl_reduce(&dev->iamthif_cl))
322 dev->iamthif_flow_control_pending = true;
323 dev->iamthif_state = MEI_IAMTHIF_FLOW_CONTROL;
324 dev_dbg(&dev->pdev->dev, "add amthif cb to write waiting list\n");
325 dev->iamthif_current_cb = cb;
326 dev->iamthif_file_object = cb->file_object;
327 list_add_tail(&cb->list, &dev->write_waiting_list.list);
329 dev_dbg(&dev->pdev->dev, "message does not complete, so add amthif cb to write list.\n");
330 list_add_tail(&cb->list, &dev->write_list.list);
333 if (!dev->hbuf_is_ready)
334 dev_dbg(&dev->pdev->dev, "host buffer is not empty");
336 dev_dbg(&dev->pdev->dev, "No flow control credentials, so add iamthif cb to write list.\n");
337 list_add_tail(&cb->list, &dev->write_list.list);
343 * mei_amthif_write - write amthif data to amthif client
345 * @dev: the device structure
346 * @cb: mei call back struct
348 * returns 0 on success, <0 on failure.
351 int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *cb)
358 ret = mei_io_cb_alloc_resp_buf(cb, dev->iamthif_mtu);
362 cb->fop_type = MEI_FOP_IOCTL;
364 if (!list_empty(&dev->amthif_cmd_list.list) ||
365 dev->iamthif_state != MEI_IAMTHIF_IDLE) {
366 dev_dbg(&dev->pdev->dev,
367 "amthif state = %d\n", dev->iamthif_state);
368 dev_dbg(&dev->pdev->dev, "AMTHIF: add cb to the wait list\n");
369 list_add_tail(&cb->list, &dev->amthif_cmd_list.list);
372 return mei_amthif_send_cmd(dev, cb);
375 * mei_amthif_run_next_cmd
377 * @dev: the device structure
379 * returns 0 on success, <0 on failure.
381 void mei_amthif_run_next_cmd(struct mei_device *dev)
383 struct mei_cl_cb *pos = NULL;
384 struct mei_cl_cb *next = NULL;
390 dev->iamthif_msg_buf_size = 0;
391 dev->iamthif_msg_buf_index = 0;
392 dev->iamthif_canceled = false;
393 dev->iamthif_ioctl = true;
394 dev->iamthif_state = MEI_IAMTHIF_IDLE;
395 dev->iamthif_timer = 0;
396 dev->iamthif_file_object = NULL;
398 dev_dbg(&dev->pdev->dev, "complete amthif cmd_list cb.\n");
400 list_for_each_entry_safe(pos, next, &dev->amthif_cmd_list.list, list) {
401 list_del(&pos->list);
403 if (pos->cl && pos->cl == &dev->iamthif_cl) {
404 status = mei_amthif_send_cmd(dev, pos);
406 dev_dbg(&dev->pdev->dev,
407 "amthif write failed status = %d\n",
417 unsigned int mei_amthif_poll(struct mei_device *dev,
418 struct file *file, poll_table *wait)
420 unsigned int mask = 0;
421 mutex_unlock(&dev->device_lock);
422 poll_wait(file, &dev->iamthif_cl.wait, wait);
423 mutex_lock(&dev->device_lock);
424 if (dev->iamthif_state == MEI_IAMTHIF_READ_COMPLETE &&
425 dev->iamthif_file_object == file) {
426 mask |= (POLLIN | POLLRDNORM);
427 dev_dbg(&dev->pdev->dev, "run next amthif cb\n");
428 mei_amthif_run_next_cmd(dev);
436 * mei_amthif_irq_write_completed - processes completed iamthif operation.
438 * @dev: the device structure.
439 * @slots: free slots.
440 * @cb_pos: callback block.
441 * @cl: private data of the file object.
442 * @cmpl_list: complete list.
444 * returns 0, OK; otherwise, error.
446 int mei_amthif_irq_write_complete(struct mei_device *dev, s32 *slots,
447 struct mei_cl_cb *cb, struct mei_cl_cb *cmpl_list)
449 struct mei_msg_hdr mei_hdr;
450 struct mei_cl *cl = cb->cl;
451 size_t len = dev->iamthif_msg_buf_size - dev->iamthif_msg_buf_index;
452 u32 msg_slots = mei_data2slots(len);
454 mei_hdr.host_addr = cl->host_client_id;
455 mei_hdr.me_addr = cl->me_client_id;
456 mei_hdr.reserved = 0;
458 if (*slots >= msg_slots) {
459 mei_hdr.length = len;
460 mei_hdr.msg_complete = 1;
461 /* Split the message only if we can write the whole host buffer */
462 } else if (*slots == dev->hbuf_depth) {
464 len = (*slots * sizeof(u32)) - sizeof(struct mei_msg_hdr);
465 mei_hdr.length = len;
466 mei_hdr.msg_complete = 0;
468 /* wait for next time the host buffer is empty */
472 dev_dbg(&dev->pdev->dev, MEI_HDR_FMT, MEI_HDR_PRM(&mei_hdr));
475 if (mei_write_message(dev, &mei_hdr,
476 dev->iamthif_msg_buf + dev->iamthif_msg_buf_index)) {
477 dev->iamthif_state = MEI_IAMTHIF_IDLE;
478 cl->status = -ENODEV;
483 if (mei_cl_flow_ctrl_reduce(cl))
486 dev->iamthif_msg_buf_index += mei_hdr.length;
489 if (mei_hdr.msg_complete) {
490 dev->iamthif_state = MEI_IAMTHIF_FLOW_CONTROL;
491 dev->iamthif_flow_control_pending = true;
493 /* save iamthif cb sent to amthif client */
494 cb->buf_idx = dev->iamthif_msg_buf_index;
495 dev->iamthif_current_cb = cb;
497 list_move_tail(&cb->list, &dev->write_waiting_list.list);
505 * mei_amthif_irq_read_message - read routine after ISR to
506 * handle the read amthif message
508 * @dev: the device structure
509 * @mei_hdr: header of amthif message
510 * @complete_list: An instance of our list structure
512 * returns 0 on success, <0 on failure.
514 int mei_amthif_irq_read_msg(struct mei_device *dev,
515 struct mei_msg_hdr *mei_hdr,
516 struct mei_cl_cb *complete_list)
518 struct mei_cl_cb *cb;
519 unsigned char *buffer;
521 BUG_ON(mei_hdr->me_addr != dev->iamthif_cl.me_client_id);
522 BUG_ON(dev->iamthif_state != MEI_IAMTHIF_READING);
524 buffer = dev->iamthif_msg_buf + dev->iamthif_msg_buf_index;
525 BUG_ON(dev->iamthif_mtu < dev->iamthif_msg_buf_index + mei_hdr->length);
527 mei_read_slots(dev, buffer, mei_hdr->length);
529 dev->iamthif_msg_buf_index += mei_hdr->length;
531 if (!mei_hdr->msg_complete)
534 dev_dbg(&dev->pdev->dev, "amthif_message_buffer_index =%d\n",
537 dev_dbg(&dev->pdev->dev, "completed amthif read.\n ");
538 if (!dev->iamthif_current_cb)
541 cb = dev->iamthif_current_cb;
542 dev->iamthif_current_cb = NULL;
547 dev->iamthif_stall_timer = 0;
548 cb->buf_idx = dev->iamthif_msg_buf_index;
549 cb->read_time = jiffies;
550 if (dev->iamthif_ioctl && cb->cl == &dev->iamthif_cl) {
551 /* found the iamthif cb */
552 dev_dbg(&dev->pdev->dev, "complete the amthif read cb.\n ");
553 dev_dbg(&dev->pdev->dev, "add the amthif read cb to complete.\n ");
554 list_add_tail(&cb->list, &complete_list->list);
560 * mei_amthif_irq_read - prepares to read amthif data.
562 * @dev: the device structure.
563 * @slots: free slots.
565 * returns 0, OK; otherwise, error.
567 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots)
569 u32 msg_slots = mei_data2slots(sizeof(struct hbm_flow_control));
571 if (*slots < msg_slots)
576 if (mei_hbm_cl_flow_control_req(dev, &dev->iamthif_cl)) {
577 dev_dbg(&dev->pdev->dev, "iamthif flow control failed\n");
581 dev_dbg(&dev->pdev->dev, "iamthif flow control success\n");
582 dev->iamthif_state = MEI_IAMTHIF_READING;
583 dev->iamthif_flow_control_pending = false;
584 dev->iamthif_msg_buf_index = 0;
585 dev->iamthif_msg_buf_size = 0;
586 dev->iamthif_stall_timer = MEI_IAMTHIF_STALL_TIMER;
587 dev->hbuf_is_ready = mei_hbuf_is_ready(dev);
592 * mei_amthif_complete - complete amthif callback.
594 * @dev: the device structure.
595 * @cb_pos: callback block.
597 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb)
599 if (dev->iamthif_canceled != 1) {
600 dev->iamthif_state = MEI_IAMTHIF_READ_COMPLETE;
601 dev->iamthif_stall_timer = 0;
602 memcpy(cb->response_buffer.data,
603 dev->iamthif_msg_buf,
604 dev->iamthif_msg_buf_index);
605 list_add_tail(&cb->list, &dev->amthif_rd_complete_list.list);
606 dev_dbg(&dev->pdev->dev, "amthif read completed\n");
607 dev->iamthif_timer = jiffies;
608 dev_dbg(&dev->pdev->dev, "dev->iamthif_timer = %ld\n",
611 mei_amthif_run_next_cmd(dev);
614 dev_dbg(&dev->pdev->dev, "completing amthif call back.\n");
615 wake_up_interruptible(&dev->iamthif_cl.wait);
619 * mei_clear_list - removes all callbacks associated with file
622 * @dev: device structure.
623 * @file: file structure
624 * @mei_cb_list: callbacks list
626 * mei_clear_list is called to clear resources associated with file
627 * when application calls close function or Ctrl-C was pressed
629 * returns true if callback removed from the list, false otherwise
631 static bool mei_clear_list(struct mei_device *dev,
632 const struct file *file, struct list_head *mei_cb_list)
634 struct mei_cl_cb *cb_pos = NULL;
635 struct mei_cl_cb *cb_next = NULL;
636 bool removed = false;
638 /* list all list member */
639 list_for_each_entry_safe(cb_pos, cb_next, mei_cb_list, list) {
640 /* check if list member associated with a file */
641 if (file == cb_pos->file_object) {
642 /* remove member from the list */
643 list_del(&cb_pos->list);
644 /* check if cb equal to current iamthif cb */
645 if (dev->iamthif_current_cb == cb_pos) {
646 dev->iamthif_current_cb = NULL;
647 /* send flow control to iamthif client */
648 mei_hbm_cl_flow_control_req(dev,
651 /* free all allocated buffers */
652 mei_io_cb_free(cb_pos);
661 * mei_clear_lists - removes all callbacks associated with file
663 * @dev: device structure
664 * @file: file structure
666 * mei_clear_lists is called to clear resources associated with file
667 * when application calls close function or Ctrl-C was pressed
669 * returns true if callback removed from the list, false otherwise
671 static bool mei_clear_lists(struct mei_device *dev, struct file *file)
673 bool removed = false;
675 /* remove callbacks associated with a file */
676 mei_clear_list(dev, file, &dev->amthif_cmd_list.list);
677 if (mei_clear_list(dev, file, &dev->amthif_rd_complete_list.list))
680 mei_clear_list(dev, file, &dev->ctrl_rd_list.list);
682 if (mei_clear_list(dev, file, &dev->ctrl_wr_list.list))
685 if (mei_clear_list(dev, file, &dev->write_waiting_list.list))
688 if (mei_clear_list(dev, file, &dev->write_list.list))
691 /* check if iamthif_current_cb not NULL */
692 if (dev->iamthif_current_cb && !removed) {
693 /* check file and iamthif current cb association */
694 if (dev->iamthif_current_cb->file_object == file) {
696 mei_io_cb_free(dev->iamthif_current_cb);
697 dev->iamthif_current_cb = NULL;
705 * mei_amthif_release - the release function
707 * @dev: device structure
708 * @file: pointer to file structure
710 * returns 0 on success, <0 on error
712 int mei_amthif_release(struct mei_device *dev, struct file *file)
714 if (dev->open_handle_count > 0)
715 dev->open_handle_count--;
717 if (dev->iamthif_file_object == file &&
718 dev->iamthif_state != MEI_IAMTHIF_IDLE) {
720 dev_dbg(&dev->pdev->dev, "amthif canceled iamthif state %d\n",
722 dev->iamthif_canceled = true;
723 if (dev->iamthif_state == MEI_IAMTHIF_READ_COMPLETE) {
724 dev_dbg(&dev->pdev->dev, "run next amthif iamthif cb\n");
725 mei_amthif_run_next_cmd(dev);
729 if (mei_clear_lists(dev, file))
730 dev->iamthif_state = MEI_IAMTHIF_IDLE;