From 05df6ec8449355f5205807b84e7a6ba87252cf27 Mon Sep 17 00:00:00 2001 From: Felix Held Date: Wed, 22 Sep 2021 16:01:36 +0200 Subject: soc/amd,intel/common/include/gpio: improve documentation of overrides Explicitly point out that gpio_configure_pads_with_override will ignore GPIOs that are only in the override configuration, but not in the base configuration. Signed-off-by: Felix Held Change-Id: I1bdfcac89b81fef773938133a2699897c6ee9415 Reviewed-on: https://review.coreboot.org/c/coreboot/+/57836 Tested-by: build bot (Jenkins) Reviewed-by: Raul Rangel Reviewed-by: Furquan Shaikh --- src/soc/amd/common/block/include/amdblocks/gpio_banks.h | 3 ++- src/soc/intel/common/block/include/intelblocks/gpio.h | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) (limited to 'src/soc') diff --git a/src/soc/amd/common/block/include/amdblocks/gpio_banks.h b/src/soc/amd/common/block/include/amdblocks/gpio_banks.h index bb82c10d75..489bb5c619 100644 --- a/src/soc/amd/common/block/include/amdblocks/gpio_banks.h +++ b/src/soc/amd/common/block/include/amdblocks/gpio_banks.h @@ -67,7 +67,8 @@ static inline bool is_gpio_event_active_low(uint32_t flags) * This function configures raw pads in base config and applies override in * override config if any. Thus, for every GPIO_x in base config, this function * looks up the GPIO in override config and if it is present there, then applies - * the configuration from override config. + * the configuration from override config. GPIOs that are only specified in the + * override, but not in the base configuration, will be ignored. */ void gpio_configure_pads_with_override(const struct soc_amd_gpio *base_cfg, size_t base_num_pads, diff --git a/src/soc/intel/common/block/include/intelblocks/gpio.h b/src/soc/intel/common/block/include/intelblocks/gpio.h index 8496db32c5..c47f908e8c 100644 --- a/src/soc/intel/common/block/include/intelblocks/gpio.h +++ b/src/soc/intel/common/block/include/intelblocks/gpio.h @@ -186,7 +186,8 @@ void gpio_configure_pads(const struct pad_config *cfg, size_t num_pads); * This function configures raw pads in base config and applies override in * override config if any. Thus, for every GPIO_x in base config, this function * looks up the GPIO in override config and if it is present there, then applies - * the configuration from override config. + * the configuration from override config. GPIOs that are only specified in the + * override, but not in the base configuration, will be ignored. */ void gpio_configure_pads_with_override(const struct pad_config *base_cfg, size_t base_num_pads, -- cgit v1.2.3