doc/glossary.sgml

   1 <!-- <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> -->
   2
   3 <glossary id="comedilib-glossary">
   4   <title>
   5     Glossary
   6   </title>
   7
   8   <glossentry id="api">
   9     <glossterm>
  10     Application Program Interface
  11     </glossterm>
  12     <acronym>API</acronym>
  13     <glossdef>
  14       <para>
  15 The (documented) set of function calls supported by a particular
  16 application, by which programmers can access the functionality
  17 available in the application.
  18       </para>
  19     </glossdef>
  20   </glossentry>
  21
  22
  23   <glossentry id="buffer">
  24     <glossterm>
  25 buffer
  26     </glossterm>
  27     <glossdef>
  28       <para>
  29 &comedi; uses permanently allocated kernel memory for streaming input
  30 and output to store data that has been measured by a device, but has
  31 not been read by an application.  These buffers can be resized by the
  32 Comedilib function <function>comedi_buffer_XXX()</function> or the
  33 <function>comedi_config</function>
  34 utility.
  35       </para>
  36     </glossdef>
  37   </glossentry>
  38
  39   <glossentry id="bufferoverflow">
  40     <glossterm>
  41 buffer overflow
  42     </glossterm>
  43     <glossdef>
  44       <para>
  45 This is an error message that indicates that the driver ran out of
  46 space in a &comedi; buffer to put samples.  It means that the application
  47 is not copying data out of the buffer quickly enough.  Often, this
  48 problem can be fixed by making the &comedi; buffer larger.  See
  49 <function>comedi_buffer_XXX</function> for more information.
  50       </para>
  51     </glossdef>
  52   </glossentry>
  53
  54   <glossentry id="differentialIO">
  55     <glossterm>
  56     Differential IO
  57     </glossterm>
  58     <glossdef>
  59       <para>
  60 &hellip;
  61       </para>
  62     </glossdef>
  63   </glossentry>
  64
  65   <glossentry id="dma">
  66     <glossterm>
  67     Direct Memory Access
  68     </glossterm>
  69     <acronym>DMA</acronym>
  70     <glossdef>
  71       <para>
  72 DMA is a method of transferring data between
  73 a device and the main memory of a computer.  DMA operates differently
  74 on ISA and PCI cards.  ISA DMA is handled by a controller on the
  75 motherboard and is limited to transfers to/from the lowest 16 MB of
  76 physical RAM and can only handle a single segment of memory at a time.
  77 These limitations make it almost useless.  PCI ("bus mastering") DMA
  78 is handled by a controller on the device, and can typically address
  79 4 GB of RAM and handle many segments of memory simultaneously.  DMA
  80 is usually not the only means to data transfer, and may or may not
  81 be the optimal transfer mechanism for a particular situation.
  82       </para>
  83     </glossdef>
  84   </glossentry>
  85
  86   <glossentry id="fifo">
  87     <glossterm>
  88     First In, First Out
  89     </glossterm>
  90     <acronym>FIFO</acronym>
  91     <glossdef>
  92       <para>
  93 Most devices have a limited amount of on-board space to store samples
  94 before they are transferred to the Comedi buffer.  This allows the CPU or
  95 DMA controller to do other things, and then efficiently process a
  96 large number of samples simultaneously.  It also increases the
  97 maximum interrupt latency that the system can handle without
  98 interruptions in data.
  99       </para>
 100     </glossdef>
 101   </glossentry>
 102
 103
 104   <glossentry id="comedicommand">
 105     <glossterm>
 106 &comedi; command
 107     </glossterm>
 108     <glossdef>
 109       <para>
 110 &comedi; commands are the mechanism that applications configure
 111 subdevices for streaming input and output.
 112       </para>
 113     </glossdef>
 114   </glossentry>
 115
 116   <glossentry id="command">
 117     <glossterm>
 118 command
 119     </glossterm>
 120     <glosssee otherterm="comedicommand">
 121   </glossentry>
 122
 123   <glossentry id="configoption">
 124     <glossterm>
 125 configuration option
 126     </glossterm>
 127     <glossdef>
 128       <para>
 129       </para>
 130     </glossdef>
 131   </glossentry>
 132
 133   <glossentry id="instruction">
 134     <glossterm>
 135 instruction
 136     </glossterm>
 137     <glossdef>
 138       <para>
 139 &comedi; instructions are the mechanism used by applications to do
 140 immediate input from channels, output to channels, and configuration
 141 of subdevices and channels.
 142       </para>
 143     </glossdef>
 144   </glossentry>
 145
 146   <glossentry id="instructionlist">
 147     <glossterm>
 148 instruction list
 149     </glossterm>
 150     <glossdef>
 151       <para>
 152 Instruction lists allow the application to perform multiple &comedi;
 153 instructions in the same system call.
 154       </para>
 155     </glossdef>
 156   </glossentry>
 157
 158   <glossentry id="option">
 159     <glossterm>
 160 option
 161     </glossterm>
 162     <glossdef>
 163       <para>
 164       </para>
 165   <glossseealso otherterm="optionlist">
 166     </glossdef>
 167   </glossentry>
 168
 169
 170   <glossentry id="optionlist">
 171     <glossterm>
 172 option list
 173     </glossterm>
 174     <glossdef>
 175       <para>
 176 Option lists are used with <function>comedi_config</function> to
 177 perform driver configuration.
 178       </para>
 179   <glossseealso otherterm="configoption">
 180   <glossseealso otherterm="option">
 181     </glossdef>
 182   </glossentry>
 183
 184   <glossentry id="overrun">
 185     <glossterm>
 186 overrun
 187     </glossterm>
 188     <glossdef>
 189       <para>
 190 This is an error message that indicates that there was device-level
 191 problem, typically with trigger pulses occurring faster than the
 192 board can handle.
 193       </para>
 194     </glossdef>
 195   </glossentry>
 196
 197   <glossentry id="poll">
 198     <glossterm>
 199 poll
 200     </glossterm>
 201     <glossdef>
 202       <para>
 203 The term poll (and polling) is used for several different related
 204 concepts in &comedi;.  &comedi; implements the
 205 <function>poll()</function> system call for Comedi devices, which is
 206 similar to <function>select()</function>, and returns information
 207 about file descriptors that can be read or written.  Comedilib also
 208 has a function called <function>comedi_poll()</function>, which causes
 209 the driver to copy all available data from the device to the &comedi;
 210 buffer.  In addition, some drivers may use a polling technique in
 211 place of interrupts.
 212       </para>
 213     </glossdef>
 214   </glossentry>
 215
 216 <!--
 217   <glossentry>
 218     <glossterm>
 219
 220     </glossterm>
 221     <glossdef>
 222       <para>
 223
 224       </para>
 225     </glossdef>
 226   </glossentry>
 227 -->
 228
 229 </glossary>
 230
 231