PSDK QNX API Guide
Files | Data Structures | Variables
SemaphoreP
OSAL

Files

file  SemaphoreP.h
 Semaphore module for the RTOS Porting Interface.
 

Data Structures

struct  SemaphoreP_Params
 Basic SemaphoreP Parameters. More...
 

Variables

char * SemaphoreP_Params::name
 
SemaphoreP_Mode SemaphoreP_Params::mode
 
uint32_t SemaphoreP_Params::maxCount
 

Semaphore status code

typedef int32_t SemaphoreP_Status
 Status codes for SemaphoreP APIs. More...
 
typedef void * SemaphoreP_Handle
 Opaque client reference to an instance of a SemaphoreP. More...
 
#define SemaphoreP_OK   (0)
 
#define SemaphoreP_FAILURE   (-(int32_t)1)
 
#define SemaphoreP_TIMEOUT   (-(int32_t)2)
 
#define SemaphoreP_UNSUPPORTED   (-(int32_t)3)
 
#define SemaphoreP_WAIT_FOREVER   (~((uint32_t)0U))
 Wait forever define. More...
 
#define SemaphoreP_NO_WAIT   ((uint32_t)0U)
 No wait define. More...
 

Mode of Semaphore

typedef uint32_t SemaphoreP_Mode
 Mode of the semaphore. More...
 
SemaphoreP_Handle SemaphoreP_create (uint32_t count, const SemaphoreP_Params *semParams)
 Function to create a semaphore. More...
 
SemaphoreP_Status SemaphoreP_delete (SemaphoreP_Handle semPhandle)
 Function to delete a semaphore. More...
 
void SemaphoreP_Params_init (SemaphoreP_Params *semParams)
 Initialize params structure to default values. More...
 
SemaphoreP_Status SemaphoreP_pend (SemaphoreP_Handle semPhandle, uint32_t timeout)
 Function to pend (wait) on a semaphore. More...
 
SemaphoreP_Status SemaphoreP_post (SemaphoreP_Handle semPhandle)
 Function to post (signal) a semaphore. More...
 
SemaphoreP_Status SemaphoreP_postFromClock (SemaphoreP_Handle semPhandle)
 Function to post (signal) a semaphore from an ClockP function. More...
 
SemaphoreP_Status SemaphoreP_postFromISR (SemaphoreP_Handle semPhandle)
 Function to post (signal) a semaphore from an ISR. More...
 
int32_t SemaphoreP_getCount (SemaphoreP_Handle semPhandle)
 Function to return the count of a semaphore. More...
 
#define SemaphoreP_Mode_COUNTING   (0x0U)
 
#define SemaphoreP_Mode_BINARY   (0x1U)
 

Detailed Description

SemaphoreP interface

Macro Definition Documentation

◆ SemaphoreP_OK

#define SemaphoreP_OK   (0)

◆ SemaphoreP_FAILURE

#define SemaphoreP_FAILURE   (-(int32_t)1)

API completed successfully

◆ SemaphoreP_TIMEOUT

#define SemaphoreP_TIMEOUT   (-(int32_t)2)

API failed

◆ SemaphoreP_UNSUPPORTED

#define SemaphoreP_UNSUPPORTED   (-(int32_t)3)

API failed because of a timeout

◆ SemaphoreP_WAIT_FOREVER

#define SemaphoreP_WAIT_FOREVER   (~((uint32_t)0U))

Wait forever define.

API failed because of not supported

◆ SemaphoreP_NO_WAIT

#define SemaphoreP_NO_WAIT   ((uint32_t)0U)

No wait define.

◆ SemaphoreP_Mode_COUNTING

#define SemaphoreP_Mode_COUNTING   (0x0U)

◆ SemaphoreP_Mode_BINARY

#define SemaphoreP_Mode_BINARY   (0x1U)

Typedef Documentation

◆ SemaphoreP_Status

typedef int32_t SemaphoreP_Status

Status codes for SemaphoreP APIs.

◆ SemaphoreP_Handle

typedef void* SemaphoreP_Handle

Opaque client reference to an instance of a SemaphoreP.

A SemaphoreP_Handle returned from the SemaphoreP_create represents that instance and is used in the other instance based functions (e.g. SemaphoreP_post or SemaphoreP_pend, etc.).

◆ SemaphoreP_Mode

typedef uint32_t SemaphoreP_Mode

Mode of the semaphore.

Function Documentation

◆ SemaphoreP_create()

SemaphoreP_Handle SemaphoreP_create ( uint32_t  count,
const SemaphoreP_Params *  semParams 
)

Function to create a semaphore.

Parameters
countInitial count of the semaphore. For binary semaphores, only values of 0 or 1 are valid.
semParamsPointer to the instance configuration parameters. NULL denotes to use the default parameters (SemaphoreP default parameters as noted in SemaphoreP_Params_init.
Returns
A SemaphoreP_Handle on success or a NULL on an error

◆ SemaphoreP_delete()

SemaphoreP_Status SemaphoreP_delete ( SemaphoreP_Handle  semPhandle)

Function to delete a semaphore.

Parameters
semPhandleA SemaphoreP_Handle returned from SemaphoreP_create
Returns
Status of the functions
  • SemaphoreP_OK: Deleted the semaphore instance
  • SemaphoreP_FAILED: Failed to delete the semaphore instance

◆ SemaphoreP_Params_init()

void SemaphoreP_Params_init ( SemaphoreP_Params *  semParams)

Initialize params structure to default values.

The default parameters are:

  • mode: SemaphoreP_Mode_COUNTING
  • name: NULL
Parameters
semParamsPointer to the instance configuration parameters.

◆ SemaphoreP_pend()

SemaphoreP_Status SemaphoreP_pend ( SemaphoreP_Handle  semPhandle,
uint32_t  timeout 
)

Function to pend (wait) on a semaphore.

Parameters
semPhandleA SemaphoreP_Handle returned from SemaphoreP_create
timeoutTimeout (in ticks) to wait for the semaphore to be posted (signalled).
Returns
Status of the functions
  • SemaphoreP_OK: Obtain the semaphore
  • SemaphoreP_TIMEOUT: Timed out. Semaphore was not obtained.
  • SemaphoreP_FAILED: Non-time out failure.

◆ SemaphoreP_post()

SemaphoreP_Status SemaphoreP_post ( SemaphoreP_Handle  semPhandle)

Function to post (signal) a semaphore.

Parameters
semPhandleA SemaphoreP_Handle returned from SemaphoreP_create
Returns
Status of the functions
  • SemaphoreP_OK: Released the semaphore
  • SemaphoreP_FAILED: Failed to post the semaphore

◆ SemaphoreP_postFromClock()

SemaphoreP_Status SemaphoreP_postFromClock ( SemaphoreP_Handle  semPhandle)

Function to post (signal) a semaphore from an ClockP function.

Parameters
semPhandleA SemaphoreP_Handle returned from SemaphoreP_create
Returns
Status of the functions
  • SemaphoreP_OK: Released the semaphore
  • SemaphoreP_FAILED: Failed to post the semaphore

◆ SemaphoreP_postFromISR()

SemaphoreP_Status SemaphoreP_postFromISR ( SemaphoreP_Handle  semPhandle)

Function to post (signal) a semaphore from an ISR.

Parameters
semPhandleA SemaphoreP_Handle returned from SemaphoreP_create
Returns
Status of the functions
  • SemaphoreP_OK: Released the semaphore
  • SemaphoreP_FAILED: Failed to post the semaphore

◆ SemaphoreP_getCount()

int32_t SemaphoreP_getCount ( SemaphoreP_Handle  semPhandle)

Function to return the count of a semaphore.

Parameters
semPhandleA SemaphoreP_Handle returned from SemaphoreP_create
Returns
The count of the semaphore

Variable Documentation

◆ name

char* SemaphoreP_Params::name

Name of the semaphore instance. Memory must persist for the life of the semaphore instance

◆ mode

SemaphoreP_Mode SemaphoreP_Params::mode

Mode for the semaphore SemaphoreP_Mode

◆ maxCount

uint32_t SemaphoreP_Params::maxCount

The max count allowed for counting semaphore