[TOC]
Description of the Zephyr EC feature and the capabilities provided
Link to the file providing all the Kconfig options related to the feature. If the Kconfig options are not currently in a standalone file, consider moving the related Kconfigs into their own file.
Example CL moving I2C related configs into a new file: https://crrev.com/c/3575081
Note - Avoid documenting CONFIG_ options in the markdown as the relevant
Kconfig* contains the authoritative definition. If there is one main Kconfig
that must be enabled for the feature, mention it in this section. See the I2C
documentation for an example.
If the Kconfig file does not provide sufficient help descriptions, please fix
them.
Detail the devicetree nodes that configure the feature.
Note - avoid documenting node properties here. Point to the relevant .yaml
file instead, which contains the authoritative definition.
Document any board specific routines that a user must create to successfully compile and run. For many features, this can section can be empty.
Document any threads enabled by this feature.
Provide any tips for testing and debugging the EC feature.
It's especially helpful to document EC console commands and ectool commands
from the AP in this section. Please provide example output.
Provide code snippets from a working board to walk the user through all code that must be created to enable this feature.