184 lines
6.9 KiB
C
184 lines
6.9 KiB
C
|
/**
|
||
|
|
* @file os_queue.h
|
||
|
|
* @author XRADIO IOT WLAN Team
|
||
|
|
*/
|
||
|
|
|
||
|
|
/*
|
||
|
|
* Copyright (C) 2017 XRADIO TECHNOLOGY CO., LTD. All rights reserved.
|
||
|
|
*
|
||
|
|
* Redistribution and use in source and binary forms, with or without
|
||
|
|
* modification, are permitted provided that the following conditions
|
||
|
|
* are met:
|
||
|
|
* 1. Redistributions of source code must retain the above copyright
|
||
|
|
* notice, this list of conditions and the following disclaimer.
|
||
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
||
|
|
* notice, this list of conditions and the following disclaimer in the
|
||
|
|
* documentation and/or other materials provided with the
|
||
|
|
* distribution.
|
||
|
|
* 3. Neither the name of XRADIO TECHNOLOGY CO., LTD. nor the names of
|
||
|
|
* its contributors may be used to endorse or promote products derived
|
||
|
|
* from this software without specific prior written permission.
|
||
|
|
*
|
||
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef _KERNEL_OS_OS_QUEUE_H_
|
||
|
|
#define _KERNEL_OS_OS_QUEUE_H_
|
||
|
|
|
||
|
|
#include "kernel/os/os_common.h"
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C" {
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Queue handle definition
|
||
|
|
*/
|
||
|
|
typedef OS_Handle_t OS_QueueHandle_t;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Queue object definition
|
||
|
|
*/
|
||
|
|
typedef struct OS_Queue {
|
||
|
|
OS_QueueHandle_t handle;
|
||
|
|
} OS_Queue_t;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Create and initialize a queue object
|
||
|
|
* @param[in] queue Pointer to the queue object
|
||
|
|
* @param[in] queueLen The maximum number of items that the queue can hold at
|
||
|
|
* any one time.
|
||
|
|
* @param[in] itemSize The size, in bytes, of each data item that can be stored
|
||
|
|
* in the queue.
|
||
|
|
* @retval OS_Status, OS_OK on success
|
||
|
|
*/
|
||
|
|
OS_Status OS_QueueCreate(OS_Queue_t *queue, uint32_t queueLen, uint32_t itemSize);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Delete the queue object
|
||
|
|
* @param[in] queue Pointer to the queue object
|
||
|
|
* @retval OS_Status, OS_OK on success
|
||
|
|
*/
|
||
|
|
OS_Status OS_QueueDelete(OS_Queue_t *queue);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Send (write) an item to the back of the queue
|
||
|
|
* @param[in] queue Pointer to the queue object
|
||
|
|
* @param[in] item Pointer to the data to be copied into the queue.
|
||
|
|
* The size of each item the queue can hold is set when the
|
||
|
|
* queue is created, and that many bytes will be copied from
|
||
|
|
* item into the queue storage area.
|
||
|
|
* @param[in] waitMS The maximum amount of time the thread should remain in the
|
||
|
|
* blocked state to wait for space to become available on the
|
||
|
|
* queue, should the queue already be full.
|
||
|
|
* OS_WAIT_FOREVER for waiting forever, zero for no waiting.
|
||
|
|
* @retval OS_Status, OS_OK on success
|
||
|
|
*/
|
||
|
|
OS_Status OS_QueueSend(OS_Queue_t *queue, const void *item, OS_Time_t waitMS);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Receive (read) an item from the queue
|
||
|
|
* @param[in] queue Pointer to the queue object
|
||
|
|
* @param[in] item Pointer to the memory into which the received data will be
|
||
|
|
* copied. The length of the buffer must be at least equal to
|
||
|
|
* the queue item size which is set when the queue is created.
|
||
|
|
* @param[in] waitMS The maximum amount of time the thread should remain in the
|
||
|
|
* blocked state to wait for data to become available on the
|
||
|
|
* queue, should the queue already be empty.
|
||
|
|
* OS_WAIT_FOREVER for waiting forever, zero for no waiting.
|
||
|
|
* @retval OS_Status, OS_OK on success
|
||
|
|
*/
|
||
|
|
OS_Status OS_QueueReceive(OS_Queue_t *queue, void *item, OS_Time_t waitMS);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Check whether the queue object is valid or not
|
||
|
|
* @param[in] queue Pointer to the queue object
|
||
|
|
* @return 1 on valid, 0 on invalid
|
||
|
|
*/
|
||
|
|
static __always_inline int OS_QueueIsValid(OS_Queue_t *queue)
|
||
|
|
{
|
||
|
|
return (queue->handle != OS_INVALID_HANDLE);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Set the queue object to invalid state
|
||
|
|
* @param[in] queue Pointer to the queue object
|
||
|
|
* @return None
|
||
|
|
*/
|
||
|
|
static __always_inline void OS_QueueSetInvalid(OS_Queue_t *queue)
|
||
|
|
{
|
||
|
|
queue->handle = OS_INVALID_HANDLE;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Create and initialize a message queue object
|
||
|
|
* @note A message queue is a queue with each data item can store a pointer.
|
||
|
|
* The size of each data item (message) is equal to sizeof(void *).
|
||
|
|
* @param[in] queue Pointer to the message queue object
|
||
|
|
* @param[in] queueLen The maximum number of items that the message queue can
|
||
|
|
* hold at any one time.
|
||
|
|
* @retval OS_Status, OS_OK on success
|
||
|
|
*/
|
||
|
|
static __always_inline OS_Status OS_MsgQueueCreate(OS_Queue_t *queue, uint32_t queueLen)
|
||
|
|
{
|
||
|
|
return OS_QueueCreate(queue, queueLen, sizeof(void *));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Delete the message queue object
|
||
|
|
* @param[in] queue Pointer to the message queue object
|
||
|
|
* @retval OS_Status, OS_OK on success
|
||
|
|
*/
|
||
|
|
static __always_inline OS_Status OS_MsgQueueDelete(OS_Queue_t *queue)
|
||
|
|
{
|
||
|
|
return OS_QueueDelete(queue);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Send (write) a message to the back of the message queue
|
||
|
|
* @param[in] queue Pointer to the message queue object
|
||
|
|
* @param[in] msg A message, which is a pointer, to be copied into the queue
|
||
|
|
* @param[in] waitMS The maximum amount of time the thread should remain in the
|
||
|
|
* blocked state to wait for space to become available on the
|
||
|
|
* message queue, should the message queue already be full.
|
||
|
|
* OS_WAIT_FOREVER for waiting forever, zero for no waiting.
|
||
|
|
* @retval OS_Status, OS_OK on success
|
||
|
|
*/
|
||
|
|
static __always_inline OS_Status OS_MsgQueueSend(OS_Queue_t *queue, void *msg, OS_Time_t waitMS)
|
||
|
|
{
|
||
|
|
return OS_QueueSend(queue, &msg, waitMS);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Receive (read) a message from the message queue
|
||
|
|
* @param[in] queue Pointer to the message queue object
|
||
|
|
* @param[in] msg Pointer to the message buffer into which the received message
|
||
|
|
* will be copied. A message is a pointer.
|
||
|
|
* @param[in] waitMS The maximum amount of time the thread should remain in the
|
||
|
|
* blocked state to wait for message to become available on
|
||
|
|
* the message queue, should the message queue already be
|
||
|
|
* empty.
|
||
|
|
* OS_WAIT_FOREVER for waiting forever, zero for no waiting.
|
||
|
|
* @retval OS_Status, OS_OK on success
|
||
|
|
*/
|
||
|
|
static __always_inline OS_Status OS_MsgQueueReceive(OS_Queue_t *queue, void **msg, OS_Time_t waitMS)
|
||
|
|
{
|
||
|
|
return OS_QueueReceive(queue, msg, waitMS);
|
||
|
|
}
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif /* _KERNEL_OS_OS_QUEUE_H_ */
|