drivers/misc/mei/hbm.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 #include <linux/export.h>
  18 #include <linux/sched.h>
  19 #include <linux/wait.h>
  20 #include <linux/pm_runtime.h>
  21 #include <linux/slab.h>
  22
  23 #include <linux/mei.h>
  24
  25 #include "mei_dev.h"
  26 #include "hbm.h"
  27 #include "client.h"
  28
  29 static const char *mei_hbm_status_str(enum mei_hbm_status status)
  30 {
  31 #define MEI_HBM_STATUS(status) case MEI_HBMS_##status: return #status
  32         switch (status) {
  33         MEI_HBM_STATUS(SUCCESS);
  34         MEI_HBM_STATUS(CLIENT_NOT_FOUND);
  35         MEI_HBM_STATUS(ALREADY_EXISTS);
  36         MEI_HBM_STATUS(REJECTED);
  37         MEI_HBM_STATUS(INVALID_PARAMETER);
  38         MEI_HBM_STATUS(NOT_ALLOWED);
  39         MEI_HBM_STATUS(ALREADY_STARTED);
  40         MEI_HBM_STATUS(NOT_STARTED);
  41         default: return "unknown";
  42         }
  43 #undef MEI_HBM_STATUS
  44 };
  45
  46 static const char *mei_cl_conn_status_str(enum mei_cl_connect_status status)
  47 {
  48 #define MEI_CL_CS(status) case MEI_CL_CONN_##status: return #status
  49         switch (status) {
  50         MEI_CL_CS(SUCCESS);
  51         MEI_CL_CS(NOT_FOUND);
  52         MEI_CL_CS(ALREADY_STARTED);
  53         MEI_CL_CS(OUT_OF_RESOURCES);
  54         MEI_CL_CS(MESSAGE_SMALL);
  55         default: return "unknown";
  56         }
  57 #undef MEI_CL_CCS
  58 }
  59
  60 const char *mei_hbm_state_str(enum mei_hbm_state state)
  61 {
  62 #define MEI_HBM_STATE(state) case MEI_HBM_##state: return #state
  63         switch (state) {
  64         MEI_HBM_STATE(IDLE);
  65         MEI_HBM_STATE(STARTING);
  66         MEI_HBM_STATE(STARTED);
  67         MEI_HBM_STATE(ENUM_CLIENTS);
  68         MEI_HBM_STATE(CLIENT_PROPERTIES);
  69         MEI_HBM_STATE(STOPPED);
  70         default:
  71                 return "unknown";
  72         }
  73 #undef MEI_HBM_STATE
  74 }
  75
  76 /**
  77  * mei_cl_conn_status_to_errno - convert client connect response
  78  * status to error code
  79  *
  80  * @status: client connect response status
  81  *
  82  * Return: corresponding error code
  83  */
  84 static int mei_cl_conn_status_to_errno(enum mei_cl_connect_status status)
  85 {
  86         switch (status) {
  87         case MEI_CL_CONN_SUCCESS:          return 0;
  88         case MEI_CL_CONN_NOT_FOUND:        return -ENOTTY;
  89         case MEI_CL_CONN_ALREADY_STARTED:  return -EBUSY;
  90         case MEI_CL_CONN_OUT_OF_RESOURCES: return -EBUSY;
  91         case MEI_CL_CONN_MESSAGE_SMALL:    return -EINVAL;
  92         default:                           return -EINVAL;
  93         }
  94 }
  95
  96 /**
  97  * mei_hbm_idle - set hbm to idle state
  98  *
  99  * @dev: the device structure
 100  */
 101 void mei_hbm_idle(struct mei_device *dev)
 102 {
 103         dev->init_clients_timer = 0;
 104         dev->hbm_state = MEI_HBM_IDLE;
 105 }
 106
 107 /**
 108  * mei_hbm_reset - reset hbm counters and book keeping data structurs
 109  *
 110  * @dev: the device structure
 111  */
 112 void mei_hbm_reset(struct mei_device *dev)
 113 {
 114         dev->me_client_index = 0;
 115
 116         mei_me_cl_rm_all(dev);
 117
 118         mei_hbm_idle(dev);
 119 }
 120
 121 /**
 122  * mei_hbm_hdr - construct hbm header
 123  *
 124  * @hdr: hbm header
 125  * @length: payload length
 126  */
 127
 128 static inline void mei_hbm_hdr(struct mei_msg_hdr *hdr, size_t length)
 129 {
 130         hdr->host_addr = 0;
 131         hdr->me_addr = 0;
 132         hdr->length = length;
 133         hdr->msg_complete = 1;
 134         hdr->reserved = 0;
 135 }
 136
 137 /**
 138  * mei_hbm_cl_hdr - construct client hbm header
 139  *
 140  * @cl: client
 141  * @hbm_cmd: host bus message command
 142  * @buf: buffer for cl header
 143  * @len: buffer length
 144  */
 145 static inline
 146 void mei_hbm_cl_hdr(struct mei_cl *cl, u8 hbm_cmd, void *buf, size_t len)
 147 {
 148         struct mei_hbm_cl_cmd *cmd = buf;
 149
 150         memset(cmd, 0, len);
 151
 152         cmd->hbm_cmd = hbm_cmd;
 153         cmd->host_addr = mei_cl_host_addr(cl);
 154         cmd->me_addr = mei_cl_me_id(cl);
 155 }
 156
 157 /**
 158  * mei_hbm_cl_write - write simple hbm client message
 159  *
 160  * @dev: the device structure
 161  * @cl: client
 162  * @hbm_cmd: host bus message command
 163  * @len: buffer length
 164  *
 165  * Return: 0 on success, <0 on failure.
 166  */
 167 static inline
 168 int mei_hbm_cl_write(struct mei_device *dev,
 169                      struct mei_cl *cl, u8 hbm_cmd, size_t len)
 170 {
 171         struct mei_msg_hdr *mei_hdr = &dev->wr_msg.hdr;
 172
 173         mei_hbm_hdr(mei_hdr, len);
 174         mei_hbm_cl_hdr(cl, hbm_cmd, dev->wr_msg.data, len);
 175
 176         return mei_write_message(dev, mei_hdr, dev->wr_msg.data);
 177 }
 178
 179 /**
 180  * mei_hbm_cl_addr_equal - check if the client's and
 181  *      the message address match
 182  *
 183  * @cl: client
 184  * @cmd: hbm client message
 185  *
 186  * Return: true if addresses are the same
 187  */
 188 static inline
 189 bool mei_hbm_cl_addr_equal(struct mei_cl *cl, struct mei_hbm_cl_cmd *cmd)
 190 {
 191         return  mei_cl_host_addr(cl) == cmd->host_addr &&
 192                 mei_cl_me_id(cl) == cmd->me_addr;
 193 }
 194
 195 /**
 196  * mei_hbm_cl_find_by_cmd - find recipient client
 197  *
 198  * @dev: the device structure
 199  * @buf: a buffer with hbm cl command
 200  *
 201  * Return: the recipient client or NULL if not found
 202  */
 203 static inline
 204 struct mei_cl *mei_hbm_cl_find_by_cmd(struct mei_device *dev, void *buf)
 205 {
 206         struct mei_hbm_cl_cmd *cmd = (struct mei_hbm_cl_cmd *)buf;
 207         struct mei_cl *cl;
 208
 209         list_for_each_entry(cl, &dev->file_list, link)
 210                 if (mei_hbm_cl_addr_equal(cl, cmd))
 211                         return cl;
 212         return NULL;
 213 }
 214
 215
 216 /**
 217  * mei_hbm_start_wait - wait for start response message.
 218  *
 219  * @dev: the device structure
 220  *
 221  * Return: 0 on success and < 0 on failure
 222  */
 223 int mei_hbm_start_wait(struct mei_device *dev)
 224 {
 225         int ret;
 226
 227         if (dev->hbm_state > MEI_HBM_STARTING)
 228                 return 0;
 229
 230         mutex_unlock(&dev->device_lock);
 231         ret = wait_event_timeout(dev->wait_hbm_start,
 232                         dev->hbm_state != MEI_HBM_STARTING,
 233                         mei_secs_to_jiffies(MEI_HBM_TIMEOUT));
 234         mutex_lock(&dev->device_lock);
 235
 236         if (ret == 0 && (dev->hbm_state <= MEI_HBM_STARTING)) {
 237                 dev->hbm_state = MEI_HBM_IDLE;
 238                 dev_err(dev->dev, "waiting for mei start failed\n");
 239                 return -ETIME;
 240         }
 241         return 0;
 242 }
 243
 244 /**
 245  * mei_hbm_start_req - sends start request message.
 246  *
 247  * @dev: the device structure
 248  *
 249  * Return: 0 on success and < 0 on failure
 250  */
 251 int mei_hbm_start_req(struct mei_device *dev)
 252 {
 253         struct mei_msg_hdr *mei_hdr = &dev->wr_msg.hdr;
 254         struct hbm_host_version_request *start_req;
 255         const size_t len = sizeof(struct hbm_host_version_request);
 256         int ret;
 257
 258         mei_hbm_reset(dev);
 259
 260         mei_hbm_hdr(mei_hdr, len);
 261
 262         /* host start message */
 263         start_req = (struct hbm_host_version_request *)dev->wr_msg.data;
 264         memset(start_req, 0, len);
 265         start_req->hbm_cmd = HOST_START_REQ_CMD;
 266         start_req->host_version.major_version = HBM_MAJOR_VERSION;
 267         start_req->host_version.minor_version = HBM_MINOR_VERSION;
 268
 269         dev->hbm_state = MEI_HBM_IDLE;
 270         ret = mei_write_message(dev, mei_hdr, dev->wr_msg.data);
 271         if (ret) {
 272                 dev_err(dev->dev, "version message write failed: ret = %d\n",
 273                         ret);
 274                 return ret;
 275         }
 276
 277         dev->hbm_state = MEI_HBM_STARTING;
 278         dev->init_clients_timer = MEI_CLIENTS_INIT_TIMEOUT;
 279         return 0;
 280 }
 281
 282 /*
 283  * mei_hbm_enum_clients_req - sends enumeration client request message.
 284  *
 285  * @dev: the device structure
 286  *
 287  * Return: 0 on success and < 0 on failure
 288  */
 289 static int mei_hbm_enum_clients_req(struct mei_device *dev)
 290 {
 291         struct mei_msg_hdr *mei_hdr = &dev->wr_msg.hdr;
 292         struct hbm_host_enum_request *enum_req;
 293         const size_t len = sizeof(struct hbm_host_enum_request);
 294         int ret;
 295
 296         /* enumerate clients */
 297         mei_hbm_hdr(mei_hdr, len);
 298
 299         enum_req = (struct hbm_host_enum_request *)dev->wr_msg.data;
 300         memset(enum_req, 0, len);
 301         enum_req->hbm_cmd = HOST_ENUM_REQ_CMD;
 302         enum_req->allow_add = dev->hbm_f_dc_supported;
 303
 304         ret = mei_write_message(dev, mei_hdr, dev->wr_msg.data);
 305         if (ret) {
 306                 dev_err(dev->dev, "enumeration request write failed: ret = %d.\n",
 307                         ret);
 308                 return ret;
 309         }
 310         dev->hbm_state = MEI_HBM_ENUM_CLIENTS;
 311         dev->init_clients_timer = MEI_CLIENTS_INIT_TIMEOUT;
 312         return 0;
 313 }
 314
 315 /*
 316  * mei_hbm_me_cl_add - add new me client to the list
 317  *
 318  * @dev: the device structure
 319  * @res: hbm property response
 320  *
 321  * Return: 0 on success and -ENOMEM on allocation failure
 322  */
 323
 324 static int mei_hbm_me_cl_add(struct mei_device *dev,
 325                              struct hbm_props_response *res)
 326 {
 327         struct mei_me_client *me_cl;
 328         const uuid_le *uuid = &res->client_properties.protocol_name;
 329
 330         mei_me_cl_rm_by_uuid(dev, uuid);
 331
 332         me_cl = kzalloc(sizeof(struct mei_me_client), GFP_KERNEL);
 333         if (!me_cl)
 334                 return -ENOMEM;
 335
 336         mei_me_cl_init(me_cl);
 337
 338         me_cl->props = res->client_properties;
 339         me_cl->client_id = res->me_addr;
 340         me_cl->mei_flow_ctrl_creds = 0;
 341
 342         mei_me_cl_add(dev, me_cl);
 343
 344         return 0;
 345 }
 346
 347 /**
 348  * mei_hbm_add_cl_resp - send response to fw on client add request
 349  *
 350  * @dev: the device structure
 351  * @addr: me address
 352  * @status: response status
 353  *
 354  * Return: 0 on success and < 0 on failure
 355  */
 356 static int mei_hbm_add_cl_resp(struct mei_device *dev, u8 addr, u8 status)
 357 {
 358         struct mei_msg_hdr *mei_hdr = &dev->wr_msg.hdr;
 359         struct hbm_add_client_response *resp;
 360         const size_t len = sizeof(struct hbm_add_client_response);
 361         int ret;
 362
 363         dev_dbg(dev->dev, "adding client response\n");
 364
 365         resp = (struct hbm_add_client_response *)dev->wr_msg.data;
 366
 367         mei_hbm_hdr(mei_hdr, len);
 368         memset(resp, 0, sizeof(struct hbm_add_client_response));
 369
 370         resp->hbm_cmd = MEI_HBM_ADD_CLIENT_RES_CMD;
 371         resp->me_addr = addr;
 372         resp->status  = status;
 373
 374         ret = mei_write_message(dev, mei_hdr, dev->wr_msg.data);
 375         if (ret)
 376                 dev_err(dev->dev, "add client response write failed: ret = %d\n",
 377                         ret);
 378         return ret;
 379 }
 380
 381 /**
 382  * mei_hbm_fw_add_cl_req - request from the fw to add a client
 383  *
 384  * @dev: the device structure
 385  * @req: add client request
 386  *
 387  * Return: 0 on success and < 0 on failure
 388  */
 389 static int mei_hbm_fw_add_cl_req(struct mei_device *dev,
 390                               struct hbm_add_client_request *req)
 391 {
 392         int ret;
 393         u8 status = MEI_HBMS_SUCCESS;
 394
 395         BUILD_BUG_ON(sizeof(struct hbm_add_client_request) !=
 396                         sizeof(struct hbm_props_response));
 397
 398         ret = mei_hbm_me_cl_add(dev, (struct hbm_props_response *)req);
 399         if (ret)
 400                 status = !MEI_HBMS_SUCCESS;
 401
 402         return mei_hbm_add_cl_resp(dev, req->me_addr, status);
 403 }
 404
 405 /**
 406  * mei_hbm_cl_notify_req - send notification request
 407  *
 408  * @dev: the device structure
 409  * @cl: a client to disconnect from
 410  * @start: true for start false for stop
 411  *
 412  * Return: 0 on success and -EIO on write failure
 413  */
 414 int mei_hbm_cl_notify_req(struct mei_device *dev,
 415                           struct mei_cl *cl, u8 start)
 416 {
 417
 418         struct mei_msg_hdr *mei_hdr = &dev->wr_msg.hdr;
 419         struct hbm_notification_request *req;
 420         const size_t len = sizeof(struct hbm_notification_request);
 421         int ret;
 422
 423         mei_hbm_hdr(mei_hdr, len);
 424         mei_hbm_cl_hdr(cl, MEI_HBM_NOTIFY_REQ_CMD, dev->wr_msg.data, len);
 425
 426         req = (struct hbm_notification_request *)dev->wr_msg.data;
 427         req->start = start;
 428
 429         ret = mei_write_message(dev, mei_hdr, dev->wr_msg.data);
 430         if (ret)
 431                 dev_err(dev->dev, "notify request failed: ret = %d\n", ret);
 432
 433         return ret;
 434 }
 435
 436 /**
 437  *  notify_res_to_fop - convert notification response to the proper
 438  *      notification FOP
 439  *
 440  * @cmd: client notification start response command
 441  *
 442  * Return:  MEI_FOP_NOTIFY_START or MEI_FOP_NOTIFY_STOP;
 443  */
 444 static inline enum mei_cb_file_ops notify_res_to_fop(struct mei_hbm_cl_cmd *cmd)
 445 {
 446         struct hbm_notification_response *rs =
 447                 (struct hbm_notification_response *)cmd;
 448
 449         return mei_cl_notify_req2fop(rs->start);
 450 }
 451
 452 /**
 453  * mei_hbm_cl_notify_start_res - update the client state according
 454  *       notify start response
 455  *
 456  * @dev: the device structure
 457  * @cl: mei host client
 458  * @cmd: client notification start response command
 459  */
 460 static void mei_hbm_cl_notify_start_res(struct mei_device *dev,
 461                                         struct mei_cl *cl,
 462                                         struct mei_hbm_cl_cmd *cmd)
 463 {
 464         struct hbm_notification_response *rs =
 465                 (struct hbm_notification_response *)cmd;
 466
 467         cl_dbg(dev, cl, "hbm: notify start response status=%d\n", rs->status);
 468
 469         if (rs->status == MEI_HBMS_SUCCESS ||
 470             rs->status == MEI_HBMS_ALREADY_STARTED) {
 471                 cl->notify_en = true;
 472                 cl->status = 0;
 473         } else {
 474                 cl->status = -EINVAL;
 475         }
 476 }
 477
 478 /**
 479  * mei_hbm_cl_notify_stop_res - update the client state according
 480  *       notify stop response
 481  *
 482  * @dev: the device structure
 483  * @cl: mei host client
 484  * @cmd: client notification stop response command
 485  */
 486 static void mei_hbm_cl_notify_stop_res(struct mei_device *dev,
 487                                        struct mei_cl *cl,
 488                                        struct mei_hbm_cl_cmd *cmd)
 489 {
 490         struct hbm_notification_response *rs =
 491                 (struct hbm_notification_response *)cmd;
 492
 493         cl_dbg(dev, cl, "hbm: notify stop response status=%d\n", rs->status);
 494
 495         if (rs->status == MEI_HBMS_SUCCESS ||
 496             rs->status == MEI_HBMS_NOT_STARTED) {
 497                 cl->notify_en = false;
 498                 cl->status = 0;
 499         } else {
 500                 /* TODO: spec is not clear yet about other possible issues */
 501                 cl->status = -EINVAL;
 502         }
 503 }
 504
 505 /**
 506  * mei_hbm_cl_notify - signal notification event
 507  *
 508  * @dev: the device structure
 509  * @cmd: notification client message
 510  */
 511 static void mei_hbm_cl_notify(struct mei_device *dev,
 512                               struct mei_hbm_cl_cmd *cmd)
 513 {
 514         struct mei_cl *cl;
 515
 516         cl = mei_hbm_cl_find_by_cmd(dev, cmd);
 517         if (cl && cl->notify_en) {
 518                 cl->notify_ev = true;
 519                 wake_up_interruptible(&cl->ev_wait);
 520         }
 521 }
 522
 523 /**
 524  * mei_hbm_prop_req - request property for a single client
 525  *
 526  * @dev: the device structure
 527  *
 528  * Return: 0 on success and < 0 on failure
 529  */
 530
 531 static int mei_hbm_prop_req(struct mei_device *dev)
 532 {
 533
 534         struct mei_msg_hdr *mei_hdr = &dev->wr_msg.hdr;
 535         struct hbm_props_request *prop_req;
 536         const size_t len = sizeof(struct hbm_props_request);
 537         unsigned long next_client_index;
 538         int ret;
 539
 540         next_client_index = find_next_bit(dev->me_clients_map, MEI_CLIENTS_MAX,
 541                                           dev->me_client_index);
 542
 543         /* We got all client properties */
 544         if (next_client_index == MEI_CLIENTS_MAX) {
 545                 dev->hbm_state = MEI_HBM_STARTED;
 546                 schedule_work(&dev->init_work);
 547
 548                 return 0;
 549         }
 550
 551         mei_hbm_hdr(mei_hdr, len);
 552         prop_req = (struct hbm_props_request *)dev->wr_msg.data;
 553
 554         memset(prop_req, 0, sizeof(struct hbm_props_request));
 555
 556         prop_req->hbm_cmd = HOST_CLIENT_PROPERTIES_REQ_CMD;
 557         prop_req->me_addr = next_client_index;
 558
 559         ret = mei_write_message(dev, mei_hdr, dev->wr_msg.data);
 560         if (ret) {
 561                 dev_err(dev->dev, "properties request write failed: ret = %d\n",
 562                         ret);
 563                 return ret;
 564         }
 565
 566         dev->init_clients_timer = MEI_CLIENTS_INIT_TIMEOUT;
 567         dev->me_client_index = next_client_index;
 568
 569         return 0;
 570 }
 571
 572 /*
 573  * mei_hbm_pg - sends pg command
 574  *
 575  * @dev: the device structure
 576  * @pg_cmd: the pg command code
 577  *
 578  * Return: -EIO on write failure
 579  *         -EOPNOTSUPP if the operation is not supported by the protocol
 580  */
 581 int mei_hbm_pg(struct mei_device *dev, u8 pg_cmd)
 582 {
 583         struct mei_msg_hdr *mei_hdr = &dev->wr_msg.hdr;
 584         struct hbm_power_gate *req;
 585         const size_t len = sizeof(struct hbm_power_gate);
 586         int ret;
 587
 588         if (!dev->hbm_f_pg_supported)
 589                 return -EOPNOTSUPP;
 590
 591         mei_hbm_hdr(mei_hdr, len);
 592
 593         req = (struct hbm_power_gate *)dev->wr_msg.data;
 594         memset(req, 0, len);
 595         req->hbm_cmd = pg_cmd;
 596
 597         ret = mei_write_message(dev, mei_hdr, dev->wr_msg.data);
 598         if (ret)
 599                 dev_err(dev->dev, "power gate command write failed.\n");
 600         return ret;
 601 }
 602 EXPORT_SYMBOL_GPL(mei_hbm_pg);
 603
 604 /**
 605  * mei_hbm_stop_req - send stop request message
 606  *
 607  * @dev: mei device
 608  *
 609  * Return: -EIO on write failure
 610  */
 611 static int mei_hbm_stop_req(struct mei_device *dev)
 612 {
 613         struct mei_msg_hdr *mei_hdr = &dev->wr_msg.hdr;
 614         struct hbm_host_stop_request *req =
 615                         (struct hbm_host_stop_request *)dev->wr_msg.data;
 616         const size_t len = sizeof(struct hbm_host_stop_request);
 617
 618         mei_hbm_hdr(mei_hdr, len);
 619
 620         memset(req, 0, len);
 621         req->hbm_cmd = HOST_STOP_REQ_CMD;
 622         req->reason = DRIVER_STOP_REQUEST;
 623
 624         return mei_write_message(dev, mei_hdr, dev->wr_msg.data);
 625 }
 626
 627 /**
 628  * mei_hbm_cl_flow_control_req - sends flow control request.
 629  *
 630  * @dev: the device structure
 631  * @cl: client info
 632  *
 633  * Return: -EIO on write failure
 634  */
 635 int mei_hbm_cl_flow_control_req(struct mei_device *dev, struct mei_cl *cl)
 636 {
 637         const size_t len = sizeof(struct hbm_flow_control);
 638
 639         cl_dbg(dev, cl, "sending flow control\n");
 640         return mei_hbm_cl_write(dev, cl, MEI_FLOW_CONTROL_CMD, len);
 641 }
 642
 643 /**
 644  * mei_hbm_add_single_flow_creds - adds single buffer credentials.
 645  *
 646  * @dev: the device structure
 647  * @flow: flow control.
 648  *
 649  * Return: 0 on success, < 0 otherwise
 650  */
 651 static int mei_hbm_add_single_flow_creds(struct mei_device *dev,
 652                                   struct hbm_flow_control *flow)
 653 {
 654         struct mei_me_client *me_cl;
 655         int rets;
 656
 657         me_cl = mei_me_cl_by_id(dev, flow->me_addr);
 658         if (!me_cl) {
 659                 dev_err(dev->dev, "no such me client %d\n",
 660                         flow->me_addr);
 661                 return -ENOENT;
 662         }
 663
 664         if (WARN_ON(me_cl->props.single_recv_buf == 0)) {
 665                 rets = -EINVAL;
 666                 goto out;
 667         }
 668
 669         me_cl->mei_flow_ctrl_creds++;
 670         dev_dbg(dev->dev, "recv flow ctrl msg ME %d (single) creds = %d.\n",
 671             flow->me_addr, me_cl->mei_flow_ctrl_creds);
 672
 673         rets = 0;
 674 out:
 675         mei_me_cl_put(me_cl);
 676         return rets;
 677 }
 678
 679 /**
 680  * mei_hbm_cl_flow_control_res - flow control response from me
 681  *
 682  * @dev: the device structure
 683  * @flow_control: flow control response bus message
 684  */
 685 static void mei_hbm_cl_flow_control_res(struct mei_device *dev,
 686                                         struct hbm_flow_control *flow_control)
 687 {
 688         struct mei_cl *cl;
 689
 690         if (!flow_control->host_addr) {
 691                 /* single receive buffer */
 692                 mei_hbm_add_single_flow_creds(dev, flow_control);
 693                 return;
 694         }
 695
 696         cl = mei_hbm_cl_find_by_cmd(dev, flow_control);
 697         if (cl) {
 698                 cl->mei_flow_ctrl_creds++;
 699                 cl_dbg(dev, cl, "flow control creds = %d.\n",
 700                                 cl->mei_flow_ctrl_creds);
 701         }
 702 }
 703
 704
 705 /**
 706  * mei_hbm_cl_disconnect_req - sends disconnect message to fw.
 707  *
 708  * @dev: the device structure
 709  * @cl: a client to disconnect from
 710  *
 711  * Return: -EIO on write failure
 712  */
 713 int mei_hbm_cl_disconnect_req(struct mei_device *dev, struct mei_cl *cl)
 714 {
 715         const size_t len = sizeof(struct hbm_client_connect_request);
 716
 717         return mei_hbm_cl_write(dev, cl, CLIENT_DISCONNECT_REQ_CMD, len);
 718 }
 719
 720 /**
 721  * mei_hbm_cl_disconnect_rsp - sends disconnect respose to the FW
 722  *
 723  * @dev: the device structure
 724  * @cl: a client to disconnect from
 725  *
 726  * Return: -EIO on write failure
 727  */
 728 int mei_hbm_cl_disconnect_rsp(struct mei_device *dev, struct mei_cl *cl)
 729 {
 730         const size_t len = sizeof(struct hbm_client_connect_response);
 731
 732         return mei_hbm_cl_write(dev, cl, CLIENT_DISCONNECT_RES_CMD, len);
 733 }
 734
 735 /**
 736  * mei_hbm_cl_disconnect_res - update the client state according
 737  *       disconnect response
 738  *
 739  * @dev: the device structure
 740  * @cl: mei host client
 741  * @cmd: disconnect client response host bus message
 742  */
 743 static void mei_hbm_cl_disconnect_res(struct mei_device *dev, struct mei_cl *cl,
 744                                       struct mei_hbm_cl_cmd *cmd)
 745 {
 746         struct hbm_client_connect_response *rs =
 747                 (struct hbm_client_connect_response *)cmd;
 748
 749         cl_dbg(dev, cl, "hbm: disconnect response status=%d\n", rs->status);
 750
 751         if (rs->status == MEI_CL_DISCONN_SUCCESS)
 752                 cl->state = MEI_FILE_DISCONNECT_REPLY;
 753         cl->status = 0;
 754 }
 755
 756 /**
 757  * mei_hbm_cl_connect_req - send connection request to specific me client
 758  *
 759  * @dev: the device structure
 760  * @cl: a client to connect to
 761  *
 762  * Return: -EIO on write failure
 763  */
 764 int mei_hbm_cl_connect_req(struct mei_device *dev, struct mei_cl *cl)
 765 {
 766         const size_t len = sizeof(struct hbm_client_connect_request);
 767
 768         return mei_hbm_cl_write(dev, cl, CLIENT_CONNECT_REQ_CMD, len);
 769 }
 770
 771 /**
 772  * mei_hbm_cl_connect_res - update the client state according
 773  *        connection response
 774  *
 775  * @dev: the device structure
 776  * @cl: mei host client
 777  * @cmd: connect client response host bus message
 778  */
 779 static void mei_hbm_cl_connect_res(struct mei_device *dev, struct mei_cl *cl,
 780                                    struct mei_hbm_cl_cmd *cmd)
 781 {
 782         struct hbm_client_connect_response *rs =
 783                 (struct hbm_client_connect_response *)cmd;
 784
 785         cl_dbg(dev, cl, "hbm: connect response status=%s\n",
 786                         mei_cl_conn_status_str(rs->status));
 787
 788         if (rs->status == MEI_CL_CONN_SUCCESS)
 789                 cl->state = MEI_FILE_CONNECTED;
 790         else {
 791                 cl->state = MEI_FILE_DISCONNECT_REPLY;
 792                 if (rs->status == MEI_CL_CONN_NOT_FOUND)
 793                         mei_me_cl_del(dev, cl->me_cl);
 794         }
 795         cl->status = mei_cl_conn_status_to_errno(rs->status);
 796 }
 797
 798 /**
 799  * mei_hbm_cl_res - process hbm response received on behalf
 800  *         an client
 801  *
 802  * @dev: the device structure
 803  * @rs:  hbm client message
 804  * @fop_type: file operation type
 805  */
 806 static void mei_hbm_cl_res(struct mei_device *dev,
 807                            struct mei_hbm_cl_cmd *rs,
 808                            enum mei_cb_file_ops fop_type)
 809 {
 810         struct mei_cl *cl;
 811         struct mei_cl_cb *cb, *next;
 812
 813         cl = NULL;
 814         list_for_each_entry_safe(cb, next, &dev->ctrl_rd_list.list, list) {
 815
 816                 cl = cb->cl;
 817
 818                 if (cb->fop_type != fop_type)
 819                         continue;
 820
 821                 if (mei_hbm_cl_addr_equal(cl, rs)) {
 822                         list_del_init(&cb->list);
 823                         break;
 824                 }
 825         }
 826
 827         if (!cl)
 828                 return;
 829
 830         switch (fop_type) {
 831         case MEI_FOP_CONNECT:
 832                 mei_hbm_cl_connect_res(dev, cl, rs);
 833                 break;
 834         case MEI_FOP_DISCONNECT:
 835                 mei_hbm_cl_disconnect_res(dev, cl, rs);
 836                 break;
 837         case MEI_FOP_NOTIFY_START:
 838                 mei_hbm_cl_notify_start_res(dev, cl, rs);
 839                 break;
 840         case MEI_FOP_NOTIFY_STOP:
 841                 mei_hbm_cl_notify_stop_res(dev, cl, rs);
 842                 break;
 843         default:
 844                 return;
 845         }
 846
 847         cl->timer_count = 0;
 848         wake_up(&cl->wait);
 849 }
 850
 851
 852 /**
 853  * mei_hbm_fw_disconnect_req - disconnect request initiated by ME firmware
 854  *  host sends disconnect response
 855  *
 856  * @dev: the device structure.
 857  * @disconnect_req: disconnect request bus message from the me
 858  *
 859  * Return: -ENOMEM on allocation failure
 860  */
 861 static int mei_hbm_fw_disconnect_req(struct mei_device *dev,
 862                 struct hbm_client_connect_request *disconnect_req)
 863 {
 864         struct mei_cl *cl;
 865         struct mei_cl_cb *cb;
 866
 867         cl = mei_hbm_cl_find_by_cmd(dev, disconnect_req);
 868         if (cl) {
 869                 cl_dbg(dev, cl, "fw disconnect request received\n");
 870                 cl->state = MEI_FILE_DISCONNECTING;
 871                 cl->timer_count = 0;
 872
 873                 cb = mei_io_cb_init(cl, MEI_FOP_DISCONNECT_RSP, NULL);
 874                 if (!cb)
 875                         return -ENOMEM;
 876                 cl_dbg(dev, cl, "add disconnect response as first\n");
 877                 list_add(&cb->list, &dev->ctrl_wr_list.list);
 878         }
 879         return 0;
 880 }
 881
 882 /**
 883  * mei_hbm_config_features - check what hbm features and commands
 884  *        are supported by the fw
 885  *
 886  * @dev: the device structure
 887  */
 888 static void mei_hbm_config_features(struct mei_device *dev)
 889 {
 890         /* Power Gating Isolation Support */
 891         dev->hbm_f_pg_supported = 0;
 892         if (dev->version.major_version > HBM_MAJOR_VERSION_PGI)
 893                 dev->hbm_f_pg_supported = 1;
 894
 895         if (dev->version.major_version == HBM_MAJOR_VERSION_PGI &&
 896             dev->version.minor_version >= HBM_MINOR_VERSION_PGI)
 897                 dev->hbm_f_pg_supported = 1;
 898
 899         if (dev->version.major_version >= HBM_MAJOR_VERSION_DC)
 900                 dev->hbm_f_dc_supported = 1;
 901
 902         /* disconnect on connect timeout instead of link reset */
 903         if (dev->version.major_version >= HBM_MAJOR_VERSION_DOT)
 904                 dev->hbm_f_dot_supported = 1;
 905
 906         /* Notification Event Support */
 907         if (dev->version.major_version >= HBM_MAJOR_VERSION_EV)
 908                 dev->hbm_f_ev_supported = 1;
 909 }
 910
 911 /**
 912  * mei_hbm_version_is_supported - checks whether the driver can
 913  *     support the hbm version of the device
 914  *
 915  * @dev: the device structure
 916  * Return: true if driver can support hbm version of the device
 917  */
 918 bool mei_hbm_version_is_supported(struct mei_device *dev)
 919 {
 920         return  (dev->version.major_version < HBM_MAJOR_VERSION) ||
 921                 (dev->version.major_version == HBM_MAJOR_VERSION &&
 922                  dev->version.minor_version <= HBM_MINOR_VERSION);
 923 }
 924
 925 /**
 926  * mei_hbm_dispatch - bottom half read routine after ISR to
 927  * handle the read bus message cmd processing.
 928  *
 929  * @dev: the device structure
 930  * @hdr: header of bus message
 931  *
 932  * Return: 0 on success and < 0 on failure
 933  */
 934 int mei_hbm_dispatch(struct mei_device *dev, struct mei_msg_hdr *hdr)
 935 {
 936         struct mei_bus_message *mei_msg;
 937         struct hbm_host_version_response *version_res;
 938         struct hbm_props_response *props_res;
 939         struct hbm_host_enum_response *enum_res;
 940         struct hbm_add_client_request *add_cl_req;
 941         int ret;
 942
 943         struct mei_hbm_cl_cmd *cl_cmd;
 944         struct hbm_client_connect_request *disconnect_req;
 945         struct hbm_flow_control *flow_control;
 946
 947         /* read the message to our buffer */
 948         BUG_ON(hdr->length >= sizeof(dev->rd_msg_buf));
 949         mei_read_slots(dev, dev->rd_msg_buf, hdr->length);
 950         mei_msg = (struct mei_bus_message *)dev->rd_msg_buf;
 951         cl_cmd  = (struct mei_hbm_cl_cmd *)mei_msg;
 952
 953         /* ignore spurious message and prevent reset nesting
 954          * hbm is put to idle during system reset
 955          */
 956         if (dev->hbm_state == MEI_HBM_IDLE) {
 957                 dev_dbg(dev->dev, "hbm: state is idle ignore spurious messages\n");
 958                 return 0;
 959         }
 960
 961         switch (mei_msg->hbm_cmd) {
 962         case HOST_START_RES_CMD:
 963                 dev_dbg(dev->dev, "hbm: start: response message received.\n");
 964
 965                 dev->init_clients_timer = 0;
 966
 967                 version_res = (struct hbm_host_version_response *)mei_msg;
 968
 969                 dev_dbg(dev->dev, "HBM VERSION: DRIVER=%02d:%02d DEVICE=%02d:%02d\n",
 970                                 HBM_MAJOR_VERSION, HBM_MINOR_VERSION,
 971                                 version_res->me_max_version.major_version,
 972                                 version_res->me_max_version.minor_version);
 973
 974                 if (version_res->host_version_supported) {
 975                         dev->version.major_version = HBM_MAJOR_VERSION;
 976                         dev->version.minor_version = HBM_MINOR_VERSION;
 977                 } else {
 978                         dev->version.major_version =
 979                                 version_res->me_max_version.major_version;
 980                         dev->version.minor_version =
 981                                 version_res->me_max_version.minor_version;
 982                 }
 983
 984                 if (!mei_hbm_version_is_supported(dev)) {
 985                         dev_warn(dev->dev, "hbm: start: version mismatch - stopping the driver.\n");
 986
 987                         dev->hbm_state = MEI_HBM_STOPPED;
 988                         if (mei_hbm_stop_req(dev)) {
 989                                 dev_err(dev->dev, "hbm: start: failed to send stop request\n");
 990                                 return -EIO;
 991                         }
 992                         break;
 993                 }
 994
 995                 mei_hbm_config_features(dev);
 996
 997                 if (dev->dev_state != MEI_DEV_INIT_CLIENTS ||
 998                     dev->hbm_state != MEI_HBM_STARTING) {
 999                         dev_err(dev->dev, "hbm: start: state mismatch, [%d, %d]\n",
1000                                 dev->dev_state, dev->hbm_state);
1001                         return -EPROTO;
1002                 }
1003
1004                 if (mei_hbm_enum_clients_req(dev)) {
1005                         dev_err(dev->dev, "hbm: start: failed to send enumeration request\n");
1006                         return -EIO;
1007                 }
1008
1009                 wake_up(&dev->wait_hbm_start);
1010                 break;
1011
1012         case CLIENT_CONNECT_RES_CMD:
1013                 dev_dbg(dev->dev, "hbm: client connect response: message received.\n");
1014                 mei_hbm_cl_res(dev, cl_cmd, MEI_FOP_CONNECT);
1015                 break;
1016
1017         case CLIENT_DISCONNECT_RES_CMD:
1018                 dev_dbg(dev->dev, "hbm: client disconnect response: message received.\n");
1019                 mei_hbm_cl_res(dev, cl_cmd, MEI_FOP_DISCONNECT);
1020                 break;
1021
1022         case MEI_FLOW_CONTROL_CMD:
1023                 dev_dbg(dev->dev, "hbm: client flow control response: message received.\n");
1024
1025                 flow_control = (struct hbm_flow_control *) mei_msg;
1026                 mei_hbm_cl_flow_control_res(dev, flow_control);
1027                 break;
1028
1029         case MEI_PG_ISOLATION_ENTRY_RES_CMD:
1030                 dev_dbg(dev->dev, "power gate isolation entry response received\n");
1031                 dev->pg_event = MEI_PG_EVENT_RECEIVED;
1032                 if (waitqueue_active(&dev->wait_pg))
1033                         wake_up(&dev->wait_pg);
1034                 break;
1035
1036         case MEI_PG_ISOLATION_EXIT_REQ_CMD:
1037                 dev_dbg(dev->dev, "power gate isolation exit request received\n");
1038                 dev->pg_event = MEI_PG_EVENT_RECEIVED;
1039                 if (waitqueue_active(&dev->wait_pg))
1040                         wake_up(&dev->wait_pg);
1041                 else
1042                         /*
1043                         * If the driver is not waiting on this then
1044                         * this is HW initiated exit from PG.
1045                         * Start runtime pm resume sequence to exit from PG.
1046                         */
1047                         pm_request_resume(dev->dev);
1048                 break;
1049
1050         case HOST_CLIENT_PROPERTIES_RES_CMD:
1051                 dev_dbg(dev->dev, "hbm: properties response: message received.\n");
1052
1053                 dev->init_clients_timer = 0;
1054
1055                 if (dev->dev_state != MEI_DEV_INIT_CLIENTS ||
1056                     dev->hbm_state != MEI_HBM_CLIENT_PROPERTIES) {
1057                         dev_err(dev->dev, "hbm: properties response: state mismatch, [%d, %d]\n",
1058                                 dev->dev_state, dev->hbm_state);
1059                         return -EPROTO;
1060                 }
1061
1062                 props_res = (struct hbm_props_response *)mei_msg;
1063
1064                 if (props_res->status) {
1065                         dev_err(dev->dev, "hbm: properties response: wrong status = %d %s\n",
1066                                 props_res->status,
1067                                 mei_hbm_status_str(props_res->status));
1068                         return -EPROTO;
1069                 }
1070
1071                 mei_hbm_me_cl_add(dev, props_res);
1072
1073                 dev->me_client_index++;
1074
1075                 /* request property for the next client */
1076                 if (mei_hbm_prop_req(dev))
1077                         return -EIO;
1078
1079                 break;
1080
1081         case HOST_ENUM_RES_CMD:
1082                 dev_dbg(dev->dev, "hbm: enumeration response: message received\n");
1083
1084                 dev->init_clients_timer = 0;
1085
1086                 enum_res = (struct hbm_host_enum_response *) mei_msg;
1087                 BUILD_BUG_ON(sizeof(dev->me_clients_map)
1088                                 < sizeof(enum_res->valid_addresses));
1089                 memcpy(dev->me_clients_map, enum_res->valid_addresses,
1090                                 sizeof(enum_res->valid_addresses));
1091
1092                 if (dev->dev_state != MEI_DEV_INIT_CLIENTS ||
1093                     dev->hbm_state != MEI_HBM_ENUM_CLIENTS) {
1094                         dev_err(dev->dev, "hbm: enumeration response: state mismatch, [%d, %d]\n",
1095                                 dev->dev_state, dev->hbm_state);
1096                         return -EPROTO;
1097                 }
1098
1099                 dev->hbm_state = MEI_HBM_CLIENT_PROPERTIES;
1100
1101                 /* first property request */
1102                 if (mei_hbm_prop_req(dev))
1103                         return -EIO;
1104
1105                 break;
1106
1107         case HOST_STOP_RES_CMD:
1108                 dev_dbg(dev->dev, "hbm: stop response: message received\n");
1109
1110                 dev->init_clients_timer = 0;
1111
1112                 if (dev->hbm_state != MEI_HBM_STOPPED) {
1113                         dev_err(dev->dev, "hbm: stop response: state mismatch, [%d, %d]\n",
1114                                 dev->dev_state, dev->hbm_state);
1115                         return -EPROTO;
1116                 }
1117
1118                 dev->dev_state = MEI_DEV_POWER_DOWN;
1119                 dev_info(dev->dev, "hbm: stop response: resetting.\n");
1120                 /* force the reset */
1121                 return -EPROTO;
1122                 break;
1123
1124         case CLIENT_DISCONNECT_REQ_CMD:
1125                 dev_dbg(dev->dev, "hbm: disconnect request: message received\n");
1126
1127                 disconnect_req = (struct hbm_client_connect_request *)mei_msg;
1128                 mei_hbm_fw_disconnect_req(dev, disconnect_req);
1129                 break;
1130
1131         case ME_STOP_REQ_CMD:
1132                 dev_dbg(dev->dev, "hbm: stop request: message received\n");
1133                 dev->hbm_state = MEI_HBM_STOPPED;
1134                 if (mei_hbm_stop_req(dev)) {
1135                         dev_err(dev->dev, "hbm: stop request: failed to send stop request\n");
1136                         return -EIO;
1137                 }
1138                 break;
1139
1140         case MEI_HBM_ADD_CLIENT_REQ_CMD:
1141                 dev_dbg(dev->dev, "hbm: add client request received\n");
1142                 /*
1143                  * after the host receives the enum_resp
1144                  * message clients may be added or removed
1145                  */
1146                 if (dev->hbm_state <= MEI_HBM_ENUM_CLIENTS &&
1147                     dev->hbm_state >= MEI_HBM_STOPPED) {
1148                         dev_err(dev->dev, "hbm: add client: state mismatch, [%d, %d]\n",
1149                                 dev->dev_state, dev->hbm_state);
1150                         return -EPROTO;
1151                 }
1152                 add_cl_req = (struct hbm_add_client_request *)mei_msg;
1153                 ret = mei_hbm_fw_add_cl_req(dev, add_cl_req);
1154                 if (ret) {
1155                         dev_err(dev->dev, "hbm: add client: failed to send response %d\n",
1156                                 ret);
1157                         return -EIO;
1158                 }
1159                 dev_dbg(dev->dev, "hbm: add client request processed\n");
1160                 break;
1161
1162         case MEI_HBM_NOTIFY_RES_CMD:
1163                 dev_dbg(dev->dev, "hbm: notify response received\n");
1164                 mei_hbm_cl_res(dev, cl_cmd, notify_res_to_fop(cl_cmd));
1165                 break;
1166
1167         case MEI_HBM_NOTIFICATION_CMD:
1168                 dev_dbg(dev->dev, "hbm: notification\n");
1169                 mei_hbm_cl_notify(dev, cl_cmd);
1170                 break;
1171
1172         default:
1173                 BUG();
1174                 break;
1175
1176         }
1177         return 0;
1178 }
1179