diff options
Diffstat (limited to 'docs/zephyr/zephyr_ap_power.md')
| -rw-r--r-- | docs/zephyr/zephyr_ap_power.md | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/docs/zephyr/zephyr_ap_power.md b/docs/zephyr/zephyr_ap_power.md new file mode 100644 index 0000000000..0b95e375d6 --- /dev/null +++ b/docs/zephyr/zephyr_ap_power.md @@ -0,0 +1,58 @@ +# Zephyr EC AP Power Requirements + +[TOC] + +## Overview + +[AP] power configures the minimum amount of power needed to boot the Application +Processor. + +## Kconfig Options + +The Kconfig option `CONFIG_PLATFORM_EC_BOOT_AP_POWER_REQUIREMENTS` enables checking power +thresholds before booting the AP. See the file [Kconfig.ap_power] for all Kconfig +options related to this feature. + +## Devicetree Nodes + +None required. + +## Board Specific Code + +None required. + +## Threads + +AP_POWER support does not enable any threads. + +## Testing and Debugging + +Use the battfake command to force the battery level, independent of the actual battery charge. +To verify the AP power thresholds, force the battery level below the +`CONFIG_PLATFORM_EC_CHARGER_MIN_BAT_PCT_FOR_POWER_ON` setting and reboot the EC. +The EC should prevent the AP from powering up. + +`battfake` usage: battfake <percent> (-1 = use real level) + +``` +battfake 2 +reboot +/* Verify that AP does ot boot */ +battfak3 3 +/* Verify that AP boots */ +/* Restore normal operation */ +battfake -1 +``` +## Example + +For Herobrine, the minimum battery level to boot the AP without AC is 2 percent +of the battery capacity and the minimum AC power to boot the AP with a battery +is set to 10000 milliwats. + +``` +CONFIG_PLATFORM_EC_CHARGER_MIN_BAT_PCT_FOR_POWER_ON=2 +CONFIG_PLATFORM_EC_CHARGER_MIN_POWER_MW_FOR_POWER_ON=10000 +``` + +[AP]: ../ec_terms.md#ap +[Kconfig.ap_power]: https://source.chromium.org/chromiumos/chromiumos/codesearch/+/main:src/platform/ec/zephyr/Kconfig.ap_power |