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