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 handelers
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 dev_err(&dev
->pdev
->dev
, "response buffer is not allocated.\n");
121 if (cb
->response_buffer
.size
< mei_hdr
->length
+ cb
->buf_idx
) {
122 dev_dbg(&dev
->pdev
->dev
, "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 dev_err(&dev
->pdev
->dev
, "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 dev_dbg(&dev
->pdev
->dev
, "completed read H cl = %d, ME cl = %d, length = %lu\n",
150 list_add_tail(&cb
->list
, &complete_list
->list
);
155 dev_dbg(&dev
->pdev
->dev
, "message read\n");
157 mei_read_slots(dev
, dev
->rd_msg_buf
, mei_hdr
->length
);
158 dev_dbg(&dev
->pdev
->dev
, "discarding message " MEI_HDR_FMT
"\n",
159 MEI_HDR_PRM(mei_hdr
));
166 * mei_cl_irq_close - processes close related operation from
167 * interrupt thread context - send disconnect request
170 * @cb: callback block.
171 * @slots: free slots.
172 * @cmpl_list: complete list.
174 * returns 0, OK; otherwise, error.
176 static int mei_cl_irq_close(struct mei_cl
*cl
, struct mei_cl_cb
*cb
,
177 s32
*slots
, struct mei_cl_cb
*cmpl_list
)
179 struct mei_device
*dev
= cl
->dev
;
182 mei_data2slots(sizeof(struct hbm_client_connect_request
));
184 if (*slots
< msg_slots
)
189 if (mei_hbm_cl_disconnect_req(dev
, cl
)) {
192 list_move_tail(&cb
->list
, &cmpl_list
->list
);
196 cl
->state
= MEI_FILE_DISCONNECTING
;
199 list_move_tail(&cb
->list
, &dev
->ctrl_rd_list
.list
);
200 cl
->timer_count
= MEI_CONNECT_TIMEOUT
;
207 * mei_cl_irq_close - processes client read related operation from the
208 * interrupt thread context - request for flow control credits
211 * @cb: callback block.
212 * @slots: free slots.
213 * @cmpl_list: complete list.
215 * returns 0, OK; otherwise, error.
217 static int mei_cl_irq_read(struct mei_cl
*cl
, struct mei_cl_cb
*cb
,
218 s32
*slots
, struct mei_cl_cb
*cmpl_list
)
220 struct mei_device
*dev
= cl
->dev
;
222 u32 msg_slots
= mei_data2slots(sizeof(struct hbm_flow_control
));
224 if (*slots
< msg_slots
) {
225 /* return the cancel routine */
232 if (mei_hbm_cl_flow_control_req(dev
, cl
)) {
233 cl
->status
= -ENODEV
;
235 list_move_tail(&cb
->list
, &cmpl_list
->list
);
238 list_move_tail(&cb
->list
, &dev
->read_list
.list
);
245 * mei_cl_irq_ioctl - processes client ioctl related operation from the
246 * interrupt thread context - send connection request
249 * @cb: callback block.
250 * @slots: free slots.
251 * @cmpl_list: complete list.
253 * returns 0, OK; otherwise, error.
255 static int mei_cl_irq_ioctl(struct mei_cl
*cl
, struct mei_cl_cb
*cb
,
256 s32
*slots
, struct mei_cl_cb
*cmpl_list
)
258 struct mei_device
*dev
= cl
->dev
;
261 mei_data2slots(sizeof(struct hbm_client_connect_request
));
263 if (*slots
< msg_slots
) {
264 /* return the cancel routine */
271 cl
->state
= MEI_FILE_CONNECTING
;
273 if (mei_hbm_cl_connect_req(dev
, cl
)) {
274 cl
->status
= -ENODEV
;
280 list_move_tail(&cb
->list
, &dev
->ctrl_rd_list
.list
);
281 cl
->timer_count
= MEI_CONNECT_TIMEOUT
;
287 * mei_irq_read_handler - bottom half read routine after ISR to
288 * handle the read processing.
290 * @dev: the device structure
291 * @cmpl_list: An instance of our list structure
292 * @slots: slots to read.
294 * returns 0 on success, <0 on failure.
296 int mei_irq_read_handler(struct mei_device
*dev
,
297 struct mei_cl_cb
*cmpl_list
, s32
*slots
)
299 struct mei_msg_hdr
*mei_hdr
;
300 struct mei_cl
*cl_pos
= NULL
;
301 struct mei_cl
*cl_next
= NULL
;
304 if (!dev
->rd_msg_hdr
) {
305 dev
->rd_msg_hdr
= mei_read_hdr(dev
);
306 dev_dbg(&dev
->pdev
->dev
, "slots =%08x.\n", *slots
);
308 dev_dbg(&dev
->pdev
->dev
, "slots =%08x.\n", *slots
);
310 mei_hdr
= (struct mei_msg_hdr
*) &dev
->rd_msg_hdr
;
311 dev_dbg(&dev
->pdev
->dev
, MEI_HDR_FMT
, MEI_HDR_PRM(mei_hdr
));
313 if (mei_hdr
->reserved
|| !dev
->rd_msg_hdr
) {
314 dev_dbg(&dev
->pdev
->dev
, "corrupted message header.\n");
319 if (mei_hdr
->host_addr
|| mei_hdr
->me_addr
) {
320 list_for_each_entry_safe(cl_pos
, cl_next
,
321 &dev
->file_list
, link
) {
322 dev_dbg(&dev
->pdev
->dev
,
323 "list_for_each_entry_safe read host"
324 " client = %d, ME client = %d\n",
325 cl_pos
->host_client_id
,
326 cl_pos
->me_client_id
);
327 if (mei_cl_hbm_equal(cl_pos
, mei_hdr
))
331 if (&cl_pos
->link
== &dev
->file_list
) {
332 dev_dbg(&dev
->pdev
->dev
, "corrupted message header\n");
337 if (((*slots
) * sizeof(u32
)) < mei_hdr
->length
) {
338 dev_err(&dev
->pdev
->dev
,
339 "we can't read the message slots =%08x.\n",
341 /* we can't read the message */
346 /* decide where to read the message too */
347 if (!mei_hdr
->host_addr
) {
348 dev_dbg(&dev
->pdev
->dev
, "call mei_irq_thread_read_bus_message.\n");
349 mei_hbm_dispatch(dev
, mei_hdr
);
350 dev_dbg(&dev
->pdev
->dev
, "end mei_irq_thread_read_bus_message.\n");
351 } else if (mei_hdr
->host_addr
== dev
->iamthif_cl
.host_client_id
&&
352 (MEI_FILE_CONNECTED
== dev
->iamthif_cl
.state
) &&
353 (dev
->iamthif_state
== MEI_IAMTHIF_READING
)) {
355 dev_dbg(&dev
->pdev
->dev
, "call mei_irq_thread_read_iamthif_message.\n");
356 dev_dbg(&dev
->pdev
->dev
, MEI_HDR_FMT
, MEI_HDR_PRM(mei_hdr
));
358 ret
= mei_amthif_irq_read_msg(dev
, mei_hdr
, cmpl_list
);
362 dev_dbg(&dev
->pdev
->dev
, "call mei_cl_irq_read_msg.\n");
363 dev_dbg(&dev
->pdev
->dev
, MEI_HDR_FMT
, MEI_HDR_PRM(mei_hdr
));
364 ret
= mei_cl_irq_read_msg(dev
, mei_hdr
, cmpl_list
);
369 /* reset the number of slots and header */
370 *slots
= mei_count_full_read_slots(dev
);
373 if (*slots
== -EOVERFLOW
) {
374 /* overflow - reset */
375 dev_err(&dev
->pdev
->dev
, "resetting due to slots overflow.\n");
376 /* set the event since message has been read */
383 EXPORT_SYMBOL_GPL(mei_irq_read_handler
);
387 * mei_irq_write_handler - dispatch write requests
390 * @dev: the device structure
391 * @cmpl_list: An instance of our list structure
393 * returns 0 on success, <0 on failure.
395 int mei_irq_write_handler(struct mei_device
*dev
, struct mei_cl_cb
*cmpl_list
)
399 struct mei_cl_cb
*cb
, *next
;
400 struct mei_cl_cb
*list
;
404 if (!mei_hbuf_is_ready(dev
)) {
405 dev_dbg(&dev
->pdev
->dev
, "host buffer is not empty.\n");
408 slots
= mei_hbuf_empty_slots(dev
);
412 /* complete all waiting for write CB */
413 dev_dbg(&dev
->pdev
->dev
, "complete all waiting for write cb.\n");
415 list
= &dev
->write_waiting_list
;
416 list_for_each_entry_safe(cb
, next
, &list
->list
, list
) {
423 if (cb
->fop_type
== MEI_FOP_WRITE
&&
424 cl
!= &dev
->iamthif_cl
) {
425 dev_dbg(&dev
->pdev
->dev
, "MEI WRITE COMPLETE\n");
426 cl
->writing_state
= MEI_WRITE_COMPLETE
;
427 list_add_tail(&cb
->list
, &cmpl_list
->list
);
429 if (cl
== &dev
->iamthif_cl
) {
430 dev_dbg(&dev
->pdev
->dev
, "check iamthif flow control.\n");
431 if (dev
->iamthif_flow_control_pending
) {
432 ret
= mei_amthif_irq_read(dev
, &slots
);
439 if (dev
->wd_state
== MEI_WD_STOPPING
) {
440 dev
->wd_state
= MEI_WD_IDLE
;
441 wake_up_interruptible(&dev
->wait_stop_wd
);
444 if (dev
->wr_ext_msg
.hdr
.length
) {
445 mei_write_message(dev
, &dev
->wr_ext_msg
.hdr
,
446 dev
->wr_ext_msg
.data
);
447 slots
-= mei_data2slots(dev
->wr_ext_msg
.hdr
.length
);
448 dev
->wr_ext_msg
.hdr
.length
= 0;
450 if (dev
->dev_state
== MEI_DEV_ENABLED
) {
451 if (dev
->wd_pending
&&
452 mei_cl_flow_ctrl_creds(&dev
->wd_cl
) > 0) {
453 if (mei_wd_send(dev
))
454 dev_dbg(&dev
->pdev
->dev
, "wd send failed.\n");
455 else if (mei_cl_flow_ctrl_reduce(&dev
->wd_cl
))
458 dev
->wd_pending
= false;
460 if (dev
->wd_state
== MEI_WD_RUNNING
)
461 slots
-= mei_data2slots(MEI_WD_START_MSG_SIZE
);
463 slots
-= mei_data2slots(MEI_WD_STOP_MSG_SIZE
);
467 /* complete control write list CB */
468 dev_dbg(&dev
->pdev
->dev
, "complete control write list cb.\n");
469 list_for_each_entry_safe(cb
, next
, &dev
->ctrl_wr_list
.list
, list
) {
475 switch (cb
->fop_type
) {
477 /* send disconnect message */
478 ret
= mei_cl_irq_close(cl
, cb
, &slots
, cmpl_list
);
484 /* send flow control message */
485 ret
= mei_cl_irq_read(cl
, cb
, &slots
, cmpl_list
);
491 /* connect message */
492 if (mei_cl_is_other_connecting(cl
))
494 ret
= mei_cl_irq_ioctl(cl
, cb
, &slots
, cmpl_list
);
505 /* complete write list CB */
506 dev_dbg(&dev
->pdev
->dev
, "complete write list cb.\n");
507 list_for_each_entry_safe(cb
, next
, &dev
->write_list
.list
, list
) {
511 if (mei_cl_flow_ctrl_creds(cl
) <= 0) {
512 dev_dbg(&dev
->pdev
->dev
,
513 "No flow control credentials for client %d, not sending.\n",
518 if (cl
== &dev
->iamthif_cl
)
519 ret
= mei_amthif_irq_write_complete(cl
, cb
,
522 ret
= mei_cl_irq_write_complete(cl
, cb
,
529 EXPORT_SYMBOL_GPL(mei_irq_write_handler
);
534 * mei_timer - timer function.
536 * @work: pointer to the work_struct structure
539 void mei_timer(struct work_struct
*work
)
541 unsigned long timeout
;
542 struct mei_cl
*cl_pos
= NULL
;
543 struct mei_cl
*cl_next
= NULL
;
544 struct mei_cl_cb
*cb_pos
= NULL
;
545 struct mei_cl_cb
*cb_next
= NULL
;
547 struct mei_device
*dev
= container_of(work
,
548 struct mei_device
, timer_work
.work
);
551 mutex_lock(&dev
->device_lock
);
553 /* Catch interrupt stalls during HBM init handshake */
554 if (dev
->dev_state
== MEI_DEV_INIT_CLIENTS
&&
555 dev
->hbm_state
!= MEI_HBM_IDLE
) {
557 if (dev
->init_clients_timer
) {
558 if (--dev
->init_clients_timer
== 0) {
559 dev_err(&dev
->pdev
->dev
, "timer: init clients timeout hbm_state = %d.\n",
567 if (dev
->dev_state
!= MEI_DEV_ENABLED
)
570 /*** connect/disconnect timeouts ***/
571 list_for_each_entry_safe(cl_pos
, cl_next
, &dev
->file_list
, link
) {
572 if (cl_pos
->timer_count
) {
573 if (--cl_pos
->timer_count
== 0) {
574 dev_err(&dev
->pdev
->dev
, "reset: connect/disconnect timeout.\n");
581 if (dev
->iamthif_stall_timer
) {
582 if (--dev
->iamthif_stall_timer
== 0) {
583 dev_err(&dev
->pdev
->dev
, "reset: amthif hanged.\n");
585 dev
->iamthif_msg_buf_size
= 0;
586 dev
->iamthif_msg_buf_index
= 0;
587 dev
->iamthif_canceled
= false;
588 dev
->iamthif_ioctl
= true;
589 dev
->iamthif_state
= MEI_IAMTHIF_IDLE
;
590 dev
->iamthif_timer
= 0;
592 mei_io_cb_free(dev
->iamthif_current_cb
);
593 dev
->iamthif_current_cb
= NULL
;
595 dev
->iamthif_file_object
= NULL
;
596 mei_amthif_run_next_cmd(dev
);
600 if (dev
->iamthif_timer
) {
602 timeout
= dev
->iamthif_timer
+
603 mei_secs_to_jiffies(MEI_IAMTHIF_READ_TIMER
);
605 dev_dbg(&dev
->pdev
->dev
, "dev->iamthif_timer = %ld\n",
607 dev_dbg(&dev
->pdev
->dev
, "timeout = %ld\n", timeout
);
608 dev_dbg(&dev
->pdev
->dev
, "jiffies = %ld\n", jiffies
);
609 if (time_after(jiffies
, timeout
)) {
611 * User didn't read the AMTHI data on time (15sec)
612 * freeing AMTHI for other requests
615 dev_dbg(&dev
->pdev
->dev
, "freeing AMTHI for other requests\n");
617 list_for_each_entry_safe(cb_pos
, cb_next
,
618 &dev
->amthif_rd_complete_list
.list
, list
) {
620 cl_pos
= cb_pos
->file_object
->private_data
;
622 /* Finding the AMTHI entry. */
623 if (cl_pos
== &dev
->iamthif_cl
)
624 list_del(&cb_pos
->list
);
626 mei_io_cb_free(dev
->iamthif_current_cb
);
627 dev
->iamthif_current_cb
= NULL
;
629 dev
->iamthif_file_object
->private_data
= NULL
;
630 dev
->iamthif_file_object
= NULL
;
631 dev
->iamthif_timer
= 0;
632 mei_amthif_run_next_cmd(dev
);
637 schedule_delayed_work(&dev
->timer_work
, 2 * HZ
);
638 mutex_unlock(&dev
->device_lock
);