summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAaron Massey <aaronmassey@google.com>2022-04-08 09:42:19 -0600
committerChromeos LUCI <chromeos-scoped@luci-project-accounts.iam.gserviceaccount.com>2022-04-12 01:10:27 +0000
commit3b0bfb3fdd2d02c5e3dabd5b15ccb734feb8b493 (patch)
treeca33cb5092cdeeb42eda41a9925bd51d7a91ff41
parent4427e1026df8ec4f5ff2dceb29ca7ff0ee218fda (diff)
downloadchrome-ec-3b0bfb3fdd2d02c5e3dabd5b15ccb734feb8b493.tar.gz
docs: ec_terms: Reference the ectool
Add a quick description and reference to the ectool in the ec_terms.md to make the ectool documentation more discoverabe. BRANCH=none BUG=None TEST=gitiles gerrit view Signed-off-by: Aaron Massey <aaronmassey@google.com> Change-Id: I5a7aa99884fd81e549539c76e61d23cd0f6448c3 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3577991 Reviewed-by: Fabio Baltieri <fabiobaltieri@google.com>
-rw-r--r--docs/ec_terms.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/docs/ec_terms.md b/docs/ec_terms.md
index d5f3690615..fce405bfbb 100644
--- a/docs/ec_terms.md
+++ b/docs/ec_terms.md
@@ -65,6 +65,11 @@
switching, sensor management, and other functions, offloading these tasks
from the [AP](#ap).
+* **ectool** {#ectool}
+
+ The [ectool] is the [AP](#ap) console's CLI for sending commands to the
+ [EC](#ec).
+
* **EC-3PO** {#ec-3po}
A replacement of the current UART-based console which moves much of the code
@@ -237,12 +242,13 @@
See the [USB-C documentation](./usb-c.md#vconn) for more details.
[BC 1.2 Specification]: <https://www.usb.org/document-library/battery-charging-v12-spec-and-adopters-agreement>
-[CrOS Board Info]: <https://chromium.googlesource.com/chromiumos/docs/+/HEAD/design_docs/cros_board_info.md>
[CEC Wikipedia page]: <https://en.wikipedia.org/wiki/Consumer_Electronics_Control>
+[CrOS Board Info]: <https://chromium.googlesource.com/chromiumos/docs/+/HEAD/design_docs/cros_board_info.md>
[DPTF Readme]: <https://github.com/intel/dptf/blob/HEAD/README.txt>
-[eSPI Specification]: <https://www.intel.com/content/dam/support/us/en/documents/software/chipset-software/327432-004_espi_base_specification_rev1.0.pdf>
+[EC MKBP driver]: <https://chromium.googlesource.com/chromiumos/platform/ec/+/HEAD/common/keyboard_mkbp.c>
[FAFT design doc]: <https://chromium.googlesource.com/chromiumos/third_party/autotest/+/HEAD/docs/faft-design-doc.md>
[I2C Specification]: <https://www.nxp.com/docs/en/user-guide/UM10204.pdf>
-[RS-232]: <https://en.wikipedia.org/wiki/RS-232>
-[EC MKBP driver]: <https://chromium.googlesource.com/chromiumos/platform/ec/+/HEAD/common/keyboard_mkbp.c>
[Low Pin Count bus]: https://en.wikipedia.org/wiki/Low_Pin_Count
+[RS-232]: <https://en.wikipedia.org/wiki/RS-232>
+[eSPI Specification]: <https://www.intel.com/content/dam/support/us/en/documents/software/chipset-software/327432-004_espi_base_specification_rev1.0.pdf>
+[ectool]: ../docs/ap-ec-comm.md