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_close - processes close related operation from
 165  *      interrupt thread context - send disconnect request
 166  *
 167  * @cl: client
 168  * @cb: callback block.
 169  * @slots: free slots.
 170  * @cmpl_list: complete list.
 171  *
 172  * returns 0, OK; otherwise, error.
 173  */
 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)
 176 {
 177         struct mei_device *dev = cl->dev;
 178
 179         u32 msg_slots =
 180                 mei_data2slots(sizeof(struct hbm_client_connect_request));
 181
 182         if (*slots < msg_slots)
 183                 return -EMSGSIZE;
 184
 185         *slots -= msg_slots;
 186
 187         if (mei_hbm_cl_disconnect_req(dev, cl)) {
 188                 cl->status = 0;
 189                 cb->buf_idx = 0;
 190                 list_move_tail(&cb->list, &cmpl_list->list);
 191                 return -EIO;
 192         }
 193
 194         cl->state = MEI_FILE_DISCONNECTING;
 195         cl->status = 0;
 196         cb->buf_idx = 0;
 197         list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
 198         cl->timer_count = MEI_CONNECT_TIMEOUT;
 199
 200         return 0;
 201 }
 202
 203
 204 /**
 205  * mei_cl_irq_close - processes client read related operation from the
 206  *      interrupt thread context - request for flow control credits
 207  *
 208  * @cl: client
 209  * @cb: callback block.
 210  * @slots: free slots.
 211  * @cmpl_list: complete list.
 212  *
 213  * returns 0, OK; otherwise, error.
 214  */
 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)
 217 {
 218         struct mei_device *dev = cl->dev;
 219         u32 msg_slots = mei_data2slots(sizeof(struct hbm_flow_control));
 220
 221         int ret;
 222
 223
 224         if (*slots < msg_slots) {
 225                 /* return the cancel routine */
 226                 list_del(&cb->list);
 227                 return -EMSGSIZE;
 228         }
 229
 230         *slots -= msg_slots;
 231
 232         ret = mei_hbm_cl_flow_control_req(dev, cl);
 233         if (ret) {
 234                 cl->status = ret;
 235                 cb->buf_idx = 0;
 236                 list_move_tail(&cb->list, &cmpl_list->list);
 237                 return ret;
 238         }
 239
 240         list_move_tail(&cb->list, &dev->read_list.list);
 241
 242         return 0;
 243 }
 244
 245
 246 /**
 247  * mei_cl_irq_ioctl - processes client ioctl related operation from the
 248  *      interrupt thread context -   send connection request
 249  *
 250  * @cl: client
 251  * @cb: callback block.
 252  * @slots: free slots.
 253  * @cmpl_list: complete list.
 254  *
 255  * returns 0, OK; otherwise, error.
 256  */
 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)
 259 {
 260         struct mei_device *dev = cl->dev;
 261         int ret;
 262
 263         u32 msg_slots =
 264                 mei_data2slots(sizeof(struct hbm_client_connect_request));
 265
 266         if (*slots < msg_slots) {
 267                 /* return the cancel routine */
 268                 list_del(&cb->list);
 269                 return -EMSGSIZE;
 270         }
 271
 272         *slots -=  msg_slots;
 273
 274         cl->state = MEI_FILE_CONNECTING;
 275
 276         ret = mei_hbm_cl_connect_req(dev, cl);
 277         if (ret) {
 278                 cl->status = ret;
 279                 cb->buf_idx = 0;
 280                 list_del(&cb->list);
 281                 return ret;
 282         }
 283
 284         list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
 285         cl->timer_count = MEI_CONNECT_TIMEOUT;
 286         return 0;
 287 }
 288
 289
 290 /**
 291  * mei_irq_read_handler - bottom half read routine after ISR to
 292  * handle the read processing.
 293  *
 294  * @dev: the device structure
 295  * @cmpl_list: An instance of our list structure
 296  * @slots: slots to read.
 297  *
 298  * returns 0 on success, <0 on failure.
 299  */
 300 int mei_irq_read_handler(struct mei_device *dev,
 301                 struct mei_cl_cb *cmpl_list, s32 *slots)
 302 {
 303         struct mei_msg_hdr *mei_hdr;
 304         struct mei_cl *cl;
 305         int ret;
 306
 307         if (!dev->rd_msg_hdr) {
 308                 dev->rd_msg_hdr = mei_read_hdr(dev);
 309                 (*slots)--;
 310                 dev_dbg(&dev->pdev->dev, "slots =%08x.\n", *slots);
 311         }
 312         mei_hdr = (struct mei_msg_hdr *) &dev->rd_msg_hdr;
 313         dev_dbg(&dev->pdev->dev, MEI_HDR_FMT, MEI_HDR_PRM(mei_hdr));
 314
 315         if (mei_hdr->reserved || !dev->rd_msg_hdr) {
 316                 dev_err(&dev->pdev->dev, "corrupted message header 0x%08X\n",
 317                                 dev->rd_msg_hdr);
 318                 ret = -EBADMSG;
 319                 goto end;
 320         }
 321
 322         if (mei_slots2data(*slots) < mei_hdr->length) {
 323                 dev_err(&dev->pdev->dev, "less data available than length=%08x.\n",
 324                                 *slots);
 325                 /* we can't read the message */
 326                 ret = -ERANGE;
 327                 goto end;
 328         }
 329
 330         /*  HBM message */
 331         if (mei_hdr->host_addr == 0 && mei_hdr->me_addr == 0) {
 332                 ret = mei_hbm_dispatch(dev, mei_hdr);
 333                 if (ret) {
 334                         dev_dbg(&dev->pdev->dev, "mei_hbm_dispatch failed ret = %d\n",
 335                                         ret);
 336                         goto end;
 337                 }
 338                 goto reset_slots;
 339         }
 340
 341         /* find recipient cl */
 342         list_for_each_entry(cl, &dev->file_list, link) {
 343                 if (mei_cl_hbm_equal(cl, mei_hdr)) {
 344                         cl_dbg(dev, cl, "got a message\n");
 345                         break;
 346                 }
 347         }
 348
 349         /* if no recipient cl was found we assume corrupted header */
 350         if (&cl->link == &dev->file_list) {
 351                 dev_err(&dev->pdev->dev, "no destination client found 0x%08X\n",
 352                                 dev->rd_msg_hdr);
 353                 ret = -EBADMSG;
 354                 goto end;
 355         }
 356
 357         if (mei_hdr->host_addr == dev->iamthif_cl.host_client_id &&
 358             MEI_FILE_CONNECTED == dev->iamthif_cl.state &&
 359             dev->iamthif_state == MEI_IAMTHIF_READING) {
 360
 361                 ret = mei_amthif_irq_read_msg(dev, mei_hdr, cmpl_list);
 362                 if (ret) {
 363                         dev_err(&dev->pdev->dev, "mei_amthif_irq_read_msg failed = %d\n",
 364                                         ret);
 365                         goto end;
 366                 }
 367         } else {
 368                 ret = mei_cl_irq_read_msg(dev, mei_hdr, cmpl_list);
 369                 if (ret) {
 370                         dev_err(&dev->pdev->dev, "mei_cl_irq_read_msg failed = %d\n",
 371                                         ret);
 372                         goto end;
 373                 }
 374         }
 375
 376 reset_slots:
 377         /* reset the number of slots and header */
 378         *slots = mei_count_full_read_slots(dev);
 379         dev->rd_msg_hdr = 0;
 380
 381         if (*slots == -EOVERFLOW) {
 382                 /* overflow - reset */
 383                 dev_err(&dev->pdev->dev, "resetting due to slots overflow.\n");
 384                 /* set the event since message has been read */
 385                 ret = -ERANGE;
 386                 goto end;
 387         }
 388 end:
 389         return ret;
 390 }
 391 EXPORT_SYMBOL_GPL(mei_irq_read_handler);
 392
 393
 394 /**
 395  * mei_irq_write_handler -  dispatch write requests
 396  *  after irq received
 397  *
 398  * @dev: the device structure
 399  * @cmpl_list: An instance of our list structure
 400  *
 401  * returns 0 on success, <0 on failure.
 402  */
 403 int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list)
 404 {
 405
 406         struct mei_cl *cl;
 407         struct mei_cl_cb *cb, *next;
 408         struct mei_cl_cb *list;
 409         s32 slots;
 410         int ret;
 411
 412         if (!mei_hbuf_is_ready(dev)) {
 413                 dev_dbg(&dev->pdev->dev, "host buffer is not empty.\n");
 414                 return 0;
 415         }
 416         slots = mei_hbuf_empty_slots(dev);
 417         if (slots <= 0)
 418                 return -EMSGSIZE;
 419
 420         /* complete all waiting for write CB */
 421         dev_dbg(&dev->pdev->dev, "complete all waiting for write cb.\n");
 422
 423         list = &dev->write_waiting_list;
 424         list_for_each_entry_safe(cb, next, &list->list, list) {
 425                 cl = cb->cl;
 426                 if (cl == NULL)
 427                         continue;
 428
 429                 cl->status = 0;
 430                 list_del(&cb->list);
 431                 if (cb->fop_type == MEI_FOP_WRITE &&
 432                     cl != &dev->iamthif_cl) {
 433                         cl_dbg(dev, cl, "MEI WRITE COMPLETE\n");
 434                         cl->writing_state = MEI_WRITE_COMPLETE;
 435                         list_add_tail(&cb->list, &cmpl_list->list);
 436                 }
 437                 if (cl == &dev->iamthif_cl) {
 438                         cl_dbg(dev, cl, "check iamthif flow control.\n");
 439                         if (dev->iamthif_flow_control_pending) {
 440                                 ret = mei_amthif_irq_read(dev, &slots);
 441                                 if (ret)
 442                                         return ret;
 443                         }
 444                 }
 445         }
 446
 447         if (dev->wd_state == MEI_WD_STOPPING) {
 448                 dev->wd_state = MEI_WD_IDLE;
 449                 wake_up_interruptible(&dev->wait_stop_wd);
 450         }
 451
 452         if (dev->wr_ext_msg.hdr.length) {
 453                 mei_write_message(dev, &dev->wr_ext_msg.hdr,
 454                                 dev->wr_ext_msg.data);
 455                 slots -= mei_data2slots(dev->wr_ext_msg.hdr.length);
 456                 dev->wr_ext_msg.hdr.length = 0;
 457         }
 458         if (dev->dev_state == MEI_DEV_ENABLED) {
 459                 if (dev->wd_pending &&
 460                     mei_cl_flow_ctrl_creds(&dev->wd_cl) > 0) {
 461                         if (mei_wd_send(dev))
 462                                 dev_dbg(&dev->pdev->dev, "wd send failed.\n");
 463                         else if (mei_cl_flow_ctrl_reduce(&dev->wd_cl))
 464                                 return -ENODEV;
 465
 466                         dev->wd_pending = false;
 467
 468                         if (dev->wd_state == MEI_WD_RUNNING)
 469                                 slots -= mei_data2slots(MEI_WD_START_MSG_SIZE);
 470                         else
 471                                 slots -= mei_data2slots(MEI_WD_STOP_MSG_SIZE);
 472                 }
 473         }
 474
 475         /* complete control write list CB */
 476         dev_dbg(&dev->pdev->dev, "complete control write list cb.\n");
 477         list_for_each_entry_safe(cb, next, &dev->ctrl_wr_list.list, list) {
 478                 cl = cb->cl;
 479                 if (!cl) {
 480                         list_del(&cb->list);
 481                         return -ENODEV;
 482                 }
 483                 switch (cb->fop_type) {
 484                 case MEI_FOP_CLOSE:
 485                         /* send disconnect message */
 486                         ret = mei_cl_irq_close(cl, cb, &slots, cmpl_list);
 487                         if (ret)
 488                                 return ret;
 489
 490                         break;
 491                 case MEI_FOP_READ:
 492                         /* send flow control message */
 493                         ret = mei_cl_irq_read(cl, cb, &slots, cmpl_list);
 494                         if (ret)
 495                                 return ret;
 496
 497                         break;
 498                 case MEI_FOP_IOCTL:
 499                         /* connect message */
 500                         if (mei_cl_is_other_connecting(cl))
 501                                 continue;
 502                         ret = mei_cl_irq_ioctl(cl, cb, &slots, cmpl_list);
 503                         if (ret)
 504                                 return ret;
 505
 506                         break;
 507
 508                 default:
 509                         BUG();
 510                 }
 511
 512         }
 513         /* complete  write list CB */
 514         dev_dbg(&dev->pdev->dev, "complete write list cb.\n");
 515         list_for_each_entry_safe(cb, next, &dev->write_list.list, list) {
 516                 cl = cb->cl;
 517                 if (cl == NULL)
 518                         continue;
 519                 if (cl == &dev->iamthif_cl)
 520                         ret = mei_amthif_irq_write_complete(cl, cb,
 521                                                 &slots, cmpl_list);
 522                 else
 523                         ret = mei_cl_irq_write_complete(cl, cb,
 524                                                 &slots, cmpl_list);
 525                 if (ret)
 526                         return ret;
 527         }
 528         return 0;
 529 }
 530 EXPORT_SYMBOL_GPL(mei_irq_write_handler);
 531
 532
 533
 534 /**
 535  * mei_timer - timer function.
 536  *
 537  * @work: pointer to the work_struct structure
 538  *
 539  */
 540 void mei_timer(struct work_struct *work)
 541 {
 542         unsigned long timeout;
 543         struct mei_cl *cl_pos = NULL;
 544         struct mei_cl *cl_next = NULL;
 545         struct mei_cl_cb  *cb_pos = NULL;
 546         struct mei_cl_cb  *cb_next = NULL;
 547
 548         struct mei_device *dev = container_of(work,
 549                                         struct mei_device, timer_work.work);
 550
 551
 552         mutex_lock(&dev->device_lock);
 553
 554         /* Catch interrupt stalls during HBM init handshake */
 555         if (dev->dev_state == MEI_DEV_INIT_CLIENTS &&
 556             dev->hbm_state != MEI_HBM_IDLE) {
 557
 558                 if (dev->init_clients_timer) {
 559                         if (--dev->init_clients_timer == 0) {
 560                                 dev_err(&dev->pdev->dev, "timer: init clients timeout hbm_state = %d.\n",
 561                                         dev->hbm_state);
 562                                 mei_reset(dev);
 563                                 goto out;
 564                         }
 565                 }
 566         }
 567
 568         if (dev->dev_state != MEI_DEV_ENABLED)
 569                 goto out;
 570
 571         /*** connect/disconnect timeouts ***/
 572         list_for_each_entry_safe(cl_pos, cl_next, &dev->file_list, link) {
 573                 if (cl_pos->timer_count) {
 574                         if (--cl_pos->timer_count == 0) {
 575                                 dev_err(&dev->pdev->dev, "timer: connect/disconnect timeout.\n");
 576                                 mei_reset(dev);
 577                                 goto out;
 578                         }
 579                 }
 580         }
 581
 582         if (dev->iamthif_stall_timer) {
 583                 if (--dev->iamthif_stall_timer == 0) {
 584                         dev_err(&dev->pdev->dev, "timer: amthif  hanged.\n");
 585                         mei_reset(dev);
 586                         dev->iamthif_msg_buf_size = 0;
 587                         dev->iamthif_msg_buf_index = 0;
 588                         dev->iamthif_canceled = false;
 589                         dev->iamthif_ioctl = true;
 590                         dev->iamthif_state = MEI_IAMTHIF_IDLE;
 591                         dev->iamthif_timer = 0;
 592
 593                         mei_io_cb_free(dev->iamthif_current_cb);
 594                         dev->iamthif_current_cb = NULL;
 595
 596                         dev->iamthif_file_object = NULL;
 597                         mei_amthif_run_next_cmd(dev);
 598                 }
 599         }
 600
 601         if (dev->iamthif_timer) {
 602
 603                 timeout = dev->iamthif_timer +
 604                         mei_secs_to_jiffies(MEI_IAMTHIF_READ_TIMER);
 605
 606                 dev_dbg(&dev->pdev->dev, "dev->iamthif_timer = %ld\n",
 607                                 dev->iamthif_timer);
 608                 dev_dbg(&dev->pdev->dev, "timeout = %ld\n", timeout);
 609                 dev_dbg(&dev->pdev->dev, "jiffies = %ld\n", jiffies);
 610                 if (time_after(jiffies, timeout)) {
 611                         /*
 612                          * User didn't read the AMTHI data on time (15sec)
 613                          * freeing AMTHI for other requests
 614                          */
 615
 616                         dev_dbg(&dev->pdev->dev, "freeing AMTHI for other requests\n");
 617
 618                         list_for_each_entry_safe(cb_pos, cb_next,
 619                                 &dev->amthif_rd_complete_list.list, list) {
 620
 621                                 cl_pos = cb_pos->file_object->private_data;
 622
 623                                 /* Finding the AMTHI entry. */
 624                                 if (cl_pos == &dev->iamthif_cl)
 625                                         list_del(&cb_pos->list);
 626                         }
 627                         mei_io_cb_free(dev->iamthif_current_cb);
 628                         dev->iamthif_current_cb = NULL;
 629
 630                         dev->iamthif_file_object->private_data = NULL;
 631                         dev->iamthif_file_object = NULL;
 632                         dev->iamthif_timer = 0;
 633                         mei_amthif_run_next_cmd(dev);
 634
 635                 }
 636         }
 637 out:
 638         if (dev->dev_state != MEI_DEV_DISABLED)
 639                 schedule_delayed_work(&dev->timer_work, 2 * HZ);
 640         mutex_unlock(&dev->device_lock);
 641 }
 642