From 7953c3321afd16dae87ac42574606c8d963e3c8c Mon Sep 17 00:00:00 2001
From: Jan Breuer <jan.breuer@jaybee.cz>
Date: 周一, 16 1月 2023 18:04:23 +0800
Subject: [PATCH] Merge pull request #114 from PolyPik/refactor_registers
---
libscpi/inc/scpi/types.h | 61 +++++++++
libscpi/src/ieee488.c | 252 +++++++++++++++++++++++++-----------------
libscpi/inc/scpi/config.h | 4
libscpi/test/test_parser.c | 2
4 files changed, 214 insertions(+), 105 deletions(-)
diff --git a/libscpi/inc/scpi/config.h b/libscpi/inc/scpi/config.h
index c391e12..2d3652e 100644
--- a/libscpi/inc/scpi/config.h
+++ b/libscpi/inc/scpi/config.h
@@ -57,6 +57,10 @@
#define SCPI_LINE_ENDING LINE_ENDING_CRLF
#endif
+#ifndef USE_CUSTOM_REGISTERS
+#define USE_CUSTOM_REGISTERS 0
+#endif
+
/**
* Detect, if it has limited resources or it is running on a full blown operating system.
* All values can be overiden by scpi_user_config.h
diff --git a/libscpi/inc/scpi/types.h b/libscpi/inc/scpi/types.h
index c6bd51a..eb9b215 100644
--- a/libscpi/inc/scpi/types.h
+++ b/libscpi/inc/scpi/types.h
@@ -78,8 +78,18 @@
SCPI_REG_QUESE, /* QUEStionable status Enable Register */
SCPI_REG_QUESC, /* QUEStionable status Condition Register */
- /* last definition - number of registers */
- SCPI_REG_COUNT
+#if USE_CUSTOM_REGISTERS
+#ifndef USER_REGISTERS
+#error "No user registers defined"
+#else
+ USER_REGISTERS
+#endif
+#endif
+
+ /* number of registers */
+ SCPI_REG_COUNT,
+ /* last definition - a value for no register */
+ SCPI_REG_NONE
};
typedef enum _scpi_reg_name_t scpi_reg_name_t;
@@ -105,6 +115,53 @@
typedef uint16_t scpi_reg_val_t;
+ enum _scpi_reg_class_t {
+ SCPI_REG_CLASS_STB = 0,
+ SCPI_REG_CLASS_SRE,
+ SCPI_REG_CLASS_EVEN,
+ SCPI_REG_CLASS_ENAB,
+ SCPI_REG_CLASS_COND,
+ SCPI_REG_CLASS_NTR,
+ SCPI_REG_CLASS_PTR,
+ };
+ typedef enum _scpi_reg_class_t scpi_reg_class_t;
+
+ enum _scpi_reg_group_t {
+ SCPI_REG_GROUP_STB = 0,
+ SCPI_REG_GROUP_ESR,
+ SCPI_REG_GROUP_OPER,
+ SCPI_REG_GROUP_QUES,
+
+#if USE_CUSTOM_REGISTERS
+#ifndef USER_REGISTER_GROUPS
+#error "No user register groups defined"
+#else
+ USER_REGISTER_GROUPS
+#endif
+#endif
+
+ /* last definition - number of register groups */
+ SCPI_REG_GROUP_COUNT
+ };
+ typedef enum _scpi_reg_group_t scpi_reg_group_t;
+
+ struct _scpi_reg_info_t {
+ scpi_reg_class_t type;
+ scpi_reg_group_t group;
+ };
+ typedef struct _scpi_reg_info_t scpi_reg_info_t;
+
+ struct _scpi_reg_group_info_t {
+ scpi_reg_name_t event;
+ scpi_reg_name_t enable;
+ scpi_reg_name_t condition;
+ scpi_reg_name_t ptfilt;
+ scpi_reg_name_t ntfilt;
+ scpi_reg_name_t parent_reg;
+ scpi_reg_val_t parent_bit;
+ };
+ typedef struct _scpi_reg_group_info_t scpi_reg_group_info_t;
+
/* scpi commands */
enum _scpi_result_t {
SCPI_RES_OK = 1,
diff --git a/libscpi/src/ieee488.c b/libscpi/src/ieee488.c
index 2102ee2..000df89 100644
--- a/libscpi/src/ieee488.c
+++ b/libscpi/src/ieee488.c
@@ -42,40 +42,75 @@
#include <stdio.h>
-/**
- * Update register value
- * @param context
- * @param name - register name
- */
-static void regUpdate(scpi_t * context, scpi_reg_name_t name) {
- SCPI_RegSet(context, name, SCPI_RegGet(context, name));
-}
+static const scpi_reg_info_t scpi_reg_details[SCPI_REG_COUNT] = {
+ { SCPI_REG_CLASS_STB, SCPI_REG_GROUP_STB },
+ { SCPI_REG_CLASS_SRE, SCPI_REG_GROUP_STB },
+ { SCPI_REG_CLASS_EVEN, SCPI_REG_GROUP_ESR },
+ { SCPI_REG_CLASS_ENAB, SCPI_REG_GROUP_ESR },
+ { SCPI_REG_CLASS_EVEN, SCPI_REG_GROUP_OPER },
+ { SCPI_REG_CLASS_ENAB, SCPI_REG_GROUP_OPER },
+ { SCPI_REG_CLASS_COND, SCPI_REG_GROUP_OPER },
+ { SCPI_REG_CLASS_EVEN, SCPI_REG_GROUP_QUES },
+ { SCPI_REG_CLASS_ENAB, SCPI_REG_GROUP_QUES },
+ { SCPI_REG_CLASS_COND, SCPI_REG_GROUP_QUES },
-/**
- * Update latching event register value based on bit transitions from 0 -> 1
- * in the condition register
- * @param context
- * @param condReg - condition register name
- * @param eventReg - event register name
- */
-static void regUpdateEvent(scpi_t * context, scpi_reg_val_t oldCondVal, scpi_reg_val_t newCondVal, scpi_reg_name_t eventReg) {
- SCPI_RegSet(context, eventReg, ((oldCondVal ^ newCondVal) & newCondVal) | SCPI_RegGet(context, eventReg));
-}
+#if USE_CUSTOM_REGISTERS
+#ifndef USER_REGISTER_DETAILS
+#error "No user register details defined"
+#else
+ USER_REGISTER_DETAILS
+#endif
+#endif
-/**
- * Update STB register according to value and its mask register
- * @param context
- * @param val value of register
- * @param mask name of mask register (enable register)
- * @param stbBits bits to clear or set in STB
- */
-static void regUpdateSTB(scpi_t * context, scpi_reg_val_t val, scpi_reg_name_t mask, scpi_reg_val_t stbBits) {
- if (val & SCPI_RegGet(context, mask)) {
- SCPI_RegSetBits(context, SCPI_REG_STB, stbBits);
- } else {
- SCPI_RegClearBits(context, SCPI_REG_STB, stbBits);
- }
-}
+};
+
+static const scpi_reg_group_info_t scpi_reg_group_details[SCPI_REG_GROUP_COUNT] = {
+ {
+ SCPI_REG_STB,
+ SCPI_REG_SRE,
+ SCPI_REG_NONE,
+ SCPI_REG_NONE,
+ SCPI_REG_NONE,
+ SCPI_REG_NONE,
+ 0
+ }, //SCPI_REG_GROUP_STB
+ {
+ SCPI_REG_ESR,
+ SCPI_REG_ESE,
+ SCPI_REG_NONE,
+ SCPI_REG_NONE,
+ SCPI_REG_NONE,
+ SCPI_REG_STB,
+ STB_ESR
+ }, //SCPI_REG_GROUP_ESR
+ {
+ SCPI_REG_OPER,
+ SCPI_REG_OPERE,
+ SCPI_REG_OPERC,
+ SCPI_REG_NONE,
+ SCPI_REG_NONE,
+ SCPI_REG_STB,
+ STB_OPS
+ }, //SCPI_REG_GROUP_OPER
+ {
+ SCPI_REG_QUES,
+ SCPI_REG_QUESE,
+ SCPI_REG_QUESC,
+ SCPI_REG_NONE,
+ SCPI_REG_NONE,
+ SCPI_REG_STB,
+ STB_QES
+ }, //SCPI_REG_GROUP_QUES
+
+#if USE_CUSTOM_REGISTERS
+#ifndef USER_REGISTER_GROUP_DETAILS
+#error "No user register group details defined"
+#else
+ USER_REGISTER_GROUP_DETAILS
+#endif
+#endif
+
+};
/**
* Get register value
@@ -110,75 +145,94 @@
* @param val - new value
*/
void SCPI_RegSet(scpi_t * context, scpi_reg_name_t name, scpi_reg_val_t val) {
- scpi_bool_t srq = FALSE;
- scpi_reg_val_t mask;
- scpi_reg_val_t old_val;
-
if ((name >= SCPI_REG_COUNT) || (context == NULL)) {
return;
}
- /* store old register value */
- old_val = context->registers[name];
+ scpi_reg_group_info_t register_group;
- /* set register value */
- context->registers[name] = val;
+ do {
+ scpi_reg_class_t register_type = scpi_reg_details[name].type;
+ register_group = scpi_reg_group_details[scpi_reg_details[name].group];
- /** @TODO: remove recutsion */
- switch (name) {
- case SCPI_REG_STB:
- mask = SCPI_RegGet(context, SCPI_REG_SRE);
- mask &= ~STB_SRQ;
- if (val & mask) {
- val |= STB_SRQ;
- /* avoid sending SRQ if nothing has changed */
- if (old_val != val) {
- srq = TRUE;
+ scpi_reg_val_t ptrans;
+
+ /* store old register value */
+ scpi_reg_val_t old_val = context->registers[name];
+
+ if (old_val == val) {
+ return;
+ } else {
+ context->registers[name] = val;
+ }
+
+ switch (register_type) {
+ case SCPI_REG_CLASS_STB:
+ case SCPI_REG_CLASS_SRE:
+ ;
+ scpi_reg_val_t stb = context->registers[SCPI_REG_STB] & ~STB_SRQ;
+ scpi_reg_val_t sre = context->registers[SCPI_REG_SRE] & ~STB_SRQ;
+
+ if (stb & sre) {
+ ptrans = ((old_val ^ val) & val);
+ context->registers[SCPI_REG_STB] |= STB_SRQ;
+ if (ptrans & val) {
+ writeControl(context, SCPI_CTRL_SRQ, context->registers[SCPI_REG_STB]);
+ }
+ } else {
+ context->registers[SCPI_REG_STB] &= ~STB_SRQ;
}
- } else {
- val &= ~STB_SRQ;
- }
- break;
- case SCPI_REG_SRE:
- regUpdate(context, SCPI_REG_STB);
- break;
- case SCPI_REG_ESR:
- regUpdateSTB(context, val, SCPI_REG_ESE, STB_ESR);
- break;
- case SCPI_REG_ESE:
- regUpdate(context, SCPI_REG_ESR);
- break;
- case SCPI_REG_QUES:
- regUpdateSTB(context, val, SCPI_REG_QUESE, STB_QES);
- break;
- case SCPI_REG_QUESE:
- regUpdate(context, SCPI_REG_QUES);
- break;
- case SCPI_REG_QUESC:
- regUpdateEvent(context, old_val, val, SCPI_REG_QUES);
- break;
- case SCPI_REG_OPER:
- regUpdateSTB(context, val, SCPI_REG_OPERE, STB_OPS);
- break;
- case SCPI_REG_OPERE:
- regUpdate(context, SCPI_REG_OPER);
- break;
- case SCPI_REG_OPERC:
- regUpdateEvent(context, old_val, val, SCPI_REG_OPER);
- break;
+ break;
+ case SCPI_REG_CLASS_EVEN:
+ ;
+ scpi_reg_val_t enable;
+ if(register_group.enable != SCPI_REG_NONE) {
+ enable = SCPI_RegGet(context, register_group.enable);
+ } else {
+ enable = 0xFFFF;
+ }
+ scpi_bool_t summary = val & enable;
- case SCPI_REG_COUNT:
- /* nothing to do */
- break;
- }
+ name = register_group.parent_reg;
+ val = SCPI_RegGet(context, register_group.parent_reg);
+ if (summary) {
+ val |= register_group.parent_bit;
+ } else {
+ val &= ~(register_group.parent_bit);
+ }
+ break;
+ case SCPI_REG_CLASS_COND:
+ name = register_group.event;
- /* set updated register value */
- context->registers[name] = val;
+ if(register_group.ptfilt == SCPI_REG_NONE && register_group.ntfilt == SCPI_REG_NONE) {
+ val = ((old_val ^ val) & val) | SCPI_RegGet(context, register_group.event);
+ } else {
+ scpi_reg_val_t ptfilt = 0, ntfilt = 0;
+ scpi_reg_val_t transitions;
+ scpi_reg_val_t ntrans;
- if (srq) {
- writeControl(context, SCPI_CTRL_SRQ, SCPI_RegGet(context, SCPI_REG_STB));
- }
+ if(register_group.ptfilt != SCPI_REG_NONE) {
+ ptfilt = SCPI_RegGet(context, register_group.ptfilt);
+ }
+
+ if(register_group.ntfilt != SCPI_REG_NONE) {
+ ntfilt = SCPI_RegGet(context, register_group.ntfilt);
+ }
+
+ transitions = old_val ^ val;
+ ptrans = transitions & val;
+ ntrans = transitions & ~ptrans;
+
+ val = ((ptrans & ptfilt) | (ntrans & ntfilt)) | SCPI_RegGet(context, register_group.event);
+ }
+ break;
+ case SCPI_REG_CLASS_ENAB:
+ case SCPI_REG_CLASS_NTR:
+ case SCPI_REG_CLASS_PTR:
+ return;
+ }
+ } while(register_group.parent_reg != SCPI_REG_NONE);
}
/**
@@ -200,25 +254,19 @@
}
/**
- * Clear event register
- * @param context
- */
-void SCPI_EventClear(scpi_t * context) {
- /* TODO */
- SCPI_RegSet(context, SCPI_REG_ESR, 0);
-}
-
-/**
* *CLS - This command clears all status data structures in a device.
* For a device which minimally complies with SCPI. (SCPI std 4.1.3.2)
* @param context
* @return
*/
scpi_result_t SCPI_CoreCls(scpi_t * context) {
- SCPI_EventClear(context);
SCPI_ErrorClear(context);
- SCPI_RegSet(context, SCPI_REG_OPER, 0);
- SCPI_RegSet(context, SCPI_REG_QUES, 0);
+ for (int i = 0; i < SCPI_REG_GROUP_COUNT; ++i) {
+ scpi_reg_name_t event_reg = scpi_reg_group_details[i].event;
+ if (event_reg != SCPI_REG_STB) {
+ SCPI_RegSet(context, event_reg, 0);
+ }
+ }
return SCPI_RES_OK;
}
diff --git a/libscpi/test/test_parser.c b/libscpi/test/test_parser.c
index 204a334..1b214c3 100644
--- a/libscpi/test/test_parser.c
+++ b/libscpi/test/test_parser.c
@@ -150,7 +150,7 @@
err_buffer_pos = 0;
SCPI_RegClearBits(&scpi_context, SCPI_REG_STB, STB_QMA);
- SCPI_EventClear(&scpi_context);
+ SCPI_RegSet(&scpi_context, SCPI_REG_ESR, 0);
SCPI_ErrorClear(&scpi_context);
}
--
Gitblit v1.9.1