1.2.11.4 Library Interface
Time System Service library provides the following interfaces:
Functions
| Name | Description |
|---|---|
| SYS_TIME_Initialize | Initializes the System Time module |
| SYS_TIME_Deinitialize | Deinitializes the specific module instance of the SYS TIMER module |
| SYS_TIME_Status | Returns System Time status |
| SYS_TIME_CallbackRegisterUS | Registers a function with the time system service to be called back when the requested number of microseconds have expired (either once or repeatedly) |
| SYS_TIME_CallbackRegisterMS | Registers a function with the time system service to be called back when the requested number of milliseconds has expired (either once or repeatedly) |
| SYS_TIME_DelayUS | This function is used to generate a delay of a given number of microseconds |
| SYS_TIME_DelayMS | This function is used to generate a delay of a given number of milliseconds |
| SYS_TIME_DelayIsComplete | Determines if the given delay timer has completed |
| SYS_TIME_FrequencyGet | Gets the frequency at which the hardwaer timer counts |
| SYS_TIME_CounterGet | Get the common 32-bit system counter value |
| SYS_TIME_Counter64Get | Get the common 64-bit system counter value |
| SYS_TIME_CounterSet | Sets the common 32-bit system counter value |
| SYS_TIME_CountToUS | Converts a counter value to time interval in microseconds |
| SYS_TIME_CountToMS | Converts a counter value to time interval in milliseconds |
| SYS_TIME_USToCount | Convert the given time interval in microseconds to an equivalent counter value |
| SYS_TIME_MSToCount | Convert the given time interval in milliseconds to an equivalent counter value |
| SYS_TIME_TimerCreate | Creates and initializes a new 32-bit software timer instance |
| SYS_TIME_TimerReload | Reloads (or reinitializes) the software timer instance |
| SYS_TIME_TimerDestroy | Destroys/deallocates a software timer instance |
| SYS_TIME_TimerCounterGet | Gets the elapsed counter value of a software timer |
| SYS_TIME_TimerStart | Starts a software timer running |
| SYS_TIME_TimerStop | Stops a running software timer |
| SYS_TIME_TimerPeriodHasExpired | Reports whether or not the current period of a software timer has expired |
Data types and constants
| Name | Type | Description |
|---|---|---|
| SYS_TIME_INIT | Struct | Defines the data required to initialize the TIME system service |
| SYS_TIME_RESULT | Enum | Result of a time service client interface operation |
| SYS_TIME_HANDLE | Typedef | Handle to a software timer instance |
| SYS_TIME_HANDLE_INVALID | Macro | Invalid handle value to a software timer instance |
| SYS_TIME_CALLBACK_TYPE | Enum | Identifies the type of callback requested (single or periodic) |
| SYS_TIME_CALLBACK | Typedef | Pointer to a time system service callback function |