| metaonly interface ti.catalog.msp430.peripherals.communication.IUSCI |
 |
 |
Universal Serial Communication Interface
| XDCspec summary | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
module-wide constants & types
};
};
};
enum UCBRK_t// Break detect flag {
};
};
};
enum UCFE_t// Framing error flag {
};
};
};
};
enum UCMSB_t// MSB first select. Controls the direction of the receive and transmit shift register {
};
enum UCOE_t// Overrun error flag {
};
};
};
};
};
};
};
};
String register;
Bool regForceSet;
};
module-wide functions
Void addPeripheralsMap// Create a map of all peripherals available on a device(ICpuDataSheet.Instance cds );
instance:
per-instance config parameters
per-instance functions
Bool getUCRXIE// ();
Bool getUCTXIE// ();
}
| enum IUSCI.UC7BIT_t |
|
Character length. Selects 7-bit or 8-bit character length
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
enum UC7BIT_t {
UC7BIT_OFF,
// 8-bit
UC7BIT
// 7-bit
};
| enum IUSCI.UCADDR_t |
|
Address received in address-bit multiprocessor mode
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
enum UCADDR_t {
UCADDR_OFF,
// Received character is data
UCADDR
// Received character is an address
};
| enum IUSCI.UCBRKIE_t |
|
Receive break character interrupt-enable
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
enum UCBRKIE_t {
UCBRKIE_OFF,
// Received break characters do not set UCAxRXIFG
UCBRKIE
// Received break characters set UCAxRXIFG
};
| enum IUSCI.UCBRK_t |
|
Break detect flag
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
enum UCBRK_t {
UCBRK_OFF,
// No break condition
UCBRK
// Break condition occurred
};
| enum IUSCI.UCBUSY_t |
|
USCI busy. This bit indicates if a transmit or receive operation is in progress
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
enum UCBUSY_t {
UCBUSY_OFF,
// USCI inactive
UCBUSY
// USCI transmitting or receiving
};
| enum IUSCI.UCDORM_t |
|
Dormant. Puts USCI into sleep mode
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
enum UCDORM_t {
UCDORM_OFF,
// Not dormant. All received characters will set UCAxRXIFG
UCDORM
// Dormant. Only characters that are preceded by an idle-line or with
address bit set will set UCAxRXIFG. In UART mode with automatic baud
rate detection only the combination of a break and synch field will set
UCAxRXIFG
};
| enum IUSCI.UCFE_t |
|
Framing error flag
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
enum UCFE_t {
UCFE_OFF,
// 0 No error
UCFE
// Character received with low stop bit
};
| enum IUSCI.UCIDLE_t |
|
Idle line detected in idle-line multiprocessor mode
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
enum UCIDLE_t {
UCIDLE_OFF,
// No idle line detected
UCIDLE
// Idle line detected
};
| enum IUSCI.UCLISTEN_t |
|
Listen enable. The UCLISTEN bit selects loopback mode
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
enum UCLISTEN_t {
UCLISTEN_OFF,
// Disabled
UCLISTEN
// Enabled. UCAxTXD is internally fed back to the receiver
};
| enum IUSCI.UCMODE_SYNC_t |
|
USCI mode. The UCMODEx bits select the synchronous mode when UCSYNC = 1
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
enum UCMODE_SYNC_t {
UCMODE_0,
// 3-Pin SPI
UCMODE_1,
// 4-Pin SPI with UCxSTE active high: slave enabled when UCxSTE = 1
UCMODE_2,
// 4-Pin SPI with UCxSTE active low: slave enabled when UCxSTE = 0
UCMODE_3
// I2C Mode
};
| enum IUSCI.UCMSB_t |
|
MSB first select. Controls the direction of the receive and transmit shift register
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
enum UCMSB_t {
UCMSB_OFF,
// LSB first
UCMSB
// MSB first
};
| enum IUSCI.UCOE_t |
|
Overrun error flag
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
enum UCOE_t {
UCOE_OFF,
// No error
UCOE
// Overrun error occurred
};
| enum IUSCI.UCPE_t |
|
Parity error flag. When UCPEN = 0, UCPE is read as 0
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
enum UCPE_t {
UCPE_OFF,
// No error
UCPE
// Character received with parity error
};
| enum IUSCI.UCRXEIE_t |
|
Receive erroneous-character interrupt-enable
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
enum UCRXEIE_t {
UCRXEIE_OFF,
// Erroneous characters rejected and UCAxRXIFG is not set
UCRXEIE
// Erroneous characters received will set UCAxRXIFG
};
| enum IUSCI.UCRXERR_t |
|
Bit 2 Receive error flag. This bit indicates a character was received with error(s). When UCRXERR = 1, on or more error flags (UCFE, UCPE, UCOE) is also set. UCRXERR is cleared when UCAxRXBUF is read
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
enum UCRXERR_t {
UCRXERR_OFF,
// No receive errors detected
UCRXERR
// Receive error detected
};
| enum IUSCI.UCSWRST_t |
|
Software reset enable
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
enum UCSWRST_t {
UCSWRST_OFF,
// Disabled. USCI reset released for operation
UCSWRST
// Enabled. USCI logic held in reset state
};
| enum IUSCI.UCSYNC_t |
|
Synchronous mode enable
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
enum UCSYNC_t {
UCSYNC_OFF,
// Asynchronous mode
UCSYNC
// Synchronous Mode
};
| enum IUSCI.UCTXADDR_t |
|
Transmit address. Next frame to be transmitted will be marked as address depending on the selected multiprocessor mode
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
enum UCTXADDR_t {
UCTXADDR_OFF,
// Next frame transmitted is data
UCTXADDR
// Next frame transmitted is an address
};
| enum IUSCI.UCTXBRK_t |
|
Transmit break. Transmits a break with the next write to the transmit buffer. In UART mode with automatic baud rate detection 055h must be written into UCAxTXBUF to generate the required break/synch fields. Otherwise 0h must be written into the transmit buffer
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
enum UCTXBRK_t {
UCTXBRK_OFF,
// Next frame transmitted is not a break
UCTXBRK
// Next frame transmitted is a break or a break/synch
};
| typedef IUSCI.IPeripheralArray |
|
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
| typedef IUSCI.StringArray |
|
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
typedef String StringArray[];
| struct IUSCI.ForceSetDefaultRegister_t |
|
Force Set Default Register
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.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
| IUSCI.addPeripheralsMap() // module-wide |
|
Create a map of all peripherals available on a device
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
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.
| IUSCI.getAll() // module-wide |
|
Find all peripherals of a certain type
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
IPeripheral.IPeripheralArray getAll();
DETAILS
The type of the peripherals returned is defined by the type of the
caller.
RETURNS
Returns an array of IPeripheral instances
| IUSCI.getRegisters() // module-wide |
|
Find all registers defined by the peripheral
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
IPeripheral.StringArray getRegisters();
RETURNS
Returns an array of register names
| config IUSCI.UCLKHz // instance |
|
Stores the UCLK external clock frequency in float
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
config Float UCLKHz = 1000000;
| config IUSCI.name // instance |
|
Specific peripheral name given by the device
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.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 IUSCI.owner // instance |
|
String specifying the entity that manages the peripheral
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
config String owner;
| IUSCI.getUCRXIE() // instance |
|
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
Bool getUCRXIE();
| IUSCI.getUCTXIE() // instance |
|
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
Bool getUCTXIE();
| IUSCI.setUCRXIE() // instance |
|
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
Bool setUCRXIE(Bool set);
| IUSCI.setUCTXIE() // instance |
|
| XDCspec declarations | sourced in ti/catalog/msp430/peripherals/communication/IUSCI.xdc |
Bool setUCTXIE(Bool set);
generated on Tue, 24 Aug 2010 15:40:42 GMT