enum IGPIO.Bit0_t |
|
GPIO Bit 0 Definitions
enum Bit0_t {
BIT0_OFF,
BIT0
};
enum IGPIO.Bit1_t |
|
enum Bit1_t {
BIT1_OFF,
BIT1
};
enum IGPIO.Bit2_t |
|
enum Bit2_t {
BIT2_OFF,
BIT2
};
enum IGPIO.Bit3_t |
|
enum Bit3_t {
BIT3_OFF,
BIT3
};
enum IGPIO.Bit4_t |
|
enum Bit4_t {
BIT4_OFF,
BIT4
};
enum IGPIO.Bit5_t |
|
enum Bit5_t {
BIT5_OFF,
BIT5
};
enum IGPIO.Bit6_t |
|
enum Bit6_t {
BIT6_OFF,
BIT6
};
enum IGPIO.Bit7_t |
|
enum Bit7_t {
BIT7_OFF,
BIT7
};
typedef IGPIO.IPeripheralArray |
|
typedef IGPIO.StringArray |
|
typedef String StringArray[];
struct IGPIO.DevicePinFunctionSetting_t |
|
Device Pin Functional Setting Descriptor
metaonly struct DevicePinFunctionSetting_t {
UInt functionIndex;
Any owner;
};
DETAILS
Type to store the selected pin configuration and a reference
to the object that last modified the configuration.
SEE
struct IGPIO.DevicePinFunction_t |
|
Device Pin Functional Descriptor
metaonly struct DevicePinFunction_t {
String functionName[];
};
DETAILS
Type to describe how a device pin is configured for all its
different uses that are possible. The function names are consolidated
in one String array rather than located together with the function-
specific data to allow easier access by Grace widgets. The functionConfig
member contains an arbitrary-length array describing all register
settings that need to be performed to configure a certain function.
SEE
struct IGPIO.DevicePin_t |
|
Device Pin Descriptor
metaonly struct DevicePin_t {
String pinName;
};
DETAILS
Type to describe a single device pin and all its possible
configurations.
SEE
struct IGPIO.DeviceRegisterConfig_t |
|
Device Register Configuration Descriptor
metaonly struct DeviceRegisterConfig_t {
String register;
UInt bitSetMask;
UInt bitClearMask;
};
DETAILS
Type to describe how a register is configured for a particular
use. The type allows setting and clearing of an arbitrary bit
pattern inside the specified register.
SEE
struct IGPIO.ForceSetDefaultRegister_t |
|
Force Set Default Register
metaonly struct ForceSetDefaultRegister_t {
String register;
Bool regForceSet;
};
DETAILS
Type to store if each register needs to be forced initialized
even if the register is in default state.
SEE
struct IGPIO.GpioBits8PxDir_t |
|
Generic GPIO 8-bit PxDIR Register
metaonly struct GpioBits8PxDir_t {
// GPIO Select Direction Bit 0
Bit = 0: The port pin is switched to input direction
Bit = 1: The port pin is switched to output direction
// GPIO Select Direction Bit 1
Bit = 0: The port pin is switched to input direction
Bit = 1: The port pin is switched to output direction
// GPIO Select Direction Bit 2
Bit = 0: The port pin is switched to input direction
Bit = 1: The port pin is switched to output direction
// GPIO Select Direction Bit 3
Bit = 0: The port pin is switched to input direction
Bit = 1: The port pin is switched to output direction
// GPIO Select Direction Bit 4
Bit = 0: The port pin is switched to input direction
Bit = 1: The port pin is switched to output direction
// GPIO Select Direction Bit 5
Bit = 0: The port pin is switched to input direction
Bit = 1: The port pin is switched to output direction
// GPIO Select Direction Bit 6
Bit = 0: The port pin is switched to input direction
Bit = 1: The port pin is switched to output direction
// GPIO Select Direction Bit 7
Bit = 0: The port pin is switched to input direction
Bit = 1: The port pin is switched to output direction
};
SEE
struct IGPIO.GpioBits8PxIe_t |
|
Generic GPIO 8-bit PxIE Register
metaonly struct GpioBits8PxIe_t {
// GPIO Interrupt Enable Bit 0
Bit = 0: The interrupt is disabled.
Bit = 1: The interrupt is enabled
// GPIO Interrupt Enable Bit 1
Bit = 0: The interrupt is disabled.
Bit = 1: The interrupt is enabled
// GPIO Interrupt Enable Bit 2
Bit = 0: The interrupt is disabled.
Bit = 1: The interrupt is enabled
// GPIO Interrupt Enable Bit 3
Bit = 0: The interrupt is disabled.
Bit = 1: The interrupt is enabled
// GPIO Interrupt Enable Bit 4
Bit = 0: The interrupt is disabled.
Bit = 1: The interrupt is enabled
// GPIO Interrupt Enable Bit 5
Bit = 0: The interrupt is disabled.
Bit = 1: The interrupt is enabled
// GPIO Interrupt Enable Bit 6
Bit = 0: The interrupt is disabled.
Bit = 1: The interrupt is enabled
// GPIO Interrupt Enable Bit 7
Bit = 0: The interrupt is disabled.
Bit = 1: The interrupt is enabled
};
SEE
struct IGPIO.GpioBits8PxIes_t |
|
Generic GPIO 8-bit PxIES Register
metaonly struct GpioBits8PxIes_t {
// GPIO Select Interrupt Edge Bit 0
Bit = 0: The PxIFGx flag is set with a low-to-high transition
Bit = 1: The PxIFGx flag is set with a high-to-low transition
// GPIO Select Interrupt Edge Bit 1
Bit = 0: The PxIFGx flag is set with a low-to-high transition
Bit = 1: The PxIFGx flag is set with a high-to-low transition
// GPIO Select Interrupt Edge Bit 2
Bit = 0: The PxIFGx flag is set with a low-to-high transition
Bit = 1: The PxIFGx flag is set with a high-to-low transition
// GPIO Select Interrupt Edge Bit 3
Bit = 0: The PxIFGx flag is set with a low-to-high transition
Bit = 1: The PxIFGx flag is set with a high-to-low transition
// GPIO Select Interrupt Edge Bit 4
Bit = 0: The PxIFGx flag is set with a low-to-high transition
Bit = 1: The PxIFGx flag is set with a high-to-low transition
// GPIO Select Interrupt Edge Bit 5
Bit = 0: The PxIFGx flag is set with a low-to-high transition
Bit = 1: The PxIFGx flag is set with a high-to-low transition
// GPIO Select Interrupt Edge Bit 6
Bit = 0: The PxIFGx flag is set with a low-to-high transition
Bit = 1: The PxIFGx flag is set with a high-to-low transition
// GPIO Select Interrupt Edge Bit 7
Bit = 0: The PxIFGx flag is set with a low-to-high transition
Bit = 1: The PxIFGx flag is set with a high-to-low transition
};
SEE
struct IGPIO.GpioBits8PxIfg_t |
|
Generic GPIO 8-bit PxIFG Register
metaonly struct GpioBits8PxIfg_t {
// GPIO Interrupt Flag Bit 0
Bit = 0: No interrupt is pending
Bit = 1: An interrupt is pending
// GPIO Interrupt Flag Bit 1
Bit = 0: No interrupt is pending
Bit = 1: An interrupt is pending
// GPIO Interrupt Flag Bit 2
Bit = 0: No interrupt is pending
Bit = 1: An interrupt is pending
// GPIO Interrupt Flag Bit 3
Bit = 0: No interrupt is pending
Bit = 1: An interrupt is pending
// GPIO Interrupt Flag Bit 4
Bit = 0: No interrupt is pending
Bit = 1: An interrupt is pending
// GPIO Interrupt Flag Bit 5
Bit = 0: No interrupt is pending
Bit = 1: An interrupt is pending
// GPIO Interrupt Flag Bit 6
Bit = 0: No interrupt is pending
Bit = 1: An interrupt is pending
// GPIO Interrupt Flag Bit 7
Bit = 0: No interrupt is pending
Bit = 1: An interrupt is pending
};
SEE
struct IGPIO.GpioBits8PxIn_t |
|
Generic GPIO 8-bit Register
metaonly struct GpioBits8PxIn_t {
// GPIO Input Signal Bit 0
// GPIO Input Signal Bit 1
// GPIO Input Signal Bit 2
// GPIO Input Signal Bit 3
// GPIO Input Signal Bit 4
// GPIO Input Signal Bit 5
// GPIO Input Signal Bit 6
// GPIO Input Signal Bit 7
};
SEE
struct IGPIO.GpioBits8PxOut_t |
|
Generic GPIO 8-bit PxOUT Register
metaonly struct GpioBits8PxOut_t {
// GPIO Output Signal Bit 0
// GPIO Output Signal Bit 1
// GPIO Output Signal Bit 2
// GPIO Output Signal Bit 3
// GPIO Output Signal Bit 4
// GPIO Output Signal Bit 5
// GPIO Output Signal Bit 6
// GPIO Output Signal Bit 7
};
SEE
struct IGPIO.GpioBits8PxRen_t |
|
Generic GPIO 8-bit PxREN Register
metaonly struct GpioBits8PxRen_t {
// GPIO Enables or Disables Pullup/Pulldown Bit 0
Bit = 0: Pullup/pulldown resistor disabled
Bit = 1: Pullup/pulldown resistor enabled
Set Pullup/down via PxOUT 0 = Down; 1 = Up
// GPIO Enables or Disables Pullup/Pulldown Bit 1
Bit = 0: Pullup/pulldown resistor disabled
Bit = 1: Pullup/pulldown resistor enabled
Set Pullup/down via PxOUT 0 = Down; 1 = Up
// GPIO Enables or Disables Pullup/Pulldown Bit 2
Bit = 0: Pullup/pulldown resistor disabled
Bit = 1: Pullup/pulldown resistor enabled
Set Pullup/down via PxOUT 0 = Down; 1 = Up
// GPIO Enables or Disables Pullup/Pulldown Bit 3
Bit = 0: Pullup/pulldown resistor disabled
Bit = 1: Pullup/pulldown resistor enabled
Set Pullup/down via PxOUT 0 = Down; 1 = Up
// GPIO Enables or Disables Pullup/Pulldown Bit 4
Bit = 0: Pullup/pulldown resistor disabled
Bit = 1: Pullup/pulldown resistor enabled
Set Pullup/down via PxOUT 0 = Down; 1 = Up
// GPIO Enables or Disables Pullup/Pulldown Bit 5
Bit = 0: Pullup/pulldown resistor disabled
Bit = 1: Pullup/pulldown resistor enabled
Set Pullup/down via PxOUT 0 = Down; 1 = Up
// GPIO Enables or Disables Pullup/Pulldown Bit 6
Bit = 0: Pullup/pulldown resistor disabled
Bit = 1: Pullup/pulldown resistor enabled
Set Pullup/down via PxOUT 0 = Down; 1 = Up
// GPIO Enables or Disables Pullup/Pulldown Bit 7
Bit = 0: Pullup/pulldown resistor disabled
Bit = 1: Pullup/pulldown resistor enabled
Set Pullup/down via PxOUT 0 = Down; 1 = Up
};
SEE
struct IGPIO.GpioBits8PxSel_t |
|
Generic GPIO 8-bit PxSEL Register
metaonly struct GpioBits8PxSel_t {
// GPIO Select Pin Function Bit 0
See the device-specific data sheet to determine pin functions
// GPIO Select Pin Function Bit 1
See the device-specific data sheet to determine pin functions
// GPIO Select Pin Function Bit 2
See the device-specific data sheet to determine pin functions
// GPIO Select Pin Function Bit 3
See the device-specific data sheet to determine pin functions
// GPIO Select Pin Function Bit 4
See the device-specific data sheet to determine pin functions
// GPIO Select Pin Function Bit 5
See the device-specific data sheet to determine pin functions
// GPIO Select Pin Function Bit 6
See the device-specific data sheet to determine pin functions
// GPIO Select Pin Function Bit 7
See the device-specific data sheet to determine pin functions
};
SEE
struct IGPIO.MatchedPortFunction_t |
|
Port Function Enumeration Type
metaonly struct MatchedPortFunction_t {
UInt port[];
UInt pin[];
String pinName[];
UInt functionIndex[];
String functionName[];
};
DETAILS
This type is used to store a list of applicable pins based on the
search criteria when using the function findPinsForFunction().
SEE
IGPIO.addPeripheralsMap() // module-wide |
|
Create a map of all peripherals available on a device
ARGUMENTS
DETAILS
The config parameter
peripherals is by default undefined in an
xdc.platform.ICpuDataSheet instance. This function gathers
all instance configuration parameters that are of the type
xdc.platform.IPeripheral into the map
peripherals.
IGPIO.getAll() // module-wide |
|
Find all peripherals of a certain type
DETAILS
The type of the peripherals returned is defined by the type of the
caller.
RETURNS
Returns an array of IPeripheral instances
IGPIO.getRegisters() // module-wide |
|
Find all registers defined by the peripheral
RETURNS
Returns an array of register names
config IGPIO.devicePinSetting // instance |
|
Fordward Declaration of Device Pin Functional Configuration
config IGPIO.name // instance |
|
Specific peripheral name given by the device
DETAILS
Devices can have more than one peripheral of the same type. In such
cases, device data sheets give different names to the instances of a
same peripheral. For example, the name for a timer module could be
TimerA3, and a device that has two such timers can name them TA0
and TA1.
config IGPIO.owner // instance |
|
String specifying the entity that manages the peripheral
IGPIO.findPinsForFunction() // instance |
|
Identify all device pins that can be used to serve a certain purpose
DETAILS
Function to scan through the pin configuration database to identify
a list of device pins matching a regular expression.
IGPIO.getPinFunctionIndex() // instance |
|
Get a pin's current functional configuration
UInt getPinFunctionIndex(UInt port, UInt pin);
DETAILS
This function is used to obtain the current configuration of a given
device pin. The returned value can be used as an index to obtain further
information from the pin configuration database.
IGPIO.getPinOwner() // instance |
|
This function returns the current owner of the specified device pin
Any getPinOwner(UInt port, UInt pin);
IGPIO.pinFunctionIsActive() // instance |
|
Check if a pin is enabled for a certain function
Bool pinFunctionIsActive(UInt port, UInt pin, String regExp);
DETAILS
This function is used to check if a certain functionality is enabled
on a given device pins (returns 'true' in that case).
IGPIO.setDefaultPinFunction() // instance |
|
Configure a device pin to its default state
Void setDefaultPinFunction(UInt port, UInt pin, Any owner);
DETAILS
This function is used to configure a device pin to its default state
and is typically used when a peripheral module relinquishes ownership
of a pin so that it can be used by other peripheral modules.
IGPIO.setPinFunctionUsingIndex() // instance |
|
Configure a device pin to a specific peripheral function
Void setPinFunctionUsingIndex(UInt port, UInt pin, UInt index, Any owner);
DETAILS
This function is used to configure a device pin to a specific peripheral
function that is identified by an index. The index corresponds to an
associated set of configuration parameters stored in the pin configuration
database. The owner parameter can be used to protect a pin from being
used by somebody else. A pin configuration can only be changed if the
current owner is undefined, or of the current owner matches the
owner specified as function parameter.