uc-sdk
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
semphr.h File Reference
#include "queue.h"

Go to the source code of this file.

Macros

#define semBINARY_SEMAPHORE_QUEUE_LENGTH   ( ( unsigned char ) 1U )
 
#define semSEMAPHORE_QUEUE_ITEM_LENGTH   ( ( unsigned char ) 0U )
 
#define semGIVE_BLOCK_TIME   ( ( portTickType ) 0U )
 
#define vSemaphoreCreateBinary(xSemaphore)
 
#define xSemaphoreTake(xSemaphore, xBlockTime)   xQueueGenericReceive( ( xQueueHandle ) ( xSemaphore ), NULL, ( xBlockTime ), pdFALSE )
 
#define xSemaphoreTakeRecursive(xMutex, xBlockTime)   xQueueTakeMutexRecursive( ( xMutex ), ( xBlockTime ) )
 
#define xSemaphoreAltTake(xSemaphore, xBlockTime)   xQueueAltGenericReceive( ( xQueueHandle ) ( xSemaphore ), NULL, ( xBlockTime ), pdFALSE )
 
#define xSemaphoreGive(xSemaphore)   xQueueGenericSend( ( xQueueHandle ) ( xSemaphore ), NULL, semGIVE_BLOCK_TIME, queueSEND_TO_BACK )
 
#define xSemaphoreGiveRecursive(xMutex)   xQueueGiveMutexRecursive( ( xMutex ) )
 
#define xSemaphoreAltGive(xSemaphore)   xQueueAltGenericSend( ( xQueueHandle ) ( xSemaphore ), NULL, semGIVE_BLOCK_TIME, queueSEND_TO_BACK )
 
#define xSemaphoreGiveFromISR(xSemaphore, pxHigherPriorityTaskWoken)   xQueueGenericSendFromISR( ( xQueueHandle ) ( xSemaphore ), NULL, ( pxHigherPriorityTaskWoken ), queueSEND_TO_BACK )
 
#define xSemaphoreTakeFromISR(xSemaphore, pxHigherPriorityTaskWoken)   xQueueReceiveFromISR( ( xQueueHandle ) ( xSemaphore ), NULL, ( pxHigherPriorityTaskWoken ) )
 
#define xSemaphoreCreateMutex()   xQueueCreateMutex( queueQUEUE_TYPE_MUTEX )
 
#define xSemaphoreCreateRecursiveMutex()   xQueueCreateMutex( queueQUEUE_TYPE_RECURSIVE_MUTEX )
 
#define xSemaphoreCreateCounting(uxMaxCount, uxInitialCount)   xQueueCreateCountingSemaphore( ( uxMaxCount ), ( uxInitialCount ) )
 
#define vSemaphoreDelete(xSemaphore)   vQueueDelete( ( xQueueHandle ) ( xSemaphore ) )
 
#define xSemaphoreGetMutexHolder(xSemaphore)   xQueueGetMutexHolder( ( xSemaphore ) )
 

Typedefs

typedef xQueueHandle xSemaphoreHandle
 

Macro Definition Documentation

#define semBINARY_SEMAPHORE_QUEUE_LENGTH   ( ( unsigned char ) 1U )

Definition at line 77 of file semphr.h.

#define semGIVE_BLOCK_TIME   ( ( portTickType ) 0U )

Definition at line 79 of file semphr.h.

#define semSEMAPHORE_QUEUE_ITEM_LENGTH   ( ( unsigned char ) 0U )

Definition at line 78 of file semphr.h.

#define vSemaphoreCreateBinary (   xSemaphore)
Value:
{ \
if( ( xSemaphore ) != NULL ) \
{ \
( void ) xSemaphoreGive( ( xSemaphore ) ); \
} \
}

Definition at line 120 of file semphr.h.

#define vSemaphoreDelete (   xSemaphore)    vQueueDelete( ( xQueueHandle ) ( xSemaphore ) )

Definition at line 767 of file semphr.h.

#define xSemaphoreAltGive (   xSemaphore)    xQueueAltGenericSend( ( xQueueHandle ) ( xSemaphore ), NULL, semGIVE_BLOCK_TIME, queueSEND_TO_BACK )

Definition at line 463 of file semphr.h.

#define xSemaphoreAltTake (   xSemaphore,
  xBlockTime 
)    xQueueAltGenericReceive( ( xQueueHandle ) ( xSemaphore ), NULL, ( xBlockTime ), pdFALSE )

Definition at line 302 of file semphr.h.

#define xSemaphoreCreateCounting (   uxMaxCount,
  uxInitialCount 
)    xQueueCreateCountingSemaphore( ( uxMaxCount ), ( uxInitialCount ) )

Definition at line 753 of file semphr.h.

#define xSemaphoreCreateMutex ( )    xQueueCreateMutex( queueQUEUE_TYPE_MUTEX )

Definition at line 635 of file semphr.h.

#define xSemaphoreCreateRecursiveMutex ( )    xQueueCreateMutex( queueQUEUE_TYPE_RECURSIVE_MUTEX )

Definition at line 690 of file semphr.h.

#define xSemaphoreGetMutexHolder (   xSemaphore)    xQueueGetMutexHolder( ( xSemaphore ) )

semphr.h

xTaskHandle xSemaphoreGetMutexHolder( xSemaphoreHandle xMutex );

If xMutex is indeed a mutex type semaphore, return the current mutex holder. If xMutex is not a mutex type semaphore, or the mutex is available (not held by a task), return NULL.

Note: This Is is a good way of determining if the calling task is the mutex holder, but not a good way of determining the identity of the mutex holder as the holder may change between the function exiting and the returned value being tested.

Definition at line 782 of file semphr.h.

#define xSemaphoreGive (   xSemaphore)    xQueueGenericSend( ( xQueueHandle ) ( xSemaphore ), NULL, semGIVE_BLOCK_TIME, queueSEND_TO_BACK )

Definition at line 365 of file semphr.h.

#define xSemaphoreGiveFromISR (   xSemaphore,
  pxHigherPriorityTaskWoken 
)    xQueueGenericSendFromISR( ( xQueueHandle ) ( xSemaphore ), NULL, ( pxHigherPriorityTaskWoken ), queueSEND_TO_BACK )

Definition at line 554 of file semphr.h.

#define xSemaphoreGiveRecursive (   xMutex)    xQueueGiveMutexRecursive( ( xMutex ) )

Definition at line 449 of file semphr.h.

#define xSemaphoreTake (   xSemaphore,
  xBlockTime 
)    xQueueGenericReceive( ( xQueueHandle ) ( xSemaphore ), NULL, ( xBlockTime ), pdFALSE )

Definition at line 194 of file semphr.h.

#define xSemaphoreTakeFromISR (   xSemaphore,
  pxHigherPriorityTaskWoken 
)    xQueueReceiveFromISR( ( xQueueHandle ) ( xSemaphore ), NULL, ( pxHigherPriorityTaskWoken ) )

semphr. h

xSemaphoreTakeFromISR( 
                         xSemaphoreHandle xSemaphore, 
                         signed portBASE_TYPE *pxHigherPriorityTaskWoken
                     )

Macro to take a semaphore from an ISR. The semaphore must have previously been created with a call to vSemaphoreCreateBinary() or xSemaphoreCreateCounting().

Mutex type semaphores (those created using a call to xSemaphoreCreateMutex()) must not be used with this macro.

This macro can be used from an ISR, however taking a semaphore from an ISR is not a common operation. It is likely to only be useful when taking a counting semaphore when an interrupt is obtaining an object from a resource pool (when the semaphore count indicates the number of resources available).

Parameters
xSemaphoreA handle to the semaphore being taken. This is the handle returned when the semaphore was created.
pxHigherPriorityTaskWokenxSemaphoreTakeFromISR() will set *pxHigherPriorityTaskWoken to pdTRUE if taking the semaphore caused a task to unblock, and the unblocked task has a priority higher than the currently running task. If xSemaphoreTakeFromISR() sets this value to pdTRUE then a context switch should be requested before the interrupt is exited.
Returns
pdTRUE if the semaphore was successfully taken, otherwise pdFALSE

Definition at line 588 of file semphr.h.

#define xSemaphoreTakeRecursive (   xMutex,
  xBlockTime 
)    xQueueTakeMutexRecursive( ( xMutex ), ( xBlockTime ) )

Definition at line 287 of file semphr.h.

Typedef Documentation

Definition at line 75 of file semphr.h.