Serial Wombat 4A and 4B Firmware
Enumerations | Functions
queue.h File Reference

Go to the source code of this file.

Enumerations

enum  SW_QUEUE_RESULT_t {
  QUEUE_RESULT_SUCCESS = 0, QUEUE_RESULT_INSUFFICIENT_USER_SPACE = 1, QUEUE_RESULT_UNALIGNED_ADDRESS = 2, QUEUE_RESULT_INVALID_QUEUE = 3,
  QUEUE_RESULT_FULL = 4, QUEUE_RESULT_EMPTY = 5
}
 

Functions

SW_QUEUE_RESULT_t QueueByteInitialize (uint16_t address, uint16_t capacity)
 
SW_QUEUE_RESULT_t QueueByteShiftInitialize (uint16_t address, uint16_t capacity)
 
SW_QUEUE_RESULT_t QueueBytesInQueue (uint16_t address, uint16_t *bytesInQueue)
 
SW_QUEUE_RESULT_t QueueAddByte (uint16_t address, uint8_t data)
 
SW_QUEUE_RESULT_t QueueReadByte (uint16_t address, uint8_t *data)
 
SW_QUEUE_RESULT_t QueuePeekByte (uint16_t address, uint8_t *data)
 
SW_QUEUE_RESULT_t QueueGetBytesFilledInQueue (uint16_t address, uint16_t *bytesFilledInQueue)
 
SW_QUEUE_RESULT_t QueueGetBytesFreeInQueue (uint16_t address, uint16_t *bytesFreeInQueue)
 
SW_QUEUE_RESULT_t QueueCopy (uint16_t dstAddress, uint16_t sourceAddress)
 

Enumeration Type Documentation

◆ SW_QUEUE_RESULT_t

Enumerator
QUEUE_RESULT_SUCCESS 
QUEUE_RESULT_INSUFFICIENT_USER_SPACE 
QUEUE_RESULT_UNALIGNED_ADDRESS 
QUEUE_RESULT_INVALID_QUEUE 
QUEUE_RESULT_FULL 
QUEUE_RESULT_EMPTY 

Function Documentation

◆ QueueAddByte()

SW_QUEUE_RESULT_t QueueAddByte ( uint16_t  address,
uint8_t  data 
)

◆ QueueByteInitialize()

SW_QUEUE_RESULT_t QueueByteInitialize ( uint16_t  address,
uint16_t  capacity 
)

◆ QueueByteShiftInitialize()

SW_QUEUE_RESULT_t QueueByteShiftInitialize ( uint16_t  address,
uint16_t  capacity 
)

◆ QueueBytesInQueue()

SW_QUEUE_RESULT_t QueueBytesInQueue ( uint16_t  address,
uint16_t *  bytesInQueue 
)

◆ QueueCopy()

SW_QUEUE_RESULT_t QueueCopy ( uint16_t  dstAddress,
uint16_t  sourceAddress 
)

◆ QueueGetBytesFilledInQueue()

SW_QUEUE_RESULT_t QueueGetBytesFilledInQueue ( uint16_t  address,
uint16_t *  bytesFilledInQueue 
)

◆ QueueGetBytesFreeInQueue()

SW_QUEUE_RESULT_t QueueGetBytesFreeInQueue ( uint16_t  address,
uint16_t *  bytesFreeInQueue 
)

◆ QueuePeekByte()

SW_QUEUE_RESULT_t QueuePeekByte ( uint16_t  address,
uint8_t *  data 
)

◆ QueueReadByte()

SW_QUEUE_RESULT_t QueueReadByte ( uint16_t  address,
uint8_t *  data 
)