Diff: src/fifo.c

Revision:

1:b497f235115a

Parent:

0:aad43948c45c

--- a/src/fifo.c	Thu Apr 09 22:42:15 2015 +0000
+++ b/src/fifo.c	Fri Aug 07 21:54:11 2015 +0000
@@ -1,18 +1,32 @@
 
-#include "scpi/fifo.h"
+#include "fifo_private.h"
 
-void fifo_init(fifo_t * fifo) {
+/**
+ * Initialize fifo
+ * @param fifo
+ */
+void fifo_init(scpi_fifo_t * fifo) {
     fifo->wr = 0;
     fifo->rd = 0;
     fifo->size = FIFO_SIZE;
 }
 
-void fifo_clear(fifo_t * fifo) {
+/**
+ * Empty fifo
+ * @param fifo
+ */
+void fifo_clear(scpi_fifo_t * fifo) {
     fifo->wr = 0;
     fifo->rd = 0;
 }
 
-scpi_bool_t fifo_add(fifo_t * fifo, int16_t value) {
+/**
+ * Add element to fifo. If fifo is full, remove last element.
+ * @param fifo
+ * @param value
+ * @return 
+ */
+scpi_bool_t fifo_add(scpi_fifo_t * fifo, int16_t value) {
     /* FIFO full? */
     if (fifo->wr == ((fifo->rd + fifo->size) % (fifo->size + 1))) {
         fifo_remove(fifo, NULL);
@@ -24,7 +38,13 @@
     return TRUE;
 }
 
-scpi_bool_t fifo_remove(fifo_t * fifo, int16_t * value) {
+/**
+ * Remove element form fifo
+ * @param fifo
+ * @param value
+ * @return FALSE - fifo is empty
+ */
+scpi_bool_t fifo_remove(scpi_fifo_t * fifo, int16_t * value) {
     /* FIFO empty? */
     if (fifo->wr == fifo->rd) {
         return FALSE;
@@ -39,7 +59,13 @@
     return TRUE;
 }
 
-scpi_bool_t fifo_count(fifo_t * fifo, int16_t * value) {
+/**
+ * Retrive number of elements in fifo
+ * @param fifo
+ * @param value
+ * @return 
+ */
+scpi_bool_t fifo_count(scpi_fifo_t * fifo, int16_t * value) {
     *value = fifo->wr - fifo->rd;
     if (*value < 0) {
         *value += (fifo->size + 1);