Factored out error handling in a dedicated function

This makes it possible to reuse the error handling of the base axis in
derived axis types (e.g. seleneGuide driver).

.gitlab-ci.yml

@@ -47,11 +47,11 @@ build_module:
     - sed -i 's/ARCH_FILTER=.*/ARCH_FILTER=linux%/' Makefile
     - echo "LIBVERSION=${CI_COMMIT_TAG:-0.0.1}" >> Makefile
     - make install
-    - cp -rT "/ioc/modules/pmacv3/$(ls -U /ioc/modules/pmacv3/ | head -1)" "./pmacv3-${CI_COMMIT_TAG:-$CI_COMMIT_SHORT_SHA}"
+    - cp -rT "/ioc/modules/turboPmac/$(ls -U /ioc/modules/turboPmac/ | head -1)" "./turboPmac-${CI_COMMIT_TAG:-$CI_COMMIT_SHORT_SHA}"
   artifacts:
-    name: "pmacv3-${CI_COMMIT_TAG:-$CI_COMMIT_SHORT_SHA}"
+    name: "turboPmac-${CI_COMMIT_TAG:-$CI_COMMIT_SHORT_SHA}"
     paths:
-      - "pmacv3-${CI_COMMIT_TAG:-$CI_COMMIT_SHORT_SHA}/*"
+      - "turboPmac-${CI_COMMIT_TAG:-$CI_COMMIT_SHORT_SHA}/*"
     expire_in: 1 week
   when: always
   tags:

Makefile

@@ -1,30 +1,33 @@
 # Use the PSI build system
 include /ioc/tools/driver.makefile
 
-MODULE=pmacv3
+MODULE=turboPmac
 BUILDCLASSES=Linux
 EPICS_VERSIONS=7.0.7
 ARCH_FILTER=RHEL%
 
 # Additional module dependencies
-REQUIRED+=asynMotor
+REQUIRED+=motorBase
 REQUIRED+=sinqMotor
 
+# Specify the version of motorBase we want to build against
+motorBase_VERSION=7.2.2
+
 # Specify the version of sinqMotor we want to build against
-sinqMotor_VERSION=0.6.3
+sinqMotor_VERSION=0.11.0
 
 # These headers allow to depend on this library for derived drivers.
-HEADERS += src/pmacv3Axis.h
+HEADERS += src/turboPmacAxis.h
-HEADERS += src/pmacv3Controller.h
+HEADERS += src/turboPmacController.h
 
 # Source files to build
-SOURCES += src/pmacv3Axis.cpp
+SOURCES += src/turboPmacAxis.cpp
-SOURCES += src/pmacv3Controller.cpp
+SOURCES += src/turboPmacController.cpp
 
 # Store the record files
-TEMPLATES += db/pmacv3.db
+TEMPLATES += db/turboPmac.db
 
 # This file registers the motor-specific functions in the IOC shell.
-DBDS += src/pmacv3.dbd
+DBDS += src/turboPmac.dbd
 
-USR_CFLAGS += -Wall -Wextra -Weffc++ -Wunused-result # -Werror
+USR_CFLAGS += -Wall -Wextra -Weffc++ -Wunused-result -Wextra -Werror # -Wpedantic // Does not work because EPICS macros trigger warnings

README.md

@@ -1,8 +1,10 @@
-# pmacv3
+# turboPmac
+
+## <span style="color:red">Please read the documentation of sinqMotor first: https://git.psi.ch/sinq-epics-modules/sinqmotor</span>
 
 ## Overview
 
-This is a driver for the pmacV3 motion controller with the SINQ communication protocol. It is based on the sinqMotor shared library (https://git.psi.ch/sinq-epics-modules/sinqmotor). The header files contain detailed documentation for all public functions. The headers themselves are exported when building the library to allow other drivers to depend on this one.
+This is a driver for the Turbo PMAC motion controller with the SINQ communication protocol. It is based on the sinqMotor shared library (https://git.psi.ch/sinq-epics-modules/sinqmotor). The header files contain detailed documentation for all public functions. The headers themselves are exported when building the library to allow other drivers to depend on this one.
 
 ## User guide
 
@@ -17,25 +19,45 @@ The folder "utils" contains utility scripts for working with pmac motor controll
 
 ### Usage in IOC shell
 
-pmacv3 exposes the following IOC shell functions (all in pmacv3Controller.cpp):
+turboPmac exports the following IOC shell functions:
-- `pmacv3Controller`: Create a new controller object.
+- `turboPmacController`: Create a new controller object.
-- `pmacv3Axis`: Create a new axis object.
+- `turboPmacAxis`: Create a new axis object.
-These functions are parametrized as follows:
+
+The full turboPmacX.cmd file looks like this:
+
 ```
-pmacv3Controller(
+# Define the name of the controller and the corresponding port
-    "$(NAME)", # Name of the MCU, e.g. mcu1. This parameter should be provided by an environment variable.
+epicsEnvSet("NAME","turboPmacX")
-    "$(ASYN_PORT)", # IP-Port of the MCU. This parameter should be provided by an environment variable.
+epicsEnvSet("ASYN_PORT","p$(NAME)")
-    8, # Maximum number of axes
+
-    0.05, # Busy poll period in seconds
+# Create the TCP/IP socket used to talk with the controller. The socket can be adressed from within the IOC shell via the port name
-    1, # Idle poll period in seconds
+drvAsynIPPortConfigure("$(ASYN_PORT)","172.28.101.24:1025")
-    0.05 # Communication timeout in seconds
+
-    );
+# Create the controller object with the defined name and connect it to the socket via the port name.
-```
+# The other parameters are as follows:
-```
+# 8: Maximum number of axes
-pmacv3Axis(
+# 0.05: Busy poll period in seconds
-    "$(NAME)", # Name of the associated MCU, e.g. mcu1. This parameter should be provided by an environment variable.
+# 1: Idle poll period in seconds
-    1 # Index of the axis.
+# 1: Socket communication timeout in seconds
-    );
+turboPmacController("$(NAME)", "$(ASYN_PORT)", 8, 0.05, 1, 1);
+
+# Define some axes for the specified MCU at the given slot (1, 2 and 5). No slot may be used twice!
+turboPmacAxis("$(NAME)",1);
+turboPmacAxis("$(NAME)",2);
+turboPmacAxis("$(NAME)",5);
+
+# Set the number of subsequent timeouts 
+setMaxSubsequentTimeouts("$(NAME)", 20);
+
+# Configure the timeout frequency watchdog: A maximum of 10 timeouts are allowed in 300 seconds before an alarm message is sent.
+setThresholdComTimeout("$(NAME)", 300, 10);
+
+# Parametrize the EPICS record database with the substitution file named after the MCU.
+epicsEnvSet("SINQDBPATH","$(sinqMotor_DB)/sinqMotor.db")
+dbLoadTemplate("$(TOP)/$(NAME).substitutions", "INSTR=$(INSTR)$(NAME):,CONTROLLER=$(NAME)")
+epicsEnvSet("SINQDBPATH","$(turboPmac_DB)/turboPmac.db")
+dbLoadTemplate("$(TOP)/$(NAME).substitutions", "INSTR=$(INSTR)$(NAME):,CONTROLLER=$(NAME)")
+dbLoadRecords("$(sinqMotor_DB)/asynRecord.db","P=$(INSTR)$(NAME),PORT=$(ASYN_PORT)")
 ```
 
 ### Versioning

db/turboPmac.db

@@ -7,7 +7,7 @@ record(longout, "$(INSTR)$(M):RereadEncoder") {
     field(PINI, "NO")
 }
 
-# The pmacV3 driver reads certain configuration parameters (such as the velocity
+# The turboPmac driver reads certain configuration parameters (such as the velocity
 # and the acceleration) directly from the MCU. This reading procedure is performed
 # once at IOC startup during atFirstPoll. However, it can be triggered manually
 # by setting this record value to 1.

src/pmacv3Controller.cpp

@@ -1,593 +0,0 @@
-#include "pmacv3Controller.h"
-#include "asynMotorController.h"
-#include "asynOctetSyncIO.h"
-#include "pmacv3Axis.h"
-#include <epicsExport.h>
-#include <errlog.h>
-#include <iocsh.h>
-#include <netinet/in.h>
-#include <registryFunction.h>
-#include <string.h>
-#include <unistd.h>
-
-/**
- * @brief Copy src into dst and replace all carriage returns with spaces. This
- * allows to print *dst with asynPrint.
- *
- *
- * @param dst                 Buffer for the modified string
- * @param src                 Original string
- */
-void adjustResponseForPrint(char *dst, const char *src, size_t buf_length) {
-    for (size_t i = 0; i < buf_length; i++) {
-        if (src[i] == '\r') {
-            dst[i] = ' ';
-        } else {
-            dst[i] = src[i];
-        }
-    }
-}
-
-/**
- * @brief Construct a new pmacv3Controller::pmacv3Controller object
- *
- * @param portName              See documentation of sinqController
- * @param ipPortConfigName      See documentation of sinqController
- * @param numAxes               See documentation of sinqController
- * @param movingPollPeriod      See documentation of sinqController
- * @param idlePollPeriod        See documentation of sinqController
- * @param comTimeout  Time after which a communication timeout error
- * is declared in writeRead (in seconds)
- * @param extraParams           See documentation of sinqController
- */
-pmacv3Controller::pmacv3Controller(const char *portName,
-                                   const char *ipPortConfigName, int numAxes,
-                                   double movingPollPeriod,
-                                   double idlePollPeriod, double comTimeout)
-    : sinqController(
-          portName, ipPortConfigName, numAxes, movingPollPeriod, idlePollPeriod,
-          /*
-          The following parameter library entries are added in this driver:
-          - REREAD_ENCODER_POSITION
-          - READ_CONFIG
-          */
-          NUM_PMACV3_DRIVER_PARAMS)
-
-{
-
-    // Initialization of local variables
-    asynStatus status = asynSuccess;
-
-    // Initialization of all member variables
-    lowLevelPortUser_ = nullptr;
-    comTimeout_ = comTimeout;
-
-    // =========================================================================;
-
-    /*
-    We try to connect to the port via the port name provided by the constructor.
-    If this fails, the function is terminated via exit
-    */
-    pasynOctetSyncIO->connect(ipPortConfigName, 0, &lowLevelPortUser_, NULL);
-    if (status != asynSuccess || lowLevelPortUser_ == nullptr) {
-        errlogPrintf(
-            "%s => line %d:\nFATAL ERROR (cannot connect to MCU controller).\n"
-            "Terminating IOC",
-            __PRETTY_FUNCTION__, __LINE__);
-        exit(-1);
-    }
-
-    // =========================================================================
-    // Create additional parameter library entries
-
-    status = createParam("REREAD_ENCODER_POSITION", asynParamInt32,
-                         &rereadEncoderPosition_);
-    if (status != asynSuccess) {
-        asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
-                  "%s => line %d:\nFATAL ERROR (creating a parameter failed "
-                  "with %s).\nTerminating IOC",
-                  __PRETTY_FUNCTION__, __LINE__, stringifyAsynStatus(status));
-        exit(-1);
-    }
-
-    status = createParam("READ_CONFIG", asynParamInt32, &readConfig_);
-    if (status != asynSuccess) {
-        asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
-                  "%s => line %d:\nFATAL ERROR (creating a parameter failed "
-                  "with %s).\nTerminating IOC",
-                  __PRETTY_FUNCTION__, __LINE__, stringifyAsynStatus(status));
-        exit(-1);
-    }
-
-    /*
-    Define the end-of-string of a message coming from the device to EPICS.
-    It is not necessary to append a terminator to outgoing messages, since
-    the message length is encoded in the message header in the getSetResponse
-    method.
-    */
-    const char *message_from_device =
-        "\006"; // Hex-code for ACK (acknowledge) -> Each message from the MCU
-                // is terminated by this value
-    status = pasynOctetSyncIO->setInputEos(
-        lowLevelPortUser_, message_from_device, strlen(message_from_device));
-    if (status != asynSuccess) {
-        asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
-                  "%s => line %d:\nFATAL ERROR (setting input EOS failed "
-                  "with %s).\nTerminating IOC",
-                  __PRETTY_FUNCTION__, __LINE__, stringifyAsynStatus(status));
-        pasynOctetSyncIO->disconnect(lowLevelPortUser_);
-        exit(-1);
-    }
-
-    status = callParamCallbacks();
-    if (status != asynSuccess) {
-        asynPrint(
-            this->pasynUserSelf, ASYN_TRACE_ERROR,
-            "%s => line %d:\nFATAL ERROR (executing ParamLib callbacks failed "
-            "with %s).\nTerminating IOC",
-            __PRETTY_FUNCTION__, __LINE__, stringifyAsynStatus(status));
-        pasynOctetSyncIO->disconnect(lowLevelPortUser_);
-        exit(-1);
-    }
-}
-
-/*
-Access one of the axes of the controller via the axis adress stored in asynUser.
-If the axis does not exist or is not a Axis, a nullptr is returned and an
-error is emitted.
-*/
-pmacv3Axis *pmacv3Controller::getAxis(asynUser *pasynUser) {
-    asynMotorAxis *asynAxis = asynMotorController::getAxis(pasynUser);
-    return pmacv3Controller::castToAxis(asynAxis);
-}
-
-/*
-Access one of the axes of the controller via the axis index.
-If the axis does not exist or is not a Axis, the function must return Null
-*/
-pmacv3Axis *pmacv3Controller::getAxis(int axisNo) {
-    asynMotorAxis *asynAxis = asynMotorController::getAxis(axisNo);
-    return pmacv3Controller::castToAxis(asynAxis);
-}
-
-pmacv3Axis *pmacv3Controller::castToAxis(asynMotorAxis *asynAxis) {
-
-    // =========================================================================
-
-    // If the axis slot of the pAxes_ array is empty, a nullptr must be returned
-    if (asynAxis == nullptr) {
-        return nullptr;
-    }
-
-    // Here, an error is emitted since asyn_axis is not a nullptr but also not
-    // an instance of Axis
-    pmacv3Axis *axis = dynamic_cast<pmacv3Axis *>(asynAxis);
-    if (axis == nullptr) {
-        asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
-                  "%s => line %d:\nAxis %d is not an instance of pmacv3Axis",
-                  __PRETTY_FUNCTION__, __LINE__, axis->axisNo_);
-    }
-    return axis;
-}
-
-asynStatus pmacv3Controller::writeRead(int axisNo, const char *command,
-                                       char *response,
-                                       int numExpectedResponses) {
-
-    // Definition of local variables.
-    asynStatus status = asynSuccess;
-    asynStatus pl_status = asynSuccess;
-    char fullCommand[MAXBUF_] = {0};
-    char drvMessageText[MAXBUF_] = {0};
-    char modResponse[MAXBUF_] = {0};
-    int motorStatusProblem = 0;
-    int numReceivedResponses = 0;
-
-    // Send the message and block the thread until either a response has
-    // been received or the timeout is triggered
-    int eomReason = 0; // Flag indicating why the message has ended
-
-    // Number of bytes of the outgoing message (which is command + the
-    // end-of-string terminator defined in the constructor)
-    size_t nbytesOut = 0;
-
-    // Number of bytes of the incoming message (which is response + the
-    // end-of-string terminator defined in the constructor)
-    size_t nbytesIn = 0;
-
-    // =========================================================================
-
-    pmacv3Axis *axis = getAxis(axisNo);
-    if (axis == nullptr) {
-        // We already did the error logging directly in getAxis
-        return asynError;
-    }
-
-    /*
-    The message protocol of the pmacv3 used at PSI looks as follows (all
-    characters immediately following each other without a newline):
-    0x40 (ASCII value of @) -> Request for download
-    0xBF (ASCII value of ¿) -> Select mode "get_response"
-    0x00 (ASCII value of 0)
-    0x00 (ASCII value of 0)
-    0x00 (ASCII value of 0)
-    0x00 (ASCII value of 0)
-    0x00 (ASCII value of 0)
-    [message length in network byte order] -> Use the htons function for this
-    value [Actual message] It is not necessary to append a terminator, since
-    this protocol encodes the message length at the beginning. See Turbo PMAC
-    User Manual, page 418 in VR_PMAC_GETRESPONSE
-
-    The message has to be build manually into the buffer fullCommand, since it
-    contains NULL terminators in its middle, therefore the string manipulation
-    methods of C don't work.
-    */
-
-    // The entire message is equal to the command length
-    const size_t commandLength =
-        strlen(command) + 1; // +1 because of the appended /r
-    const int offset = 8;
-
-    // Positions 2 to 6 must have the value 0. Since fullCommand is initialized
-    // as an array of zeros, we don't need to set these bits manually.
-    fullCommand[0] = '\x40';
-    fullCommand[1] = '\xBF';
-    fullCommand[7] = commandLength;
-
-    snprintf((char *)fullCommand + offset, MAXBUF_ - offset, "%s\r", command);
-    asynPrint(this->pasynUserSelf, ASYN_TRACEIO_DRIVER,
-              "%s => line %d:\nSending command %s", __PRETTY_FUNCTION__,
-              __LINE__, fullCommand);
-
-    // Perform the actual writeRead
-    status = pasynOctetSyncIO->writeRead(
-        lowLevelPortUser_, fullCommand, commandLength + offset, response,
-        MAXBUF_, comTimeout_, &nbytesOut, &nbytesIn, &eomReason);
-
-    /*
-    Calculate the number of received responses by counting the number of
-    carriage returns "\r" in the response.
-    */
-    for (size_t i = 0; i < strlen(response); i++) {
-        if (response[i] == '\r') {
-            numReceivedResponses++;
-        }
-    }
-
-    /*
-    Check if we got the expected amount of responses. If we didn't, flush the
-    PMAC and try again. If that fails as well, return an error.
-    */
-    if (numExpectedResponses != numReceivedResponses) {
-        // Flush message as defined in Turbo PMAC User Manual, p. 430:
-        // \x40\xB3000
-        // VR_DOWNLOAD = \x40
-        // VR_PMAC_FLUSH = \xB3
-        char flush_msg[5] = {0};
-        flush_msg[0] = '\x40';
-        flush_msg[1] = '\xB3';
-        size_t nbytesOut = 0;
-        status = pasynOctetSyncIO->write(lowLevelPortUser_, flush_msg, 5,
-                                         comTimeout_, &nbytesOut);
-
-        // Wait after the flush so the MCU has time to prepare for the
-        // next command
-        usleep(100000);
-
-        if (status == asynSuccess) {
-            // If flushing the MCU succeded, try to send the command again
-            status = pasynOctetSyncIO->writeRead(
-                lowLevelPortUser_, fullCommand, commandLength + offset,
-                response, MAXBUF_, comTimeout_, &nbytesOut, &nbytesIn,
-                &eomReason);
-
-            // If the command returned a bad answer for the second time, give up
-            // and propagate the problem
-            numReceivedResponses = 0;
-            for (size_t i = 0; i < strlen(response); i++) {
-                if (response[i] == '\r') {
-                    numReceivedResponses++;
-                }
-            }
-
-            // Second check: If this fails, give up and propagate the error.
-            if (numExpectedResponses != numReceivedResponses) {
-
-                adjustResponseForPrint(modResponse, response, MAXBUF_);
-                asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
-                          "%s => line %d:\nUnexpected response '%s' (carriage "
-                          "returns are replaced with spaces) for command %s\n",
-                          __PRETTY_FUNCTION__, __LINE__, modResponse, command);
-                snprintf(drvMessageText, sizeof(drvMessageText),
-                         "Received unexpected response '%s' (carriage returns "
-                         "are replaced with spaces) for command %s. "
-                         "Please call the support",
-                         modResponse, command);
-                pl_status = setStringParam(motorMessageText_, drvMessageText);
-                if (pl_status != asynSuccess) {
-                    return paramLibAccessFailed(pl_status, "motorMessageText_",
-                                                __PRETTY_FUNCTION__, __LINE__);
-                }
-                status = asynError;
-            }
-        } else {
-            asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
-                      "%s => line %d:\nFlushing the MCU failed with %s\n",
-                      __PRETTY_FUNCTION__, __LINE__,
-                      stringifyAsynStatus(status));
-        }
-    }
-
-    // Create custom error messages for different failure modes
-    if (strlen(drvMessageText) == 0) {
-        switch (status) {
-        case asynSuccess:
-            break; // Communicate nothing
-        case asynTimeout:
-            snprintf(drvMessageText, sizeof(drvMessageText),
-                     "connection timeout for axis %d", axisNo);
-            break;
-        case asynDisconnected:
-            snprintf(drvMessageText, sizeof(drvMessageText),
-                     "axis is not connected");
-            break;
-        case asynDisabled:
-            snprintf(drvMessageText, sizeof(drvMessageText),
-                     "axis is disabled");
-            break;
-        default:
-            snprintf(drvMessageText, sizeof(drvMessageText),
-                     "Communication failed (%s)", stringifyAsynStatus(status));
-            break;
-        }
-    }
-
-    // Log the overall status (communication successfull or not)
-    if (status == asynSuccess) {
-
-        asynPrint(lowLevelPortUser_, ASYN_TRACEIO_DRIVER,
-                  "%s => line %d:\nDevice response: %s (_ are "
-                  "carriage returns)\n",
-                  __PRETTY_FUNCTION__, __LINE__, modResponse);
-        pl_status = axis->setIntegerParam(this->motorStatusCommsError_, 0);
-    } else {
-        asynPrint(lowLevelPortUser_, ASYN_TRACE_ERROR,
-                  "%s => line %d:\nCommunication failed for command %s (%s)\n",
-                  __PRETTY_FUNCTION__, __LINE__, fullCommand,
-                  stringifyAsynStatus(status));
-
-        // Check if the axis already is in an error communication mode. If it is
-        // not, upstream the error. This is done to avoid "flooding" the user
-        // with different error messages if more than one error ocurred before
-        // an error-free communication
-        pl_status =
-            getIntegerParam(axisNo, motorStatusProblem_, &motorStatusProblem);
-        if (pl_status != asynSuccess) {
-            return paramLibAccessFailed(pl_status, "motorStatusProblem_",
-                                        __PRETTY_FUNCTION__, __LINE__);
-        }
-
-        if (motorStatusProblem == 0) {
-            pl_status = axis->setStringParam(motorMessageText_, drvMessageText);
-            if (pl_status != asynSuccess) {
-                return paramLibAccessFailed(pl_status, "motorMessageText_",
-                                            __PRETTY_FUNCTION__, __LINE__);
-            }
-
-            pl_status = axis->setIntegerParam(motorStatusProblem_, 1);
-            if (pl_status != asynSuccess) {
-                return paramLibAccessFailed(pl_status, "motorStatusProblem",
-                                            __PRETTY_FUNCTION__, __LINE__);
-            }
-
-            pl_status = axis->setIntegerParam(motorStatusProblem_, 1);
-            if (pl_status != asynSuccess) {
-                return paramLibAccessFailed(pl_status, "motorStatusCommsError_",
-                                            __PRETTY_FUNCTION__, __LINE__);
-            }
-        }
-    }
-    return status;
-}
-
-asynStatus pmacv3Controller::writeInt32(asynUser *pasynUser, epicsInt32 value) {
-    int function = pasynUser->reason;
-
-    // =====================================================================
-
-    pmacv3Axis *axis = getAxis(pasynUser);
-    if (axis == nullptr) {
-        // We already did the error logging directly in getAxis
-        return asynError;
-    }
-
-    // Handle custom PVs
-    if (function == rereadEncoderPosition_) {
-        return axis->rereadEncoder();
-    } else if (function == readConfig_) {
-        return axis->atFirstPoll();
-    } else {
-        return sinqController::writeInt32(pasynUser, value);
-    }
-}
-
-asynStatus sinqController::readInt32(asynUser *pasynUser, epicsInt32 *value) {
-    // PMACs can be disabled
-    if (pasynUser->reason == motorCanDisable_) {
-        *value = 1;
-        return asynSuccess;
-    } else {
-        return asynMotorController::readInt32(pasynUser, value);
-    }
-}
-
-asynStatus pmacv3Controller::errMsgCouldNotParseResponse(
-    const char *command, const char *response, int axisNo,
-    const char *functionName, int lineNumber) {
-    char modifiedResponse[MAXBUF_] = {0};
-    adjustResponseForPrint(modifiedResponse, response, MAXBUF_);
-    return sinqController::errMsgCouldNotParseResponse(
-        command, modifiedResponse, axisNo, functionName, lineNumber);
-}
-
-/*************************************************************************************/
-/** The following functions are C-wrappers, and can be called directly from
- * iocsh */
-
-extern "C" {
-
-/*
-C wrapper for the controller constructor. Please refer to the pmacv3Controller
-constructor documentation.
-*/
-asynStatus pmacv3CreateController(const char *portName,
-                                  const char *ipPortConfigName, int numAxes,
-                                  double movingPollPeriod,
-                                  double idlePollPeriod, double comTimeout) {
-    /*
-    We create a new instance of the controller, using the "new" keyword to
-    allocate it on the heap while avoiding RAII.
-    https://github.com/epics-modules/motor/blob/master/motorApp/MotorSrc/asynMotorController.cpp
-    https://github.com/epics-modules/asyn/blob/master/asyn/asynPortDriver/asynPortDriver.cpp
-
-    The created object is registered in EPICS in its constructor and can safely
-    be "leaked" here.
-    */
-#pragma GCC diagnostic ignored "-Wunused-but-set-variable"
-#pragma GCC diagnostic ignored "-Wunused-variable"
-    pmacv3Controller *pController =
-        new pmacv3Controller(portName, ipPortConfigName, numAxes,
-                             movingPollPeriod, idlePollPeriod, comTimeout);
-
-    return asynSuccess;
-}
-
-/*
-C wrapper for the axis constructor. Please refer to the pmacv3Axis constructor
-documentation. The controller is read from the portName.
-*/
-asynStatus pmacv3CreateAxis(const char *portName, int axis) {
-    pmacv3Axis *pAxis;
-
-    /*
-    findAsynPortDriver is a asyn library FFI function which uses the C ABI.
-    Therefore it returns a void pointer instead of e.g. a pointer to a
-    superclass of the controller such as asynPortDriver. Type-safe upcasting
-    via dynamic_cast is therefore not possible directly. However, we do know
-    that the void pointer is either a pointer to asynPortDriver (if a driver
-    with the specified name exists) or a nullptr. Therefore, we first do a
-    nullptr check, then a cast to asynPortDriver and lastly a (typesafe)
-    dynamic_upcast to Controller
-    https://stackoverflow.com/questions/70906749/is-there-a-safe-way-to-cast-void-to-class-pointer-in-c
-     */
-    void *ptr = findAsynPortDriver(portName);
-    if (ptr == nullptr) {
-        /*
-        We can't use asynPrint here since this macro would require us
-        to get a lowLevelPortUser_ from a pointer to an asynPortDriver.
-        However, the given pointer is a nullptr and therefore doesn't
-        have a lowLevelPortUser_! printf is an EPICS alternative which
-        works w/o that, but doesn't offer the comfort provided
-        by the asynTrace-facility
-        */
-        errlogPrintf("%s => line %d:\nPort %s not found.", __PRETTY_FUNCTION__,
-                     __LINE__, portName);
-        return asynError;
-    }
-    // Unsafe cast of the pointer to an asynPortDriver
-    asynPortDriver *apd = (asynPortDriver *)(ptr);
-
-    // Safe downcast
-    pmacv3Controller *pC = dynamic_cast<pmacv3Controller *>(apd);
-    if (pC == nullptr) {
-        errlogPrintf(
-            "%s => line %d:\ncontroller on port %s is not a pmacv3Controller.",
-            __PRETTY_FUNCTION__, __LINE__, portName);
-        return asynError;
-    }
-
-    // Prevent manipulation of the controller from other threads while we
-    // create the new axis.
-    pC->lock();
-
-    /*
-    We create a new instance of the axis, using the "new" keyword to
-    allocate it on the heap while avoiding RAII.
-    https://github.com/epics-modules/motor/blob/master/motorApp/MotorSrc/asynMotorController.cpp
-    https://github.com/epics-modules/asyn/blob/master/asyn/asynPortDriver/asynPortDriver.cpp
-
-    The created object is registered in EPICS in its constructor and can safely
-    be "leaked" here.
-    */
-#pragma GCC diagnostic ignored "-Wunused-but-set-variable"
-#pragma GCC diagnostic ignored "-Wunused-variable"
-    pAxis = new pmacv3Axis(pC, axis);
-
-    // Allow manipulation of the controller again
-    pC->unlock();
-    return asynSuccess;
-}
-
-/*
-This is boilerplate code which is used to make the FFI functions
-CreateController and CreateAxis "known" to the IOC shell (iocsh).
-*/
-
-#ifdef vxWorks
-#else
-
-/*
-Define name and type of the arguments for the CreateController function
-in the iocsh. This is done by creating structs with the argument names and
-types and then providing "factory" functions
-(configCreateControllerCallFunc). These factory functions are used to
-register the constructors during compilation.
-*/
-static const iocshArg CreateControllerArg0 = {"Controller name (e.g. mcu1)",
-                                              iocshArgString};
-static const iocshArg CreateControllerArg1 = {"Asyn IP port name (e.g. pmcu1)",
-                                              iocshArgString};
-static const iocshArg CreateControllerArg2 = {"Number of axes", iocshArgInt};
-static const iocshArg CreateControllerArg3 = {"Moving poll rate (s)",
-                                              iocshArgDouble};
-static const iocshArg CreateControllerArg4 = {"Idle poll rate (s)",
-                                              iocshArgDouble};
-static const iocshArg CreateControllerArg5 = {"Communication timeout (s)",
-                                              iocshArgDouble};
-static const iocshArg *const CreateControllerArgs[] = {
-    &CreateControllerArg0, &CreateControllerArg1, &CreateControllerArg2,
-    &CreateControllerArg3, &CreateControllerArg4, &CreateControllerArg5};
-static const iocshFuncDef configPmacV3CreateController = {"pmacv3Controller", 6,
-                                                          CreateControllerArgs};
-static void configPmacV3CreateControllerCallFunc(const iocshArgBuf *args) {
-    pmacv3CreateController(args[0].sval, args[1].sval, args[2].ival,
-                           args[3].dval, args[4].dval, args[5].dval);
-}
-
-/*
-Same procedure as for the CreateController function, but for the axis
-itself.
-*/
-static const iocshArg CreateAxisArg0 = {"Controller name (e.g. mcu1)",
-                                        iocshArgString};
-static const iocshArg CreateAxisArg1 = {"Axis number", iocshArgInt};
-static const iocshArg *const CreateAxisArgs[] = {&CreateAxisArg0,
-                                                 &CreateAxisArg1};
-static const iocshFuncDef configPmacV3CreateAxis = {"pmacv3Axis", 2,
-                                                    CreateAxisArgs};
-static void configPmacV3CreateAxisCallFunc(const iocshArgBuf *args) {
-    pmacv3CreateAxis(args[0].sval, args[1].ival);
-}
-
-// This function is made known to EPICS in pmacv3.dbd and is called by EPICS
-// in order to register both functions in the IOC shell
-static void pmacv3Register(void) {
-    iocshRegister(&configPmacV3CreateController,
-                  configPmacV3CreateControllerCallFunc);
-    iocshRegister(&configPmacV3CreateAxis, configPmacV3CreateAxisCallFunc);
-}
-epicsExportRegistrar(pmacv3Register);
-
-#endif
-
-} // extern "C"

src/turboPmac.dbd

@@ -1,4 +1,5 @@
 #---------------------------------------------
 # SINQ specific DB definitions
 #---------------------------------------------
-registrar(pmacv3Register) 
+registrar(turboPmacControllerRegister) 
+registrar(turboPmacAxisRegister) 

src/turboPmacAxis.h

@@ -1,27 +1,28 @@
-#ifndef pmacv3AXIS_H
+#ifndef turboPmacAXIS_H
-#define pmacv3AXIS_H
+#define turboPmacAXIS_H
 #include "sinqAxis.h"
 
 // Forward declaration of the controller class to resolve the cyclic dependency
-// between C804Controller.h and C804Axis.h. See
+// between the controller and the axis .h-file. See
 // https://en.cppreference.com/w/cpp/language/class.
-class pmacv3Controller;
+class turboPmacController;
 
-class pmacv3Axis : public sinqAxis {
+class turboPmacAxis : public sinqAxis {
   public:
     /**
-     * @brief Construct a new pmacv3Axis
+     * @brief Construct a new turboPmacAxis
      *
      * @param pController         Pointer to the associated controller
      * @param axisNo              Index of the axis
      */
-    pmacv3Axis(pmacv3Controller *pController, int axisNo);
+    turboPmacAxis(turboPmacController *pController, int axisNo,
+                  bool initialize = true);
 
     /**
-     * @brief Destroy the pmacv3Axis
+     * @brief Destroy the turboPmacAxis
      *
      */
-    virtual ~pmacv3Axis();
+    virtual ~turboPmacAxis();
 
     /**
      * @brief Implementation of the `stop` function from asynMotorAxis
@@ -69,16 +70,24 @@ class pmacv3Axis : public sinqAxis {
                       double max_velocity, double acceleration);
 
     /**
-     * @brief Implementation of the `atFirstPoll` function from sinqAxis.
+     * @brief Readout of some values from the controller at IOC startup
      *
      * The following steps are performed:
      * - Read out the motor status, motor position, velocity and acceleration
      * from the MCU and store this information in the parameter library.
-     * - Set the enable PV accordint to the initial status of the axis.
+     * - Set the enable PV according to the initial status of the axis.
      *
      * @return asynStatus
      */
-    asynStatus atFirstPoll();
+    asynStatus init();
+
+    /**
+     * @brief Implementation of the `doReset` function from sinqAxis.
+     *
+     * @param on
+     * @return asynStatus
+     */
+    asynStatus doReset();
 
     /**
      * @brief Enable / disable the axis.
@@ -103,18 +112,24 @@ class pmacv3Axis : public sinqAxis {
      */
     asynStatus rereadEncoder();
 
-  protected:
+    /**
-    pmacv3Controller *pC_;
+     * @brief Interpret the error code and populate the user message accordingly
+     *
+     * @param error
+     * @param userMessage
+     * @param sizeUserMessage
+     * @return asynStatus
+     */
+    asynStatus handleError(int error, char *userMessage, int sizeUserMessage);
+
+  protected:
+    turboPmacController *pC_;
 
-    bool initial_poll_;
     bool waitForHandshake_;
     time_t timeAtHandshake_;
 
     // The axis status is used when enabling / disabling the motor
     int axisStatus_;
-
-  private:
-    friend class pmacv3Controller;
 };
 
 #endif

src/turboPmacController.cpp

@@ -0,0 +1,566 @@
+#include "turboPmacController.h"
+#include "asynMotorController.h"
+#include "asynOctetSyncIO.h"
+#include "turboPmacAxis.h"
+#include <epicsExport.h>
+#include <errlog.h>
+#include <initHooks.h>
+#include <iocsh.h>
+#include <netinet/in.h>
+#include <registryFunction.h>
+#include <string.h>
+#include <unistd.h>
+
+/**
+ * @brief Copy src into dst and replace all carriage returns with spaces. This
+ * allows to print *dst with asynPrint.
+ *
+ *
+ * @param dst                 Buffer for the modified string
+ * @param src                 Original string
+ */
+void adjustResponseForPrint(char *dst, const char *src, size_t buf_length) {
+    for (size_t i = 0; i < buf_length; i++) {
+        if (src[i] == '\r') {
+            dst[i] = ' ';
+        } else {
+            dst[i] = src[i];
+        }
+    }
+}
+
+turboPmacController::turboPmacController(const char *portName,
+                                         const char *ipPortConfigName,
+                                         int numAxes, double movingPollPeriod,
+                                         double idlePollPeriod,
+                                         double comTimeout, int numExtraParams)
+    : sinqController(
+          portName, ipPortConfigName, numAxes, movingPollPeriod, idlePollPeriod,
+          /*
+          The following parameter library entries are added in this driver:
+          - REREAD_ENCODER_POSITION
+          - READ_CONFIG
+          */
+          numExtraParams + NUM_turboPmac_DRIVER_PARAMS)
+
+{
+
+    // Initialization of local variables
+    asynStatus status = asynSuccess;
+
+    // Initialization of all member variables
+    comTimeout_ = comTimeout;
+
+    // Maximum allowed number of subsequent timeouts before the user is
+    // informed.
+    maxSubsequentTimeouts_ = 10;
+
+    // =========================================================================
+    // Create additional parameter library entries
+
+    status = createParam("REREAD_ENCODER_POSITION", asynParamInt32,
+                         &rereadEncoderPosition_);
+    if (status != asynSuccess) {
+        asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
+                  "Controller \"%s\" => %s, line %d\nFATAL ERROR (creating a "
+                  "parameter failed with %s).\nTerminating IOC",
+                  portName, __PRETTY_FUNCTION__, __LINE__,
+                  stringifyAsynStatus(status));
+        exit(-1);
+    }
+
+    status = createParam("READ_CONFIG", asynParamInt32, &readConfig_);
+    if (status != asynSuccess) {
+        asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
+                  "Controller \"%s\" => %s, line %d\nFATAL ERROR (creating a "
+                  "parameter failed with %s).\nTerminating IOC",
+                  portName, __PRETTY_FUNCTION__, __LINE__,
+                  stringifyAsynStatus(status));
+        exit(-1);
+    }
+
+    /*
+    Define the end-of-string of a message coming from the device to EPICS.
+    It is not necessary to append a terminator to outgoing messages, since
+    the message length is encoded in the message header in the getSetResponse
+    method.
+    */
+    const char *message_from_device =
+        "\006"; // Hex-code for ACK (acknowledge) -> Each message from the MCU
+                // is terminated by this value
+    status = pasynOctetSyncIO->setInputEos(ipPortUser_, message_from_device,
+                                           strlen(message_from_device));
+    if (status != asynSuccess) {
+        asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
+                  "Controller \"%s\" => %s, line %d\nFATAL ERROR "
+                  "(setting input EOS failed with %s).\nTerminating IOC",
+                  portName, __PRETTY_FUNCTION__, __LINE__,
+                  stringifyAsynStatus(status));
+        pasynOctetSyncIO->disconnect(ipPortUser_);
+        exit(-1);
+    }
+
+    status = callParamCallbacks();
+    if (status != asynSuccess) {
+        asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
+                  "Controller \"%s\" => %s, line %d\nFATAL ERROR "
+                  "(executing ParamLib callbacks failed "
+                  "with %s).\nTerminating IOC",
+                  portName, __PRETTY_FUNCTION__, __LINE__,
+                  stringifyAsynStatus(status));
+        pasynOctetSyncIO->disconnect(ipPortUser_);
+        exit(-1);
+    }
+}
+
+/*
+Access one of the axes of the controller via the axis adress stored in asynUser.
+If the axis does not exist or is not a Axis, a nullptr is returned and an
+error is emitted.
+*/
+turboPmacAxis *turboPmacController::getTurboPmacAxis(asynUser *pasynUser) {
+    asynMotorAxis *asynAxis = asynMotorController::getAxis(pasynUser);
+    return dynamic_cast<turboPmacAxis *>(asynAxis);
+}
+
+/*
+Access one of the axes of the controller via the axis index.
+If the axis does not exist or is not a Axis, the function must return Null
+*/
+turboPmacAxis *turboPmacController::getTurboPmacAxis(int axisNo) {
+    asynMotorAxis *asynAxis = asynMotorController::getAxis(axisNo);
+    return dynamic_cast<turboPmacAxis *>(asynAxis);
+}
+
+asynStatus turboPmacController::writeRead(int axisNo, const char *command,
+                                          char *response,
+                                          int numExpectedResponses) {
+
+    // Definition of local variables.
+    asynStatus status = asynSuccess;
+    asynStatus paramLibStatus = asynSuccess;
+    asynStatus timeoutStatus = asynSuccess;
+    char fullCommand[MAXBUF_] = {0};
+    char drvMessageText[MAXBUF_] = {0};
+    char modResponse[MAXBUF_] = {0};
+    int motorStatusProblem = 0;
+    int numReceivedResponses = 0;
+
+    /*
+    asyn defines the following reasons for an end-of-message coming from the MCU
+    (https://epics.anl.gov/modules/soft/asyn/R4-14/asynDriver.pdf, p. 28):
+    0: Timeout
+    1: Request count reached
+    2: End of string detected -> In this driver, this is the "normal" case
+    4: End indicator detected
+    Combinations of reasons are also possible, e.g. eomReason = 5 would mean
+    that both the request count was reached and an end indicator was detected.
+     */
+    int eomReason = 0;
+
+    // Number of bytes of the outgoing message (which is command + the
+    // end-of-string terminator defined in the constructor)
+    size_t nbytesOut = 0;
+
+    // Number of bytes of the incoming message (which is response + the
+    // end-of-string terminator defined in the constructor)
+    size_t nbytesIn = 0;
+
+    // =========================================================================
+
+    turboPmacAxis *axis = getTurboPmacAxis(axisNo);
+    if (axis == nullptr) {
+        // We already did the error logging directly in getAxis
+        return asynError;
+    }
+
+    /*
+    The message protocol of the turboPmac used at PSI looks as follows (all
+    characters immediately following each other without a newline):
+    0x40 (ASCII value of @) -> Request for download
+    0xBF (ASCII value of ¿) -> Select mode "get_response"
+    0x00 (ASCII value of 0)
+    0x00 (ASCII value of 0)
+    0x00 (ASCII value of 0)
+    0x00 (ASCII value of 0)
+    0x00 (ASCII value of 0)
+    [message length in network byte order] -> Use the htons function for this
+    value [Actual message] It is not necessary to append a terminator, since
+    this protocol encodes the message length at the beginning. See Turbo PMAC
+    User Manual, page 418 in VR_PMAC_GETRESPONSE
+    x0D (ASCII value of carriage return) -> The controller needs a carriage
+    return at the end of a "send" command (a command were we transmit data via
+    =). For "request" commands (e.g. read status or position), this is not
+    necessary, but it doesn't hurt either, therefore we always add a carriage
+    return.
+
+    The message has to be build manually into the buffer fullCommand, since it
+    contains NULL terminators in its middle, therefore the string manipulation
+    methods of C don't work.
+    */
+
+    const size_t commandLength = strlen(command);
+    const int offset = 9;
+
+    // Positions 2 to 6 must have the value 0. Since fullCommand is initialized
+    // as an array of zeros, we don't need to set these bits manually.
+    fullCommand[0] = '\x40';
+    fullCommand[1] = '\xBF';
+
+    // The size of size_t is platform dependant (pointers-sized), while htons
+    // needs an unsigned int. The byte order is then converted from host to
+    // network order. The offset "+1" is for the carriage return.
+    u_int16_t len = htons(static_cast<u_int16_t>(commandLength + 1));
+
+    // Split up into the upper and the lower byte
+    fullCommand[7] = (char)(len >> 8);   // Shift the 8 higher bits to the right
+    fullCommand[8] = (char)(len & 0xFF); // Mask the higher bits
+
+    // Write the actual command behind the protocol
+    for (size_t i = 0; i < commandLength; i++) {
+        fullCommand[i + offset] = command[i];
+    }
+    fullCommand[offset + commandLength] = '\x0D';
+
+    // +1 for the carriage return.
+    const size_t fullComandLength = offset + commandLength + 1;
+
+    /*
+    We use separated write and read commands here, not the combined writeRead
+    method, because the latter is actually a flushWriteRead (see
+    https://epics.anl.gov/modules/soft/asyn/R4-14/asynDriver.pdf, p. 31) ->
+    Calls the flush command, then the write command, then the read command.
+    The flush itself reads repeatedly from the MCU until no messages are there
+    anymore. (The Diamond Light Source driver first send a PMAC flush command
+    and then does the same as the asyn flush). We don't want this behaviour.
+    (https://www.slac.stanford.edu/grp/lcls/controls/global/doc/epics-modules/R3-14-12/asyn/asyn-R4-18-lcls2/asyn/interfaces/asynOctetBase.c)
+
+    If a timeout occurs during writing or reading, inform the user that we're
+    trying to reconnect. If the problem persists, ask them to call the support
+    */
+
+    status = pasynOctetSyncIO->write(ipPortUser_, fullCommand, fullComandLength,
+                                     comTimeout_, &nbytesOut);
+
+    msgPrintControlKey writeKey =
+        msgPrintControlKey(portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
+
+    if (status == asynTimeout) {
+
+        if (msgPrintControl_.shouldBePrinted(writeKey, true, pasynUserSelf)) {
+            asynPrint(
+                this->pasynUserSelf, ASYN_TRACE_ERROR,
+                "Controller \"%s\", axis %d => %s, line %d\nTimeout while "
+                "writing to the MCU.%s\n",
+                portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
+                msgPrintControl_.getSuffix());
+        }
+
+        timeoutStatus = checkComTimeoutWatchdog(axisNo, drvMessageText,
+                                                sizeof(drvMessageText));
+
+        int timeoutCounter = 0;
+        while (1) {
+            checkMaxSubsequentTimeouts(timeoutCounter, axis);
+            timeoutCounter += 1;
+
+            status = pasynOctetSyncIO->write(ipPortUser_, fullCommand,
+                                             fullComandLength, comTimeout_,
+                                             &nbytesOut);
+            if (status != asynTimeout) {
+                asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
+                          "Controller \"%s\", axis %d  => %s, line "
+                          "%d\nReconnected after write timeout\n",
+                          portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
+                break;
+            }
+        }
+    } else if (status != asynSuccess) {
+        if (msgPrintControl_.shouldBePrinted(writeKey, true, pasynUserSelf)) {
+            asynPrint(
+                this->pasynUserSelf, ASYN_TRACE_ERROR,
+                "Controller \"%s\", axis %d => %s, line %d\nError %s while "
+                "writing to the controller.%s\n",
+                portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
+                stringifyAsynStatus(status), msgPrintControl_.getSuffix());
+        }
+    } else {
+        msgPrintControl_.resetCount(writeKey, pasynUserSelf);
+    }
+
+    // Read the response from the MCU buffer
+    status = pasynOctetSyncIO->read(ipPortUser_, response, MAXBUF_, comTimeout_,
+                                    &nbytesIn, &eomReason);
+
+    msgPrintControlKey readKey =
+        msgPrintControlKey(portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
+
+    if (status == asynTimeout) {
+
+        if (msgPrintControl_.shouldBePrinted(readKey, true, pasynUserSelf)) {
+            asynPrint(
+                this->pasynUserSelf, ASYN_TRACE_ERROR,
+                "Controller \"%s\", axis %d => %s, line %d\nTimeout while "
+                "reading from the MCU.%s\n",
+                portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
+                msgPrintControl_.getSuffix());
+        }
+
+        // Add this event to the back of the timeout event counter
+        timeoutStatus = checkComTimeoutWatchdog(axisNo, drvMessageText,
+                                                sizeof(drvMessageText));
+
+        int timeoutCounter = 0;
+        while (1) {
+            checkMaxSubsequentTimeouts(timeoutCounter, axis);
+            timeoutCounter += 1;
+
+            status = pasynOctetSyncIO->read(ipPortUser_, response, MAXBUF_,
+                                            comTimeout_, &nbytesIn, &eomReason);
+            if (status != asynTimeout) {
+                asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
+                          "Controller \"%s\", axis %d  => %s, line "
+                          "%d\nReconnected after read timeout\n",
+                          portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
+                break;
+            }
+        }
+    } else if (status != asynSuccess) {
+        if (msgPrintControl_.shouldBePrinted(readKey, true, pasynUserSelf)) {
+            asynPrint(
+                this->pasynUserSelf, ASYN_TRACE_ERROR,
+                "Controller \"%s\", axis %d => %s, line %d\nError %s while "
+                "reading from the controller.%s\n",
+                portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
+                stringifyAsynStatus(status), msgPrintControl_.getSuffix());
+        }
+    } else {
+        msgPrintControl_.resetCount(readKey, pasynUserSelf);
+    }
+
+    if (timeoutStatus == asynError) {
+        status = asynError;
+    }
+
+    // The message should only ever terminate due to reason 2
+    msgPrintControlKey terminateKey =
+        msgPrintControlKey(portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
+    if (eomReason != 2) {
+        status = asynError;
+
+        snprintf(drvMessageText, sizeof(drvMessageText),
+                 "Terminated message due to reason %d (should be 2).",
+                 eomReason);
+
+        if (msgPrintControl_.shouldBePrinted(terminateKey, true,
+                                             pasynUserSelf)) {
+            asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
+                      "Controller \"%s\", axis %d => %s, line %d\nMessage "
+                      "terminated due to reason %i.%s\n",
+                      portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
+                      eomReason, msgPrintControl_.getSuffix());
+        }
+    } else {
+        msgPrintControl_.resetCount(terminateKey, pasynUserSelf);
+    }
+
+    /*
+    Calculate the number of received responses by counting the number of
+    carriage returns "\r" in the response.
+    */
+    for (size_t i = 0; i < strlen(response); i++) {
+        if (response[i] == '\r') {
+            numReceivedResponses++;
+        }
+    }
+    msgPrintControlKey numResponsesKey =
+        msgPrintControlKey(portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
+    if (numExpectedResponses != numReceivedResponses) {
+        adjustResponseForPrint(modResponse, response, MAXBUF_);
+
+        if (msgPrintControl_.shouldBePrinted(numResponsesKey, true,
+                                             pasynUserSelf)) {
+            asynPrint(
+                this->pasynUserSelf, ASYN_TRACE_ERROR,
+                "Controller \"%s\", axis %d => %s, line %d\nUnexpected "
+                "response '%s' (carriage returns are replaced with spaces) "
+                "for command %s.%s\n",
+                portName, axisNo, __PRETTY_FUNCTION__, __LINE__, modResponse,
+                command, msgPrintControl_.getSuffix());
+        }
+
+        snprintf(drvMessageText, sizeof(drvMessageText),
+                 "Received unexpected response '%s' (carriage returns "
+                 "are replaced with spaces) for command %s. "
+                 "Please call the support",
+                 modResponse, command);
+        status = asynError;
+    } else {
+        msgPrintControl_.resetCount(numResponsesKey, pasynUserSelf);
+    }
+
+    // Create custom error messages for different failure modes, if no error
+    // message has been set yet
+    if (strlen(drvMessageText) == 0) {
+        switch (status) {
+        case asynSuccess:
+            break; // Communicate nothing
+        case asynTimeout:
+            snprintf(drvMessageText, sizeof(drvMessageText),
+                     "connection timeout for axis %d", axisNo);
+            break;
+        case asynDisconnected:
+            snprintf(drvMessageText, sizeof(drvMessageText),
+                     "axis is not connected");
+            break;
+        case asynDisabled:
+            snprintf(drvMessageText, sizeof(drvMessageText),
+                     "axis is disabled");
+            break;
+        default:
+            snprintf(drvMessageText, sizeof(drvMessageText),
+                     "Communication failed (%s)", stringifyAsynStatus(status));
+            break;
+        }
+    }
+
+    // Log the overall status (communication successfull or not)
+    if (status == asynSuccess) {
+        paramLibStatus = axis->setIntegerParam(this->motorStatusCommsError_, 0);
+    } else {
+        // Check if the axis already is in an error communication mode. If
+        // it is not, upstream the error. This is done to avoid "flooding"
+        // the user with different error messages if more than one error
+        // ocurred before an error-free communication
+        paramLibStatus =
+            getIntegerParam(axisNo, motorStatusProblem_, &motorStatusProblem);
+        if (paramLibStatus != asynSuccess) {
+            return paramLibAccessFailed(paramLibStatus, "motorStatusProblem_",
+                                        axisNo, __PRETTY_FUNCTION__, __LINE__);
+        }
+
+        if (motorStatusProblem == 0) {
+            paramLibStatus =
+                axis->setStringParam(motorMessageText_, drvMessageText);
+            if (paramLibStatus != asynSuccess) {
+                return paramLibAccessFailed(paramLibStatus, "motorMessageText_",
+                                            axisNo, __PRETTY_FUNCTION__,
+                                            __LINE__);
+            }
+
+            paramLibStatus = axis->setIntegerParam(motorStatusProblem_, 1);
+            if (paramLibStatus != asynSuccess) {
+                return paramLibAccessFailed(paramLibStatus,
+                                            "motorStatusProblem", axisNo,
+                                            __PRETTY_FUNCTION__, __LINE__);
+            }
+
+            paramLibStatus = axis->setIntegerParam(motorStatusProblem_, 1);
+            if (paramLibStatus != asynSuccess) {
+                return paramLibAccessFailed(paramLibStatus,
+                                            "motorStatusCommsError_", axisNo,
+                                            __PRETTY_FUNCTION__, __LINE__);
+            }
+        }
+    }
+    return status;
+}
+
+asynStatus turboPmacController::writeInt32(asynUser *pasynUser,
+                                           epicsInt32 value) {
+    int function = pasynUser->reason;
+
+    // =====================================================================
+
+    turboPmacAxis *axis = getTurboPmacAxis(pasynUser);
+
+    // Handle custom PVs
+    if (function == rereadEncoderPosition_) {
+        return axis->rereadEncoder();
+    } else if (function == readConfig_) {
+        return axis->init();
+    } else {
+        return sinqController::writeInt32(pasynUser, value);
+    }
+}
+
+asynStatus turboPmacController::couldNotParseResponse(const char *command,
+                                                      const char *response,
+                                                      int axisNo,
+                                                      const char *functionName,
+                                                      int lineNumber) {
+    char modifiedResponse[MAXBUF_] = {0};
+    adjustResponseForPrint(modifiedResponse, response, MAXBUF_);
+    return sinqController::couldNotParseResponse(
+        command, modifiedResponse, axisNo, functionName, lineNumber);
+}
+
+/*************************************************************************************/
+/** The following functions are C-wrappers, and can be called directly from
+ * iocsh */
+
+extern "C" {
+
+/*
+C wrapper for the controller constructor. Please refer to the
+turboPmacController constructor documentation.
+*/
+asynStatus turboPmacCreateController(const char *portName,
+                                     const char *ipPortConfigName, int numAxes,
+                                     double movingPollPeriod,
+                                     double idlePollPeriod, double comTimeout) {
+    /*
+    We create a new instance of the controller, using the "new" keyword to
+    allocate it on the heap while avoiding RAII.
+    https://github.com/epics-modules/motor/blob/master/motorApp/MotorSrc/asynMotorController.cpp
+    https://github.com/epics-modules/asyn/blob/master/asyn/asynPortDriver/asynPortDriver.cpp
+
+    The created object is registered in EPICS in its constructor and can
+    safely be "leaked" here.
+    */
+#pragma GCC diagnostic ignored "-Wunused-but-set-variable"
+#pragma GCC diagnostic ignored "-Wunused-variable"
+    turboPmacController *pController =
+        new turboPmacController(portName, ipPortConfigName, numAxes,
+                                movingPollPeriod, idlePollPeriod, comTimeout);
+
+    return asynSuccess;
+}
+
+/*
+Define name and type of the arguments for the CreateController function
+in the iocsh. This is done by creating structs with the argument names and
+types and then providing "factory" functions
+(configCreateControllerCallFunc). These factory functions are used to
+register the constructors during compilation.
+*/
+static const iocshArg CreateControllerArg0 = {"Controller name (e.g. mcu1)",
+                                              iocshArgString};
+static const iocshArg CreateControllerArg1 = {"Asyn IP port name (e.g. pmcu1)",
+                                              iocshArgString};
+static const iocshArg CreateControllerArg2 = {"Number of axes", iocshArgInt};
+static const iocshArg CreateControllerArg3 = {"Moving poll rate (s)",
+                                              iocshArgDouble};
+static const iocshArg CreateControllerArg4 = {"Idle poll rate (s)",
+                                              iocshArgDouble};
+static const iocshArg CreateControllerArg5 = {"Communication timeout (s)",
+                                              iocshArgDouble};
+static const iocshArg *const CreateControllerArgs[] = {
+    &CreateControllerArg0, &CreateControllerArg1, &CreateControllerArg2,
+    &CreateControllerArg3, &CreateControllerArg4, &CreateControllerArg5};
+static const iocshFuncDef configTurboPmacCreateController = {
+    "turboPmacController", 6, CreateControllerArgs};
+static void configTurboPmacCreateControllerCallFunc(const iocshArgBuf *args) {
+    turboPmacCreateController(args[0].sval, args[1].sval, args[2].ival,
+                              args[3].dval, args[4].dval, args[5].dval);
+}
+
+// This function is made known to EPICS in turboPmac.dbd and is called by
+// EPICS in order to register both functions in the IOC shell
+static void turboPmacControllerRegister(void) {
+    iocshRegister(&configTurboPmacCreateController,
+                  configTurboPmacCreateControllerCallFunc);
+}
+epicsExportRegistrar(turboPmacControllerRegister);
+
+} // extern "C"

src/turboPmacController.h

@@ -1,22 +1,22 @@
 /********************************************
- *  pmacv3Controller.h
+ *  turboPmacController.h
  *
- * PMAC V3 controller driver based on the asynMotorController class
+ * Turbo PMAC controller driver based on the asynMotorController class
  *
  * Stefan Mathis, September 2024
  ********************************************/
 
-#ifndef pmacv3Controller_H
+#ifndef turboPmacController_H
-#define pmacv3Controller_H
+#define turboPmacController_H
-#include "pmacv3Axis.h"
 #include "sinqAxis.h"
 #include "sinqController.h"
+#include "turboPmacAxis.h"
 
-class pmacv3Controller : public sinqController {
+class turboPmacController : public sinqController {
-
   public:
     /**
-     * @brief Construct a new pmacv3Controller object
+     * @brief Construct a new turboPmacController object. This function is meant
+    to be called from a child class constructor.
      *
      * @param portName            See sinqController constructor
      * @param ipPortConfigName    See sinqController constructor
@@ -26,26 +26,30 @@ class pmacv3Controller : public sinqController {
      * @param comTimeout          When trying to communicate with the device,
     the underlying asynOctetSyncIO interface waits for a response until this
     time (in seconds) has passed, then it declares a timeout.
+     * @param numExtraParams      Number of extra parameters from a child class
      */
-    pmacv3Controller(const char *portName, const char *ipPortConfigName,
+    turboPmacController(const char *portName, const char *ipPortConfigName,
-                     int numAxes, double movingPollPeriod,
+                        int numAxes, double movingPollPeriod,
-                     double idlePollPeriod, double comTimeout);
+                        double idlePollPeriod, double comTimeout,
+                        int numExtraParams = 0);
 
     /**
      * @brief Get the axis object
      *
      * @param pasynUser           Specify the axis via the asynUser
-     * @return pmacv3Axis*        If no axis could be found, this is a nullptr
+     * @return turboPmacAxis*        If no axis could be found, this is a
+     * nullptr
      */
-    pmacv3Axis *getAxis(asynUser *pasynUser);
+    turboPmacAxis *getTurboPmacAxis(asynUser *pasynUser);
 
     /**
      * @brief Get the axis object
      *
      * @param axisNo              Specify the axis via its index
-     * @return pmacv3Axis*        If no axis could be found, this is a nullptr
+     * @return turboPmacAxis*        If no axis could be found, this is a
+     * nullptr
      */
-    pmacv3Axis *getAxis(int axisNo);
+    turboPmacAxis *getTurboPmacAxis(int axisNo);
 
     /**
      * @brief Overloaded function of sinqController
@@ -56,10 +60,7 @@ class pmacv3Controller : public sinqController {
      * @param value               New value
      * @return asynStatus
      */
-    asynStatus writeInt32(asynUser *pasynUser, epicsInt32 value);
+    virtual asynStatus writeInt32(asynUser *pasynUser, epicsInt32 value);
-
-  protected:
-    asynUser *lowLevelPortUser_;
 
     /**
      * @brief Send a command to the hardware and receive a response
@@ -81,22 +82,13 @@ class pmacv3Controller : public sinqController {
                          int numExpectedResponses);
 
     /**
-     * @brief Save cast of the given asynAxis pointer to a pmacv3Axis pointer.
+     * @brief Specialized version of sinqController::couldNotParseResponse
-     * If the cast fails, this function returns a nullptr.
+     * for turboPmac
-     *
-     * @param asynAxis
-     * @return pmacv3Axis*
-     */
-    pmacv3Axis *castToAxis(asynMotorAxis *asynAxis);
-
-    /**
-     * @brief Specialized version of sinqController::errMsgCouldNotParseResponse
-     * for pmacv3
      *
      * This is an overloaded version of
-     * sinqController::errMsgCouldNotParseResponse which calls
+     * sinqController::couldNotParseResponse which calls
      * adjustResponseForLogging on response before handing it over to
-     * sinqController::errMsgCouldNotParseResponse.
+     * sinqController::couldNotParseResponse.
      *
      * @param command             Command which led to the unparseable message
      * @param response            Response which wasn't parseable
@@ -107,30 +99,34 @@ class pmacv3Controller : public sinqController {
     called. It is recommended to use a macro, e.g. __LINE__.
      * @return asynStatus         Returns asynError.
      */
-    asynStatus errMsgCouldNotParseResponse(const char *command,
+    asynStatus couldNotParseResponse(const char *command, const char *response,
-                                           const char *response, int axisNo_,
+                                     int axisNo_, const char *functionName,
-                                           const char *functionName,
+                                     int lineNumber);
-                                           int lineNumber);
+
+    // Accessors for additional PVs
+    int rereadEncoderPosition() { return rereadEncoderPosition_; }
+    int readConfig() { return readConfig_; }
 
-  private:
     // Set the maximum buffer size. This is an empirical value which must be
     // large enough to avoid overflows for all commands to the device /
     // responses from it.
     static const uint32_t MAXBUF_ = 200;
 
+  protected:
     /*
-    Stores the constructor input comTimeout
+    Timeout for the communication process in seconds
     */
     double comTimeout_;
 
+    char lastResponse[MAXBUF_];
+
     // Indices of additional PVs
-#define FIRST_PMACV3_PARAM rereadEncoderPosition_
+#define FIRST_turboPmac_PARAM rereadEncoderPosition_
     int rereadEncoderPosition_;
     int readConfig_;
-#define LAST_PMACV3_PARAM readConfig_
+#define LAST_turboPmac_PARAM readConfig_
-
-    friend class pmacv3Axis;
 };
-#define NUM_PMACV3_DRIVER_PARAMS (&LAST_PMACV3_PARAM - &FIRST_PMACV3_PARAM + 1)
+#define NUM_turboPmac_DRIVER_PARAMS                                            \
+    (&LAST_turboPmac_PARAM - &FIRST_turboPmac_PARAM + 1)
 
-#endif /* pmacv3Controller_H */
+#endif /* turboPmacController_H */

utils/analyzeTcpDump/analyzeTcpDump.py

@@ -79,7 +79,7 @@ def parse(fileAndPath):
                     value = int(response)
                 
                 lastLayer = lastPacket.getlayer(Raw)
-                lastTime = int(lastPacket.time)
+                lastTime = float(lastPacket.time)
                 data = {
                     'command': {
                         'hex': [format(value, '02x') for value in lastLayer.load],
@@ -180,10 +180,11 @@ After a successfull parse run, the resulting JSON data looks like this:
                 <Timestamp in Epoch>
     <Set command type> (e.g. Q0100= to set the position of axis 1)
         <Event timestamp>
-            <Raw ASCII string>
+            Command
-            <Actual command (e.g. P0100)
+                <Raw ASCII string>
-            <Set value>
+                <Actual command (e.g. P0100)
-            <Timestamp in Epoch>
+                <Set value>
+                <Timestamp in Epoch>
 <IP Adress MCU2>
             """)
 

utils/analyzeTcpDump/demo.py

@@ -70,8 +70,8 @@ if __name__ == "__main__":
     position_target.append(position_target[-1])
 
     plt.plot(dates_target, position_target, "k--", label="Target position")
-    plt.plot(dates_all, position_all, "r", label="All responses")
+    plt.plot(dates_all, position_all, "r-", label="All responses")
-    plt.plot(dates_valid, position_valid, "b", label="Valid responses")
+    plt.plot(dates_valid, position_valid, "b-", label="Valid responses")
     plt.xlabel("Time (ISO 8601)")
     plt.ylabel("Axis position in degree")
     plt.gca().xaxis.set_major_formatter(mdates.DateFormatter("%Y-%m-%dT%H:%M:%S"))