You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
60 lines
2.8 KiB
60 lines
2.8 KiB
/**
|
|
******************************************************************************
|
|
* @file stm_queue.h
|
|
* @author MCD Application Team
|
|
* @brief Header for stm_queue.c
|
|
******************************************************************************
|
|
* @attention
|
|
*
|
|
* <h2><center>© Copyright (c) 2019 STMicroelectronics.
|
|
* All rights reserved.</center></h2>
|
|
*
|
|
* This software component is licensed by ST under BSD 3-Clause license,
|
|
* the "License"; You may not use this file except in compliance with the
|
|
* License. You may obtain a copy of the License at:
|
|
* opensource.org/licenses/BSD-3-Clause
|
|
*
|
|
******************************************************************************
|
|
*/
|
|
|
|
|
|
|
|
/* Define to prevent recursive inclusion -------------------------------------*/
|
|
#ifndef __STM_QUEUE_H
|
|
#define __STM_QUEUE_H
|
|
|
|
/* Includes ------------------------------------------------------------------*/
|
|
/* Exported define -----------------------------------------------------------*/
|
|
/* Options flags */
|
|
#define CIRCULAR_QUEUE_NO_FLAG 0
|
|
#define CIRCULAR_QUEUE_NO_WRAP_FLAG 1
|
|
#define CIRCULAR_QUEUE_SPLIT_IF_WRAPPING_FLAG 2
|
|
|
|
|
|
/* Exported types ------------------------------------------------------------*/
|
|
typedef struct {
|
|
uint8_t* qBuff; /* queue buffer, , provided by init fct */
|
|
uint32_t queueMaxSize; /* size of the queue, provided by init fct (in bytes)*/
|
|
uint16_t elementSize; /* -1 variable. If variable elemenet size the size is stored in the 4 first of the queue element */
|
|
uint32_t first; /* position of first element */
|
|
uint32_t last; /* position of last element */
|
|
uint32_t byteCount; /* number of bytes in the queue */
|
|
uint32_t elementCount; /* number of element in the queue */
|
|
uint8_t optionFlags; /* option to enable specific features */
|
|
} queue_t;
|
|
|
|
/* Exported constants --------------------------------------------------------*/
|
|
|
|
/* Exported macro ------------------------------------------------------------*/
|
|
/* Exported functions ------------------------------------------------------- */
|
|
int CircularQueue_Init(queue_t *q, uint8_t* queueBuffer, uint32_t queueSize, uint16_t elementSize, uint8_t optionlags);
|
|
uint8_t* CircularQueue_Add(queue_t *q, uint8_t* x, uint16_t elementSize, uint32_t nbElements);
|
|
uint8_t* CircularQueue_Remove(queue_t *q, uint16_t* elementSize);
|
|
uint8_t* CircularQueue_Sense(queue_t *q, uint16_t* elementSize);
|
|
int CircularQueue_Empty(queue_t *q);
|
|
int CircularQueue_NbElement(queue_t *q);
|
|
uint8_t* CircularQueue_Remove_Copy(queue_t *q, uint16_t* elementSize, uint8_t* buffer);
|
|
uint8_t* CircularQueue_Sense_Copy(queue_t *q, uint16_t* elementSize, uint8_t* buffer);
|
|
|
|
/******************* (C) COPYRIGHT 2010 STMicroelectronics *****END OF FILE****/
|
|
#endif /* __STM_QUEUE_H */
|
|
|