summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBobby Casey <bobbycasey@google.com>2022-04-22 13:16:50 -0400
committerChromeos LUCI <chromeos-scoped@luci-project-accounts.iam.gserviceaccount.com>2022-05-09 19:42:13 +0000
commit28c0e2d4e0711b35571cca79c7b1c05fbb3edbb0 (patch)
treef3b88710f27b476811839a338159466305224b71
parentb2a8ce6511dd89054ff6e0d321fb33cda9594178 (diff)
downloadchrome-ec-28c0e2d4e0711b35571cca79c7b1c05fbb3edbb0.tar.gz
Docs: Replace Chrome OS with ChromeOS in FP docs
Per https://carbon.googleplex.com/cros-ux/pages/mechanics, "As of Q1 2022, we are using 'ChromeOS' instead of 'Chrome OS'". This commit brings all `ec/docs/fingerprint` up to compliance. BRANCH=none BUG=b:229978105 TEST=Review to verify only expected changes were made Signed-off-by: Bobby Casey <bobbycasey@google.com> Change-Id: I7f740bf4f8932e01522c07e32212f5d4a6dc6716 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3600914 Reviewed-by: Tom Hughes <tomhughes@chromium.org> Reviewed-by: Andrea Grandi <agrandi@google.com>
-rw-r--r--docs/fingerprint/fingerprint-authentication-design-doc.md6
-rw-r--r--docs/fingerprint/fingerprint-debugging.md4
-rw-r--r--docs/fingerprint/fingerprint-dev-for-partners.md4
-rw-r--r--docs/fingerprint/fingerprint-factory-quick-guide.md4
-rw-r--r--docs/fingerprint/fingerprint-factory-requirements.md20
-rw-r--r--docs/fingerprint/fingerprint-firmware-testing-for-partners.md2
-rw-r--r--docs/fingerprint/fingerprint-tpm-seed.md8
-rw-r--r--docs/fingerprint/fingerprint.md54
8 files changed, 51 insertions, 51 deletions
diff --git a/docs/fingerprint/fingerprint-authentication-design-doc.md b/docs/fingerprint/fingerprint-authentication-design-doc.md
index 3871968784..a78ca41756 100644
--- a/docs/fingerprint/fingerprint-authentication-design-doc.md
+++ b/docs/fingerprint/fingerprint-authentication-design-doc.md
@@ -1,4 +1,4 @@
-# Fingerprint Authentication on Chrome OS
+# Fingerprint Authentication on ChromeOS
Authors: norvez@google.com, vpalatin@google.com
@@ -31,7 +31,7 @@ Last Updated: 2019-01-14
To unlock their Chromebook users have to enter their password or a PIN.
[Windows] and [macOS] let the user authenticate with their fingerprint for
-faster unlocking, we want to bring that capability to Chrome OS.
+faster unlocking, we want to bring that capability to ChromeOS.
### Fingerprint matching basics
@@ -379,7 +379,7 @@ used to protect the EC in detachable keyboards as described in
The SBP has a minimalistic RO firmware that contains the public part of an
RSA-3072 exponent 3 key pair. The corresponding private key is only accessible
-by the Chrome OS signers and is used to sign SBP firmwares. On boot the RO
+by the ChromeOS signers and is used to sign SBP firmwares. On boot the RO
firmware verifies the signature of the RW firmware. If the RW signature is
valid, the RO firmware protects itself by setting the WP bit of the Flash then
jumps to RW.
diff --git a/docs/fingerprint/fingerprint-debugging.md b/docs/fingerprint/fingerprint-debugging.md
index e626be8cdc..772ea91e81 100644
--- a/docs/fingerprint/fingerprint-debugging.md
+++ b/docs/fingerprint/fingerprint-debugging.md
@@ -32,7 +32,7 @@ used for JTAG and SWD for ARM devices.
is the only software required for flashing.
* In order to perform breakpoint debugging, you will need a tool that supports
connecting `gdbserver`. This document will assume [CLion] \(Googlers see
- [CLion for Chrome OS]) and was tested with `JLink v6.94a`. Alternatively,
+ [CLion for ChromeOS]) and was tested with `JLink v6.94a`. Alternatively,
you can use [Ozone], a standalone debugger from Segger.
## JLink Software {#software}
@@ -243,7 +243,7 @@ STM32F412 package that does not have the synchronous trace pins, but the
[SWD Cable]: https://www.adafruit.com/product/1675
[Ozone]: https://www.segger.com/products/development-tools/ozone-j-link-debugger/
[CLion]: https://www.jetbrains.com/clion/
-[CLion for Chrome OS]: http://go/clion-for-chromeos
+[CLion for ChromeOS]: http://go/clion-for-chromeos
[GDB Remote Debug Configuration]: https://www.jetbrains.com/help/clion/remote-debug.html#remote-config
[CLion Start Remote Debug]: https://www.jetbrains.com/help/clion/remote-debug.html#start-remote-debug
[Nucleo STM32F412ZG]: https://www.st.com/en/evaluation-tools/nucleo-f412zg.html
diff --git a/docs/fingerprint/fingerprint-dev-for-partners.md b/docs/fingerprint/fingerprint-dev-for-partners.md
index 89694e987a..e78fde5caa 100644
--- a/docs/fingerprint/fingerprint-dev-for-partners.md
+++ b/docs/fingerprint/fingerprint-dev-for-partners.md
@@ -366,7 +366,7 @@ some docs to help you get started:
* [Git: Concepts and Workflow]: Good overview of how `git` actually works.
* [Gerrit: Concepts and Workflow]: Good overview of how Gerrit works; assumes
you understand `git` basics.
-* [Life of a patch]: Android workflow, but similar to Chrome OS.
+* [Life of a patch]: Android workflow, but similar to ChromeOS.
The Gerrit dashboard that will show your pending reviews (and ones we have for
you):
@@ -433,7 +433,7 @@ from the UI.
### Developer Mode and Write Protection
-Make sure that your fingerprint-equipped Chrome OS device is in [developer mode]
+Make sure that your fingerprint-equipped ChromeOS device is in [developer mode]
with a *test* image flashed and [hardware write protection] disabled. Using the
test image will allow you to SSH into the device and disabling hardware write
protection allows you to have full access to flashing the FPMCU firmware.
diff --git a/docs/fingerprint/fingerprint-factory-quick-guide.md b/docs/fingerprint/fingerprint-factory-quick-guide.md
index c9478bf99a..a2dd69ebe4 100644
--- a/docs/fingerprint/fingerprint-factory-quick-guide.md
+++ b/docs/fingerprint/fingerprint-factory-quick-guide.md
@@ -1,7 +1,7 @@
-# Chrome OS Fingerprint Sensor: Quick Factory Guide
+# ChromeOS Fingerprint Sensor: Quick Factory Guide
The goal of this document is to outline how ODM partners can make use of the
-existing Chrome OS factory scripts to meet Chrome OS FPS factory requirements.
+existing ChromeOS factory scripts to meet ChromeOS FPS factory requirements.
[TOC]
diff --git a/docs/fingerprint/fingerprint-factory-requirements.md b/docs/fingerprint/fingerprint-factory-requirements.md
index 1fb61dbd2f..486d103c45 100644
--- a/docs/fingerprint/fingerprint-factory-requirements.md
+++ b/docs/fingerprint/fingerprint-factory-requirements.md
@@ -1,4 +1,4 @@
-# Chrome OS Fingerprint Factory Requirements
+# ChromeOS Fingerprint Factory Requirements
This document provides an overview of factory requirements and testing for the
fingerprint sensor.
@@ -8,7 +8,7 @@ fingerprint sensor.
## Contact
For questions regarding this document, please contact the
-[Chrome OS Fingerprint Team].
+[ChromeOS Fingerprint Team].
## Terminology
@@ -39,12 +39,12 @@ For questions regarding this document, please contact the
## FPMCU Firmware Location
The binaries for the FPMCU firmware are located in `/opt/google/biod/fw`. Now
-that Chrome OS supports unibuild, there may be multiple firmware binaries in the
+that ChromeOS supports unibuild, there may be multiple firmware binaries in the
directory since multiple sensors may be used across a single "board" (e.g., the
`hatch` board can use either `bloonchipper` or `dartmonkey`).
The correct firmware type to use for a given board can be discovered with the
-[Chrome OS Config] tool:
+[ChromeOS Config] tool:
```bash
(dut) $ cros_config /fingerprint board
@@ -64,8 +64,8 @@ The corresponding firmware for the above command would be
<!-- mdformat off(b/139308852) -->
*** note
**NOTE**: If you get an empty response when running the above commands, the
-Chrome OS Config settings may not have been updated for the Chrome OS board.
-See the instructions on [updating Chrome OS Config] for fingerprint.
+ChromeOS Config settings may not have been updated for the ChromeOS board.
+See the instructions on [updating ChromeOS Config] for fingerprint.
***
<!-- mdformat on -->
@@ -146,7 +146,7 @@ In-device tests are run during the `FATP` process once the device has been fully
assembled. Google provides source code for these tests in
[`fingerprint_mcu.py`].
-Hardware Required: Chrome OS DUT before finalization.
+Hardware Required: ChromeOS DUT before finalization.
Documentation: [FPC In-Device Test Specification]
@@ -494,9 +494,9 @@ Wrote /tmp/fp.1.png (14025 bytes)
[GetSensorId]: https://chromium.googlesource.com/chromiumos/platform/factory/+/d23ebc7eeb074760e8a720e3acac4cfe4073b2ae/py/test/utils/fpmcu_utils.py#65
[ProcessResetPixelImage]: https://chromium.googlesource.com/chromiumos/platform/factory/+/d23ebc7eeb074760e8a720e3acac4cfe4073b2ae/py/test/pytests/fingerprint_mcu.py#268
[rubber_finger_present]: https://chromium.googlesource.com/chromiumos/platform/factory/+/d23ebc7eeb074760e8a720e3acac4cfe4073b2ae/py/test/pytests/fingerprint_mcu.py#330
-[Chrome OS Fingerprint Team]: http://go/cros-fingerprint-docs
+[ChromeOS Fingerprint Team]: http://go/cros-fingerprint-docs
[Factory Fingerprint Sensor Testing for `nocturne`]: http://go/fingerprint-factory-testing-nocturne
[`flash_fp_mcu`]: https://chromium.googlesource.com/chromiumos/platform/ec/+/HEAD/util/flash_fp_mcu
[Fingerprint flashing documentation]: ./fingerprint.md#factory-rma-dev-updates
-[Chrome OS Config]: https://chromium.googlesource.com/chromiumos/platform2/+/HEAD/chromeos-config/README.md
-[updating Chrome OS Config]: ./fingerprint.md#update-chromeos-config
+[ChromeOS Config]: https://chromium.googlesource.com/chromiumos/platform2/+/HEAD/chromeos-config/README.md
+[updating ChromeOS Config]: ./fingerprint.md#update-chromeos-config
diff --git a/docs/fingerprint/fingerprint-firmware-testing-for-partners.md b/docs/fingerprint/fingerprint-firmware-testing-for-partners.md
index 3432bb0aac..c1a8456a3e 100644
--- a/docs/fingerprint/fingerprint-firmware-testing-for-partners.md
+++ b/docs/fingerprint/fingerprint-firmware-testing-for-partners.md
@@ -1,7 +1,7 @@
# Fingerprint Firmware Testing Instructions for Partners
This document is intended to help partners (sensor vendors, MCU vendors, etc)
-run the Chrome OS fingerprint team's firmware tests, as part of the AVL process.
+run the ChromeOS fingerprint team's firmware tests, as part of the AVL process.
The document assumes that you‘re using Linux to do the development; preferably a
recent version of Ubuntu or Debian. It may be possible to use a virtual machine,
but that is not a configuration we test.
diff --git a/docs/fingerprint/fingerprint-tpm-seed.md b/docs/fingerprint/fingerprint-tpm-seed.md
index 904fb7243a..84b9e1aa40 100644
--- a/docs/fingerprint/fingerprint-tpm-seed.md
+++ b/docs/fingerprint/fingerprint-tpm-seed.md
@@ -18,7 +18,7 @@ TPM during boot in mount-encrypted.
## Background
-Fingerprint authorization in Chrome OS, relies on encrypted FP templates which
+Fingerprint authorization in ChromeOS, relies on encrypted FP templates which
are stored in each user’s mount directory. These templates are created and
encrypted by the FPMCU during FP enrollment, before being sent back to the AP
(Application Processor). When the user logs in, these templates are sent to the
@@ -30,7 +30,7 @@ obtained by and attacker from the user mount directory, they cannot be
decrypted, since the attacker will not have access to the MCU entropy. This
entropy gets reset on every powerwash/recovery.
-The complete design doc is [Fingerprint Authentication on Chrome OS].
+The complete design doc is [Fingerprint Authentication on ChromeOS].
## Requirements and Scale
@@ -303,10 +303,10 @@ then set TPM.
## Privacy Considerations
This implementation should not have any adverse implications on Privacy (over
-and above existing functionality on Chrome OS). This provides security hardening
+and above existing functionality on ChromeOS). This provides security hardening
for the fingerprint templates to prevent their retrieval and mis-use.
-[Fingerprint Authentication on Chrome OS]: ../fingerprint/fingerprint-authentication-design-doc.md
+[Fingerprint Authentication on ChromeOS]: ../fingerprint/fingerprint-authentication-design-doc.md
[`SBP_Src_Key`]: ../fingerprint/fingerprint-authentication-design-doc.md#sbp-secret-generation
[IPC Mechanism]: #ipc
[minijail0 arguments]: https://source.chromium.org/chromiumos/chromiumos/codesearch/+/main:src/platform2/biod/init/bio_crypto_init.conf;l=36;drc=1fcefaa166e868069ad1b81091333ff75e0657f6
diff --git a/docs/fingerprint/fingerprint.md b/docs/fingerprint/fingerprint.md
index a111daafce..1185ef131c 100644
--- a/docs/fingerprint/fingerprint.md
+++ b/docs/fingerprint/fingerprint.md
@@ -45,14 +45,14 @@ Sensor | Fingerprint Template Size
### Determining Hardware {#chromeos-config-fingerprint}
-If you have access to a shell on your Chromebook, you can use [Chrome OS Config]
+If you have access to a shell on your Chromebook, you can use [ChromeOS Config]
to determine the FPMCU that it contains:
```bash
(dut) $ cros_config /fingerprint board
```
-Alternatively, if you have a Chromium OS build, you can use [Chrome OS Config]
+Alternatively, if you have a Chromium OS build, you can use [ChromeOS Config]
in the chroot to determine the FPMCU:
```bash
@@ -62,8 +62,8 @@ in the chroot to determine the FPMCU:
<!-- mdformat off(b/139308852) -->
*** note
**NOTE**: If you get an empty response when running these commands, the
-[Chrome OS Config] properties for fingerprint may not have been set up yet. See
-the [section on updating Chrome OS Config](#update-chromeos-config).
+[ChromeOS Config] properties for fingerprint may not have been set up yet. See
+the [section on updating ChromeOS Config](#update-chromeos-config).
***
<!-- mdformat on -->
@@ -411,25 +411,25 @@ measure releases before that point.
@@ pp3300_dx_mcu_mw 174 5.47 0.10 5.48 4.17
```
-## Chrome OS Build (portage / ebuild)
+## ChromeOS Build (portage / ebuild)
-In order to use the fingerprint sensor with a given [Chrome OS board], a few
-things need to be configured for the [Chrome OS board].
+In order to use the fingerprint sensor with a given [ChromeOS board], a few
+things need to be configured for the [ChromeOS board].
### Enable biod USE flag
-The biod [`USE` flag] needs to be enabled for the [Chrome OS board]. This `USE`
+The biod [`USE` flag] needs to be enabled for the [ChromeOS board]. This `USE`
flag
[determines whether the `biod` daemon is built and installed][biod chromium-os].
-To enable the `USE` flag, update the `make.defaults` for the [Chrome OS board].
+To enable the `USE` flag, update the `make.defaults` for the [ChromeOS board].
See the [`make.defaults` for the Hatch board][hatch make.defaults] as an
example.
#### Verifying biod is installed in the rootfs
After enabling the `biod` [`USE` flag] and building the `biod` package for your
-target [Chrome OS board], the `biod` binary should be in the build directory:
+target [ChromeOS board], the `biod` binary should be in the build directory:
```bash
(chroot) $ emerge-<BOARD> biod
@@ -443,7 +443,7 @@ target [Chrome OS board], the `biod` binary should be in the build directory:
### Update FPMCU_FIRMWARE
`FPMCU_FIRMWARE` should be set to the set of fingerprint firmware that should be
-built and installed for the [Chrome OS board].
+built and installed for the [ChromeOS board].
`FPMCU_FIRMWARE` is a [`USE_EXPAND` variable][`USE` flag],
[defined in the base `make.defaults`][FPMCU_FIRMWARE make.defaults].
@@ -485,18 +485,18 @@ firmware by setting `FPMCU_FIRMWARE="bloonchipper dartmonkey"`. The actual
version numbers displayed will not necessarily match since the firmware is
constantly updated.
-### Update Chrome OS Config {#update-chromeos-config}
+### Update ChromeOS Config {#update-chromeos-config}
-With "unibuild", the same OS image (build) for a given [Chrome OS board] is used
+With "unibuild", the same OS image (build) for a given [ChromeOS board] is used
across multiple devices. Often there will be some devices that have a
fingerprint sensor, some that do not, and even different sensors for the same
board.
-Determining what fingerprint hardware is on a given [Chrome OS board] is thus
-done at runtime, using [Chrome OS Config].
+Determining what fingerprint hardware is on a given [ChromeOS board] is thus
+done at runtime, using [ChromeOS Config].
The `fingerprint` config needs to be in the `model.yaml` for the given
-[Chrome OS board]. The [Chrome OS Config fingerprint] section describes the
+[ChromeOS board]. The [ChromeOS Config fingerprint] section describes the
attributes for the `fingerprint` config in more detail.
The [`ec_extras` attribute] needs to be set to the list of fingerprint firmware
@@ -505,7 +505,7 @@ that should be built as part of the build.
See the [`model.yaml` for the Hatch board][hatch model.yaml] as an example.
Instead of crafting the `model.yaml` by hand, newer boards are moving to the
-[Chrome OS Project Configuration] model, where the config is generated using
+[ChromeOS Project Configuration] model, where the config is generated using
[Starlark]. The common [`create_fingerprint`] function can be used across models
to configure the fingerprint settings. See the [Morphius `config.star`] for an
example of how to call `create_fingerprint`. After you modify a `config.star`
@@ -514,18 +514,18 @@ projects (e.g., modifying [`create_fingerprint`]), you can use the [`CLFactory`]
tool.
Once you have updated the config, you can test your changes by
-[running `cros_config`](#chromeos-config-fingerprint). The Chrome OS Config
+[running `cros_config`](#chromeos-config-fingerprint). The ChromeOS Config
documentation has a [section on testing properties] that describes this in more
detail.
### SKUs
The fingerprint sensor may only be included on certain SKUs for a given device.
-The fingerprint code uses [Chrome OS Config] to determine whether a device has a
+The fingerprint code uses [ChromeOS Config] to determine whether a device has a
fingerprint sensor or not. For each SKU, there is an associated
-[fingerprint config][Chrome OS Config fingerprint]. [Chrome OS Config]
-determines the [SKU information][Chrome OS Config SKU] (and thus the
-[fingerprint config][Chrome OS Config fingerprint]) from [CBI Info]. The SKU for
+[fingerprint config][ChromeOS Config fingerprint]. [ChromeOS Config]
+determines the [SKU information][ChromeOS Config SKU] (and thus the
+[fingerprint config][ChromeOS Config fingerprint]) from [CBI Info]. The SKU for
a given device can be found by viewing `chrome://system/#platform_identity_sku`.
## Kernel Driver
@@ -560,10 +560,10 @@ that are connected via UART use [`cros_ec_uart.c`].
[cros_ec_debugfs]: https://chromium.googlesource.com/chromiumos/third_party/kernel/+/9db44685934a2e4bc9180ea2de87a6c429672395/drivers/platform/chrome/cros_ec_debugfs.c
[Fingerprint Factory Requirements]: ./fingerprint-factory-requirements.md
[Chromium OS test image]: https://chromium.googlesource.com/chromiumos/platform/factory/+/HEAD/README.md#building-test-image
-[Chrome OS Config]: https://chromium.googlesource.com/chromiumos/platform2/+/HEAD/chromeos-config/README.md
-[Chrome OS Config fingerprint]: https://chromium.googlesource.com/chromiumos/platform2/+/HEAD/chromeos-config/README.md#fingerprint
+[ChromeOS Config]: https://chromium.googlesource.com/chromiumos/platform2/+/HEAD/chromeos-config/README.md
+[ChromeOS Config fingerprint]: https://chromium.googlesource.com/chromiumos/platform2/+/HEAD/chromeos-config/README.md#fingerprint
[section on testing properties]: https://chromium.googlesource.com/chromiumos/platform2/+/HEAD/chromeos-config/README.md#adding-and-testing-new-properties
-[Chrome OS board]: https://chromium.googlesource.com/chromiumos/docs/+/HEAD/developer_guide.md#Select-a-board
+[ChromeOS board]: https://chromium.googlesource.com/chromiumos/docs/+/HEAD/developer_guide.md#Select-a-board
[biod chromium-os]: https://chromium.googlesource.com/chromiumos/overlays/chromiumos-overlay/+/4ea72b588af3394cb9fd1c330dcf726472183dfd/virtual/target-chromium-os/target-chromium-os-1.ebuild#154
[hatch make.defaults]: https://chromium.googlesource.com/chromiumos/overlays/board-overlays/+/2f075f0e7ce09d3eb460f3c529da463a6201276c/overlay-hatch/profiles/base/make.defaults#22
[Hatch baseboard `make.defaults`]: https://chrome-internal.googlesource.com/chromeos/overlays/baseboard-hatch-private/+/HEAD/profiles/base/make.defaults#17
@@ -590,8 +590,8 @@ that are connected via UART use [`cros_ec_uart.c`].
[Nucleo F412ZG]: https://www.digikey.com/en/products/detail/stmicroelectronics/NUCLEO-F412ZG/6137573
[Nucleo H743ZI2]: https://www.digikey.com/en/products/detail/stmicroelectronics/NUCLEO-H743ZI2/10130892
[CBI Info]: https://chromium.googlesource.com/chromiumos/docs/+/HEAD/design_docs/cros_board_info.md
-[Chrome OS Config SKU]: https://chromium.googlesource.com/chromiumos/platform2/+/HEAD/chromeos-config/README.md#identity
-[Chrome OS Project Configuration]: https://chromium.googlesource.com/chromiumos/config/+/HEAD/README.md
+[ChromeOS Config SKU]: https://chromium.googlesource.com/chromiumos/platform2/+/HEAD/chromeos-config/README.md#identity
+[ChromeOS Project Configuration]: https://chromium.googlesource.com/chromiumos/config/+/HEAD/README.md
[Starlark]: https://docs.bazel.build/versions/main/skylark/language.html
[`create_fingerprint`]: https://chromium.googlesource.com/chromiumos/config/+/e1fa0d7f56eb3dd6e9378e4326de086ada46b7d3/util/hw_topology.star#444
[Morphius `config.star`]: https://chrome-internal.googlesource.com/chromeos/project/zork/morphius/+/593b657a776ed6b320c826916adc9cd845faf709/config.star#85