From 48740913646eda7fb5be39fbe0d30cad710d7524 Mon Sep 17 00:00:00 2001 From: Ian Abbott Date: Tue, 8 May 2012 13:58:27 +0100 Subject: [PATCH] doc/other.xml: More DocBook mark-up changes. More changes, mostly adding tags. --- doc/other.xml | 161 +++++++++++++++++++++++++------------------------- 1 file changed, 81 insertions(+), 80 deletions(-) diff --git a/doc/other.xml b/doc/other.xml index f398024..85fddf4 100644 --- a/doc/other.xml +++ b/doc/other.xml @@ -357,12 +357,12 @@ Because of the large flexibility of the instruction function, many types of instruction do not need to fill in all fields, or attach different meanings to the same field. But the current implementation of &comedi; requires the -data field to be at -least one byte long. +data +field to be at least one byte long. -The insn flag of the +The insn member of the instruction data structure determines the type of acquisition executed in the corresponding instruction: @@ -473,7 +473,8 @@ how they are used to configure a subdevice. There are various sorts of configurations, and the specific information for each different configuration possibility is to be specified via the -data buffer of the +data +buffer of the instruction data structure. (So, the pointer to a lsampl_t @@ -482,13 +483,15 @@ is misused as a pointer to an array with board-specific information.) Using INSN_CONFIG as the -insn flag in an +insn +member in an instruction data structure indicates that the instruction will not perform acquisition on a channel, but will configure that channel. The -chanspec field in the +chanspec +member in the comedi_insn data structure, contains the channel to be configured. The zeroth element of the data array @@ -607,7 +610,8 @@ Instruction for internal triggering This special instruction has INSN_INTTRIG as the -insn flag in its +insn +member in its instruction data structure. Its execution causes an internal triggering event. This @@ -617,7 +621,7 @@ depends on the card and its particular driver. The -data[0] field of the +data[0] element of the INSN_INTTRIG instruction is reserved for future use, and should be set to 0. @@ -692,7 +696,7 @@ intervals of 1 millisecond apart. The command function is complementary to the configuration instruction function: each channel in the command's -chanlist +chanlist should first be configured by an appropriate instruction. @@ -792,19 +796,19 @@ function can be useful in discovering the index of your desired subdevice. -The chanlist +The chanlist member of the comedi_cmd data structure should point to an array whose number of elements is specified by -chanlist_len +chanlist_len (this will generally be the same as the -scan_end_arg). +scan_end_arg). The -chanlist +chanlist specifies the sequence of channels and gains (and analog references) that should be stepped through for each scan. The elements of the -chanlist array should be +chanlist array should be initialized by packing the channel, range and reference information together with the CR_PACK @@ -812,8 +816,8 @@ macro. -The data and -data_len +The data and +data_len members can be safely ignored when issueing commands from a user-space program. They only have meaning when a command is sent from a kernel module using the @@ -824,10 +828,10 @@ the buffer where the driver should write/read its data to/from. The final member of the comedi_cmd structure is the -flags field, +flags field, i.e., bits in a word that can be bitwise-or'd together. The meaning of -these bits are explained in a -later section. +these bits are explained in +. @@ -869,19 +873,17 @@ corresponding arguments (…_arg). The start of an acquisition is controlled by the -start_src events. +start_src events. The available options are: -TRIG_NOW: the -start_src -event occurs -start_arg +TRIG_NOW: the start event occurs +start_arg nanoseconds after the command is set up. Currently, only -start_arg=0 is +start_arg=0 is supported. @@ -889,8 +891,7 @@ supported. -TRIG_FOLLOW: (For an output device.) The -start_src +TRIG_FOLLOW: (For an output device.) The start event occurs when data is written to the buffer. @@ -898,9 +899,9 @@ event occurs when data is written to the buffer. -TRIG_EXT: the start event occurs when an +TRIG_EXT: the start event occurs when an external trigger signal occurs; e.g., a rising edge of a digital line. -start_arg +start_arg chooses the particular digital line. @@ -908,7 +909,7 @@ chooses the particular digital line. -TRIG_INT: the start event occurs on a &comedi; +TRIG_INT: the start event occurs on a &comedi; internal signal, which is typically caused by an INSN_INTTRIG instruction. @@ -918,19 +919,17 @@ instruction. The start of the beginning of each scan is controlled by the -scan_begin events. +scan_begin_src events. The available options are: -TRIG_TIMER: -scan_begin -events occur periodically. The time between -scan_begin +TRIG_TIMER: scan begin +events occur periodically. The time between scan begin events is -convert_arg +scan_begin_arg nanoseconds. @@ -938,10 +937,8 @@ nanoseconds. -TRIG_FOLLOW: The -scan_begin -event occurs immediately after a -scan_end +TRIG_FOLLOW: The scan begin +event occurs immediately after a scan end event occurs. @@ -949,18 +946,17 @@ event occurs. -TRIG_EXT: the -scan_begin +TRIG_EXT: the scan begin event occurs when an external trigger signal occurs; e.g., a rising edge of a digital line. -scan_begin_arg +scan_begin_arg chooses the particular digital line. The -scan_begin_arg +scan_begin_arg used here may not be supported exactly by the device, but it will be adjusted to the nearest supported value by comedi_command_test. @@ -968,8 +964,9 @@ will be adjusted to the nearest supported value by The timing between each sample in a scan is controlled by the -convert_… -fields: +convert_src +events. +The available options are: @@ -977,8 +974,8 @@ fields: TRIG_TIMER: the conversion events occur periodically. -The time between convert events is -convert_arg +The time between convert events is +convert_arg nanoseconds. @@ -989,7 +986,7 @@ nanoseconds. TRIG_EXT: the conversion events occur when an external trigger signal occurs, e.g., a rising edge of a digital line. -convert_arg +convert_arg chooses the particular digital line. @@ -1005,10 +1002,12 @@ chooses the particular digital line. The end of each scan is almost always specified -using +by setting the +scan_end_src +event to TRIG_COUNT, with the argument being the same as the number of channels in the -chanlist. You +chanlist. You could probably find a device that allows something else, but it would be strange. @@ -1016,8 +1015,8 @@ be strange. The end of an acquisition is controlled by -stop_src -and stop_arg: +stop_src event. +The available options are: @@ -1025,7 +1024,7 @@ and stop_arg: TRIG_COUNT: stop the acquisition after -stop_arg +stop_arg scans. @@ -1039,7 +1038,7 @@ until stopped using comedi_cancel. -Its argument is reserved and should be set to 0. +Its stop_arg argument is reserved and should be set to 0. (Reserved means that unspecified things could happen if it is set to something else but 0.) @@ -1100,7 +1099,8 @@ The command flags The -flags field in the +flags +field in the command data structure is used to specify some behaviour of the acquisitions in a command. @@ -1485,12 +1485,13 @@ this yet).) -The insn field of the +The insn +field of the instruction data structure has not been assigned yet. -The chanspec field +The chanspec field of the instruction data structure is ignored. @@ -1529,12 +1530,12 @@ Analog Output Waveform Generation this yet).) -The insn field of the +The insn field of the instruction data structure has not been assigned yet. -The chanspec field +The chanspec field of the instruction data structure is ignored. @@ -1561,12 +1562,12 @@ Extended Triggering -The insn field of the +The insn field of the instruction data structure has not been assigned yet. -The chanspec field +The chanspec field of the instruction data structure is ignored. @@ -1610,7 +1611,7 @@ only be allowed with a properly configured extended trigger. Extended triggers must use -data[1] as flags. The +data[1] as flags. The upper 16 bits are reserved and used only for flags that are common to all extended triggers. The lower 16 bits may be defined by the particular type of extended trigger. @@ -1618,7 +1619,7 @@ particular type of extended trigger. Various types of extended triggers must use -data[1] to know which +data[1] to know which event the extended trigger will be assigned to in the command structure. The possible values are an OR'd mask of the following: @@ -1665,18 +1666,18 @@ implements this feature.) -The insn field of the +The insn field of the instruction data structure has not been assigned yet. -The chanspec field +The chanspec field of the instruction data structure is ignored. -The data field +The data field of the instruction data structure is used as follows: @@ -1746,18 +1747,18 @@ Bitfield Pattern Matching Extended Trigger -The insn field of the +The insn field of the instruction data structure has not been assigned yet. -The chanspec field +The chanspec field of the instruction data structure is ignored. -The data field +The data field of the instruction data structure is used as follows: @@ -1812,19 +1813,19 @@ Counter configuration -The insn field of the +The insn field of the instruction data structure has not been assigned yet. -The chanspec field +The chanspec field of the instruction data structure is used to specify which counter to use. (I.e., the counter is a &comedi; channel.) -The data field +The data field of the instruction data structure is used as follows: @@ -1870,10 +1871,10 @@ or asynchronous mode (using input subdevices. The input signal for both modes is the accumulator. Commands on counter subdevices are almost always specified using -scan_begin_src +scan_begin_src = TRIG_OTHER, with the counter configuration also serving as the extended configuration for -the scan begin source. +the scan begin source. @@ -1901,18 +1902,18 @@ One source plus auxiliary counter configuration -The insn field of the +The insn field of the instruction data structure has not been assigned yet. -The chanspec field +The chanspec field of the instruction data structure is used to … -The data field +The data field of the instruction data structure is used as follows: @@ -1940,8 +1941,8 @@ transitions of the source signals. data[4] determine the primary source for the counter, similar to the -…_src and the -…_arg fields +…_src and the +…_arg fields used in the command data structure. -- 2.26.2