pal_os_lock.h File Reference

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

#include "pal.h"

Include dependency graph for pal_os_lock.h:

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

Go to the source code of this file.

Classes
struct	pal_os_lock
	PAL OS lock structure . More...
typedef struct pal_os_lock	pal_os_lock_t
	PAL OS lock structure . More...
void	pal_os_lock_create (pal_os_lock_t *p_lock, uint8_t lock_type)
	Creates a lock. More...
void	pal_os_lock_destroy (pal_os_lock_t *p_lock)
	Deinitializes the lock. More...
pal_status_t	pal_os_lock_acquire (pal_os_lock_t *p_lock)
	Acquires a lock. More...
void	pal_os_lock_release (pal_os_lock_t *p_lock)
	Releases the lock. More...
void	pal_os_lock_enter_critical_section (void)
	To enter critical section. More...
void	pal_os_lock_exit_critical_section (void)
	To exit critical section. More...

Detailed Description

This file provides the prototype declarations of PAL OS lock 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

Typedef Documentation

pal_os_lock_t

typedef struct pal_os_lock pal_os_lock_t

PAL OS lock structure .

Function Documentation

pal_os_lock_acquire()

pal_status_t pal_os_lock_acquire

(

pal_os_lock_t *

p_lock

)

Acquires a lock.

Acquires the lock associated with the instance of pal_os_lock_t.

• Acquires the lock to the supplied instance.

Precondition

• None

Note

• None

Parameters

[in]

p_lock

Valid instance of pal_os_lock_t.

pal_os_lock_create()

void pal_os_lock_create	(	pal_os_lock_t *	p_lock,
		uint8_t	lock_type
	)

Creates a lock.

Creates a lock to the instance of pal_os_lock_t.

• Creates the lock to the supplied instance.

Precondition

• None

Note

• None

Parameters

[in]	p_lock	Valid instance of pal_os_lock_t.
[in]	lock_type	Type of the lock.

pal_os_lock_destroy()

void pal_os_lock_destroy

(

pal_os_lock_t *

p_lock

)

Deinitializes the lock.

Destroys the lock to the instance of pal_os_lock_t.

• Deinitializes the lock of the supplied instance.

Precondition

• None

Note

• None

Parameters

[in]

p_lock

Valid instance of pal_os_lock_t.

pal_os_lock_enter_critical_section()

void pal_os_lock_enter_critical_section

(

void

)

To enter critical section.

Enters critical section

Precondition

• None

Note

• None

pal_os_lock_exit_critical_section()

void pal_os_lock_exit_critical_section

(

void

)

To exit critical section.

Exits critical section

Precondition

• None

Note

• None

pal_os_lock_release()

void pal_os_lock_release

(

pal_os_lock_t *

p_lock

)

Releases the lock.

Releases the lock associated with the instance of pal_os_lock_t.

• Releases the lock to the supplied instance.

Precondition

• None

Note

• None

Parameters

[in]

p_lock

Valid instance of pal_os_lock_t.