summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFabio Baltieri <fabiobaltieri@google.com>2022-11-02 12:17:59 +0000
committerChromeos LUCI <chromeos-scoped@luci-project-accounts.iam.gserviceaccount.com>2022-11-09 10:18:08 +0000
commit34780313d94adc7988b7926e03b707c5ec37a0ec (patch)
tree55f29abbce5fed3d579b0ecce4ef2e2a0c2c2498 /docs
parent7f7528f4a06ef78a068a8b949d7bd08ae9773b3c (diff)
downloadchrome-ec-34780313d94adc7988b7926e03b707c5ec37a0ec.tar.gz
zephyr: bindings: rename named-cbi-ssfc to cros-ec,cbi-ssfc
Rename the SSFC dts bindings for consistency with the FW_CONFIG ones. BRANCH=none BUG=none TEST=cq dry run Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com> Change-Id: Ic47e60948ca6cf3face5903ecbfc8d9b3d0b6c7e Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3999727 Reviewed-by: Abe Levkoy <alevkoy@chromium.org> Code-Coverage: Zoss <zoss-cl-coverage@prod.google.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/zephyr/zephyr_ssfc.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/docs/zephyr/zephyr_ssfc.md b/docs/zephyr/zephyr_ssfc.md
index d40fdbc9c4..6a3fe079d3 100644
--- a/docs/zephyr/zephyr_ssfc.md
+++ b/docs/zephyr/zephyr_ssfc.md
@@ -25,11 +25,11 @@ Device tree is used to define and specify the field sizes and values.
## Devicetree Nodes
-The [`SSFC`] device tree nodes are defined via the [`named-cbi-ssfc`] and
-[`named-cbi-ssfc-value`] YAML bindings.
+The [`SSFC`] device tree nodes are defined via the [`cros-ec,cbi-ssfc`] and
+[`cros-ec,cbi-ssfc-value`] YAML bindings.
-The [`named-cbi-ssfc`] bindings define the name and size of each field.
-The [`named-cbi-ssfc-value`] bindings allow names/values to be defined for each
+The [`cros-ec,cbi-ssfc`] bindings define the name and size of each field.
+The [`cros-ec,cbi-ssfc-value`] bindings allow names/values to be defined for each
value that may be stored in the field.
One of the values may be designated as the default, which is used if
the [`CBI`] data cannot be accessed.
@@ -41,12 +41,12 @@ value is used as a default, indicating the default field.
An example definition is:
```
cbi-ssfc {
- compatible = "named-cbi-ssfc";
+ compatible = "cros-ec,cbi-ssfc";
base_sensor {
enum-name = "BASE_SENSOR";
size = <3>;
base_sensor_0: bmi160 {
- compatible = "named-cbi-ssfc-value";
+ compatible = "cros-ec,cbi-ssfc-value";
status = "okay";
value = <1>;
};
@@ -55,7 +55,7 @@ cbi-ssfc {
enum-name = "LID_SENSOR";
size = <3>;
lid_sensor_0: bma255 {
- compatible = "named-cbi-ssfc-value";
+ compatible = "cros-ec,cbi-ssfc-value";
status = "okay";
value = <1>;
};
@@ -64,7 +64,7 @@ cbi-ssfc {
enum-name = "LIGHTBAR";
size = <2>;
lightbar_0: 10_led {
- compatible = "named-cbi-ssfc-value";
+ compatible = "cros-ec,cbi-ssfc-value";
status = "okay";
value = <1>;
};
@@ -99,6 +99,6 @@ The [`ectool cbi`] command can be used to read and set the [`SSFC`].
[`CBI`]: https://chromium.googlesource.com/chromiumos/docs/+/HEAD/design_docs/cros_board_info.md
[`CBI Configuration`]: ./zephyr_cbi.md
[`ectool cbi`]: ./zephyr_cbi.md#testing-and-debugging
-[`named-cbi-ssfc`]: ../../zephyr/dts/bindings/cbi/named-cbi-fw-config.yaml
-[`named-cbi-ssfc-value`]: ../../zephyr/dts/bindings/cbi/named-cbi-fw-config-value.yaml
+[`cros-ec,cbi-ssfc`]: ../../zephyr/dts/bindings/cbi/cros-ec,cbi-fw-config.yaml
+[`cros-ec,cbi-ssfc-value`]: ../../zephyr/dts/bindings/cbi/cros-ec,cbi-fw-config-value.yaml
[`SSFC`]: https://chromium.googlesource.com/chromiumos/docs/+/HEAD/design_docs/firmware_config.md