From b0a4e2ad081cc55ad309d44b59583f0140f87608 Mon Sep 17 00:00:00 2001 From: Nicholas Corgan Date: Fri, 3 May 2013 10:54:36 -0700 Subject: UHD has man pages now * Linux installations will automatically install man pages * Moved usrp_n2xx_simple_net_burner and usrp2_card_burner into bin --- host/CMakeLists.txt | 1 + host/cmake/Modules/FindGZip.cmake | 21 ++++++ host/cmake/Modules/UHDPackage.cmake | 4 ++ host/docs/CMakeLists.txt | 46 +++++++++++++ host/docs/uhd_cal_rx_iq_balance.1 | 68 +++++++++++++++++++ host/docs/uhd_cal_tx_dc_offset.1 | 68 +++++++++++++++++++ host/docs/uhd_cal_tx_iq_balance.1 | 68 +++++++++++++++++++ host/docs/uhd_find_devices.1 | 108 ++++++++++++++++++++++++++++++ host/docs/uhd_images_downloader.1 | 54 +++++++++++++++ host/docs/uhd_usrp_probe.1 | 114 ++++++++++++++++++++++++++++++++ host/docs/usrp2_card_burner.1 | 52 +++++++++++++++ host/docs/usrp_n2xx_simple_net_burner.1 | 59 +++++++++++++++++ host/utils/CMakeLists.txt | 33 ++++++--- 13 files changed, 687 insertions(+), 9 deletions(-) create mode 100644 host/cmake/Modules/FindGZip.cmake create mode 100644 host/docs/uhd_cal_rx_iq_balance.1 create mode 100644 host/docs/uhd_cal_tx_dc_offset.1 create mode 100644 host/docs/uhd_cal_tx_iq_balance.1 create mode 100644 host/docs/uhd_find_devices.1 create mode 100644 host/docs/uhd_images_downloader.1 create mode 100644 host/docs/uhd_usrp_probe.1 create mode 100644 host/docs/usrp2_card_burner.1 create mode 100644 host/docs/usrp_n2xx_simple_net_burner.1 diff --git a/host/CMakeLists.txt b/host/CMakeLists.txt index 21a73565c..585a5e874 100644 --- a/host/CMakeLists.txt +++ b/host/CMakeLists.txt @@ -46,6 +46,7 @@ IF(NOT DEFINED PKG_LIB_DIR) SET(PKG_LIB_DIR ${PKG_DATA_DIR}) ENDIF() SET(PKG_DOC_DIR share/doc/uhd) +SET(PKG_MAN_DIR share/man/man1) ######################################################################## # Local Include Dir diff --git a/host/cmake/Modules/FindGZip.cmake b/host/cmake/Modules/FindGZip.cmake new file mode 100644 index 000000000..05fe26b4c --- /dev/null +++ b/host/cmake/Modules/FindGZip.cmake @@ -0,0 +1,21 @@ +# +# Copyright 2013 Ettus Research LLC +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# + +######################################################################## +FIND_PROGRAM(GZIP_EXECUTABLE NAMES gzip) +INCLUDE(FindPackageHandleStandardArgs) +FIND_PACKAGE_HANDLE_STANDARD_ARGS(GZip DEFAULT_MSG GZIP_EXECUTABLE) diff --git a/host/cmake/Modules/UHDPackage.cmake b/host/cmake/Modules/UHDPackage.cmake index a535241a7..5e2303ff8 100644 --- a/host/cmake/Modules/UHDPackage.cmake +++ b/host/cmake/Modules/UHDPackage.cmake @@ -155,6 +155,10 @@ FOREACH(filename preinst postinst prerm postrm) ${CMAKE_BINARY_DIR}/debian/${filename} @ONLY) ENDFOREACH(filename) +CONFIGURE_FILE( + ${CMAKE_SOURCE_DIR}/cmake/debian/watch + ${CMAKE_BINARY_DIR}/debian/watch +@ONLY) ######################################################################## # Setup CPack RPM diff --git a/host/docs/CMakeLists.txt b/host/docs/CMakeLists.txt index f56358ca9..3c49f8088 100644 --- a/host/docs/CMakeLists.txt +++ b/host/docs/CMakeLists.txt @@ -106,3 +106,49 @@ IF(ENABLE_DOXYGEN) ADD_CUSTOM_TARGET(doxygen_docs ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR_DOXYGEN}) INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR_DOXYGEN} DESTINATION ${PKG_DOC_DIR} COMPONENT doxygen) ENDIF(ENABLE_DOXYGEN) + +######################################################################## +# List of man page sources +######################################################################## + +SET(man_page_sources + uhd_cal_rx_iq_balance.1 + uhd_cal_tx_dc_offset.1 + uhd_cal_tx_iq_balance.1 + uhd_find_devices.1 + uhd_images_downloader.1 + uhd_usrp_probe.1 + usrp_n2xx_simple_net_burner.1 + usrp2_card_burner.1 +) + +######################################################################## +# Setup man pages +######################################################################## +MESSAGE(STATUS "") +FIND_PACKAGE(GZip) + +LIBUHD_REGISTER_COMPONENT("Man Pages" ENABLE_MAN_PAGES ON "GZIP_FOUND;LINUX" OFF) + +IF(ENABLE_MAN_PAGES) + #Generate man pages + FOREACH(manfile ${man_page_sources}) + #make the gzip file depend on the text file + STRING(REPLACE ".1" "" PROGRAM_NAME "${manfile}") + SET(gzfile "${CMAKE_CURRENT_BINARY_DIR}/${manfile}.gz") + SET(manfile "${CMAKE_CURRENT_SOURCE_DIR}/${manfile}") + ADD_CUSTOM_COMMAND( + OUTPUT ${gzfile} + DEPENDS ${manfile} + COMMAND ${GZIP_EXECUTABLE} -cf ${manfile} > ${gzfile} + COMMENT "Generating ${PROGRAM_NAME} man page" + ) + + #make the man page target depend on the gz file + LIST(APPEND man_page_gz_files ${gzfile}) + INSTALL(FILES ${gzfile} DESTINATION ${PKG_MAN_DIR} COMPONENT manpages) + ENDFOREACH(manfile ${man_page_sources}) + + #make the man pages a build-time dependency + ADD_CUSTOM_TARGET(man_page_gzips ALL DEPENDS ${man_page_gz_files}) +ENDIF(ENABLE_MAN_PAGES) diff --git a/host/docs/uhd_cal_rx_iq_balance.1 b/host/docs/uhd_cal_rx_iq_balance.1 new file mode 100644 index 000000000..073d8ce63 --- /dev/null +++ b/host/docs/uhd_cal_rx_iq_balance.1 @@ -0,0 +1,68 @@ +.TH "uhd_cal_rx_iq_balance" "1" "3.5.1" "UHD" "User Commands" +.SH NAME +uhd_cal_rx_iq_balance \- Generate RX IQ Balance Calibration Table for a UHD Device +.SH DESCRIPTION +The Universal Software Radio Peripheral Hardware Drivers handle calibration +information. This application reduces RX IQ imbalance within the specified frequency +range using transmit leakage into the receive path. Remove all external hardware +from the RF antenna ports before using this application. This can take up to +several minutes with default settings. +.LP +NOTE: This application can only be used with the WBX, SBX, XCVR2450, and RFX daughterboards. +.SH OPTIONS +.TP +\fB\-\-help\fR +help message +.TP +\fB\-\-verbose\fR +enable some verbose +.TP +\fB\-\-args\fR arg +device address args [default = ""] +.TP +\fB\-\-tx_wave_freq\fR arg (=507123) +Transmit wave frequency in Hz +.TP +\fB\-\-tx_wave_ampl\fR arg (=0.69999999999999996) +Transmit wave amplitude in counts +.TP +\fB\-\-tx_offset\fR arg (=934400) +TX LO offset from the RX LO in Hz +.TP +\fB\-\-freq_start\fR arg +Frequency start in Hz (will use beginning of frequency range if unspecified) +.TP +\fB\-\-freq_stop\fR arg +Frequency stop in Hz (will use end of frequency range if unspecified) +.TP +\fB\-\-freq_step\fR arg (=7300000) +Step size for LO sweep in Hz +.TP +\fB\-\-nsamps\fR arg (=10000) +Samples per data capture +.PP +.SH SEE ALSO +UHD documentation: +.B http://files.ettus.com/uhd_docs/manual/html/index.html +.LP +GR-UHD documentation: +.B http://gnuradio.org/doc/doxygen/page_uhd.html +.LP +Other UHD programs: +.sp +uhd_cal_tx_dc_offset(1) uhd_cal_tx_iq_balance(1) +.SH AUTHOR +This manual page was written by Maitland Bottoms and Nicholas Corgan +for the Debian project (but may be used by others). +.SH COPYRIGHT +Copyright (c) 2012 Ettus Research LLC +.LP +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +.LP +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. diff --git a/host/docs/uhd_cal_tx_dc_offset.1 b/host/docs/uhd_cal_tx_dc_offset.1 new file mode 100644 index 000000000..d64120242 --- /dev/null +++ b/host/docs/uhd_cal_tx_dc_offset.1 @@ -0,0 +1,68 @@ +.TH "uhd_cal_tx_dc_offset" "1" "3.5.1" "UHD" "User Commands" +.SH NAME +uhd_cal_tx_dc_offset \- Generate TX DC Offset Calibration Table for a UHD Device +.SH DESCRIPTION +The Universal Software Radio Peripheral Hardware Drivers handle calibration +information. This application reduces TX DC offset within the specified frequency +range using transmit leakage into the receive path. Remove all external hardware +from the RF antenna ports before using this application. This can take up to +several minutes with default settings. +.LP +NOTE: This application can only be used with the WBX, SBX, XCVR2450, and RFX daughterboards. +.SH OPTIONS +.TP +\fB\-\-help\fR +help message +.TP +\fB\-\-verbose\fR +enable some verbose +.TP +\fB\-\-args\fR arg +device address args [default = ""] +.TP +\fB\-\-tx_wave_freq\fR arg (=507123) +Transmit wave frequency in Hz +.TP +\fB\-\-tx_wave_ampl\fR arg (=0.69999999999999996) +Transmit wave amplitude in counts +.TP +\fB\-\-rx_offset\fR arg (=934400) +RX LO offset from the TX LO in Hz +.TP +\fB\-\-freq_start\fR arg +Frequency start in Hz (will use beginning of frequency range if unspecified) +.TP +\fB\-\-freq_stop\fR arg +Frequency stop in Hz (will use end of frequency range if unspecified) +.TP +\fB\-\-freq_step\fR arg (=7300000) +Step size for LO sweep in Hz +.TP +\fB\-\-nsamps\fR arg (=10000) +Samples per data capture +.PP +.SH SEE ALSO +UHD documentation: +.B http://files.ettus.com/uhd_docs/manual/html/index.html +.LP +GR-UHD documentation: +.B http://gnuradio.org/doc/doxygen/page_uhd.html +.LP +Other UHD programs: +.sp +uhd_cal_rx_iq_balance(1) uhd_cal_tx_iq_balance(1) +.SH AUTHOR +This manual page was written by Maitland Bottoms and Nicholas Corgan +for the Debian project (but may be used by others). +.SH COPYRIGHT +Copyright (c) 2012 Ettus Research LLC +.LP +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +.LP +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. diff --git a/host/docs/uhd_cal_tx_iq_balance.1 b/host/docs/uhd_cal_tx_iq_balance.1 new file mode 100644 index 000000000..f4fdbd12f --- /dev/null +++ b/host/docs/uhd_cal_tx_iq_balance.1 @@ -0,0 +1,68 @@ +.TH "uhd_cal_tx_iq_balance" "1" "3.5.1" "UHD" "User Commands" +.SH NAME +uhd_cal_tx_iq_balance \- Generate TX IQ Balance Calibration Table for a UHD Device +.SH DESCRIPTION +The Universal Software Radio Peripheral Hardware Drivers handle calibration +information. This application reduces TX IQ imbalance within the specified frequency +range using transmit leakage into the receive path. Remove all external hardware +from the RF antenna ports before using this application. This can take up to +several minutes with default settings. +.LP +NOTE: This application can only be used with the WBX, SBX, XCVR2450, and RFX daughterboards. +.SH OPTIONS +.TP +\fB\-\-help\fR +help message +.TP +\fB\-\-verbose\fR +enable some verbose +.TP +\fB\-\-args\fR arg +device address args [default = ""] +.TP +\fB\-\-tx_wave_freq\fR arg (=507123) +Transmit wave frequency in Hz +.TP +\fB\-\-tx_wave_ampl\fR arg (=0.69999999999999996) +Transmit wave amplitude in counts +.TP +\fB\-\-rx_offset\fR arg (=934400) +RX LO offset from the TX LO in Hz +.TP +\fB\-\-freq_start\fR arg +Frequency start in Hz (will use beginning of frequency range if unspecified) +.TP +\fB\-\-freq_stop\fR arg +Frequency stop in Hz (will use end of frequency range if unspecified) +.TP +\fB\-\-freq_step\fR arg (=7300000) +Step size for LO sweep in Hz +.TP +\fB\-\-nsamps\fR arg (=10000) +Samples per data capture +.PP +.SH SEE ALSO +UHD documentation: +.B http://files.ettus.com/uhd_docs/manual/html/index.html +.LP +GR-UHD documentation: +.B http://gnuradio.org/doc/doxygen/page_uhd.html +.LP +Other UHD programs: +.sp +uhd_cal_tx_dc_offset(1) uhd_cal_rx_iq_balance(1) +.SH AUTHOR +This manual page was written by Maitland Bottoms and Nicholas Corgan +for the Debian project (but may be used by others). +.SH COPYRIGHT +Copyright (c) 2012 Ettus Research LLC +.LP +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +.LP +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. diff --git a/host/docs/uhd_find_devices.1 b/host/docs/uhd_find_devices.1 new file mode 100644 index 000000000..7dc0dd470 --- /dev/null +++ b/host/docs/uhd_find_devices.1 @@ -0,0 +1,108 @@ +.TH "uhd_find_devices" 1 "3.5.1" UHD "User Commands" +.SH NAME +uhd_find_devices \- USRP Hardware Driver Discovery Utility +.SH DESCRIPTION +Find UHD-supporting Software Radio Peripherals attached by USB, +network or embedded configuration. +.LP +The UHD package is the universal hardware driver for Ettus Research +products. The goal is to provide a host driver and API for +current and future Ettus Research products. Users will be able to use +the UHD driver standalone or with 3rd party applications. +.LP +Hardware supporting UHD drivers includes the Universal Software Radio +Peripheral, or USRP, available in several models. +.SH SYNOPSIS +.B uhd_find_devices [OPTIONS] +.SH OPTIONS +.IP "Device Address Arguments:" +--args \fIarg\fR +.IP "This help information:" +--help +.SH IDENTIFYING USRP DEVICES +.sp +Devices are addressed through key/value string pairs. +These string pairs can be used to narrow down the search for a specific device or group of devices. +Most UHD utility applications and examples have a \-\-args parameter that takes a device address, +where the device address is expressed as a delimited string. +See the documentation in types/device_addr.hpp for reference. + +Every device has several ways of identifying it on the host system. +.SS Identifying by hardware identifier +.sp + +All USRP devices can be found through their hardware series identifier, which match to USRP +devices as follows: + +Argument | Device + +type=usrp1 | USRP1 + +type=usrp2 | USRP2, USRP N200, USRP N210 + +type=b100 | USRP B100 + +type=e100 | USRP E100, USRP E110 + +.SS Identifying by serial number + +All USRP devices are given a unique serial number, which can be used to identify a device as follows: + +serial=12345678 + +.SS Identifying by IP address + +USRP2, USRP N200, and USRP N210 devices connected to the host machine can all be found through their +IP addresses, as follows: + +addr=192.168.10.2 + +.SS Identifying by name + +Users have the option of giving their USRP devices short names using the usrp_burn_mb_eeprom utility +in lib/uhd/utils. Devices that have been given a name can be identified as follows: + +name=foo + +.fi +.SH EXAMPLES +.SS Device discovery via command line +.sp +Device address arguments can be supplied to narrow the scope of the search. +.sp +.nf +.ft C +uhd_find_devices \-\-args="type=usrp1" + +\-\- OR \-\- + +uhd_find_devices \-\-args="serial=12345678" +.ft P +.fi +.IP "Find all devices available to this system:" +uhd_find_devices +.SH SEE ALSO +UHD documentation: +.B http://files.ettus.com/uhd_docs/manual/html/index.html +.LP +GR-UHD documentation: +.B http://gnuradio.org/doc/doxygen/page_uhd.html +.LP +Other UHD programs: +.sp +uhd_usrp_probe(1) +.SH AUTHOR +This manual page was written by Maitland Bottoms and Nicholas Corgan +for the Debian project (but may be used by others). +.SH COPYRIGHT +Copyright (c) 2010 Ettus Research LLC +.LP +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +.LP +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. diff --git a/host/docs/uhd_images_downloader.1 b/host/docs/uhd_images_downloader.1 new file mode 100644 index 000000000..ece826cb5 --- /dev/null +++ b/host/docs/uhd_images_downloader.1 @@ -0,0 +1,54 @@ +.TH "uhd_images_downloader" 1 "3.5.1" UHD "User Commands" +.SH NAME +uhd_images_downloader \- USRP Hardware Driver firmware/FPGA downloader +.SH DESCRIPTION +The UHD package is the universal hardware driver for Ettus Research +products. The goal of the UHD is to provide a host driver and API for +current and future Ettus Research products. Users will be able to use +the UHD driver standalone or with 3rd party applications. +.LP +Hardware supporting UHD drivers includes the Universal Software Radio +Peripheral, or USRP, available in several models. +.LP +This program installs the firmware and FPGA binaries from Ettus Research +matching this UHD driver release onto the host system. If the uhd-images +package is installed, there is no need to run this installer. +.SH SYNOPSIS +.B uhd_images_downloader +Usage: uhd_images_downloader.py [options] +.SH OPTIONS +This program works best without any arguments. +.PP + -h, --help show this help message and exit +.PP + --download-location=DOWNLOAD_LOCATION + Set custom download location for images, + [default=/usr/share/uhd/images] +.PP + --buffer-size=BUFFER_SIZE + Set download buffer size, [default=8192] +.SH SEE ALSO +UHD documentation: +.B http://files.ettus.com/uhd_docs/manual/html/index.html +.LP +GR-UHD documentation: +.B http://gnuradio.org/doc/doxygen/page_uhd.html +.LP +Other UHD programs: +.sp +usrp2_card_burner(1) usrp_n2xx_simple_net_burner(1) +.SH AUTHOR +This manual page was written by Maitland Bottoms and Nicholas Corgan +for the Debian project (but may be used by others). +.SH COPYRIGHT +Copyright (c) 2012 Ettus Research LLC +.LP +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +.LP +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. diff --git a/host/docs/uhd_usrp_probe.1 b/host/docs/uhd_usrp_probe.1 new file mode 100644 index 000000000..7e82bf99a --- /dev/null +++ b/host/docs/uhd_usrp_probe.1 @@ -0,0 +1,114 @@ +.TH "uhd_usrp_probe" 1 "3.5.1" UHD "User Commands" +.SH NAME +uhd_usrp_probe \- Universal Hardware Driver Peripheral Report Utility +.SH DESCRIPTION +Report detailed information on UHD-supported Software Radio Peripherals +attached by USB, network, or embedded configuration. +.LP +The UHD package is the universal hardware driver for Ettus Research products. The goal +is to provide a host driver and API for current and future Ettus Research products. +Users will be able to use the UHD driver standalone or with 3rd party applications. +.LP +Details include unit names, revision numbers, and available sensors on all attached +USRP motherboards and daughterboards. +.SH SYNOPSIS +.B uhd_usrp_probe [OPTIONS] +.SH OPTIONS +.IP "Device Address Arguments:" +--args \fIarg\fR +.IP "Print a complete property tree:" +--tree +.IP "Query a string value from the properties tree:" +--string \fIarg\fR +.IP "Print the version string and exit:" +--version +.IP "This help information:" +--help +.SH IDENTIFYING USRP DEVICES +.sp +Devices are addressed through key/value string pairs. +These string pairs can be used to narrow down the search for a specific device or group of devices. +Most UHD utility applications and examples have a \-\-args parameter that takes a device address, +where the device address is expressed as a delimited string. +See the documentation in types/device_addr.hpp for reference. + +Every device has several ways of identifying it on the host system. +.SS Identifying by hardware identifier +.sp + +All USRP devices can be found through their hardware series identifier, which match to USRP +devices as follows: + +Argument | Device + +type=usrp1 | USRP1 + +type=usrp2 | USRP2, USRP N200, USRP N210 + +type=b100 | USRP B100 + +type=e100 | USRP E100, USRP E110 + +.SS Identifying by serial number + +All USRP devices are given a unique serial number, which can be used to identify a device as follows: + +serial=12345678 + +.SS Identifying by IP address + +USRP2, USRP N200, and USRP N210 devices connected to the host machine can all be found through their +IP addresses, as follows: + +addr=192.168.10.2 + +.SS Identifying by name + +Users have the option of giving their USRP devices short names using the usrp_burn_mb_eeprom utility +in lib/uhd/utils. Devices that have been given a name can be identified as follows: + +name=foo + +.fi +.fi +.SH EXAMPLES +.SS Device discovery via command line +.sp +Device address arguments can be supplied to narrow the scope of the search. +.sp +.nf +.ft C +uhd_usrp_probe \-\-args="type=usrp1" + +\-\- OR \-\- + +uhd_usrp_probe \-\-args="serial=12345678" +.ft P +.fi +.IP "Find all devices available to this system:" +uhd_usrp_probe +.SH SEE ALSO +UHD documentation: +.B http://files.ettus.com/uhd_docs/manual/html/index.html +.LP +GR-UHD documentation: +.B http://gnuradio.org/doc/doxygen/page_uhd.html +.LP +Other UHD programs: +.sp +uhd_find_devices(1) +.SH AUTHOR +This manual page was written by Maitland Bottoms and Nicholas Corgan +for the Debian project (but may be used by others). +.SH COPYRIGHT +Copyright (c) 2010 Ettus Research LLC +.LP +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +.LP +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. diff --git a/host/docs/usrp2_card_burner.1 b/host/docs/usrp2_card_burner.1 new file mode 100644 index 000000000..d6a12b073 --- /dev/null +++ b/host/docs/usrp2_card_burner.1 @@ -0,0 +1,52 @@ +.TH "usrp2_card_burner" 1 "3.5.1" UHD "User Commands" +.SH NAME +usrp2_card_burner - USRP N-Series FPGA/Firmware Burner +.SH DESCRIPTION +Burn USRP2 firmware and FPGA images onto an SD card plugged into +the host machine. +.SH SYNOPSIS +.B usrp2_card_burner [OPTIONS] +.SH OPTIONS +.IP "Raw device path:" +--addr=\fI"Address"\fR (default: 192.168.10.2) +.IP "This help information:" +--help +.IP "Firmware Filepath:" +--fw=\fI"filepath"\fR +.IP "FPGA Filepath:" +--fpga=\fI"filepath"\fR +.IP "List all USRP devices without burning" +--list +.IP "Override safety check" +--force +.SH EXAMPLES +.SS Standard burning procedure +.sp +usrp2_card_burner --dev=/dev/sdd1 --fw=usrp2_fw.bin --fpga=usrp2_fpga.bin +.ft +.fi +.SH SEE ALSO +UHD documentation: +.B http://files.ettus.com/uhd_docs/manual/html/index.html +.LP +GR-UHD documentation: +.B http://gnuradio.org/doc/doxygen/page_uhd.html +.LP +Other UHD programs: +.sp +uhd_images_downloader(1) usrp_n2xx_simple_net_burner(1) +.SH AUTHOR +This manual page was written by Nicholas Corgan +for the Debian project (but may be used by others). +.SH COPYRIGHT +Copyright (c) 2012 Ettus Research LLC +.LP +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +.LP +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. diff --git a/host/docs/usrp_n2xx_simple_net_burner.1 b/host/docs/usrp_n2xx_simple_net_burner.1 new file mode 100644 index 000000000..6e8e38fae --- /dev/null +++ b/host/docs/usrp_n2xx_simple_net_burner.1 @@ -0,0 +1,59 @@ +.TH "usrp_n2xx_simple_net_burner" 1 "3.5.1" UHD "User Commands" +.SH NAME +usrp_n2xx_simple_net_burner - USRP N-Series FPGA/Firmware Burner +.SH DESCRIPTION +Burn firmware and FPGA images onto connected USRP N-Series devices. The +program takes an IP address as an argument, queries the USRP device to +identify which model and revision it is, and burns the appropriate images +over Ethernet. +.SH SYNOPSIS +.B usrp_n2xx_simple_net_burner [OPTIONS] +.SH OPTIONS +This program works best when only an IP address is specified. +.IP "Device IP Address:" +--addr=\fI"Address"\fR (default: 192.168.10.2) +.IP "This help information:" +--help +.IP "Custom Firmware Filepath:" +--fw=\fI"filepath"\fR +.IP "Custom FPGA Filepath:" +--fpga=\fI"filepath"\fR +.IP "Don't burn firmware:" +--no_fw +.IP "Don't burn FPGA:" +--no_fpga +.IP "Automatically reboot USRP device after burning" +--auto_reboot +.IP "List all USRP devices without burning" +--list +.SH EXAMPLES +.SS Selecting a USRP device with a non-standard IP address +.sp +usrp_n2xx_simple_net_burner --addr=192.168.10.3 +.ft +.fi +.SH SEE ALSO +UHD documentation: +.B http://files.ettus.com/uhd_docs/manual/html/index.html +.LP +GR-UHD documentation: +.B http://gnuradio.org/doc/doxygen/page_uhd.html +.LP +Other UHD programs: +.sp +uhd_images_downloader(1) usrp2_card_burner(1) +.SH AUTHOR +This manual page was written by Nicholas Corgan +for the Debian project (but may be used by others). +.SH COPYRIGHT +Copyright (c) 2012 Ettus Research LLC +.LP +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +.LP +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. diff --git a/host/utils/CMakeLists.txt b/host/utils/CMakeLists.txt index 6fc11d747..73be96016 100644 --- a/host/utils/CMakeLists.txt +++ b/host/utils/CMakeLists.txt @@ -24,6 +24,7 @@ SET(util_runtime_sources uhd_cal_rx_iq_balance.cpp uhd_cal_tx_dc_offset.cpp uhd_cal_tx_iq_balance.cpp + usrp_n2xx_simple_net_burner.cpp ) #for each source: build an executable and install @@ -41,7 +42,6 @@ SET(util_share_sources query_gpsdo_sensors.cpp usrp_burn_db_eeprom.cpp usrp_burn_mb_eeprom.cpp - usrp_n2xx_simple_net_burner.cpp ) IF(ENABLE_USB) @@ -66,6 +66,8 @@ FOREACH(util_source ${util_share_sources}) INSTALL(TARGETS ${util_name} RUNTIME DESTINATION ${PKG_LIB_DIR}/utils COMPONENT utilities) ENDFOREACH(util_source) +INSTALL(TARGETS usrp_n2xx_simple_net_burner RUNTIME DESTINATION ${PKG_LIB_DIR}/utils COMPONENT utilities) + #UHD images downloader configuration CONFIGURE_FILE( ${CMAKE_CURRENT_SOURCE_DIR}/uhd_images_downloader.py.in @@ -86,6 +88,13 @@ IF(LINUX) ENDIF(LINUX) IF(ENABLE_USRP2) + SET(burners + usrp2_card_burner.py + usrp2_card_burner_gui.py + usrp_n2xx_net_burner.py + usrp_n2xx_net_burner_gui.py + ) + IF(WIN32 AND UHD_RELEASE_MODE) #include dd.exe FILE(DOWNLOAD "http://files.ettus.com/dd.exe" @@ -103,13 +112,19 @@ IF(ENABLE_USRP2) DESTINATION ${PKG_LIB_DIR}/utils COMPONENT utilities ) + INSTALL(PROGRAMS + usrp2_card_burner.py + RENAME usrp2_card_burner + DESTINATION ${RUNTIME_DIR} + COMPONENT utilities + ) ENDIF(LINUX) - INSTALL(PROGRAMS - usrp2_card_burner.py - usrp2_card_burner_gui.py - usrp_n2xx_net_burner.py - usrp_n2xx_net_burner_gui.py - DESTINATION ${PKG_LIB_DIR}/utils - COMPONENT utilities - ) + FOREACH(burner ${burners}) + INSTALL(PROGRAMS + ${burner} + DESTINATION ${PKG_LIB_DIR}/utils + COMPONENT utilities + ) + ENDFOREACH(burner ${burners}) + ENDIF(ENABLE_USRP2) -- cgit v1.2.3