CC3200 Peripheral Driver Library User's Guide
1.2.0
|
Functions | |
void | TimerEnable (unsigned long ulBase, unsigned long ulTimer) |
void | TimerDisable (unsigned long ulBase, unsigned long ulTimer) |
void | TimerConfigure (unsigned long ulBase, unsigned long ulConfig) |
void | TimerControlLevel (unsigned long ulBase, unsigned long ulTimer, tBoolean bInvert) |
void | TimerControlEvent (unsigned long ulBase, unsigned long ulTimer, unsigned long ulEvent) |
void | TimerControlStall (unsigned long ulBase, unsigned long ulTimer, tBoolean bStall) |
void | TimerPrescaleSet (unsigned long ulBase, unsigned long ulTimer, unsigned long ulValue) |
unsigned long | TimerPrescaleGet (unsigned long ulBase, unsigned long ulTimer) |
void | TimerPrescaleMatchSet (unsigned long ulBase, unsigned long ulTimer, unsigned long ulValue) |
unsigned long | TimerPrescaleMatchGet (unsigned long ulBase, unsigned long ulTimer) |
void | TimerLoadSet (unsigned long ulBase, unsigned long ulTimer, unsigned long ulValue) |
unsigned long | TimerLoadGet (unsigned long ulBase, unsigned long ulTimer) |
unsigned long | TimerValueGet (unsigned long ulBase, unsigned long ulTimer) |
void | TimerValueSet (unsigned long ulBase, unsigned long ulTimer, unsigned long ulValue) |
void | TimerMatchSet (unsigned long ulBase, unsigned long ulTimer, unsigned long ulValue) |
unsigned long | TimerMatchGet (unsigned long ulBase, unsigned long ulTimer) |
void | TimerIntRegister (unsigned long ulBase, unsigned long ulTimer, void(*pfnHandler)(void)) |
void | TimerIntUnregister (unsigned long ulBase, unsigned long ulTimer) |
void | TimerIntEnable (unsigned long ulBase, unsigned long ulIntFlags) |
void | TimerIntDisable (unsigned long ulBase, unsigned long ulIntFlags) |
unsigned long | TimerIntStatus (unsigned long ulBase, tBoolean bMasked) |
void | TimerIntClear (unsigned long ulBase, unsigned long ulIntFlags) |
void | TimerDMAEventSet (unsigned long ulBase, unsigned long ulDMAEvent) |
unsigned long | TimerDMAEventGet (unsigned long ulBase) |
void TimerConfigure | ( | unsigned long | ulBase, |
unsigned long | ulConfig | ||
) |
Configures the timer(s).
ulBase | is the base address of the timer module. |
ulConfig | is the configuration for the timer. |
This function configures the operating mode of the timer(s). The timer module is disabled before being configured, and is left in the disabled state. The 16/32-bit timer is comprised of two 16-bit timers that can operate independently or be concatenated to form a 32-bit timer.
The configuration is specified in ulConfig as one of the following values:
When configured for a pair of half-width timers, each timer is separately configured. The first timer is configured by setting ulConfig to the result of a logical OR operation between one of the following values and ulConfig:
Similarly, the second timer is configured by setting ulConfig to the result of a logical OR operation between one of the corresponding TIMER_CFG_B_* values and ulConfig.
void TimerControlEvent | ( | unsigned long | ulBase, |
unsigned long | ulTimer, | ||
unsigned long | ulEvent | ||
) |
Controls the event type.
ulBase | is the base address of the timer module. |
ulTimer | specifies the timer(s) to be adjusted; must be one of TIMER_A, TIMER_B, or TIMER_BOTH. |
ulEvent | specifies the type of event; must be one of TIMER_EVENT_POS_EDGE, TIMER_EVENT_NEG_EDGE, or TIMER_EVENT_BOTH_EDGES. |
This function sets the signal edge(s) that triggers the timer when in capture mode.
void TimerControlLevel | ( | unsigned long | ulBase, |
unsigned long | ulTimer, | ||
tBoolean | bInvert | ||
) |
Controls the output level.
ulBase | is the base address of the timer module. |
ulTimer | specifies the timer(s) to adjust; must be one of TIMER_A, TIMER_B, or TIMER_BOTH. |
bInvert | specifies the output level. |
This function sets the PWM output level for the specified timer. If the bInvert parameter is true, then the timer's output is made active low; otherwise, it is made active high.
void TimerControlStall | ( | unsigned long | ulBase, |
unsigned long | ulTimer, | ||
tBoolean | bStall | ||
) |
Controls the stall handling.
ulBase | is the base address of the timer module. |
ulTimer | specifies the timer(s) to be adjusted; must be one of TIMER_A, TIMER_B, or TIMER_BOTH. |
bStall | specifies the response to a stall signal. |
This function controls the stall response for the specified timer. If the bStall parameter is true, then the timer stops counting if the processor enters debug mode; otherwise the timer keeps running while in debug mode.
void TimerDisable | ( | unsigned long | ulBase, |
unsigned long | ulTimer | ||
) |
Disables the timer(s).
ulBase | is the base address of the timer module. |
ulTimer | specifies the timer(s) to disable; must be one of TIMER_A, TIMER_B, or TIMER_BOTH. |
This function disables operation of the timer module.
unsigned long TimerDMAEventGet | ( | unsigned long | ulBase | ) |
Returns the events that can trigger a DMA request.
ulBase | is the base address of the timer module. |
This function returns the timer events that can trigger the start of a DMA sequence. The DMA trigger events are the logical OR of the following values:
void TimerDMAEventSet | ( | unsigned long | ulBase, |
unsigned long | ulDMAEvent | ||
) |
Enables the events that can trigger a DMA request.
ulBase | is the base address of the timer module. |
ulDMAEvent | is a bit mask of the events that can trigger DMA. |
This function enables the timer events that can trigger the start of a DMA sequence. The DMA trigger events are specified in the ui32DMAEvent parameter by passing in the logical OR of the following values:
void TimerEnable | ( | unsigned long | ulBase, |
unsigned long | ulTimer | ||
) |
Enables the timer(s).
ulBase | is the base address of the timer module. |
ulTimer | specifies the timer(s) to enable; must be one of TIMER_A, TIMER_B, or TIMER_BOTH. |
This function enables operation of the timer module. The timer must be configured before it is enabled.
void TimerIntClear | ( | unsigned long | ulBase, |
unsigned long | ulIntFlags | ||
) |
Clears timer interrupt sources.
ulBase | is the base address of the timer module. |
ulIntFlags | is a bit mask of the interrupt sources to be cleared. |
The specified timer interrupt sources are cleared, so that they no longer assert. This function must be called in the interrupt handler to keep the interrupt from being triggered again immediately upon exit.
The ulIntFlags parameter has the same definition as the ulIntFlags parameter to TimerIntEnable().
void TimerIntDisable | ( | unsigned long | ulBase, |
unsigned long | ulIntFlags | ||
) |
Disables individual timer interrupt sources.
ulBase | is the base address of the timer module. |
ulIntFlags | is the bit mask of the interrupt sources to be disabled. |
Disables the indicated timer interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt; disabled sources have no effect on the processor.
The ulIntFlags parameter has the same definition as the ulIntFlags parameter to TimerIntEnable().
void TimerIntEnable | ( | unsigned long | ulBase, |
unsigned long | ulIntFlags | ||
) |
Enables individual timer interrupt sources.
ulBase | is the base address of the timer module. |
ulIntFlags | is the bit mask of the interrupt sources to be enabled. |
Enables the indicated timer interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt; disabled sources have no effect on the processor.
The ulIntFlags parameter must be the logical OR of any combination of the following:
void TimerIntRegister | ( | unsigned long | ulBase, |
unsigned long | ulTimer, | ||
void(*)(void) | pfnHandler | ||
) |
Registers an interrupt handler for the timer interrupt.
ulBase | is the base address of the timer module. |
ulTimer | specifies the timer(s); must be one of TIMER_A, TIMER_B, or TIMER_BOTH. |
pfnHandler | is a pointer to the function to be called when the timer interrupt occurs. |
This function sets the handler to be called when a timer interrupt occurs. In addition, this function enables the global interrupt in the interrupt controller; specific timer interrupts must be enabled via TimerIntEnable(). It is the interrupt handler's responsibility to clear the interrupt source via TimerIntClear().
unsigned long TimerIntStatus | ( | unsigned long | ulBase, |
tBoolean | bMasked | ||
) |
Gets the current interrupt status.
ulBase | is the base address of the timer module. |
bMasked | is false if the raw interrupt status is required and true if the masked interrupt status is required. |
This function returns the interrupt status for the timer module. Either the raw interrupt status or the status of interrupts that are allowed to reflect to the processor can be returned.
void TimerIntUnregister | ( | unsigned long | ulBase, |
unsigned long | ulTimer | ||
) |
Unregisters an interrupt handler for the timer interrupt.
ulBase | is the base address of the timer module. |
ulTimer | specifies the timer(s); must be one of TIMER_A, TIMER_B, or TIMER_BOTH. |
This function clears the handler to be called when a timer interrupt occurs. This function also masks off the interrupt in the interrupt controller so that the interrupt handler no longer is called.
unsigned long TimerLoadGet | ( | unsigned long | ulBase, |
unsigned long | ulTimer | ||
) |
Gets the timer load value.
ulBase | is the base address of the timer module. |
ulTimer | specifies the timer; must be one of TIMER_A or TIMER_B. Only TIMER_A should be used when the timer is configured for full-width operation. |
This function gets the currently programmed interval load value for the specified timer.
void TimerLoadSet | ( | unsigned long | ulBase, |
unsigned long | ulTimer, | ||
unsigned long | ulValue | ||
) |
Sets the timer load value.
ulBase | is the base address of the timer module. |
ulTimer | specifies the timer(s) to adjust; must be one of TIMER_A, TIMER_B, or TIMER_BOTH. Only TIMER_A should be used when the timer is configured for full-width operation. |
ulValue | is the load value. |
This function sets the timer load value; if the timer is running then the value is immediately loaded into the timer.
unsigned long TimerMatchGet | ( | unsigned long | ulBase, |
unsigned long | ulTimer | ||
) |
Gets the timer match value.
ulBase | is the base address of the timer module. |
ulTimer | specifies the timer; must be one of TIMER_A or TIMER_B. Only TIMER_A should be used when the timer is configured for 32-bit operation. |
This function gets the match value for the specified timer.
void TimerMatchSet | ( | unsigned long | ulBase, |
unsigned long | ulTimer, | ||
unsigned long | ulValue | ||
) |
Sets the timer match value.
ulBase | is the base address of the timer module. |
ulTimer | specifies the timer(s) to adjust; must be one of TIMER_A, TIMER_B, or TIMER_BOTH. Only TIMER_A should be used when the timer is configured for 32-bit operation. |
ulValue | is the match value. |
This function sets the match value for a timer. This is used in capture count mode to determine when to interrupt the processor and in PWM mode to determine the duty cycle of the output signal.
unsigned long TimerPrescaleGet | ( | unsigned long | ulBase, |
unsigned long | ulTimer | ||
) |
Get the timer prescale value.
ulBase | is the base address of the timer module. |
ulTimer | specifies the timer; must be one of TIMER_A or TIMER_B. |
This function gets the value of the input clock prescaler. The prescaler is only operational when in half-width mode and is used to extend the range of the half-width timer modes.
unsigned long TimerPrescaleMatchGet | ( | unsigned long | ulBase, |
unsigned long | ulTimer | ||
) |
Get the timer prescale match value.
ulBase | is the base address of the timer module. |
ulTimer | specifies the timer; must be one of TIMER_A or TIMER_B. |
This function gets the value of the input clock prescaler match value. When in a half-width mode that uses the counter match and prescaler, the prescale match effectively extends the range of the match.
void TimerPrescaleMatchSet | ( | unsigned long | ulBase, |
unsigned long | ulTimer, | ||
unsigned long | ulValue | ||
) |
Set the timer prescale match value.
ulBase | is the base address of the timer module. |
ulTimer | specifies the timer(s) to adjust; must be one of TIMER_A, TIMER_B, or TIMER_BOTH. |
ulValue | is the timer prescale match value which must be between 0 and 255 (inclusive) for 16/32-bit timers. |
This function sets the value of the input clock prescaler match value. When in a half-width mode that uses the counter match and the prescaler, the prescale match effectively extends the range of the match.
void TimerPrescaleSet | ( | unsigned long | ulBase, |
unsigned long | ulTimer, | ||
unsigned long | ulValue | ||
) |
Set the timer prescale value.
ulBase | is the base address of the timer module. |
ulTimer | specifies the timer(s) to adjust; must be one of TIMER_A, TIMER_B, or TIMER_BOTH. |
ulValue | is the timer prescale value which must be between 0 and 255 (inclusive) for 16/32-bit timers. |
This function sets the value of the input clock prescaler. The prescaler is only operational when in half-width mode and is used to extend the range of the half-width timer modes.
unsigned long TimerValueGet | ( | unsigned long | ulBase, |
unsigned long | ulTimer | ||
) |
Gets the current timer value.
ulBase | is the base address of the timer module. |
ulTimer | specifies the timer; must be one of TIMER_A or TIMER_B. Only TIMER_A should be used when the timer is configured for 32-bit operation. |
This function reads the current value of the specified timer.
void TimerValueSet | ( | unsigned long | ulBase, |
unsigned long | ulTimer, | ||
unsigned long | ulValue | ||
) |
Sets the current timer value.
ulBase | is the base address of the timer module. |
ulTimer | specifies the timer; must be one of TIMER_A or TIMER_B. Only TIMER_A should be used when the timer is configured for 32-bit operation. |
ulValue | is the new value of the timer to be set. |
This function sets the current value of the specified timer.