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/ioctl.h>
25 #include <linux/cdev.h>
26 #include <linux/list.h>
27 #include <linux/delay.h>
28 #include <linux/sched.h>
29 #include <linux/uuid.h>
30 #include <linux/jiffies.h>
31 #include <linux/uaccess.h>
33 #include <linux/mei.h>
40 const uuid_le mei_amthif_guid = UUID_LE(0x12f80028, 0xb4b7, 0x4b2d,
41 0xac, 0xa8, 0x46, 0xe0,
42 0xff, 0x65, 0x81, 0x4c);
45 * mei_amthif_reset_params - initializes mei device iamthif
47 * @dev: the device structure
49 void mei_amthif_reset_params(struct mei_device *dev)
51 /* reset iamthif parameters. */
52 dev->iamthif_current_cb = NULL;
53 dev->iamthif_msg_buf_size = 0;
54 dev->iamthif_msg_buf_index = 0;
55 dev->iamthif_canceled = false;
56 dev->iamthif_ioctl = false;
57 dev->iamthif_state = MEI_IAMTHIF_IDLE;
58 dev->iamthif_timer = 0;
59 dev->iamthif_stall_timer = 0;
60 dev->iamthif_open_count = 0;
64 * mei_amthif_host_init - mei initialization amthif client.
66 * @dev: the device structure
69 int mei_amthif_host_init(struct mei_device *dev)
71 struct mei_cl *cl = &dev->iamthif_cl;
72 unsigned char *msg_buf;
75 dev->iamthif_state = MEI_IAMTHIF_IDLE;
79 i = mei_me_cl_by_uuid(dev, &mei_amthif_guid);
82 dev_info(&dev->pdev->dev,
83 "amthif: failed to find the client %d\n", ret);
87 cl->me_client_id = dev->me_clients[i].client_id;
89 /* Assign iamthif_mtu to the value received from ME */
91 dev->iamthif_mtu = dev->me_clients[i].props.max_msg_length;
92 dev_dbg(&dev->pdev->dev, "IAMTHIF_MTU = %d\n",
93 dev->me_clients[i].props.max_msg_length);
95 kfree(dev->iamthif_msg_buf);
96 dev->iamthif_msg_buf = NULL;
98 /* allocate storage for ME message buffer */
99 msg_buf = kcalloc(dev->iamthif_mtu,
100 sizeof(unsigned char), GFP_KERNEL);
102 dev_err(&dev->pdev->dev, "amthif: memory allocation for ME message buffer failed.\n");
106 dev->iamthif_msg_buf = msg_buf;
108 ret = mei_cl_link(cl, MEI_IAMTHIF_HOST_CLIENT_ID);
111 dev_err(&dev->pdev->dev,
112 "amthif: failed link client %d\n", ret);
116 cl->state = MEI_FILE_CONNECTING;
118 ret = mei_cl_connect(cl, NULL);
120 dev->iamthif_state = MEI_IAMTHIF_IDLE;
126 * mei_amthif_find_read_list_entry - finds a amthilist entry for current file
128 * @dev: the device structure
129 * @file: pointer to file object
131 * returns returned a list entry on success, NULL on failure.
133 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
136 struct mei_cl_cb *cb;
138 list_for_each_entry(cb, &dev->amthif_rd_complete_list.list, list) {
139 if (cb->cl && cb->cl == &dev->iamthif_cl &&
140 cb->file_object == file)
148 * mei_amthif_read - read data from AMTHIF client
150 * @dev: the device structure
151 * @if_num: minor number
152 * @file: pointer to file object
153 * @*ubuf: pointer to user data in user space
154 * @length: data length to read
155 * @offset: data read offset
157 * Locking: called under "dev->device_lock" lock
160 * returned data length on success,
161 * zero if no data to read,
162 * negative on failure.
164 int mei_amthif_read(struct mei_device *dev, struct file *file,
165 char __user *ubuf, size_t length, loff_t *offset)
169 struct mei_cl_cb *cb = NULL;
170 struct mei_cl *cl = file->private_data;
171 unsigned long timeout;
174 /* Only possible if we are in timeout */
175 if (!cl || cl != &dev->iamthif_cl) {
176 dev_dbg(&dev->pdev->dev, "bad file ext.\n");
180 i = mei_me_cl_by_id(dev, dev->iamthif_cl.me_client_id);
183 dev_dbg(&dev->pdev->dev, "amthif client not found.\n");
186 dev_dbg(&dev->pdev->dev, "checking amthif data\n");
187 cb = mei_amthif_find_read_list_entry(dev, file);
189 /* Check for if we can block or not*/
190 if (cb == NULL && file->f_flags & O_NONBLOCK)
194 dev_dbg(&dev->pdev->dev, "waiting for amthif data\n");
196 /* unlock the Mutex */
197 mutex_unlock(&dev->device_lock);
199 wait_ret = wait_event_interruptible(dev->iamthif_cl.wait,
200 (cb = mei_amthif_find_read_list_entry(dev, file)));
202 /* Locking again the Mutex */
203 mutex_lock(&dev->device_lock);
208 dev_dbg(&dev->pdev->dev, "woke up from sleep\n");
212 dev_dbg(&dev->pdev->dev, "Got amthif data\n");
213 dev->iamthif_timer = 0;
216 timeout = cb->read_time +
217 mei_secs_to_jiffies(MEI_IAMTHIF_READ_TIMER);
218 dev_dbg(&dev->pdev->dev, "amthif timeout = %lud\n",
221 if (time_after(jiffies, timeout)) {
222 dev_dbg(&dev->pdev->dev, "amthif Time out\n");
223 /* 15 sec for the message has expired */
229 /* if the whole message will fit remove it from the list */
230 if (cb->buf_idx >= *offset && length >= (cb->buf_idx - *offset))
232 else if (cb->buf_idx > 0 && cb->buf_idx <= *offset) {
233 /* end of the message has been reached */
238 /* else means that not full buffer will be read and do not
239 * remove message from deletion list
242 dev_dbg(&dev->pdev->dev, "amthif cb->response_buffer size - %d\n",
243 cb->response_buffer.size);
244 dev_dbg(&dev->pdev->dev, "amthif cb->buf_idx - %lu\n", cb->buf_idx);
246 /* length is being truncated to PAGE_SIZE, however,
247 * the buf_idx may point beyond */
248 length = min_t(size_t, length, (cb->buf_idx - *offset));
250 if (copy_to_user(ubuf, cb->response_buffer.data + *offset, length))
254 if ((*offset + length) < cb->buf_idx) {
260 dev_dbg(&dev->pdev->dev, "free amthif cb memory.\n");
268 * mei_amthif_send_cmd - send amthif command to the ME
270 * @dev: the device structure
271 * @cb: mei call back struct
273 * returns 0 on success, <0 on failure.
276 static int mei_amthif_send_cmd(struct mei_device *dev, struct mei_cl_cb *cb)
278 struct mei_msg_hdr mei_hdr;
284 dev_dbg(&dev->pdev->dev, "write data to amthif client.\n");
286 dev->iamthif_state = MEI_IAMTHIF_WRITING;
287 dev->iamthif_current_cb = cb;
288 dev->iamthif_file_object = cb->file_object;
289 dev->iamthif_canceled = false;
290 dev->iamthif_ioctl = true;
291 dev->iamthif_msg_buf_size = cb->request_buffer.size;
292 memcpy(dev->iamthif_msg_buf, cb->request_buffer.data,
293 cb->request_buffer.size);
295 ret = mei_cl_flow_ctrl_creds(&dev->iamthif_cl);
299 if (ret && dev->hbuf_is_ready) {
301 dev->hbuf_is_ready = false;
302 if (cb->request_buffer.size > mei_hbuf_max_len(dev)) {
303 mei_hdr.length = mei_hbuf_max_len(dev);
304 mei_hdr.msg_complete = 0;
306 mei_hdr.length = cb->request_buffer.size;
307 mei_hdr.msg_complete = 1;
310 mei_hdr.host_addr = dev->iamthif_cl.host_client_id;
311 mei_hdr.me_addr = dev->iamthif_cl.me_client_id;
312 mei_hdr.reserved = 0;
313 mei_hdr.internal = 0;
314 dev->iamthif_msg_buf_index += mei_hdr.length;
315 ret = mei_write_message(dev, &mei_hdr, 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_WRITE;
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;
422 poll_wait(file, &dev->iamthif_cl.wait, wait);
424 mutex_lock(&dev->device_lock);
425 if (!mei_cl_is_connected(&dev->iamthif_cl)) {
429 } else if (dev->iamthif_state == MEI_IAMTHIF_READ_COMPLETE &&
430 dev->iamthif_file_object == file) {
432 mask |= (POLLIN | POLLRDNORM);
433 dev_dbg(&dev->pdev->dev, "run next amthif cb\n");
434 mei_amthif_run_next_cmd(dev);
436 mutex_unlock(&dev->device_lock);
444 * mei_amthif_irq_write_completed - processes completed iamthif operation.
446 * @dev: the device structure.
447 * @slots: free slots.
448 * @cb_pos: callback block.
449 * @cl: private data of the file object.
450 * @cmpl_list: complete list.
452 * returns 0, OK; otherwise, error.
454 int mei_amthif_irq_write_complete(struct mei_cl *cl, struct mei_cl_cb *cb,
455 s32 *slots, struct mei_cl_cb *cmpl_list)
457 struct mei_device *dev = cl->dev;
458 struct mei_msg_hdr mei_hdr;
459 size_t len = dev->iamthif_msg_buf_size - dev->iamthif_msg_buf_index;
460 u32 msg_slots = mei_data2slots(len);
463 rets = mei_cl_flow_ctrl_creds(cl);
468 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
472 mei_hdr.host_addr = cl->host_client_id;
473 mei_hdr.me_addr = cl->me_client_id;
474 mei_hdr.reserved = 0;
475 mei_hdr.internal = 0;
477 if (*slots >= msg_slots) {
478 mei_hdr.length = len;
479 mei_hdr.msg_complete = 1;
480 /* Split the message only if we can write the whole host buffer */
481 } else if (*slots == dev->hbuf_depth) {
483 len = (*slots * sizeof(u32)) - sizeof(struct mei_msg_hdr);
484 mei_hdr.length = len;
485 mei_hdr.msg_complete = 0;
487 /* wait for next time the host buffer is empty */
491 dev_dbg(&dev->pdev->dev, MEI_HDR_FMT, MEI_HDR_PRM(&mei_hdr));
494 rets = mei_write_message(dev, &mei_hdr,
495 dev->iamthif_msg_buf + dev->iamthif_msg_buf_index);
497 dev->iamthif_state = MEI_IAMTHIF_IDLE;
503 if (mei_cl_flow_ctrl_reduce(cl))
506 dev->iamthif_msg_buf_index += mei_hdr.length;
509 if (mei_hdr.msg_complete) {
510 dev->iamthif_state = MEI_IAMTHIF_FLOW_CONTROL;
511 dev->iamthif_flow_control_pending = true;
513 /* save iamthif cb sent to amthif client */
514 cb->buf_idx = dev->iamthif_msg_buf_index;
515 dev->iamthif_current_cb = cb;
517 list_move_tail(&cb->list, &dev->write_waiting_list.list);
525 * mei_amthif_irq_read_message - read routine after ISR to
526 * handle the read amthif message
528 * @dev: the device structure
529 * @mei_hdr: header of amthif message
530 * @complete_list: An instance of our list structure
532 * returns 0 on success, <0 on failure.
534 int mei_amthif_irq_read_msg(struct mei_device *dev,
535 struct mei_msg_hdr *mei_hdr,
536 struct mei_cl_cb *complete_list)
538 struct mei_cl_cb *cb;
539 unsigned char *buffer;
541 BUG_ON(mei_hdr->me_addr != dev->iamthif_cl.me_client_id);
542 BUG_ON(dev->iamthif_state != MEI_IAMTHIF_READING);
544 buffer = dev->iamthif_msg_buf + dev->iamthif_msg_buf_index;
545 BUG_ON(dev->iamthif_mtu < dev->iamthif_msg_buf_index + mei_hdr->length);
547 mei_read_slots(dev, buffer, mei_hdr->length);
549 dev->iamthif_msg_buf_index += mei_hdr->length;
551 if (!mei_hdr->msg_complete)
554 dev_dbg(&dev->pdev->dev, "amthif_message_buffer_index =%d\n",
557 dev_dbg(&dev->pdev->dev, "completed amthif read.\n ");
558 if (!dev->iamthif_current_cb)
561 cb = dev->iamthif_current_cb;
562 dev->iamthif_current_cb = NULL;
567 dev->iamthif_stall_timer = 0;
568 cb->buf_idx = dev->iamthif_msg_buf_index;
569 cb->read_time = jiffies;
570 if (dev->iamthif_ioctl && cb->cl == &dev->iamthif_cl) {
571 /* found the iamthif cb */
572 dev_dbg(&dev->pdev->dev, "complete the amthif read cb.\n ");
573 dev_dbg(&dev->pdev->dev, "add the amthif read cb to complete.\n ");
574 list_add_tail(&cb->list, &complete_list->list);
580 * mei_amthif_irq_read - prepares to read amthif data.
582 * @dev: the device structure.
583 * @slots: free slots.
585 * returns 0, OK; otherwise, error.
587 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots)
589 u32 msg_slots = mei_data2slots(sizeof(struct hbm_flow_control));
591 if (*slots < msg_slots)
596 if (mei_hbm_cl_flow_control_req(dev, &dev->iamthif_cl)) {
597 dev_dbg(&dev->pdev->dev, "iamthif flow control failed\n");
601 dev_dbg(&dev->pdev->dev, "iamthif flow control success\n");
602 dev->iamthif_state = MEI_IAMTHIF_READING;
603 dev->iamthif_flow_control_pending = false;
604 dev->iamthif_msg_buf_index = 0;
605 dev->iamthif_msg_buf_size = 0;
606 dev->iamthif_stall_timer = MEI_IAMTHIF_STALL_TIMER;
607 dev->hbuf_is_ready = mei_hbuf_is_ready(dev);
612 * mei_amthif_complete - complete amthif callback.
614 * @dev: the device structure.
615 * @cb_pos: callback block.
617 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb)
619 if (dev->iamthif_canceled != 1) {
620 dev->iamthif_state = MEI_IAMTHIF_READ_COMPLETE;
621 dev->iamthif_stall_timer = 0;
622 memcpy(cb->response_buffer.data,
623 dev->iamthif_msg_buf,
624 dev->iamthif_msg_buf_index);
625 list_add_tail(&cb->list, &dev->amthif_rd_complete_list.list);
626 dev_dbg(&dev->pdev->dev, "amthif read completed\n");
627 dev->iamthif_timer = jiffies;
628 dev_dbg(&dev->pdev->dev, "dev->iamthif_timer = %ld\n",
631 mei_amthif_run_next_cmd(dev);
634 dev_dbg(&dev->pdev->dev, "completing amthif call back.\n");
635 wake_up_interruptible(&dev->iamthif_cl.wait);
639 * mei_clear_list - removes all callbacks associated with file
642 * @dev: device structure.
643 * @file: file structure
644 * @mei_cb_list: callbacks list
646 * mei_clear_list is called to clear resources associated with file
647 * when application calls close function or Ctrl-C was pressed
649 * returns true if callback removed from the list, false otherwise
651 static bool mei_clear_list(struct mei_device *dev,
652 const struct file *file, struct list_head *mei_cb_list)
654 struct mei_cl_cb *cb_pos = NULL;
655 struct mei_cl_cb *cb_next = NULL;
656 bool removed = false;
658 /* list all list member */
659 list_for_each_entry_safe(cb_pos, cb_next, mei_cb_list, list) {
660 /* check if list member associated with a file */
661 if (file == cb_pos->file_object) {
662 /* remove member from the list */
663 list_del(&cb_pos->list);
664 /* check if cb equal to current iamthif cb */
665 if (dev->iamthif_current_cb == cb_pos) {
666 dev->iamthif_current_cb = NULL;
667 /* send flow control to iamthif client */
668 mei_hbm_cl_flow_control_req(dev,
671 /* free all allocated buffers */
672 mei_io_cb_free(cb_pos);
681 * mei_clear_lists - removes all callbacks associated with file
683 * @dev: device structure
684 * @file: file structure
686 * mei_clear_lists is called to clear resources associated with file
687 * when application calls close function or Ctrl-C was pressed
689 * returns true if callback removed from the list, false otherwise
691 static bool mei_clear_lists(struct mei_device *dev, struct file *file)
693 bool removed = false;
695 /* remove callbacks associated with a file */
696 mei_clear_list(dev, file, &dev->amthif_cmd_list.list);
697 if (mei_clear_list(dev, file, &dev->amthif_rd_complete_list.list))
700 mei_clear_list(dev, file, &dev->ctrl_rd_list.list);
702 if (mei_clear_list(dev, file, &dev->ctrl_wr_list.list))
705 if (mei_clear_list(dev, file, &dev->write_waiting_list.list))
708 if (mei_clear_list(dev, file, &dev->write_list.list))
711 /* check if iamthif_current_cb not NULL */
712 if (dev->iamthif_current_cb && !removed) {
713 /* check file and iamthif current cb association */
714 if (dev->iamthif_current_cb->file_object == file) {
716 mei_io_cb_free(dev->iamthif_current_cb);
717 dev->iamthif_current_cb = NULL;
725 * mei_amthif_release - the release function
727 * @dev: device structure
728 * @file: pointer to file structure
730 * returns 0 on success, <0 on error
732 int mei_amthif_release(struct mei_device *dev, struct file *file)
734 if (dev->iamthif_open_count > 0)
735 dev->iamthif_open_count--;
737 if (dev->iamthif_file_object == file &&
738 dev->iamthif_state != MEI_IAMTHIF_IDLE) {
740 dev_dbg(&dev->pdev->dev, "amthif canceled iamthif state %d\n",
742 dev->iamthif_canceled = true;
743 if (dev->iamthif_state == MEI_IAMTHIF_READ_COMPLETE) {
744 dev_dbg(&dev->pdev->dev, "run next amthif iamthif cb\n");
745 mei_amthif_run_next_cmd(dev);
749 if (mei_clear_lists(dev, file))
750 dev->iamthif_state = MEI_IAMTHIF_IDLE;