From 11f2f2e329ef404d0e9c022cb2f9fbbb45bae285 Mon Sep 17 00:00:00 2001
From: nancy.liao <huihui.liao@greentest.com.cn>
Date: 周日, 27 4月 2025 17:33:31 +0800
Subject: [PATCH] 完成了SCPI命令语法分析器的完整规则

---
 libscpi/src/error.c |  303 +++++++++++++++++++++++++++++---------------------
 1 files changed, 175 insertions(+), 128 deletions(-)

diff --git a/libscpi/src/error.c b/libscpi/src/error.c
index 493b623..00f4869 100644
--- a/libscpi/src/error.c
+++ b/libscpi/src/error.c
@@ -1,58 +1,86 @@
 /*-
- * Copyright (c) 2012-2013 Jan Breuer,
+ * BSD 2-Clause License
  *
- * All Rights Reserved
- * 
+ * Copyright (c) 2012-2018, Jan Breuer
+ * All rights reserved.
+ *
  * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are
- * met:
- * 1. Redistributions of source code must retain the above copyright notice,
- *    this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in the
- *    documentation and/or other materials provided with the distribution.
- * 
- * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
- * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
- * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
- * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
- * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
- * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-
 /**
  * @file   scpi_error.c
  * @date   Thu Nov 15 10:58:45 UTC 2012
- * 
+ *
  * @brief  Error handling and storing routines
- * 
- * 
+ *
+ *
  */
 
 #include <stdint.h>
 
-#include "scpi/parser.h"
-#include "scpi/ieee488.h"
-#include "scpi/error.h"
-#include "scpi/fifo.h"
+#include <scpi/parser.h>
+#include <scpi/ieee488.h>
+#include <scpi/error.h>
+#include "fifo_private.h"
+#include <scpi/constants.h>
 
-// basic FIFO
-static fifo_t local_error_queue;
+#if USE_DEVICE_DEPENDENT_ERROR_INFORMATION
+#define SCPI_ERROR_SETVAL(e, c, i) do { (e)->error_code = (c); (e)->device_dependent_info = (i); } while(0)
+#else
+#define SCPI_ERROR_SETVAL(e, c, i) do { (e)->error_code = (c); (void)(i);} while(0)
+#endif
 
+/**
+ * Initialize error queue
+ * @param context - scpi context
+ */
+void SCPI_ErrorInit(scpi_t * context, scpi_error_t * data, int16_t size) {
+    fifo_init(&context->error_queue, data, size);
+}
 
+/**
+ * Emit no error
+ * @param context scpi context
+ */
+static void SCPI_ErrorEmitEmpty(scpi_t * context) {
+    if ((SCPI_ErrorCount(context) == 0) && (SCPI_RegGet(context, SCPI_REG_STB) & STB_QMA)) {
+        SCPI_RegClearBits(context, SCPI_REG_STB, STB_QMA);
 
-void SCPI_ErrorInit(scpi_t * context) {
-    //// 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);
+        if (context->interface && context->interface->error) {
+            context->interface->error(context, 0);
+        }
+    }
+}
+
+/**
+ * Emit error
+ * @param context scpi context
+ * @param err Error to emit
+ */
+static void SCPI_ErrorEmit(scpi_t * context, int16_t err) {
+    SCPI_RegSetBits(context, SCPI_REG_STB, STB_QMA);
+
+    if (context->interface && context->interface->error) {
+        context->interface->error(context, err);
+    }
 }
 
 /**
@@ -60,112 +88,126 @@
  * @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);
+#if USE_DEVICE_DEPENDENT_ERROR_INFORMATION
+    scpi_error_t error;
+    while (fifo_remove(&context->error_queue, &error)) {
+        SCPIDEFINE_free(&context->error_info_heap, error.device_dependent_info, false);
+    }
+#endif
+    fifo_clear(&context->error_queue);
+
+    SCPI_ErrorEmitEmpty(context);
 }
 
 /**
  * Pop error from queue
  * @param context - scpi context
- * @return error number
+ * @param error
+ * @return
  */
-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);
+scpi_bool_t SCPI_ErrorPop(scpi_t * context, scpi_error_t * error) {
+    if (!error || !context) return FALSE;
+    SCPI_ERROR_SETVAL(error, 0, NULL);
+    fifo_remove(&context->error_queue, error);
 
-    return result;
+    SCPI_ErrorEmitEmpty(context);
+
+    return TRUE;
 }
 
 /**
  * Return number of errors/events in the queue
  * @param context
- * @return 
+ * @return
  */
 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);
-    
-    
+
+    fifo_count(&context->error_queue, &result);
+
     return result;
 }
 
-static void SCPI_ErrorPushInternal(scpi_t * context, int16_t err) {
-    //// FreeRTOS
-    //xQueueSend((xQueueHandle)context->error_queue, &err, 0);
-    
-    // basic FIFO
-    fifo_add((fifo_t *)context->error_queue, err);
+static scpi_bool_t SCPI_ErrorAddInternal(scpi_t * context, int16_t err, char * info, size_t info_len) {
+    scpi_error_t error_value;
+    /* SCPIDEFINE_strndup is sometimes a dumy that does not reference it's arguments. 
+       Since info_len is not referenced elsewhere caoing to void prevents unusd argument warnings */
+    (void) info_len;
+    char * info_ptr = NULL;
+    if (info) {
+        info_ptr = SCPIDEFINE_strndup(&context->error_info_heap, info, info_len);
+    }
+    SCPI_ERROR_SETVAL(&error_value, err, info_ptr);
+    if (!fifo_add(&context->error_queue, &error_value)) {
+        SCPIDEFINE_free(&context->error_info_heap, error_value.device_dependent_info, true);
+        fifo_remove_last(&context->error_queue, &error_value);
+        SCPIDEFINE_free(&context->error_info_heap, error_value.device_dependent_info, true);
+        SCPI_ERROR_SETVAL(&error_value, SCPI_ERROR_QUEUE_OVERFLOW, NULL);
+        fifo_add(&context->error_queue, &error_value);
+        return FALSE;
+    }
+    return TRUE;
 }
+
+struct error_reg {
+    int16_t from;
+    int16_t to;
+    scpi_reg_val_t esrBit;
+};
+
+#define ERROR_DEFS_N 9
+
+static const struct error_reg errs[ERROR_DEFS_N] = {
+    {-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    */
+    { 1, 32767, ESR_DER}, /* Device designer provided specific error 1, 32767 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 */
+};
+
+/**
+ * Push error to queue
+ * @param context
+ * @param err - error number
+ * @param info - additional text information or NULL for no text
+ * @param info_len - length of text or 0 for automatic length
+ */
+void SCPI_ErrorPushEx(scpi_t * context, int16_t err, char * info, size_t info_len) {
+    int i;
+    /* automatic calculation of length */
+    if (info && info_len == 0) {
+        info_len = SCPIDEFINE_strnlen(info, SCPI_STD_ERROR_DESC_MAX_STRING_LENGTH);
+    }
+    scpi_bool_t queue_overflow = !SCPI_ErrorAddInternal(context, err, info, info_len);
+
+    for (i = 0; i < ERROR_DEFS_N; i++) {
+        if ((err <= errs[i].from) && (err >= errs[i].to)) {
+            SCPI_RegSetBits(context, SCPI_REG_ESR, errs[i].esrBit);
+        }
+    }
+
+    SCPI_ErrorEmit(context, err);
+    if (queue_overflow) {
+        SCPI_ErrorEmit(context, SCPI_ERROR_QUEUE_OVERFLOW);
+    }
+
+    if (context) {
+        context->cmd_error = TRUE;
+    }
+}
+
 /**
  * Push error to queue
  * @param context - scpi context
  * @param err - error number
  */
 void SCPI_ErrorPush(scpi_t * context, int16_t err) {
-    SCPI_ErrorPushInternal(context, err);
-    
-    // Command error (e.g. syntax error) ch 21.8.9
-    if ((err < -100) && (err > -199)) {
-        SCPI_RegSetBits(context, SCPI_REG_ESR, ESR_CER);
-    }
-
-    // Execution Error (e.g. range error) ch 21.8.10
-    if ((err < -200) && (err > -299)) {
-        SCPI_RegSetBits(context, SCPI_REG_ESR, ESR_EER);
-    }
-
-    // Device specific error -300, -399 ch 21.8.11
-    if ((err < -300) && (err > -399)) {
-        SCPI_RegSetBits(context, SCPI_REG_ESR, ESR_DER);
-    }
-
-    // Query error -400, -499 ch 21.8.12
-    if ((err < -400) && (err > -499)) {
-        SCPI_RegSetBits(context, SCPI_REG_ESR, ESR_QER);
-    }
-
-    // Power on event -500, -599 ch 21.8.13
-    if ((err < -500) && (err > -599)) {
-        SCPI_RegSetBits(context, SCPI_REG_ESR, ESR_PON);
-    }
-
-    // User Request Event -600, -699 ch 21.8.14
-    if ((err < -600) && (err > -699)) {
-        SCPI_RegSetBits(context, SCPI_REG_ESR, ESR_URQ);
-    }
-
-    // Request Control Event -700, -799 ch 21.8.15
-    if ((err < -700) && (err > -799)) {
-        SCPI_RegSetBits(context, SCPI_REG_ESR, ESR_REQ);
-    }
-
-    // Operation Complete Event -800, -899 ch 21.8.16
-    if ((err < -800) && (err > -899)) {
-        SCPI_RegSetBits(context, SCPI_REG_ESR, ESR_OPC);
-    }
-
-    if (context) {
-        if (context->interface && context->interface->error) {
-            context->interface->error(context, err);
-        }
-
-        context->cmd_error = TRUE;
-    }
+    SCPI_ErrorPushEx(context, err, NULL, 0);
+    return;
 }
 
 /**
@@ -175,14 +217,19 @@
  */
 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;
+#if USE_FULL_ERROR_LIST
+#define XE X
+#else
+#define XE(def, val, str)
+#endif
+        LIST_OF_ERRORS
+
+#if USE_USER_ERROR_LIST
+        LIST_OF_USER_ERRORS
+#endif
+#undef X
+#undef XE
         default: return "Unknown error";
     }
 }

--
Gitblit v1.9.1