| Message ID | 20240722160745.67904-3-philmd@linaro.org |
|---|---|
| State | Superseded |
| Headers | show |
| Series | util/fifo8: Rework fifo8_pop_buf() | expand |
On 7/22/24 09:07, Philippe Mathieu-Daudé wrote: > Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org> > --- > include/qemu/fifo8.h | 22 ++++++---------------- > 1 file changed, 6 insertions(+), 16 deletions(-) > > diff --git a/include/qemu/fifo8.h b/include/qemu/fifo8.h > index c6295c6ff0..2692d6bfda 100644 > --- a/include/qemu/fifo8.h > +++ b/include/qemu/fifo8.h > @@ -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,7 +60,6 @@ void fifo8_push_all(Fifo8 *fifo, const uint8_t *data, uint32_t num); > * > * Returns: The popped data byte. > */ > - > uint8_t fifo8_pop(Fifo8 *fifo); > > /** > @@ -73,7 +68,7 @@ uint8_t fifo8_pop(Fifo8 *fifo); > * @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 > + * 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. > @@ -82,7 +77,7 @@ uint8_t fifo8_pop(Fifo8 *fifo); > * 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. > * > @@ -99,7 +94,7 @@ const uint8_t *fifo8_pop_buf(Fifo8 *fifo, uint32_t max, uint32_t *numptr); > * @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 +104,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. > * > @@ -126,7 +121,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 +131,6 @@ void fifo8_reset(Fifo8 *fifo); > * > * Returns: True if the fifo is empty, false otherwise. > */ > - > bool fifo8_is_empty(Fifo8 *fifo); > > /** > @@ -148,7 +141,6 @@ bool fifo8_is_empty(Fifo8 *fifo); > * > * Returns: True if the fifo is full, false otherwise. > */ > - > bool fifo8_is_full(Fifo8 *fifo); > > /** > @@ -159,7 +151,6 @@ bool fifo8_is_full(Fifo8 *fifo); > * > * Returns: Number of free bytes. > */ > - > uint32_t fifo8_num_free(Fifo8 *fifo); > > /** > @@ -170,7 +161,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; Reviewed-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>
On 22/07/2024 17:07, Philippe Mathieu-Daudé wrote: > Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org> > --- > include/qemu/fifo8.h | 22 ++++++---------------- > 1 file changed, 6 insertions(+), 16 deletions(-) > > diff --git a/include/qemu/fifo8.h b/include/qemu/fifo8.h > index c6295c6ff0..2692d6bfda 100644 > --- a/include/qemu/fifo8.h > +++ b/include/qemu/fifo8.h > @@ -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,7 +60,6 @@ void fifo8_push_all(Fifo8 *fifo, const uint8_t *data, uint32_t num); > * > * Returns: The popped data byte. > */ > - > uint8_t fifo8_pop(Fifo8 *fifo); > > /** > @@ -73,7 +68,7 @@ uint8_t fifo8_pop(Fifo8 *fifo); > * @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 > + * 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. > @@ -82,7 +77,7 @@ uint8_t fifo8_pop(Fifo8 *fifo); > * 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. > * > @@ -99,7 +94,7 @@ const uint8_t *fifo8_pop_buf(Fifo8 *fifo, uint32_t max, uint32_t *numptr); > * @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 +104,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. > * > @@ -126,7 +121,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 +131,6 @@ void fifo8_reset(Fifo8 *fifo); > * > * Returns: True if the fifo is empty, false otherwise. > */ > - > bool fifo8_is_empty(Fifo8 *fifo); > > /** > @@ -148,7 +141,6 @@ bool fifo8_is_empty(Fifo8 *fifo); > * > * Returns: True if the fifo is full, false otherwise. > */ > - > bool fifo8_is_full(Fifo8 *fifo); > > /** > @@ -159,7 +151,6 @@ bool fifo8_is_full(Fifo8 *fifo); > * > * Returns: Number of free bytes. > */ > - > uint32_t fifo8_num_free(Fifo8 *fifo); > > /** > @@ -170,7 +161,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; Reviewed-by: Mark Cave-Ayland <mark.cave-ayland@ilande.co.uk> ATB, Mark.
diff --git a/include/qemu/fifo8.h b/include/qemu/fifo8.h index c6295c6ff0..2692d6bfda 100644 --- a/include/qemu/fifo8.h +++ b/include/qemu/fifo8.h @@ -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,7 +60,6 @@ void fifo8_push_all(Fifo8 *fifo, const uint8_t *data, uint32_t num); * * Returns: The popped data byte. */ - uint8_t fifo8_pop(Fifo8 *fifo); /** @@ -73,7 +68,7 @@ uint8_t fifo8_pop(Fifo8 *fifo); * @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 + * 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. @@ -82,7 +77,7 @@ uint8_t fifo8_pop(Fifo8 *fifo); * 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. * @@ -99,7 +94,7 @@ const uint8_t *fifo8_pop_buf(Fifo8 *fifo, uint32_t max, uint32_t *numptr); * @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 +104,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. * @@ -126,7 +121,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 +131,6 @@ void fifo8_reset(Fifo8 *fifo); * * Returns: True if the fifo is empty, false otherwise. */ - bool fifo8_is_empty(Fifo8 *fifo); /** @@ -148,7 +141,6 @@ bool fifo8_is_empty(Fifo8 *fifo); * * Returns: True if the fifo is full, false otherwise. */ - bool fifo8_is_full(Fifo8 *fifo); /** @@ -159,7 +151,6 @@ bool fifo8_is_full(Fifo8 *fifo); * * Returns: Number of free bytes. */ - uint32_t fifo8_num_free(Fifo8 *fifo); /** @@ -170,7 +161,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;
Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org> --- include/qemu/fifo8.h | 22 ++++++---------------- 1 file changed, 6 insertions(+), 16 deletions(-)