From 380f2fc1eb2368c19f9573ad1a2e0a23505b7ac7 Mon Sep 17 00:00:00 2001 From: David Schleef Date: Thu, 4 Oct 2001 20:10:36 +0000 Subject: [PATCH] Additional typing --- doc/comedilib.sgml | 142 ++++++++++++++++++++++++++++++++++++--------- 1 file changed, 116 insertions(+), 26 deletions(-) diff --git a/doc/comedilib.sgml b/doc/comedilib.sgml index ebbf5b8..80bf994 100644 --- a/doc/comedilib.sgml +++ b/doc/comedilib.sgml @@ -786,6 +786,7 @@ access to the device. It is a transparent type, and pointers to type Source: /include/comedi.h

sampl_t @@ -793,20 +794,29 @@ should not be dereferenced by the application.

The data type +Most drivers represent data trasferred by Source: /include/comedi.h

lsampl_t

-The data type Source: /include/comedi.h

comedi_trig_struct -This structure is defined as part of the Comedi kernel interface. +

Source: /include/comedi.h

comedi_sv_t @@ -867,6 +876,7 @@ functions to provide a simple method of accurately measuring slowly varying inputs. See the relevant section for more details. +

Source: comedilib.h

comedi_cmd @@ -907,32 +917,112 @@ struct comedi_cmd_struct{ More information on using commands can be found in the section. -

-This structure is defined as part of the Comedi kernel interface. +

Source: comedilib.h

comedi_insn

-undocumented + +typedef struct comedi_insn_struct comedi_insn; + +struct comedi_insn_struct{ + unsigned int insn; + unsigned int n; + lsampl_t *data; + unsigned int subdev; + unsigned int chanspec; + unsigned int unused[3]; +}; +

-Related functions are described in section XXX. +Comedi instructions are described by the -This structure is defined as part of the Comedi kernel interface. +The field +INSN_READ read values from an input channel +INSN_WRITE write values to an output channel +INSN_BITS read/write values on multiple digital I/O channels +INSN_CONFIG configure a subdevice +INSN_GTOD read a timestamp, identical to INSN_WAIT wait a specified number of nanoseconds + +

+The number of samples to read or write, or the size of the configuration +structure is specified by the field +Instructions can be sent to drivers using Source: comedi.h

comedi_range

-undocumented + +typedef struct{ + double min; + double max; + unsigned int unit; +}comedi_range; + + +

+The +XXX RF_EXTERNAL +

Source: comedilib.h +

+comedi_krange +

+ + +struct comedi_krange_struct{ + int min; + int max; + unsigned int flags; +}; + + +

+The Source: comedi.h + Functions

@@ -1112,11 +1202,6 @@ set, the cooresponding bit in -The current implementation reads and writes bits using separate -system calls, which is not ideal. When the kernel driver supports -simultaneous reading/writing, this will be fixed in the library. -

It should be noted that it is not possible to access channels greater than 31 using this function. @@ -1157,7 +1242,7 @@ chan,unsigned int *bit);/

The function reads the status of channel This function is equivalent to +This function is equivalent to Source: /lib/dio.c @@ -1183,14 +1271,15 @@ Source: /lib/dio.c comedi_fileno()

- The function it is an invalid comedi_t pointer, the function -returns -1 and sets the appropriate libcomedi error value. +returns the integer descriptor for the device dev is an invalid comedi_t +pointer, the function returns -1 and sets the appropriate +libcomedi error value. Source: /lib/comedi.c @@ -1207,8 +1296,9 @@ The function chan belonging to a subdevice of the comedi device it, that includes both min and max in units. -If it finds a matching range, it returns its index. If no -matching range is available, it returns -1. +If a matching range is found, the index of the matching range is +returned. If no matching range is available, the function returns +-1.

Valid units are: -- 2.26.2