metaonly interface ti.catalog.msp430.peripherals.gpio.IGPIO

MSP430 General Purpose Input Output Ports

XDCspec summary sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
metaonly interface IGPIO {  ...
instance:  ...
XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
 
metaonly interface IGPIO inherits IPeripheral {
module-wide constants & types
        BIT0_OFF,
        BIT0
    };
    enum Bit1_t//  {
        BIT1_OFF,
        BIT1
    };
    enum Bit2_t//  {
        BIT2_OFF,
        BIT2
    };
    enum Bit3_t//  {
        BIT3_OFF,
        BIT3
    };
    enum Bit4_t//  {
        BIT4_OFF,
        BIT4
    };
    enum Bit5_t//  {
        BIT5_OFF,
        BIT5
    };
    enum Bit6_t//  {
        BIT6_OFF,
        BIT6
    };
    enum Bit7_t//  {
        BIT7_OFF,
        BIT7
    };
    typedef String StringArray// [];
        UInt functionIndex;
        Any owner;
    };
        String functionName[];
    };
    metaonly struct DevicePin_t// Device Pin Descriptor {
        String pinName;
    };
        String register;
        UInt bitSetMask;
        UInt bitClearMask;
    };
        String register;
        Bool regForceSet;
    };
    };
    };
    };
    };
    };
    };
    };
    };
        UInt port[];
        UInt pin[];
        String pinName[];
        UInt functionIndex[];
        String functionName[];
    };
module-wide functions
 
instance:
per-instance config parameters
per-instance functions
    Bool pinFunctionIsActive// Check if a pin is enabled for a certain function(UInt port, UInt pin, String regExp);
    Void setDefaultPinFunction// Configure a device pin to its default state(UInt port, UInt pin, Any owner);
    Void setPinFunctionUsingIndex// Configure a device pin to a specific peripheral function(UInt port, UInt pin, UInt index, Any owner);
}
enum IGPIO.Bit0_t

GPIO Bit 0 Definitions

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
enum Bit0_t {
    BIT0_OFF,
    BIT0
};
enum IGPIO.Bit1_t
XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
enum Bit1_t {
    BIT1_OFF,
    BIT1
};
enum IGPIO.Bit2_t
XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
enum Bit2_t {
    BIT2_OFF,
    BIT2
};
enum IGPIO.Bit3_t
XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
enum Bit3_t {
    BIT3_OFF,
    BIT3
};
enum IGPIO.Bit4_t
XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
enum Bit4_t {
    BIT4_OFF,
    BIT4
};
enum IGPIO.Bit5_t
XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
enum Bit5_t {
    BIT5_OFF,
    BIT5
};
enum IGPIO.Bit6_t
XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
enum Bit6_t {
    BIT6_OFF,
    BIT6
};
enum IGPIO.Bit7_t
XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
enum Bit7_t {
    BIT7_OFF,
    BIT7
};
typedef IGPIO.IPeripheralArray
XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
typedef IPeripheral.Instance IPeripheralArray[];
typedef IGPIO.StringArray
XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
typedef String StringArray[];
struct IGPIO.DevicePinFunctionSetting_t

Device Pin Functional Setting Descriptor

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
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

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
metaonly struct DevicePinFunction_t {
    String functionName[];
    IGPIO.DeviceRegisterConfig_t functionConfig[][];
};
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

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
metaonly struct DevicePin_t {
    String pinName;
    IGPIO.DevicePinFunction_t pinFunction;
};
DETAILS
Type to describe a single device pin and all its possible configurations.
SEE
struct IGPIO.DeviceRegisterConfig_t

Device Register Configuration Descriptor

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
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

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
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

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
metaonly struct GpioBits8PxDir_t {
    IGPIO.Bit0_t Bit0;
    // 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
    IGPIO.Bit1_t Bit1;
    // 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
    IGPIO.Bit2_t Bit2;
    // 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
    IGPIO.Bit3_t Bit3;
    // 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
    IGPIO.Bit4_t Bit4;
    // 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
    IGPIO.Bit5_t Bit5;
    // 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
    IGPIO.Bit6_t Bit6;
    // 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
    IGPIO.Bit7_t Bit7;
    // 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

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
metaonly struct GpioBits8PxIe_t {
    IGPIO.Bit0_t Bit0;
    // GPIO Interrupt Enable Bit 0 Bit = 0: The interrupt is disabled. Bit = 1: The interrupt is enabled
    IGPIO.Bit1_t Bit1;
    // GPIO Interrupt Enable Bit 1 Bit = 0: The interrupt is disabled. Bit = 1: The interrupt is enabled
    IGPIO.Bit2_t Bit2;
    // GPIO Interrupt Enable Bit 2 Bit = 0: The interrupt is disabled. Bit = 1: The interrupt is enabled
    IGPIO.Bit3_t Bit3;
    // GPIO Interrupt Enable Bit 3 Bit = 0: The interrupt is disabled. Bit = 1: The interrupt is enabled
    IGPIO.Bit4_t Bit4;
    // GPIO Interrupt Enable Bit 4 Bit = 0: The interrupt is disabled. Bit = 1: The interrupt is enabled
    IGPIO.Bit5_t Bit5;
    // GPIO Interrupt Enable Bit 5 Bit = 0: The interrupt is disabled. Bit = 1: The interrupt is enabled
    IGPIO.Bit6_t Bit6;
    // GPIO Interrupt Enable Bit 6 Bit = 0: The interrupt is disabled. Bit = 1: The interrupt is enabled
    IGPIO.Bit7_t Bit7;
    // 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

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
metaonly struct GpioBits8PxIes_t {
    IGPIO.Bit0_t Bit0;
    // 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
    IGPIO.Bit1_t Bit1;
    // 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
    IGPIO.Bit2_t Bit2;
    // 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
    IGPIO.Bit3_t Bit3;
    // 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
    IGPIO.Bit4_t Bit4;
    // 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
    IGPIO.Bit5_t Bit5;
    // 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
    IGPIO.Bit6_t Bit6;
    // 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
    IGPIO.Bit7_t Bit7;
    // 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

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
metaonly struct GpioBits8PxIfg_t {
    IGPIO.Bit0_t Bit0;
    // GPIO Interrupt Flag Bit 0 Bit = 0: No interrupt is pending Bit = 1: An interrupt is pending
    IGPIO.Bit1_t Bit1;
    // GPIO Interrupt Flag Bit 1 Bit = 0: No interrupt is pending Bit = 1: An interrupt is pending
    IGPIO.Bit2_t Bit2;
    // GPIO Interrupt Flag Bit 2 Bit = 0: No interrupt is pending Bit = 1: An interrupt is pending
    IGPIO.Bit3_t Bit3;
    // GPIO Interrupt Flag Bit 3 Bit = 0: No interrupt is pending Bit = 1: An interrupt is pending
    IGPIO.Bit4_t Bit4;
    // GPIO Interrupt Flag Bit 4 Bit = 0: No interrupt is pending Bit = 1: An interrupt is pending
    IGPIO.Bit5_t Bit5;
    // GPIO Interrupt Flag Bit 5 Bit = 0: No interrupt is pending Bit = 1: An interrupt is pending
    IGPIO.Bit6_t Bit6;
    // GPIO Interrupt Flag Bit 6 Bit = 0: No interrupt is pending Bit = 1: An interrupt is pending
    IGPIO.Bit7_t Bit7;
    // 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

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
metaonly struct GpioBits8PxIn_t {
    IGPIO.Bit0_t Bit0;
    // GPIO Input Signal Bit 0
    IGPIO.Bit1_t Bit1;
    // GPIO Input Signal Bit 1
    IGPIO.Bit2_t Bit2;
    // GPIO Input Signal Bit 2
    IGPIO.Bit3_t Bit3;
    // GPIO Input Signal Bit 3
    IGPIO.Bit4_t Bit4;
    // GPIO Input Signal Bit 4
    IGPIO.Bit5_t Bit5;
    // GPIO Input Signal Bit 5
    IGPIO.Bit6_t Bit6;
    // GPIO Input Signal Bit 6
    IGPIO.Bit7_t Bit7;
    // GPIO Input Signal Bit 7
};
SEE
struct IGPIO.GpioBits8PxOut_t

Generic GPIO 8-bit PxOUT Register

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
metaonly struct GpioBits8PxOut_t {
    IGPIO.Bit0_t Bit0;
    // GPIO Output Signal Bit 0
    IGPIO.Bit1_t Bit1;
    // GPIO Output Signal Bit 1
    IGPIO.Bit2_t Bit2;
    // GPIO Output Signal Bit 2
    IGPIO.Bit3_t Bit3;
    // GPIO Output Signal Bit 3
    IGPIO.Bit4_t Bit4;
    // GPIO Output Signal Bit 4
    IGPIO.Bit5_t Bit5;
    // GPIO Output Signal Bit 5
    IGPIO.Bit6_t Bit6;
    // GPIO Output Signal Bit 6
    IGPIO.Bit7_t Bit7;
    // GPIO Output Signal Bit 7
};
SEE
struct IGPIO.GpioBits8PxRen_t

Generic GPIO 8-bit PxREN Register

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
metaonly struct GpioBits8PxRen_t {
    IGPIO.Bit0_t Bit0;
    // 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
    IGPIO.Bit1_t Bit1;
    // 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
    IGPIO.Bit2_t Bit2;
    // 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
    IGPIO.Bit3_t Bit3;
    // 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
    IGPIO.Bit4_t Bit4;
    // 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
    IGPIO.Bit5_t Bit5;
    // 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
    IGPIO.Bit6_t Bit6;
    // 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
    IGPIO.Bit7_t Bit7;
    // 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

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
metaonly struct GpioBits8PxSel_t {
    IGPIO.Bit0_t Bit0;
    // GPIO Select Pin Function Bit 0 See the device-specific data sheet to determine pin functions
    IGPIO.Bit1_t Bit1;
    // GPIO Select Pin Function Bit 1 See the device-specific data sheet to determine pin functions
    IGPIO.Bit2_t Bit2;
    // GPIO Select Pin Function Bit 2 See the device-specific data sheet to determine pin functions
    IGPIO.Bit3_t Bit3;
    // GPIO Select Pin Function Bit 3 See the device-specific data sheet to determine pin functions
    IGPIO.Bit4_t Bit4;
    // GPIO Select Pin Function Bit 4 See the device-specific data sheet to determine pin functions
    IGPIO.Bit5_t Bit5;
    // GPIO Select Pin Function Bit 5 See the device-specific data sheet to determine pin functions
    IGPIO.Bit6_t Bit6;
    // GPIO Select Pin Function Bit 6 See the device-specific data sheet to determine pin functions
    IGPIO.Bit7_t Bit7;
    // 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

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
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

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
Void addPeripheralsMap(ICpuDataSheet.Instance cds);
ARGUMENTS
cds — an xdc.platform.ICpuDataSheet instance
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

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
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

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
IPeripheral.StringArray getRegisters();
RETURNS
Returns an array of register names
config IGPIO.devicePinSetting  // instance

Fordward Declaration of Device Pin Functional Configuration

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
config IGPIO.DevicePinFunctionSetting_t devicePinSetting[][];
config IGPIO.name  // instance

Specific peripheral name given by the device

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
config String name;
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

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
config String owner;
IGPIO.findPinsForFunction()  // instance

Identify all device pins that can be used to serve a certain purpose

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
IGPIO.MatchedPortFunction_t findPinsForFunction(String regExp);
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

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
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

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
Any getPinOwner(UInt port, UInt pin);
IGPIO.pinFunctionIsActive()  // instance

Check if a pin is enabled for a certain function

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
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

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
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

XDCspec declarations sourced in ti/catalog/msp430/peripherals/gpio/IGPIO.xdc
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.
generated on Tue, 24 Aug 2010 15:40:45 GMT