enum Timer_B3.CAP_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.CAP_t
const Timer_B3.CAP_OFF;
const Timer_B3.CAP;
enum Timer_B3.CCIE_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.CCIE_t
const Timer_B3.CCIE_OFF;
const Timer_B3.CCIE;
enum Timer_B3.CCIFG_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.CCIFG_t
const Timer_B3.CCIFG_OFF;
const Timer_B3.CCIFG;
enum Timer_B3.CCIS_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.CCIS_t
const Timer_B3.CCIS_0;
// CCIxA
const Timer_B3.CCIS_1;
// CCIxB
const Timer_B3.CCIS_2;
// GND
const Timer_B3.CCIS_3;
// Vcc
enum Timer_B3.CCI_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.CCI_t
const Timer_B3.CCI_OFF;
const Timer_B3.CCI;
enum Timer_B3.CLLD_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.CLLD_t
const Timer_B3.CLLD_0;
const Timer_B3.CLLD_1;
const Timer_B3.CLLD_2;
const Timer_B3.CLLD_3;
enum Timer_B3.CM_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.CM_t
const Timer_B3.CM_0;
// No Capture
const Timer_B3.CM_1;
// Rising Edge
const Timer_B3.CM_2;
// Falling Edge
const Timer_B3.CM_3;
// Both Edges
enum Timer_B3.CNTL_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.CNTL_t
const Timer_B3.CNTL_0;
// 16-bit, TBR(max) = 0FFFFh
const Timer_B3.CNTL_1;
// 12-bit, TBR(max) = 0FFFh
const Timer_B3.CNTL_2;
// 10-bit, TBR(max) = 03FFh
const Timer_B3.CNTL_3;
// 8-bit, TBR(max) = 0FFh
enum Timer_B3.COV_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.COV_t
const Timer_B3.COV_OFF;
const Timer_B3.COV;
enum Timer_B3.ID_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.ID_t
const Timer_B3.ID_0;
// Divider - /1
const Timer_B3.ID_1;
// Divider - /2
const Timer_B3.ID_2;
// Divider - /4
const Timer_B3.ID_3;
// Divider - /8
enum Timer_B3.IVValues |
|
TB3IV Definitions
XDCscript usage |
meta-domain |
values of type Timer_B3.IVValues
const Timer_B3.TBIV_NONE;
// No Interrupt pending
const Timer_B3.TBIV_TBCCR1;
// TBCCR1_CCIFG
const Timer_B3.TBIV_TBCCR2;
// TBCCR2_CCIFG
const Timer_B3.TBIV_6;
// Reserved
const Timer_B3.TBIV_8;
// Reserved
const Timer_B3.TBIV_TBIFG;
// TBIFG
enum Timer_B3.MC_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.MC_t
const Timer_B3.MC_0;
// Stop Mode
const Timer_B3.MC_1;
// Up Mode
const Timer_B3.MC_2;
// Continuous Mode
const Timer_B3.MC_3;
// Up/Down Mode
enum Timer_B3.OUTMOD_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.OUTMOD_t
const Timer_B3.OUTMOD_0;
// PWM output mode: 0 - OUT bit value
const Timer_B3.OUTMOD_1;
// PWM output mode: 1 - Set
const Timer_B3.OUTMOD_2;
// PWM output mode: 2 - PWM toggle/reset
const Timer_B3.OUTMOD_3;
// PWM output mode: 3 - PWM set/reset
const Timer_B3.OUTMOD_4;
// PWM output mode: 4 - Toggle
const Timer_B3.OUTMOD_5;
// PWM output mode: 5 - Reset
const Timer_B3.OUTMOD_6;
// PWM output mode: 6 - PWM toggle/set
const Timer_B3.OUTMOD_7;
// PWM output mode: 7 - PWM reset/set
enum Timer_B3.OUT_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.OUT_t
const Timer_B3.OUT_OFF;
const Timer_B3.OUT;
enum Timer_B3.SCCI_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.SCCI_t
const Timer_B3.SCCI_OFF;
const Timer_B3.SCCI;
enum Timer_B3.SCS_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.SCS_t
const Timer_B3.SCS_OFF;
const Timer_B3.SCS;
enum Timer_B3.TBCLGRP_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.TBCLGRP_t
const Timer_B3.TBCLGRP_0;
const Timer_B3.TBCLGRP_1;
const Timer_B3.TBCLGRP_2;
const Timer_B3.TBCLGRP_3;
enum Timer_B3.TBCLR_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.TBCLR_t
const Timer_B3.TBCLR_OFF;
const Timer_B3.TBCLR;
enum Timer_B3.TBIE_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.TBIE_t
const Timer_B3.TBIE_OFF;
const Timer_B3.TBIE;
enum Timer_B3.TBIFG_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.TBIFG_t
const Timer_B3.TBIFG_OFF;
const Timer_B3.TBIFG;
enum Timer_B3.TBSSEL_t |
|
XDCscript usage |
meta-domain |
values of type Timer_B3.TBSSEL_t
const Timer_B3.TBSSEL_0;
// TBCLK
const Timer_B3.TBSSEL_1;
// ACLK
const Timer_B3.TBSSEL_2;
// SMCLK
const Timer_B3.TBSSEL_3;
// INCLK
struct Timer_B3.ForceSetDefaultRegister_t |
|
Force Set Default Register
XDCscript usage |
meta-domain |
var obj = new Timer_B3.ForceSetDefaultRegister_t;
obj.register = String ...
obj.regForceSet = Bool ...
DETAILS
Type to store if each register needs to be forced initialized
even if the register is in default state.
SEE
struct Timer_B3.TBCCTLx_t |
|
XDCscript usage |
meta-domain |
var obj = new Timer_B3.TBCCTLx_t;
// Capture mode
00 No capture
01 Capture on rising edge
10 Capture on falling edge
11 Capture on both rising and falling edges
// Capture/compare input select. These bits select the TBCCRx input signal.
See the device-specific data sheet for specific signal connections.
00 CCIxA
01 CCIxB
10 GND
11 VCC
// Synchronize capture source. This bit is used to synchronize the capture input
signal with the timer clock.
0 Asynchronous capture
1 Synchronous capture
// Compare latch load. These bits select the compare latch load event.
00 TBCLx loads on write to TBCCRx
01 TBCLx loads when TBR counts to 0
10 TBCLx loads when TBR counts to 0 (up or continuous mode)
TBCLx loads when TBR counts to TBCL0 or to 0 (up/down mode)
11 TBCLx loads when TBR counts to TBCLx
// Capture mode
0 Compare mode
1 Capture mode
// Output mode. Modes 2, 3, 6, and 7 are not useful for TBCL0 because EQUx
= EQU0.
000 OUT bit value
001 Set
010 Toggle/reset
011 Set/reset
100 Toggle
101 Reset
110 Toggle/set
111 Reset/set
// Capture/compare interrupt enable. This bit enables the interrupt request of
the corresponding CCIFG flag.
0 Interrupt disabled
1 Interrupt enabled
// Capture/compare input. The selected input signal can be read by this bit
// Output. For output mode 0, this bit directly controls the state of the output.
0 Output low
1 Output high
// Capture overflow. This bit indicates a capture overflow occurred. COV must
be reset with software.
0 No capture overflow occurred
1 Capture overflow occurred
// Capture/compare interrupt flag
0 No interrupt pending
1 Interrupt pending
struct Timer_B3.TBCTL_t |
|
Timer_B Control Register
XDCscript usage |
meta-domain |
var obj = new Timer_B3.TBCTL_t;
// TBCLx group
00 Each TBCLx latch loads independently
01 TBCL1+TBCL2 (TBCCR1 CLLDx bits control the update)
TBCL3+TBCL4 (TBCCR3 CLLDx bits control the update)
TBCL5+TBCL6 (TBCCR5 CLLDx bits control the update)
TBCL0 independent
10 TBCL1+TBCL2+TBCL3 (TBCCR1 CLLDx bits control the update)
TBCL4+TBCL5+TBCL6 (TBCCR4 CLLDx bits control the update)
TBCL0 independent
11 TBCL0+TBCL1+TBCL2+TBCL3+TBCL4+TBCL5+TBCL6
(TBCCR1 CLLDx bits control the update)
// Counter Length
00 16-bit, TBR(max) = 0FFFFh
01 12-bit, TBR(max) = 0FFFh
10 10-bit, TBR(max) = 03FFh
11 8-bit, TBR(max) = 0FFh
// Timer_B clock source select.
00 TBCLK
01 ACLK
10 SMCLK
11 Inverted TBCLK
// Input divider. These bits select the divider for the input clock.
00 /1
01 /2
10 /4
11 /8
// Mode control. Setting MCx = 00h when Timer_B is not in use conserves
power.
00 Stop mode: the timer is halted
01 Up mode: the timer counts up to TBCL0
10 Continuous mode: the timer counts up to the value set by CNTLx
11 Up/down mode: the timer counts up to TBCL0 and down to 0000h
// Timer_B clear. Setting this bit resets TBR, the clock divider, and the count
direction. The TBCLR bit is automatically reset and is always read as zero
// Timer_B interrupt enable. This bit enables the TBIFG interrupt request.
0 Interrupt disabled
1 Interrupt enabled
// Timer_B interrupt flag.
0 No interrupt pending
1 Interrupt pending
SEE
struct Timer_B3.regIntVect_t |
|
Interrupt vector description
XDCscript usage |
meta-domain |
var obj = new Timer_B3.regIntVect_t;
obj.registerName = String ...
obj.registerDescription = String ...
obj.isrToggleString = String ...
obj.priorityName = String ...
obj.interruptEnable = Bool ...
obj.interruptHandler = Bool ...
obj.priority = Int ...
DETAILS
Type to describe a single interrupt vector pin and all its possible
configurations.
SEE
Timer_B3.getAll() // module-wide |
|
Find all peripherals of a certain type
XDCscript usage |
meta-domain |
DETAILS
The type of the peripherals returned is defined by the type of the
caller.
RETURNS
Returns an array of IPeripheral instances
Timer_B3.getRegisters() // module-wide |
|
Find all registers defined by the peripheral
XDCscript usage |
meta-domain |
Timer_B3.getRegisters() returns String[]
RETURNS
Returns an array of register names
Instance Config Parameters |
|
XDCscript usage |
meta-domain |
var params = new Timer_B3.Params;
// Instance config-params object
params.INCLK = Float 0;
// Timer_B INCLK
params.TBCCR0 = Bits16 0;
// TBCCR0, Timer_B Capture/Compare Register 0
params.TBCCR1 = Bits16 0;
// TBCCR1, Timer_B Capture/Compare Register 1
params.TBCCR2 = Bits16 0;
// TBCCR2, Timer_B Capture/Compare Register 2
// TBCCTL0, Capture/Compare Control Register 0
};
// TBCCTL1, Capture/Compare Control Register 1
};
// TBCCTL2, Capture/Compare Control Register 2
};
params.TBCLK = Float 0;
// Timer_B TBCLK
// TBCTL, Timer_B3 Control Register
};
params.baseAddr = UInt undefined;
// Address of the peripheral's control register
// Determine if each Register needs to be forced set or not
{
register: "TBCTL",
regForceSet: false
},
{
register: "TBCCTL0",
regForceSet: false
},
{
register: "TBCCTL1",
regForceSet: false
},
{
register: "TBCCTL2",
regForceSet: false
},
{
register: "TBCCR0",
regForceSet: false
},
{
register: "TBCCR1",
regForceSet: false
},
{
register: "TBCCR2",
regForceSet: false
}
];
params.intNum = UInt undefined;
// Interrupt source number
// Timer interrupt enables
params.isInternal = Bool false;
// Boolean that is true if a Timer is internal, meaning
it has no external inputs or outputs
params.name = String undefined;
// Specific peripheral name given by the device
params.numberOfTimers = UChar undefined;
// Stores the number of available timer capture compare blocks
params.owner = String undefined;
// String specifying the entity that manages the peripheral
config Timer_B3.INCLK // instance |
|
Timer_B INCLK
XDCscript usage |
meta-domain |
var params = new Timer_B3.Params;
...
params.INCLK = Float 0;
config Timer_B3.TBCCR0 // instance |
|
TBCCR0, Timer_B Capture/Compare Register 0
XDCscript usage |
meta-domain |
var params = new Timer_B3.Params;
...
params.TBCCR0 = Bits16 0;
config Timer_B3.TBCCR1 // instance |
|
TBCCR1, Timer_B Capture/Compare Register 1
XDCscript usage |
meta-domain |
var params = new Timer_B3.Params;
...
params.TBCCR1 = Bits16 0;
config Timer_B3.TBCCR2 // instance |
|
TBCCR2, Timer_B Capture/Compare Register 2
XDCscript usage |
meta-domain |
var params = new Timer_B3.Params;
...
params.TBCCR2 = Bits16 0;
config Timer_B3.TBCCTL0 // instance |
|
TBCCTL0, Capture/Compare Control Register 0
XDCscript usage |
meta-domain |
var params = new Timer_B3.Params;
...
};
config Timer_B3.TBCCTL1 // instance |
|
TBCCTL1, Capture/Compare Control Register 1
XDCscript usage |
meta-domain |
var params = new Timer_B3.Params;
...
};
config Timer_B3.TBCCTL2 // instance |
|
TBCCTL2, Capture/Compare Control Register 2
XDCscript usage |
meta-domain |
var params = new Timer_B3.Params;
...
};
config Timer_B3.TBCLK // instance |
|
Timer_B TBCLK
XDCscript usage |
meta-domain |
var params = new Timer_B3.Params;
...
params.TBCLK = Float 0;
config Timer_B3.TBCTL // instance |
|
TBCTL, Timer_B3 Control Register
XDCscript usage |
meta-domain |
var params = new Timer_B3.Params;
...
};
config Timer_B3.baseAddr // instance |
|
Address of the peripheral's control register
XDCscript usage |
meta-domain |
var params = new Timer_B3.Params;
...
params.baseAddr = UInt undefined;
DETAILS
A peripheral's registers are commonly accessed through a structure
that defines the offsets of a particular register from the lowest
address mapped to a peripheral. That lowest address is specified by
this parameter.
config Timer_B3.forceSetDefaultRegister // instance |
|
Determine if each Register needs to be forced set or not
XDCscript usage |
meta-domain |
var params = new Timer_B3.Params;
...
{
register: "TBCTL",
regForceSet: false
},
{
register: "TBCCTL0",
regForceSet: false
},
{
register: "TBCCTL1",
regForceSet: false
},
{
register: "TBCCTL2",
regForceSet: false
},
{
register: "TBCCR0",
regForceSet: false
},
{
register: "TBCCR1",
regForceSet: false
},
{
register: "TBCCR2",
regForceSet: false
}
];
config Timer_B3.intNum // instance |
|
Interrupt source number
XDCscript usage |
meta-domain |
var params = new Timer_B3.Params;
...
params.intNum = UInt undefined;
config Timer_B3.interruptSource // instance |
|
Timer interrupt enables
XDCscript usage |
meta-domain |
var params = new Timer_B3.Params;
...
config Timer_B3.isInternal // instance |
|
Boolean that is true if a Timer is internal, meaning
it has no external inputs or outputs
XDCscript usage |
meta-domain |
var params = new Timer_B3.Params;
...
params.isInternal = Bool false;
config Timer_B3.name // instance |
|
Specific peripheral name given by the device
XDCscript usage |
meta-domain |
var params = new Timer_B3.Params;
...
params.name = String undefined;
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 Timer_B3.numberOfTimers // instance |
|
Stores the number of available timer capture compare blocks
XDCscript usage |
meta-domain |
var params = new Timer_B3.Params;
...
params.numberOfTimers = UChar undefined;
config Timer_B3.owner // instance |
|
String specifying the entity that manages the peripheral
XDCscript usage |
meta-domain |
var params = new Timer_B3.Params;
...
params.owner = String undefined;
Instance Creation |
|
XDCscript usage |
meta-domain |
var params =
new Timer_B3.
Params;
// Allocate instance config-params
params.config = ...
// Assign individual configs
// Create an instance-object
Timer_B3.getTxxCCRx() // instance |
|
Returns TxxCCRx register value based on which CCR register
XDCscript usage |
meta-domain |
inst.getTxxCCRx(UChar ccrNumber) returns Bits16
SEE
Timer_B3.setTxxCCRx() // instance |
|
Sets TxxCCRx register value based on which CCR register
XDCscript usage |
meta-domain |
inst.setTxxCCRx(UChar ccrNumber, Bits16 value) returns Void
SEE