- Drivers and plugins each need to support a number of parameters that control their - operation and provide status information. Most of these can be treated as 32-bit - integers, 64-bit floats, or strings. When the new value of a parameter is sent to - a driver, (e.g. detector binning in the X direction) from an asyn client (e.g. an - EPICS record), then the driver will need to take some action. It may change some - other parameters in response to this new value (e.g. image size in the X direction). - The sequence of operations in the driver can be summarized as -
-- asynPortDriver provides methods to simplify the above sequence, which must be implemented - for each of the many parameters that the driver supports. Each parameter is assigned - a number, which is the value in the pasynUser-> reason field that asyn clients - pass to the driver when reading or writing that parameter. asynPortDriver maintains - a table of parameter values, associating each parameter number with a data type - (integer, double, or string), caching the current value, and maintaining a flag - indicating if a value has changed. Drivers use asynPortDriver methods to read the - current value from the table, and to set new values in the table. There is a method - to call all registered callbacks for values that have changed since callbacks were - last done. -
-- The following are the public definitions in the asynPortDriver class: -
-#define asynCommonMask 0x00000001
-#define asynDrvUserMask 0x00000002
-#define asynOptionMask 0x00000004
-#define asynInt32Mask 0x00000008
-#define asyUInt32DigitalMask 0x00000010
-#define asynFloat64Mask 0x00000020
-#define asynOctetMask 0x00000040
-#define asynInt8ArrayMask 0x00000080
-#define asynInt16ArrayMask 0x00000100
-#define asynInt32ArrayMask 0x00000200
-#define asynFloat32ArrayMask 0x00000400
-#define asynFloat64ArrayMask 0x00000800
-#define asynGenericPointerMask 0x00001000
-
-class asynPortDriver {
-public:
- asynPortDriver(const char *portName, int maxAddr, int paramTableSize, int interfaceMask, int interruptMask);
- virtual ~asynPortDriver();
- virtual asynStatus getAddress(asynUser *pasynUser, const char *functionName, int *address);
- virtual asynStatus findParam(asynParamString_t *paramTable, int numParams, const char *paramName, int *param);
- virtual asynStatus readInt32(asynUser *pasynUser, epicsInt32 *value);
- virtual asynStatus writeInt32(asynUser *pasynUser, epicsInt32 value);
- virtual asynStatus getBounds(asynUser *pasynUser, epicsInt32 *low, epicsInt32 *high);
- virtual asynStatus readFloat64(asynUser *pasynUser, epicsFloat64 *value);
- virtual asynStatus writeFloat64(asynUser *pasynUser, epicsFloat64 value);
- virtual asynStatus readOctet(asynUser *pasynUser, char *value, size_t maxChars,
- size_t *nActual, int *eomReason);
- virtual asynStatus writeOctet(asynUser *pasynUser, const char *value, size_t maxChars,
- size_t *nActual);
- virtual asynStatus readInt8Array(asynUser *pasynUser, epicsInt8 *value,
- size_t nElements, size_t *nIn);
- virtual asynStatus writeInt8Array(asynUser *pasynUser, epicsInt8 *value,
- size_t nElements);
- virtual asynStatus doCallbacksInt8Array(epicsInt8 *value,
- size_t nElements, int reason, int addr);
- virtual asynStatus readInt16Array(asynUser *pasynUser, epicsInt16 *value,
- size_t nElements, size_t *nIn);
- virtual asynStatus writeInt16Array(asynUser *pasynUser, epicsInt16 *value,
- size_t nElements);
- virtual asynStatus doCallbacksInt16Array(epicsInt16 *value,
- size_t nElements, int reason, int addr);
- virtual asynStatus readInt32Array(asynUser *pasynUser, epicsInt32 *value,
- size_t nElements, size_t *nIn);
- virtual asynStatus writeInt32Array(asynUser *pasynUser, epicsInt32 *value,
- size_t nElements);
- virtual asynStatus doCallbacksInt32Array(epicsInt32 *value,
- size_t nElements, int reason, int addr);
- virtual asynStatus readFloat32Array(asynUser *pasynUser, epicsFloat32 *value,
- size_t nElements, size_t *nIn);
- virtual asynStatus writeFloat32Array(asynUser *pasynUser, epicsFloat32 *value,
- size_t nElements);
- virtual asynStatus doCallbacksFloat32Array(epicsFloat32 *value,
- size_t nElements, int reason, int addr);
- virtual asynStatus readFloat64Array(asynUser *pasynUser, epicsFloat64 *value,
- size_t nElements, size_t *nIn);
- virtual asynStatus writeFloat64Array(asynUser *pasynUser, epicsFloat64 *value,
- size_t nElements);
- virtual asynStatus doCallbacksFloat64Array(epicsFloat64 *value,
- size_t nElements, int reason, int addr);
- virtual asynStatus readGenericPointer(asynUser *pasynUser, void *pointer);
- virtual asynStatus writeGenericPointer(asynUser *pasynUser, void *pointer);
- virtual asynStatus doCallbacksGenericPointer(void *pointer, int reason, int addr);
- virtual asynStatus drvUserCreate(asynUser *pasynUser, const char *drvInfo,
- const char **pptypeName, size_t *psize);
- virtual asynStatus drvUserGetType(asynUser *pasynUser,
- const char **pptypeName, size_t *psize);
- virtual asynStatus drvUserDestroy(asynUser *pasynUser);
- virtual void report(FILE *fp, int details);
- virtual asynStatus connect(asynUser *pasynUser);
- virtual asynStatus disconnect(asynUser *pasynUser);
-
- virtual asynStatus setIntegerParam(int index, int value);
- virtual asynStatus setIntegerParam(int list, int index, int value);
- virtual asynStatus setDoubleParam(int index, double value);
- virtual asynStatus setDoubleParam(int list, int index, double value);
- virtual asynStatus setStringParam(int index, const char *value);
- virtual asynStatus setStringParam(int list, int index, const char *value);
- virtual asynStatus getIntegerParam(int index, int * value);
- virtual asynStatus getIntegerParam(int list, int index, int * value);
- virtual asynStatus getDoubleParam(int index, double * value);
- virtual asynStatus getDoubleParam(int list, int index, double * value);
- virtual asynStatus getStringParam(int index, int maxChars, char *value);
- virtual asynStatus getStringParam(int list, int index, int maxChars, char *value);
- virtual asynStatus callParamCallbacks();
- virtual asynStatus callParamCallbacks(int list, int addr);
- virtual void reportParams();
-
- char *portName;
- int maxAddr;
- paramList **params;
- epicsMutexId mutexId;
-
- /* The asyn interfaces this driver implements */
- asynStandardInterfaces asynStdInterfaces;
-
- /* asynUser connected to ourselves for asynTrace */
- asynUser *pasynUserSelf;
-};
-
- - A brief explanation of the methods and data in this class is provided here. Users - should look at the example driver (simDetector) and plugins provided with areaDetector - for examples of how this class is used. -
-asynPortDriver(const char *portName, int maxAddr, int paramTableSize, int interfaceMask, int interruptMask); --
- This is the constructor for the class. -
-portName is the name of the asyn port for this driver or plugin.maxAddr is the maximum number of asyn addresses that this driver
- supports. This number returned by the pasynManager-> getAddr() function.
- Typically it is 1, but some plugins (e.g. NDPluginROI) support values > 1. This
- controls the number of parameter tables that are created.parmTableSize is the maximum number of parameters that this driver
- or plugin supports. This controls the size of the parameter tables.interfaceMask is a mask with each bit defining which asyn interfaces
- this driver or plugin supports. The bit mask values are defined in asynPortDriver.h,
- e.g. asynInt32Mask.interruptMask is a mask with each bit defining which of the asyn
- interfaces this driver or plugin supports can generate interrupts. The bit mask
- values are defined in asynPortDriver.h, e.g. asynInt8ArrayMask.virtual asynStatus getAddress(asynUser *pasynUser, const char *functionName, int *address); --
- Returns the value from pasynManager-> getAddr(pasynUser,...). Returns an error - if the address is not valid, e.g. >= this-> maxAddr. -
-virtual asynStatus readInt32(asynUser *pasynUser, epicsInt32 *value); - virtual asynStatus readFloat64(asynUser *pasynUser, epicsFloat64 *value); - virtual asynStatus readOctet(asynUser *pasynUser, char *value, size_t maxChars, - size_t *nActual, int *eomReason); --
- These methods are called by asyn clients to return the current cached value for
- the parameter indexed by pasynUser-> reason in the parameter table defined by
- getAddress(). Derived classed typically do not need to implement these
- methods.
-
virtual asynStatus writeInt32(asynUser *pasynUser, epicsInt32 value); - virtual asynStatus writeFloat64(asynUser *pasynUser, epicsFloat64 value); - virtual asynStatus writeOctet(asynUser *pasynUser, const char *value, size_t maxChars, - size_t *nActual); --
- These methods are called by asynClients to set the new value of a parameter. The - implementation of these methods in asynPortDriver copies the parameter into a cached - location for use by the asynRead(Int32, Float64, and Octet) methods. Most drivers - will provide their own implementations of these methods to do driver-dependent operations - when there is a new value of the parameter. -
-- virtual asynStatus readXXXArray(asynUser *pasynUser, epicsInt8 *value, - size_t nElements, size_t *nIn); - virtual asynStatus writeXXXArray(asynUser *pasynUser, epicsInt8 *value, - size_t nElements); - virtual asynStatus doCallbacksXXXArray(epicsInt8 *value, - size_t nElements, int reason, int addr); - virtual asynStatus readGenericPointer(asynUser *pasynUser, void *handle); - virtual asynStatus writeGenericPointer(asynUser *pasynUser, void *handle); - virtual asynStatus doCallbacksGenericPointer(void *handle, int reason, int addr); --
- where XXX=(Int8, Int16, Int32, Float32, or Float64). The readXXX and writeXXX methods
- only have stub methods that return an error in asynPortDriver, so they must be implemented
- in the derived classes if the corresponding interface is used. They are not pure
- virtual functions so that the derived class need not implement the interface if
- it is not used. The doCallbacksXXX methods in asynPortDriver call any registered
- asyn clients on the corresponding interface if the reason and addr
- values match. It typically does not need to be implemented in derived classes.
-
- virtual asynStatus findParam(asynParamString_t *paramTable, int numParams, const char *paramName, int *param); - virtual asynStatus drvUserCreate(asynUser *pasynUser, const char *drvInfo, - const char **pptypeName, size_t *psize); - virtual asynStatus drvUserGetType(asynUser *pasynUser, - const char **pptypeName, size_t *psize); - virtual asynStatus drvUserDestroy(asynUser *pasynUser); --
- drvUserCreate must be implemented in derived classes that use the parameter facilities
- of asynPortDriver. The findParam method is a convenience function that
- searches an array of {enum, string} structures and returns the enum (parameter number)
- matching the string. This is typically used in the implementation of drvUserCreate
- in derived classes. drvUserGetType and drvUserDestroy
- typically do not need to be implemented in derived classes.
-
- virtual void report(FILE *fp, int details); - virtual asynStatus connect(asynUser *pasynUser); - virtual asynStatus disconnect(asynUser *pasynUser); --
- The report function prints information on registered interrupt clients
- if details > 0, and prints parameter table information if details > 5. It is
- typically called by the implementation of report in derived classes
- before or after they print specific information about themselves. connect
- and disconnect call pasynManager-> exceptionConnect
- and pasynManager-> exceptionDisconnect respectively. Derived classes
- may or may not need to implement these functions.
-
- virtual asynStatus setIntegerParam(int index, int value); - virtual asynStatus setIntegerParam(int list, int index, int value); - virtual asynStatus setDoubleParam(int index, double value); - virtual asynStatus setDoubleParam(int list, int index, double value); - virtual asynStatus setStringParam(int index, const char *value); - virtual asynStatus setStringParam(int list, int index, const char *value); - virtual asynStatus getIntegerParam(int index, int * value); - virtual asynStatus getIntegerParam(int list, int index, int * value); - virtual asynStatus getDoubleParam(int index, double * value); - virtual asynStatus getDoubleParam(int list, int index, double * value); - virtual asynStatus getStringParam(int index, int maxChars, char *value); - virtual asynStatus getStringParam(int list, int index, int maxChars, char *value); - virtual asynStatus callParamCallbacks(); - virtual asynStatus callParamCallbacks(int list, int addr); --
- The setXXXParam methods set the value of a parameter in the parameter
- table in the object. If the value is different from the previous value of the parameter
- they also set the flag indicating that the value has changed. The getXXXParam
- methods return the current value of the parameter. There are two versions of the
- setXXXParam and getXXXParam methods, one with a list
- argument, and one without. The one without uses list=0, since there
- is often only a single parameter list (i.e. if maxAddr=1). The callParamCallbacks
- methods call back any registered clients for parameters that have changed since
- the last time callParamCallbacks was called. The version of callParamCallbacks
- with no arguments uses the first parameter list and matches asyn address=0. There
- is a second version of callParamCallbacks that takes an argument specifying
- the parameter list number, and the asyn address to match.
+ They inherit from the asynPortDriver
+ base C++ class that is provided in the asyn module. That base class handles
+ all of the details of registering the port driver, registering the supported interfaces,
+ and registering the required interrupt sources.
size is the number of elements in this dimension.offset is the starting element in this dimension relative to the
first element of the detector in unbinned units. If a selected region of the detector
- is being read, then this value may be > 0. The offset value is cumulative, so
+ is being read, then this value may be >0. The offset value is cumulative, so
if a plugin such as NDPluginROI further selects a subregion, the offset is relative
to the first element in the detector, and not to the first element of the region
passed to NDPluginROI.writeGenericPointer This method currently does nothing. Derived classes
must implement this method as required.report This method calls the report function in the asynPortDriver
- base class. It then calls the NDArrayPool->report() method if details > 5.