|
@@ -15,10 +15,9 @@ typedef struct {
|
|
|
* @fifo: struct Fifo8 to initialise with new FIFO
|
|
|
* @capacity: capacity of the newly created FIFO
|
|
|
*
|
|
|
- * Create a FIFO of the specified size. Clients should call fifo8_destroy()
|
|
|
+ * Create a FIFO of the specified capacity. Clients should call fifo8_destroy()
|
|
|
* when finished using the fifo. The FIFO is initially empty.
|
|
|
*/
|
|
|
-
|
|
|
void fifo8_create(Fifo8 *fifo, uint32_t capacity);
|
|
|
|
|
|
/**
|
|
@@ -26,9 +25,8 @@ void fifo8_create(Fifo8 *fifo, uint32_t capacity);
|
|
|
* @fifo: FIFO to cleanup
|
|
|
*
|
|
|
* Cleanup a FIFO created with fifo8_create(). Frees memory created for FIFO
|
|
|
- *storage. The FIFO is no longer usable after this has been called.
|
|
|
+ * storage. The FIFO is no longer usable after this has been called.
|
|
|
*/
|
|
|
-
|
|
|
void fifo8_destroy(Fifo8 *fifo);
|
|
|
|
|
|
/**
|
|
@@ -39,7 +37,6 @@ void fifo8_destroy(Fifo8 *fifo);
|
|
|
* Push a data byte to the FIFO. Behaviour is undefined if the FIFO is full.
|
|
|
* Clients are responsible for checking for fullness using fifo8_is_full().
|
|
|
*/
|
|
|
-
|
|
|
void fifo8_push(Fifo8 *fifo, uint8_t data);
|
|
|
|
|
|
/**
|
|
@@ -52,7 +49,6 @@ void fifo8_push(Fifo8 *fifo, uint8_t data);
|
|
|
* Clients are responsible for checking the space left in the FIFO using
|
|
|
* fifo8_num_free().
|
|
|
*/
|
|
|
-
|
|
|
void fifo8_push_all(Fifo8 *fifo, const uint8_t *data, uint32_t num);
|
|
|
|
|
|
/**
|
|
@@ -64,25 +60,40 @@ void fifo8_push_all(Fifo8 *fifo, const uint8_t *data, uint32_t num);
|
|
|
*
|
|
|
* Returns: The popped data byte.
|
|
|
*/
|
|
|
-
|
|
|
uint8_t fifo8_pop(Fifo8 *fifo);
|
|
|
|
|
|
/**
|
|
|
* fifo8_pop_buf:
|
|
|
* @fifo: FIFO to pop from
|
|
|
+ * @dest: the buffer to write the data into (can be NULL)
|
|
|
+ * @destlen: size of @dest and maximum number of bytes to pop
|
|
|
+ *
|
|
|
+ * Pop a number of elements from the FIFO up to a maximum of @destlen.
|
|
|
+ * The popped data is copied into the @dest buffer.
|
|
|
+ * Care is taken when the data wraps around in the ring buffer.
|
|
|
+ *
|
|
|
+ * Returns: number of bytes popped.
|
|
|
+ */
|
|
|
+uint32_t fifo8_pop_buf(Fifo8 *fifo, uint8_t *dest, uint32_t destlen);
|
|
|
+
|
|
|
+/**
|
|
|
+ * fifo8_pop_bufptr:
|
|
|
+ * @fifo: FIFO to pop from
|
|
|
* @max: maximum number of bytes to pop
|
|
|
* @numptr: pointer filled with number of bytes returned (can be NULL)
|
|
|
*
|
|
|
- * Pop a number of elements from the FIFO up to a maximum of max. The buffer
|
|
|
+ * New code should prefer to use fifo8_pop_buf() instead of fifo8_pop_bufptr().
|
|
|
+ *
|
|
|
+ * Pop a number of elements from the FIFO up to a maximum of @max. The buffer
|
|
|
* containing the popped data is returned. This buffer points directly into
|
|
|
- * the FIFO backing store and data is invalidated once any of the fifo8_* APIs
|
|
|
- * are called on the FIFO.
|
|
|
+ * the internal FIFO backing store and data (without checking for overflow!)
|
|
|
+ * and is invalidated once any of the fifo8_* APIs are called on the FIFO.
|
|
|
*
|
|
|
* The function may return fewer bytes than requested when the data wraps
|
|
|
* around in the ring buffer; in this case only a contiguous part of the data
|
|
|
* is returned.
|
|
|
*
|
|
|
- * The number of valid bytes returned is populated in *numptr; will always
|
|
|
+ * The number of valid bytes returned is populated in *@numptr; will always
|
|
|
* return at least 1 byte. max must not be 0 or greater than the number of
|
|
|
* bytes in the FIFO.
|
|
|
*
|
|
@@ -91,15 +102,15 @@ uint8_t fifo8_pop(Fifo8 *fifo);
|
|
|
*
|
|
|
* Returns: A pointer to popped data.
|
|
|
*/
|
|
|
-const uint8_t *fifo8_pop_buf(Fifo8 *fifo, uint32_t max, uint32_t *numptr);
|
|
|
+const uint8_t *fifo8_pop_bufptr(Fifo8 *fifo, uint32_t max, uint32_t *numptr);
|
|
|
|
|
|
/**
|
|
|
- * fifo8_peek_buf: read upto max bytes from the fifo
|
|
|
+ * fifo8_peek_bufptr: read upto max bytes from the fifo
|
|
|
* @fifo: FIFO to read from
|
|
|
* @max: maximum number of bytes to peek
|
|
|
* @numptr: pointer filled with number of bytes returned (can be NULL)
|
|
|
*
|
|
|
- * Peek into a number of elements from the FIFO up to a maximum of max.
|
|
|
+ * Peek into a number of elements from the FIFO up to a maximum of @max.
|
|
|
* The buffer containing the data peeked into is returned. This buffer points
|
|
|
* directly into the FIFO backing store. Since data is invalidated once any
|
|
|
* of the fifo8_* APIs are called on the FIFO, it is the caller responsibility
|
|
@@ -109,7 +120,7 @@ const uint8_t *fifo8_pop_buf(Fifo8 *fifo, uint32_t max, uint32_t *numptr);
|
|
|
* around in the ring buffer; in this case only a contiguous part of the data
|
|
|
* is returned.
|
|
|
*
|
|
|
- * The number of valid bytes returned is populated in *numptr; will always
|
|
|
+ * The number of valid bytes returned is populated in *@numptr; will always
|
|
|
* return at least 1 byte. max must not be 0 or greater than the number of
|
|
|
* bytes in the FIFO.
|
|
|
*
|
|
@@ -118,7 +129,16 @@ const uint8_t *fifo8_pop_buf(Fifo8 *fifo, uint32_t max, uint32_t *numptr);
|
|
|
*
|
|
|
* Returns: A pointer to peekable data.
|
|
|
*/
|
|
|
-const uint8_t *fifo8_peek_buf(Fifo8 *fifo, uint32_t max, uint32_t *numptr);
|
|
|
+const uint8_t *fifo8_peek_bufptr(Fifo8 *fifo, uint32_t max, uint32_t *numptr);
|
|
|
+
|
|
|
+/**
|
|
|
+ * fifo8_drop:
|
|
|
+ * @fifo: FIFO to drop bytes
|
|
|
+ * @len: number of bytes to drop
|
|
|
+ *
|
|
|
+ * Drop (consume) bytes from a FIFO.
|
|
|
+ */
|
|
|
+void fifo8_drop(Fifo8 *fifo, uint32_t len);
|
|
|
|
|
|
/**
|
|
|
* fifo8_reset:
|
|
@@ -126,7 +146,6 @@ const uint8_t *fifo8_peek_buf(Fifo8 *fifo, uint32_t max, uint32_t *numptr);
|
|
|
*
|
|
|
* Reset a FIFO. All data is discarded and the FIFO is emptied.
|
|
|
*/
|
|
|
-
|
|
|
void fifo8_reset(Fifo8 *fifo);
|
|
|
|
|
|
/**
|
|
@@ -137,7 +156,6 @@ void fifo8_reset(Fifo8 *fifo);
|
|
|
*
|
|
|
* Returns: True if the fifo is empty, false otherwise.
|
|
|
*/
|
|
|
-
|
|
|
bool fifo8_is_empty(Fifo8 *fifo);
|
|
|
|
|
|
/**
|
|
@@ -148,7 +166,6 @@ bool fifo8_is_empty(Fifo8 *fifo);
|
|
|
*
|
|
|
* Returns: True if the fifo is full, false otherwise.
|
|
|
*/
|
|
|
-
|
|
|
bool fifo8_is_full(Fifo8 *fifo);
|
|
|
|
|
|
/**
|
|
@@ -159,7 +176,6 @@ bool fifo8_is_full(Fifo8 *fifo);
|
|
|
*
|
|
|
* Returns: Number of free bytes.
|
|
|
*/
|
|
|
-
|
|
|
uint32_t fifo8_num_free(Fifo8 *fifo);
|
|
|
|
|
|
/**
|
|
@@ -170,7 +186,6 @@ uint32_t fifo8_num_free(Fifo8 *fifo);
|
|
|
*
|
|
|
* Returns: Number of used bytes.
|
|
|
*/
|
|
|
-
|
|
|
uint32_t fifo8_num_used(Fifo8 *fifo);
|
|
|
|
|
|
extern const VMStateDescription vmstate_fifo8;
|