summaryrefslogtreecommitdiff
path: root/docs/ap-ec-comm.md
diff options
context:
space:
mode:
authorMichał Barnaś <mb@semihalf.com>2022-01-19 18:27:33 +0100
committerChromeos LUCI <chromeos-scoped@luci-project-accounts.iam.gserviceaccount.com>2022-03-22 18:40:46 +0000
commit53a2adff4d69f28d755144b6d972a173a35ad349 (patch)
treee1721a96f290e854dd8fd03f5bd8f3c5dff35fa3 /docs/ap-ec-comm.md
parent0d5c2467785930f326af62d611ce4fa1f2121fae (diff)
downloadchrome-ec-53a2adff4d69f28d755144b6d972a173a35ad349.tar.gz
zephyr: add documentation about host commands
This commit adds information about available Kconfigs and device tree definitions used to enable and configure host interface support. BRANCH=main BUG=b:208438167 TEST=generate preview Change-Id: I049dbd5efd5edc32492b191b8f1cc7911ad2b2bd Signed-off-by: Michał Barnaś <mb@semihalf.com> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3401640 Reviewed-by: Keith Short <keithshort@chromium.org>
Diffstat (limited to 'docs/ap-ec-comm.md')
-rw-r--r--docs/ap-ec-comm.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/ap-ec-comm.md b/docs/ap-ec-comm.md
index 5cd6fd82d9..035e2d7457 100644
--- a/docs/ap-ec-comm.md
+++ b/docs/ap-ec-comm.md
@@ -25,6 +25,21 @@ the following sections.
providing a CLI. They call one of the transport-specific `ec_command`
implementations in the `util/comm-*.c` files to send and receive from the EC.
+#### Stress test
+
+The `ectool stress` command sends a large amount of host commands continuously
+to the EC. This verifies that the EC can respond to all commands received
+without timeouts or communication errors.
+
+It will log the time elapsed for every iteration of sending 10000 host commands
+with the time that it took to send them.
+
+Example output of stress test is:
+`Update: attempt 10000 round 1 | took 205 seconds`
+
+Killing the process will result in displaying the total runtime and failures
+that happened during it.
+
### EC kernel driver
In most cases, `ectool` communicates via the [`cros-ec` Kernel driver], rather