aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs/octoclock_firmware_burner.1
diff options
context:
space:
mode:
authorNicholas Corgan <nick.corgan@ettus.com>2014-07-17 11:50:50 -0700
committerNicholas Corgan <nick.corgan@ettus.com>2014-07-23 07:37:32 -0700
commita6e18604befdb6a954542f7722c8d55424065621 (patch)
tree22168e6f4c41c931e38ccd07ff8881b56c8cd88a /host/docs/octoclock_firmware_burner.1
parent7423d1691fff3af08f8e42e3e09d8c8d9ec99fe8 (diff)
downloaduhd-a6e18604befdb6a954542f7722c8d55424065621.tar.gz
uhd-a6e18604befdb6a954542f7722c8d55424065621.tar.bz2
uhd-a6e18604befdb6a954542f7722c8d55424065621.zip
OctoClock firmware upgrade, added host driver
* OctoClock can communicate with UHD over Ethernet * Can read NMEA strings from GPSDO and send to host * Added multi_usrp_clock class for clock devices * uhd::device can now filter to return only USRP devices or clock devices * New OctoClock bootloader can accept firmware download over Ethernet * Added octoclock_burn_eeprom,octoclock_firmware_burner utilities * Added test_clock_synch example to show clock API
Diffstat (limited to 'host/docs/octoclock_firmware_burner.1')
-rw-r--r--host/docs/octoclock_firmware_burner.145
1 files changed, 45 insertions, 0 deletions
diff --git a/host/docs/octoclock_firmware_burner.1 b/host/docs/octoclock_firmware_burner.1
new file mode 100644
index 000000000..0494b3b37
--- /dev/null
+++ b/host/docs/octoclock_firmware_burner.1
@@ -0,0 +1,45 @@
+.TH "octoclock_firmware_burner" 1 "3.7.1" UHD "User Commands"
+.SH NAME
+octoclock_firmware_burner - OctoClock Firmware Burner
+.SH DESCRIPTION
+Burn firmware images onto an Ettus Research OctoClock device over Ethernet.
+.SH SYNOPSIS
+.B octoclock_firmware_burner [OPTIONS]
+.SH OPTIONS
+This program works best when only an IP address is specified.
+.IP "Device IP Address:"
+--addr=\fI"Address"\fR
+.IP "This help information:"
+--help
+.IP "Custom Firmware Filepath:"
+--fw-path=\fI"filepath"\fR
+.IP "List all OctoClock devices without burning"
+--list
+.SH EXAMPLES
+.SS Selecting a custom firmware path
+.sp
+octoclock_firmware_burner --addr=192.168.10.3 --fw-path=~/custom_octoclock_image.bin
+.ft
+.fi
+.SH SEE ALSO
+UHD documentation:
+.B http://files.ettus.com/uhd_docs/manual/html/index.html
+.LP
+Other UHD programs:
+.sp
+uhd_images_downloader(1) usrp2_card_burner(1) usrp_n2xx_simple_net_burner(1) usrp_x3xx_fpga_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) 2014 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.