summaryrefslogtreecommitdiff
path: root/docs/write_protection.md
diff options
context:
space:
mode:
authorTom Hughes <tomhughes@chromium.org>2020-11-20 08:35:27 -0800
committerCommit Bot <commit-bot@chromium.org>2020-12-07 17:22:57 +0000
commitb5f739adf69cf118679f4100813abcd2d6a6892a (patch)
tree20f39a9ef0258f156387fd0b98cca585305eb8ba /docs/write_protection.md
parentdb461b09acd6c09a9ece4e13f47f724b45c314e5 (diff)
downloadchrome-ec-b5f739adf69cf118679f4100813abcd2d6a6892a.tar.gz
docs: Fix headers in write protection doc
gitiles doesn't render backticks in headers. BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I312799ad938d35e8452a90d129baf933ff6639e0 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2552603 Reviewed-by: Jack Rosenthal <jrosenth@chromium.org>
Diffstat (limited to 'docs/write_protection.md')
-rw-r--r--docs/write_protection.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/write_protection.md b/docs/write_protection.md
index 2ef32a869e..248aa718ca 100644
--- a/docs/write_protection.md
+++ b/docs/write_protection.md
@@ -129,9 +129,9 @@ flashprotect enable/disable`, which sends the `EC_CMD_FLASH_PROTECT` command
toggling `EC_FLASH_PROTECT_RO_AT_BOOT` (changing `--name` to target different
ECs).
-### Changing Software Write Protection with `ectool`
+### Changing Software Write Protection with ectool
-#### `ectool flashprotect`
+#### ectool flashprotect
Print out current flash protection state.
@@ -168,17 +168,17 @@ Flags:
* `INCONSISTENT` - One or more banks of flash is not protected when it should
be (should not happen during normal operation. Read only.).
-#### `ectool flashprotect enable`
+#### ectool flashprotect enable
Set `ro_at_boot` flag. The next time the EC is reset it will protect the flash.
Note that this requires a cold reset.
-#### `ectool flashprotect enable now`
+#### ectool flashprotect enable now
Set `ro_at_boot` `ro_now all_now` flags and immediately protect the flash. Note
that this will fail if hardware write protect is disabled.
-#### `ectool flashprotect disable`
+#### ectool flashprotect disable
Clear `ro_at_boot` flag. This can only be cleared if the EC booted without
hardware write protect enabled.
@@ -188,7 +188,7 @@ If the `ro_at_boot` flag set and the EC resets with the HW gpio disabled, the EC
will leave the flash unprotected (`ro_now` and `all_now` flags are not set) but
leave `ro_at_boot` flag set.
-### Changing Software Write Protection with `flashrom`
+### Changing Software Write Protection with flashrom
#### View the current state of software write protection
@@ -261,7 +261,7 @@ WP: write protect range: start=0x00000000, len=0x00000000
SUCCESS
```
-## `system_is_locked()`
+## system_is_locked()
The [`system_is_locked()`] function in the EC code returns false if the HW write
protect GPIO is disabled or the read-only firmware is not protected.