https://github.com/j123b567/scpi-parser
Dependents: scpi_sx127x scpi_sx127x_firstTest MLX90418_I2C_master
error.h
00001 /*- 00002 * Copyright (c) 2012-2013 Jan Breuer, 00003 * 00004 * All Rights Reserved 00005 * 00006 * Redistribution and use in source and binary forms, with or without 00007 * modification, are permitted provided that the following conditions are 00008 * met: 00009 * 1. Redistributions of source code must retain the above copyright notice, 00010 * this list of conditions and the following disclaimer. 00011 * 2. Redistributions in binary form must reproduce the above copyright 00012 * notice, this list of conditions and the following disclaimer in the 00013 * documentation and/or other materials provided with the distribution. 00014 * 00015 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR 00016 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 00017 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 00018 * DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE 00019 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 00020 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 00021 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 00022 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 00023 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 00024 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN 00025 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00026 */ 00027 00028 /** 00029 * @file scpi_error.h 00030 * @date Thu Nov 15 10:58:45 UTC 2012 00031 * 00032 * @brief Error handling and storing routines 00033 * 00034 * 00035 */ 00036 00037 #ifndef SCPI_ERROR_H 00038 #define SCPI_ERROR_H 00039 00040 #include "scpi/config.h" 00041 #include "scpi/types.h" 00042 00043 #ifdef __cplusplus 00044 extern "C" { 00045 #endif 00046 00047 void SCPI_ErrorInit(scpi_t * context); 00048 void SCPI_ErrorClear(scpi_t * context); 00049 int16_t SCPI_ErrorPop(scpi_t * context); 00050 void SCPI_ErrorPush(scpi_t * context, int16_t err); 00051 int32_t SCPI_ErrorCount(scpi_t * context); 00052 const char * SCPI_ErrorTranslate(int16_t err); 00053 00054 00055 /* Using X-Macro technique to define everything once 00056 * http://en.wikipedia.org/wiki/X_Macro 00057 * 00058 * X macro is for minimal set of errors for library itself 00059 * XE macro is for full set of SCPI errors available to user application 00060 */ 00061 #define LIST_OF_ERRORS \ 00062 XE(SCPI_ERROR_COMMAND, -100, "Command error") \ 00063 X(SCPI_ERROR_INVALID_CHARACTER, -101, "Invalid character") \ 00064 XE(SCPI_ERROR_SYNTAX, -102, "Syntax error") \ 00065 X(SCPI_ERROR_INVALID_SEPARATOR, -103, "Invalid separator") \ 00066 X(SCPI_ERROR_DATA_TYPE_ERROR, -104, "Data type error") \ 00067 XE(SCPI_ERROR_GET_NOT_ALLOWED, -105, "GET not allowed") \ 00068 X(SCPI_ERROR_PARAMETER_NOT_ALLOWED, -108, "Parameter not allowed") \ 00069 X(SCPI_ERROR_MISSING_PARAMETER, -109, "Missing parameter") \ 00070 XE(SCPI_ERROR_COMMAND_HEADER, -110, "Command header error") \ 00071 XE(SCPI_ERROR_HEADER_SEPARATOR, -111, "Header separator error") \ 00072 XE(SCPI_ERROR_PRG_MNEMONIC_TOO_LONG, -112, "Program mnemonic too long") \ 00073 X(SCPI_ERROR_UNDEFINED_HEADER, -113, "Undefined header") \ 00074 XE(SCPI_ERROR_HEADER_SUFFIX_OUTOFRANGE, -114, "Header suffix out of range") \ 00075 XE(SCPI_ERROR_UNEXP_NUM_OF_PARAMETER, -115, "Unexpected number of parameters") \ 00076 XE(SCPI_ERROR_NUMERIC_DATA_ERROR, -120, "Numeric data error") \ 00077 XE(SCPI_ERROR_INVAL_CHAR_IN_NUMBER, -121, "Invalid character in number") \ 00078 XE(SCPI_ERROR_EXPONENT_TOO_LONG, -123, "Exponent too large") \ 00079 XE(SCPI_ERROR_TOO_MANY_DIGITS, -124, "Too many digits") \ 00080 XE(SCPI_ERROR_NUMERIC_DATA_NOT_ALLOWED, -128, "Numeric data not allowed") \ 00081 XE(SCPI_ERROR_SUFFIX_ERROR, -130, "Suffix error") \ 00082 X(SCPI_ERROR_INVALID_SUFFIX, -131, "Invalid suffix") \ 00083 XE(SCPI_ERROR_SUFFIX_TOO_LONG, -134, "Suffix too long") \ 00084 X(SCPI_ERROR_SUFFIX_NOT_ALLOWED, -138, "Suffix not allowed") \ 00085 XE(SCPI_ERROR_CHARACTER_DATA_ERROR, -140, "Character data error") \ 00086 XE(SCPI_ERROR_INVAL_CHARACTER_DATA, -141, "Invalid character data") \ 00087 XE(SCPI_ERROR_CHARACTER_DATA_TOO_LONG, -144, "Character data too long") \ 00088 XE(SCPI_ERROR_CHARACTER_DATA_NOT_ALLOWED, -148, "Character data not allowed") \ 00089 XE(SCPI_ERROR_STRING_DATA_ERROR, -150, "String data error") \ 00090 X(SCPI_ERROR_INVALID_STRING_DATA, -151, "Invalid string data") \ 00091 XE(SCPI_ERROR_STRING_DATA_NOT_ALLOWED, -158, "String data not allowed") \ 00092 XE(SCPI_ERROR_BLOCK_DATA_ERROR, -160, "Block data error") \ 00093 XE(SCPI_ERROR_INVALID_BLOCK_DATA, -161, "Invalid block data") \ 00094 XE(SCPI_ERROR_BLOCK_DATA_NOT_ALLOWED, -168, "Block data not allowed") \ 00095 XE(SCPI_ERROR_EXPRESSION_PARSING_ERROR, -170, "Expression error") \ 00096 XE(SCPI_ERROR_INVAL_EXPRESSION, -171, "Invalid expression") \ 00097 XE(SCPI_ERROR_EXPRESSION_DATA_NOT_ALLOWED, -178, "Expression data not allowed") \ 00098 XE(SCPI_ERROR_MACRO_DEFINITION_ERROR, -180, "Macro error") \ 00099 XE(SCPI_ERROR_INVAL_OUTSIDE_MACRO_DEF, -181, "Invalid outside macro definition") \ 00100 XE(SCPI_ERROR_INVAL_INSIDE_MACRO_DEF, -183, "Invalid inside macro definition") \ 00101 XE(SCPI_ERROR_MACRO_PARAMETER_ERROR, -184, "Macro parameter error") \ 00102 X(SCPI_ERROR_EXECUTION_ERROR, -200, "Execution error") \ 00103 XE(SCPI_ERROR_INVAL_WHILE_IN_LOCAL, -201, "Invalid while in local") \ 00104 XE(SCPI_ERROR_SETTINGS_LOST_DUE_TO_RTL, -202, "Settings lost due to rtl") \ 00105 XE(SCPI_ERROR_COMMAND_PROTECTED, -203, "Command protected TK024") \ 00106 XE(SCPI_ERROR_TRIGGER_ERROR, -210, "Trigger error") \ 00107 XE(SCPI_ERROR_TRIGGER_IGNORED, -211, "Trigger ignored") \ 00108 XE(SCPI_ERROR_ARM_IGNORED, -212, "Arm ignored") \ 00109 XE(SCPI_ERROR_INIT_IGNORED, -213, "Init ignored") \ 00110 XE(SCPI_ERROR_TRIGGER_DEADLOCK, -214, "Trigger deadlock") \ 00111 XE(SCPI_ERROR_ARM_DEADLOCK, -215, "Arm deadlock") \ 00112 XE(SCPI_ERROR_PARAMETER_ERROR, -220, "Parameter error") \ 00113 XE(SCPI_ERROR_SETTINGS_CONFLICT, -221, "Settings conflict") \ 00114 XE(SCPI_ERROR_DATA_OUT_OF_RANGE, -222, "Data out of range") \ 00115 XE(SCPI_ERROR_TOO_MUCH_DATA, -223, "Too much data") \ 00116 X(SCPI_ERROR_ILLEGAL_PARAMETER_VALUE, -224, "Illegal parameter value") \ 00117 XE(SCPI_ERROR_OUT_OF_MEMORY_FOR_REQ_OP, -225, "Out of memory") \ 00118 XE(SCPI_ERROR_LISTS_NOT_SAME_LENGTH, -226, "Lists not same length") \ 00119 XE(SCPI_ERROR_DATA_CORRUPT, -230, "Data corrupt or stale") \ 00120 XE(SCPI_ERROR_DATA_QUESTIONABLE, -231, "Data questionable") \ 00121 XE(SCPI_ERROR_INVAL_VERSION, -233, "Invalid version") \ 00122 XE(SCPI_ERROR_HARDWARE_ERROR, -240, "Hardware error") \ 00123 XE(SCPI_ERROR_HARDWARE_MISSING, -241, "Hardware missing") \ 00124 XE(SCPI_ERROR_MASS_STORAGE_ERROR, -250, "Mass storage error") \ 00125 XE(SCPI_ERROR_MISSING_MASS_STORAGE, -251, "Missing mass storage") \ 00126 XE(SCPI_ERROR_MISSING_MASS_MEDIA, -252, "Missing media") \ 00127 XE(SCPI_ERROR_CORRUPT_MEDIA, -253, "Corrupt media") \ 00128 XE(SCPI_ERROR_MEDIA_FULL, -254, "Media full") \ 00129 XE(SCPI_ERROR_DIRECTORY_FULL, -255, "Directory full") \ 00130 XE(SCPI_ERROR_FILE_NAME_NOT_FOUND, -256, "File name not found") \ 00131 XE(SCPI_ERROR_FILE_NAME_ERROR, -257, "File name error") \ 00132 XE(SCPI_ERROR_MEDIA_PROTECTED, -258, "Media protected") \ 00133 XE(SCPI_ERROR_EXPRESSION_EXECUTING_ERROR, -260, "Expression error") \ 00134 XE(SCPI_ERROR_MATH_ERROR_IN_EXPRESSION, -261, "Math error in expression") \ 00135 XE(SCPI_ERROR_MACRO_UNDEF_EXEC_ERROR, -270, "Macro error") \ 00136 XE(SCPI_ERROR_MACRO_SYNTAX_ERROR, -271, "Macro syntax error") \ 00137 XE(SCPI_ERROR_MACRO_EXECUTION_ERROR, -272, "Macro execution error") \ 00138 XE(SCPI_ERROR_ILLEGAL_MACRO_LABEL, -273, "Illegal macro label") \ 00139 XE(SCPI_ERROR_IMPROPER_USED_MACRO_PARAM, -274, "Macro parameter error") \ 00140 XE(SCPI_ERROR_MACRO_DEFINITION_TOO_LONG, -275, "Macro definition too long") \ 00141 XE(SCPI_ERROR_MACRO_RECURSION_ERROR, -276, "Macro recursion error") \ 00142 XE(SCPI_ERROR_MACRO_REDEF_NOT_ALLOWED, -277, "Macro redefinition not allowed") \ 00143 XE(SCPI_ERROR_MACRO_HEADER_NOT_FOUND, -278, "Macro header not found") \ 00144 XE(SCPI_ERROR_PROGRAM_ERROR, -280, "Program error") \ 00145 XE(SCPI_ERROR_CANNOT_CREATE_PROGRAM, -281, "Cannot create program") \ 00146 XE(SCPI_ERROR_ILLEGAL_PROGRAM_NAME, -282, "Illegal program name") \ 00147 XE(SCPI_ERROR_ILLEGAL_VARIABLE_NAME, -283, "Illegal variable name") \ 00148 XE(SCPI_ERROR_PROGRAM_CURRENTLY_RUNNING, -284, "Program currently running") \ 00149 XE(SCPI_ERROR_PROGRAM_SYNTAX_ERROR, -285, "Program syntax error") \ 00150 XE(SCPI_ERROR_PROGRAM_RUNTIME_ERROR, -286, "Program runtime error") \ 00151 XE(SCPI_ERROR_MEMORY_USE_ERROR, -290, "Memory use error") \ 00152 XE(SCPI_ERROR_OUT_OF_MEMORY, -291, "Out of memory") \ 00153 XE(SCPI_ERROR_REF_NAME_DOES_NOT_EXIST, -292, "Referenced name does not exist") \ 00154 XE(SCPI_ERROR_REF_NAME_ALREADY_EXISTS, -293, "Referenced name already exists") \ 00155 XE(SCPI_ERROR_INCOMPATIBLE_TYPE, -294, "Incompatible type") \ 00156 XE(SCPI_ERROR_DEVICE_ERROR, -300, "Device specific error") \ 00157 X(SCPI_ERROR_SYSTEM_ERROR, -310, "System error") \ 00158 XE(SCPI_ERROR_MEMORY_ERROR, -311, "Memory error") \ 00159 XE(SCPI_ERROR_PUD_MEMORY_LOST, -312, "PUD memory lost") \ 00160 XE(SCPI_ERROR_CALIBRATION_MEMORY_LOST, -313, "Calibration memory lost") \ 00161 XE(SCPI_ERROR_SAVE_RECALL_MEMORY_LOST, -314, "Save/recall memory lost") \ 00162 XE(SCPI_ERROR_CONFIGURATION_MEMORY_LOST, -315, "Configuration memory lost") \ 00163 XE(SCPI_ERROR_STORAGE_FAULT, -320, "Storage fault") \ 00164 XE(SCPI_ERROR_OUT_OF_DEVICE_MEMORY, -321, "Out of memory") \ 00165 XE(SCPI_ERROR_SELF_TEST_FAILED, -330, "Self-test failed") \ 00166 XE(SCPI_ERROR_CALIBRATION_FAILED, -340, "Calibration failed") \ 00167 XE(SCPI_ERROR_QUEUE_OVERFLOW, -350, "Queue overflow") \ 00168 XE(SCPI_ERROR_COMMUNICATION_ERROR, -360, "Communication error") \ 00169 XE(SCPI_ERROR_PARITY_ERROR_IN_CMD_MSG, -361, "Parity error in program message") \ 00170 XE(SCPI_ERROR_FRAMING_ERROR_IN_CMD_MSG, -362, "Framing error in program message") \ 00171 XE(SCPI_ERROR_INPUT_BUFFER_OVERRUN, -363, "Input buffer overrun") \ 00172 XE(SCPI_ERROR_TIME_OUT, -365, "Time out error") \ 00173 XE(SCPI_ERROR_QUERY_ERROR, -400, "Query error") \ 00174 XE(SCPI_ERROR_QUERY_INTERRUPTED, -410, "Query INTERRUPTED") \ 00175 XE(SCPI_ERROR_QUERY_UNTERMINATED, -420, "Query UNTERMINATED") \ 00176 XE(SCPI_ERROR_QUERY_DEADLOCKED, -430, "Query DEADLOCKED") \ 00177 XE(SCPI_ERROR_QUERY_UNTERM_INDEF_RESP, -440, "Query UNTERMINATED after indefinite response") \ 00178 XE(SCPI_ERROR_POWER_ON, -500, "Power on") \ 00179 XE(SCPI_ERROR_USER_REQUEST, -600, "User request") \ 00180 XE(SCPI_ERROR_REQUEST_CONTROL, -700, "Request control") \ 00181 XE(SCPI_ERROR_OPERATION_COMPLETE, -800, "Operation complete") \ 00182 00183 enum { 00184 #define X(def, val, str) def = val, 00185 #if USE_FULL_ERROR_LIST 00186 #define XE X 00187 #else 00188 #define XE(def, val, str) 00189 #endif 00190 LIST_OF_ERRORS 00191 00192 #if USE_USER_ERROR_LIST 00193 LIST_OF_USER_ERRORS 00194 #endif 00195 #undef X 00196 #undef XE 00197 }; 00198 00199 #ifdef __cplusplus 00200 } 00201 #endif 00202 00203 #endif /* SCPI_ERROR_H */
Generated on Tue Jul 12 2022 19:30:15 by 1.7.2