Collaboration diagram for Transparent Data Channel (TDC) Timer API:
Data Structures | |
| struct | ptxTDC_Timer_Status |
| TDC Timer: Component Structure. More... | |
Typedefs | |
| typedef struct ptxTDC_Timer_Status | ptxTDC_Timer_Status_t |
| TDC Timer: Component Structure. | |
Functions | |
| ptxStatus_t | ptxTDC_Timer_Start (uint32_t ms) |
| Initializes and starts the TDC timer for a given duration. | |
| ptxStatus_t | ptxTDC_Timer_Status (ptxTDC_Timer_Status_t *timerStatus) |
| Retrieves status information from the timer. | |
| ptxStatus_t | ptxTDC_Timer_Stop () |
| Stops and deinitializes the TDC timer. | |
Detailed Description
Function Documentation
◆ ptxTDC_Timer_Start()
| ptxStatus_t ptxTDC_Timer_Start | ( | uint32_t | ms | ) |
Initializes and starts the TDC timer for a given duration.
- Parameters
-
[in] ms Milliseconds until the timer elapses.
- Returns
- Status, indicating whether the operation was successful. See ptxStatus_t.
◆ ptxTDC_Timer_Status()
| ptxStatus_t ptxTDC_Timer_Status | ( | ptxTDC_Timer_Status_t * | timerStatus | ) |
Retrieves status information from the timer.
- Parameters
-
[in,out] timerStatus Pointer to ptxTDC_Timer_Status_t.
- Returns
- Status, indicating whether the operation was successful. See ptxStatus_t.
◆ ptxTDC_Timer_Stop()
| ptxStatus_t ptxTDC_Timer_Stop | ( | ) |
Stops and deinitializes the TDC timer.
- Returns
- Status, indicating whether the operation was successful. See ptxStatus_t.
