include/comedi.h

   1 /*
   2     include/comedi.h (installed as /usr/include/comedi.h)
   3     header file for comedi
   4
   5     COMEDI - Linux Control and Measurement Device Interface
   6     Copyright (C) 1998-2001 David A. Schleef <ds@schleef.org>
   7
   8     This program is free software; you can redistribute it and/or modify
   9     it under the terms of the GNU General Public License as published by
  10     the Free Software Foundation; either version 2 of the License, or
  11     (at your option) any later version.
  12
  13     This program is distributed in the hope that it will be useful,
  14     but WITHOUT ANY WARRANTY; without even the implied warranty of
  15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16     GNU General Public License for more details.
  17
  18     You should have received a copy of the GNU General Public License
  19     along with this program; if not, write to the Free Software
  20     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21
  22 */
  23
  24
  25 #ifndef _COMEDI_H
  26 #define _COMEDI_H
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 /* comedi's major device number */
  33 #define COMEDI_MAJOR 98
  34
  35 /*
  36    maximum number of minor devices.  This can be increased, although
  37    kernel structures are currently statically allocated, thus you
  38    don't want this to be much more than you actually use.
  39  */
  40 #define COMEDI_NDEVICES 4
  41
  42 /* number of config options in the config structure */
  43 #define COMEDI_NDEVCONFOPTS 32
  44 #define COMEDI_DEVCONF_AUX_DATA         30
  45 #define COMEDI_DEVCONF_AUX_DATA_LENGTH  31
  46
  47 /* max length of device and driver names */
  48 #define COMEDI_NAMELEN 20
  49
  50
  51 typedef unsigned int lsampl_t;
  52 typedef unsigned short sampl_t;
  53
  54 /* packs and unpacks a channel/range number */
  55
  56 #define CR_PACK(chan,rng,aref)          ( (((aref)&0x3)<<24) | (((rng)&0xff)<<16) | (chan) )
  57 #define CR_PACK_FLAGS(chan, range, aref, flags) (CR_PACK(chan, range, aref) | ((flags) & CR_FLAGS_MASK))
  58
  59 #define CR_CHAN(a)      ((a)&0xffff)
  60 #define CR_RANGE(a)     (((a)>>16)&0xff)
  61 #define CR_AREF(a)      (((a)>>24)&0x03)
  62
  63 #define CR_FLAGS_MASK   0xfc000000
  64 #define CR_ALT_FILTER   (1<<26)
  65 #define CR_DITHER               CR_ALT_FILTER
  66 #define CR_DEGLITCH             CR_ALT_FILTER
  67 #define CR_ALT_SOURCE   (1<<27)
  68 #define CR_EDGE (1<<30)
  69 #define CR_INVERT       (1<<31)
  70
  71 #define AREF_GROUND     0x00            /* analog ref = analog ground */
  72 #define AREF_COMMON     0x01            /* analog ref = analog common */
  73 #define AREF_DIFF       0x02            /* analog ref = differential */
  74 #define AREF_OTHER      0x03            /* analog ref = other (undefined) */
  75
  76 /* counters -- these are arbitrary values */
  77 #define GPCT_RESET              0x0001
  78 #define GPCT_SET_SOURCE         0x0002
  79 #define GPCT_SET_GATE           0x0004
  80 #define GPCT_SET_DIRECTION      0x0008
  81 #define GPCT_SET_OPERATION      0x0010
  82 #define GPCT_ARM                0x0020
  83 #define GPCT_DISARM             0x0040
  84 #define GPCT_GET_INT_CLK_FRQ    0x0080
  85
  86 #define GPCT_INT_CLOCK          0x0001
  87 #define GPCT_EXT_PIN            0x0002
  88 #define GPCT_NO_GATE            0x0004
  89 #define GPCT_UP                 0x0008
  90 #define GPCT_DOWN               0x0010
  91 #define GPCT_HWUD               0x0020
  92 #define GPCT_SIMPLE_EVENT       0x0040
  93 #define GPCT_SINGLE_PERIOD      0x0080
  94 #define GPCT_SINGLE_PW          0x0100
  95 #define GPCT_CONT_PULSE_OUT     0x0200
  96 #define GPCT_SINGLE_PULSE_OUT   0x0400
  97
  98
  99 /* instructions */
 100
 101 #define INSN_MASK_WRITE         0x8000000
 102 #define INSN_MASK_READ          0x4000000
 103 #define INSN_MASK_SPECIAL       0x2000000
 104
 105 #define INSN_READ               ( 0 | INSN_MASK_READ)
 106 #define INSN_WRITE              ( 1 | INSN_MASK_WRITE)
 107 #define INSN_BITS               ( 2 | INSN_MASK_READ|INSN_MASK_WRITE)
 108 #define INSN_CONFIG             ( 3 | INSN_MASK_READ|INSN_MASK_WRITE)
 109 #define INSN_GTOD               ( 4 | INSN_MASK_READ|INSN_MASK_SPECIAL)
 110 #define INSN_WAIT               ( 5 | INSN_MASK_WRITE|INSN_MASK_SPECIAL)
 111 #define INSN_INTTRIG            ( 6 | INSN_MASK_WRITE|INSN_MASK_SPECIAL)
 112
 113 /* trigger flags */
 114 /* These flags are used in comedi_trig structures */
 115
 116 #define TRIG_BOGUS      0x0001          /* do the motions */
 117 #define TRIG_DITHER     0x0002          /* enable dithering */
 118 #define TRIG_DEGLITCH   0x0004          /* enable deglitching */
 119 //#define TRIG_RT       0x0008          /* perform op in real time */
 120 #define TRIG_CONFIG     0x0010          /* perform configuration, not triggering */
 121 //#define TRIG_WAKE_EOS 0x0020          /* wake up on end-of-scan events */
 122 //#define TRIG_WRITE    0x0040          /* write to bidirectional devices */
 123
 124 /* command flags */
 125 /* These flags are used in comedi_cmd structures */
 126
 127 #define CMDF_PRIORITY           0x00000008 /* try to use a real-time interrupt while performing command */
 128
 129 #define TRIG_RT         CMDF_PRIORITY /* compatibility definition */
 130 #define TRIG_WAKE_EOS           0x00000020 /* legacy definition for COMEDI_EV_SCAN_END */
 131
 132 #define CMDF_WRITE              0x00000040
 133 #define TRIG_WRITE      CMDF_WRITE /* compatibility definition */
 134
 135 #define CMDF_RAWDATA            0x00000080
 136
 137 #define COMEDI_EV_START         0x00040000
 138 #define COMEDI_EV_SCAN_BEGIN    0x00080000
 139 #define COMEDI_EV_CONVERT       0x00100000
 140 #define COMEDI_EV_SCAN_END      0x00200000
 141 #define COMEDI_EV_STOP          0x00400000
 142
 143 #define TRIG_ROUND_MASK         0x00030000
 144 #define TRIG_ROUND_NEAREST      0x00000000
 145 #define TRIG_ROUND_DOWN         0x00010000
 146 #define TRIG_ROUND_UP           0x00020000
 147 #define TRIG_ROUND_UP_NEXT      0x00030000
 148
 149 /* trigger sources */
 150
 151 #define TRIG_ANY        0xffffffff
 152 #define TRIG_INVALID    0x00000000
 153
 154 #define TRIG_NONE       0x00000001      /* never trigger */
 155 #define TRIG_NOW        0x00000002      /* trigger now + N ns */
 156 #define TRIG_FOLLOW     0x00000004      /* trigger on next lower level trig */
 157 #define TRIG_TIME       0x00000008      /* trigger at time N ns */
 158 #define TRIG_TIMER      0x00000010      /* trigger at rate N ns */
 159 #define TRIG_COUNT      0x00000020      /* trigger when count reaches N */
 160 #define TRIG_EXT        0x00000040      /* trigger on external signal N */
 161 #define TRIG_INT        0x00000080      /* trigger on comedi-internal signal N */
 162 #define TRIG_OTHER      0x00000100      /* driver defined */
 163
 164 /* subdevice flags */
 165
 166 #define SDF_BUSY        0x0001          /* device is busy */
 167 #define SDF_BUSY_OWNER  0x0002          /* device is busy with your job */
 168 #define SDF_LOCKED      0x0004          /* subdevice is locked */
 169 #define SDF_LOCK_OWNER  0x0008          /* you own lock */
 170 #define SDF_MAXDATA     0x0010          /* maxdata depends on channel */
 171 #define SDF_FLAGS       0x0020          /* flags depend on channel */
 172 #define SDF_RANGETYPE   0x0040          /* range type depends on channel */
 173 #define SDF_MODE0       0x0080          /* can do mode 0 */
 174 #define SDF_MODE1       0x0100          /* can do mode 1 */
 175 #define SDF_MODE2       0x0200          /* can do mode 2 */
 176 #define SDF_MODE3       0x0400          /* can do mode 3 */
 177 #define SDF_MODE4       0x0800          /* can do mode 4 */
 178 #define SDF_CMD         0x1000          /* can do commands */
 179
 180 #define SDF_READABLE    0x00010000      /* subdevice can be read (e.g. analog input) */
 181 #define SDF_WRITABLE    0x00020000      /* subdevice can be written (e.g. analog output) */
 182 #define SDF_WRITEABLE   SDF_WRITABLE    /* spelling error in API */
 183 #define SDF_INTERNAL    0x00040000      /* subdevice does not have externally visible lines */
 184 #define SDF_RT          0x00080000      /* DEPRECATED: subdevice is RT capable */
 185 #define SDF_GROUND      0x00100000      /* can do aref=ground */
 186 #define SDF_COMMON      0x00200000      /* can do aref=common */
 187 #define SDF_DIFF        0x00400000      /* can do aref=diff */
 188 #define SDF_OTHER       0x00800000      /* can do aref=other */
 189 #define SDF_DITHER      0x01000000      /* can do dithering */
 190 #define SDF_DEGLITCH    0x02000000      /* can do deglitching */
 191 #define SDF_MMAP        0x04000000      /* can do mmap() */
 192 #define SDF_RUNNING     0x08000000      /* subdevice is acquiring data */
 193 #define SDF_LSAMPL      0x10000000      /* subdevice uses 32-bit samples */
 194 #define SDF_PACKED      0x20000000      /* subdevice can do packed DIO */
 195
 196 /* subdevice types */
 197
 198 #define COMEDI_SUBD_UNUSED              0       /* unused */
 199 #define COMEDI_SUBD_AI                  1       /* analog input */
 200 #define COMEDI_SUBD_AO                  2       /* analog output */
 201 #define COMEDI_SUBD_DI                  3       /* digital input */
 202 #define COMEDI_SUBD_DO                  4       /* digital output */
 203 #define COMEDI_SUBD_DIO                 5       /* digital input/output */
 204 #define COMEDI_SUBD_COUNTER             6       /* counter */
 205 #define COMEDI_SUBD_TIMER               7       /* timer */
 206 #define COMEDI_SUBD_MEMORY              8       /* memory, EEPROM, DPRAM */
 207 #define COMEDI_SUBD_CALIB               9       /* calibration DACs */
 208 #define COMEDI_SUBD_PROC                10      /* processor, DSP */
 209
 210 /* configuration instructions */
 211
 212 #define COMEDI_INPUT                    0
 213 #define COMEDI_OUTPUT                   1
 214 #define COMEDI_OPENDRAIN                2
 215
 216 #define INSN_CONFIG_ANALOG_TRIG         0x10
 217 //#define INSN_CONFIG_WAVEFORM          0x11
 218 //#define INSN_CONFIG_TRIG              0x12
 219 //#define INSN_CONFIG_COUNTER           0x13
 220 #define INSN_CONFIG_ALT_SOURCE          0x14
 221 #define INSN_CONFIG_DIGITAL_TRIG        0x15
 222 #define INSN_CONFIG_BLOCK_SIZE          0x16
 223 #define INSN_CONFIG_TIMER_1             0x17
 224 #define INSN_CONFIG_FILTER              0x18
 225 #define INSN_CONFIG_CHANGE_NOTIFY       0x19
 226
 227 /* ioctls */
 228
 229 #define CIO 'd'
 230 #define COMEDI_DEVCONFIG _IOW(CIO,0,comedi_devconfig)
 231 #define COMEDI_DEVINFO _IOR(CIO,1,comedi_devinfo)
 232 #define COMEDI_SUBDINFO _IOR(CIO,2,comedi_subdinfo)
 233 #define COMEDI_CHANINFO _IOR(CIO,3,comedi_chaninfo)
 234 #define COMEDI_TRIG _IOWR(CIO,4,comedi_trig)
 235 #define COMEDI_LOCK _IO(CIO,5)
 236 #define COMEDI_UNLOCK _IO(CIO,6)
 237 #define COMEDI_CANCEL _IO(CIO,7)
 238 #define COMEDI_RANGEINFO _IOR(CIO,8,comedi_rangeinfo)
 239 #define COMEDI_CMD _IOR(CIO,9,comedi_cmd)
 240 #define COMEDI_CMDTEST _IOR(CIO,10,comedi_cmd)
 241 #define COMEDI_INSNLIST _IOR(CIO,11,comedi_insnlist)
 242 #define COMEDI_INSN _IOR(CIO,12,comedi_insn)
 243 #define COMEDI_BUFCONFIG _IOR(CIO,13,comedi_bufconfig)
 244 #define COMEDI_BUFINFO _IOWR(CIO,14,comedi_bufinfo)
 245 #define COMEDI_POLL _IO(CIO,15)
 246
 247
 248 /* structures */
 249
 250 typedef struct comedi_trig_struct comedi_trig;
 251 typedef struct comedi_cmd_struct comedi_cmd;
 252 typedef struct comedi_insn_struct comedi_insn;
 253 typedef struct comedi_insnlist_struct comedi_insnlist;
 254 typedef struct comedi_chaninfo_struct comedi_chaninfo;
 255 typedef struct comedi_subdinfo_struct comedi_subdinfo;
 256 typedef struct comedi_devinfo_struct comedi_devinfo;
 257 typedef struct comedi_devconfig_struct comedi_devconfig;
 258 typedef struct comedi_rangeinfo_struct comedi_rangeinfo;
 259 typedef struct comedi_krange_struct comedi_krange;
 260 typedef struct comedi_bufconfig_struct comedi_bufconfig;
 261 typedef struct comedi_bufinfo_struct comedi_bufinfo;
 262
 263 struct comedi_trig_struct{
 264         unsigned int subdev;            /* subdevice */
 265         unsigned int mode;              /* mode */
 266         unsigned int flags;
 267         unsigned int n_chan;            /* number of channels */
 268         unsigned int *chanlist;         /* channel/range list */
 269         sampl_t *data;                  /* data list, size depends on subd flags */
 270         unsigned int n;                 /* number of scans */
 271         unsigned int trigsrc;
 272         unsigned int trigvar;
 273         unsigned int trigvar1;
 274         unsigned int data_len;
 275         unsigned int unused[3];
 276 };
 277
 278 struct comedi_insn_struct{
 279         unsigned int insn;
 280         unsigned int n;
 281         lsampl_t *data;
 282         unsigned int subdev;
 283         unsigned int chanspec;
 284         unsigned int unused[3];
 285 };
 286
 287 struct comedi_insnlist_struct{
 288         unsigned int n_insns;
 289         comedi_insn *insns;
 290 };
 291
 292 struct comedi_cmd_struct{
 293         unsigned int subdev;
 294         unsigned int flags;
 295
 296         unsigned int start_src;
 297         unsigned int start_arg;
 298
 299         unsigned int scan_begin_src;
 300         unsigned int scan_begin_arg;
 301
 302         unsigned int convert_src;
 303         unsigned int convert_arg;
 304
 305         unsigned int scan_end_src;
 306         unsigned int scan_end_arg;
 307
 308         unsigned int stop_src;
 309         unsigned int stop_arg;
 310
 311         unsigned int *chanlist;         /* channel/range list */
 312         unsigned int chanlist_len;
 313
 314         sampl_t *data;                  /* data list, size depends on subd flags */
 315         unsigned int data_len;
 316 };
 317
 318 struct comedi_chaninfo_struct{
 319         unsigned int subdev;
 320         lsampl_t *maxdata_list;
 321         unsigned int *flaglist;
 322         unsigned int *rangelist;
 323         unsigned int unused[4];
 324 };
 325
 326 struct comedi_rangeinfo_struct{
 327         unsigned int range_type;
 328         void *range_ptr;
 329 };
 330
 331 struct comedi_krange_struct{
 332         int min;        /* fixed point, multiply by 1e-6 */
 333         int max;        /* fixed point, multiply by 1e-6 */
 334         unsigned int flags;
 335 };
 336
 337 struct comedi_subdinfo_struct{
 338         unsigned int type;
 339         unsigned int n_chan;
 340         unsigned int subd_flags;
 341         unsigned int timer_type;
 342         unsigned int len_chanlist;
 343         lsampl_t        maxdata;
 344         unsigned int    flags;          /* channel flags */
 345         unsigned int    range_type;     /* lookup in kernel */
 346         unsigned int    settling_time_0;
 347         unsigned int unused[9];
 348 };
 349
 350 struct comedi_devinfo_struct{
 351         unsigned int version_code;
 352         unsigned int n_subdevs;
 353         char driver_name[COMEDI_NAMELEN];
 354         char board_name[COMEDI_NAMELEN];
 355         int read_subdevice;
 356         int write_subdevice;
 357         int unused[30];
 358 };
 359
 360 struct comedi_devconfig_struct{
 361         char board_name[COMEDI_NAMELEN];
 362         int options[COMEDI_NDEVCONFOPTS];
 363 };
 364
 365 struct comedi_bufconfig_struct{
 366         unsigned int subdevice;
 367         unsigned int flags;
 368
 369         unsigned int maximum_size;
 370         unsigned int size;
 371
 372         unsigned int unused[4];
 373 };
 374
 375 struct comedi_bufinfo_struct{
 376         unsigned int subdevice;
 377         unsigned int bytes_read;
 378
 379         unsigned int buf_int_ptr;
 380         unsigned int buf_user_ptr;
 381         unsigned int buf_int_count;
 382         unsigned int buf_user_count;
 383
 384         unsigned int bytes_written;
 385
 386         unsigned int unused[4];
 387 };
 388
 389 /* range stuff */
 390
 391 #define __RANGE(a,b)    ((((a)&0xffff)<<16)|((b)&0xffff))
 392
 393 #define RANGE_OFFSET(a)         (((a)>>16)&0xffff)
 394 #define RANGE_LENGTH(b)         ((b)&0xffff)
 395
 396 #define RF_UNIT(flags)          ((flags)&0xff)
 397 #define RF_EXTERNAL             (1<<8)
 398
 399 #define UNIT_volt               0
 400 #define UNIT_mA                 1
 401 #define UNIT_none               2
 402
 403 #define COMEDI_MIN_SPEED        ((unsigned int)0xffffffff)
 404
 405 /* callback stuff */
 406 /* only relevant to kernel modules. */
 407
 408 #define COMEDI_CB_EOS           1       /* end of scan */
 409 #define COMEDI_CB_EOA           2       /* end of acquisition */
 410 #define COMEDI_CB_BLOCK         4       /* DEPRECATED: convenient block size */
 411 #define COMEDI_CB_EOBUF         8       /* DEPRECATED: end of buffer */
 412 #define COMEDI_CB_ERROR         16      /* card error during acquisition */
 413 #define COMEDI_CB_OVERFLOW      32      /* buffer overflow/underflow */
 414
 415
 416 #ifdef __cplusplus
 417 }
 418 #endif
 419
 420 #endif /* _COMEDI_H */
 421