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/kthread.h>
20 #include <linux/interrupt.h>
22 #include <linux/jiffies.h>
23 #include <linux/slab.h>
25 #include <linux/mei.h>
33 * mei_irq_compl_handler - dispatch complete handlers
34 * for the completed callbacks
37 * @compl_list: list of completed cbs
39 void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *compl_list)
41 struct mei_cl_cb *cb, *next;
44 list_for_each_entry_safe(cb, next, &compl_list->list, list) {
46 list_del_init(&cb->list);
48 dev_dbg(dev->dev, "completing call back.\n");
49 if (cl == &dev->iamthif_cl)
50 mei_amthif_complete(dev, cb);
52 mei_cl_complete(cl, cb);
55 EXPORT_SYMBOL_GPL(mei_irq_compl_handler);
58 * mei_cl_hbm_equal - check if hbm is addressed to the client
61 * @mei_hdr: header of mei client message
63 * Return: true if matches, false otherwise
65 static inline int mei_cl_hbm_equal(struct mei_cl *cl,
66 struct mei_msg_hdr *mei_hdr)
68 return cl->host_client_id == mei_hdr->host_addr &&
69 cl->me_client_id == mei_hdr->me_addr;
73 * mei_irq_discard_msg - discard received message
76 * @hdr: message header
79 void mei_irq_discard_msg(struct mei_device *dev, struct mei_msg_hdr *hdr)
82 * no need to check for size as it is guarantied
83 * that length fits into rd_msg_buf
85 mei_read_slots(dev, dev->rd_msg_buf, hdr->length);
86 dev_dbg(dev->dev, "discarding message " MEI_HDR_FMT "\n",
91 * mei_cl_irq_read_msg - process client message
94 * @mei_hdr: header of mei client message
95 * @complete_list: completion list
99 int mei_cl_irq_read_msg(struct mei_cl *cl,
100 struct mei_msg_hdr *mei_hdr,
101 struct mei_cl_cb *complete_list)
103 struct mei_device *dev = cl->dev;
104 struct mei_cl_cb *cb;
105 unsigned char *buffer = NULL;
107 cb = list_first_entry_or_null(&cl->rd_pending, struct mei_cl_cb, list);
109 cl_err(dev, cl, "pending read cb not found\n");
113 if (!mei_cl_is_connected(cl)) {
114 cl_dbg(dev, cl, "not connected\n");
115 cb->status = -ENODEV;
119 if (cb->buf.size == 0 || cb->buf.data == NULL) {
120 cl_err(dev, cl, "response buffer is not allocated.\n");
121 list_move_tail(&cb->list, &complete_list->list);
122 cb->status = -ENOMEM;
126 if (cb->buf.size < mei_hdr->length + cb->buf_idx) {
127 cl_dbg(dev, cl, "message overflow. size %d len %d idx %ld\n",
128 cb->buf.size, mei_hdr->length, cb->buf_idx);
129 buffer = krealloc(cb->buf.data, mei_hdr->length + cb->buf_idx,
133 cb->status = -ENOMEM;
134 list_move_tail(&cb->list, &complete_list->list);
137 cb->buf.data = buffer;
138 cb->buf.size = mei_hdr->length + cb->buf_idx;
141 buffer = cb->buf.data + cb->buf_idx;
142 mei_read_slots(dev, buffer, mei_hdr->length);
144 cb->buf_idx += mei_hdr->length;
146 if (mei_hdr->msg_complete) {
147 cb->read_time = jiffies;
148 cl_dbg(dev, cl, "completed read length = %lu\n", cb->buf_idx);
149 list_move_tail(&cb->list, &complete_list->list);
154 mei_irq_discard_msg(dev, mei_hdr);
160 * mei_cl_irq_disconnect_rsp - send disconnection response message
163 * @cb: callback block.
164 * @cmpl_list: complete list.
166 * Return: 0, OK; otherwise, error.
168 static int mei_cl_irq_disconnect_rsp(struct mei_cl *cl, struct mei_cl_cb *cb,
169 struct mei_cl_cb *cmpl_list)
171 struct mei_device *dev = cl->dev;
176 slots = mei_hbuf_empty_slots(dev);
177 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_response));
179 if (slots < msg_slots)
182 ret = mei_hbm_cl_disconnect_rsp(dev, cl);
184 cl->state = MEI_FILE_DISCONNECTED;
194 * mei_cl_irq_disconnect - processes close related operation from
195 * interrupt thread context - send disconnect request
198 * @cb: callback block.
199 * @cmpl_list: complete list.
201 * Return: 0, OK; otherwise, error.
203 static int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
204 struct mei_cl_cb *cmpl_list)
206 struct mei_device *dev = cl->dev;
210 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
211 slots = mei_hbuf_empty_slots(dev);
213 if (slots < msg_slots)
216 if (mei_hbm_cl_disconnect_req(dev, cl)) {
219 list_move_tail(&cb->list, &cmpl_list->list);
223 cl->state = MEI_FILE_DISCONNECTING;
226 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
227 cl->timer_count = MEI_CONNECT_TIMEOUT;
234 * mei_cl_irq_read - processes client read related operation from the
235 * interrupt thread context - request for flow control credits
238 * @cb: callback block.
239 * @cmpl_list: complete list.
241 * Return: 0, OK; otherwise, error.
243 static int mei_cl_irq_read(struct mei_cl *cl, struct mei_cl_cb *cb,
244 struct mei_cl_cb *cmpl_list)
246 struct mei_device *dev = cl->dev;
251 msg_slots = mei_data2slots(sizeof(struct hbm_flow_control));
252 slots = mei_hbuf_empty_slots(dev);
254 if (slots < msg_slots)
257 ret = mei_hbm_cl_flow_control_req(dev, cl);
261 list_move_tail(&cb->list, &cmpl_list->list);
265 list_move_tail(&cb->list, &cl->rd_pending);
272 * mei_cl_irq_connect - send connect request in irq_thread context
275 * @cb: callback block.
276 * @cmpl_list: complete list.
278 * Return: 0, OK; otherwise, error.
280 static int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
281 struct mei_cl_cb *cmpl_list)
283 struct mei_device *dev = cl->dev;
288 msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
289 slots = mei_hbuf_empty_slots(dev);
291 if (mei_cl_is_other_connecting(cl))
294 if (slots < msg_slots)
297 cl->state = MEI_FILE_CONNECTING;
299 ret = mei_hbm_cl_connect_req(dev, cl);
303 list_del_init(&cb->list);
307 list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
308 cl->timer_count = MEI_CONNECT_TIMEOUT;
314 * mei_irq_read_handler - bottom half read routine after ISR to
315 * handle the read processing.
317 * @dev: the device structure
318 * @cmpl_list: An instance of our list structure
319 * @slots: slots to read.
321 * Return: 0 on success, <0 on failure.
323 int mei_irq_read_handler(struct mei_device *dev,
324 struct mei_cl_cb *cmpl_list, s32 *slots)
326 struct mei_msg_hdr *mei_hdr;
330 if (!dev->rd_msg_hdr) {
331 dev->rd_msg_hdr = mei_read_hdr(dev);
333 dev_dbg(dev->dev, "slots =%08x.\n", *slots);
335 mei_hdr = (struct mei_msg_hdr *) &dev->rd_msg_hdr;
336 dev_dbg(dev->dev, MEI_HDR_FMT, MEI_HDR_PRM(mei_hdr));
338 if (mei_hdr->reserved || !dev->rd_msg_hdr) {
339 dev_err(dev->dev, "corrupted message header 0x%08X\n",
345 if (mei_slots2data(*slots) < mei_hdr->length) {
346 dev_err(dev->dev, "less data available than length=%08x.\n",
348 /* we can't read the message */
354 if (mei_hdr->host_addr == 0 && mei_hdr->me_addr == 0) {
355 ret = mei_hbm_dispatch(dev, mei_hdr);
357 dev_dbg(dev->dev, "mei_hbm_dispatch failed ret = %d\n",
364 /* find recipient cl */
365 list_for_each_entry(cl, &dev->file_list, link) {
366 if (mei_cl_hbm_equal(cl, mei_hdr)) {
367 cl_dbg(dev, cl, "got a message\n");
372 /* if no recipient cl was found we assume corrupted header */
373 if (&cl->link == &dev->file_list) {
374 dev_err(dev->dev, "no destination client found 0x%08X\n",
380 if (cl == &dev->iamthif_cl) {
381 ret = mei_amthif_irq_read_msg(cl, mei_hdr, cmpl_list);
383 ret = mei_cl_irq_read_msg(cl, mei_hdr, cmpl_list);
388 /* reset the number of slots and header */
389 *slots = mei_count_full_read_slots(dev);
392 if (*slots == -EOVERFLOW) {
393 /* overflow - reset */
394 dev_err(dev->dev, "resetting due to slots overflow.\n");
395 /* set the event since message has been read */
402 EXPORT_SYMBOL_GPL(mei_irq_read_handler);
406 * mei_irq_write_handler - dispatch write requests
409 * @dev: the device structure
410 * @cmpl_list: An instance of our list structure
412 * Return: 0 on success, <0 on failure.
414 int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list)
418 struct mei_cl_cb *cb, *next;
419 struct mei_cl_cb *list;
424 if (!mei_hbuf_acquire(dev))
427 slots = mei_hbuf_empty_slots(dev);
431 /* complete all waiting for write CB */
432 dev_dbg(dev->dev, "complete all waiting for write cb.\n");
434 list = &dev->write_waiting_list;
435 list_for_each_entry_safe(cb, next, &list->list, list) {
439 cl_dbg(dev, cl, "MEI WRITE COMPLETE\n");
440 cl->writing_state = MEI_WRITE_COMPLETE;
441 list_move_tail(&cb->list, &cmpl_list->list);
444 if (dev->wd_state == MEI_WD_STOPPING) {
445 dev->wd_state = MEI_WD_IDLE;
446 wake_up(&dev->wait_stop_wd);
449 if (mei_cl_is_connected(&dev->wd_cl)) {
450 if (dev->wd_pending &&
451 mei_cl_flow_ctrl_creds(&dev->wd_cl) > 0) {
452 ret = mei_wd_send(dev);
455 dev->wd_pending = false;
459 /* complete control write list CB */
460 dev_dbg(dev->dev, "complete control write list cb.\n");
461 list_for_each_entry_safe(cb, next, &dev->ctrl_wr_list.list, list) {
463 switch (cb->fop_type) {
464 case MEI_FOP_DISCONNECT:
465 /* send disconnect message */
466 ret = mei_cl_irq_disconnect(cl, cb, cmpl_list);
472 /* send flow control message */
473 ret = mei_cl_irq_read(cl, cb, cmpl_list);
478 case MEI_FOP_CONNECT:
479 /* connect message */
480 ret = mei_cl_irq_connect(cl, cb, cmpl_list);
485 case MEI_FOP_DISCONNECT_RSP:
486 /* send disconnect resp */
487 ret = mei_cl_irq_disconnect_rsp(cl, cb, cmpl_list);
496 /* complete write list CB */
497 dev_dbg(dev->dev, "complete write list cb.\n");
498 list_for_each_entry_safe(cb, next, &dev->write_list.list, list) {
500 if (cl == &dev->iamthif_cl)
501 ret = mei_amthif_irq_write(cl, cb, cmpl_list);
503 ret = mei_cl_irq_write(cl, cb, cmpl_list);
509 EXPORT_SYMBOL_GPL(mei_irq_write_handler);
514 * mei_timer - timer function.
516 * @work: pointer to the work_struct structure
519 void mei_timer(struct work_struct *work)
521 unsigned long timeout;
524 struct mei_device *dev = container_of(work,
525 struct mei_device, timer_work.work);
528 mutex_lock(&dev->device_lock);
530 /* Catch interrupt stalls during HBM init handshake */
531 if (dev->dev_state == MEI_DEV_INIT_CLIENTS &&
532 dev->hbm_state != MEI_HBM_IDLE) {
534 if (dev->init_clients_timer) {
535 if (--dev->init_clients_timer == 0) {
536 dev_err(dev->dev, "timer: init clients timeout hbm_state = %d.\n",
544 if (dev->dev_state != MEI_DEV_ENABLED)
547 /*** connect/disconnect timeouts ***/
548 list_for_each_entry(cl, &dev->file_list, link) {
549 if (cl->timer_count) {
550 if (--cl->timer_count == 0) {
551 dev_err(dev->dev, "timer: connect/disconnect timeout.\n");
558 if (!mei_cl_is_connected(&dev->iamthif_cl))
561 if (dev->iamthif_stall_timer) {
562 if (--dev->iamthif_stall_timer == 0) {
563 dev_err(dev->dev, "timer: amthif hanged.\n");
565 dev->iamthif_canceled = false;
566 dev->iamthif_state = MEI_IAMTHIF_IDLE;
567 dev->iamthif_timer = 0;
569 mei_io_cb_free(dev->iamthif_current_cb);
570 dev->iamthif_current_cb = NULL;
572 dev->iamthif_file_object = NULL;
573 mei_amthif_run_next_cmd(dev);
577 if (dev->iamthif_timer) {
579 timeout = dev->iamthif_timer +
580 mei_secs_to_jiffies(MEI_IAMTHIF_READ_TIMER);
582 dev_dbg(dev->dev, "dev->iamthif_timer = %ld\n",
584 dev_dbg(dev->dev, "timeout = %ld\n", timeout);
585 dev_dbg(dev->dev, "jiffies = %ld\n", jiffies);
586 if (time_after(jiffies, timeout)) {
588 * User didn't read the AMTHI data on time (15sec)
589 * freeing AMTHI for other requests
592 dev_dbg(dev->dev, "freeing AMTHI for other requests\n");
594 mei_io_list_flush(&dev->amthif_rd_complete_list,
596 mei_io_cb_free(dev->iamthif_current_cb);
597 dev->iamthif_current_cb = NULL;
599 dev->iamthif_file_object->private_data = NULL;
600 dev->iamthif_file_object = NULL;
601 dev->iamthif_timer = 0;
602 mei_amthif_run_next_cmd(dev);
607 if (dev->dev_state != MEI_DEV_DISABLED)
608 schedule_delayed_work(&dev->timer_work, 2 * HZ);
609 mutex_unlock(&dev->device_lock);