Serial Wombat 4A and 4B Firmware
queue.h
Go to the documentation of this file.
1 #ifndef _QUEUE_H_
2 #define _QUEUE_H_
3 
4 typedef enum
5 {
13 
14 
15 
16 SW_QUEUE_RESULT_t QueueByteInitialize(uint16_t address, uint16_t capacity);
17 SW_QUEUE_RESULT_t QueueByteShiftInitialize(uint16_t address, uint16_t capacity);
18 SW_QUEUE_RESULT_t QueueBytesInQueue(uint16_t address,uint16_t* bytesInQueue );
19 SW_QUEUE_RESULT_t QueueAddByte(uint16_t address, uint8_t data);
20 SW_QUEUE_RESULT_t QueueReadByte(uint16_t address, uint8_t* data);
21 SW_QUEUE_RESULT_t QueuePeekByte(uint16_t address, uint8_t* data);
22 SW_QUEUE_RESULT_t QueueGetBytesFilledInQueue(uint16_t address, uint16_t* bytesFilledInQueue);
23 SW_QUEUE_RESULT_t QueueGetBytesFreeInQueue(uint16_t address, uint16_t* bytesFreeInQueue);
24 SW_QUEUE_RESULT_t QueueCopy(uint16_t dstAddress, uint16_t sourceAddress);
25 
26 #endif
QueueGetBytesFilledInQueue
SW_QUEUE_RESULT_t QueueGetBytesFilledInQueue(uint16_t address, uint16_t *bytesFilledInQueue)
QUEUE_RESULT_EMPTY
@ QUEUE_RESULT_EMPTY
Definition: queue.h:11
QueueBytesInQueue
SW_QUEUE_RESULT_t QueueBytesInQueue(uint16_t address, uint16_t *bytesInQueue)
QUEUE_RESULT_INSUFFICIENT_USER_SPACE
@ QUEUE_RESULT_INSUFFICIENT_USER_SPACE
Definition: queue.h:7
SW_QUEUE_RESULT_t
SW_QUEUE_RESULT_t
Definition: queue.h:4
QueueAddByte
SW_QUEUE_RESULT_t QueueAddByte(uint16_t address, uint8_t data)
QueueCopy
SW_QUEUE_RESULT_t QueueCopy(uint16_t dstAddress, uint16_t sourceAddress)
QUEUE_RESULT_INVALID_QUEUE
@ QUEUE_RESULT_INVALID_QUEUE
Definition: queue.h:9
QUEUE_RESULT_SUCCESS
@ QUEUE_RESULT_SUCCESS
Definition: queue.h:6
QueuePeekByte
SW_QUEUE_RESULT_t QueuePeekByte(uint16_t address, uint8_t *data)
QueueByteShiftInitialize
SW_QUEUE_RESULT_t QueueByteShiftInitialize(uint16_t address, uint16_t capacity)
QueueByteInitialize
SW_QUEUE_RESULT_t QueueByteInitialize(uint16_t address, uint16_t capacity)
QUEUE_RESULT_UNALIGNED_ADDRESS
@ QUEUE_RESULT_UNALIGNED_ADDRESS
Definition: queue.h:8
QueueReadByte
SW_QUEUE_RESULT_t QueueReadByte(uint16_t address, uint8_t *data)
QUEUE_RESULT_FULL
@ QUEUE_RESULT_FULL
Definition: queue.h:10
QueueGetBytesFreeInQueue
SW_QUEUE_RESULT_t QueueGetBytesFreeInQueue(uint16_t address, uint16_t *bytesFreeInQueue)