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