xQueueSendFromISR

queue.h

1 BaseType_t xQueueSendFromISR
2           (
3               QueueHandle_t xQueue,
4               const void *pvItemToQueue,
5               BaseType_t *pxHigherPriorityTaskWoken
6           );

This is a macro that calls

xQueueGenericSendFromISR()

. It is included for backward compatibility with versions of FreeRTOS that did not include the

xQueueSendToBackFromISR()

and

xQueueSendToFrontFromISR()

macros.

Post an item into the back of a queue. It is safe to use this function from within an interrupt service routine.

Items are queued by copy not reference so it is preferable to only queue small items, especially when called from an ISR. In most cases it would be preferable to store a pointer to the item being queued.

Parameters:

xQueue

The handle to the queue on which the item is to be posted.
pvItemToQueue

A pointer to the item that is to be placed on the queue. The size of the items the queue will hold was defined when the queue was created, so this many bytes will be copied from
```
pvItemToQueue
```
into the queue storage area.
pxHigherPriorityTaskWoken
```
xQueueSendFromISR()
```
will set
```
*pxHigherPriorityTaskWoken
```
to
```
pdTRUE
```
if sending to the queue caused a task to unblock, and the unblocked task has a priority higher than the currently running task. If
```
xQueueSendFromISR()
```
sets this value to
```
pdTRUE
```
then a context switch should be requested before the interrupt is exited. From FreeRTOS V7.3.0
```
pxHigherPriorityTaskWoken
```
is an optional parameter and can be set to NULL.

Returns:

pdPASS if the data was successfully sent to the queue,
errQUEUE_FULL otherwise.

Example usage for buffered IO (where the ISR can obtain more than one value per call):

1void vBufferISR( void )
2{
3    char cIn;
4    BaseType_t xHigherPriorityTaskWoken;
5
6    /* We have not woken a task at the start of the ISR. */
7    xHigherPriorityTaskWoken = pdFALSE;
8
9    /* Loop until the buffer is empty. */
10    do
11    {
12        /* Obtain a byte from the buffer. */
13        cIn = portINPUT_BYTE( RX_REGISTER_ADDRESS );
14
15       /* Post the byte. */
16       xQueueSendFromISR( xRxQueue, &cIn, &xHigherPriorityTaskWoken );
17
18    } while( portINPUT_BYTE( BUFFER_COUNT ) );
19
20    /* Now the buffer is empty we can switch context if necessary. */
21    if( xHigherPriorityTaskWoken )
22    {
23        /* Actual macro used here is port specific. */
24        taskYIELD_FROM_ISR ();
25    }
26}

xQueueSendFromISR

Related links