| LPCOpen Platform v1.03 LPCOpen Platform for NXP LPC Microcontrollers

- Main Page
- Modules
- Data Structures
- Files
- Related Pages

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Functions
CHIP: LPC11xx 32-bit Timer driver
LPC11xx chip specific drivers

## Detailed Description

## Functions
void | Chip_TIMER_Init (LPC_TIMER_T *pTMR)
| Initialize a timer.
void | Chip_TIMER_DeInit (LPC_TIMER_T *pTMR)
| Shutdown a timer.
STATIC INLINE bool | Chip_TIMER_MatchPending (LPC_TIMER_T *pTMR, int8_t matchnum)
| Determine if a match interrupt is pending.
STATIC INLINE bool | Chip_TIMER_CapturePending (LPC_TIMER_T *pTMR, int8_t capnum)
| Determine if a capture interrupt is pending.
STATIC INLINE void | Chip_TIMER_ClearMatch (LPC_TIMER_T *pTMR, int8_t matchnum)
| Clears a (pending) match interrupt.
STATIC INLINE void | Chip_TIMER_ClearCapture (LPC_TIMER_T *pTMR, int8_t capnum)
| Clears a (pending) capture interrupt.
STATIC INLINE void | Chip_TIMER_Enable (LPC_TIMER_T *pTMR)
| Enables the timer (starts count)
STATIC INLINE void | Chip_TIMER_Disable (LPC_TIMER_T *pTMR)
| Disables the timer (stops count)
STATIC INLINE uint32_t | Chip_TIMER_ReadCount (LPC_TIMER_T *pTMR)
| Returns the current timer count.
STATIC INLINE uint32_t | Chip_TIMER_ReadPrescale (LPC_TIMER_T *pTMR)
| Returns the current prescale count.
STATIC INLINE void | Chip_TIMER_PrescaleSet (LPC_TIMER_T *pTMR, uint32_t prescale)
| Sets the prescaler value.
STATIC INLINE void | Chip_TIMER_SetMatch (LPC_TIMER_T *pTMR, int8_t matchnum, uint32_t matchval)
| Sets a timer match value.
STATIC INLINE uint32_t | Chip_TIMER_ReadCapture (LPC_TIMER_T *pTMR, int8_t capnum)
| Reads a capture register.
STATIC INLINE void | Chip_TIMER_Reset (LPC_TIMER_T *pTMR)
| Resets the timer terminal and prescale counts to 0.
STATIC INLINE void | Chip_TIMER_MatchEnableInt (LPC_TIMER_T *pTMR, int8_t matchnum)
| Enables a match interrupt that fires when the terminal count matches the match counter value.
STATIC INLINE void | Chip_TIMER_MatchDisableInt (LPC_TIMER_T *pTMR, int8_t matchnum)
| Disables a match interrupt for a match counter.
STATIC INLINE void | Chip_TIMER_ResetOnMatchEnable (LPC_TIMER_T *pTMR, int8_t matchnum)
| For the specific match counter, enables reset of the terminal count register when a match occurs.
STATIC INLINE void | Chip_TIMER_ResetOnMatchDisable (LPC_TIMER_T *pTMR, int8_t matchnum)
| For the specific match counter, disables reset of the terminal count register when a match occurs.
STATIC INLINE void | Chip_TIMER_StopOnMatchEnable (LPC_TIMER_T *pTMR, int8_t matchnum)
| Enable a match timer to stop the terminal count when a match count equals the terminal count.
STATIC INLINE void | Chip_TIMER_StopOnMatchDisable (LPC_TIMER_T *pTMR, int8_t matchnum)
| Disable stop on match for a match timer. Disables a match timer to stop the terminal count when a match count equals the terminal count.
STATIC INLINE void | Chip_TIMER_CaptureRisingEdgeEnable (LPC_TIMER_T *pTMR, int8_t capnum)
| Enables capture on on rising edge of selected CAP signal for the selected capture register, enables the selected CAPn.capnum signal to load the capture register with the terminal coount on a rising edge.
STATIC INLINE void | Chip_TIMER_CaptureRisingEdgeDisable (LPC_TIMER_T *pTMR, int8_t capnum)
| Disables capture on on rising edge of selected CAP signal. For the selected capture register, disables the selected CAPn.capnum signal to load the capture register with the terminal coount on a rising edge.
STATIC INLINE void | Chip_TIMER_CaptureFallingEdgeEnable (LPC_TIMER_T *pTMR, int8_t capnum)
| Enables capture on on falling edge of selected CAP signal. For the selected capture register, enables the selected CAPn.capnum signal to load the capture register with the terminal coount on a falling edge.
STATIC INLINE void | Chip_TIMER_CaptureFallingEdgeDisable (LPC_TIMER_T *pTMR, int8_t capnum)
| Disables capture on on falling edge of selected CAP signal. For the selected capture register, disables the selected CAPn.capnum signal to load the capture register with the terminal coount on a falling edge.
STATIC INLINE void | Chip_TIMER_CaptureEnableInt (LPC_TIMER_T *pTMR, int8_t capnum)
| Enables interrupt on capture of selected CAP signal. For the selected capture register, an interrupt will be generated when the enabled rising or falling edge on CAPn.capnum is detected.
STATIC INLINE void | Chip_TIMER_CaptureDisableInt (LPC_TIMER_T *pTMR, int8_t capnum)
| Disables interrupt on capture of selected CAP signal.
STATIC INLINE void | Chip_TIMER_ExtMatchControlSet (LPC_TIMER_T *pTMR, int8_t initial_state, IP_TIMER_PIN_MATCH_STATE_T matchState, int8_t matchnum)
| Sets external match control (MATn.matchnum) pin control. For the pin selected with matchnum, sets the function of the pin that occurs on a terminal count match for the match count.
STATIC INLINE void | Chip_TIMER_TIMER_SetCountClockSrc (LPC_TIMER_T *pTMR, IP_TIMER_CAP_SRC_STATE_T capSrc, int8_t capnum)
| Sets timer count source and edge with the selected passed from CapSrc. If CapSrc selected a CAPn pin, select the specific CAPn pin with the capnum value.

## Function Documentation

STATIC INLINE void Chip_TIMER_CaptureDisableInt | ( | LPC_TIMER_T * | pTMR,
|  | int8_t | capnum
| ) |  |

Disables interrupt on capture of selected CAP signal.

Parameters

  pTMR | : Pointer to timer IP register address
  capnum | : Capture signal/register to use

Returns
  Nothing

Definition at line 333 of file timer_11xx.h.

STATIC INLINE void Chip_TIMER_CaptureEnableInt | ( | LPC_TIMER_T * | pTMR,
|  | int8_t | capnum
| ) |  |

Enables interrupt on capture of selected CAP signal. For the selected capture register, an interrupt will be generated when the enabled rising or falling edge on CAPn.capnum is detected.

Parameters

  pTMR | : Pointer to timer IP register address
  capnum | : Capture signal/register to use

Returns
  Nothing

Definition at line 322 of file timer_11xx.h.

STATIC INLINE void Chip_TIMER_CaptureFallingEdgeDisable | ( | LPC_TIMER_T * | pTMR,
|  | int8_t | capnum
| ) |  |

Disables capture on on falling edge of selected CAP signal. For the selected capture register, disables the selected CAPn.capnum signal to load the capture register with the terminal coount on a falling edge.

Parameters

  pTMR | : Pointer to timer IP register address
  capnum | : Capture signal/register to use

Returns
  Nothing

Definition at line 309 of file timer_11xx.h.

STATIC INLINE void Chip_TIMER_CaptureFallingEdgeEnable | ( | LPC_TIMER_T * | pTMR,
|  | int8_t | capnum
| ) |  |

Enables capture on on falling edge of selected CAP signal. For the selected capture register, enables the selected CAPn.capnum signal to load the capture register with the terminal coount on a falling edge.

Parameters

  pTMR | : Pointer to timer IP register address
  capnum | : Capture signal/register to use

Returns
  Nothing

Definition at line 296 of file timer_11xx.h.

STATIC INLINE bool Chip_TIMER_CapturePending | ( | LPC_TIMER_T * | pTMR,
|  | int8_t | capnum
| ) |  |

Determine if a capture interrupt is pending.

Parameters

  pTMR | : Pointer to timer IP register address
  capnum | : Capture interrupt number to check

Returns
  false if the interrupt is not pending, otherwise true

Note
  Determine if the capture interrupt for the passed capture pin is pending.

Definition at line 79 of file timer_11xx.h.

STATIC INLINE void Chip_TIMER_CaptureRisingEdgeDisable | ( | LPC_TIMER_T * | pTMR,
|  | int8_t | capnum
| ) |  |

Disables capture on on rising edge of selected CAP signal. For the selected capture register, disables the selected CAPn.capnum signal to load the capture register with the terminal coount on a rising edge.

Parameters

  pTMR | : Pointer to timer IP register address
  capnum | : Capture signal/register to use

Returns
  Nothing

Definition at line 283 of file timer_11xx.h.

STATIC INLINE void Chip_TIMER_CaptureRisingEdgeEnable | ( | LPC_TIMER_T * | pTMR,
|  | int8_t | capnum
| ) |  |

Enables capture on on rising edge of selected CAP signal for the selected capture register, enables the selected CAPn.capnum signal to load the capture register with the terminal coount on a rising edge.

Parameters

  pTMR | : Pointer to timer IP register address
  capnum | : Capture signal/register to use

Returns
  Nothing

Definition at line 270 of file timer_11xx.h.

STATIC INLINE void Chip_TIMER_ClearCapture | ( | LPC_TIMER_T * | pTMR,
|  | int8_t | capnum
| ) |  |

Clears a (pending) capture interrupt.

Parameters

  pTMR | : Pointer to timer IP register address
  capnum | : Capture interrupt number to clear

Returns
  Nothing

Definition at line 101 of file timer_11xx.h.

STATIC INLINE void Chip_TIMER_ClearMatch | ( | LPC_TIMER_T * | pTMR,
|  | int8_t | matchnum
| ) |  |

Clears a (pending) match interrupt.

Parameters

  pTMR | : Pointer to timer IP register address
  matchnum | : Match interrupt number to clear

Returns
  Nothing

Definition at line 90 of file timer_11xx.h.

void Chip_TIMER_DeInit | ( | LPC_TIMER_T * | pTMR | ) |

Shutdown a timer.

Parameters

  pTMR | : Pointer to timer IP register address

Returns
  Nothing

Definition at line 79 of file timer_11xx.c.

STATIC INLINE void Chip_TIMER_Disable | ( | LPC_TIMER_T * | pTMR | ) |

Disables the timer (stops count)

Parameters

  pTMR | : Pointer to timer IP register address

Returns
  Nothing

Definition at line 121 of file timer_11xx.h.

STATIC INLINE void Chip_TIMER_Enable | ( | LPC_TIMER_T * | pTMR | ) |

Enables the timer (starts count)

Parameters

  pTMR | : Pointer to timer IP register address

Returns
  Nothing

Definition at line 111 of file timer_11xx.h.

STATIC INLINE void Chip_TIMER_ExtMatchControlSet | ( | LPC_TIMER_T * | pTMR,
|  | int8_t | initial_state,
|  | IP_TIMER_PIN_MATCH_STATE_T | matchState,
|  | int8_t | matchnum
| ) |  |

Sets external match control (MATn.matchnum) pin control. For the pin selected with matchnum, sets the function of the pin that occurs on a terminal count match for the match count.

Parameters

  pTMR | : Pointer to timer IP register address
  initial_state | : Initial state of the pin, high(1) or low(0)
  matchState | : Selects the match state for the pin
  matchnum | : MATn.matchnum signal to use

Returns
  Nothing

Definition at line 348 of file timer_11xx.h.

void Chip_TIMER_Init | ( | LPC_TIMER_T * | pTMR | ) |

Initialize a timer.

Parameters

  pTMR | : Pointer to timer IP register address

Returns
  Nothing

Definition at line 72 of file timer_11xx.c.

STATIC INLINE void Chip_TIMER_MatchDisableInt | ( | LPC_TIMER_T * | pTMR,
|  | int8_t | matchnum
| ) |  |

Disables a match interrupt for a match counter.

Parameters

  pTMR | : Pointer to timer IP register address
  matchnum | : Match timer, 0 to 3

Returns
  Nothing

Definition at line 211 of file timer_11xx.h.

STATIC INLINE void Chip_TIMER_MatchEnableInt | ( | LPC_TIMER_T * | pTMR,
|  | int8_t | matchnum
| ) |  |

Enables a match interrupt that fires when the terminal count matches the match counter value.

Parameters

  pTMR | : Pointer to timer IP register address
  matchnum | : Match timer, 0 to 3

Returns
  Nothing

Definition at line 200 of file timer_11xx.h.

STATIC INLINE bool Chip_TIMER_MatchPending | ( | LPC_TIMER_T * | pTMR,
|  | int8_t | matchnum
| ) |  |

Determine if a match interrupt is pending.

Parameters

  pTMR | : Pointer to timer IP register address
  matchnum | : Match interrupt number to check

Returns
  false if the interrupt is not pending, otherwise true

Note
  Determine if the match interrupt for the passed timer and match counter is pending.

Definition at line 66 of file timer_11xx.h.

STATIC INLINE void Chip_TIMER_PrescaleSet | ( | LPC_TIMER_T * | pTMR,
|  | uint32_t | prescale
| ) |  |

Sets the prescaler value.

Parameters

  pTMR | : Pointer to timer IP register address
  prescale | : Prescale value to set the prescale register to

Returns
  Nothing

Definition at line 154 of file timer_11xx.h.

STATIC INLINE uint32_t Chip_TIMER_ReadCapture | ( | LPC_TIMER_T * | pTMR,
|  | int8_t | capnum
| ) |  |

Reads a capture register.

Parameters

  pTMR | : Pointer to timer IP register address
  capnum | : Capture register to read

Returns
  The selected capture register value

Note
  Returns the selected capture register value.

Definition at line 178 of file timer_11xx.h.

STATIC INLINE uint32_t Chip_TIMER_ReadCount | ( | LPC_TIMER_T * | pTMR | ) |

Returns the current timer count.

Parameters

  pTMR | : Pointer to timer IP register address

Returns
  Current timer terminal count value

Note
  Returns the current timer terminal count.

Definition at line 132 of file timer_11xx.h.

STATIC INLINE uint32_t Chip_TIMER_ReadPrescale | ( | LPC_TIMER_T * | pTMR | ) |

Returns the current prescale count.

Parameters

  pTMR | : Pointer to timer IP register address

Returns
  Current timer prescale count value

Note
  Returns the current prescale count.

Definition at line 143 of file timer_11xx.h.

STATIC INLINE void Chip_TIMER_Reset | ( | LPC_TIMER_T * | pTMR | ) |

Resets the timer terminal and prescale counts to 0.

Parameters

  pTMR | : Pointer to timer IP register address

Returns
  Nothing

Definition at line 188 of file timer_11xx.h.

STATIC INLINE void Chip_TIMER_ResetOnMatchDisable | ( | LPC_TIMER_T * | pTMR,
|  | int8_t | matchnum
| ) |  |

For the specific match counter, disables reset of the terminal count register when a match occurs.

Parameters

  pTMR | : Pointer to timer IP register address
  matchnum | : Match timer, 0 to 3

Returns
  Nothing

Definition at line 233 of file timer_11xx.h.

STATIC INLINE void Chip_TIMER_ResetOnMatchEnable | ( | LPC_TIMER_T * | pTMR,
|  | int8_t | matchnum
| ) |  |

For the specific match counter, enables reset of the terminal count register when a match occurs.

Parameters

  pTMR | : Pointer to timer IP register address
  matchnum | : Match timer, 0 to 3

Returns
  Nothing

Definition at line 222 of file timer_11xx.h.

STATIC INLINE void Chip_TIMER_SetMatch | ( | LPC_TIMER_T * | pTMR,
|  | int8_t | matchnum,
|  | uint32_t | matchval
| ) |  |

Sets a timer match value.

Parameters

  pTMR | : Pointer to timer IP register address
  matchnum | : Match timer to set match count for
  matchval | : Match value for the selected match count

Returns
  Nothing

Definition at line 166 of file timer_11xx.h.

STATIC INLINE void Chip_TIMER_StopOnMatchDisable | ( | LPC_TIMER_T * | pTMR,
|  | int8_t | matchnum
| ) |  |

Disable stop on match for a match timer. Disables a match timer to stop the terminal count when a match count equals the terminal count.

Parameters

  pTMR | : Pointer to timer IP register address
  matchnum | : Match timer, 0 to 3

Returns
  Nothing

Definition at line 257 of file timer_11xx.h.

STATIC INLINE void Chip_TIMER_StopOnMatchEnable | ( | LPC_TIMER_T * | pTMR,
|  | int8_t | matchnum
| ) |  |

Enable a match timer to stop the terminal count when a match count equals the terminal count.

Parameters

  pTMR | : Pointer to timer IP register address
  matchnum | : Match timer, 0 to 3

Returns
  Nothing

Definition at line 245 of file timer_11xx.h.

STATIC INLINE void Chip_TIMER_TIMER_SetCountClockSrc | ( | LPC_TIMER_T * | pTMR,
|  | IP_TIMER_CAP_SRC_STATE_T | capSrc,
|  | int8_t | capnum
| ) |  |

Sets timer count source and edge with the selected passed from CapSrc. If CapSrc selected a CAPn pin, select the specific CAPn pin with the capnum value.

Parameters

  pTMR | : Pointer to timer IP register address
  capSrc | : timer clock source and edge
  capnum | : CAPn.capnum pin to use (if used)

Returns
  Nothing

Definition at line 362 of file timer_11xx.h.