summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorVadim Bendebury <vbendeb@chromium.org>2017-09-06 15:51:46 -0700
committerchrome-bot <chrome-bot@chromium.org>2017-10-10 22:13:43 -0700
commita08f61506cc71b690858e51da905c7dcb2d7ef10 (patch)
tree7f504d1fdaa6c6a8630656e95f1ed15e2b774d4d /docs
parentf1e6af516c87623f475900f8fc85cb9c40668092 (diff)
downloadchrome-ec-a08f61506cc71b690858e51da905c7dcb2d7ef10.tar.gz
g: rename usb_updater into gsctool
The usb_updater utility has long been not just an updater, and has long been using other interfaces in addition to USB. gsctool is a much more suitable name. CQ-DEPEND=CL:709776 BRANCH=cr50 BUG=b:67007500 TEST=verified that make -C ./extra/usb_updater generates ./extra/usb_updater/gsctool: $ ./extra/usb_updater/gsctool --help Usage: gsctool [options] <binary image> This updates the Cr50 RW firmware over USB. The required argument is the full RO+RW image. Options: [...] $ Change-Id: I3ab70c28acf3664ddefaa923a87ba1fd5c3c437b Signed-off-by: Vadim Bendebury <vbendeb@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/709738 Reviewed-by: Mary Ruthven <mruthven@chromium.org>
Diffstat (limited to 'docs')
-rw-r--r--docs/usb_updater.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/docs/usb_updater.md b/docs/usb_updater.md
index 5eb2cc2086..476b50f316 100644
--- a/docs/usb_updater.md
+++ b/docs/usb_updater.md
@@ -4,10 +4,13 @@ EC update over USB
chip/g (Cr50) and common code (hammer, servo_micro/v4) update over USB protocols
share a lot in terms of protocol and ideas, but use different code bases.
-chip/g EC-side implementation is found at `chip/g/*upgrade*`, and the userspace
-updater is found in `extra/usb_updater/usb_updater.c`, while common code
-uses implementations in `common/*update*.c` and `include/*update*.h`, and
-`extra/usb_updater/usb_updater2.c` for the userspace updater.
+chip/g EC-side implementation is found in `chip/g/*upgrade*`, and the
+userspace tool which provides updates over USB among with supporting other
+features and interfaces is found in `extra/usb_updater/gsctool.c`.
+
+Common code uses implementations in `common/*update*.c` and
+`include/*update*.h`, and `extra/usb_updater/usb_updater2.c` for the userspace
+updater.
Cr50-specific notes
-------------------
@@ -24,7 +27,7 @@ is restarted, the new RO and RW are used if they pass verification and are
logically newer than the existing sections.
There are two ways to communicate with the Cr50 device: USB and `/dev/tpm0`
-(when `usb_updater` is running on a chromebook with the Cr50 device). Originally
+(when `gsctool` is running on a chromebook with the Cr50 device). Originally
different protocols were used to communicate over different channels,
starting with version 3 the same protocol is used.