pal_os_timer.h File Reference

This file provides the prototype declarations of PAL OS timer functionalities. More...

#include "pal.h"

Include dependency graph for pal_os_timer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
uint32_t	pal_os_timer_get_time_in_microseconds (void)
	Gets tick count value in microseconds. More...
uint32_t	pal_os_timer_get_time_in_milliseconds (void)
	Gets tick count value in milliseconds. More...
void	pal_os_timer_delay_in_milliseconds (uint16_t milliseconds)
	Waits or delay until the supplied milliseconds. More...
pal_status_t	pal_timer_init (void)
	To initialize the timer. More...
pal_status_t	pal_timer_deinit (void)
	To De-initialize the timer. More...

Detailed Description

This file provides the prototype declarations of PAL OS timer functionalities.

Copyright

MIT License

Copyright (c) 2019 Infineon Technologies AG

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE

\endcopyright

Author

Infineon Technologies AG

Function Documentation

pal_os_timer_delay_in_milliseconds()

void pal_os_timer_delay_in_milliseconds

(

uint16_t

milliseconds

)

Waits or delay until the supplied milliseconds.

Waits or delays until the given milliseconds time

Precondition

• None

Note

• None

Parameters

[in]

milliseconds

Delay value in milliseconds

pal_os_timer_get_time_in_microseconds()

uint32_t pal_os_timer_get_time_in_microseconds

(

void

)

Gets tick count value in microseconds.

Get the current time in microseconds

Precondition

• None

Note

• None

Return values

uint32_t

time in microseconds

pal_os_timer_get_time_in_milliseconds()

uint32_t pal_os_timer_get_time_in_milliseconds

(

void

)

Gets tick count value in milliseconds.

Get the current time in milliseconds

Precondition

• None

Note

• None

Return values

uint32_t

time in milliseconds

pal_timer_deinit()

pal_status_t pal_timer_deinit

(

void

)

To De-initialize the timer.

To De-initialize the timer

Precondition

• None

Note

• None

Return values

PAL_STATUS_SUCCESS	On successful execution
PAL_STATUS_FAILURE	On failure

pal_timer_init()

pal_status_t pal_timer_init

(

void

)

To initialize the timer.

To initialize the timer

Precondition

• None

Note

• None

Return values

PAL_STATUS_SUCCESS	On successful execution
PAL_STATUS_FAILURE	On failure