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
18 #include <linux/export.h>
19 #include <linux/pci.h>
20 #include <linux/kthread.h>
21 #include <linux/interrupt.h>
23 #include <linux/jiffies.h>
25 #include <linux/mei.h>
34 * mei_irq_compl_handler - dispatch complete handlers
35 * for the completed callbacks
38 * @compl_list - list of completed cbs
40 void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *compl_list)
42 struct mei_cl_cb *cb, *next;
45 list_for_each_entry_safe(cb, next, &compl_list->list, list) {
51 dev_dbg(&dev->pdev->dev, "completing call back.\n");
52 if (cl == &dev->iamthif_cl)
53 mei_amthif_complete(dev, cb);
55 mei_cl_complete(cl, cb);
58 EXPORT_SYMBOL_GPL(mei_irq_compl_handler);
61 * mei_cl_hbm_equal - check if hbm is addressed to the client
64 * @mei_hdr: header of mei client message
66 * returns true if matches, false otherwise
68 static inline int mei_cl_hbm_equal(struct mei_cl *cl,
69 struct mei_msg_hdr *mei_hdr)
71 return cl->host_client_id == mei_hdr->host_addr &&
72 cl->me_client_id == mei_hdr->me_addr;
75 * mei_cl_is_reading - checks if the client
76 is the one to read this message
79 * @mei_hdr: header of mei message
81 * returns true on match and false otherwise
83 static bool mei_cl_is_reading(struct mei_cl *cl, struct mei_msg_hdr *mei_hdr)
85 return mei_cl_hbm_equal(cl, mei_hdr) &&
86 cl->state == MEI_FILE_CONNECTED &&
87 cl->reading_state != MEI_READ_COMPLETE;
91 * mei_irq_read_client_message - process client message
93 * @dev: the device structure
94 * @mei_hdr: header of mei client message
95 * @complete_list: An instance of our list structure
97 * returns 0 on success, <0 on failure.
99 static int mei_cl_irq_read_msg(struct mei_device *dev,
100 struct mei_msg_hdr *mei_hdr,
101 struct mei_cl_cb *complete_list)
104 struct mei_cl_cb *cb, *next;
105 unsigned char *buffer = NULL;
107 list_for_each_entry_safe(cb, next, &dev->read_list.list, list) {
109 if (!cl || !mei_cl_is_reading(cl, mei_hdr))
112 cl->reading_state = MEI_READING;
114 if (cb->response_buffer.size == 0 ||
115 cb->response_buffer.data == NULL) {
116 cl_err(dev, cl, "response buffer is not allocated.\n");
121 if (cb->response_buffer.size < mei_hdr->length + cb->buf_idx) {
122 cl_dbg(dev, cl, "message overflow. size %d len %d idx %ld\n",
123 cb->response_buffer.size,
124 mei_hdr->length, cb->buf_idx);
125 buffer = krealloc(cb->response_buffer.data,
126 mei_hdr->length + cb->buf_idx,
130 cl_err(dev, cl, "allocation failed.\n");
134 cb->response_buffer.data = buffer;
135 cb->response_buffer.size =
136 mei_hdr->length + cb->buf_idx;
139 buffer = cb->response_buffer.data + cb->buf_idx;
140 mei_read_slots(dev, buffer, mei_hdr->length);
142 cb->buf_idx += mei_hdr->length;
143 if (mei_hdr->msg_complete) {
146 cl_dbg(dev, cl, "completed read length = %lu\n",
148 list_add_tail(&cb->list, &complete_list->list);
153 dev_dbg(&dev->pdev->dev, "message read\n");
155 mei_read_slots(dev, dev->rd_msg_buf, mei_hdr->length);
156 dev_dbg(&dev->pdev->dev, "discarding message " MEI_HDR_FMT "\n",
157 MEI_HDR_PRM(mei_hdr));
164 * mei_cl_irq_disconnect_rsp - send disconnection response message
167 * @cb: callback block.
168 * @slots: free slots.
169 * @cmpl_list: complete list.
171 * returns 0, OK; otherwise, error.
173 static int mei_cl_irq_disconnect_rsp(struct mei_cl *cl, struct mei_cl_cb *cb,
174 s32 *slots, struct mei_cl_cb *cmpl_list)
176 struct mei_device *dev = cl->dev;
180 mei_data2slots(sizeof(struct hbm_client_connect_response));
182 if (*slots < msg_slots)
187 ret = mei_hbm_cl_disconnect_rsp(dev, cl);
189 cl->state = MEI_FILE_DISCONNECTED;
199 * mei_cl_irq_close - processes close related operation from
200 * interrupt thread context - send disconnect request
203 * @cb: callback block.
204 * @slots: free slots.
205 * @cmpl_list: complete list.
207 * returns 0, OK; otherwise, error.
209 static int mei_cl_irq_close(struct mei_cl *cl, struct mei_cl_cb *cb,
210 s32 *slots, struct mei_cl_cb *cmpl_list)
212 struct mei_device *dev = cl->dev;
215 mei_data2slots(sizeof(struct hbm_client_connect_request));
217 if (*slots < msg_slots)
222 if (mei_hbm_cl_disconnect_req(dev, cl)) {
225 list_move_tail(&cb->list, &cmpl_list->list);
229 cl->state = MEI_FILE_DISCONNECTING;
232 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
233 cl->timer_count = MEI_CONNECT_TIMEOUT;
240 * mei_cl_irq_close - processes client read related operation from the
241 * interrupt thread context - request for flow control credits
244 * @cb: callback block.
245 * @slots: free slots.
246 * @cmpl_list: complete list.
248 * returns 0, OK; otherwise, error.
250 static int mei_cl_irq_read(struct mei_cl *cl, struct mei_cl_cb *cb,
251 s32 *slots, struct mei_cl_cb *cmpl_list)
253 struct mei_device *dev = cl->dev;
254 u32 msg_slots = mei_data2slots(sizeof(struct hbm_flow_control));
259 if (*slots < msg_slots) {
260 /* return the cancel routine */
267 ret = mei_hbm_cl_flow_control_req(dev, cl);
271 list_move_tail(&cb->list, &cmpl_list->list);
275 list_move_tail(&cb->list, &dev->read_list.list);
282 * mei_cl_irq_connect - send connect request in irq_thread context
285 * @cb: callback block.
286 * @slots: free slots.
287 * @cmpl_list: complete list.
289 * returns 0, OK; otherwise, error.
291 static int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
292 s32 *slots, struct mei_cl_cb *cmpl_list)
294 struct mei_device *dev = cl->dev;
298 mei_data2slots(sizeof(struct hbm_client_connect_request));
300 if (mei_cl_is_other_connecting(cl))
303 if (*slots < msg_slots) {
304 /* return the cancel routine */
311 cl->state = MEI_FILE_CONNECTING;
313 ret = mei_hbm_cl_connect_req(dev, cl);
321 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
322 cl->timer_count = MEI_CONNECT_TIMEOUT;
328 * mei_irq_read_handler - bottom half read routine after ISR to
329 * handle the read processing.
331 * @dev: the device structure
332 * @cmpl_list: An instance of our list structure
333 * @slots: slots to read.
335 * returns 0 on success, <0 on failure.
337 int mei_irq_read_handler(struct mei_device *dev,
338 struct mei_cl_cb *cmpl_list, s32 *slots)
340 struct mei_msg_hdr *mei_hdr;
344 if (!dev->rd_msg_hdr) {
345 dev->rd_msg_hdr = mei_read_hdr(dev);
347 dev_dbg(&dev->pdev->dev, "slots =%08x.\n", *slots);
349 mei_hdr = (struct mei_msg_hdr *) &dev->rd_msg_hdr;
350 dev_dbg(&dev->pdev->dev, MEI_HDR_FMT, MEI_HDR_PRM(mei_hdr));
352 if (mei_hdr->reserved || !dev->rd_msg_hdr) {
353 dev_err(&dev->pdev->dev, "corrupted message header 0x%08X\n",
359 if (mei_slots2data(*slots) < mei_hdr->length) {
360 dev_err(&dev->pdev->dev, "less data available than length=%08x.\n",
362 /* we can't read the message */
368 if (mei_hdr->host_addr == 0 && mei_hdr->me_addr == 0) {
369 ret = mei_hbm_dispatch(dev, mei_hdr);
371 dev_dbg(&dev->pdev->dev, "mei_hbm_dispatch failed ret = %d\n",
378 /* find recipient cl */
379 list_for_each_entry(cl, &dev->file_list, link) {
380 if (mei_cl_hbm_equal(cl, mei_hdr)) {
381 cl_dbg(dev, cl, "got a message\n");
386 /* if no recipient cl was found we assume corrupted header */
387 if (&cl->link == &dev->file_list) {
388 dev_err(&dev->pdev->dev, "no destination client found 0x%08X\n",
394 if (mei_hdr->host_addr == dev->iamthif_cl.host_client_id &&
395 MEI_FILE_CONNECTED == dev->iamthif_cl.state &&
396 dev->iamthif_state == MEI_IAMTHIF_READING) {
398 ret = mei_amthif_irq_read_msg(dev, mei_hdr, cmpl_list);
400 dev_err(&dev->pdev->dev, "mei_amthif_irq_read_msg failed = %d\n",
405 ret = mei_cl_irq_read_msg(dev, mei_hdr, cmpl_list);
407 dev_err(&dev->pdev->dev, "mei_cl_irq_read_msg failed = %d\n",
414 /* reset the number of slots and header */
415 *slots = mei_count_full_read_slots(dev);
418 if (*slots == -EOVERFLOW) {
419 /* overflow - reset */
420 dev_err(&dev->pdev->dev, "resetting due to slots overflow.\n");
421 /* set the event since message has been read */
428 EXPORT_SYMBOL_GPL(mei_irq_read_handler);
432 * mei_irq_write_handler - dispatch write requests
435 * @dev: the device structure
436 * @cmpl_list: An instance of our list structure
438 * returns 0 on success, <0 on failure.
440 int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list)
444 struct mei_cl_cb *cb, *next;
445 struct mei_cl_cb *list;
450 if (!mei_hbuf_acquire(dev))
453 slots = mei_hbuf_empty_slots(dev);
457 /* complete all waiting for write CB */
458 dev_dbg(&dev->pdev->dev, "complete all waiting for write cb.\n");
460 list = &dev->write_waiting_list;
461 list_for_each_entry_safe(cb, next, &list->list, list) {
468 if (MEI_WRITING == cl->writing_state &&
469 cb->fop_type == MEI_FOP_WRITE &&
470 cl != &dev->iamthif_cl) {
471 cl_dbg(dev, cl, "MEI WRITE COMPLETE\n");
472 cl->writing_state = MEI_WRITE_COMPLETE;
473 list_add_tail(&cb->list, &cmpl_list->list);
475 if (cl == &dev->iamthif_cl) {
476 cl_dbg(dev, cl, "check iamthif flow control.\n");
477 if (dev->iamthif_flow_control_pending) {
478 ret = mei_amthif_irq_read(dev, &slots);
485 if (dev->wd_state == MEI_WD_STOPPING) {
486 dev->wd_state = MEI_WD_IDLE;
487 wake_up_interruptible(&dev->wait_stop_wd);
490 if (mei_cl_is_connected(&dev->wd_cl)) {
491 if (dev->wd_pending &&
492 mei_cl_flow_ctrl_creds(&dev->wd_cl) > 0) {
493 if (mei_wd_send(dev))
494 dev_dbg(&dev->pdev->dev, "wd send failed.\n");
495 else if (mei_cl_flow_ctrl_reduce(&dev->wd_cl))
498 dev->wd_pending = false;
500 if (dev->wd_state == MEI_WD_RUNNING)
501 slots -= mei_data2slots(MEI_WD_START_MSG_SIZE);
503 slots -= mei_data2slots(MEI_WD_STOP_MSG_SIZE);
507 /* complete control write list CB */
508 dev_dbg(&dev->pdev->dev, "complete control write list cb.\n");
509 list_for_each_entry_safe(cb, next, &dev->ctrl_wr_list.list, list) {
515 switch (cb->fop_type) {
517 /* send disconnect message */
518 ret = mei_cl_irq_close(cl, cb, &slots, cmpl_list);
524 /* send flow control message */
525 ret = mei_cl_irq_read(cl, cb, &slots, cmpl_list);
530 case MEI_FOP_CONNECT:
531 /* connect message */
532 ret = mei_cl_irq_connect(cl, cb, &slots, cmpl_list);
537 case MEI_FOP_DISCONNECT_RSP:
538 /* send disconnect resp */
539 ret = mei_cl_irq_disconnect_rsp(cl, cb, &slots, cmpl_list);
547 /* complete write list CB */
548 dev_dbg(&dev->pdev->dev, "complete write list cb.\n");
549 list_for_each_entry_safe(cb, next, &dev->write_list.list, list) {
553 if (cl == &dev->iamthif_cl)
554 ret = mei_amthif_irq_write_complete(cl, cb,
557 ret = mei_cl_irq_write_complete(cl, cb,
564 EXPORT_SYMBOL_GPL(mei_irq_write_handler);
569 * mei_timer - timer function.
571 * @work: pointer to the work_struct structure
574 void mei_timer(struct work_struct *work)
576 unsigned long timeout;
578 struct mei_cl_cb *cb_pos = NULL;
579 struct mei_cl_cb *cb_next = NULL;
581 struct mei_device *dev = container_of(work,
582 struct mei_device, timer_work.work);
585 mutex_lock(&dev->device_lock);
587 /* Catch interrupt stalls during HBM init handshake */
588 if (dev->dev_state == MEI_DEV_INIT_CLIENTS &&
589 dev->hbm_state != MEI_HBM_IDLE) {
591 if (dev->init_clients_timer) {
592 if (--dev->init_clients_timer == 0) {
593 dev_err(&dev->pdev->dev, "timer: init clients timeout hbm_state = %d.\n",
601 if (dev->dev_state != MEI_DEV_ENABLED)
604 /*** connect/disconnect timeouts ***/
605 list_for_each_entry(cl, &dev->file_list, link) {
606 if (cl->timer_count) {
607 if (--cl->timer_count == 0) {
608 dev_err(&dev->pdev->dev, "timer: connect/disconnect timeout.\n");
615 if (!mei_cl_is_connected(&dev->iamthif_cl))
618 if (dev->iamthif_stall_timer) {
619 if (--dev->iamthif_stall_timer == 0) {
620 dev_err(&dev->pdev->dev, "timer: amthif hanged.\n");
622 dev->iamthif_msg_buf_size = 0;
623 dev->iamthif_msg_buf_index = 0;
624 dev->iamthif_canceled = false;
625 dev->iamthif_ioctl = true;
626 dev->iamthif_state = MEI_IAMTHIF_IDLE;
627 dev->iamthif_timer = 0;
629 mei_io_cb_free(dev->iamthif_current_cb);
630 dev->iamthif_current_cb = NULL;
632 dev->iamthif_file_object = NULL;
633 mei_amthif_run_next_cmd(dev);
637 if (dev->iamthif_timer) {
639 timeout = dev->iamthif_timer +
640 mei_secs_to_jiffies(MEI_IAMTHIF_READ_TIMER);
642 dev_dbg(&dev->pdev->dev, "dev->iamthif_timer = %ld\n",
644 dev_dbg(&dev->pdev->dev, "timeout = %ld\n", timeout);
645 dev_dbg(&dev->pdev->dev, "jiffies = %ld\n", jiffies);
646 if (time_after(jiffies, timeout)) {
648 * User didn't read the AMTHI data on time (15sec)
649 * freeing AMTHI for other requests
652 dev_dbg(&dev->pdev->dev, "freeing AMTHI for other requests\n");
654 list_for_each_entry_safe(cb_pos, cb_next,
655 &dev->amthif_rd_complete_list.list, list) {
657 cl = cb_pos->file_object->private_data;
659 /* Finding the AMTHI entry. */
660 if (cl == &dev->iamthif_cl)
661 list_del(&cb_pos->list);
663 mei_io_cb_free(dev->iamthif_current_cb);
664 dev->iamthif_current_cb = NULL;
666 dev->iamthif_file_object->private_data = NULL;
667 dev->iamthif_file_object = NULL;
668 dev->iamthif_timer = 0;
669 mei_amthif_run_next_cmd(dev);
674 if (dev->dev_state != MEI_DEV_DISABLED)
675 schedule_delayed_work(&dev->timer_work, 2 * HZ);
676 mutex_unlock(&dev->device_lock);