summaryrefslogtreecommitdiff
path: root/docs/zephyr/zephyr_i2c.md
diff options
context:
space:
mode:
authorKeith Short <keithshort@chromium.org>2022-04-06 11:58:17 -0600
committerChromeos LUCI <chromeos-scoped@luci-project-accounts.iam.gserviceaccount.com>2022-04-08 00:54:28 +0000
commiteff19e347d68914d8ef84c021a55f046b5571831 (patch)
tree4625708eac0d6b7e5380a300589950005ca0fcab /docs/zephyr/zephyr_i2c.md
parent79b9c35043eadcd4435783e88f2e8d2a3656c736 (diff)
downloadchrome-ec-eff19e347d68914d8ef84c021a55f046b5571831.tar.gz
zephyr: convert PLATFORM_EC_I2C to a helper symbol
Convert CONFIG_PLATFORM_EC_I2C to a helper symbol that is automatically enabled if the Zephyr CONFIG_I2C option is enabled. BUG=b:217926701 BRANCH=none TEST=zmake testall Signed-off-by: Keith Short <keithshort@chromium.org> Change-Id: I5aab26b0dea609a706b07ed752503f7432848136 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3575084 Reviewed-by: Aaron Massey <aaronmassey@google.com>
Diffstat (limited to 'docs/zephyr/zephyr_i2c.md')
-rw-r--r--docs/zephyr/zephyr_i2c.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/zephyr/zephyr_i2c.md b/docs/zephyr/zephyr_i2c.md
index 7ded5b2242..4f001e4408 100644
--- a/docs/zephyr/zephyr_i2c.md
+++ b/docs/zephyr/zephyr_i2c.md
@@ -9,7 +9,7 @@ USB-C chips, battery, charging IC, and sensors.
## Kconfig Options
-The Kconfig option `CONFIG_PLATFORM_EC_I2C` enables I2C support in the EC
+The Kconfig option [`CONFIG_I2C`] enables I2C support in the EC
application. Refer to [Kconfig.i2c] for all sub-options related to I2C support.
The upstream Zephyr I2C driver also provides I2C shell commands with the
@@ -348,6 +348,7 @@ below:
[subcommands]: https://github.com/zephyrproject-rtos/zephyr/blob/f4a0ea7b43eee4d2ee735ab6beccc68c9d40a7d0/drivers/i2c/i2c_shell.c#L245
[I2C Example]: ../images/i2c_example.png
[Kconfig.i2c]: ../../zephyr/Kconfig.i2c
+[`CONFIG_I2C`]: https://docs.zephyrproject.org/latest/kconfig.html#CONFIG_I2C
[`CONFIG_I2C_SHELL`]: https://docs.zephyrproject.org/latest/kconfig.html#CONFIG_I2C_SHELL
[cros-ec-i2c-port-base.yaml]: https://source.chromium.org/chromiumos/chromiumos/codesearch/+/main:src/platform/ec/zephyr/dts/bindings/i2c/cros-ec-i2c-port-base.yaml
[volteer.dts]: https://source.chromium.org/chromiumos/chromiumos/codesearch/+/main:src/platform/ec/zephyr/boards/arm/volteer/volteer.dts;