aed03efa72f4b5e3fc285095a6255cca70ee998c
[firefly-linux-kernel-4.4.55.git] / drivers / misc / mei / interrupt.c
1 /*
2  *
3  * Intel Management Engine Interface (Intel MEI) Linux driver
4  * Copyright (c) 2003-2012, Intel Corporation.
5  *
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.
9  *
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
13  * more details.
14  *
15  */
16
17
18 #include <linux/export.h>
19 #include <linux/pci.h>
20 #include <linux/kthread.h>
21 #include <linux/interrupt.h>
22 #include <linux/fs.h>
23 #include <linux/jiffies.h>
24
25 #include <linux/mei.h>
26
27 #include "mei_dev.h"
28 #include "hbm.h"
29 #include "hw-me.h"
30 #include "client.h"
31
32
33 /**
34  * mei_irq_compl_handler - dispatch complete handlers
35  *      for the completed callbacks
36  *
37  * @dev - mei device
38  * @compl_list - list of completed cbs
39  */
40 void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *compl_list)
41 {
42         struct mei_cl_cb *cb, *next;
43         struct mei_cl *cl;
44
45         list_for_each_entry_safe(cb, next, &compl_list->list, list) {
46                 cl = cb->cl;
47                 list_del(&cb->list);
48                 if (!cl)
49                         continue;
50
51                 dev_dbg(&dev->pdev->dev, "completing call back.\n");
52                 if (cl == &dev->iamthif_cl)
53                         mei_amthif_complete(dev, cb);
54                 else
55                         mei_cl_complete(cl, cb);
56         }
57 }
58 EXPORT_SYMBOL_GPL(mei_irq_compl_handler);
59
60 /**
61  * mei_cl_hbm_equal - check if hbm is addressed to the client
62  *
63  * @cl: host client
64  * @mei_hdr: header of mei client message
65  *
66  * returns true if matches, false otherwise
67  */
68 static inline int mei_cl_hbm_equal(struct mei_cl *cl,
69                         struct mei_msg_hdr *mei_hdr)
70 {
71         return cl->host_client_id == mei_hdr->host_addr &&
72                 cl->me_client_id == mei_hdr->me_addr;
73 }
74 /**
75  * mei_cl_is_reading - checks if the client
76                 is the one to read this message
77  *
78  * @cl: mei client
79  * @mei_hdr: header of mei message
80  *
81  * returns true on match and false otherwise
82  */
83 static bool mei_cl_is_reading(struct mei_cl *cl, struct mei_msg_hdr *mei_hdr)
84 {
85         return mei_cl_hbm_equal(cl, mei_hdr) &&
86                 cl->state == MEI_FILE_CONNECTED &&
87                 cl->reading_state != MEI_READ_COMPLETE;
88 }
89
90 /**
91  * mei_irq_read_client_message - process client message
92  *
93  * @dev: the device structure
94  * @mei_hdr: header of mei client message
95  * @complete_list: An instance of our list structure
96  *
97  * returns 0 on success, <0 on failure.
98  */
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)
102 {
103         struct mei_cl *cl;
104         struct mei_cl_cb *cb, *next;
105         unsigned char *buffer = NULL;
106
107         list_for_each_entry_safe(cb, next, &dev->read_list.list, list) {
108                 cl = cb->cl;
109                 if (!cl || !mei_cl_is_reading(cl, mei_hdr))
110                         continue;
111
112                 cl->reading_state = MEI_READING;
113
114                 if (cb->response_buffer.size == 0 ||
115                     cb->response_buffer.data == NULL) {
116                         cl_err(dev, cl, "response buffer is not allocated.\n");
117                         list_del(&cb->list);
118                         return -ENOMEM;
119                 }
120
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,
127                                           GFP_KERNEL);
128
129                         if (!buffer) {
130                                 cl_err(dev, cl, "allocation failed.\n");
131                                 list_del(&cb->list);
132                                 return -ENOMEM;
133                         }
134                         cb->response_buffer.data = buffer;
135                         cb->response_buffer.size =
136                                 mei_hdr->length + cb->buf_idx;
137                 }
138
139                 buffer = cb->response_buffer.data + cb->buf_idx;
140                 mei_read_slots(dev, buffer, mei_hdr->length);
141
142                 cb->buf_idx += mei_hdr->length;
143                 if (mei_hdr->msg_complete) {
144                         cl->status = 0;
145                         list_del(&cb->list);
146                         cl_dbg(dev, cl, "completed read length = %lu\n",
147                                 cb->buf_idx);
148                         list_add_tail(&cb->list, &complete_list->list);
149                 }
150                 break;
151         }
152
153         dev_dbg(&dev->pdev->dev, "message read\n");
154         if (!buffer) {
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));
158         }
159
160         return 0;
161 }
162
163 /**
164  * mei_cl_irq_disconnect_rsp - send disconnection response message
165  *
166  * @cl: client
167  * @cb: callback block.
168  * @slots: free slots.
169  * @cmpl_list: complete list.
170  *
171  * returns 0, OK; otherwise, error.
172  */
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)
175 {
176         struct mei_device *dev = cl->dev;
177         int ret;
178
179         u32 msg_slots =
180                 mei_data2slots(sizeof(struct hbm_client_connect_response));
181
182         if (*slots < msg_slots)
183                 return -EMSGSIZE;
184
185         *slots -= msg_slots;
186
187         ret = mei_hbm_cl_disconnect_rsp(dev, cl);
188
189         cl->state = MEI_FILE_DISCONNECTED;
190         cl->status = 0;
191         mei_io_cb_free(cb);
192
193         return ret;
194 }
195
196
197
198 /**
199  * mei_cl_irq_close - processes close related operation from
200  *      interrupt thread context - send disconnect request
201  *
202  * @cl: client
203  * @cb: callback block.
204  * @slots: free slots.
205  * @cmpl_list: complete list.
206  *
207  * returns 0, OK; otherwise, error.
208  */
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)
211 {
212         struct mei_device *dev = cl->dev;
213
214         u32 msg_slots =
215                 mei_data2slots(sizeof(struct hbm_client_connect_request));
216
217         if (*slots < msg_slots)
218                 return -EMSGSIZE;
219
220         *slots -= msg_slots;
221
222         if (mei_hbm_cl_disconnect_req(dev, cl)) {
223                 cl->status = 0;
224                 cb->buf_idx = 0;
225                 list_move_tail(&cb->list, &cmpl_list->list);
226                 return -EIO;
227         }
228
229         cl->state = MEI_FILE_DISCONNECTING;
230         cl->status = 0;
231         cb->buf_idx = 0;
232         list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
233         cl->timer_count = MEI_CONNECT_TIMEOUT;
234
235         return 0;
236 }
237
238
239 /**
240  * mei_cl_irq_close - processes client read related operation from the
241  *      interrupt thread context - request for flow control credits
242  *
243  * @cl: client
244  * @cb: callback block.
245  * @slots: free slots.
246  * @cmpl_list: complete list.
247  *
248  * returns 0, OK; otherwise, error.
249  */
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)
252 {
253         struct mei_device *dev = cl->dev;
254         u32 msg_slots = mei_data2slots(sizeof(struct hbm_flow_control));
255
256         int ret;
257
258
259         if (*slots < msg_slots) {
260                 /* return the cancel routine */
261                 list_del(&cb->list);
262                 return -EMSGSIZE;
263         }
264
265         *slots -= msg_slots;
266
267         ret = mei_hbm_cl_flow_control_req(dev, cl);
268         if (ret) {
269                 cl->status = ret;
270                 cb->buf_idx = 0;
271                 list_move_tail(&cb->list, &cmpl_list->list);
272                 return ret;
273         }
274
275         list_move_tail(&cb->list, &dev->read_list.list);
276
277         return 0;
278 }
279
280
281 /**
282  * mei_cl_irq_connect - send connect request in irq_thread context
283  *
284  * @cl: client
285  * @cb: callback block.
286  * @slots: free slots.
287  * @cmpl_list: complete list.
288  *
289  * returns 0, OK; otherwise, error.
290  */
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)
293 {
294         struct mei_device *dev = cl->dev;
295         int ret;
296
297         u32 msg_slots =
298                 mei_data2slots(sizeof(struct hbm_client_connect_request));
299
300         if (mei_cl_is_other_connecting(cl))
301                 return 0;
302
303         if (*slots < msg_slots) {
304                 /* return the cancel routine */
305                 list_del(&cb->list);
306                 return -EMSGSIZE;
307         }
308
309         *slots -=  msg_slots;
310
311         cl->state = MEI_FILE_CONNECTING;
312
313         ret = mei_hbm_cl_connect_req(dev, cl);
314         if (ret) {
315                 cl->status = ret;
316                 cb->buf_idx = 0;
317                 list_del(&cb->list);
318                 return ret;
319         }
320
321         list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
322         cl->timer_count = MEI_CONNECT_TIMEOUT;
323         return 0;
324 }
325
326
327 /**
328  * mei_irq_read_handler - bottom half read routine after ISR to
329  * handle the read processing.
330  *
331  * @dev: the device structure
332  * @cmpl_list: An instance of our list structure
333  * @slots: slots to read.
334  *
335  * returns 0 on success, <0 on failure.
336  */
337 int mei_irq_read_handler(struct mei_device *dev,
338                 struct mei_cl_cb *cmpl_list, s32 *slots)
339 {
340         struct mei_msg_hdr *mei_hdr;
341         struct mei_cl *cl;
342         int ret;
343
344         if (!dev->rd_msg_hdr) {
345                 dev->rd_msg_hdr = mei_read_hdr(dev);
346                 (*slots)--;
347                 dev_dbg(&dev->pdev->dev, "slots =%08x.\n", *slots);
348         }
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));
351
352         if (mei_hdr->reserved || !dev->rd_msg_hdr) {
353                 dev_err(&dev->pdev->dev, "corrupted message header 0x%08X\n",
354                                 dev->rd_msg_hdr);
355                 ret = -EBADMSG;
356                 goto end;
357         }
358
359         if (mei_slots2data(*slots) < mei_hdr->length) {
360                 dev_err(&dev->pdev->dev, "less data available than length=%08x.\n",
361                                 *slots);
362                 /* we can't read the message */
363                 ret = -ERANGE;
364                 goto end;
365         }
366
367         /*  HBM message */
368         if (mei_hdr->host_addr == 0 && mei_hdr->me_addr == 0) {
369                 ret = mei_hbm_dispatch(dev, mei_hdr);
370                 if (ret) {
371                         dev_dbg(&dev->pdev->dev, "mei_hbm_dispatch failed ret = %d\n",
372                                         ret);
373                         goto end;
374                 }
375                 goto reset_slots;
376         }
377
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");
382                         break;
383                 }
384         }
385
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",
389                                 dev->rd_msg_hdr);
390                 ret = -EBADMSG;
391                 goto end;
392         }
393
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) {
397
398                 ret = mei_amthif_irq_read_msg(dev, mei_hdr, cmpl_list);
399                 if (ret) {
400                         dev_err(&dev->pdev->dev, "mei_amthif_irq_read_msg failed = %d\n",
401                                         ret);
402                         goto end;
403                 }
404         } else {
405                 ret = mei_cl_irq_read_msg(dev, mei_hdr, cmpl_list);
406                 if (ret) {
407                         dev_err(&dev->pdev->dev, "mei_cl_irq_read_msg failed = %d\n",
408                                         ret);
409                         goto end;
410                 }
411         }
412
413 reset_slots:
414         /* reset the number of slots and header */
415         *slots = mei_count_full_read_slots(dev);
416         dev->rd_msg_hdr = 0;
417
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 */
422                 ret = -ERANGE;
423                 goto end;
424         }
425 end:
426         return ret;
427 }
428 EXPORT_SYMBOL_GPL(mei_irq_read_handler);
429
430
431 /**
432  * mei_irq_write_handler -  dispatch write requests
433  *  after irq received
434  *
435  * @dev: the device structure
436  * @cmpl_list: An instance of our list structure
437  *
438  * returns 0 on success, <0 on failure.
439  */
440 int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list)
441 {
442
443         struct mei_cl *cl;
444         struct mei_cl_cb *cb, *next;
445         struct mei_cl_cb *list;
446         s32 slots;
447         int ret;
448
449
450         if (!mei_hbuf_acquire(dev))
451                 return 0;
452
453         slots = mei_hbuf_empty_slots(dev);
454         if (slots <= 0)
455                 return -EMSGSIZE;
456
457         /* complete all waiting for write CB */
458         dev_dbg(&dev->pdev->dev, "complete all waiting for write cb.\n");
459
460         list = &dev->write_waiting_list;
461         list_for_each_entry_safe(cb, next, &list->list, list) {
462                 cl = cb->cl;
463                 if (cl == NULL)
464                         continue;
465
466                 cl->status = 0;
467                 list_del(&cb->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);
474                 }
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);
479                                 if (ret)
480                                         return ret;
481                         }
482                 }
483         }
484
485         if (dev->wd_state == MEI_WD_STOPPING) {
486                 dev->wd_state = MEI_WD_IDLE;
487                 wake_up_interruptible(&dev->wait_stop_wd);
488         }
489
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))
496                                 return -ENODEV;
497
498                         dev->wd_pending = false;
499
500                         if (dev->wd_state == MEI_WD_RUNNING)
501                                 slots -= mei_data2slots(MEI_WD_START_MSG_SIZE);
502                         else
503                                 slots -= mei_data2slots(MEI_WD_STOP_MSG_SIZE);
504                 }
505         }
506
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) {
510                 cl = cb->cl;
511                 if (!cl) {
512                         list_del(&cb->list);
513                         return -ENODEV;
514                 }
515                 switch (cb->fop_type) {
516                 case MEI_FOP_CLOSE:
517                         /* send disconnect message */
518                         ret = mei_cl_irq_close(cl, cb, &slots, cmpl_list);
519                         if (ret)
520                                 return ret;
521
522                         break;
523                 case MEI_FOP_READ:
524                         /* send flow control message */
525                         ret = mei_cl_irq_read(cl, cb, &slots, cmpl_list);
526                         if (ret)
527                                 return ret;
528
529                         break;
530                 case MEI_FOP_CONNECT:
531                         /* connect message */
532                         ret = mei_cl_irq_connect(cl, cb, &slots, cmpl_list);
533                         if (ret)
534                                 return ret;
535
536                         break;
537                 case MEI_FOP_DISCONNECT_RSP:
538                         /* send disconnect resp */
539                         ret = mei_cl_irq_disconnect_rsp(cl, cb, &slots, cmpl_list);
540                         if (ret)
541                                 return ret;
542                 default:
543                         BUG();
544                 }
545
546         }
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) {
550                 cl = cb->cl;
551                 if (cl == NULL)
552                         continue;
553                 if (cl == &dev->iamthif_cl)
554                         ret = mei_amthif_irq_write_complete(cl, cb,
555                                                 &slots, cmpl_list);
556                 else
557                         ret = mei_cl_irq_write_complete(cl, cb,
558                                                 &slots, cmpl_list);
559                 if (ret)
560                         return ret;
561         }
562         return 0;
563 }
564 EXPORT_SYMBOL_GPL(mei_irq_write_handler);
565
566
567
568 /**
569  * mei_timer - timer function.
570  *
571  * @work: pointer to the work_struct structure
572  *
573  */
574 void mei_timer(struct work_struct *work)
575 {
576         unsigned long timeout;
577         struct mei_cl *cl;
578         struct mei_cl_cb  *cb_pos = NULL;
579         struct mei_cl_cb  *cb_next = NULL;
580
581         struct mei_device *dev = container_of(work,
582                                         struct mei_device, timer_work.work);
583
584
585         mutex_lock(&dev->device_lock);
586
587         /* Catch interrupt stalls during HBM init handshake */
588         if (dev->dev_state == MEI_DEV_INIT_CLIENTS &&
589             dev->hbm_state != MEI_HBM_IDLE) {
590
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",
594                                         dev->hbm_state);
595                                 mei_reset(dev);
596                                 goto out;
597                         }
598                 }
599         }
600
601         if (dev->dev_state != MEI_DEV_ENABLED)
602                 goto out;
603
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");
609                                 mei_reset(dev);
610                                 goto out;
611                         }
612                 }
613         }
614
615         if (!mei_cl_is_connected(&dev->iamthif_cl))
616                 goto out;
617
618         if (dev->iamthif_stall_timer) {
619                 if (--dev->iamthif_stall_timer == 0) {
620                         dev_err(&dev->pdev->dev, "timer: amthif  hanged.\n");
621                         mei_reset(dev);
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;
628
629                         mei_io_cb_free(dev->iamthif_current_cb);
630                         dev->iamthif_current_cb = NULL;
631
632                         dev->iamthif_file_object = NULL;
633                         mei_amthif_run_next_cmd(dev);
634                 }
635         }
636
637         if (dev->iamthif_timer) {
638
639                 timeout = dev->iamthif_timer +
640                         mei_secs_to_jiffies(MEI_IAMTHIF_READ_TIMER);
641
642                 dev_dbg(&dev->pdev->dev, "dev->iamthif_timer = %ld\n",
643                                 dev->iamthif_timer);
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)) {
647                         /*
648                          * User didn't read the AMTHI data on time (15sec)
649                          * freeing AMTHI for other requests
650                          */
651
652                         dev_dbg(&dev->pdev->dev, "freeing AMTHI for other requests\n");
653
654                         list_for_each_entry_safe(cb_pos, cb_next,
655                                 &dev->amthif_rd_complete_list.list, list) {
656
657                                 cl = cb_pos->file_object->private_data;
658
659                                 /* Finding the AMTHI entry. */
660                                 if (cl == &dev->iamthif_cl)
661                                         list_del(&cb_pos->list);
662                         }
663                         mei_io_cb_free(dev->iamthif_current_cb);
664                         dev->iamthif_current_cb = NULL;
665
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);
670
671                 }
672         }
673 out:
674         if (dev->dev_state != MEI_DEV_DISABLED)
675                 schedule_delayed_work(&dev->timer_work, 2 * HZ);
676         mutex_unlock(&dev->device_lock);
677 }
678