Skip to content

platform/chrome: Kunit tests and refactor for cros_ec_cmd_xfer()

Tzung-Bi Shih chrome-platform lkml 3 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v2 Latest10 patches 7 repliesIn review 8 of 10 applied
  2. v1 posting 2/211 patches 13 repliesSuperseded
  3. v1 posting 1/211 patches 6 repliesSuperseded

Patches in v2 8 of 10 applied

#Subject and filesSizeRepliesApplied
1/10platform/chrome: cros_kunit_util: add default value for `msg->result`drivers/platform/chrome/cros_kunit_util.c drivers/platform/chrome/cros_kunit_util.h+7 -14 replies
2/10platform/chrome: cros_ec_proto: add "cros_ec_" prefix to send_command()drivers/platform/chrome/cros_ec_proto.c+7 -80 repliesApplied
3/10platform/chrome: cros_ec_proto: add Kunit tests for cros_ec_cmd_xfer()drivers/platform/chrome/cros_ec_proto_test.c+149 -00 repliesApplied
4/10platform/chrome: cros_ec_proto: add Kunit tests for cros_ec_send_command()drivers/platform/chrome/cros_ec_proto_test.c drivers/platform/chrome/cros_kunit_util.c drivers/platform/chrome/cros_kunit_util.h+289 -00 replies
5/10platform/chrome: cros_ec_proto: separate cros_ec_xfer_command()drivers/platform/chrome/cros_ec_proto.c+10 -30 repliesApplied
6/10platform/chrome: cros_ec_proto: separate cros_ec_wait_until_complete()drivers/platform/chrome/cros_ec_proto.c+35 -391 replyApplied
7/10platform/chrome: cros_ec_proto: change Kunit expectation when timed outdrivers/platform/chrome/cros_ec_proto_test.c+1 -30 repliesApplied
8/10platform/chrome: cros_ec_proto: return -EAGAIN when retries timed outdrivers/platform/chrome/cros_ec_proto.c+3 -01 replyApplied
9/10platform/chrome: cros_ec_proto: add Kunit test for empty payloaddrivers/platform/chrome/cros_ec_proto_test.c+31 -01 replyApplied
10/10platform/chrome: cros_ec_proto: return -EPROTO if empty payloaddrivers/platform/chrome/cros_ec_proto.c+5 -00 repliesApplied

Reviews trailers per patch

9 of 10 patches have a Reviewed-by or Acked-by.

PatchGuenter Roeck
1/10
2/10R-b
3/10R-b
4/10R-b
5/10R-b
6/10R-b
7/10R-b
8/10R-b
9/10R-b
10/10R-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v2 thread

Cover letter [PATCH v2 00/10] platform/chrome: Kunit tests and refactor for cros_ec_cmd_xfer()

The 1st patch fixes an issue that cros_kunit_ec_xfer_mock() could return garbage bytes for msg->result if the mock list is empty.

The 2nd ~ 6th patches add Kunit tests and refactors for cros_ec_cmd_xfer().

The last 4 patches change the behavior a bit by altering return codes.

Asynchronous mechanism in EC protocol:
EC returns EC_RES_IN_PROGRESS if the host command needs more time to complete. It saves the result into saved_result once the command completed[1].

By design, AP should send another command EC_CMD_RESEND_RESPONSE for getting the result from the previous pending command[2]. The mechanism was only designed for commands that don't need responses[3].

However, the kernel code doesn't have such logic when dealing with EC_RES_IN_PROGRESS.

The series doesn't fix it but leave it as is. I doubt there is no existing use case.

[1]: https://crrev.com/9b80051e01872d8cae86fff999b5d31a0bea985b/common/host_command.c#113
[2]: https://crrev.com/9b80051e01872d8cae86fff999b5d31a0bea985b/common/host_command.c#748
[3]: https://crrev.com/9b80051e01872d8cae86fff999b5d31a0bea985b/common/host_command.c#126

Return value overridden in cros_ec_send_command() if asynchronous:
By original intention, cros_ec_send_command() returns number of available bytes of input payload.

When it falls into asynchronous path (i.e. EC_RES_IN_PROGRESS), both return value and msg->result will be overridden by the subsequent EC_CMD_GET_COMMS_STATUS.

The series doesn't fix it but leave it as is.

Tzung-Bi Shih (10):
platform/chrome: cros_kunit_util: add default value for msg->result platform/chrome: cros_ec_proto: add "cros_ec_" prefix to
send_command()
platform/chrome: cros_ec_proto: add Kunit tests for cros_ec_cmd_xfer() platform/chrome: cros_ec_proto: add Kunit tests for
cros_ec_send_command()
platform/chrome: cros_ec_proto: separate cros_ec_xfer_command() platform/chrome: cros_ec_proto: separate cros_ec_wait_until_complete() platform/chrome: cros_ec_proto: change Kunit expectation when timed
out
platform/chrome: cros_ec_proto: return -EAGAIN when retries timed out platform/chrome: cros_ec_proto: add Kunit test for empty payload platform/chrome: cros_ec_proto: return -EPROTO if empty payload

 drivers/platform/chrome/cros_ec_proto.c      | 102 +++--
 drivers/platform/chrome/cros_ec_proto_test.c | 443 +++++++++++++++++++
 drivers/platform/chrome/cros_kunit_util.c    |  27 +-
 drivers/platform/chrome/cros_kunit_util.h    |   5 +
 4 files changed, 530 insertions(+), 47 deletions(-)

Changes from v1 (https://patchwork.kernel.org/project/chrome-platform/cover/[email protected]/):
- Drop "platform/chrome: cros_ec_proto: change Kunit expectation for EC errors"
and "platform/chrome: cros_ec_proto: return standard error codes for EC
errors" because they could break existing ABI.
- Add "platform/chrome: cros_kunit_util: add default value for msg->result".

Signature · 1 line
2.37.0.170.g444d1eabd0-goog