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 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_close - processes close related operation from
165 * interrupt thread context - send disconnect request
168 * @cb: callback block.
169 * @slots: free slots.
170 * @cmpl_list: complete list.
172 * returns 0, OK; otherwise, error.
174 static int mei_cl_irq_close(struct mei_cl
*cl
, struct mei_cl_cb
*cb
,
175 s32
*slots
, struct mei_cl_cb
*cmpl_list
)
177 struct mei_device
*dev
= cl
->dev
;
180 mei_data2slots(sizeof(struct hbm_client_connect_request
));
182 if (*slots
< msg_slots
)
187 if (mei_hbm_cl_disconnect_req(dev
, cl
)) {
190 list_move_tail(&cb
->list
, &cmpl_list
->list
);
194 cl
->state
= MEI_FILE_DISCONNECTING
;
197 list_move_tail(&cb
->list
, &dev
->ctrl_rd_list
.list
);
198 cl
->timer_count
= MEI_CONNECT_TIMEOUT
;
205 * mei_cl_irq_close - processes client read related operation from the
206 * interrupt thread context - request for flow control credits
209 * @cb: callback block.
210 * @slots: free slots.
211 * @cmpl_list: complete list.
213 * returns 0, OK; otherwise, error.
215 static int mei_cl_irq_read(struct mei_cl
*cl
, struct mei_cl_cb
*cb
,
216 s32
*slots
, struct mei_cl_cb
*cmpl_list
)
218 struct mei_device
*dev
= cl
->dev
;
219 u32 msg_slots
= mei_data2slots(sizeof(struct hbm_flow_control
));
224 if (*slots
< msg_slots
) {
225 /* return the cancel routine */
232 ret
= mei_hbm_cl_flow_control_req(dev
, cl
);
236 list_move_tail(&cb
->list
, &cmpl_list
->list
);
240 list_move_tail(&cb
->list
, &dev
->read_list
.list
);
247 * mei_cl_irq_ioctl - processes client ioctl related operation from the
248 * interrupt thread context - send connection request
251 * @cb: callback block.
252 * @slots: free slots.
253 * @cmpl_list: complete list.
255 * returns 0, OK; otherwise, error.
257 static int mei_cl_irq_ioctl(struct mei_cl
*cl
, struct mei_cl_cb
*cb
,
258 s32
*slots
, struct mei_cl_cb
*cmpl_list
)
260 struct mei_device
*dev
= cl
->dev
;
264 mei_data2slots(sizeof(struct hbm_client_connect_request
));
266 if (*slots
< msg_slots
) {
267 /* return the cancel routine */
274 cl
->state
= MEI_FILE_CONNECTING
;
276 ret
= mei_hbm_cl_connect_req(dev
, cl
);
284 list_move_tail(&cb
->list
, &dev
->ctrl_rd_list
.list
);
285 cl
->timer_count
= MEI_CONNECT_TIMEOUT
;
291 * mei_irq_read_handler - bottom half read routine after ISR to
292 * handle the read processing.
294 * @dev: the device structure
295 * @cmpl_list: An instance of our list structure
296 * @slots: slots to read.
298 * returns 0 on success, <0 on failure.
300 int mei_irq_read_handler(struct mei_device
*dev
,
301 struct mei_cl_cb
*cmpl_list
, s32
*slots
)
303 struct mei_msg_hdr
*mei_hdr
;
304 struct mei_cl
*cl_pos
= NULL
;
305 struct mei_cl
*cl_next
= NULL
;
308 if (!dev
->rd_msg_hdr
) {
309 dev
->rd_msg_hdr
= mei_read_hdr(dev
);
310 dev_dbg(&dev
->pdev
->dev
, "slots =%08x.\n", *slots
);
312 dev_dbg(&dev
->pdev
->dev
, "slots =%08x.\n", *slots
);
314 mei_hdr
= (struct mei_msg_hdr
*) &dev
->rd_msg_hdr
;
315 dev_dbg(&dev
->pdev
->dev
, MEI_HDR_FMT
, MEI_HDR_PRM(mei_hdr
));
317 if (mei_hdr
->reserved
|| !dev
->rd_msg_hdr
) {
318 dev_dbg(&dev
->pdev
->dev
, "corrupted message header.\n");
323 if (mei_hdr
->host_addr
|| mei_hdr
->me_addr
) {
324 list_for_each_entry_safe(cl_pos
, cl_next
,
325 &dev
->file_list
, link
) {
326 dev_dbg(&dev
->pdev
->dev
,
327 "list_for_each_entry_safe read host"
328 " client = %d, ME client = %d\n",
329 cl_pos
->host_client_id
,
330 cl_pos
->me_client_id
);
331 if (mei_cl_hbm_equal(cl_pos
, mei_hdr
))
335 if (&cl_pos
->link
== &dev
->file_list
) {
336 dev_dbg(&dev
->pdev
->dev
, "corrupted message header\n");
341 if (((*slots
) * sizeof(u32
)) < mei_hdr
->length
) {
342 dev_err(&dev
->pdev
->dev
,
343 "we can't read the message slots =%08x.\n",
345 /* we can't read the message */
350 /* decide where to read the message too */
351 if (!mei_hdr
->host_addr
) {
352 dev_dbg(&dev
->pdev
->dev
, "call mei_hbm_dispatch.\n");
353 mei_hbm_dispatch(dev
, mei_hdr
);
354 dev_dbg(&dev
->pdev
->dev
, "end mei_hbm_dispatch.\n");
355 } else if (mei_hdr
->host_addr
== dev
->iamthif_cl
.host_client_id
&&
356 (MEI_FILE_CONNECTED
== dev
->iamthif_cl
.state
) &&
357 (dev
->iamthif_state
== MEI_IAMTHIF_READING
)) {
359 dev_dbg(&dev
->pdev
->dev
, "call mei_amthif_irq_read_msg.\n");
360 dev_dbg(&dev
->pdev
->dev
, MEI_HDR_FMT
, MEI_HDR_PRM(mei_hdr
));
362 ret
= mei_amthif_irq_read_msg(dev
, mei_hdr
, cmpl_list
);
366 dev_dbg(&dev
->pdev
->dev
, "call mei_cl_irq_read_msg.\n");
367 dev_dbg(&dev
->pdev
->dev
, MEI_HDR_FMT
, MEI_HDR_PRM(mei_hdr
));
368 ret
= mei_cl_irq_read_msg(dev
, mei_hdr
, cmpl_list
);
373 /* reset the number of slots and header */
374 *slots
= mei_count_full_read_slots(dev
);
377 if (*slots
== -EOVERFLOW
) {
378 /* overflow - reset */
379 dev_err(&dev
->pdev
->dev
, "resetting due to slots overflow.\n");
380 /* set the event since message has been read */
387 EXPORT_SYMBOL_GPL(mei_irq_read_handler
);
391 * mei_irq_write_handler - dispatch write requests
394 * @dev: the device structure
395 * @cmpl_list: An instance of our list structure
397 * returns 0 on success, <0 on failure.
399 int mei_irq_write_handler(struct mei_device
*dev
, struct mei_cl_cb
*cmpl_list
)
403 struct mei_cl_cb
*cb
, *next
;
404 struct mei_cl_cb
*list
;
408 if (!mei_hbuf_is_ready(dev
)) {
409 dev_dbg(&dev
->pdev
->dev
, "host buffer is not empty.\n");
412 slots
= mei_hbuf_empty_slots(dev
);
416 /* complete all waiting for write CB */
417 dev_dbg(&dev
->pdev
->dev
, "complete all waiting for write cb.\n");
419 list
= &dev
->write_waiting_list
;
420 list_for_each_entry_safe(cb
, next
, &list
->list
, list
) {
427 if (MEI_WRITING
== cl
->writing_state
&&
428 cb
->fop_type
== MEI_FOP_WRITE
&&
429 cl
!= &dev
->iamthif_cl
) {
430 cl_dbg(dev
, cl
, "MEI WRITE COMPLETE\n");
431 cl
->writing_state
= MEI_WRITE_COMPLETE
;
432 list_add_tail(&cb
->list
, &cmpl_list
->list
);
434 if (cl
== &dev
->iamthif_cl
) {
435 cl_dbg(dev
, cl
, "check iamthif flow control.\n");
436 if (dev
->iamthif_flow_control_pending
) {
437 ret
= mei_amthif_irq_read(dev
, &slots
);
444 if (dev
->wd_state
== MEI_WD_STOPPING
) {
445 dev
->wd_state
= MEI_WD_IDLE
;
446 wake_up_interruptible(&dev
->wait_stop_wd
);
449 if (dev
->wr_ext_msg
.hdr
.length
) {
450 mei_write_message(dev
, &dev
->wr_ext_msg
.hdr
,
451 dev
->wr_ext_msg
.data
);
452 slots
-= mei_data2slots(dev
->wr_ext_msg
.hdr
.length
);
453 dev
->wr_ext_msg
.hdr
.length
= 0;
455 if (dev
->dev_state
== MEI_DEV_ENABLED
) {
456 if (dev
->wd_pending
&&
457 mei_cl_flow_ctrl_creds(&dev
->wd_cl
) > 0) {
458 if (mei_wd_send(dev
))
459 dev_dbg(&dev
->pdev
->dev
, "wd send failed.\n");
460 else if (mei_cl_flow_ctrl_reduce(&dev
->wd_cl
))
463 dev
->wd_pending
= false;
465 if (dev
->wd_state
== MEI_WD_RUNNING
)
466 slots
-= mei_data2slots(MEI_WD_START_MSG_SIZE
);
468 slots
-= mei_data2slots(MEI_WD_STOP_MSG_SIZE
);
472 /* complete control write list CB */
473 dev_dbg(&dev
->pdev
->dev
, "complete control write list cb.\n");
474 list_for_each_entry_safe(cb
, next
, &dev
->ctrl_wr_list
.list
, list
) {
480 switch (cb
->fop_type
) {
482 /* send disconnect message */
483 ret
= mei_cl_irq_close(cl
, cb
, &slots
, cmpl_list
);
489 /* send flow control message */
490 ret
= mei_cl_irq_read(cl
, cb
, &slots
, cmpl_list
);
496 /* connect message */
497 if (mei_cl_is_other_connecting(cl
))
499 ret
= mei_cl_irq_ioctl(cl
, cb
, &slots
, cmpl_list
);
510 /* complete write list CB */
511 dev_dbg(&dev
->pdev
->dev
, "complete write list cb.\n");
512 list_for_each_entry_safe(cb
, next
, &dev
->write_list
.list
, list
) {
516 if (cl
== &dev
->iamthif_cl
)
517 ret
= mei_amthif_irq_write_complete(cl
, cb
,
520 ret
= mei_cl_irq_write_complete(cl
, cb
,
527 EXPORT_SYMBOL_GPL(mei_irq_write_handler
);
532 * mei_timer - timer function.
534 * @work: pointer to the work_struct structure
536 * NOTE: This function is called by timer interrupt work
538 void mei_timer(struct work_struct
*work
)
540 unsigned long timeout
;
541 struct mei_cl
*cl_pos
= NULL
;
542 struct mei_cl
*cl_next
= NULL
;
543 struct mei_cl_cb
*cb_pos
= NULL
;
544 struct mei_cl_cb
*cb_next
= NULL
;
546 struct mei_device
*dev
= container_of(work
,
547 struct mei_device
, timer_work
.work
);
550 mutex_lock(&dev
->device_lock
);
551 if (dev
->dev_state
!= MEI_DEV_ENABLED
) {
552 if (dev
->dev_state
== MEI_DEV_INIT_CLIENTS
) {
553 if (dev
->init_clients_timer
) {
554 if (--dev
->init_clients_timer
== 0) {
555 dev_err(&dev
->pdev
->dev
, "reset: init clients timeout hbm_state = %d.\n",
563 /*** connect/disconnect timeouts ***/
564 list_for_each_entry_safe(cl_pos
, cl_next
, &dev
->file_list
, link
) {
565 if (cl_pos
->timer_count
) {
566 if (--cl_pos
->timer_count
== 0) {
567 dev_err(&dev
->pdev
->dev
, "reset: connect/disconnect timeout.\n");
574 if (dev
->iamthif_stall_timer
) {
575 if (--dev
->iamthif_stall_timer
== 0) {
576 dev_err(&dev
->pdev
->dev
, "reset: amthif hanged.\n");
578 dev
->iamthif_msg_buf_size
= 0;
579 dev
->iamthif_msg_buf_index
= 0;
580 dev
->iamthif_canceled
= false;
581 dev
->iamthif_ioctl
= true;
582 dev
->iamthif_state
= MEI_IAMTHIF_IDLE
;
583 dev
->iamthif_timer
= 0;
585 mei_io_cb_free(dev
->iamthif_current_cb
);
586 dev
->iamthif_current_cb
= NULL
;
588 dev
->iamthif_file_object
= NULL
;
589 mei_amthif_run_next_cmd(dev
);
593 if (dev
->iamthif_timer
) {
595 timeout
= dev
->iamthif_timer
+
596 mei_secs_to_jiffies(MEI_IAMTHIF_READ_TIMER
);
598 dev_dbg(&dev
->pdev
->dev
, "dev->iamthif_timer = %ld\n",
600 dev_dbg(&dev
->pdev
->dev
, "timeout = %ld\n", timeout
);
601 dev_dbg(&dev
->pdev
->dev
, "jiffies = %ld\n", jiffies
);
602 if (time_after(jiffies
, timeout
)) {
604 * User didn't read the AMTHI data on time (15sec)
605 * freeing AMTHI for other requests
608 dev_dbg(&dev
->pdev
->dev
, "freeing AMTHI for other requests\n");
610 list_for_each_entry_safe(cb_pos
, cb_next
,
611 &dev
->amthif_rd_complete_list
.list
, list
) {
613 cl_pos
= cb_pos
->file_object
->private_data
;
615 /* Finding the AMTHI entry. */
616 if (cl_pos
== &dev
->iamthif_cl
)
617 list_del(&cb_pos
->list
);
619 mei_io_cb_free(dev
->iamthif_current_cb
);
620 dev
->iamthif_current_cb
= NULL
;
622 dev
->iamthif_file_object
->private_data
= NULL
;
623 dev
->iamthif_file_object
= NULL
;
624 dev
->iamthif_timer
= 0;
625 mei_amthif_run_next_cmd(dev
);
630 schedule_delayed_work(&dev
->timer_work
, 2 * HZ
);
631 mutex_unlock(&dev
->device_lock
);