1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (c) 2003-2018, Intel Corporation. All rights reserved.
4 * Intel Management Engine Interface (Intel MEI) Linux driver
5 */
6
7#include <linux/export.h>
8#include <linux/kthread.h>
9#include <linux/interrupt.h>
10#include <linux/fs.h>
11#include <linux/jiffies.h>
12#include <linux/slab.h>
13#include <linux/pm_runtime.h>
14
15#include <linux/mei.h>
16
17#include "mei_dev.h"
18#include "hbm.h"
19#include "client.h"
20
21
22/**
23 * mei_irq_compl_handler - dispatch complete handlers
24 * for the completed callbacks
25 *
26 * @dev: mei device
27 * @cmpl_list: list of completed cbs
28 */
29void mei_irq_compl_handler(struct mei_device *dev, struct list_head *cmpl_list)
30{
31 struct mei_cl_cb *cb, *next;
32 struct mei_cl *cl;
33
34 list_for_each_entry_safe(cb, next, cmpl_list, list) {
35 cl = cb->cl;
36 list_del_init(entry: &cb->list);
37
38 cl_dbg(dev, cl, "completing call back.\n");
39 mei_cl_complete(cl, cb);
40 }
41}
42EXPORT_SYMBOL_GPL(mei_irq_compl_handler);
43
44/**
45 * mei_cl_hbm_equal - check if hbm is addressed to the client
46 *
47 * @cl: host client
48 * @mei_hdr: header of mei client message
49 *
50 * Return: true if matches, false otherwise
51 */
52static inline int mei_cl_hbm_equal(struct mei_cl *cl,
53 struct mei_msg_hdr *mei_hdr)
54{
55 return mei_cl_host_addr(cl) == mei_hdr->host_addr &&
56 mei_cl_me_id(cl) == mei_hdr->me_addr;
57}
58
59/**
60 * mei_irq_discard_msg - discard received message
61 *
62 * @dev: mei device
63 * @hdr: message header
64 * @discard_len: the length of the message to discard (excluding header)
65 */
66static void mei_irq_discard_msg(struct mei_device *dev, struct mei_msg_hdr *hdr,
67 size_t discard_len)
68{
69 if (hdr->dma_ring) {
70 mei_dma_ring_read(dev, NULL,
71 len: hdr->extension[dev->rd_msg_hdr_count - 2]);
72 discard_len = 0;
73 }
74 /*
75 * no need to check for size as it is guaranteed
76 * that length fits into rd_msg_buf
77 */
78 mei_read_slots(dev, buf: dev->rd_msg_buf, len: discard_len);
79 dev_dbg(&dev->dev, "discarding message " MEI_HDR_FMT "\n",
80 MEI_HDR_PRM(hdr));
81}
82
83/**
84 * mei_cl_irq_read_msg - process client message
85 *
86 * @cl: reading client
87 * @mei_hdr: header of mei client message
88 * @meta: extend meta header
89 * @cmpl_list: completion list
90 *
91 * Return: always 0
92 */
93static int mei_cl_irq_read_msg(struct mei_cl *cl,
94 struct mei_msg_hdr *mei_hdr,
95 struct mei_ext_meta_hdr *meta,
96 struct list_head *cmpl_list)
97{
98 struct mei_device *dev = cl->dev;
99 struct mei_cl_cb *cb;
100
101 struct mei_ext_hdr_vtag *vtag_hdr = NULL;
102 struct mei_ext_hdr_gsc_f2h *gsc_f2h = NULL;
103
104 size_t buf_sz;
105 u32 length;
106 u32 ext_len;
107
108 length = mei_hdr->length;
109 ext_len = 0;
110 if (mei_hdr->extended) {
111 ext_len = sizeof(*meta) + mei_slots2data(slots: meta->size);
112 length -= ext_len;
113 }
114
115 cb = list_first_entry_or_null(&cl->rd_pending, struct mei_cl_cb, list);
116 if (!cb) {
117 if (!mei_cl_is_fixed_address(cl)) {
118 cl_err(dev, cl, "pending read cb not found\n");
119 goto discard;
120 }
121 cb = mei_cl_alloc_cb(cl, length: mei_cl_mtu(cl), type: MEI_FOP_READ, fp: cl->fp);
122 if (!cb)
123 goto discard;
124 list_add_tail(new: &cb->list, head: &cl->rd_pending);
125 }
126
127 if (mei_hdr->extended) {
128 struct mei_ext_hdr *ext = mei_ext_begin(meta);
129 do {
130 switch (ext->type) {
131 case MEI_EXT_HDR_VTAG:
132 vtag_hdr = (struct mei_ext_hdr_vtag *)ext;
133 break;
134 case MEI_EXT_HDR_GSC:
135 gsc_f2h = (struct mei_ext_hdr_gsc_f2h *)ext;
136 cb->ext_hdr = (struct mei_ext_hdr *)kzalloc(sizeof(*gsc_f2h), GFP_KERNEL);
137 if (!cb->ext_hdr) {
138 cb->status = -ENOMEM;
139 goto discard;
140 }
141 break;
142 case MEI_EXT_HDR_NONE:
143 fallthrough;
144 default:
145 cl_err(dev, cl, "unknown extended header\n");
146 cb->status = -EPROTO;
147 break;
148 }
149
150 ext = mei_ext_next(ext);
151 } while (!mei_ext_last(meta, ext));
152
153 if (!vtag_hdr && !gsc_f2h) {
154 cl_dbg(dev, cl, "no vtag or gsc found in extended header.\n");
155 cb->status = -EPROTO;
156 goto discard;
157 }
158 }
159
160 if (vtag_hdr) {
161 cl_dbg(dev, cl, "vtag: %d\n", vtag_hdr->vtag);
162 if (cb->vtag && cb->vtag != vtag_hdr->vtag) {
163 cl_err(dev, cl, "mismatched tag: %d != %d\n",
164 cb->vtag, vtag_hdr->vtag);
165 cb->status = -EPROTO;
166 goto discard;
167 }
168 cb->vtag = vtag_hdr->vtag;
169 }
170
171 if (gsc_f2h) {
172 u32 ext_hdr_len = mei_ext_hdr_len(ext: &gsc_f2h->hdr);
173
174 if (!dev->hbm_f_gsc_supported) {
175 cl_err(dev, cl, "gsc extended header is not supported\n");
176 cb->status = -EPROTO;
177 goto discard;
178 }
179
180 if (length) {
181 cl_err(dev, cl, "no data allowed in cb with gsc\n");
182 cb->status = -EPROTO;
183 goto discard;
184 }
185 if (ext_hdr_len > sizeof(*gsc_f2h)) {
186 cl_err(dev, cl, "gsc extended header is too big %u\n", ext_hdr_len);
187 cb->status = -EPROTO;
188 goto discard;
189 }
190 memcpy(to: cb->ext_hdr, from: gsc_f2h, len: ext_hdr_len);
191 }
192
193 if (!mei_cl_is_connected(cl)) {
194 cl_dbg(dev, cl, "not connected\n");
195 cb->status = -ENODEV;
196 goto discard;
197 }
198
199 if (mei_hdr->dma_ring)
200 length = mei_hdr->extension[mei_data2slots(length: ext_len)];
201
202 buf_sz = length + cb->buf_idx;
203 /* catch for integer overflow */
204 if (buf_sz < cb->buf_idx) {
205 cl_err(dev, cl, "message is too big len %d idx %zu\n",
206 length, cb->buf_idx);
207 cb->status = -EMSGSIZE;
208 goto discard;
209 }
210
211 if (cb->buf.size < buf_sz) {
212 cl_dbg(dev, cl, "message overflow. size %zu len %d idx %zu\n",
213 cb->buf.size, length, cb->buf_idx);
214 cb->status = -EMSGSIZE;
215 goto discard;
216 }
217
218 if (mei_hdr->dma_ring) {
219 mei_dma_ring_read(dev, buf: cb->buf.data + cb->buf_idx, len: length);
220 /* for DMA read 0 length to generate interrupt to the device */
221 mei_read_slots(dev, buf: cb->buf.data + cb->buf_idx, len: 0);
222 } else {
223 mei_read_slots(dev, buf: cb->buf.data + cb->buf_idx, len: length);
224 }
225
226 cb->buf_idx += length;
227
228 if (mei_hdr->msg_complete) {
229 cl_dbg(dev, cl, "completed read length = %zu\n", cb->buf_idx);
230 list_move_tail(list: &cb->list, head: cmpl_list);
231 } else {
232 pm_runtime_mark_last_busy(dev: dev->parent);
233 pm_request_autosuspend(dev: dev->parent);
234 }
235
236 return 0;
237
238discard:
239 if (cb)
240 list_move_tail(list: &cb->list, head: cmpl_list);
241 mei_irq_discard_msg(dev, hdr: mei_hdr, discard_len: length);
242 return 0;
243}
244
245/**
246 * mei_cl_irq_disconnect_rsp - send disconnection response message
247 *
248 * @cl: client
249 * @cb: callback block.
250 * @cmpl_list: complete list.
251 *
252 * Return: 0, OK; otherwise, error.
253 */
254static int mei_cl_irq_disconnect_rsp(struct mei_cl *cl, struct mei_cl_cb *cb,
255 struct list_head *cmpl_list)
256{
257 struct mei_device *dev = cl->dev;
258 u32 msg_slots;
259 int slots;
260 int ret;
261
262 msg_slots = mei_hbm2slots(length: sizeof(struct hbm_client_connect_response));
263 slots = mei_hbuf_empty_slots(dev);
264 if (slots < 0)
265 return -EOVERFLOW;
266
267 if ((u32)slots < msg_slots)
268 return -EMSGSIZE;
269
270 ret = mei_hbm_cl_disconnect_rsp(dev, cl);
271 list_move_tail(list: &cb->list, head: cmpl_list);
272
273 return ret;
274}
275
276/**
277 * mei_cl_irq_read - processes client read related operation from the
278 * interrupt thread context - request for flow control credits
279 *
280 * @cl: client
281 * @cb: callback block.
282 * @cmpl_list: complete list.
283 *
284 * Return: 0, OK; otherwise, error.
285 */
286static int mei_cl_irq_read(struct mei_cl *cl, struct mei_cl_cb *cb,
287 struct list_head *cmpl_list)
288{
289 struct mei_device *dev = cl->dev;
290 u32 msg_slots;
291 int slots;
292 int ret;
293
294 if (!list_empty(head: &cl->rd_pending))
295 return 0;
296
297 msg_slots = mei_hbm2slots(length: sizeof(struct hbm_flow_control));
298 slots = mei_hbuf_empty_slots(dev);
299 if (slots < 0)
300 return -EOVERFLOW;
301
302 if ((u32)slots < msg_slots)
303 return -EMSGSIZE;
304
305 ret = mei_hbm_cl_flow_control_req(dev, cl);
306 if (ret) {
307 cl->status = ret;
308 cb->buf_idx = 0;
309 list_move_tail(list: &cb->list, head: cmpl_list);
310 return ret;
311 }
312
313 pm_runtime_mark_last_busy(dev: dev->parent);
314 pm_request_autosuspend(dev: dev->parent);
315
316 list_move_tail(list: &cb->list, head: &cl->rd_pending);
317
318 return 0;
319}
320
321static inline bool hdr_is_hbm(struct mei_msg_hdr *mei_hdr)
322{
323 return mei_hdr->host_addr == 0 && mei_hdr->me_addr == 0;
324}
325
326static inline bool hdr_is_fixed(struct mei_msg_hdr *mei_hdr)
327{
328 return mei_hdr->host_addr == 0 && mei_hdr->me_addr != 0;
329}
330
331static inline int hdr_is_valid(u32 msg_hdr)
332{
333 struct mei_msg_hdr *mei_hdr;
334 u32 expected_len = 0;
335
336 mei_hdr = (struct mei_msg_hdr *)&msg_hdr;
337 if (!msg_hdr || mei_hdr->reserved)
338 return -EBADMSG;
339
340 if (mei_hdr->dma_ring)
341 expected_len += MEI_SLOT_SIZE;
342 if (mei_hdr->extended)
343 expected_len += MEI_SLOT_SIZE;
344 if (mei_hdr->length < expected_len)
345 return -EBADMSG;
346
347 return 0;
348}
349
350/**
351 * mei_irq_read_handler - bottom half read routine after ISR to
352 * handle the read processing.
353 *
354 * @dev: the device structure
355 * @cmpl_list: An instance of our list structure
356 * @slots: slots to read.
357 *
358 * Return: 0 on success, <0 on failure.
359 */
360int mei_irq_read_handler(struct mei_device *dev,
361 struct list_head *cmpl_list, s32 *slots)
362{
363 struct mei_msg_hdr *mei_hdr;
364 struct mei_ext_meta_hdr *meta_hdr = NULL;
365 struct mei_cl *cl;
366 int ret;
367 u32 hdr_size_left;
368 u32 hdr_size_ext;
369 int i;
370 int ext_hdr_end;
371
372 if (!dev->rd_msg_hdr[0]) {
373 dev->rd_msg_hdr[0] = mei_read_hdr(dev);
374 dev->rd_msg_hdr_count = 1;
375 (*slots)--;
376 dev_dbg(&dev->dev, "slots =%08x.\n", *slots);
377
378 ret = hdr_is_valid(msg_hdr: dev->rd_msg_hdr[0]);
379 if (ret) {
380 dev_err(&dev->dev, "corrupted message header 0x%08X\n",
381 dev->rd_msg_hdr[0]);
382 goto end;
383 }
384 }
385
386 mei_hdr = (struct mei_msg_hdr *)dev->rd_msg_hdr;
387 dev_dbg(&dev->dev, MEI_HDR_FMT, MEI_HDR_PRM(mei_hdr));
388
389 if (mei_slots2data(slots: *slots) < mei_hdr->length) {
390 dev_err(&dev->dev, "less data available than length=%08x.\n",
391 *slots);
392 /* we can't read the message */
393 ret = -ENODATA;
394 goto end;
395 }
396
397 ext_hdr_end = 1;
398 hdr_size_left = mei_hdr->length;
399
400 if (mei_hdr->extended) {
401 if (!dev->rd_msg_hdr[1]) {
402 dev->rd_msg_hdr[1] = mei_read_hdr(dev);
403 dev->rd_msg_hdr_count++;
404 (*slots)--;
405 dev_dbg(&dev->dev, "extended header is %08x\n", dev->rd_msg_hdr[1]);
406 }
407 meta_hdr = ((struct mei_ext_meta_hdr *)&dev->rd_msg_hdr[1]);
408 if (check_add_overflow((u32)sizeof(*meta_hdr),
409 mei_slots2data(meta_hdr->size),
410 &hdr_size_ext)) {
411 dev_err(&dev->dev, "extended message size too big %d\n",
412 meta_hdr->size);
413 return -EBADMSG;
414 }
415 if (hdr_size_left < hdr_size_ext) {
416 dev_err(&dev->dev, "corrupted message header len %d\n",
417 mei_hdr->length);
418 return -EBADMSG;
419 }
420 hdr_size_left -= hdr_size_ext;
421
422 ext_hdr_end = meta_hdr->size + 2;
423 for (i = dev->rd_msg_hdr_count; i < ext_hdr_end; i++) {
424 dev->rd_msg_hdr[i] = mei_read_hdr(dev);
425 dev_dbg(&dev->dev, "extended header %d is %08x\n", i,
426 dev->rd_msg_hdr[i]);
427 dev->rd_msg_hdr_count++;
428 (*slots)--;
429 }
430 }
431
432 if (mei_hdr->dma_ring) {
433 if (hdr_size_left != sizeof(dev->rd_msg_hdr[ext_hdr_end])) {
434 dev_err(&dev->dev, "corrupted message header len %d\n",
435 mei_hdr->length);
436 return -EBADMSG;
437 }
438
439 dev->rd_msg_hdr[ext_hdr_end] = mei_read_hdr(dev);
440 dev->rd_msg_hdr_count++;
441 (*slots)--;
442 mei_hdr->length -= sizeof(dev->rd_msg_hdr[ext_hdr_end]);
443 }
444
445 /* HBM message */
446 if (hdr_is_hbm(mei_hdr)) {
447 ret = mei_hbm_dispatch(dev, hdr: mei_hdr);
448 if (ret) {
449 dev_dbg(&dev->dev, "mei_hbm_dispatch failed ret = %d\n", ret);
450 goto end;
451 }
452 goto reset_slots;
453 }
454
455 /* find recipient cl */
456 list_for_each_entry(cl, &dev->file_list, link) {
457 if (mei_cl_hbm_equal(cl, mei_hdr)) {
458 cl_dbg(dev, cl, "got a message\n");
459 ret = mei_cl_irq_read_msg(cl, mei_hdr, meta: meta_hdr, cmpl_list);
460 goto reset_slots;
461 }
462 }
463
464 /* if no recipient cl was found we assume corrupted header */
465 /* A message for not connected fixed address clients
466 * should be silently discarded
467 * On power down client may be force cleaned,
468 * silently discard such messages
469 */
470 if (hdr_is_fixed(mei_hdr) ||
471 dev->dev_state == MEI_DEV_POWER_DOWN) {
472 mei_irq_discard_msg(dev, hdr: mei_hdr, discard_len: mei_hdr->length);
473 ret = 0;
474 goto reset_slots;
475 }
476 dev_err(&dev->dev, "no destination client found 0x%08X\n", dev->rd_msg_hdr[0]);
477 ret = -EBADMSG;
478 goto end;
479
480reset_slots:
481 /* reset the number of slots and header */
482 memset(s: dev->rd_msg_hdr, c: 0, n: sizeof(dev->rd_msg_hdr));
483 dev->rd_msg_hdr_count = 0;
484 *slots = mei_count_full_read_slots(dev);
485 if (*slots == -EOVERFLOW) {
486 /* overflow - reset */
487 dev_err(&dev->dev, "resetting due to slots overflow.\n");
488 /* set the event since message has been read */
489 ret = -ERANGE;
490 goto end;
491 }
492end:
493 return ret;
494}
495EXPORT_SYMBOL_GPL(mei_irq_read_handler);
496
497
498/**
499 * mei_irq_write_handler - dispatch write requests
500 * after irq received
501 *
502 * @dev: the device structure
503 * @cmpl_list: An instance of our list structure
504 *
505 * Return: 0 on success, <0 on failure.
506 */
507int mei_irq_write_handler(struct mei_device *dev, struct list_head *cmpl_list)
508{
509
510 struct mei_cl *cl;
511 struct mei_cl_cb *cb, *next;
512 s32 slots;
513 int ret;
514
515
516 if (!mei_hbuf_acquire(dev))
517 return 0;
518
519 slots = mei_hbuf_empty_slots(dev);
520 if (slots < 0)
521 return -EOVERFLOW;
522
523 if (slots == 0)
524 return -EMSGSIZE;
525
526 /* complete all waiting for write CB */
527 dev_dbg(&dev->dev, "complete all waiting for write cb.\n");
528
529 list_for_each_entry_safe(cb, next, &dev->write_waiting_list, list) {
530 cl = cb->cl;
531
532 cl->status = 0;
533 cl_dbg(dev, cl, "MEI WRITE COMPLETE\n");
534 cl->writing_state = MEI_WRITE_COMPLETE;
535 list_move_tail(list: &cb->list, head: cmpl_list);
536 }
537
538 /* complete control write list CB */
539 dev_dbg(&dev->dev, "complete control write list cb.\n");
540 list_for_each_entry_safe(cb, next, &dev->ctrl_wr_list, list) {
541 cl = cb->cl;
542 switch (cb->fop_type) {
543 case MEI_FOP_DISCONNECT:
544 /* send disconnect message */
545 ret = mei_cl_irq_disconnect(cl, cb, cmpl_list);
546 if (ret)
547 return ret;
548
549 break;
550 case MEI_FOP_READ:
551 /* send flow control message */
552 ret = mei_cl_irq_read(cl, cb, cmpl_list);
553 if (ret)
554 return ret;
555
556 break;
557 case MEI_FOP_CONNECT:
558 /* connect message */
559 ret = mei_cl_irq_connect(cl, cb, cmpl_list);
560 if (ret)
561 return ret;
562
563 break;
564 case MEI_FOP_DISCONNECT_RSP:
565 /* send disconnect resp */
566 ret = mei_cl_irq_disconnect_rsp(cl, cb, cmpl_list);
567 if (ret)
568 return ret;
569 break;
570
571 case MEI_FOP_NOTIFY_START:
572 case MEI_FOP_NOTIFY_STOP:
573 ret = mei_cl_irq_notify(cl, cb, cmpl_list);
574 if (ret)
575 return ret;
576 break;
577 case MEI_FOP_DMA_MAP:
578 ret = mei_cl_irq_dma_map(cl, cb, cmpl_list);
579 if (ret)
580 return ret;
581 break;
582 case MEI_FOP_DMA_UNMAP:
583 ret = mei_cl_irq_dma_unmap(cl, cb, cmpl_list);
584 if (ret)
585 return ret;
586 break;
587 default:
588 BUG();
589 }
590
591 }
592 /* complete write list CB */
593 dev_dbg(&dev->dev, "complete write list cb.\n");
594 list_for_each_entry_safe(cb, next, &dev->write_list, list) {
595 cl = cb->cl;
596 ret = mei_cl_irq_write(cl, cb, cmpl_list);
597 if (ret)
598 return ret;
599 }
600 return 0;
601}
602EXPORT_SYMBOL_GPL(mei_irq_write_handler);
603
604
605/**
606 * mei_connect_timeout - connect/disconnect timeouts
607 *
608 * @cl: host client
609 */
610static void mei_connect_timeout(struct mei_cl *cl)
611{
612 struct mei_device *dev = cl->dev;
613
614 if (cl->state == MEI_FILE_CONNECTING) {
615 if (dev->hbm_f_dot_supported) {
616 cl->state = MEI_FILE_DISCONNECT_REQUIRED;
617 wake_up(&cl->wait);
618 return;
619 }
620 }
621 mei_reset(dev);
622}
623
624#define MEI_STALL_TIMER_FREQ (2 * HZ)
625/**
626 * mei_schedule_stall_timer - re-arm stall_timer work
627 *
628 * @dev: the device structure
629 *
630 * Schedule stall timer
631 */
632void mei_schedule_stall_timer(struct mei_device *dev)
633{
634 schedule_delayed_work(dwork: &dev->timer_work, MEI_STALL_TIMER_FREQ);
635}
636
637/**
638 * mei_timer - timer function.
639 *
640 * @work: pointer to the work_struct structure
641 *
642 */
643void mei_timer(struct work_struct *work)
644{
645 struct mei_cl *cl;
646 struct mei_device *dev = container_of(work,
647 struct mei_device, timer_work.work);
648 bool reschedule_timer = false;
649
650 mutex_lock(lock: &dev->device_lock);
651
652 /* Catch interrupt stalls during HBM init handshake */
653 if (dev->dev_state == MEI_DEV_INIT_CLIENTS &&
654 dev->hbm_state != MEI_HBM_IDLE) {
655
656 if (dev->init_clients_timer) {
657 if (--dev->init_clients_timer == 0) {
658 dev_err(&dev->dev, "timer: init clients timeout hbm_state = %d.\n",
659 dev->hbm_state);
660 mei_reset(dev);
661 goto out;
662 }
663 reschedule_timer = true;
664 }
665 }
666
667 if (dev->dev_state != MEI_DEV_ENABLED)
668 goto out;
669
670 /*** connect/disconnect timeouts ***/
671 list_for_each_entry(cl, &dev->file_list, link) {
672 if (cl->timer_count) {
673 if (--cl->timer_count == 0) {
674 dev_err(&dev->dev, "timer: connect/disconnect timeout.\n");
675 mei_connect_timeout(cl);
676 goto out;
677 }
678 reschedule_timer = true;
679 }
680 }
681
682out:
683 if (dev->dev_state != MEI_DEV_DISABLED && reschedule_timer)
684 mei_schedule_stall_timer(dev);
685
686 mutex_unlock(lock: &dev->device_lock);
687}
688