From: Ian Abbott Date: Fri, 4 May 2012 17:10:55 +0000 (+0100) Subject: doc/reference.xml: More DocBook mark-up changes. X-Git-Url: http://git.tremily.us/?p=comedilib.git;a=commitdiff_plain;h=c63732907e6a963dee574e0272a8f12221cfad97 doc/reference.xml: More DocBook mark-up changes. --- diff --git a/doc/reference.xml b/doc/reference.xml index 6a5320d..b1dcfd9 100644 --- a/doc/reference.xml +++ b/doc/reference.xml @@ -38,11 +38,12 @@ CR_PACK -CR_PACK is used to initialize the elements of the +CR_PACKchanrng +aref is used to initialize the elements of the chanlist array in the -comedi_cmd data structure, +comedi_cmd data structure, and the chanspec member of the -comedi_insn structure. +comedi_insn structure. The range rng is an index, starting at zero, whose meaning is device dependent. The -comedi_get_n_ranges() +comedi_get_n_ranges and -comedi_get_range() +comedi_get_range functions are useful in discovering information about the available ranges. @@ -69,7 +70,7 @@ The aref argument indicates what reference you want the device to use. It can be any of the following: - AREF_GROUND + AREF_GROUND is for inputs/outputs referenced to ground. @@ -77,7 +78,7 @@ want the device to use. It can be any of the following: - AREF_COMMON + AREF_COMMON is for a common reference (the low inputs of all the @@ -86,7 +87,7 @@ channels are tied together, but are isolated from ground). - AREF_DIFF + AREF_DIFF is for differential inputs/outputs. @@ -94,7 +95,7 @@ channels are tied together, but are isolated from ground). - AREF_OTHER + AREF_OTHER is for any reference that does not fit into the above categories. @@ -119,12 +120,13 @@ used for communication between the kernel and library. -The RANGE_LENGTH() macro returns the length of the array that is -specified by the rangetype token. +The RANGE_LENGTHrangetype +macro returns the length of the array that is +specified by the rangetype token. -The RANGE_LENGTH() macro is deprecated, and should not be used in +The RANGE_LENGTH macro is deprecated, and should not be used in new applications. It is scheduled to be removed from the header file at version 1.0. Binary compatibility may be broken for version 1.1. @@ -146,9 +148,11 @@ enum comedi_conversion_direction -A comedi_conversion_direction is used to choose between converting data -from Comedi's integer sample values to a physical value (COMEDI_TO_PHYSICAL), -and converting from a physical value to Comedi's integer sample values (COMEDI_FROM_PHYSICAL). +A comedi_conversion_direction is used to choose between converting data +from Comedi's integer sample values to a physical value +(COMEDI_TO_PHYSICAL), +and converting from a physical value to Comedi's integer sample values +(COMEDI_FROM_PHYSICAL). @@ -168,9 +172,9 @@ enum comedi_io_direction -A comedi_io_direction is used to select between input or output. For example, -comedi_dio_config -uses the COMEDI_INPUT and COMEDI_OUTPUT values to specify +A comedi_io_direction is used to select between input or output. For example, +comedi_dio_config +uses the COMEDI_INPUT and COMEDI_OUTPUT values to specify whether a configurable digital i/o channel should be configured as an input or output. @@ -202,10 +206,10 @@ enum comedi_subdevice_type { -The comedi_subdevice_type enumeration specifies the possible values for +The comedi_subdevice_type enumeration specifies the possible values for a subdevice type. These values are used by the functions -comedi_get_subdevice_type and -comedi_find_subdevice_by_type. +comedi_get_subdevice_type and +comedi_find_subdevice_by_type. @@ -242,7 +246,7 @@ subdevice_struct -The data type subdevice_struct is used to store +The data type subdevice_struct is used to store information about a subdevice. This structure is usually filled in automatically when the driver is loaded (attached), so programmers need not access this data structure directly. @@ -264,7 +268,7 @@ struct subdevice_struct{ unsigned int *flags_list; comedi_range *rangeinfo; - ccomedi_range **rangeinfo_list; + comedi_range **rangeinfo_list; unsigned int has_cmd; unsigned int has_insn_bits; @@ -287,7 +291,7 @@ comedi_devinfo -The data type comedi_devinfo is used to store +The data type comedi_devinfo is used to store information about a device. This structure is usually filled in automatically when the driver is loaded (attached), so programmers need not access this data structure directly. @@ -316,7 +320,7 @@ comedi_t -The data type comedi_t is used to represent an +The data type comedi_t is used to represent an open &comedi; device: typedef struct comedi_t_struct comedi_t; @@ -334,7 +338,7 @@ struct comedi_t_struct{ A valid comedi_t pointer is returned by a successful call to -comedi_open(), +comedi_open, and should be used for subsequent access to the device. It is a transparent type, and pointers to type comedi_t @@ -354,24 +358,21 @@ typedef unsigned short sampl_t; -The data type sampl_t is one +The data type sampl_t is one of the generic types used to represent data values in Comedilib. It is used in a few places where a data type -shorter than lsampl_t is -useful. On most architectures, -sampl_t -is defined to be uint16. +shorter than lsampl_t is +useful. On most architectures it is a 16-bit, unsigned integer. -Most drivers represent data transferred by read() and -write() using -sampl_t. +Most drivers represent data transferred by read and +write functions using sampl_t. Applications should check the subdevice flag -SDF_LSAMPL to determine if the subdevice uses -sampl_t or -lsampl_t. +SDF_LSAMPL to determine if the subdevice uses +sampl_t or +lsampl_t. @@ -387,11 +388,10 @@ typedef unsigned int lsampl_t; The data type -lsampl_t +lsampl_t is the data type typically used to represent -data values in libcomedi. On most architectures, -lsampl_t -is defined to be uint32. +data values in Comedilib. On most architectures it is a 32-bit, +unsigned integer. @@ -421,9 +421,9 @@ struct comedi_trig_struct{ -The comedi_trig structure is a control structure used by the -COMEDI_TRIG ioctl, an older method of communicating -instructions to the driver and hardware. Use of comedi_trig is +The comedi_trig structure is a control structure used by the +COMEDI_TRIG ioctl, an older method of communicating +instructions to the driver and hardware. Use of comedi_trig is deprecated, and should not be used in new applications. @@ -453,7 +453,7 @@ struct comedi_sv_struct{ -The comedi_sv_t structure is used by the comedi_sv_*() +The comedi_sv_t structure is used by the comedi_sv_… functions to provide a simple method of accurately measuring slowly varying inputs. See the relevant section for more details. @@ -497,7 +497,7 @@ struct comedi_cmd_struct{ More information on using commands can be found in the -command section. +command section. @@ -520,7 +520,7 @@ struct comedi_insn_struct{ -Comedi instructions are described by the comedi_insn structure. +Comedi instructions are described by the comedi_insn structure. Applications send instructions to the driver in order to perform control and measurement operations that are done immediately or synchronously, i.e., the operations complete before program control @@ -537,7 +537,7 @@ to the driver. Valid instruction types are: -INSN_READ +INSN_READ @@ -548,7 +548,7 @@ read values from an input channel -INSN_WRITE +INSN_WRITE @@ -559,7 +559,7 @@ write values to an output channel -INSN_BITS +INSN_BITS @@ -570,7 +570,7 @@ read/write values on multiple digital I/O channels -INSN_CONFIG +INSN_CONFIG @@ -581,19 +581,19 @@ configure a subdevice -INSN_GTOD +INSN_GTOD -read a timestamp, identical to gettimeofday() except the seconds -and microseconds values are of type lsampl_t. +read a timestamp, identical to gettimeofday except the seconds +and microseconds values are of type lsampl_t. -INSN_WAIT +INSN_WAIT @@ -612,9 +612,10 @@ the channel, range, and analog reference (if applicable). -Instructions can be sent to drivers using comedi_do_insn(). -Multiple instructions can be sent to drivers in the same system -call using comedi_do_insnlist(). +Instructions can be sent to drivers using +comedi_do_insn. +Multiple instructions can be sent to drivers in the same system call using +comedi_do_insnlist. @@ -634,12 +635,13 @@ struct comedi_range_struct{ -The comedi_range structure conveys part of the information +The comedi_range structure conveys part of the information necessary to translate sample values to physical units, in particular, the endpoints of the range and the physical unit type. The physical unit type is specified by the field unit, which may -take the values UNIT_volt for volts, UNIT_mA for milliamps, -or UNIT_none for unitless. The endpoints are specified by +take the values UNIT_volt for volts, +UNIT_mA for milliamps, +or UNIT_none for unitless. The endpoints are specified by the fields min and max. @@ -660,17 +662,18 @@ struct comedi_krange_struct{ -The comedi_krange structure is used to transfer range information +The comedi_krange structure is used to transfer range information between the driver and Comedilib, and should not normally be used by applications. The structure conveys the same information as the comedi_range structure, except the fields min and max are integers, multiplied by a factor of 1000000 compared to the -counterparts in comedi_range. +counterparts in comedi_range. -In addition, kcomedilib uses the comedi_krange structure in place -of the comedi_range structure. +In addition, kcomedilib uses the +comedi_krange structure in place +of the comedi_range structure. @@ -690,7 +693,7 @@ struct comedi_insnlist_struct{ -An instruction list (insnlist) structure is used to communicate +An instruction list (comedi_insnlist) structure is used to communicate a list of instructions. @@ -711,13 +714,13 @@ typedef struct { -A comedi_polynomial_t holds calibration data for a channel of a +A comedi_polynomial_t holds calibration data for a channel of a subdevice. It is initialized by the -comedi_get_hardcal_converter -or comedi_get_softcal_converter +comedi_get_hardcal_converter +or comedi_get_softcal_converter calibration functions and is passed to the -comedi_to_physical -and comedi_from_physical +comedi_to_physical +and comedi_from_physical raw/physical conversion functions.