asyn  4-31
asynPortDriver.h
Go to the documentation of this file.
1 #ifndef asynPortDriver_H
2 #define asynPortDriver_H
3 
4 #include <vector>
5 #include <string>
6 
7 #include <epicsTypes.h>
8 #include <epicsMutex.h>
9 
10 #include <asynStandardInterfaces.h>
11 #include <asynParamType.h>
12 #include <paramErrors.h>
13 
14 class paramList;
15 
16 epicsShareFunc void* findAsynPortDriver(const char *portName);
17 typedef void (*userTimeStampFunction)(void *userPvt, epicsTimeStamp *pTimeStamp);
18 
19 #ifdef __cplusplus
20 
22 #define asynCommonMask 0x00000001
23 #define asynDrvUserMask 0x00000002
24 #define asynOptionMask 0x00000004
25 #define asynInt32Mask 0x00000008
26 #define asynUInt32DigitalMask 0x00000010
27 #define asynFloat64Mask 0x00000020
28 #define asynOctetMask 0x00000040
29 #define asynInt8ArrayMask 0x00000080
30 #define asynInt16ArrayMask 0x00000100
31 #define asynInt32ArrayMask 0x00000200
32 #define asynFloat32ArrayMask 0x00000400
33 #define asynFloat64ArrayMask 0x00000800
34 #define asynGenericPointerMask 0x00001000
35 #define asynEnumMask 0x00002000
36 
37 
38 
41 class epicsShareClass asynPortDriver {
42 public:
43  asynPortDriver(const char *portName, int maxAddr, int paramTableSize, int interfaceMask, int interruptMask,
44  int asynFlags, int autoConnect, int priority, int stackSize);
45  virtual ~asynPortDriver();
46  virtual asynStatus lock();
47  virtual asynStatus unlock();
48  virtual asynStatus getAddress(asynUser *pasynUser, int *address);
49  virtual asynStatus readInt32(asynUser *pasynUser, epicsInt32 *value);
50  virtual asynStatus writeInt32(asynUser *pasynUser, epicsInt32 value);
51  virtual asynStatus readUInt32Digital(asynUser *pasynUser, epicsUInt32 *value, epicsUInt32 mask);
52  virtual asynStatus writeUInt32Digital(asynUser *pasynUser, epicsUInt32 value, epicsUInt32 mask);
53  virtual asynStatus setInterruptUInt32Digital(asynUser *pasynUser, epicsUInt32 mask, interruptReason reason);
54  virtual asynStatus clearInterruptUInt32Digital(asynUser *pasynUser, epicsUInt32 mask);
55  virtual asynStatus getInterruptUInt32Digital(asynUser *pasynUser, epicsUInt32 *mask, interruptReason reason);
56  virtual asynStatus getBounds(asynUser *pasynUser, epicsInt32 *low, epicsInt32 *high);
57  virtual asynStatus readFloat64(asynUser *pasynUser, epicsFloat64 *value);
58  virtual asynStatus writeFloat64(asynUser *pasynUser, epicsFloat64 value);
59  virtual asynStatus readOctet(asynUser *pasynUser, char *value, size_t maxChars,
60  size_t *nActual, int *eomReason);
61  virtual asynStatus writeOctet(asynUser *pasynUser, const char *value, size_t maxChars,
62  size_t *nActual);
63  virtual asynStatus flushOctet(asynUser *pasynUser);
64  virtual asynStatus setInputEosOctet(asynUser *pasynUser, const char *eos, int eosLen);
65  virtual asynStatus getInputEosOctet(asynUser *pasynUser, char *eos, int eosSize, int *eosLen);
66  virtual asynStatus setOutputEosOctet(asynUser *pasynUser, const char *eos, int eosLen);
67  virtual asynStatus getOutputEosOctet(asynUser *pasynUser, char *eos, int eosSize, int *eosLen);
68  virtual asynStatus readInt8Array(asynUser *pasynUser, epicsInt8 *value,
69  size_t nElements, size_t *nIn);
70  virtual asynStatus writeInt8Array(asynUser *pasynUser, epicsInt8 *value,
71  size_t nElements);
72  virtual asynStatus doCallbacksInt8Array(epicsInt8 *value,
73  size_t nElements, int reason, int addr);
74  virtual asynStatus readInt16Array(asynUser *pasynUser, epicsInt16 *value,
75  size_t nElements, size_t *nIn);
76  virtual asynStatus writeInt16Array(asynUser *pasynUser, epicsInt16 *value,
77  size_t nElements);
78  virtual asynStatus doCallbacksInt16Array(epicsInt16 *value,
79  size_t nElements, int reason, int addr);
80  virtual asynStatus readInt32Array(asynUser *pasynUser, epicsInt32 *value,
81  size_t nElements, size_t *nIn);
82  virtual asynStatus writeInt32Array(asynUser *pasynUser, epicsInt32 *value,
83  size_t nElements);
84  virtual asynStatus doCallbacksInt32Array(epicsInt32 *value,
85  size_t nElements, int reason, int addr);
86  virtual asynStatus readFloat32Array(asynUser *pasynUser, epicsFloat32 *value,
87  size_t nElements, size_t *nIn);
88  virtual asynStatus writeFloat32Array(asynUser *pasynUser, epicsFloat32 *value,
89  size_t nElements);
90  virtual asynStatus doCallbacksFloat32Array(epicsFloat32 *value,
91  size_t nElements, int reason, int addr);
92  virtual asynStatus readFloat64Array(asynUser *pasynUser, epicsFloat64 *value,
93  size_t nElements, size_t *nIn);
94  virtual asynStatus writeFloat64Array(asynUser *pasynUser, epicsFloat64 *value,
95  size_t nElements);
96  virtual asynStatus doCallbacksFloat64Array(epicsFloat64 *value,
97  size_t nElements, int reason, int addr);
98  virtual asynStatus readGenericPointer(asynUser *pasynUser, void *pointer);
99  virtual asynStatus writeGenericPointer(asynUser *pasynUser, void *pointer);
100  virtual asynStatus doCallbacksGenericPointer(void *pointer, int reason, int addr);
101  virtual asynStatus readOption(asynUser *pasynUser, const char *key, char *value, int maxChars);
102  virtual asynStatus writeOption(asynUser *pasynUser, const char *key, const char *value);
103  virtual asynStatus readEnum(asynUser *pasynUser, char *strings[], int values[], int severities[], size_t nElements, size_t *nIn);
104  virtual asynStatus writeEnum(asynUser *pasynUser, char *strings[], int values[], int severities[], size_t nElements);
105  virtual asynStatus doCallbacksEnum(char *strings[], int values[], int severities[], size_t nElements, int reason, int addr);
106  virtual asynStatus drvUserCreate(asynUser *pasynUser, const char *drvInfo,
107  const char **pptypeName, size_t *psize);
108  virtual asynStatus drvUserGetType(asynUser *pasynUser,
109  const char **pptypeName, size_t *psize);
110  virtual asynStatus drvUserDestroy(asynUser *pasynUser);
111  virtual void report(FILE *fp, int details);
112  virtual asynStatus connect(asynUser *pasynUser);
113  virtual asynStatus disconnect(asynUser *pasynUser);
114 
115  virtual asynStatus createParam( const char *name, asynParamType type, int *index);
116  virtual asynStatus createParam(int list, const char *name, asynParamType type, int *index);
117  virtual asynStatus findParam( const char *name, int *index);
118  virtual asynStatus findParam(int list, const char *name, int *index);
119  virtual asynStatus getParamName( int index, const char **name);
120  virtual asynStatus getParamName(int list, int index, const char **name);
121  virtual asynStatus setParamStatus( int index, asynStatus status);
122  virtual asynStatus setParamStatus(int list, int index, asynStatus status);
123  virtual asynStatus getParamStatus( int index, asynStatus *status);
124  virtual asynStatus getParamStatus(int list, int index, asynStatus *status);
125  virtual asynStatus setParamAlarmStatus( int index, int status);
126  virtual asynStatus setParamAlarmStatus(int list, int index, int status);
127  virtual asynStatus getParamAlarmStatus( int index, int *status);
128  virtual asynStatus getParamAlarmStatus(int list, int index, int *status);
129  virtual asynStatus setParamAlarmSeverity( int index, int severity);
130  virtual asynStatus setParamAlarmSeverity(int list, int index, int severity);
131  virtual asynStatus getParamAlarmSeverity( int index, int *severity);
132  virtual asynStatus getParamAlarmSeverity(int list, int index, int *severity);
133  virtual void reportSetParamErrors(asynStatus status, int index, int list, const char *functionName);
134  virtual void reportGetParamErrors(asynStatus status, int index, int list, const char *functionName);
135  virtual asynStatus setIntegerParam( int index, int value);
136  virtual asynStatus setIntegerParam(int list, int index, int value);
137  virtual asynStatus setUIntDigitalParam( int index, epicsUInt32 value, epicsUInt32 valueMask);
138  virtual asynStatus setUIntDigitalParam(int list, int index, epicsUInt32 value, epicsUInt32 valueMask);
139  virtual asynStatus setUIntDigitalParam( int index, epicsUInt32 value, epicsUInt32 valueMask, epicsUInt32 interruptMask);
140  virtual asynStatus setUIntDigitalParam(int list, int index, epicsUInt32 value, epicsUInt32 valueMask, epicsUInt32 interruptMask);
141  virtual asynStatus setUInt32DigitalInterrupt( int index, epicsUInt32 mask, interruptReason reason);
142  virtual asynStatus setUInt32DigitalInterrupt(int list, int index, epicsUInt32 mask, interruptReason reason);
143  virtual asynStatus clearUInt32DigitalInterrupt( int index, epicsUInt32 mask);
144  virtual asynStatus clearUInt32DigitalInterrupt(int list, int index, epicsUInt32 mask);
145  virtual asynStatus getUInt32DigitalInterrupt( int index, epicsUInt32 *mask, interruptReason reason);
146  virtual asynStatus getUInt32DigitalInterrupt(int list, int index, epicsUInt32 *mask, interruptReason reason);
147  virtual asynStatus setDoubleParam( int index, double value);
148  virtual asynStatus setDoubleParam(int list, int index, double value);
149  virtual asynStatus setStringParam( int index, const char *value);
150  virtual asynStatus setStringParam(int list, int index, const char *value);
151  virtual asynStatus setStringParam( int index, const std::string& value);
152  virtual asynStatus setStringParam(int list, int index, const std::string& value);
153  virtual asynStatus getIntegerParam( int index, int * value);
154  virtual asynStatus getIntegerParam(int list, int index, int * value);
155  virtual asynStatus getUIntDigitalParam( int index, epicsUInt32 *value, epicsUInt32 mask);
156  virtual asynStatus getUIntDigitalParam(int list, int index, epicsUInt32 *value, epicsUInt32 mask);
157  virtual asynStatus getDoubleParam( int index, double * value);
158  virtual asynStatus getDoubleParam(int list, int index, double * value);
159  virtual asynStatus getStringParam( int index, int maxChars, char *value);
160  virtual asynStatus getStringParam(int list, int index, int maxChars, char *value);
161  virtual asynStatus getStringParam( int index, std::string& value);
162  virtual asynStatus getStringParam(int list, int index, std::string& value);
163  virtual asynStatus callParamCallbacks();
164  virtual asynStatus callParamCallbacks( int addr);
165  virtual asynStatus callParamCallbacks(int list, int addr);
166  virtual asynStatus updateTimeStamp();
167  virtual asynStatus updateTimeStamp(epicsTimeStamp *pTimeStamp);
168  virtual asynStatus getTimeStamp(epicsTimeStamp *pTimeStamp);
169  virtual asynStatus setTimeStamp(const epicsTimeStamp *pTimeStamp);
170  asynStandardInterfaces *getAsynStdInterfaces();
171  virtual void reportParams(FILE *fp, int details);
172 
173  char *portName;
175  int maxAddr;
176  void callbackTask();
177 
178 protected:
179  asynUser *pasynUserSelf;
180  asynStandardInterfaces asynStdInterfaces;
182 private:
183  std::vector<paramList*> params;
184  epicsMutexId mutexId;
185  char *inputEosOctet;
186  int inputEosLenOctet;
187  char *outputEosOctet;
188  int outputEosLenOctet;
189  template <typename epicsType, typename interruptType>
190  asynStatus doCallbacksArray(epicsType *value, size_t nElements,
191  int reason, int address, void *interruptPvt);
192 
193  friend class paramList;
194 };
195 
196 #endif /* cplusplus */
197 
198 #endif
paramList
Class to support parameter library (also called parameter list); set and get values indexed by parame...
Definition: asynPortDriver.cpp:47
asynParamType
asynParamType
Parameter data types for the parameter library.
Definition: asynParamType.h:12
asynPortDriver
Base class for asyn port drivers; handles most of the bookkeeping for writing an asyn port driver wit...
Definition: asynPortDriver.h:41
asynPortDriver::portName
char * portName
The name of this asyn port.
Definition: asynPortDriver.h:173
userTimeStampFunction
void(* userTimeStampFunction)(void *userPvt, epicsTimeStamp *pTimeStamp)
Definition: asynPortDriver.h:17
asynPortDriver::asynStdInterfaces
asynStandardInterfaces asynStdInterfaces
The asyn interfaces this driver implements.
Definition: asynPortDriver.h:180
findAsynPortDriver
void * findAsynPortDriver(const char *portName)
Utility function that returns a pointer to an asynPortDriver object from its name.
Definition: asynPortDriver.cpp:3379
asynPortDriver::pasynUserSelf
asynUser * pasynUserSelf
asynUser connected to ourselves for asynTrace
Definition: asynPortDriver.h:179
asynPortDriver::maxAddr
int maxAddr
The maximum asyn address (addr) supported by this driver.
Definition: asynPortDriver.h:175
Generated by   doxygen 1.8.5