summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikolai Artemiev <nartemiev@google.com>2023-05-09 10:28:16 +1000
committerChromeos LUCI <chromeos-scoped@luci-project-accounts.iam.gserviceaccount.com>2023-05-10 23:58:37 +0000
commit20a872b191d69e605b125a5dd1bfc35eee8cdaef (patch)
tree88a9ac50e8ea101373240304c0cb0e05dbffa649
parent852eaf4a63a6d2dca094f923da1a1b685278043c (diff)
downloadchrome-ec-cr50_stab.tar.gz
docs: Delete deprecated flashrom WP commands and fix docscr50_stab
Update documentation to use `futility flash` instead of flashrom. `futility flash` encapsulates low-level writeprotect logic, making it more robust and easier to use than raw flashrom commands. This commit also fixes documentation that incorrectly states that `flashrom --wp-status` will check HW WP status; it only checks SW WP status. BUG=b:280362324 TEST=tested new commands Change-Id: I78566f2319b8060b25436d70b52c48e94ae7ff29 Signed-off-by: Nikolai Artemiev <nartemiev@google.com> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/4514137 Reviewed-by: Edward O'Callaghan <quasisec@chromium.org> Tested-by: Edward O'Callaghan <quasisec@chromium.org> Reviewed-by: Mary Ruthven <mruthven@chromium.org> Commit-Queue: Edward O'Callaghan <quasisec@chromium.org> Reviewed-by: Matthew Blecker <matthewb@chromium.org>
-rw-r--r--docs/case_closed_debugging_gsc.md13
-rw-r--r--docs/ccd_howtos.md26
2 files changed, 14 insertions, 25 deletions
diff --git a/docs/case_closed_debugging_gsc.md b/docs/case_closed_debugging_gsc.md
index 234b92289e..96b505cae6 100644
--- a/docs/case_closed_debugging_gsc.md
+++ b/docs/case_closed_debugging_gsc.md
@@ -393,7 +393,7 @@ If you want to reflash the AP RO firmware using CCD and your board has issues
disabling hardware write protect, you may need to also disable software write
protect.
-To determine if the board you are using has this issue:
+If you suspect the board you are using has this issue, you can try this:
1. Disable write protect using the GSC console command:
@@ -401,17 +401,10 @@ To determine if the board you are using has this issue:
(gsc) > wp disable
```
-1. Check if hardware write protect disabled when the AP is off:
+2. Disable software write protect via CCD:
```bash
- (chroot) $ sudo flashrom -p raiden_debug_spi:target=AP --wp-status
- ```
-
-1. If the last command shows that hardware write protect is still enabled when
- the AP is off, then you need to disable software write protect:
-
- ```bash
- (chroot) $ flashrom -p host --wp-disable
+ (chroot) $ sudo futility flash --wp-disable --servo
```
## Control Hardware Write Protect {#hw-wp}
diff --git a/docs/ccd_howtos.md b/docs/ccd_howtos.md
index c7c8996561..5950e90189 100644
--- a/docs/ccd_howtos.md
+++ b/docs/ccd_howtos.md
@@ -235,17 +235,17 @@ is not a clamshell, check out the [full dev mode instructions].
chroot > dut-control ec_board
---
-## I Just Want to Disable Write Protect
-Cr50 has a couple of ways to remove write protect. The biggest difference in the
-process is whether or not you want to open the case and whether or not you need
-write protect disable to be permanent.
+## I Just Want to Disable HW Write Protect
+Cr50 has a couple of ways to remove HW write protect. The biggest difference in
+the process is whether or not you want to open the case and whether or not you
+need write protect disable to be permanent.
**Opening CCD might require the AP can boot. If you're relying on CCD to recover
a bricked machine, you may want to do the optional CCD setup steps before
flashing RO firmware.**
### Process if You're Okay Opening Case
-Cr50 will disable write protect if you remove the battery.
+Cr50 will disable HW write protect if you remove the battery.
#### Steps
@@ -260,13 +260,13 @@ Cr50 will disable write protect if you remove the battery.
4. (optional) Check write protect is disabled from the AP.
- AP > flashrom --wp-status
+ AP > crossystem wpsw_cur
5. (optional) Reconnecting the battery will reenable write protect. You can
disable SW write protect if you want to be able to rewrite RO firmware
without needing to keep the battery disconnected.
- AP > flashrom -p host --wp-disable
+ AP > futility flash --wp-disable
6. **(recommended) Run some basic commands to setup CCD.** It's really easy to
open cr50 with the battery removed. You might want to setup CCD while you
@@ -343,17 +343,13 @@ It goes into a lot more detail.
cr50 > wp disable atboot
-4. (optional) Check write protect is disabled. ccd open takes the AP out of dev
- mode, so you can reenter dev mode and check the wp status from the AP or you
- can use ccd to check.
+4. (optional) Check HW WP is disabled. ccd open takes the AP out of dev
+ mode, so you can reenter dev mode and check the HW WP status from the AP.
From AP (after reentering dev mode):
- AP > flashrom --wp-status
+ AP > crossystem wpsw_cur
- Using CCD:
-
- from chroot > flashrom -p raiden_debug_spi:target=AP --wp-status
5. **(recommended) Setup capabilities**, so you can flash the device or open
ccd without being able to boot the AP.
@@ -372,7 +368,7 @@ It goes into a lot more detail.
6. **(recommended) [Disable SW WP]** to flash RO firmware if your board has
issues disabling HW WP with the AP off.
- AP > flashrom -p host --wp-disable
+ AP > futility flash --wp-disable
[Disable SW WP]: ./case_closed_debugging_gsc.md#AP-Off
[enter dev mode]: ./case_closed_debugging_gsc.md#enter-dev-mode