CoffeeLake Intel(R) Firmware Support Package (FSP) Integration Guide
Header file for GpioConfig structure used by GPIO library. More...
Go to the source code of this file.
|GPIO configuration structure used for pin programming. More...|
|Mask for GPIO_INT_CONFIG for interrupt source. |
|Mask for GPIO_INT_CONFIG for interrupt type. |
|Mask for GPIO_ELECTRICAL_CONFIG for termination value. |
|Mask for GPIO_LOCK_CONFIG for Pad Configuration Lock. |
|Mask for GPIO_LOCK_CONFIG for Pad Output Lock. |
|Mask for GPIO_OTHER_CONFIG for RxRaw1 setting. |
|For any GpioPad usage in code use GPIO_PAD type. |
|For any GpioGroup usage in code use GPIO_GROUP type. |
|GPIO Pad Mode Refer to GPIO documentation on native functions available for certain pad. More...|
|Host Software Pad Ownership modes This setting affects GPIO interrupt status registers. More...|
|GPIO Direction. More...|
|GPIO Output State This field is relevant only if output is enabled. More...|
|GPIO interrupt configuration This setting is applicable only if pad is in GPIO mode and has input enabled. More...|
|GPIO Power Configuration GPIO_RESET_CONFIG allows to set GPIO Reset type (PADCFG_DW0.PadRstCfg) which will be used to reset certain GPIO settings. More...|
|GPIO Electrical Configuration Configuration options for GPIO termination setting. More...|
|GPIO LockConfiguration Set GPIO configuration lock and output state lock. More...|
|Other GPIO Configuration GPIO_OTHER_CONFIG is used for less often settings and for future extensions Supported settings: More...|
Header file for GpioConfig structure used by GPIO library.
- Copyright (c) 2014 - 2017, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
- Specification Reference:
Definition in file GpioConfig.h.
Enumeration Type Documentation
Definition at line 149 of file GpioConfig.h.
GPIO Electrical Configuration Configuration options for GPIO termination setting.
Definition at line 264 of file GpioConfig.h.
Leave setting unmodified.
Definition at line 99 of file GpioConfig.h.
Host Software Pad Ownership modes This setting affects GPIO interrupt status registers.
Depending on chosen ownership some GPIO Interrupt status register get updated and other masked. Please refer to EDS for HOSTSW_OWN register description.
Definition at line 128 of file GpioConfig.h.
GPIO interrupt configuration This setting is applicable only if pad is in GPIO mode and has input enabled.
GPIO_INT_CONFIG allows to choose which interrupt is generated (IOxAPIC/SCI/SMI/NMI) and how it is triggered (edge or level). Refer to PADCFG_DW0 register description in EDS for details on this settings. Field from GpioIntNmi to GpioIntApic can be OR'ed with GpioIntLevel to GpioIntBothEdge to describe an interrupt e.g. GpioIntApic | GpioIntLevel If GPIO is set to cause an SCI then also GPI_GPE_EN is enabled for this pad. If GPIO is set to cause an NMI then also GPI_NMI_EN is enabled for this pad. Not all GPIO are capable of generating an SMI or NMI interrupt. When routing GPIO to cause an IOxAPIC interrupt care must be taken, as this interrupt cannot be shared and its IRQn number is not configurable. Refer to EDS for GPIO pads IRQ numbers (PADCFG_DW1.IntSel) If GPIO is under GPIO OS driver control and appropriate ACPI GpioInt descriptor exist then use only trigger type setting (from GpioIntLevel to GpioIntBothEdge). This type of GPIO Driver interrupt doesn't have any additional routing setting required to be set by BIOS. Interrupt is handled by GPIO OS Driver.
Definition at line 189 of file GpioConfig.h.
GPIO LockConfiguration Set GPIO configuration lock and output state lock.
GpioPadConfigUnlock/Lock and GpioOutputStateUnlock can be OR'ed. By default GPIO pads will be locked unless GPIO lib is explicitly informed that certain pad is to be left unlocked. Lock settings reset is in Powergood domain. Care must be taken when using this setting as fields it locks may be reset by a different signal and can be controlled by what is in GPIO_RESET_CONFIG (PADCFG_DW0.PadRstCfg). GPIO library provides functions which allow to unlock a GPIO pad. If possible each GPIO lib function will try to unlock an already locked pad upon request for reconfiguration
Definition at line 297 of file GpioConfig.h.
Other GPIO Configuration GPIO_OTHER_CONFIG is used for less often settings and for future extensions Supported settings:
- RX raw override to '1' - allows to override input value to '1' This setting is applicable only if in input mode (both in GPIO and native usage). The override takes place at the internal pad state directly from buffer and before the RXINV.
Use default input override value.
Don't override input.
Override input to '1'.
Definition at line 323 of file GpioConfig.h.
GPIO Output State This field is relevant only if output is enabled.
Leave output value unmodified.
Set output to low.
Set output to high.
Definition at line 163 of file GpioConfig.h.
GPIO Pad Mode Refer to GPIO documentation on native functions available for certain pad.
If GPIO is set to one of NativeX modes then following settings are not applicable and can be skipped:
- Interrupt related settings
- Host Software Ownership
- Output/Input enabling/disabling
- Output lock
Definition at line 113 of file GpioConfig.h.
GPIO Power Configuration GPIO_RESET_CONFIG allows to set GPIO Reset type (PADCFG_DW0.PadRstCfg) which will be used to reset certain GPIO settings.
Refer to EDS for settings that are controllable by PadRstCfg.
Definition at line 211 of file GpioConfig.h.
Generated on Wed Aug 22 2018 17:48:55 for CoffeeLake Intel(R) Firmware Support Package (FSP) Integration Guide by 1.8.10