qi-hardware/ben-wpan
1
0
Fork 0
mirror of git://projects.qi-hardware.com/ben-wpan.git synced 2024-11-22 20:03:09 +02:00
Code

prod/doc/: reduced excessive use of <B> ... </B>

Browse Source
This commit is contained in:
Werner Almesberger 2011-05-29 10:04:13 -03:00
parent 45746fdfa5
commit 8b26bb7130
4 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
prod/doc/analysis.hmac
View File

@ -184,7 +184,7 @@ the right:
<TR><TD>0 Hz<TD>Check voltages; check that the clock is enabled;
check for shorts around crystal; check connectivity of crystal
<TR><TD>0.999-1.001 MHz, ~3.3 Vpp<TD>Perform precision measurement with
<B>atrf-xtal</B>
atrf-xtal
<TR><TD>Other<TD>Check voltages; check for contamination around crystal
</TABLE>
<P>
@ -222,7 +222,7 @@ filter.
<TR><TD>0.999-1.001 MHz, ~3.3 Vpp<TD>Check presence of firmware; check for
shorts on SPI signals; check connectivity of SPI signals
<TR><TD>7.992-8.008 MHz, ~3.3 Vpp<TD>Perform precision measurement with
<B>atrf-xtal</B>
atrf-xtal
<TR><TD>Other<TD>Check voltages; check for contamination around crystal
</TABLE>
<P>
@ -238,7 +238,7 @@ depending on how much code was successfully flashed.
<SUBSECTION title="Precision measurements">
The clock frequency of <B>atben</B> can be measured with an accuracy
of about +/&minus; 100 ppm using the program <B>atrf-xtal</B>. <B>atrf-xtal</B>
of about +/&minus; 100 ppm using the program atrf-xtal. atrf-xtal
runs directly on the Ben and measures the duration of packet transmissions.
The transmission time depends on the bit clock which is in turn derived
from the oscillator.

4
prod/doc/flash.hmac
View File

@ -28,8 +28,8 @@ The microcontroller of <B>atusb</B> contains firmware that must be
loaded before the testing process can commence. The firmware consists
of the following two parts:
<OL>
<LI>The boot loader (via serial programming, using <B>avrdude</B>)
<LI>The application (via DFU, using <B>dfu-util</B>)
<LI>The boot loader (via serial programming, using avrdude)
<LI>The application (via DFU, using dfu-util)
</OL>
<P>
Note that <B>atben</B> has no microcontroller and therefore does not need

38
prod/doc/setup.hmac
View File

@ -37,13 +37,13 @@ and configuration process.
<SECTION ref="pcsw" title="PC software installation">
For a DUT and reference device role, the <B>ben-wpan</B> utilities
For a DUT and reference device role, the ben-wpan utilities
and the test scripts have to be installed on the PC. For flashing the
<B>atusb</B> application
firmware, also <B>dfu-util</B> and the firmware binary are required.
firmware, also dfu-util and the firmware binary are required.
<P>
The instructions below assume that a complete development environment
is already present on the PC, including <B>SDL</B> and <B>SDL_gfx</B>.
is already present on the PC, including SDL and SDL_gfx.
If any prerequisites are not met,
compilation will fail, and you'll have to install the corresponding
package and try again.
@ -65,13 +65,13 @@ make install
</PRE>
<P>
A different directory prefix can be chosen by overriding the
<B>INSTALL_PREFIX</B> variable, e.g.,
<SAMP>INSTALL_PREFIX</SAMP> variable, e.g.,
<PRE>
make INSTALL_PREFIX=/usr install
</PRE>
<P>
Note that the test scripts expect <SAMP>${INSTALL_PREFIX}/bin</SAMP>
to be in <B>PATH</B>.
to be in <SAMP>PATH</SAMP>.
<!-- ---------------------------------------------------------------------- -->
@ -80,7 +80,7 @@ to be in <B>PATH</B>.
<SUBSECTION title="Install test scripts">
The test scripts are in the directory <SAMP>prod/</SAMP> of the
<B>ben-wpan</B> project. They currently are designed to be run from
ben-wpan project. They currently are designed to be run from
this directory. Therefore, all that's necessary is to check out the
repository, as shown above.
@ -90,8 +90,8 @@ repository, as shown above.
<SUBSECTION title="Install dfu-util">
<B>dfu-util</B> is used to transfer the application firmware to
<B>atusb</B> boards. To build <B>dfu-util</B> from source, run these
dfu-util is used to transfer the application firmware to
<B>atusb</B> boards. To build dfu-util from source, run these
commands:
<PRE>
@ -104,7 +104,7 @@ make install
</PRE>
Note that some Linux distributions already provide a pre-compiled
version of <B>dfu-util</B>, which could be used instead of building
version of dfu-util, which could be used instead of building
it from source.
@ -160,10 +160,10 @@ If using <SAMP>prod/Makefile</SAMP> to run the production test process,
the names of the drivers for DUT and reference device are defined
through variables at the beginning of the Makefile. In particular,
if the host name or IP address under which the Ben is reached differs from
"ben", the value of <B>ATBEN_DUT</B> and <B>ATUSB_REF</B> will have be
changed accordingly.
"ben", the value of <SAMP>ATBEN_DUT</SAMP> and <SAMP>ATUSB_REF</SAMP>
will have be changed accordingly.
<P>
The Makefile also contains the variable <B>SPECTRUM_MARGIN</B> that
The Makefile also contains the variable <SAMP>SPECTRUM_MARGIN</SAMP> that
defines how many dB of tolerance should be allowed below and above the
reference signal strength. The default is to allow a margin of 5 dB in
either direction.
@ -179,9 +179,9 @@ configuration variables. If the names of the files containing the
<SECTION ref="bensw" title="Ben software installation">
For a DUT and reference device role, the <B>ben-wpan</B> utilities
For a DUT and reference device role, the ben-wpan utilities
have to be installed on a Ben. For flashing the <B>atusb</B> boot
loader, also <B>avrdude</B> and the boot loader binary are needed.
loader, also avrdude and the boot loader binary are needed.
<P>
The instructions below apply for OpenWrt and Jlime. For building
things from source, a cross-compilation toolchain has to be installed
@ -205,7 +205,7 @@ ssh ben 'cat >>/etc/dropbear/authorized_keys' <~/.ssh/id_rsa.pub
<SUBSECTION title="Install ben-wpan tools">
To build and install the <B>ben-wpan</B> tools on the Ben, first set
To build and install the ben-wpan tools on the Ben, first set
up networking between the PC and the Ben. If you have not yet checked
out the project's repository, run these commands:
@ -214,7 +214,7 @@ git clone git://projects.qi-hardware.com/ben-wpan.git
cd ben-wpan/tools
</PRE>
If you have already checked out the repository, <B>cd</B> to
If you have already checked out the repository, <SAMP>cd</SAMP> to
<SAMP>ben-wpan/tools/</SAMP> and run
<PRE>
@ -238,7 +238,7 @@ Finally, upload the tools to the Ben and install them under
make HOST=ben install
</PRE>
Where <B>ben</B> is the host name or IP address assigned to the Ben.
Where <SAMP>ben</SAMP> is the host name or IP address assigned to the Ben.
<!-- ---------------------------------------------------------------------- -->
@ -246,7 +246,7 @@ Where <B>ben</B> is the host name or IP address assigned to the Ben.
<SUBSECTION title="Install avrdude">
The <B>atusb</B> boot loader is flashed using <B>avrdude</B>. A pre-compiled
The <B>atusb</B> boot loader is flashed using avrdude. A pre-compiled
static binary (suitable for OpenWrt and Jlime) can be installed by running
the following two command on the Ben:
@ -255,7 +255,7 @@ wget http://downloads.qi-hardware.com/people/werner/wpan/bindist/avrdude-5.10-de
tar -xz -C / -f avrdude-5.10-de72af351f661b538add81cbc9965278a2f8c40c.tar.gz
</PRE>
Instructions for building <B>avrdude</B> from sources are
Instructions for building avrdude from sources are
<A href="http://projects.qi-hardware.com/index.php/p/ben-blinkenlights/source/tree/master/avrdude/README
">here</A>.

2
prod/doc/test.hmac
View File

@ -80,7 +80,7 @@ Of these tests, only "LED" and "Spectrum" require operator input. The
other tests run without interaction.
<P>
The test scripts log the commands they execute and their output in the
file <B>_log</B>.
file <SAMP>_log</SAMP>.
<!-- ---------------------------------------------------------------------- -->