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 <felix-coreboot@felixheld.de>
Change-Id: I1bdfcac89b81fef773938133a2699897c6ee9415
Reviewed-on: https://review.coreboot.org/c/coreboot/+/57836
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Raul Rangel <rrangel@chromium.org>
Reviewed-by: Furquan Shaikh <furquan@google.com>
This commit is contained in:
Felix Held 2021-09-22 16:01:36 +02:00 committed by Felix Held
parent a9a0b331c6
commit 05df6ec844
2 changed files with 4 additions and 2 deletions

View File

@ -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,

View File

@ -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,