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