From edf4f2883a71e71b5dd27243d1128647e00f40ee Mon Sep 17 00:00:00 2001
From: Jan Breuer <jan.breuer@jaybee.cz>
Date: ćšć, 19 3æ 2015 03:33:52 +0800
Subject: [PATCH] Update documentation
---
libscpi/src/error.c | 108 +++++++++++++++++++++++++++++-------------------------
1 files changed, 58 insertions(+), 50 deletions(-)
diff --git a/libscpi/src/error.c b/libscpi/src/error.c
index 475aa80..da0398e 100644
--- a/libscpi/src/error.c
+++ b/libscpi/src/error.c
@@ -39,20 +39,25 @@
#include "scpi/parser.h"
#include "scpi/ieee488.h"
#include "scpi/error.h"
-#include "scpi/fifo.h"
+#include "fifo_private.h"
-// basic FIFO
-static fifo_t local_error_queue;
+/* basic FIFO */
+static scpi_fifo_t local_error_queue;
-
+/**
+ * Initialize error queue
+ * @param context - scpi context
+ */
void SCPI_ErrorInit(scpi_t * context) {
- //// FreeRTOS
- // context->error_queue = (scpi_error_queue_t)xQueueCreate(100, sizeof(int16_t));
-
- // basic FIFO
+ /*
+ * // FreeRTOS
+ * context->error_queue = (scpi_error_queue_t)xQueueCreate(100, sizeof(int16_t));
+ */
+
+ /* basic FIFO */
context->error_queue = (scpi_error_queue_t)&local_error_queue;
- fifo_init((fifo_t *)context->error_queue);
+ fifo_init((scpi_fifo_t *)context->error_queue);
}
/**
@@ -60,11 +65,13 @@
* @param context - scpi context
*/
void SCPI_ErrorClear(scpi_t * context) {
- //// FreeRTOS
- //xQueueReset((xQueueHandle)context->error_queue);
-
- // basic FIFO
- fifo_clear((fifo_t *)context->error_queue);
+ /*
+ * // FreeRTOS
+ * xQueueReset((xQueueHandle)context->error_queue);
+ */
+
+ /* basic FIFO */
+ fifo_clear((scpi_fifo_t *)context->error_queue);
}
/**
@@ -74,14 +81,16 @@
*/
int16_t SCPI_ErrorPop(scpi_t * context) {
int16_t result = 0;
-
- //// FreeRTOS
- //if (pdFALSE == xQueueReceive((xQueueHandle)context->error_queue, &result, 0)) {
- // result = 0;
- //}
-
- // basic FIFO
- fifo_remove((fifo_t *)context->error_queue, &result);
+
+ /*
+ * // FreeRTOS
+ * if (pdFALSE == xQueueReceive((xQueueHandle)context->error_queue, &result, 0)) {
+ * result = 0;
+ * }
+ */
+
+ /* basic FIFO */
+ fifo_remove((scpi_fifo_t *)context->error_queue, &result);
return result;
}
@@ -93,23 +102,26 @@
*/
int32_t SCPI_ErrorCount(scpi_t * context) {
int16_t result = 0;
-
- //// FreeRTOS
- //result = uxQueueMessagesWaiting((xQueueHandle)context->error_queue);
-
- //basic FIFO
- fifo_count((fifo_t *)context->error_queue, &result);
-
-
+
+ /*
+ * // FreeRTOS
+ * result = uxQueueMessagesWaiting((xQueueHandle)context->error_queue);
+ */
+
+ /* basic FIFO */
+ fifo_count((scpi_fifo_t *)context->error_queue, &result);
+
return result;
}
static void SCPI_ErrorAddInternal(scpi_t * context, int16_t err) {
- //// FreeRTOS
- //xQueueSend((xQueueHandle)context->error_queue, &err, 0);
-
- // basic FIFO
- fifo_add((fifo_t *)context->error_queue, err);
+ /*
+ * // FreeRTOS
+ * xQueueSend((xQueueHandle)context->error_queue, &err, 0);
+ */
+
+ /* basic FIFO */
+ fifo_add((scpi_fifo_t *)context->error_queue, err);
}
struct error_reg {
@@ -121,14 +133,14 @@
#define ERROR_DEFS_N 8
static const struct error_reg errs[ERROR_DEFS_N] = {
- {.from = -100, .to = -199, .bit=ESR_CER}, // Command error (e.g. syntax error) ch 21.8.9
- {.from = -200, .to = -299, .bit=ESR_EER}, // Execution Error (e.g. range error) ch 21.8.10
- {.from = -300, .to = -399, .bit=ESR_DER}, // Device specific error -300, -399 ch 21.8.11
- {.from = -400, .to = -499, .bit=ESR_QER}, // Query error -400, -499 ch 21.8.12
- {.from = -500, .to = -599, .bit=ESR_PON}, // Power on event -500, -599 ch 21.8.13
- {.from = -600, .to = -699, .bit=ESR_URQ}, // User Request Event -600, -699 ch 21.8.14
- {.from = -700, .to = -799, .bit=ESR_REQ}, // Request Control Event -700, -799 ch 21.8.15
- {.from = -800, .to = -899, .bit=ESR_OPC}, // Operation Complete Event -800, -899 ch 21.8.16
+ {-100, -199, ESR_CER}, /* Command error (e.g. syntax error) ch 21.8.9 */
+ {-200, -299, ESR_EER}, /* Execution Error (e.g. range error) ch 21.8.10 */
+ {-300, -399, ESR_DER}, /* Device specific error -300, -399 ch 21.8.11 */
+ {-400, -499, ESR_QER}, /* Query error -400, -499 ch 21.8.12 */
+ {-500, -599, ESR_PON}, /* Power on event -500, -599 ch 21.8.13 */
+ {-600, -699, ESR_URQ}, /* User Request Event -600, -699 ch 21.8.14 */
+ {-700, -799, ESR_REQ}, /* Request Control Event -700, -799 ch 21.8.15 */
+ {-800, -899, ESR_OPC}, /* Operation Complete Event -800, -899 ch 21.8.16 */
};
/**
@@ -165,13 +177,9 @@
const char * SCPI_ErrorTranslate(int16_t err) {
switch (err) {
case 0: return "No error";
- case SCPI_ERROR_SYNTAX: return "Syntax error";
- case SCPI_ERROR_INVALID_SEPARATOR: return "Invalid separator";
- case SCPI_ERROR_UNDEFINED_HEADER: return "Undefined header";
- case SCPI_ERROR_PARAMETER_NOT_ALLOWED: return "Parameter not allowed";
- case SCPI_ERROR_MISSING_PARAMETER: return "Missing parameter";
- case SCPI_ERROR_INVALID_SUFFIX: return "Invalid suffix";
- case SCPI_ERROR_SUFFIX_NOT_ALLOWED: return "Suffix not allowed";
+ #define X(def, val, str) case def: return str;
+ LIST_OF_ERRORS
+ #undef X
default: return "Unknown error";
}
}
--
Gitblit v1.9.1