Jan Breuer
2015-10-12 6110e0eeedb48c81fad0e5175aa3639f1a703bfa
libscpi/src/error.c
@@ -2,7 +2,7 @@
 * Copyright (c) 2012-2013 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:
@@ -11,7 +11,7 @@
 * 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
@@ -28,10 +28,10 @@
/**
 * @file   scpi_error.c
 * @date   Thu Nov 15 10:58:45 UTC 2012
 *
 *
 * @brief  Error handling and storing routines
 *
 *
 *
 *
 */
#include <stdint.h>
@@ -44,7 +44,6 @@
/* basic FIFO */
static scpi_fifo_t local_error_queue;
/**
 * Initialize error queue
 * @param context - scpi context
@@ -56,8 +55,35 @@
     */
    /* basic FIFO */
    context->error_queue = (scpi_error_queue_t)&local_error_queue;
    fifo_init((scpi_fifo_t *)context->error_queue);
    context->error_queue = (scpi_error_queue_t) & local_error_queue;
    fifo_init((scpi_fifo_t *) context->error_queue);
}
/**
 * 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);
        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);
    }
}
/**
@@ -71,7 +97,9 @@
     */
    /* basic FIFO */
    fifo_clear((scpi_fifo_t *)context->error_queue);
    fifo_clear((scpi_fifo_t *) context->error_queue);
    SCPI_ErrorEmitEmpty(context);
}
/**
@@ -90,7 +118,9 @@
     */
    /* basic FIFO */
    fifo_remove((scpi_fifo_t *)context->error_queue, &result);
    fifo_remove((scpi_fifo_t *) context->error_queue, &result);
    SCPI_ErrorEmitEmpty(context);
    return result;
}
@@ -98,7 +128,7 @@
/**
 * Return number of errors/events in the queue
 * @param context
 * @return
 * @return
 */
int32_t SCPI_ErrorCount(scpi_t * context) {
    int16_t result = 0;
@@ -109,7 +139,7 @@
     */
    /* basic FIFO */
    fifo_count((scpi_fifo_t *)context->error_queue, &result);
    fifo_count((scpi_fifo_t *) context->error_queue, &result);
    return result;
}
@@ -121,7 +151,7 @@
     */
    /* basic FIFO */
    fifo_add((scpi_fifo_t *)context->error_queue, err);
    fifo_add((scpi_fifo_t *) context->error_queue, err);
}
struct error_reg {
@@ -130,12 +160,13 @@
    scpi_reg_val_t bit;
};
#define ERROR_DEFS_N   8
#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       */
@@ -154,17 +185,15 @@
    SCPI_ErrorAddInternal(context, err);
    for(i = 0; i < ERROR_DEFS_N; i++) {
    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].bit);
        }
    }
    if (context) {
        if (context->interface && context->interface->error) {
            context->interface->error(context, err);
        }
    SCPI_ErrorEmit(context, err);
    if (context) {
        context->cmd_error = TRUE;
    }
}
@@ -177,10 +206,20 @@
const char * SCPI_ErrorTranslate(int16_t err) {
    switch (err) {
        case 0: return "No error";
        #define X(def, val, str) case def: return str;
        LIST_OF_ERRORS
        #undef X
        default: return "Unknown error";
#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";
    }
}