From: Ian Abbott Date: Tue, 8 May 2012 11:11:55 +0000 (+0100) Subject: doc/install.xml: A few DocBook mark-up changes. X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=5d91ff685d0fb2ad0ea4a7071667ecef747a6d86;p=comedilib.git doc/install.xml: A few DocBook mark-up changes. --- diff --git a/doc/install.xml b/doc/install.xml index 69c6e26..214a299 100644 --- a/doc/install.xml +++ b/doc/install.xml @@ -26,14 +26,15 @@ The good news is: on most systems PCI and USB based boards are configured automatically. The kernel will detect your data acquisition devices, will load the appropriate - kernel drivers and will create the /dev/comedi entries. + kernel drivers and will create the + /dev/comedi entries. bp1@bp1-x61:~/sandbox/comedilib$ ls -l /dev/comedi0* crw-rw---- 1 root iocard 98, 0 2012-04-26 23:41 /dev/comedi0 crw-rw---- 1 root iocard 98, 48 2012-04-26 23:41 /dev/comedi0_subd0 crw-rw---- 1 root iocard 98, 49 2012-04-26 23:41 /dev/comedi0_subd1 - Usually these devices belong to the group "iocard" as shown here. The only +Usually these devices belong to the group iocard as shown here. The only action you need to take is to become member of this group and then the &comedi; device is ready to be used. @@ -45,7 +46,8 @@ crw-rw---- 1 root iocard 98, 49 2012-04-26 23:41 /dev/comedi0_subd1 On embedded systems it might also be necessary to load the driver and then to configure the boards manually. In general manual configuration is done by running - the comedi_config command (as root). + the comedi_config command + (as root). Here is an example of how to use the command (perhaps you should read its man page now): @@ -53,7 +55,7 @@ crw-rw---- 1 root iocard 98, 49 2012-04-26 23:41 /dev/comedi0_subd1 This command says that the file /dev/comedi0 can be used to access the &comedi; - device that uses the labpc-1200 board, and that + device that uses the labpc-1200 board, and that you give it two run-time parameters (0x260 and 3). More parameters are possible, and their meaning is driver dependant. @@ -62,20 +64,20 @@ crw-rw---- 1 root iocard 98, 49 2012-04-26 23:41 /dev/comedi0_subd1 This tutorial goes through the process of configuring &comedi; for two devices, a - National Instruments AT-MIO-16E-10, and a - Data Translation DT2821-F-8DI. + National Instruments AT-MIO-16E-10, and a + Data Translation DT2821-F-8DI. - The NI board is plug-and-play. The current ni_atmio driver + The NI board is plug-and-play. The current ni_atmio driver has kernel-level ISAPNP support, which is used by default if you do not specify a base address. So you could simply - run comedi_config as + run comedi_config as comedi_config /dev/comedi0 ni_atmio - For the preceding comedi_config command to succeed, the - ni_atmio kernel module must + For the preceding comedi_config command to succeed, the + ni_atmio kernel module must be loaded first. For plug-n-play boards on modern kernels, the appropriate comedi kernel modules should get loaded automatically when your computer is booted. @@ -84,14 +86,14 @@ crw-rw---- 1 root iocard 98, 49 2012-04-26 23:41 /dev/comedi0_subd1 will list all the currently loaded modules. - For the Data Translation board, you need to know + For the Data Translation board, you need to know how the board's jumpers are configured in order to specify the correct - comedi_config parameters. These parameters for the board are given in the - kernel drivers section about the dt282x + comedi_config parameters. These parameters for the board are given in the + kernel drivers section about the dt282x driver. - The card discussed here is a DT2821-f-8di. The - entry for the dt282x driver tells you that the - comedi_config parameters give the driver the I/O base, + The card discussed here is a DT2821-f-8di. The + entry for the dt282x driver tells you that the + comedi_config parameters give the driver the I/O base, IRQ, DMA 1, DMA 2, and in addition the states of the differential/single-ended and unipolar/bipolar jumpers: @@ -167,7 +169,7 @@ comedi0: ni_atmio: 0x0260 at-mio-16e-10 ( irq = 3 ) talk to &comedi;. Call the command comedi_board_info, which provides information about each subdevice on the board. - Here's part of the output of the USB-DUX sigma + Here's part of the output for the USB-DUX sigma board (which is on /dev/comedi0), as a result of the command comedi_board_info -v. @@ -263,7 +265,7 @@ subdevice 3: - Here's the information from comedi's proc + Here's the information from &comedi;'s /proc/comedi file, which indicates what drivers are loaded and which boards are configured: @@ -284,9 +286,10 @@ usbduxsigma: This documentation feature currently returns the driver name, the device name, and the number of - subdevices. Following those lines are a list of the comedi kernel + subdevices. Following those lines are a list of the &comedi; kernel driver modules currently loaded, each followed by a list of the board - names it recognizes (names that can be used with comedi_config). + names it recognizes (names that can be used with + comedi_config).