docs: Moved manual to Doxygen

1 files changed, 114 insertions, 0 deletions

diff --git a/host/docs/images.dox b/host/docs/images.dox
new file mode 100644
index 000000000..02454c674
--- /dev/null
+++ b/host/docs/images.dox
@@ -0,0 +1,114 @@
+/*! \page page_images Firmware and FPGA Image Application Notes
+
+\tableofcontents
+
+\section images_overview Images Overview
+
+Every USRP device must be loaded with special firmware and FPGA images.
+The methods of loading images into the device vary among devices:
+
+-   **USRP1:** The host code will automatically load the firmware and
+    FPGA at runtime.
+-   **USRP2:** The user must manually write the images onto the USRP2 SD
+    card.
+-   **USRP-N Series:** The user programs an image into on-board storage,
+    which then is automatically loaded at runtime.
+-   **USRP-E Series:** The host code will automatically load the FPGA at
+    runtime.
+-   **USRP-B Series:** The host code will automatically load the FPGA at
+    runtime.
+-   **USRP-X Series:** The user programs an image into on-board storage,
+    which then is automatically loaded at runtime.
+
+\section images_prebuild Pre-built Images
+
+Pre-built images are available for download.
+
+- <a href="http://files.ettus.com/binaries/master_images/">Master Branch images</a>
+- <a href="http://files.ettus.com/binaries/maint_images/">Maint Branch images</a>
+
+The pre-built images come in two forms:
+
+-   bundled with UHD software in a platform-specific installer
+-   stand-alone platform-independent archive files
+
+\subsection images_prebuilt_downloader UHD Images Downloader
+
+The UHD images downloader downloads UHD images compatible with the host
+code and places them in the default images directory.
+
+By default, it can be found at: `<install-path>/lib/uhd/utils/uhd_images_downloader.py`
+
+By default, it installs images to: `<install-path>/share/uhd/images`
+
+\subsection images_prebuilt_installers Platform installers
+
+The UNIX-based installers will install the images into `/usr/share/uhd/images`.
+
+The Windows installers will install the images into `C:/Program Files/UHD/share/uhd/images`.
+
+\subsection images_prebuilt_archive Archive install
+
+When installing images from an archive, there are two options:
+
+<b>Option 1:</b>
+
+Unpack the archive into the UHD installation prefix. UHD software will
+always search `<install-path>/share/uhd/images` for image files.
+Where `<install-path>` was set by the `CMAKE_INSTALL_PREFIX` at
+configure-time.
+
+<b>Option 2:</b>
+
+Unpack the archive anywhere and set the `UHD_IMAGES_PATH`
+environment variable. `UHD_IMAGES_PATH` may contain a list of
+directories to search for image files.
+
+\section images_building Building Images
+
+The UHD source repository comes with the source code necessary to build
+both firmware and FPGA images for all supported devices.
+
+The build commands for a particular image can be found in
+`<uhd-repo-path>/images/Makefile`.
+
+\subsection images_building_xilinx Xilinx FPGA builds
+
+USRP Xilinx FPGA images are built with two different versions of ISE,
+depending on the device.
+
+The build requires that you have a UNIX-like environment with `Make`.
+Make sure that `xtclsh` from the Xilinx ISE bin directory is in your `$PATH`.
+
+- Xilinx ISE 14.4: USRP X3x0 Series
+
+See `<uhd-repo-path>/fpga/usrp3/top/`.
+
+- Xilinx ISSE 12.2: USRP N2x0, USRP B2x0, USRP B1x0, USRP E1x0, USRP2
+
+See `<uhd-repo-path>/fpga/usrp2/top/`.
+
+\subsection images_building_zpu ZPU firmware builds
+
+The ZPU GCC compiler is required to build the ZPU firmware images. The
+build requires that you have a UNIX-like environment with `CMake` and
+`Make`. Make sure that `zpu-elf-gcc` is in your `$PATH`.
+
+See `<uhd-repo-path>/firmware/zpu`.
+
+\subsection images_building_altera Altera FPGA builds
+
+Quartus is required to build the Altera FPGA image for the USRP1.
+Pre-built images can also be found in `<uhd-repo-path>/fpga/usrp1/rbf`.
+
+See `<uhd-repo-path>/fpga/usrp1/toplevel/`.
+
+\subsection images_building_fx2 FX2 firmware builds
+
+The SDCC compiler is required to build the FX2 firmware images. The
+build requires that you have a UNIX-like environment with `CMake` and `Make`.
+
+See `<uhd-repo-path>/firmware/fx2`.
+
+*/
+// vim:ft=doxygen: