drivers/platform/chrome/cros_ec_proto.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 // ChromeOS EC communication protocol helper functions
   3 //
   4 // Copyright (C) 2015 Google, Inc
   5
   6 #include <linux/delay.h>
   7 #include <linux/device.h>
   8 #include <linux/module.h>
   9 #include <linux/platform_data/cros_ec_commands.h>
  10 #include <linux/platform_data/cros_ec_proto.h>
  11 #include <linux/slab.h>
  12 #include <asm/unaligned.h>
  13
  14 #include "cros_ec_trace.h"
  15
  16 #define EC_COMMAND_RETRIES      50
  17
  18 static const int cros_ec_error_map[] = {
  19         [EC_RES_INVALID_COMMAND] = -EOPNOTSUPP,
  20         [EC_RES_ERROR] = -EIO,
  21         [EC_RES_INVALID_PARAM] = -EINVAL,
  22         [EC_RES_ACCESS_DENIED] = -EACCES,
  23         [EC_RES_INVALID_RESPONSE] = -EPROTO,
  24         [EC_RES_INVALID_VERSION] = -ENOPROTOOPT,
  25         [EC_RES_INVALID_CHECKSUM] = -EBADMSG,
  26         [EC_RES_IN_PROGRESS] = -EINPROGRESS,
  27         [EC_RES_UNAVAILABLE] = -ENODATA,
  28         [EC_RES_TIMEOUT] = -ETIMEDOUT,
  29         [EC_RES_OVERFLOW] = -EOVERFLOW,
  30         [EC_RES_INVALID_HEADER] = -EBADR,
  31         [EC_RES_REQUEST_TRUNCATED] = -EBADR,
  32         [EC_RES_RESPONSE_TOO_BIG] = -EFBIG,
  33         [EC_RES_BUS_ERROR] = -EFAULT,
  34         [EC_RES_BUSY] = -EBUSY,
  35         [EC_RES_INVALID_HEADER_VERSION] = -EBADMSG,
  36         [EC_RES_INVALID_HEADER_CRC] = -EBADMSG,
  37         [EC_RES_INVALID_DATA_CRC] = -EBADMSG,
  38         [EC_RES_DUP_UNAVAILABLE] = -ENODATA,
  39 };
  40
  41 static int cros_ec_map_error(uint32_t result)
  42 {
  43         int ret = 0;
  44
  45         if (result != EC_RES_SUCCESS) {
  46                 if (result < ARRAY_SIZE(cros_ec_error_map) && cros_ec_error_map[result])
  47                         ret = cros_ec_error_map[result];
  48                 else
  49                         ret = -EPROTO;
  50         }
  51
  52         return ret;
  53 }
  54
  55 static int prepare_packet(struct cros_ec_device *ec_dev,
  56                           struct cros_ec_command *msg)
  57 {
  58         struct ec_host_request *request;
  59         u8 *out;
  60         int i;
  61         u8 csum = 0;
  62
  63         BUG_ON(ec_dev->proto_version != EC_HOST_REQUEST_VERSION);
  64         BUG_ON(msg->outsize + sizeof(*request) > ec_dev->dout_size);
  65
  66         out = ec_dev->dout;
  67         request = (struct ec_host_request *)out;
  68         request->struct_version = EC_HOST_REQUEST_VERSION;
  69         request->checksum = 0;
  70         request->command = msg->command;
  71         request->command_version = msg->version;
  72         request->reserved = 0;
  73         request->data_len = msg->outsize;
  74
  75         for (i = 0; i < sizeof(*request); i++)
  76                 csum += out[i];
  77
  78         /* Copy data and update checksum */
  79         memcpy(out + sizeof(*request), msg->data, msg->outsize);
  80         for (i = 0; i < msg->outsize; i++)
  81                 csum += msg->data[i];
  82
  83         request->checksum = -csum;
  84
  85         return sizeof(*request) + msg->outsize;
  86 }
  87
  88 static int send_command(struct cros_ec_device *ec_dev,
  89                         struct cros_ec_command *msg)
  90 {
  91         int ret;
  92         int (*xfer_fxn)(struct cros_ec_device *ec, struct cros_ec_command *msg);
  93
  94         if (ec_dev->proto_version > 2)
  95                 xfer_fxn = ec_dev->pkt_xfer;
  96         else
  97                 xfer_fxn = ec_dev->cmd_xfer;
  98
  99         if (!xfer_fxn) {
 100                 /*
 101                  * This error can happen if a communication error happened and
 102                  * the EC is trying to use protocol v2, on an underlying
 103                  * communication mechanism that does not support v2.
 104                  */
 105                 dev_err_once(ec_dev->dev,
 106                              "missing EC transfer API, cannot send command\n");
 107                 return -EIO;
 108         }
 109
 110         trace_cros_ec_request_start(msg);
 111         ret = (*xfer_fxn)(ec_dev, msg);
 112         trace_cros_ec_request_done(msg, ret);
 113         if (msg->result == EC_RES_IN_PROGRESS) {
 114                 int i;
 115                 struct cros_ec_command *status_msg;
 116                 struct ec_response_get_comms_status *status;
 117
 118                 status_msg = kmalloc(sizeof(*status_msg) + sizeof(*status),
 119                                      GFP_KERNEL);
 120                 if (!status_msg)
 121                         return -ENOMEM;
 122
 123                 status_msg->version = 0;
 124                 status_msg->command = EC_CMD_GET_COMMS_STATUS;
 125                 status_msg->insize = sizeof(*status);
 126                 status_msg->outsize = 0;
 127
 128                 /*
 129                  * Query the EC's status until it's no longer busy or
 130                  * we encounter an error.
 131                  */
 132                 for (i = 0; i < EC_COMMAND_RETRIES; i++) {
 133                         usleep_range(10000, 11000);
 134
 135                         trace_cros_ec_request_start(status_msg);
 136                         ret = (*xfer_fxn)(ec_dev, status_msg);
 137                         trace_cros_ec_request_done(status_msg, ret);
 138                         if (ret == -EAGAIN)
 139                                 continue;
 140                         if (ret < 0)
 141                                 break;
 142
 143                         msg->result = status_msg->result;
 144                         if (status_msg->result != EC_RES_SUCCESS)
 145                                 break;
 146
 147                         status = (struct ec_response_get_comms_status *)
 148                                  status_msg->data;
 149                         if (!(status->flags & EC_COMMS_STATUS_PROCESSING))
 150                                 break;
 151                 }
 152
 153                 kfree(status_msg);
 154         }
 155
 156         return ret;
 157 }
 158
 159 /**
 160  * cros_ec_prepare_tx() - Prepare an outgoing message in the output buffer.
 161  * @ec_dev: Device to register.
 162  * @msg: Message to write.
 163  *
 164  * This is intended to be used by all ChromeOS EC drivers, but at present
 165  * only SPI uses it. Once LPC uses the same protocol it can start using it.
 166  * I2C could use it now, with a refactor of the existing code.
 167  *
 168  * Return: 0 on success or negative error code.
 169  */
 170 int cros_ec_prepare_tx(struct cros_ec_device *ec_dev,
 171                        struct cros_ec_command *msg)
 172 {
 173         u8 *out;
 174         u8 csum;
 175         int i;
 176
 177         if (ec_dev->proto_version > 2)
 178                 return prepare_packet(ec_dev, msg);
 179
 180         BUG_ON(msg->outsize > EC_PROTO2_MAX_PARAM_SIZE);
 181         out = ec_dev->dout;
 182         out[0] = EC_CMD_VERSION0 + msg->version;
 183         out[1] = msg->command;
 184         out[2] = msg->outsize;
 185         csum = out[0] + out[1] + out[2];
 186         for (i = 0; i < msg->outsize; i++)
 187                 csum += out[EC_MSG_TX_HEADER_BYTES + i] = msg->data[i];
 188         out[EC_MSG_TX_HEADER_BYTES + msg->outsize] = csum;
 189
 190         return EC_MSG_TX_PROTO_BYTES + msg->outsize;
 191 }
 192 EXPORT_SYMBOL(cros_ec_prepare_tx);
 193
 194 /**
 195  * cros_ec_check_result() - Check ec_msg->result.
 196  * @ec_dev: EC device.
 197  * @msg: Message to check.
 198  *
 199  * This is used by ChromeOS EC drivers to check the ec_msg->result for
 200  * errors and to warn about them.
 201  *
 202  * Return: 0 on success or negative error code.
 203  */
 204 int cros_ec_check_result(struct cros_ec_device *ec_dev,
 205                          struct cros_ec_command *msg)
 206 {
 207         switch (msg->result) {
 208         case EC_RES_SUCCESS:
 209                 return 0;
 210         case EC_RES_IN_PROGRESS:
 211                 dev_dbg(ec_dev->dev, "command 0x%02x in progress\n",
 212                         msg->command);
 213                 return -EAGAIN;
 214         default:
 215                 dev_dbg(ec_dev->dev, "command 0x%02x returned %d\n",
 216                         msg->command, msg->result);
 217                 return 0;
 218         }
 219 }
 220 EXPORT_SYMBOL(cros_ec_check_result);
 221
 222 /*
 223  * cros_ec_get_host_event_wake_mask
 224  *
 225  * Get the mask of host events that cause wake from suspend.
 226  *
 227  * @ec_dev: EC device to call
 228  * @msg: message structure to use
 229  * @mask: result when function returns >=0.
 230  *
 231  * LOCKING:
 232  * the caller has ec_dev->lock mutex, or the caller knows there is
 233  * no other command in progress.
 234  */
 235 static int cros_ec_get_host_event_wake_mask(struct cros_ec_device *ec_dev,
 236                                             struct cros_ec_command *msg,
 237                                             uint32_t *mask)
 238 {
 239         struct ec_response_host_event_mask *r;
 240         int ret;
 241
 242         msg->command = EC_CMD_HOST_EVENT_GET_WAKE_MASK;
 243         msg->version = 0;
 244         msg->outsize = 0;
 245         msg->insize = sizeof(*r);
 246
 247         ret = send_command(ec_dev, msg);
 248         if (ret >= 0) {
 249                 if (msg->result == EC_RES_INVALID_COMMAND)
 250                         return -EOPNOTSUPP;
 251                 if (msg->result != EC_RES_SUCCESS)
 252                         return -EPROTO;
 253         }
 254         if (ret > 0) {
 255                 r = (struct ec_response_host_event_mask *)msg->data;
 256                 *mask = r->mask;
 257         }
 258
 259         return ret;
 260 }
 261
 262 static int cros_ec_host_command_proto_query(struct cros_ec_device *ec_dev,
 263                                             int devidx,
 264                                             struct cros_ec_command *msg)
 265 {
 266         /*
 267          * Try using v3+ to query for supported protocols. If this
 268          * command fails, fall back to v2. Returns the highest protocol
 269          * supported by the EC.
 270          * Also sets the max request/response/passthru size.
 271          */
 272         int ret;
 273
 274         if (!ec_dev->pkt_xfer)
 275                 return -EPROTONOSUPPORT;
 276
 277         memset(msg, 0, sizeof(*msg));
 278         msg->command = EC_CMD_PASSTHRU_OFFSET(devidx) | EC_CMD_GET_PROTOCOL_INFO;
 279         msg->insize = sizeof(struct ec_response_get_protocol_info);
 280
 281         ret = send_command(ec_dev, msg);
 282
 283         if (ret < 0) {
 284                 dev_dbg(ec_dev->dev,
 285                         "failed to check for EC[%d] protocol version: %d\n",
 286                         devidx, ret);
 287                 return ret;
 288         }
 289
 290         if (devidx > 0 && msg->result == EC_RES_INVALID_COMMAND)
 291                 return -ENODEV;
 292         else if (msg->result != EC_RES_SUCCESS)
 293                 return msg->result;
 294
 295         return 0;
 296 }
 297
 298 static int cros_ec_host_command_proto_query_v2(struct cros_ec_device *ec_dev)
 299 {
 300         struct cros_ec_command *msg;
 301         struct ec_params_hello *hello_params;
 302         struct ec_response_hello *hello_response;
 303         int ret;
 304         int len = max(sizeof(*hello_params), sizeof(*hello_response));
 305
 306         msg = kmalloc(sizeof(*msg) + len, GFP_KERNEL);
 307         if (!msg)
 308                 return -ENOMEM;
 309
 310         msg->version = 0;
 311         msg->command = EC_CMD_HELLO;
 312         hello_params = (struct ec_params_hello *)msg->data;
 313         msg->outsize = sizeof(*hello_params);
 314         hello_response = (struct ec_response_hello *)msg->data;
 315         msg->insize = sizeof(*hello_response);
 316
 317         hello_params->in_data = 0xa0b0c0d0;
 318
 319         ret = send_command(ec_dev, msg);
 320
 321         if (ret < 0) {
 322                 dev_dbg(ec_dev->dev,
 323                         "EC failed to respond to v2 hello: %d\n",
 324                         ret);
 325                 goto exit;
 326         } else if (msg->result != EC_RES_SUCCESS) {
 327                 dev_err(ec_dev->dev,
 328                         "EC responded to v2 hello with error: %d\n",
 329                         msg->result);
 330                 ret = msg->result;
 331                 goto exit;
 332         } else if (hello_response->out_data != 0xa1b2c3d4) {
 333                 dev_err(ec_dev->dev,
 334                         "EC responded to v2 hello with bad result: %u\n",
 335                         hello_response->out_data);
 336                 ret = -EBADMSG;
 337                 goto exit;
 338         }
 339
 340         ret = 0;
 341
 342  exit:
 343         kfree(msg);
 344         return ret;
 345 }
 346
 347 /*
 348  * cros_ec_get_host_command_version_mask
 349  *
 350  * Get the version mask of a given command.
 351  *
 352  * @ec_dev: EC device to call
 353  * @msg: message structure to use
 354  * @cmd: command to get the version of.
 355  * @mask: result when function returns 0.
 356  *
 357  * @return 0 on success, error code otherwise
 358  *
 359  * LOCKING:
 360  * the caller has ec_dev->lock mutex or the caller knows there is
 361  * no other command in progress.
 362  */
 363 static int cros_ec_get_host_command_version_mask(struct cros_ec_device *ec_dev,
 364         u16 cmd, u32 *mask)
 365 {
 366         struct ec_params_get_cmd_versions *pver;
 367         struct ec_response_get_cmd_versions *rver;
 368         struct cros_ec_command *msg;
 369         int ret;
 370
 371         msg = kmalloc(sizeof(*msg) + max(sizeof(*rver), sizeof(*pver)),
 372                       GFP_KERNEL);
 373         if (!msg)
 374                 return -ENOMEM;
 375
 376         msg->version = 0;
 377         msg->command = EC_CMD_GET_CMD_VERSIONS;
 378         msg->insize = sizeof(*rver);
 379         msg->outsize = sizeof(*pver);
 380
 381         pver = (struct ec_params_get_cmd_versions *)msg->data;
 382         pver->cmd = cmd;
 383
 384         ret = send_command(ec_dev, msg);
 385         if (ret > 0) {
 386                 rver = (struct ec_response_get_cmd_versions *)msg->data;
 387                 *mask = rver->version_mask;
 388         }
 389
 390         kfree(msg);
 391
 392         return ret;
 393 }
 394
 395 /**
 396  * cros_ec_query_all() -  Query the protocol version supported by the
 397  *         ChromeOS EC.
 398  * @ec_dev: Device to register.
 399  *
 400  * Return: 0 on success or negative error code.
 401  */
 402 int cros_ec_query_all(struct cros_ec_device *ec_dev)
 403 {
 404         struct device *dev = ec_dev->dev;
 405         struct cros_ec_command *proto_msg;
 406         struct ec_response_get_protocol_info *proto_info;
 407         u32 ver_mask = 0;
 408         int ret;
 409
 410         proto_msg = kzalloc(sizeof(*proto_msg) + sizeof(*proto_info),
 411                             GFP_KERNEL);
 412         if (!proto_msg)
 413                 return -ENOMEM;
 414
 415         /* First try sending with proto v3. */
 416         ec_dev->proto_version = 3;
 417         ret = cros_ec_host_command_proto_query(ec_dev, 0, proto_msg);
 418
 419         if (ret == 0) {
 420                 proto_info = (struct ec_response_get_protocol_info *)
 421                         proto_msg->data;
 422                 ec_dev->max_request = proto_info->max_request_packet_size -
 423                         sizeof(struct ec_host_request);
 424                 ec_dev->max_response = proto_info->max_response_packet_size -
 425                         sizeof(struct ec_host_response);
 426                 ec_dev->proto_version =
 427                         min(EC_HOST_REQUEST_VERSION,
 428                                         fls(proto_info->protocol_versions) - 1);
 429                 dev_dbg(ec_dev->dev,
 430                         "using proto v%u\n",
 431                         ec_dev->proto_version);
 432
 433                 ec_dev->din_size = ec_dev->max_response +
 434                         sizeof(struct ec_host_response) +
 435                         EC_MAX_RESPONSE_OVERHEAD;
 436                 ec_dev->dout_size = ec_dev->max_request +
 437                         sizeof(struct ec_host_request) +
 438                         EC_MAX_REQUEST_OVERHEAD;
 439
 440                 /*
 441                  * Check for PD
 442                  */
 443                 ret = cros_ec_host_command_proto_query(ec_dev, 1, proto_msg);
 444
 445                 if (ret) {
 446                         dev_dbg(ec_dev->dev, "no PD chip found: %d\n", ret);
 447                         ec_dev->max_passthru = 0;
 448                 } else {
 449                         dev_dbg(ec_dev->dev, "found PD chip\n");
 450                         ec_dev->max_passthru =
 451                                 proto_info->max_request_packet_size -
 452                                 sizeof(struct ec_host_request);
 453                 }
 454         } else {
 455                 /* Try querying with a v2 hello message. */
 456                 ec_dev->proto_version = 2;
 457                 ret = cros_ec_host_command_proto_query_v2(ec_dev);
 458
 459                 if (ret == 0) {
 460                         /* V2 hello succeeded. */
 461                         dev_dbg(ec_dev->dev, "falling back to proto v2\n");
 462
 463                         ec_dev->max_request = EC_PROTO2_MAX_PARAM_SIZE;
 464                         ec_dev->max_response = EC_PROTO2_MAX_PARAM_SIZE;
 465                         ec_dev->max_passthru = 0;
 466                         ec_dev->pkt_xfer = NULL;
 467                         ec_dev->din_size = EC_PROTO2_MSG_BYTES;
 468                         ec_dev->dout_size = EC_PROTO2_MSG_BYTES;
 469                 } else {
 470                         /*
 471                          * It's possible for a test to occur too early when
 472                          * the EC isn't listening. If this happens, we'll
 473                          * test later when the first command is run.
 474                          */
 475                         ec_dev->proto_version = EC_PROTO_VERSION_UNKNOWN;
 476                         dev_dbg(ec_dev->dev, "EC query failed: %d\n", ret);
 477                         goto exit;
 478                 }
 479         }
 480
 481         devm_kfree(dev, ec_dev->din);
 482         devm_kfree(dev, ec_dev->dout);
 483
 484         ec_dev->din = devm_kzalloc(dev, ec_dev->din_size, GFP_KERNEL);
 485         if (!ec_dev->din) {
 486                 ret = -ENOMEM;
 487                 goto exit;
 488         }
 489
 490         ec_dev->dout = devm_kzalloc(dev, ec_dev->dout_size, GFP_KERNEL);
 491         if (!ec_dev->dout) {
 492                 devm_kfree(dev, ec_dev->din);
 493                 ret = -ENOMEM;
 494                 goto exit;
 495         }
 496
 497         /* Probe if MKBP event is supported */
 498         ret = cros_ec_get_host_command_version_mask(ec_dev,
 499                                                     EC_CMD_GET_NEXT_EVENT,
 500                                                     &ver_mask);
 501         if (ret < 0 || ver_mask == 0)
 502                 ec_dev->mkbp_event_supported = 0;
 503         else
 504                 ec_dev->mkbp_event_supported = fls(ver_mask);
 505
 506         dev_dbg(ec_dev->dev, "MKBP support version %u\n",
 507                 ec_dev->mkbp_event_supported - 1);
 508
 509         /* Probe if host sleep v1 is supported for S0ix failure detection. */
 510         ret = cros_ec_get_host_command_version_mask(ec_dev,
 511                                                     EC_CMD_HOST_SLEEP_EVENT,
 512                                                     &ver_mask);
 513         ec_dev->host_sleep_v1 = (ret >= 0 && (ver_mask & EC_VER_MASK(1)));
 514
 515         /* Get host event wake mask. */
 516         ret = cros_ec_get_host_event_wake_mask(ec_dev, proto_msg,
 517                                                &ec_dev->host_event_wake_mask);
 518         if (ret < 0) {
 519                 /*
 520                  * If the EC doesn't support EC_CMD_HOST_EVENT_GET_WAKE_MASK,
 521                  * use a reasonable default. Note that we ignore various
 522                  * battery, AC status, and power-state events, because (a)
 523                  * those can be quite common (e.g., when sitting at full
 524                  * charge, on AC) and (b) these are not actionable wake events;
 525                  * if anything, we'd like to continue suspending (to save
 526                  * power), not wake up.
 527                  */
 528                 ec_dev->host_event_wake_mask = U32_MAX &
 529                         ~(BIT(EC_HOST_EVENT_AC_DISCONNECTED) |
 530                           BIT(EC_HOST_EVENT_BATTERY_LOW) |
 531                           BIT(EC_HOST_EVENT_BATTERY_CRITICAL) |
 532                           BIT(EC_HOST_EVENT_PD_MCU) |
 533                           BIT(EC_HOST_EVENT_BATTERY_STATUS));
 534                 /*
 535                  * Old ECs may not support this command. Complain about all
 536                  * other errors.
 537                  */
 538                 if (ret != -EOPNOTSUPP)
 539                         dev_err(ec_dev->dev,
 540                                 "failed to retrieve wake mask: %d\n", ret);
 541         }
 542
 543         ret = 0;
 544
 545 exit:
 546         kfree(proto_msg);
 547         return ret;
 548 }
 549 EXPORT_SYMBOL(cros_ec_query_all);
 550
 551 /**
 552  * cros_ec_cmd_xfer() - Send a command to the ChromeOS EC.
 553  * @ec_dev: EC device.
 554  * @msg: Message to write.
 555  *
 556  * Call this to send a command to the ChromeOS EC.  This should be used
 557  * instead of calling the EC's cmd_xfer() callback directly.
 558  *
 559  * Return: 0 on success or negative error code.
 560  */
 561 static int cros_ec_cmd_xfer(struct cros_ec_device *ec_dev,
 562                             struct cros_ec_command *msg)
 563 {
 564         int ret;
 565
 566         mutex_lock(&ec_dev->lock);
 567         if (ec_dev->proto_version == EC_PROTO_VERSION_UNKNOWN) {
 568                 ret = cros_ec_query_all(ec_dev);
 569                 if (ret) {
 570                         dev_err(ec_dev->dev,
 571                                 "EC version unknown and query failed; aborting command\n");
 572                         mutex_unlock(&ec_dev->lock);
 573                         return ret;
 574                 }
 575         }
 576
 577         if (msg->insize > ec_dev->max_response) {
 578                 dev_dbg(ec_dev->dev, "clamping message receive buffer\n");
 579                 msg->insize = ec_dev->max_response;
 580         }
 581
 582         if (msg->command < EC_CMD_PASSTHRU_OFFSET(1)) {
 583                 if (msg->outsize > ec_dev->max_request) {
 584                         dev_err(ec_dev->dev,
 585                                 "request of size %u is too big (max: %u)\n",
 586                                 msg->outsize,
 587                                 ec_dev->max_request);
 588                         mutex_unlock(&ec_dev->lock);
 589                         return -EMSGSIZE;
 590                 }
 591         } else {
 592                 if (msg->outsize > ec_dev->max_passthru) {
 593                         dev_err(ec_dev->dev,
 594                                 "passthru rq of size %u is too big (max: %u)\n",
 595                                 msg->outsize,
 596                                 ec_dev->max_passthru);
 597                         mutex_unlock(&ec_dev->lock);
 598                         return -EMSGSIZE;
 599                 }
 600         }
 601         ret = send_command(ec_dev, msg);
 602         mutex_unlock(&ec_dev->lock);
 603
 604         return ret;
 605 }
 606
 607 /**
 608  * cros_ec_cmd_xfer_status() - Send a command to the ChromeOS EC.
 609  * @ec_dev: EC device.
 610  * @msg: Message to write.
 611  *
 612  * This function is identical to cros_ec_cmd_xfer, except it returns success
 613  * status only if both the command was transmitted successfully and the EC
 614  * replied with success status. It's not necessary to check msg->result when
 615  * using this function.
 616  *
 617  * Return:
 618  * >=0 - The number of bytes transferred
 619  * <0 - Linux error code
 620  */
 621 int cros_ec_cmd_xfer_status(struct cros_ec_device *ec_dev,
 622                             struct cros_ec_command *msg)
 623 {
 624         int ret, mapped;
 625
 626         ret = cros_ec_cmd_xfer(ec_dev, msg);
 627         if (ret < 0) {
 628                 dev_err(ec_dev->dev, "Command xfer error (err:%d)\n", ret);
 629                 return ret;
 630         }
 631         mapped = cros_ec_map_error(msg->result);
 632         if (mapped) {
 633                 dev_dbg(ec_dev->dev, "Command result (err: %d [%d])\n",
 634                         msg->result, mapped);
 635                 ret = mapped;
 636         }
 637         return ret;
 638 }
 639 EXPORT_SYMBOL(cros_ec_cmd_xfer_status);
 640
 641 static int get_next_event_xfer(struct cros_ec_device *ec_dev,
 642                                struct cros_ec_command *msg,
 643                                struct ec_response_get_next_event_v1 *event,
 644                                int version, uint32_t size)
 645 {
 646         int ret;
 647
 648         msg->version = version;
 649         msg->command = EC_CMD_GET_NEXT_EVENT;
 650         msg->insize = size;
 651         msg->outsize = 0;
 652
 653         ret = cros_ec_cmd_xfer(ec_dev, msg);
 654         if (ret > 0) {
 655                 ec_dev->event_size = ret - 1;
 656                 ec_dev->event_data = *event;
 657         }
 658
 659         return ret;
 660 }
 661
 662 static int get_next_event(struct cros_ec_device *ec_dev)
 663 {
 664         struct {
 665                 struct cros_ec_command msg;
 666                 struct ec_response_get_next_event_v1 event;
 667         } __packed buf;
 668         struct cros_ec_command *msg = &buf.msg;
 669         struct ec_response_get_next_event_v1 *event = &buf.event;
 670         const int cmd_version = ec_dev->mkbp_event_supported - 1;
 671
 672         memset(msg, 0, sizeof(*msg));
 673         if (ec_dev->suspended) {
 674                 dev_dbg(ec_dev->dev, "Device suspended.\n");
 675                 return -EHOSTDOWN;
 676         }
 677
 678         if (cmd_version == 0)
 679                 return get_next_event_xfer(ec_dev, msg, event, 0,
 680                                   sizeof(struct ec_response_get_next_event));
 681
 682         return get_next_event_xfer(ec_dev, msg, event, cmd_version,
 683                                 sizeof(struct ec_response_get_next_event_v1));
 684 }
 685
 686 static int get_keyboard_state_event(struct cros_ec_device *ec_dev)
 687 {
 688         u8 buffer[sizeof(struct cros_ec_command) +
 689                   sizeof(ec_dev->event_data.data)];
 690         struct cros_ec_command *msg = (struct cros_ec_command *)&buffer;
 691
 692         msg->version = 0;
 693         msg->command = EC_CMD_MKBP_STATE;
 694         msg->insize = sizeof(ec_dev->event_data.data);
 695         msg->outsize = 0;
 696
 697         ec_dev->event_size = cros_ec_cmd_xfer(ec_dev, msg);
 698         ec_dev->event_data.event_type = EC_MKBP_EVENT_KEY_MATRIX;
 699         memcpy(&ec_dev->event_data.data, msg->data,
 700                sizeof(ec_dev->event_data.data));
 701
 702         return ec_dev->event_size;
 703 }
 704
 705 /**
 706  * cros_ec_get_next_event() - Fetch next event from the ChromeOS EC.
 707  * @ec_dev: Device to fetch event from.
 708  * @wake_event: Pointer to a bool set to true upon return if the event might be
 709  *              treated as a wake event. Ignored if null.
 710  * @has_more_events: Pointer to bool set to true if more than one event is
 711  *              pending.
 712  *              Some EC will set this flag to indicate cros_ec_get_next_event()
 713  *              can be called multiple times in a row.
 714  *              It is an optimization to prevent issuing a EC command for
 715  *              nothing or wait for another interrupt from the EC to process
 716  *              the next message.
 717  *              Ignored if null.
 718  *
 719  * Return: negative error code on errors; 0 for no data; or else number of
 720  * bytes received (i.e., an event was retrieved successfully). Event types are
 721  * written out to @ec_dev->event_data.event_type on success.
 722  */
 723 int cros_ec_get_next_event(struct cros_ec_device *ec_dev,
 724                            bool *wake_event,
 725                            bool *has_more_events)
 726 {
 727         u8 event_type;
 728         u32 host_event;
 729         int ret;
 730
 731         /*
 732          * Default value for wake_event.
 733          * Wake up on keyboard event, wake up for spurious interrupt or link
 734          * error to the EC.
 735          */
 736         if (wake_event)
 737                 *wake_event = true;
 738
 739         /*
 740          * Default value for has_more_events.
 741          * EC will raise another interrupt if AP does not process all events
 742          * anyway.
 743          */
 744         if (has_more_events)
 745                 *has_more_events = false;
 746
 747         if (!ec_dev->mkbp_event_supported)
 748                 return get_keyboard_state_event(ec_dev);
 749
 750         ret = get_next_event(ec_dev);
 751         if (ret <= 0)
 752                 return ret;
 753
 754         if (has_more_events)
 755                 *has_more_events = ec_dev->event_data.event_type &
 756                         EC_MKBP_HAS_MORE_EVENTS;
 757         ec_dev->event_data.event_type &= EC_MKBP_EVENT_TYPE_MASK;
 758
 759         if (wake_event) {
 760                 event_type = ec_dev->event_data.event_type;
 761                 host_event = cros_ec_get_host_event(ec_dev);
 762
 763                 /*
 764                  * Sensor events need to be parsed by the sensor sub-device.
 765                  * Defer them, and don't report the wakeup here.
 766                  */
 767                 if (event_type == EC_MKBP_EVENT_SENSOR_FIFO)
 768                         *wake_event = false;
 769                 /* Masked host-events should not count as wake events. */
 770                 else if (host_event &&
 771                          !(host_event & ec_dev->host_event_wake_mask))
 772                         *wake_event = false;
 773         }
 774
 775         return ret;
 776 }
 777 EXPORT_SYMBOL(cros_ec_get_next_event);
 778
 779 /**
 780  * cros_ec_get_host_event() - Return a mask of event set by the ChromeOS EC.
 781  * @ec_dev: Device to fetch event from.
 782  *
 783  * When MKBP is supported, when the EC raises an interrupt, we collect the
 784  * events raised and call the functions in the ec notifier. This function
 785  * is a helper to know which events are raised.
 786  *
 787  * Return: 0 on error or non-zero bitmask of one or more EC_HOST_EVENT_*.
 788  */
 789 u32 cros_ec_get_host_event(struct cros_ec_device *ec_dev)
 790 {
 791         u32 host_event;
 792
 793         BUG_ON(!ec_dev->mkbp_event_supported);
 794
 795         if (ec_dev->event_data.event_type != EC_MKBP_EVENT_HOST_EVENT)
 796                 return 0;
 797
 798         if (ec_dev->event_size != sizeof(host_event)) {
 799                 dev_warn(ec_dev->dev, "Invalid host event size\n");
 800                 return 0;
 801         }
 802
 803         host_event = get_unaligned_le32(&ec_dev->event_data.data.host_event);
 804
 805         return host_event;
 806 }
 807 EXPORT_SYMBOL(cros_ec_get_host_event);
 808
 809 /**
 810  * cros_ec_check_features() - Test for the presence of EC features
 811  *
 812  * @ec: EC device, does not have to be connected directly to the AP,
 813  *      can be daisy chained through another device.
 814  * @feature: One of ec_feature_code bit.
 815  *
 816  * Call this function to test whether the ChromeOS EC supports a feature.
 817  *
 818  * Return: 1 if supported, 0 if not
 819  */
 820 int cros_ec_check_features(struct cros_ec_dev *ec, int feature)
 821 {
 822         struct cros_ec_command *msg;
 823         int ret;
 824
 825         if (ec->features[0] == -1U && ec->features[1] == -1U) {
 826                 /* features bitmap not read yet */
 827                 msg = kzalloc(sizeof(*msg) + sizeof(ec->features), GFP_KERNEL);
 828                 if (!msg)
 829                         return -ENOMEM;
 830
 831                 msg->command = EC_CMD_GET_FEATURES + ec->cmd_offset;
 832                 msg->insize = sizeof(ec->features);
 833
 834                 ret = cros_ec_cmd_xfer_status(ec->ec_dev, msg);
 835                 if (ret < 0) {
 836                         dev_warn(ec->dev, "cannot get EC features: %d/%d\n",
 837                                  ret, msg->result);
 838                         memset(ec->features, 0, sizeof(ec->features));
 839                 } else {
 840                         memcpy(ec->features, msg->data, sizeof(ec->features));
 841                 }
 842
 843                 dev_dbg(ec->dev, "EC features %08x %08x\n",
 844                         ec->features[0], ec->features[1]);
 845
 846                 kfree(msg);
 847         }
 848
 849         return ec->features[feature / 32] & EC_FEATURE_MASK_0(feature);
 850 }
 851 EXPORT_SYMBOL_GPL(cros_ec_check_features);
 852
 853 /**
 854  * cros_ec_get_sensor_count() - Return the number of MEMS sensors supported.
 855  *
 856  * @ec: EC device, does not have to be connected directly to the AP,
 857  *      can be daisy chained through another device.
 858  * Return: < 0 in case of error.
 859  */
 860 int cros_ec_get_sensor_count(struct cros_ec_dev *ec)
 861 {
 862         /*
 863          * Issue a command to get the number of sensor reported.
 864          * If not supported, check for legacy mode.
 865          */
 866         int ret, sensor_count;
 867         struct ec_params_motion_sense *params;
 868         struct ec_response_motion_sense *resp;
 869         struct cros_ec_command *msg;
 870         struct cros_ec_device *ec_dev = ec->ec_dev;
 871         u8 status;
 872
 873         msg = kzalloc(sizeof(*msg) + max(sizeof(*params), sizeof(*resp)),
 874                       GFP_KERNEL);
 875         if (!msg)
 876                 return -ENOMEM;
 877
 878         msg->version = 1;
 879         msg->command = EC_CMD_MOTION_SENSE_CMD + ec->cmd_offset;
 880         msg->outsize = sizeof(*params);
 881         msg->insize = sizeof(*resp);
 882
 883         params = (struct ec_params_motion_sense *)msg->data;
 884         params->cmd = MOTIONSENSE_CMD_DUMP;
 885
 886         ret = cros_ec_cmd_xfer(ec->ec_dev, msg);
 887         if (ret < 0) {
 888                 sensor_count = ret;
 889         } else if (msg->result != EC_RES_SUCCESS) {
 890                 sensor_count = -EPROTO;
 891         } else {
 892                 resp = (struct ec_response_motion_sense *)msg->data;
 893                 sensor_count = resp->dump.sensor_count;
 894         }
 895         kfree(msg);
 896
 897         /*
 898          * Check legacy mode: Let's find out if sensors are accessible
 899          * via LPC interface.
 900          */
 901         if (sensor_count == -EPROTO &&
 902             ec->cmd_offset == 0 &&
 903             ec_dev->cmd_readmem) {
 904                 ret = ec_dev->cmd_readmem(ec_dev, EC_MEMMAP_ACC_STATUS,
 905                                 1, &status);
 906                 if (ret >= 0 &&
 907                     (status & EC_MEMMAP_ACC_STATUS_PRESENCE_BIT)) {
 908                         /*
 909                          * We have 2 sensors, one in the lid, one in the base.
 910                          */
 911                         sensor_count = 2;
 912                 } else {
 913                         /*
 914                          * EC uses LPC interface and no sensors are presented.
 915                          */
 916                         sensor_count = 0;
 917                 }
 918         } else if (sensor_count == -EPROTO) {
 919                 /* EC responded, but does not understand DUMP command. */
 920                 sensor_count = 0;
 921         }
 922         return sensor_count;
 923 }
 924 EXPORT_SYMBOL_GPL(cros_ec_get_sensor_count);