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