From 988b36805ab5608e759fbf56c8d78a95459c6bd6 Mon Sep 17 00:00:00 2001
From: Jan Breuer <jan.breuer@jaybee.cz>
Date: 周六, 03 10月 2015 00:20:51 +0800
Subject: [PATCH] Comment numeric list
---
libscpi/src/fifo.c | 36 +++++++++++++++++++++++++++++++-----
1 files changed, 31 insertions(+), 5 deletions(-)
diff --git a/libscpi/src/fifo.c b/libscpi/src/fifo.c
index 306ff2f..341bc8e 100644
--- a/libscpi/src/fifo.c
+++ b/libscpi/src/fifo.c
@@ -1,18 +1,32 @@
#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;
}
-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;
}
-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;
}
-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);
--
Gitblit v1.9.1