#include "queue.h"

Macros
#define	semBINARY_SEMAPHORE_QUEUE_LENGTH ( ( unsigned char ) 1U )

#define	semGIVE_BLOCK_TIME ( ( portTickType ) 0U )

#define	semSEMAPHORE_QUEUE_ITEM_LENGTH ( ( unsigned char ) 0U )

#define	vSemaphoreCreateBinary(xSemaphore)

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

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

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

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

#define	xSemaphoreCreateMutex() xQueueCreateMutex( queueQUEUE_TYPE_MUTEX )

#define	xSemaphoreCreateRecursiveMutex() xQueueCreateMutex( queueQUEUE_TYPE_RECURSIVE_MUTEX )

#define	xSemaphoreGetMutexHolder(xSemaphore) xQueueGetMutexHolder( ( xSemaphore ) )
	semphr.h More...

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

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

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

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

#define	xSemaphoreTakeFromISR(xSemaphore, pxHigherPriorityTaskWoken) xQueueReceiveFromISR( ( xQueueHandle ) ( xSemaphore ), NULL, ( pxHigherPriorityTaskWoken ) )
	semphr. More...

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

Typedefs
typedef xQueueHandle	xSemaphoreHandle

#define semBINARY_SEMAPHORE_QUEUE_LENGTH ( ( unsigned char ) 1U )

#define semGIVE_BLOCK_TIME ( ( portTickType ) 0U )

#define semSEMAPHORE_QUEUE_ITEM_LENGTH ( ( unsigned char ) 0U )

#define vSemaphoreCreateBinary ( xSemaphore )

Value:

{                                                                                                                                           \
        ( xSemaphore ) = xQueueGenericCreate( ( unsigned portBASE_TYPE ) 1, semSEMAPHORE_QUEUE_ITEM_LENGTH, queueQUEUE_TYPE_BINARY_SEMAPHORE ); \
		if( ( xSemaphore ) != NULL )                                                                                                          \
        {                                                                                                                                       \
			xSemaphoreGive( ( xSemaphore ) );                                                                                                    \
        }                                                                                                                                       \
    }

Referenced by sys_sem_new(), and vStartSemaphoreTasks().

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

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

Referenced by prvHighPriorityMutexTask(), and prvLowPriorityMutexTask().

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

Referenced by prvHighPriorityMutexTask(), and prvLowPriorityMutexTask().

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

Referenced by vStartCountingSemaphoreTasks().

#define xSemaphoreCreateMutex ( ) xQueueCreateMutex( queueQUEUE_TYPE_MUTEX )

Referenced by osprintf_init(), vStartAltGenericQueueTasks(), and vStartGenericQueueTasks().

#define xSemaphoreCreateRecursiveMutex ( ) xQueueCreateMutex( queueQUEUE_TYPE_RECURSIVE_MUTEX )

Referenced by vStartRecursiveMutexTasks().

#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.

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

Referenced by ksz8851snl_low_level_output(), osprint(), osprint_hex_array(), osprint_sem_give(), osprintf(), portTASK_FUNCTION(), prvDecrementSemaphoreCount(), prvHighPriorityMutexTask(), prvIncrementSemaphoreCount(), prvLowPriorityMutexTask(), and sys_sem_signal().

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

Referenced by INTN_Handler().

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

Referenced by prvRecursiveMutexBlockingTask(), prvRecursiveMutexControllingTask(), and prvRecursiveMutexPollingTask().

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

Referenced by osprint(), osprint_hex_array(), osprint_sem_take(), osprintf(), portTASK_FUNCTION(), prvCountingSemaphoreTask(), prvDecrementSemaphoreCount(), prvHighPriorityMutexTask(), prvIncrementSemaphoreCount(), prvLowPriorityMutexTask(), sys_arch_sem_wait(), and sys_sem_new().

#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

xSemaphore	A handle to the semaphore being taken. This is the handle returned when the semaphore was created.
pxHigherPriorityTaskWoken	xSemaphoreTakeFromISR() 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

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

Referenced by prvRecursiveMutexBlockingTask(), prvRecursiveMutexControllingTask(), and prvRecursiveMutexPollingTask().

typedef xQueueHandle xSemaphoreHandle

Microchip® Advanced Software Framework

Macros

Typedefs