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_prop_req - request property for a single client
 407  *
 408  * @dev: the device structure
 409  *
 410  * Return: 0 on success and < 0 on failure
 411  */
 412
 413 static int mei_hbm_prop_req(struct mei_device *dev)
 414 {
 415
 416         struct mei_msg_hdr *mei_hdr = &dev->wr_msg.hdr;
 417         struct hbm_props_request *prop_req;
 418         const size_t len = sizeof(struct hbm_props_request);
 419         unsigned long next_client_index;
 420         int ret;
 421
 422         next_client_index = find_next_bit(dev->me_clients_map, MEI_CLIENTS_MAX,
 423                                           dev->me_client_index);
 424
 425         /* We got all client properties */
 426         if (next_client_index == MEI_CLIENTS_MAX) {
 427                 dev->hbm_state = MEI_HBM_STARTED;
 428                 schedule_work(&dev->init_work);
 429
 430                 return 0;
 431         }
 432
 433         mei_hbm_hdr(mei_hdr, len);
 434         prop_req = (struct hbm_props_request *)dev->wr_msg.data;
 435
 436         memset(prop_req, 0, sizeof(struct hbm_props_request));
 437
 438         prop_req->hbm_cmd = HOST_CLIENT_PROPERTIES_REQ_CMD;
 439         prop_req->me_addr = next_client_index;
 440
 441         ret = mei_write_message(dev, mei_hdr, dev->wr_msg.data);
 442         if (ret) {
 443                 dev_err(dev->dev, "properties request write failed: ret = %d\n",
 444                         ret);
 445                 return ret;
 446         }
 447
 448         dev->init_clients_timer = MEI_CLIENTS_INIT_TIMEOUT;
 449         dev->me_client_index = next_client_index;
 450
 451         return 0;
 452 }
 453
 454 /*
 455  * mei_hbm_pg - sends pg command
 456  *
 457  * @dev: the device structure
 458  * @pg_cmd: the pg command code
 459  *
 460  * Return: -EIO on write failure
 461  *         -EOPNOTSUPP if the operation is not supported by the protocol
 462  */
 463 int mei_hbm_pg(struct mei_device *dev, u8 pg_cmd)
 464 {
 465         struct mei_msg_hdr *mei_hdr = &dev->wr_msg.hdr;
 466         struct hbm_power_gate *req;
 467         const size_t len = sizeof(struct hbm_power_gate);
 468         int ret;
 469
 470         if (!dev->hbm_f_pg_supported)
 471                 return -EOPNOTSUPP;
 472
 473         mei_hbm_hdr(mei_hdr, len);
 474
 475         req = (struct hbm_power_gate *)dev->wr_msg.data;
 476         memset(req, 0, len);
 477         req->hbm_cmd = pg_cmd;
 478
 479         ret = mei_write_message(dev, mei_hdr, dev->wr_msg.data);
 480         if (ret)
 481                 dev_err(dev->dev, "power gate command write failed.\n");
 482         return ret;
 483 }
 484 EXPORT_SYMBOL_GPL(mei_hbm_pg);
 485
 486 /**
 487  * mei_hbm_stop_req - send stop request message
 488  *
 489  * @dev: mei device
 490  *
 491  * Return: -EIO on write failure
 492  */
 493 static int mei_hbm_stop_req(struct mei_device *dev)
 494 {
 495         struct mei_msg_hdr *mei_hdr = &dev->wr_msg.hdr;
 496         struct hbm_host_stop_request *req =
 497                         (struct hbm_host_stop_request *)dev->wr_msg.data;
 498         const size_t len = sizeof(struct hbm_host_stop_request);
 499
 500         mei_hbm_hdr(mei_hdr, len);
 501
 502         memset(req, 0, len);
 503         req->hbm_cmd = HOST_STOP_REQ_CMD;
 504         req->reason = DRIVER_STOP_REQUEST;
 505
 506         return mei_write_message(dev, mei_hdr, dev->wr_msg.data);
 507 }
 508
 509 /**
 510  * mei_hbm_cl_flow_control_req - sends flow control request.
 511  *
 512  * @dev: the device structure
 513  * @cl: client info
 514  *
 515  * Return: -EIO on write failure
 516  */
 517 int mei_hbm_cl_flow_control_req(struct mei_device *dev, struct mei_cl *cl)
 518 {
 519         const size_t len = sizeof(struct hbm_flow_control);
 520
 521         cl_dbg(dev, cl, "sending flow control\n");
 522         return mei_hbm_cl_write(dev, cl, MEI_FLOW_CONTROL_CMD, len);
 523 }
 524
 525 /**
 526  * mei_hbm_add_single_flow_creds - adds single buffer credentials.
 527  *
 528  * @dev: the device structure
 529  * @flow: flow control.
 530  *
 531  * Return: 0 on success, < 0 otherwise
 532  */
 533 static int mei_hbm_add_single_flow_creds(struct mei_device *dev,
 534                                   struct hbm_flow_control *flow)
 535 {
 536         struct mei_me_client *me_cl;
 537         int rets;
 538
 539         me_cl = mei_me_cl_by_id(dev, flow->me_addr);
 540         if (!me_cl) {
 541                 dev_err(dev->dev, "no such me client %d\n",
 542                         flow->me_addr);
 543                 return -ENOENT;
 544         }
 545
 546         if (WARN_ON(me_cl->props.single_recv_buf == 0)) {
 547                 rets = -EINVAL;
 548                 goto out;
 549         }
 550
 551         me_cl->mei_flow_ctrl_creds++;
 552         dev_dbg(dev->dev, "recv flow ctrl msg ME %d (single) creds = %d.\n",
 553             flow->me_addr, me_cl->mei_flow_ctrl_creds);
 554
 555         rets = 0;
 556 out:
 557         mei_me_cl_put(me_cl);
 558         return rets;
 559 }
 560
 561 /**
 562  * mei_hbm_cl_flow_control_res - flow control response from me
 563  *
 564  * @dev: the device structure
 565  * @flow_control: flow control response bus message
 566  */
 567 static void mei_hbm_cl_flow_control_res(struct mei_device *dev,
 568                                         struct hbm_flow_control *flow_control)
 569 {
 570         struct mei_cl *cl;
 571
 572         if (!flow_control->host_addr) {
 573                 /* single receive buffer */
 574                 mei_hbm_add_single_flow_creds(dev, flow_control);
 575                 return;
 576         }
 577
 578         cl = mei_hbm_cl_find_by_cmd(dev, flow_control);
 579         if (cl) {
 580                 cl->mei_flow_ctrl_creds++;
 581                 cl_dbg(dev, cl, "flow control creds = %d.\n",
 582                                 cl->mei_flow_ctrl_creds);
 583         }
 584 }
 585
 586
 587 /**
 588  * mei_hbm_cl_disconnect_req - sends disconnect message to fw.
 589  *
 590  * @dev: the device structure
 591  * @cl: a client to disconnect from
 592  *
 593  * Return: -EIO on write failure
 594  */
 595 int mei_hbm_cl_disconnect_req(struct mei_device *dev, struct mei_cl *cl)
 596 {
 597         const size_t len = sizeof(struct hbm_client_connect_request);
 598
 599         return mei_hbm_cl_write(dev, cl, CLIENT_DISCONNECT_REQ_CMD, len);
 600 }
 601
 602 /**
 603  * mei_hbm_cl_disconnect_rsp - sends disconnect respose to the FW
 604  *
 605  * @dev: the device structure
 606  * @cl: a client to disconnect from
 607  *
 608  * Return: -EIO on write failure
 609  */
 610 int mei_hbm_cl_disconnect_rsp(struct mei_device *dev, struct mei_cl *cl)
 611 {
 612         const size_t len = sizeof(struct hbm_client_connect_response);
 613
 614         return mei_hbm_cl_write(dev, cl, CLIENT_DISCONNECT_RES_CMD, len);
 615 }
 616
 617 /**
 618  * mei_hbm_cl_disconnect_res - update the client state according
 619  *       disconnect response
 620  *
 621  * @dev: the device structure
 622  * @cl: mei host client
 623  * @cmd: disconnect client response host bus message
 624  */
 625 static void mei_hbm_cl_disconnect_res(struct mei_device *dev, struct mei_cl *cl,
 626                                       struct mei_hbm_cl_cmd *cmd)
 627 {
 628         struct hbm_client_connect_response *rs =
 629                 (struct hbm_client_connect_response *)cmd;
 630
 631         cl_dbg(dev, cl, "hbm: disconnect response status=%d\n", rs->status);
 632
 633         if (rs->status == MEI_CL_DISCONN_SUCCESS)
 634                 cl->state = MEI_FILE_DISCONNECT_REPLY;
 635         cl->status = 0;
 636 }
 637
 638 /**
 639  * mei_hbm_cl_connect_req - send connection request to specific me client
 640  *
 641  * @dev: the device structure
 642  * @cl: a client to connect to
 643  *
 644  * Return: -EIO on write failure
 645  */
 646 int mei_hbm_cl_connect_req(struct mei_device *dev, struct mei_cl *cl)
 647 {
 648         const size_t len = sizeof(struct hbm_client_connect_request);
 649
 650         return mei_hbm_cl_write(dev, cl, CLIENT_CONNECT_REQ_CMD, len);
 651 }
 652
 653 /**
 654  * mei_hbm_cl_connect_res - update the client state according
 655  *        connection response
 656  *
 657  * @dev: the device structure
 658  * @cl: mei host client
 659  * @cmd: connect client response host bus message
 660  */
 661 static void mei_hbm_cl_connect_res(struct mei_device *dev, struct mei_cl *cl,
 662                                    struct mei_hbm_cl_cmd *cmd)
 663 {
 664         struct hbm_client_connect_response *rs =
 665                 (struct hbm_client_connect_response *)cmd;
 666
 667         cl_dbg(dev, cl, "hbm: connect response status=%s\n",
 668                         mei_cl_conn_status_str(rs->status));
 669
 670         if (rs->status == MEI_CL_CONN_SUCCESS)
 671                 cl->state = MEI_FILE_CONNECTED;
 672         else {
 673                 cl->state = MEI_FILE_DISCONNECT_REPLY;
 674                 if (rs->status == MEI_CL_CONN_NOT_FOUND)
 675                         mei_me_cl_del(dev, cl->me_cl);
 676         }
 677         cl->status = mei_cl_conn_status_to_errno(rs->status);
 678 }
 679
 680 /**
 681  * mei_hbm_cl_res - process hbm response received on behalf
 682  *         an client
 683  *
 684  * @dev: the device structure
 685  * @rs:  hbm client message
 686  * @fop_type: file operation type
 687  */
 688 static void mei_hbm_cl_res(struct mei_device *dev,
 689                            struct mei_hbm_cl_cmd *rs,
 690                            enum mei_cb_file_ops fop_type)
 691 {
 692         struct mei_cl *cl;
 693         struct mei_cl_cb *cb, *next;
 694
 695         cl = NULL;
 696         list_for_each_entry_safe(cb, next, &dev->ctrl_rd_list.list, list) {
 697
 698                 cl = cb->cl;
 699
 700                 if (cb->fop_type != fop_type)
 701                         continue;
 702
 703                 if (mei_hbm_cl_addr_equal(cl, rs)) {
 704                         list_del_init(&cb->list);
 705                         break;
 706                 }
 707         }
 708
 709         if (!cl)
 710                 return;
 711
 712         switch (fop_type) {
 713         case MEI_FOP_CONNECT:
 714                 mei_hbm_cl_connect_res(dev, cl, rs);
 715                 break;
 716         case MEI_FOP_DISCONNECT:
 717                 mei_hbm_cl_disconnect_res(dev, cl, rs);
 718                 break;
 719         default:
 720                 return;
 721         }
 722
 723         cl->timer_count = 0;
 724         wake_up(&cl->wait);
 725 }
 726
 727
 728 /**
 729  * mei_hbm_fw_disconnect_req - disconnect request initiated by ME firmware
 730  *  host sends disconnect response
 731  *
 732  * @dev: the device structure.
 733  * @disconnect_req: disconnect request bus message from the me
 734  *
 735  * Return: -ENOMEM on allocation failure
 736  */
 737 static int mei_hbm_fw_disconnect_req(struct mei_device *dev,
 738                 struct hbm_client_connect_request *disconnect_req)
 739 {
 740         struct mei_cl *cl;
 741         struct mei_cl_cb *cb;
 742
 743         cl = mei_hbm_cl_find_by_cmd(dev, disconnect_req);
 744         if (cl) {
 745                 cl_dbg(dev, cl, "fw disconnect request received\n");
 746                 cl->state = MEI_FILE_DISCONNECTING;
 747                 cl->timer_count = 0;
 748
 749                 cb = mei_io_cb_init(cl, MEI_FOP_DISCONNECT_RSP, NULL);
 750                 if (!cb)
 751                         return -ENOMEM;
 752                 cl_dbg(dev, cl, "add disconnect response as first\n");
 753                 list_add(&cb->list, &dev->ctrl_wr_list.list);
 754         }
 755         return 0;
 756 }
 757
 758 /**
 759  * mei_hbm_config_features - check what hbm features and commands
 760  *        are supported by the fw
 761  *
 762  * @dev: the device structure
 763  */
 764 static void mei_hbm_config_features(struct mei_device *dev)
 765 {
 766         /* Power Gating Isolation Support */
 767         dev->hbm_f_pg_supported = 0;
 768         if (dev->version.major_version > HBM_MAJOR_VERSION_PGI)
 769                 dev->hbm_f_pg_supported = 1;
 770
 771         if (dev->version.major_version == HBM_MAJOR_VERSION_PGI &&
 772             dev->version.minor_version >= HBM_MINOR_VERSION_PGI)
 773                 dev->hbm_f_pg_supported = 1;
 774
 775         if (dev->version.major_version >= HBM_MAJOR_VERSION_DC)
 776                 dev->hbm_f_dc_supported = 1;
 777 }
 778
 779 /**
 780  * mei_hbm_version_is_supported - checks whether the driver can
 781  *     support the hbm version of the device
 782  *
 783  * @dev: the device structure
 784  * Return: true if driver can support hbm version of the device
 785  */
 786 bool mei_hbm_version_is_supported(struct mei_device *dev)
 787 {
 788         return  (dev->version.major_version < HBM_MAJOR_VERSION) ||
 789                 (dev->version.major_version == HBM_MAJOR_VERSION &&
 790                  dev->version.minor_version <= HBM_MINOR_VERSION);
 791 }
 792
 793 /**
 794  * mei_hbm_dispatch - bottom half read routine after ISR to
 795  * handle the read bus message cmd processing.
 796  *
 797  * @dev: the device structure
 798  * @hdr: header of bus message
 799  *
 800  * Return: 0 on success and < 0 on failure
 801  */
 802 int mei_hbm_dispatch(struct mei_device *dev, struct mei_msg_hdr *hdr)
 803 {
 804         struct mei_bus_message *mei_msg;
 805         struct hbm_host_version_response *version_res;
 806         struct hbm_props_response *props_res;
 807         struct hbm_host_enum_response *enum_res;
 808         struct hbm_add_client_request *add_cl_req;
 809         int ret;
 810
 811         struct mei_hbm_cl_cmd *cl_cmd;
 812         struct hbm_client_connect_request *disconnect_req;
 813         struct hbm_flow_control *flow_control;
 814
 815         /* read the message to our buffer */
 816         BUG_ON(hdr->length >= sizeof(dev->rd_msg_buf));
 817         mei_read_slots(dev, dev->rd_msg_buf, hdr->length);
 818         mei_msg = (struct mei_bus_message *)dev->rd_msg_buf;
 819         cl_cmd  = (struct mei_hbm_cl_cmd *)mei_msg;
 820
 821         /* ignore spurious message and prevent reset nesting
 822          * hbm is put to idle during system reset
 823          */
 824         if (dev->hbm_state == MEI_HBM_IDLE) {
 825                 dev_dbg(dev->dev, "hbm: state is idle ignore spurious messages\n");
 826                 return 0;
 827         }
 828
 829         switch (mei_msg->hbm_cmd) {
 830         case HOST_START_RES_CMD:
 831                 dev_dbg(dev->dev, "hbm: start: response message received.\n");
 832
 833                 dev->init_clients_timer = 0;
 834
 835                 version_res = (struct hbm_host_version_response *)mei_msg;
 836
 837                 dev_dbg(dev->dev, "HBM VERSION: DRIVER=%02d:%02d DEVICE=%02d:%02d\n",
 838                                 HBM_MAJOR_VERSION, HBM_MINOR_VERSION,
 839                                 version_res->me_max_version.major_version,
 840                                 version_res->me_max_version.minor_version);
 841
 842                 if (version_res->host_version_supported) {
 843                         dev->version.major_version = HBM_MAJOR_VERSION;
 844                         dev->version.minor_version = HBM_MINOR_VERSION;
 845                 } else {
 846                         dev->version.major_version =
 847                                 version_res->me_max_version.major_version;
 848                         dev->version.minor_version =
 849                                 version_res->me_max_version.minor_version;
 850                 }
 851
 852                 if (!mei_hbm_version_is_supported(dev)) {
 853                         dev_warn(dev->dev, "hbm: start: version mismatch - stopping the driver.\n");
 854
 855                         dev->hbm_state = MEI_HBM_STOPPED;
 856                         if (mei_hbm_stop_req(dev)) {
 857                                 dev_err(dev->dev, "hbm: start: failed to send stop request\n");
 858                                 return -EIO;
 859                         }
 860                         break;
 861                 }
 862
 863                 mei_hbm_config_features(dev);
 864
 865                 if (dev->dev_state != MEI_DEV_INIT_CLIENTS ||
 866                     dev->hbm_state != MEI_HBM_STARTING) {
 867                         dev_err(dev->dev, "hbm: start: state mismatch, [%d, %d]\n",
 868                                 dev->dev_state, dev->hbm_state);
 869                         return -EPROTO;
 870                 }
 871
 872                 if (mei_hbm_enum_clients_req(dev)) {
 873                         dev_err(dev->dev, "hbm: start: failed to send enumeration request\n");
 874                         return -EIO;
 875                 }
 876
 877                 wake_up(&dev->wait_hbm_start);
 878                 break;
 879
 880         case CLIENT_CONNECT_RES_CMD:
 881                 dev_dbg(dev->dev, "hbm: client connect response: message received.\n");
 882                 mei_hbm_cl_res(dev, cl_cmd, MEI_FOP_CONNECT);
 883                 break;
 884
 885         case CLIENT_DISCONNECT_RES_CMD:
 886                 dev_dbg(dev->dev, "hbm: client disconnect response: message received.\n");
 887                 mei_hbm_cl_res(dev, cl_cmd, MEI_FOP_DISCONNECT);
 888                 break;
 889
 890         case MEI_FLOW_CONTROL_CMD:
 891                 dev_dbg(dev->dev, "hbm: client flow control response: message received.\n");
 892
 893                 flow_control = (struct hbm_flow_control *) mei_msg;
 894                 mei_hbm_cl_flow_control_res(dev, flow_control);
 895                 break;
 896
 897         case MEI_PG_ISOLATION_ENTRY_RES_CMD:
 898                 dev_dbg(dev->dev, "power gate isolation entry response received\n");
 899                 dev->pg_event = MEI_PG_EVENT_RECEIVED;
 900                 if (waitqueue_active(&dev->wait_pg))
 901                         wake_up(&dev->wait_pg);
 902                 break;
 903
 904         case MEI_PG_ISOLATION_EXIT_REQ_CMD:
 905                 dev_dbg(dev->dev, "power gate isolation exit request received\n");
 906                 dev->pg_event = MEI_PG_EVENT_RECEIVED;
 907                 if (waitqueue_active(&dev->wait_pg))
 908                         wake_up(&dev->wait_pg);
 909                 else
 910                         /*
 911                         * If the driver is not waiting on this then
 912                         * this is HW initiated exit from PG.
 913                         * Start runtime pm resume sequence to exit from PG.
 914                         */
 915                         pm_request_resume(dev->dev);
 916                 break;
 917
 918         case HOST_CLIENT_PROPERTIES_RES_CMD:
 919                 dev_dbg(dev->dev, "hbm: properties response: message received.\n");
 920
 921                 dev->init_clients_timer = 0;
 922
 923                 if (dev->dev_state != MEI_DEV_INIT_CLIENTS ||
 924                     dev->hbm_state != MEI_HBM_CLIENT_PROPERTIES) {
 925                         dev_err(dev->dev, "hbm: properties response: state mismatch, [%d, %d]\n",
 926                                 dev->dev_state, dev->hbm_state);
 927                         return -EPROTO;
 928                 }
 929
 930                 props_res = (struct hbm_props_response *)mei_msg;
 931
 932                 if (props_res->status) {
 933                         dev_err(dev->dev, "hbm: properties response: wrong status = %d %s\n",
 934                                 props_res->status,
 935                                 mei_hbm_status_str(props_res->status));
 936                         return -EPROTO;
 937                 }
 938
 939                 mei_hbm_me_cl_add(dev, props_res);
 940
 941                 dev->me_client_index++;
 942
 943                 /* request property for the next client */
 944                 if (mei_hbm_prop_req(dev))
 945                         return -EIO;
 946
 947                 break;
 948
 949         case HOST_ENUM_RES_CMD:
 950                 dev_dbg(dev->dev, "hbm: enumeration response: message received\n");
 951
 952                 dev->init_clients_timer = 0;
 953
 954                 enum_res = (struct hbm_host_enum_response *) mei_msg;
 955                 BUILD_BUG_ON(sizeof(dev->me_clients_map)
 956                                 < sizeof(enum_res->valid_addresses));
 957                 memcpy(dev->me_clients_map, enum_res->valid_addresses,
 958                                 sizeof(enum_res->valid_addresses));
 959
 960                 if (dev->dev_state != MEI_DEV_INIT_CLIENTS ||
 961                     dev->hbm_state != MEI_HBM_ENUM_CLIENTS) {
 962                         dev_err(dev->dev, "hbm: enumeration response: state mismatch, [%d, %d]\n",
 963                                 dev->dev_state, dev->hbm_state);
 964                         return -EPROTO;
 965                 }
 966
 967                 dev->hbm_state = MEI_HBM_CLIENT_PROPERTIES;
 968
 969                 /* first property request */
 970                 if (mei_hbm_prop_req(dev))
 971                         return -EIO;
 972
 973                 break;
 974
 975         case HOST_STOP_RES_CMD:
 976                 dev_dbg(dev->dev, "hbm: stop response: message received\n");
 977
 978                 dev->init_clients_timer = 0;
 979
 980                 if (dev->hbm_state != MEI_HBM_STOPPED) {
 981                         dev_err(dev->dev, "hbm: stop response: state mismatch, [%d, %d]\n",
 982                                 dev->dev_state, dev->hbm_state);
 983                         return -EPROTO;
 984                 }
 985
 986                 dev->dev_state = MEI_DEV_POWER_DOWN;
 987                 dev_info(dev->dev, "hbm: stop response: resetting.\n");
 988                 /* force the reset */
 989                 return -EPROTO;
 990                 break;
 991
 992         case CLIENT_DISCONNECT_REQ_CMD:
 993                 dev_dbg(dev->dev, "hbm: disconnect request: message received\n");
 994
 995                 disconnect_req = (struct hbm_client_connect_request *)mei_msg;
 996                 mei_hbm_fw_disconnect_req(dev, disconnect_req);
 997                 break;
 998
 999         case ME_STOP_REQ_CMD:
1000                 dev_dbg(dev->dev, "hbm: stop request: message received\n");
1001                 dev->hbm_state = MEI_HBM_STOPPED;
1002                 if (mei_hbm_stop_req(dev)) {
1003                         dev_err(dev->dev, "hbm: stop request: failed to send stop request\n");
1004                         return -EIO;
1005                 }
1006                 break;
1007
1008         case MEI_HBM_ADD_CLIENT_REQ_CMD:
1009                 dev_dbg(dev->dev, "hbm: add client request received\n");
1010                 /*
1011                  * after the host receives the enum_resp
1012                  * message clients may be added or removed
1013                  */
1014                 if (dev->hbm_state <= MEI_HBM_ENUM_CLIENTS &&
1015                     dev->hbm_state >= MEI_HBM_STOPPED) {
1016                         dev_err(dev->dev, "hbm: add client: state mismatch, [%d, %d]\n",
1017                                 dev->dev_state, dev->hbm_state);
1018                         return -EPROTO;
1019                 }
1020                 add_cl_req = (struct hbm_add_client_request *)mei_msg;
1021                 ret = mei_hbm_fw_add_cl_req(dev, add_cl_req);
1022                 if (ret) {
1023                         dev_err(dev->dev, "hbm: add client: failed to send response %d\n",
1024                                 ret);
1025                         return -EIO;
1026                 }
1027                 dev_dbg(dev->dev, "hbm: add client request processed\n");
1028                 break;
1029
1030         default:
1031                 BUG();
1032                 break;
1033
1034         }
1035         return 0;
1036 }
1037