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 Lesser 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 #ifndef _COMEDI_H
  25 #define _COMEDI_H
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #if 0
  30 } /* avoid confusing editor auto-indent */
  31 #endif
  32 #endif
  33
  34 /* comedi's major device number */
  35 #define COMEDI_MAJOR 98
  36
  37 /*
  38    maximum number of minor devices.  This can be increased, although
  39    kernel structures are currently statically allocated, thus you
  40    don't want this to be much more than you actually use.
  41  */
  42 #define COMEDI_NDEVICES 16
  43
  44 /* number of config options in the config structure */
  45 #define COMEDI_NDEVCONFOPTS 32
  46 /*length of nth chunk of firmware data*/
  47 #define COMEDI_DEVCONF_AUX_DATA3_LENGTH         25
  48 #define COMEDI_DEVCONF_AUX_DATA2_LENGTH         26
  49 #define COMEDI_DEVCONF_AUX_DATA1_LENGTH         27
  50 #define COMEDI_DEVCONF_AUX_DATA0_LENGTH         28
  51 #define COMEDI_DEVCONF_AUX_DATA_HI              29      /*most significant 32 bits of pointer address (if needed) */
  52 #define COMEDI_DEVCONF_AUX_DATA_LO              30      /*least significant 32 bits of pointer address */
  53 #define COMEDI_DEVCONF_AUX_DATA_LENGTH  31      /* total data length */
  54
  55 /* max length of device and driver names */
  56 #define COMEDI_NAMELEN 20
  57
  58 typedef unsigned int lsampl_t;
  59 typedef unsigned short sampl_t;
  60
  61 /* packs and unpacks a channel/range number */
  62
  63 #define CR_PACK(chan,rng,aref)          ( (((aref)&0x3)<<24) | (((rng)&0xff)<<16) | (chan) )
  64 #define CR_PACK_FLAGS(chan, range, aref, flags) (CR_PACK(chan, range, aref) | ((flags) & CR_FLAGS_MASK))
  65
  66 #define CR_CHAN(a)      ((a)&0xffff)
  67 #define CR_RANGE(a)     (((a)>>16)&0xff)
  68 #define CR_AREF(a)      (((a)>>24)&0x03)
  69
  70 #define CR_FLAGS_MASK   0xfc000000
  71 #define CR_ALT_FILTER   (1<<26)
  72 #define CR_DITHER               CR_ALT_FILTER
  73 #define CR_DEGLITCH             CR_ALT_FILTER
  74 #define CR_ALT_SOURCE   (1<<27)
  75 #define CR_EDGE (1<<30)
  76 #define CR_INVERT       (1<<31)
  77
  78 #define AREF_GROUND     0x00    /* analog ref = analog ground */
  79 #define AREF_COMMON     0x01    /* analog ref = analog common */
  80 #define AREF_DIFF       0x02    /* analog ref = differential */
  81 #define AREF_OTHER      0x03    /* analog ref = other (undefined) */
  82
  83 /* counters -- these are arbitrary values */
  84 #define GPCT_RESET              0x0001
  85 #define GPCT_SET_SOURCE         0x0002
  86 #define GPCT_SET_GATE           0x0004
  87 #define GPCT_SET_DIRECTION      0x0008
  88 #define GPCT_SET_OPERATION      0x0010
  89 #define GPCT_ARM                0x0020
  90 #define GPCT_DISARM             0x0040
  91 #define GPCT_GET_INT_CLK_FRQ    0x0080
  92
  93 #define GPCT_INT_CLOCK          0x0001
  94 #define GPCT_EXT_PIN            0x0002
  95 #define GPCT_NO_GATE            0x0004
  96 #define GPCT_UP                 0x0008
  97 #define GPCT_DOWN               0x0010
  98 #define GPCT_HWUD               0x0020
  99 #define GPCT_SIMPLE_EVENT       0x0040
 100 #define GPCT_SINGLE_PERIOD      0x0080
 101 #define GPCT_SINGLE_PW          0x0100
 102 #define GPCT_CONT_PULSE_OUT     0x0200
 103 #define GPCT_SINGLE_PULSE_OUT   0x0400
 104
 105 /* instructions */
 106
 107 #define INSN_MASK_WRITE         0x8000000
 108 #define INSN_MASK_READ          0x4000000
 109 #define INSN_MASK_SPECIAL       0x2000000
 110
 111 #define INSN_READ               ( 0 | INSN_MASK_READ)
 112 #define INSN_WRITE              ( 1 | INSN_MASK_WRITE)
 113 #define INSN_BITS               ( 2 | INSN_MASK_READ|INSN_MASK_WRITE)
 114 #define INSN_CONFIG             ( 3 | INSN_MASK_READ|INSN_MASK_WRITE)
 115 #define INSN_GTOD               ( 4 | INSN_MASK_READ|INSN_MASK_SPECIAL)
 116 #define INSN_WAIT               ( 5 | INSN_MASK_WRITE|INSN_MASK_SPECIAL)
 117 #define INSN_INTTRIG            ( 6 | INSN_MASK_WRITE|INSN_MASK_SPECIAL)
 118
 119 /* trigger flags */
 120 /* These flags are used in comedi_trig structures */
 121
 122 #define TRIG_BOGUS      0x0001  /* do the motions */
 123 #define TRIG_DITHER     0x0002  /* enable dithering */
 124 #define TRIG_DEGLITCH   0x0004  /* enable deglitching */
 125 //#define TRIG_RT       0x0008          /* perform op in real time */
 126 #define TRIG_CONFIG     0x0010  /* perform configuration, not triggering */
 127 #define TRIG_WAKE_EOS   0x0020  /* wake up on end-of-scan events */
 128 //#define TRIG_WRITE    0x0040          /* write to bidirectional devices */
 129
 130 /* command flags */
 131 /* These flags are used in comedi_cmd structures */
 132
 133 #define CMDF_PRIORITY           0x00000008      /* try to use a real-time interrupt while performing command */
 134
 135 #define TRIG_RT         CMDF_PRIORITY   /* compatibility definition */
 136
 137 #define CMDF_WRITE              0x00000040
 138 #define TRIG_WRITE      CMDF_WRITE      /* compatibility definition */
 139
 140 #define CMDF_RAWDATA            0x00000080
 141
 142 #define COMEDI_EV_START         0x00040000
 143 #define COMEDI_EV_SCAN_BEGIN    0x00080000
 144 #define COMEDI_EV_CONVERT       0x00100000
 145 #define COMEDI_EV_SCAN_END      0x00200000
 146 #define COMEDI_EV_STOP          0x00400000
 147
 148 #define TRIG_ROUND_MASK         0x00030000
 149 #define TRIG_ROUND_NEAREST      0x00000000
 150 #define TRIG_ROUND_DOWN         0x00010000
 151 #define TRIG_ROUND_UP           0x00020000
 152 #define TRIG_ROUND_UP_NEXT      0x00030000
 153
 154 /* trigger sources */
 155
 156 #define TRIG_ANY        0xffffffff
 157 #define TRIG_INVALID    0x00000000
 158
 159 #define TRIG_NONE       0x00000001      /* never trigger */
 160 #define TRIG_NOW        0x00000002      /* trigger now + N ns */
 161 #define TRIG_FOLLOW     0x00000004      /* trigger on next lower level trig */
 162 #define TRIG_TIME       0x00000008      /* trigger at time N ns */
 163 #define TRIG_TIMER      0x00000010      /* trigger at rate N ns */
 164 #define TRIG_COUNT      0x00000020      /* trigger when count reaches N */
 165 #define TRIG_EXT        0x00000040      /* trigger on external signal N */
 166 #define TRIG_INT        0x00000080      /* trigger on comedi-internal signal N */
 167 #define TRIG_OTHER      0x00000100      /* driver defined */
 168
 169 /* subdevice flags */
 170
 171 #define SDF_BUSY        0x0001  /* device is busy */
 172 #define SDF_BUSY_OWNER  0x0002  /* device is busy with your job */
 173 #define SDF_LOCKED      0x0004  /* subdevice is locked */
 174 #define SDF_LOCK_OWNER  0x0008  /* you own lock */
 175 #define SDF_MAXDATA     0x0010  /* maxdata depends on channel */
 176 #define SDF_FLAGS       0x0020  /* flags depend on channel */
 177 #define SDF_RANGETYPE   0x0040  /* range type depends on channel */
 178 #define SDF_MODE0       0x0080  /* can do mode 0 */
 179 #define SDF_MODE1       0x0100  /* can do mode 1 */
 180 #define SDF_MODE2       0x0200  /* can do mode 2 */
 181 #define SDF_MODE3       0x0400  /* can do mode 3 */
 182 #define SDF_MODE4       0x0800  /* can do mode 4 */
 183 #define SDF_CMD         0x1000  /* can do commands (deprecated) */
 184 #define SDF_SOFT_CALIBRATED     0x2000  /* subdevice uses software calibration */
 185 #define SDF_CMD_WRITE           0x4000  /* can do output commands */
 186 #define SDF_CMD_READ            0x8000  /* can do input commands */
 187
 188 #define SDF_READABLE    0x00010000      /* subdevice can be read (e.g. analog input) */
 189 #define SDF_WRITABLE    0x00020000      /* subdevice can be written (e.g. analog output) */
 190 #define SDF_WRITEABLE   SDF_WRITABLE    /* spelling error in API */
 191 #define SDF_INTERNAL    0x00040000      /* subdevice does not have externally visible lines */
 192 #define SDF_RT          0x00080000      /* DEPRECATED: subdevice is RT capable */
 193 #define SDF_GROUND      0x00100000      /* can do aref=ground */
 194 #define SDF_COMMON      0x00200000      /* can do aref=common */
 195 #define SDF_DIFF        0x00400000      /* can do aref=diff */
 196 #define SDF_OTHER       0x00800000      /* can do aref=other */
 197 #define SDF_DITHER      0x01000000      /* can do dithering */
 198 #define SDF_DEGLITCH    0x02000000      /* can do deglitching */
 199 #define SDF_MMAP        0x04000000      /* can do mmap() */
 200 #define SDF_RUNNING     0x08000000      /* subdevice is acquiring data */
 201 #define SDF_LSAMPL      0x10000000      /* subdevice uses 32-bit samples */
 202 #define SDF_PACKED      0x20000000      /* subdevice can do packed DIO */
 203 /* re recyle these flags for PWM */
 204 #define SDF_PWM_COUNTER SDF_MODE0       /* PWM can automatically switch off */
 205 #define SDF_PWM_HBRIDGE SDF_MODE1       /* PWM is signed (H-bridge) */
 206
 207
 208
 209 /* subdevice types */
 210
 211 enum comedi_subdevice_type {
 212         COMEDI_SUBD_UNUSED,     /* unused by driver */
 213         COMEDI_SUBD_AI, /* analog input */
 214         COMEDI_SUBD_AO, /* analog output */
 215         COMEDI_SUBD_DI, /* digital input */
 216         COMEDI_SUBD_DO, /* digital output */
 217         COMEDI_SUBD_DIO,        /* digital input/output */
 218         COMEDI_SUBD_COUNTER,    /* counter */
 219         COMEDI_SUBD_TIMER,      /* timer */
 220         COMEDI_SUBD_MEMORY,     /* memory, EEPROM, DPRAM */
 221         COMEDI_SUBD_CALIB,      /* calibration DACs */
 222         COMEDI_SUBD_PROC,       /* processor, DSP */
 223         COMEDI_SUBD_SERIAL,     /* serial IO */
 224         COMEDI_SUBD_PWM         /* PWM */
 225 };
 226
 227 /* configuration instructions */
 228
 229 enum configuration_ids {
 230         INSN_CONFIG_DIO_INPUT = 0,
 231         INSN_CONFIG_DIO_OUTPUT = 1,
 232         INSN_CONFIG_DIO_OPENDRAIN = 2,
 233         INSN_CONFIG_ANALOG_TRIG = 16,
 234 //      INSN_CONFIG_WAVEFORM = 17,
 235 //      INSN_CONFIG_TRIG = 18,
 236 //      INSN_CONFIG_COUNTER = 19,
 237         INSN_CONFIG_ALT_SOURCE = 20,
 238         INSN_CONFIG_DIGITAL_TRIG = 21,
 239         INSN_CONFIG_BLOCK_SIZE = 22,
 240         INSN_CONFIG_TIMER_1 = 23,
 241         INSN_CONFIG_FILTER = 24,
 242         INSN_CONFIG_CHANGE_NOTIFY = 25,
 243
 244          /*ALPHA*/ INSN_CONFIG_SERIAL_CLOCK = 26,
 245         INSN_CONFIG_BIDIRECTIONAL_DATA = 27,
 246         INSN_CONFIG_DIO_QUERY = 28,
 247         INSN_CONFIG_PWM_OUTPUT = 29,
 248         INSN_CONFIG_GET_PWM_OUTPUT = 30,
 249         INSN_CONFIG_ARM = 31,
 250         INSN_CONFIG_DISARM = 32,
 251         INSN_CONFIG_GET_COUNTER_STATUS = 33,
 252         INSN_CONFIG_RESET = 34,
 253         INSN_CONFIG_GPCT_SINGLE_PULSE_GENERATOR = 1001, // Use CTR as single pulsegenerator
 254         INSN_CONFIG_GPCT_PULSE_TRAIN_GENERATOR = 1002,  // Use CTR as pulsetraingenerator
 255         INSN_CONFIG_GPCT_QUADRATURE_ENCODER = 1003,     // Use the counter as encoder
 256         INSN_CONFIG_SET_GATE_SRC = 2001,        // Set gate source
 257         INSN_CONFIG_GET_GATE_SRC = 2002,        // Get gate source
 258         INSN_CONFIG_SET_CLOCK_SRC = 2003,       // Set master clock source
 259         INSN_CONFIG_GET_CLOCK_SRC = 2004,       // Get master clock source
 260         INSN_CONFIG_SET_OTHER_SRC = 2005,       // Set other source
 261 //      INSN_CONFIG_GET_OTHER_SRC = 2006,       // Get other source
 262         INSN_CONFIG_GET_HARDWARE_BUFFER_SIZE = 2006,    // Get size in bytes of subdevice's on-board fifos used during streaming input/output
 263         INSN_CONFIG_SET_COUNTER_MODE = 4097,
 264         INSN_CONFIG_8254_SET_MODE = INSN_CONFIG_SET_COUNTER_MODE,       /* deprecated */
 265         INSN_CONFIG_8254_READ_STATUS = 4098,
 266         INSN_CONFIG_SET_ROUTING = 4099,
 267         INSN_CONFIG_GET_ROUTING = 4109,
 268 /* PWM */
 269         INSN_CONFIG_PWM_SET_PERIOD = 5000,   /* sets frequency */
 270         INSN_CONFIG_PWM_GET_PERIOD = 5001,   /* gets frequency */
 271         INSN_CONFIG_GET_PWM_STATUS = 5002,          /* is it running? */
 272         INSN_CONFIG_PWM_SET_H_BRIDGE = 5003, /* sets H bridge: duty cycle and sign bit for a relay  at the same time*/
 273         INSN_CONFIG_PWM_GET_H_BRIDGE = 5004  /* gets H bridge data: duty cycle and the sign bit */
 274 };
 275
 276 /*
 277  * Settings for INSN_CONFIG_DIGITAL_TRIG:
 278  * data[0] = INSN_CONFIG_DIGITAL_TRIG
 279  * data[1] = trigger ID
 280  * data[2] = configuration operation
 281  * data[3] = configuration parameter 1
 282  * data[4] = configuration parameter 2
 283  * data[5] = configuration parameter 3
 284  *
 285  * operation                           parameter 1   parameter 2   parameter 3
 286  * ---------------------------------   -----------   -----------   -----------
 287  * COMEDI_DIGITAL_TRIG_DISABLE
 288  * COMEDI_DIGITAL_TRIG_ENABLE_EDGES    left-shift    rising-edges  falling-edges
 289  * COMEDI_DIGITAL_TRIG_ENABLE_LEVELS   left-shift    high-levels   low-levels
 290  *
 291  * COMEDI_DIGITAL_TRIG_DISABLE returns the trigger to its default, inactive,
 292  * unconfigured state.
 293  *
 294  * COMEDI_DIGITAL_TRIG_ENABLE_EDGES sets the rising and/or falling edge inputs
 295  * that each can fire the trigger.
 296  *
 297  * COMEDI_DIGITAL_TRIG_ENABLE_LEVELS sets a combination of high and/or low
 298  * level inputs that can fire the trigger.
 299  *
 300  * "left-shift" is useful if the trigger has more than 32 inputs to specify the
 301  * first input for this configuration.
 302  *
 303  * Some sequences of INSN_CONFIG_DIGITAL_TRIG instructions may have a (partly)
 304  * accumulative effect, depending on the low-level driver.  This is useful
 305  * when setting up a trigger that has more than 32 inputs or has a combination
 306  * of edge and level triggered inputs.
 307  */
 308 enum comedi_digital_trig_op {
 309         COMEDI_DIGITAL_TRIG_DISABLE = 0,
 310         COMEDI_DIGITAL_TRIG_ENABLE_EDGES = 1,
 311         COMEDI_DIGITAL_TRIG_ENABLE_LEVELS = 2
 312 };
 313
 314 enum comedi_io_direction {
 315         COMEDI_INPUT = 0,
 316         COMEDI_OUTPUT = 1,
 317         COMEDI_OPENDRAIN = 2
 318 };
 319
 320 enum comedi_support_level
 321 {
 322         COMEDI_UNKNOWN_SUPPORT = 0,
 323         COMEDI_SUPPORTED,
 324         COMEDI_UNSUPPORTED
 325 };
 326
 327 /* ioctls */
 328
 329 #define CIO 'd'
 330 #define COMEDI_DEVCONFIG _IOW(CIO,0,comedi_devconfig)
 331 #define COMEDI_DEVINFO _IOR(CIO,1,comedi_devinfo)
 332 #define COMEDI_SUBDINFO _IOR(CIO,2,comedi_subdinfo)
 333 #define COMEDI_CHANINFO _IOR(CIO,3,comedi_chaninfo)
 334 #define COMEDI_TRIG _IOWR(CIO,4,comedi_trig)
 335 #define COMEDI_LOCK _IO(CIO,5)
 336 #define COMEDI_UNLOCK _IO(CIO,6)
 337 #define COMEDI_CANCEL _IO(CIO,7)
 338 #define COMEDI_RANGEINFO _IOR(CIO,8,comedi_rangeinfo)
 339 #define COMEDI_CMD _IOR(CIO,9,comedi_cmd)
 340 #define COMEDI_CMDTEST _IOR(CIO,10,comedi_cmd)
 341 #define COMEDI_INSNLIST _IOR(CIO,11,comedi_insnlist)
 342 #define COMEDI_INSN _IOR(CIO,12,comedi_insn)
 343 #define COMEDI_BUFCONFIG _IOR(CIO,13,comedi_bufconfig)
 344 #define COMEDI_BUFINFO _IOWR(CIO,14,comedi_bufinfo)
 345 #define COMEDI_POLL _IO(CIO,15)
 346
 347 /* structures */
 348
 349 typedef struct comedi_trig_struct comedi_trig;
 350 typedef struct comedi_cmd_struct comedi_cmd;
 351 typedef struct comedi_insn_struct comedi_insn;
 352 typedef struct comedi_insnlist_struct comedi_insnlist;
 353 typedef struct comedi_chaninfo_struct comedi_chaninfo;
 354 typedef struct comedi_subdinfo_struct comedi_subdinfo;
 355 typedef struct comedi_devinfo_struct comedi_devinfo;
 356 typedef struct comedi_devconfig_struct comedi_devconfig;
 357 typedef struct comedi_rangeinfo_struct comedi_rangeinfo;
 358 typedef struct comedi_krange_struct comedi_krange;
 359 typedef struct comedi_bufconfig_struct comedi_bufconfig;
 360 typedef struct comedi_bufinfo_struct comedi_bufinfo;
 361
 362 struct comedi_trig_struct {
 363         unsigned int subdev;    /* subdevice */
 364         unsigned int mode;      /* mode */
 365         unsigned int flags;
 366         unsigned int n_chan;    /* number of channels */
 367         unsigned int *chanlist; /* channel/range list */
 368         sampl_t *data;  /* data list, size depends on subd flags */
 369         unsigned int n; /* number of scans */
 370         unsigned int trigsrc;
 371         unsigned int trigvar;
 372         unsigned int trigvar1;
 373         unsigned int data_len;
 374         unsigned int unused[3];
 375 };
 376
 377 struct comedi_insn_struct {
 378         unsigned int insn;
 379         unsigned int n;
 380         lsampl_t *data;
 381         unsigned int subdev;
 382         unsigned int chanspec;
 383         unsigned int unused[3];
 384 };
 385
 386 struct comedi_insnlist_struct {
 387         unsigned int n_insns;
 388         comedi_insn *insns;
 389 };
 390
 391 struct comedi_cmd_struct {
 392         unsigned int subdev;
 393         unsigned int flags;
 394
 395         unsigned int start_src;
 396         unsigned int start_arg;
 397
 398         unsigned int scan_begin_src;
 399         unsigned int scan_begin_arg;
 400
 401         unsigned int convert_src;
 402         unsigned int convert_arg;
 403
 404         unsigned int scan_end_src;
 405         unsigned int scan_end_arg;
 406
 407         unsigned int stop_src;
 408         unsigned int stop_arg;
 409
 410         unsigned int *chanlist; /* channel/range list */
 411         unsigned int chanlist_len;
 412
 413         sampl_t *data;  /* data list, size depends on subd flags */
 414         unsigned int data_len;
 415 };
 416
 417 struct comedi_chaninfo_struct {
 418         unsigned int subdev;
 419         lsampl_t *maxdata_list;
 420         unsigned int *flaglist;
 421         unsigned int *rangelist;
 422         unsigned int unused[4];
 423 };
 424
 425 struct comedi_rangeinfo_struct {
 426         unsigned int range_type;
 427         void *range_ptr;
 428 };
 429
 430 struct comedi_krange_struct {
 431         int min;        /* fixed point, multiply by 1e-6 */
 432         int max;        /* fixed point, multiply by 1e-6 */
 433         unsigned int flags;
 434 };
 435
 436
 437 struct comedi_subdinfo_struct {
 438         unsigned int type;
 439         unsigned int n_chan;
 440         unsigned int subd_flags;
 441         unsigned int timer_type;
 442         unsigned int len_chanlist;
 443         lsampl_t maxdata;
 444         unsigned int flags;     /* channel flags */
 445         unsigned int range_type;        /* lookup in kernel */
 446         unsigned int settling_time_0;
 447         unsigned insn_bits_support;     /* see support_level enum for values*/
 448         unsigned int unused[8];
 449 };
 450
 451 struct comedi_devinfo_struct {
 452         unsigned int version_code;
 453         unsigned int n_subdevs;
 454         char driver_name[COMEDI_NAMELEN];
 455         char board_name[COMEDI_NAMELEN];
 456         int read_subdevice;
 457         int write_subdevice;
 458         int unused[30];
 459 };
 460
 461 struct comedi_devconfig_struct {
 462         char board_name[COMEDI_NAMELEN];
 463         int options[COMEDI_NDEVCONFOPTS];
 464 };
 465
 466 struct comedi_bufconfig_struct {
 467         unsigned int subdevice;
 468         unsigned int flags;
 469
 470         unsigned int maximum_size;
 471         unsigned int size;
 472
 473         unsigned int unused[4];
 474 };
 475
 476 struct comedi_bufinfo_struct {
 477         unsigned int subdevice;
 478         unsigned int bytes_read;
 479
 480         unsigned int buf_write_ptr;
 481         unsigned int buf_read_ptr;
 482         unsigned int buf_write_count;
 483         unsigned int buf_read_count;
 484
 485         unsigned int bytes_written;
 486
 487         unsigned int unused[4];
 488 };
 489
 490 /* range stuff */
 491
 492 #define __RANGE(a,b)    ((((a)&0xffff)<<16)|((b)&0xffff))
 493
 494 #define RANGE_OFFSET(a)         (((a)>>16)&0xffff)
 495 #define RANGE_LENGTH(b)         ((b)&0xffff)
 496
 497 #define RF_UNIT(flags)          ((flags)&0xff)
 498 #define RF_EXTERNAL             (1<<8)
 499
 500 #define UNIT_volt               0
 501 #define UNIT_mA                 1
 502 #define UNIT_none               2
 503
 504 #define COMEDI_MIN_SPEED        ((unsigned int)0xffffffff)
 505
 506 /* callback stuff */
 507 /* only relevant to kernel modules. */
 508
 509 #define COMEDI_CB_EOS           1       /* end of scan */
 510 #define COMEDI_CB_EOA           2       /* end of acquisition/output */
 511 #define COMEDI_CB_BLOCK         4       /* new data has arrived: wakes up write()/read() */
 512 #define COMEDI_CB_EOBUF         8       /* DEPRECATED: end of buffer */
 513 #define COMEDI_CB_ERROR         16      /* card error during acquisition */
 514 #define COMEDI_CB_OVERFLOW      32      /* buffer overflow/underflow */
 515
 516 /**********************************************************/
 517 /* everything after this line is ALPHA */
 518 /**********************************************************/
 519
 520 /*
 521 8254 specific configuration.
 522
 523 It supports two config commands:
 524
 525 0 ID: INSN_CONFIG_SET_COUNTER_MODE
 526 1 8254 Mode
 527 I8254_MODE0, I8254_MODE1, ..., I8254_MODE5
 528 OR'ed with:
 529 I8254_BCD, I8254_BINARY
 530
 531 0 ID: INSN_CONFIG_8254_READ_STATUS
 532 1 <-- Status byte returned here.
 533 B7=Output
 534 B6=NULL Count
 535 B5-B0 Current mode.
 536
 537 */
 538
 539 enum i8254_mode {
 540         I8254_MODE0 = (0 << 1), /* Interrupt on terminal count */
 541         I8254_MODE1 = (1 << 1), /* Hardware retriggerable one-shot */
 542         I8254_MODE2 = (2 << 1), /* Rate generator */
 543         I8254_MODE3 = (3 << 1), /* Square wave mode */
 544         I8254_MODE4 = (4 << 1), /* Software triggered strobe */
 545         I8254_MODE5 = (5 << 1), /* Hardware triggered strobe (retriggerable) */
 546         I8254_BCD = 1,  /* use binary-coded decimal instead of binary (pretty useless) */
 547         I8254_BINARY = 0
 548 };
 549
 550 static inline unsigned NI_USUAL_PFI_SELECT(unsigned pfi_channel) {
 551         if (pfi_channel < 10)
 552                 return 0x1 + pfi_channel;
 553         else
 554                 return 0xb + pfi_channel;
 555 } static inline unsigned NI_USUAL_RTSI_SELECT(unsigned rtsi_channel) {
 556         if (rtsi_channel < 7)
 557                 return 0xb + rtsi_channel;
 558         else
 559                 return 0x1b;
 560 }
 561 /* mode bits for NI general-purpose counters, set with INSN_CONFIG_SET_COUNTER_MODE */
 562 #define NI_GPCT_COUNTING_MODE_SHIFT 16
 563 #define NI_GPCT_INDEX_PHASE_BITSHIFT 20
 564 #define NI_GPCT_COUNTING_DIRECTION_SHIFT 24
 565 enum ni_gpct_mode_bits {
 566         NI_GPCT_GATE_ON_BOTH_EDGES_BIT = 0x4,
 567         NI_GPCT_EDGE_GATE_MODE_MASK = 0x18,
 568         NI_GPCT_EDGE_GATE_STARTS_STOPS_BITS = 0x0,
 569         NI_GPCT_EDGE_GATE_STOPS_STARTS_BITS = 0x8,
 570         NI_GPCT_EDGE_GATE_STARTS_BITS = 0x10,
 571         NI_GPCT_EDGE_GATE_NO_STARTS_NO_STOPS_BITS = 0x18,
 572         NI_GPCT_STOP_MODE_MASK = 0x60,
 573         NI_GPCT_STOP_ON_GATE_BITS = 0x00,
 574         NI_GPCT_STOP_ON_GATE_OR_TC_BITS = 0x20,
 575         NI_GPCT_STOP_ON_GATE_OR_SECOND_TC_BITS = 0x40,
 576         NI_GPCT_LOAD_B_SELECT_BIT = 0x80,
 577         NI_GPCT_OUTPUT_MODE_MASK = 0x300,
 578         NI_GPCT_OUTPUT_TC_PULSE_BITS = 0x100,
 579         NI_GPCT_OUTPUT_TC_TOGGLE_BITS = 0x200,
 580         NI_GPCT_OUTPUT_TC_OR_GATE_TOGGLE_BITS = 0x300,
 581         NI_GPCT_HARDWARE_DISARM_MASK = 0xc00,
 582         NI_GPCT_NO_HARDWARE_DISARM_BITS = 0x000,
 583         NI_GPCT_DISARM_AT_TC_BITS = 0x400,
 584         NI_GPCT_DISARM_AT_GATE_BITS = 0x800,
 585         NI_GPCT_DISARM_AT_TC_OR_GATE_BITS = 0xc00,
 586         NI_GPCT_LOADING_ON_TC_BIT = 0x1000,
 587         NI_GPCT_LOADING_ON_GATE_BIT = 0x4000,
 588         NI_GPCT_COUNTING_MODE_MASK = 0x7 << NI_GPCT_COUNTING_MODE_SHIFT,
 589         NI_GPCT_COUNTING_MODE_NORMAL_BITS =
 590                 0x0 << NI_GPCT_COUNTING_MODE_SHIFT,
 591         NI_GPCT_COUNTING_MODE_QUADRATURE_X1_BITS =
 592                 0x1 << NI_GPCT_COUNTING_MODE_SHIFT,
 593         NI_GPCT_COUNTING_MODE_QUADRATURE_X2_BITS =
 594                 0x2 << NI_GPCT_COUNTING_MODE_SHIFT,
 595         NI_GPCT_COUNTING_MODE_QUADRATURE_X4_BITS =
 596                 0x3 << NI_GPCT_COUNTING_MODE_SHIFT,
 597         NI_GPCT_COUNTING_MODE_TWO_PULSE_BITS =
 598                 0x4 << NI_GPCT_COUNTING_MODE_SHIFT,
 599         NI_GPCT_COUNTING_MODE_SYNC_SOURCE_BITS =
 600                 0x6 << NI_GPCT_COUNTING_MODE_SHIFT,
 601         NI_GPCT_INDEX_PHASE_MASK = 0x3 << NI_GPCT_INDEX_PHASE_BITSHIFT,
 602         NI_GPCT_INDEX_PHASE_LOW_A_LOW_B_BITS =
 603                 0x0 << NI_GPCT_INDEX_PHASE_BITSHIFT,
 604         NI_GPCT_INDEX_PHASE_LOW_A_HIGH_B_BITS =
 605                 0x1 << NI_GPCT_INDEX_PHASE_BITSHIFT,
 606         NI_GPCT_INDEX_PHASE_HIGH_A_LOW_B_BITS =
 607                 0x2 << NI_GPCT_INDEX_PHASE_BITSHIFT,
 608         NI_GPCT_INDEX_PHASE_HIGH_A_HIGH_B_BITS =
 609                 0x3 << NI_GPCT_INDEX_PHASE_BITSHIFT,
 610         NI_GPCT_INDEX_ENABLE_BIT = 0x400000,
 611         NI_GPCT_COUNTING_DIRECTION_MASK =
 612                 0x3 << NI_GPCT_COUNTING_DIRECTION_SHIFT,
 613         NI_GPCT_COUNTING_DIRECTION_DOWN_BITS =
 614                 0x00 << NI_GPCT_COUNTING_DIRECTION_SHIFT,
 615         NI_GPCT_COUNTING_DIRECTION_UP_BITS =
 616                 0x1 << NI_GPCT_COUNTING_DIRECTION_SHIFT,
 617         NI_GPCT_COUNTING_DIRECTION_HW_UP_DOWN_BITS =
 618                 0x2 << NI_GPCT_COUNTING_DIRECTION_SHIFT,
 619         NI_GPCT_COUNTING_DIRECTION_HW_GATE_BITS =
 620                 0x3 << NI_GPCT_COUNTING_DIRECTION_SHIFT,
 621         NI_GPCT_RELOAD_SOURCE_MASK = 0xc000000,
 622         NI_GPCT_RELOAD_SOURCE_FIXED_BITS = 0x0,
 623         NI_GPCT_RELOAD_SOURCE_SWITCHING_BITS = 0x4000000,
 624         NI_GPCT_RELOAD_SOURCE_GATE_SELECT_BITS = 0x8000000,
 625         NI_GPCT_OR_GATE_BIT = 0x10000000,
 626         NI_GPCT_INVERT_OUTPUT_BIT = 0x20000000
 627 };
 628
 629 /* Bits for setting a clock source with
 630 * INSN_CONFIG_SET_CLOCK_SRC when using NI general-purpose counters. */
 631 enum ni_gpct_clock_source_bits {
 632         NI_GPCT_CLOCK_SRC_SELECT_MASK = 0x3f,
 633         NI_GPCT_TIMEBASE_1_CLOCK_SRC_BITS = 0x0,
 634         NI_GPCT_TIMEBASE_2_CLOCK_SRC_BITS = 0x1,
 635         NI_GPCT_TIMEBASE_3_CLOCK_SRC_BITS = 0x2,
 636         NI_GPCT_LOGIC_LOW_CLOCK_SRC_BITS = 0x3,
 637         NI_GPCT_NEXT_GATE_CLOCK_SRC_BITS = 0x4,
 638         NI_GPCT_NEXT_TC_CLOCK_SRC_BITS = 0x5,
 639         NI_GPCT_SOURCE_PIN_i_CLOCK_SRC_BITS = 0x6,      /* NI 660x-specific */
 640         NI_GPCT_PXI10_CLOCK_SRC_BITS = 0x7,
 641         NI_GPCT_PXI_STAR_TRIGGER_CLOCK_SRC_BITS = 0x8,
 642         NI_GPCT_ANALOG_TRIGGER_OUT_CLOCK_SRC_BITS = 0x9,
 643         NI_GPCT_PRESCALE_MODE_CLOCK_SRC_MASK = 0x30000000,
 644         NI_GPCT_NO_PRESCALE_CLOCK_SRC_BITS = 0x0,
 645         NI_GPCT_PRESCALE_X2_CLOCK_SRC_BITS = 0x10000000,        /* divide source by 2 */
 646         NI_GPCT_PRESCALE_X8_CLOCK_SRC_BITS = 0x20000000,        /* divide source by 8 */
 647         NI_GPCT_INVERT_CLOCK_SRC_BIT = 0x80000000
 648 };
 649 static inline unsigned NI_GPCT_SOURCE_PIN_CLOCK_SRC_BITS(unsigned n) {  /* NI 660x-specific */
 650         return 0x10 + n;
 651 }
 652 static inline unsigned NI_GPCT_RTSI_CLOCK_SRC_BITS(unsigned n) {
 653         return 0x18 + n;
 654 }
 655 static inline unsigned NI_GPCT_PFI_CLOCK_SRC_BITS(unsigned n) { /* no pfi on NI 660x */
 656         return 0x20 + n;
 657 }
 658
 659 /* Possibilities for setting a gate source with
 660 INSN_CONFIG_SET_GATE_SRC when using NI general-purpose counters.
 661 May be bitwise-or'd with CR_EDGE or CR_INVERT. */
 662 enum ni_gpct_gate_select {
 663         /* m-series gates */
 664         NI_GPCT_TIMESTAMP_MUX_GATE_SELECT = 0x0,
 665         NI_GPCT_AI_START2_GATE_SELECT = 0x12,
 666         NI_GPCT_PXI_STAR_TRIGGER_GATE_SELECT = 0x13,
 667         NI_GPCT_NEXT_OUT_GATE_SELECT = 0x14,
 668         NI_GPCT_AI_START1_GATE_SELECT = 0x1c,
 669         NI_GPCT_NEXT_SOURCE_GATE_SELECT = 0x1d,
 670         NI_GPCT_ANALOG_TRIGGER_OUT_GATE_SELECT = 0x1e,
 671         NI_GPCT_LOGIC_LOW_GATE_SELECT = 0x1f,
 672         /* more gates for 660x */
 673         NI_GPCT_SOURCE_PIN_i_GATE_SELECT = 0x100,
 674         NI_GPCT_GATE_PIN_i_GATE_SELECT = 0x101,
 675         /* more gates for 660x "second gate" */
 676         NI_GPCT_UP_DOWN_PIN_i_GATE_SELECT = 0x201,
 677         NI_GPCT_SELECTED_GATE_GATE_SELECT = 0x21e,
 678         /* m-series "second gate" sources are unknown,
 679            we should add them here with an offset of 0x300 when known. */
 680         NI_GPCT_DISABLED_GATE_SELECT = 0x8000,
 681 };
 682 static inline unsigned NI_GPCT_GATE_PIN_GATE_SELECT(unsigned n) {
 683         return 0x102 + n;
 684 }
 685 static inline unsigned NI_GPCT_RTSI_GATE_SELECT(unsigned n) {
 686         return NI_USUAL_RTSI_SELECT(n);
 687 }
 688 static inline unsigned NI_GPCT_PFI_GATE_SELECT(unsigned n) {
 689         return NI_USUAL_PFI_SELECT(n);
 690 }
 691 static inline unsigned NI_GPCT_UP_DOWN_PIN_GATE_SELECT(unsigned n) {
 692         return 0x202 + n;
 693 }
 694
 695 /* Possibilities for setting a source with
 696 INSN_CONFIG_SET_OTHER_SRC when using NI general-purpose counters. */
 697 enum ni_gpct_other_index {
 698         NI_GPCT_SOURCE_ENCODER_A,
 699         NI_GPCT_SOURCE_ENCODER_B,
 700         NI_GPCT_SOURCE_ENCODER_Z
 701 };
 702 enum ni_gpct_other_select {
 703         /* m-series gates */
 704         // Still unknown, probably only need NI_GPCT_PFI_OTHER_SELECT
 705         NI_GPCT_DISABLED_OTHER_SELECT = 0x8000,
 706 };
 707 static inline unsigned NI_GPCT_PFI_OTHER_SELECT(unsigned n) {
 708         return NI_USUAL_PFI_SELECT(n);
 709 }
 710
 711 /* start sources for ni general-purpose counters for use with
 712 INSN_CONFIG_ARM */
 713 enum ni_gpct_arm_source {
 714         NI_GPCT_ARM_IMMEDIATE = 0x0,
 715         NI_GPCT_ARM_PAIRED_IMMEDIATE = 0x1,     /* Start both the counter and the adjacent paired counter simultaneously */
 716         /* NI doesn't document bits for selecting hardware arm triggers.  If
 717            the NI_GPCT_ARM_UNKNOWN bit is set, we will pass the least significant
 718            bits (3 bits for 660x or 5 bits for m-series) through to the hardware.
 719            This will at least allow someone to figure out what the bits do later. */
 720         NI_GPCT_ARM_UNKNOWN = 0x1000,
 721 };
 722
 723 /* digital filtering options for ni 660x for use with INSN_CONFIG_FILTER. */
 724 enum ni_gpct_filter_select {
 725         NI_GPCT_FILTER_OFF = 0x0,
 726         NI_GPCT_FILTER_TIMEBASE_3_SYNC = 0x1,
 727         NI_GPCT_FILTER_100x_TIMEBASE_1 = 0x2,
 728         NI_GPCT_FILTER_20x_TIMEBASE_1 = 0x3,
 729         NI_GPCT_FILTER_10x_TIMEBASE_1 = 0x4,
 730         NI_GPCT_FILTER_2x_TIMEBASE_1 = 0x5,
 731         NI_GPCT_FILTER_2x_TIMEBASE_3 = 0x6
 732 };
 733
 734 /* PFI digital filtering options for ni m-series for use with INSN_CONFIG_FILTER. */
 735 enum ni_pfi_filter_select {
 736         NI_PFI_FILTER_OFF = 0x0,
 737         NI_PFI_FILTER_125ns = 0x1,
 738         NI_PFI_FILTER_6425ns = 0x2,
 739         NI_PFI_FILTER_2550us = 0x3
 740 };
 741
 742 /* master clock sources for ni mio boards and INSN_CONFIG_SET_CLOCK_SRC */
 743 enum ni_mio_clock_source {
 744         NI_MIO_INTERNAL_CLOCK = 0,
 745         NI_MIO_RTSI_CLOCK = 1,  /* doesn't work for m-series, use NI_MIO_PLL_RTSI_CLOCK() */
 746         /* the NI_MIO_PLL_* sources are m-series only */
 747         NI_MIO_PLL_PXI_STAR_TRIGGER_CLOCK = 2,
 748         NI_MIO_PLL_PXI10_CLOCK = 3,
 749         NI_MIO_PLL_RTSI0_CLOCK = 4
 750 };
 751 static inline unsigned NI_MIO_PLL_RTSI_CLOCK(unsigned rtsi_channel) {
 752         return NI_MIO_PLL_RTSI0_CLOCK + rtsi_channel;
 753 }
 754
 755 /* Signals which can be routed to an NI RTSI pin with INSN_CONFIG_SET_ROUTING.
 756 The numbers assigned are not arbitrary, they correspond to the bits required
 757 to program the board. */
 758 enum ni_rtsi_routing {
 759         NI_RTSI_OUTPUT_ADR_START1 = 0,
 760         NI_RTSI_OUTPUT_ADR_START2 = 1,
 761         NI_RTSI_OUTPUT_SCLKG = 2,
 762         NI_RTSI_OUTPUT_DACUPDN = 3,
 763         NI_RTSI_OUTPUT_DA_START1 = 4,
 764         NI_RTSI_OUTPUT_G_SRC0 = 5,
 765         NI_RTSI_OUTPUT_G_GATE0 = 6,
 766         NI_RTSI_OUTPUT_RGOUT0 = 7,
 767         NI_RTSI_OUTPUT_RTSI_BRD_0 = 8,
 768         NI_RTSI_OUTPUT_RTSI_OSC = 12    /* pre-m-series always have RTSI clock on line 7 */
 769 };
 770 static inline unsigned NI_RTSI_OUTPUT_RTSI_BRD(unsigned n) {
 771         return NI_RTSI_OUTPUT_RTSI_BRD_0 + n;
 772 }
 773
 774 /* Signals which can be routed to an NI PFI pin on an m-series board
 775 with INSN_CONFIG_SET_ROUTING.  These numbers are also returned
 776 by INSN_CONFIG_GET_ROUTING on pre-m-series boards, even though
 777 their routing cannot be changed.  The numbers assigned are
 778 not arbitrary, they correspond to the bits required
 779 to program the board. */
 780 enum ni_pfi_routing {
 781         NI_PFI_OUTPUT_PFI_DEFAULT = 0,
 782         NI_PFI_OUTPUT_AI_START1 = 1,
 783         NI_PFI_OUTPUT_AI_START2 = 2,
 784         NI_PFI_OUTPUT_AI_CONVERT = 3,
 785         NI_PFI_OUTPUT_G_SRC1 = 4,
 786         NI_PFI_OUTPUT_G_GATE1 = 5,
 787         NI_PFI_OUTPUT_AO_UPDATE_N = 6,
 788         NI_PFI_OUTPUT_AO_START1 = 7,
 789         NI_PFI_OUTPUT_AI_START_PULSE = 8,
 790         NI_PFI_OUTPUT_G_SRC0 = 9,
 791         NI_PFI_OUTPUT_G_GATE0 = 10,
 792         NI_PFI_OUTPUT_EXT_STROBE = 11,
 793         NI_PFI_OUTPUT_AI_EXT_MUX_CLK = 12,
 794         NI_PFI_OUTPUT_GOUT0 = 13,
 795         NI_PFI_OUTPUT_GOUT1 = 14,
 796         NI_PFI_OUTPUT_FREQ_OUT = 15,
 797         NI_PFI_OUTPUT_PFI_DO = 16,
 798         NI_PFI_OUTPUT_I_ATRIG = 17,
 799         NI_PFI_OUTPUT_RTSI0 = 18,
 800         NI_PFI_OUTPUT_PXI_STAR_TRIGGER_IN = 26,
 801         NI_PFI_OUTPUT_SCXI_TRIG1 = 27,
 802         NI_PFI_OUTPUT_DIO_CHANGE_DETECT_RTSI = 28,
 803         NI_PFI_OUTPUT_CDI_SAMPLE = 29,
 804         NI_PFI_OUTPUT_CDO_UPDATE = 30
 805 };
 806 static inline unsigned NI_PFI_OUTPUT_RTSI(unsigned rtsi_channel) {
 807         return NI_PFI_OUTPUT_RTSI0 + rtsi_channel;
 808 }
 809
 810 /* Signals which can be routed to output on a NI PFI pin on a 660x board
 811 with INSN_CONFIG_SET_ROUTING.  The numbers assigned are
 812 not arbitrary, they correspond to the bits required
 813 to program the board.  Lines 0 to 7 can only be set to
 814 NI_660X_PFI_OUTPUT_DIO.  Lines 32 to 39 can only be set to
 815 NI_660X_PFI_OUTPUT_COUNTER. */
 816 enum ni_660x_pfi_routing {
 817         NI_660X_PFI_OUTPUT_COUNTER = 1, // counter
 818         NI_660X_PFI_OUTPUT_DIO = 2,     // static digital output
 819 };
 820
 821 /* NI External Trigger lines.  These values are not arbitrary, but are related to
 822 the bits required to program the board (offset by 1 for historical reasons). */
 823 static inline unsigned NI_EXT_PFI(unsigned pfi_channel) {
 824         return NI_USUAL_PFI_SELECT(pfi_channel) - 1;
 825 }
 826 static inline unsigned NI_EXT_RTSI(unsigned rtsi_channel) {
 827         return NI_USUAL_RTSI_SELECT(rtsi_channel) - 1;
 828 }
 829
 830 /* status bits for INSN_CONFIG_GET_COUNTER_STATUS */
 831 enum comedi_counter_status_flags {
 832         COMEDI_COUNTER_ARMED = 0x1,
 833         COMEDI_COUNTER_COUNTING = 0x2,
 834         COMEDI_COUNTER_TERMINAL_COUNT = 0x4,
 835 };
 836
 837 /* Clock sources for CDIO subdevice on NI m-series boards.
 838 Used as the scan_begin_arg for a comedi_command. These
 839 sources may also be bitwise-or'd with CR_INVERT to change polarity. */
 840 enum ni_m_series_cdio_scan_begin_src {
 841         NI_CDIO_SCAN_BEGIN_SRC_GROUND = 0,
 842         NI_CDIO_SCAN_BEGIN_SRC_AI_START = 18,
 843         NI_CDIO_SCAN_BEGIN_SRC_AI_CONVERT = 19,
 844         NI_CDIO_SCAN_BEGIN_SRC_PXI_STAR_TRIGGER = 20,
 845         NI_CDIO_SCAN_BEGIN_SRC_G0_OUT = 28,
 846         NI_CDIO_SCAN_BEGIN_SRC_G1_OUT = 29,
 847         NI_CDIO_SCAN_BEGIN_SRC_ANALOG_TRIGGER = 30,
 848         NI_CDIO_SCAN_BEGIN_SRC_AO_UPDATE = 31,
 849         NI_CDIO_SCAN_BEGIN_SRC_FREQ_OUT = 32,
 850         NI_CDIO_SCAN_BEGIN_SRC_DIO_CHANGE_DETECT_IRQ = 33
 851 };
 852 static inline unsigned NI_CDIO_SCAN_BEGIN_SRC_PFI(unsigned pfi_channel) {
 853         return NI_USUAL_PFI_SELECT(pfi_channel);
 854 }
 855 static inline unsigned NI_CDIO_SCAN_BEGIN_SRC_RTSI(unsigned
 856         rtsi_channel) {
 857         return NI_USUAL_RTSI_SELECT(rtsi_channel);
 858 }
 859
 860 /* scan_begin_src for scan_begin_arg==TRIG_EXT with analog output command
 861 on NI boards.  These scan begin sources can also be bitwise-or'd with
 862 CR_INVERT to change polarity. */
 863 static inline unsigned NI_AO_SCAN_BEGIN_SRC_PFI(unsigned pfi_channel) {
 864         return NI_USUAL_PFI_SELECT(pfi_channel);
 865 }
 866 static inline unsigned NI_AO_SCAN_BEGIN_SRC_RTSI(unsigned rtsi_channel) {
 867         return NI_USUAL_RTSI_SELECT(rtsi_channel);
 868 }
 869
 870 /* Bits for setting a clock source with
 871 * INSN_CONFIG_SET_CLOCK_SRC when using NI frequency output subdevice. */
 872 enum ni_freq_out_clock_source_bits {
 873         NI_FREQ_OUT_TIMEBASE_1_DIV_2_CLOCK_SRC, // 10 MHz
 874         NI_FREQ_OUT_TIMEBASE_2_CLOCK_SRC        // 100 KHz
 875 };
 876
 877 /* Values for setting a clock source with INSN_CONFIG_SET_CLOCK_SRC for
 878 * 8254 counter subdevices on Amplicon DIO boards (amplc_dio200 driver). */
 879 enum amplc_dio_clock_source {
 880         AMPLC_DIO_CLK_CLKN,     /* per channel external clock
 881                                    input/output pin (pin is only an
 882                                    input when clock source set to this
 883                                    value, otherwise it is an output) */
 884         AMPLC_DIO_CLK_10MHZ,    /* 10 MHz internal clock */
 885         AMPLC_DIO_CLK_1MHZ,     /* 1 MHz internal clock */
 886         AMPLC_DIO_CLK_100KHZ,   /* 100 kHz internal clock */
 887         AMPLC_DIO_CLK_10KHZ,    /* 10 kHz internal clock */
 888         AMPLC_DIO_CLK_1KHZ,     /* 1 kHz internal clock */
 889         AMPLC_DIO_CLK_OUTNM1,   /* output of preceding counter channel
 890                                    (for channel 0, preceding counter
 891                                    channel is channel 2 on preceding
 892                                    counter subdevice, for first counter
 893                                    subdevice, preceding counter
 894                                    subdevice is the last counter
 895                                    subdevice) */
 896         AMPLC_DIO_CLK_EXT,      /* per chip external input pin */
 897         /* the following are "enhanced" clock sources for PCIe models */
 898         AMPLC_DIO_CLK_VCC,      /* clock input HIGH */
 899         AMPLC_DIO_CLK_GND,      /* clock input set LOW */
 900         AMPLC_DIO_CLK_PAT_PRESENT, /* "pattern present" signal */
 901         AMPLC_DIO_CLK_20MHZ     /* 20 MHz internal clock */
 902 };
 903
 904 /* Values for setting a clock source with INSN_CONFIG_SET_CLOCK_SRC for
 905 * timer subdevice on some Amplicon DIO PCIe boards (amplc_dio200 driver). */
 906 enum amplc_dio_ts_clock_src {
 907         AMPLC_DIO_TS_CLK_1GHZ,  /* 1 ns period with 20 ns granularity */
 908         AMPLC_DIO_TS_CLK_1MHZ,  /* 1 us period */
 909         AMPLC_DIO_TS_CLK_1KHZ   /* 1 ms period */
 910 };
 911
 912 /* Values for setting a gate source with INSN_CONFIG_SET_GATE_SRC for
 913 * 8254 counter subdevices on Amplicon DIO boards (amplc_dio200 driver). */
 914 enum amplc_dio_gate_source {
 915         AMPLC_DIO_GAT_VCC,      /* internal high logic level */
 916         AMPLC_DIO_GAT_GND,      /* internal low logic level */
 917         AMPLC_DIO_GAT_GATN,     /* per channel external gate input */
 918         AMPLC_DIO_GAT_NOUTNM2,  /* negated output of counter channel
 919                                    minus 2 (for channels 0 or 1,
 920                                    channel minus 2 is channel 1 or 2 on
 921                                    the preceding counter subdevice, for
 922                                    the first counter subdevice the
 923                                    preceding counter subdevice is the
 924                                    last counter subdevice) */
 925         AMPLC_DIO_GAT_RESERVED4,
 926         AMPLC_DIO_GAT_RESERVED5,
 927         AMPLC_DIO_GAT_RESERVED6,
 928         AMPLC_DIO_GAT_RESERVED7,
 929         /* the following are "enhanced" gate sources for PCIe models */
 930         AMPLC_DIO_GAT_NGATN = 6, /* negated per channel gate input */
 931         AMPLC_DIO_GAT_OUTNM2,   /* non-negated output of counter
 932                                    channel minus 2 */
 933         AMPLC_DIO_GAT_PAT_PRESENT, /* "pattern present" signal */
 934         AMPLC_DIO_GAT_PAT_OCCURRED, /* "pattern occurred" latched */
 935         AMPLC_DIO_GAT_PAT_GONE, /* "pattern gone away" latched */
 936         AMPLC_DIO_GAT_NPAT_PRESENT, /* negated "pattern present" */
 937         AMPLC_DIO_GAT_NPAT_OCCURRED, /* negated "pattern occurred" */
 938         AMPLC_DIO_GAT_NPAT_GONE /* negated "pattern gone away" */
 939 };
 940
 941 #ifdef __cplusplus
 942 #if 0
 943 { /* avoid confusing editor auto-indent */
 944 #endif
 945 }
 946 #endif
 947
 948 #endif /* _COMEDI_H */