N300/N310 Getting Started Guides - Revision history

Ettus: Redirected page to USRP N300/N310/N320/N321 Getting Started Guide

2019-04-19T18:35:36Z

Redirected page to USRP N300/N310/N320/N321 Getting Started Guide

Show changes

Ettus: /* USRP N3xx Device Specific Operations */

2019-02-18T03:12:45Z

‎USRP N3xx Device Specific Operations

Ettus: /* USRP N300/N310 Device Specific Operations */

2019-02-18T03:12:29Z

‎USRP N300/N310 Device Specific Operations

Ettus: /* Kit Contents */

2019-02-18T02:59:44Z

‎Kit Contents

Ettus: /* Kit Contents */

2019-02-18T02:59:32Z

‎Kit Contents

Ettus: /* N300/N310 */

2019-02-18T02:58:02Z

‎N300/N310

Ettus: /* Embedded Mode FPGA Image Update */

2019-02-18T02:55:42Z

‎Embedded Mode FPGA Image Update

Ettus: /* Updating the Network Configurations */

2019-02-18T02:53:27Z

‎Updating the Network Configurations

Ettus: /* Updating the File-system */

2019-02-18T02:52:49Z

‎Updating the File-system

Ettus: /* Install and Setup the Software Tools on Your Host Computer */

2019-02-18T01:32:51Z

‎Install and Setup the Software Tools on Your Host Computer

@@ Line 1,082: / Line 1,082: @@
 ===Enable Auto Booting===
-Auto booting of the N310 when power is applied can be configured by enabling the flag on the device's EEPROM with the following command:
+Auto booting of the N3xx when power is applied can be configured by enabling the flag on the device's EEPROM with the following command:
      eeprom-set-flags 0x1

@@ Line 1,071: / Line 1,071: @@
      --tx_subdev "A:0 A:1 B:0 B:1"
-==USRP N300/N310 Device Specific Operations==
+==USRP N3xx Device Specific Operations==
 ===White Rabbit Ethernet-Based Synchronization===

@@ Line 23: / Line 23: @@
 * Getting Started Guide
 * Ettus Research Sticker
-||[[File:n310 kit.png|450px|center]]
+||[[File:n310 kit.png|500px|center]]
 |}

@@ Line 2: / Line 2: @@
 ===N300===
 {|
-||
+|style="vertical-align:top"|
 * USRP N300
 * DC Power Supply (12V, 7A)
@@ Line 12: / Line 12: @@
 ||[[File:n300 kit.png|450px|center]]
 |}
 ===N310===
 {|
-||
+|style="vertical-align:top"|
 * USRP N310
 * DC Power Supply (12V, 7A)
@@ Line 23: / Line 23: @@
 * Getting Started Guide
 * Ettus Research Sticker
-||[[File:n310 kit.png|500px|center]]
+||[[File:n310 kit.png|450px|center]]
 |}

@@ Line 1: / Line 1: @@
 ==Kit Contents==
-===N300/N310===
+===N300===
-* USRP N300/N310
+{|
 * DC Power Supply (12V, 7A)
 * 1 RJ45 – SFP+ Adapter
@@ Line 8: / Line 10: @@
 * Getting Started Guide
 * Ettus Research Sticker
 ||[[File:n300 kit.png|450px|center]]
 ||[[File:n310 kit.png|500px|center]]
 |}

@@ Line 401: / Line 401: @@
 It is possible to update the FPGA image when operated in Embedded mode. Connect to the ARM CPU via Serial Console or SSH as detailed in the section above.
-Run the command <code>uhd_images_downloader</code> to download the FPGA images to the device's file system:
+Updating the FPGA image from the ARM CPU is the same as detailed above for a Host mode update, except it is not required to provide an <code>addr</code> device argument.
-NOTE: The 1 GB RJ45 management interface will require Internet access for the next step.
+    uhd_image_loader --args "type=n3xx,fpga=HG"
-−
-<pre>
-# uhd_images_downloader
-[INFO] Images destination: /usr/share/uhd/images
-[INFO] No inventory file found at /usr/share/uhd/images/inventory.json. Creating an empty one.
-kB / 00006 kB (100%) usrp1_b100_fw_default-g6bea23d.zip
-kB / 11698 kB (100%) n3xx_n310_fpga_default-g61cdf981.zip
-kB / 02757 kB (100%) usrp2_n210_fpga_default-g6bea23d.zip
-kB / 02076 kB (100%) n230_n230_fpga_default-g61cdf981.zip
-kB / 00522 kB (100%) usrp1_b100_fpga_default-g6bea23d.zip
-kB / 00465 kB (100%) b2xx_b200_fpga_default-g1c568e6.zip
-kB / 02415 kB (100%) usrp2_n200_fpga_default-g6bea23d.zip
-kB / 29462 kB (100%) x3xx_x310_fpga_default-g61cdf981.zip
-kB / 00517 kB (100%) b2xx_b205mini_fpga_default-g1c568e6.zip
-kB / 28343 kB (100%) x3xx_x300_fpga_default-g61cdf981.zip
-kB / 00017 kB (100%) octoclock_octoclock_fw_default-g14000041.zip
-kB / 04839 kB (100%) usb_common_windrv_default-g14000041.zip
-kB / 00007 kB (100%) usrp2_usrp2_fw_default-g6bea23d.zip
-kB / 00009 kB (100%) usrp2_n200_fw_default-g6bea23d.zip
-kB / 00450 kB (100%) usrp2_usrp2_fpga_default-g6bea23d.zip
-kB / 00144 kB (100%) b2xx_common_fw_default-g14000041.zip
-kB / 00473 kB (100%) b2xx_b200mini_fpga_default-g1c568e6.zip
-kB / 00319 kB (100%) usrp1_usrp1_fpga_default-g6bea23d.zip
-kB / 00009 kB (100%) usrp2_n210_fw_default-g6bea23d.zip
-kB / 08058 kB (100%) n3xx_n300_fpga_default-g61cdf981.zip
-kB / 04442 kB (100%) e3xx_e310_fpga_default-g61cdf981.zip
-kB / 00859 kB (100%) b2xx_b210_fpga_default-g1c568e6.zip
-[INFO] Images download complete.
-</pre>
-−
-NOTE: The default UHD FPGA Images destination within the N300/N310's file-system is <code>/usr/share/uhd/images</code>. The default UHD FPGA Images destination on a typical host installation is <code>/usr/local/share/uhd/images</code>.
-−
-Updating the FPGA image from the ARM CPU is the same as detailed above for a Host mode update:
 <pre>

← Older revision		Revision as of 02:53, 18 February 2019
Line 170:		Line 170:

	root@ni-n3xx-<motherboard serial #>:~#		root@ni-n3xx-<motherboard serial #>:~#
		+
		+	==Updating the Linux File System==
		+	Before operating the device, it is strongly recommended to update to the latest version of the Embedded Linux file system. If you are operating the device in Network Mode, the version of UHD running on the host machine and N3xx USRP must match.
		+
		+	There is two ways to update the file system for the N3xx USRP:
		+
		+	1. Mender
		+
		+	2. Physically remove microSD card from device and write a new file system to the microSD card.
		+
		+	===File System Partition Layout===
		+	The SD Card is divided into four partitions. There is two root file system partitions, a boot partition and a data partition.
		+
		+	Any data you would like to preserve through Mender updates should be saved to the <code>data</code> partition, which is mounted at <code>/data</code>.
		+
		+	===Updating the file system with Mender===
		+	Mender is third-party software that enables remote updating of the root file system without physically accessing the device (see also the Mender website https://mender.io). Mender can be executed locally on the device, or a Mender server can be set up which can be used to remotely update an arbitrary number of USRP devices. Users can host their own local Mender server, or use servers hosted by Mender as a paid service; contact Mender for more information.
		+
		+	====Mender Update Process====
		+	When updating the file system using Mender, the tool will overwrite the root file system partition that is not currently mounted. Any data stored in the root partitions will be permanently lost with a Mender update.
		+
		+	After updating a partition with Mender, it will reboot into the newly updated partition. Only if the update is confirmed by the user, the update will be made permanent. This means that if an update fails, the device will be always able to reboot into the partition from which the update was originally launched, which presumably is in a working state. Another update can be launched now to correct the previous, failed update, until it works.
		+
		+	To obtain the file system Mender image (these are files with a <code>.mender</code> suffix), run the following command on the host computer with Internet access:
		+
		+	$ sudo uhd_images_downloader -t mender -t n3xx --yes
		+
		+	Example Output:
		+	[INFO] Images destination: /usr/local/share/uhd/images
		+	451639 kB / 451639 kB (100%) n3xx_common_mender_default-v3.14.0.0.zip
		+	[INFO] Images download complete.
		+
		+	NOTE: In the output of the command, the folder destination where the images are saved is printed out.
		+
		+	Next, you will need to copy this Mender file system image to the USRP N3xx. This can be done with the Linux utility <code>scp</code>.
		+
		+	$ scp /usr/local/share/uhd/images/usrp_n3xx_fs.mender root@192.168.1.51:~/.
		+
		+	Note: The path and IP may different for your configuration, the command above assumes you're using the default installation path of <code>/usr/local</code> and that the N3xx's IP is <code>192.168.1.51</code>.
		+
		+	After copying the Mender file system image to the N3xx, connect to the N3xx using either the Serial Console, or via SSH to gain shell access.
		+
		+	On the N3xx, run <code>mender -rootfs /path/to/latest.mender</code> to update the file system:
		+
		+	root@ni-n3xx-serial:~# mender -rootfs /home/root/usrp_n3xx_fs.mender
		+
		+	Example Output:
		+
		+	<pre>
		+	root@ni-n3xx-serial:~# mender -rootfs /home/root/usrp_n3xx_fs.mender
		+	INFO[0000] Configuration file does not exist: /var/lib/mender/mender.conf module=config
		+	INFO[0000] Loaded configuration file: /etc/mender/mender.conf module=config
		+	INFO[0000] Mender running on partition: /dev/mmcblk0p2 module=main
		+	INFO[0000] Start updating from local image file: [/home/root/usrp_n3xx_fs.mender] module=rootfs
		+	Installing update from the artifact of size 460989952
		+	INFO[0000] no public key was provided for authenticating the artifact module=installer
		+	INFO[0000] opening device /dev/mmcblk0p3 for writing module=block_device
		+	INFO[0000] partition /dev/mmcblk0p3 size: 7851737088 module=block_device
		+	................................ 0% 1024 KiB
		+	................................ 0% 2048 KiB
		+	................................ 0% 3072 KiB
		+	[truncated for readability]
		+	................................ 99% 448512 KiB
		+	................................ 99% 449536 KiB
		+	................................ 100% 450185 KiB
		+	INFO[3004] wrote 7851737088/7851737088 bytes of update to device /dev/mmcblk0p3 module=device
		+	INFO[3009] Enabling partition with new image installed to be a boot candidate: 3 module=device
		+
		+
		+	</pre>
		+
		+	The artifact can also be stored on a remote server:
		+	$ mender -rootfs <http://server.name/path/to/latest.mender>
		+
		+	This procedure will take a few minutes to complete. After mender has logged a successful update, reboot the device:
		+	$ reboot
		+
		+	If the reboot worked, and the device seems functional, commit the changes so that the boot loader knows to permanently boot into this partition:
		+	$ mender -commit
		+
		+	To identify the currently installed Mender artifact from the command line, the following file can be queried on the N3xx:
		+	$ cat /etc/mender/artifact_info
		+
		+	If you are using a Mender server, the updates can be initiated from a web dashboard. From there, you can start the updates without having to log into the device, and you can update groups of USRPs with a few clicks in a web GUI. The dashboard can also be used to inspect the state of USRPs. This is a simple way to update groups of rack-mounted USRPs with custom file systems.
		+
		+	For more information on updating the file-system, refer to the UHD Manual at https://uhd.ettus.com.
		+
		+	===Updating the files system by writing the disk image===
		+	Please see the separate application note, [[Writing the USRP File System Disk Image to a SD Card]], for step-by-step instructions on writing the file system image to the SD card.

	==Updating the Network Configurations==		==Updating the Network Configurations==

← Older revision		Revision as of 02:52, 18 February 2019
Line 56:		Line 56:

	NOTE: Before operating the device, it is strongly recommended to update to the latest version of the Embedded Linux file system. If you are operating the device in Network Mode, the version of UHD running on the host machine and N3xx USRP must match.		NOTE: Before operating the device, it is strongly recommended to update to the latest version of the Embedded Linux file system. If you are operating the device in Network Mode, the version of UHD running on the host machine and N3xx USRP must match.
−
−	~~==Updating the File-system==~~
−	Before operating the device, it is strongly recommended to re-image the microSD card with the latest version of the Embedded Linux file-system. The image should match the version of UHD installed on the host computer.
−
−	~~===Downloading the SD Card / File System Image===~~
−	~~To obtain the file system SD card image, run the following command on the host computer with Internet access:~~
−
−	~~$ sudo uhd_images_downloader -t sdimg -v~~
−
−	~~Example Output:~~
−
−	~~$ sudo uhd_images_downloader -t sdimg -v~~
−	~~[INFO] Images destination: /usr/local/share/uhd/images~~
−	~~[INFO] No inventory file found at /usr/local/share/uhd/images/inventory.json. Creating an empty one.~~
−	~~845962 kB / 845962 kB (100%) n3xx_common_sdimg_default-v3.11.1.0.zip~~
−	~~[INFO] Images download complete.~~
−
−	~~NOTE: In the output of the command, the folder destination where the images are saved is printed out.~~
−
−	~~===Identifying UHD Installation Prefix===~~
−	~~An alternative method to identify your installation prefix is to run the command:~~
−
−	~~$ uhd_config_info --install-prefix~~
−
−	~~Example Output:~~
−
−	~~$ uhd_config_info --install-prefix~~
−	~~Install prefix: /usr/local~~
−
−	~~The default folder location for FPGA and SD card images is:~~
−
−	~~<UHD_INSTALL_PREFIX>/share/uhd/images/~~
−
−	~~Verify the SD card image is at this location:~~
−
−	~~$ ls /usr/local/share/uhd/images/*.sdimg~~
−
−	~~Example Output:~~
−
−	~~/usr/local/share/uhd/images/usrp_n3xx_fs.sdimg~~
−
−	~~===Identifying SD Card Mount Location===~~
−	~~Insert the microSD card into the host computer.~~
−
−	~~To identify the device where the microSD card is, run the command:~~
−
−	~~dmesg \| tail~~
−
−	~~Example Output (partially truncated for readability):~~
−
−	~~[21265.575488] usb-storage 1-2:1.0: USB Mass Storage device detected~~
−	~~[21266.586983] scsi 0:0:0:0: Direct-Access Generic Mass-Storage 1.11 PQ: 0 ANSI: 2~~
−	~~[21266.588024] sd 0:0:0:0: Attached scsi generic sg0 type 0~~
−	~~[21267.299812] sd 0:0:0:0: [sdb] 31116288 512-byte logical blocks: (15.9 GB/14.8 GiB)~~
−	~~[21267.302687] sdb: sdb1 sdb2 sdb3 sdb4~~
−
−	~~NOTE: In this specific example configuration, the SD card has been attached to <code>sdb</code>.~~
−
−	~~Another method to finding the device node the disk is attached at is to use the Linux utility <code>lsblk</code>:~~
−
−	~~Example Output:~~
−
−	~~$ lsblk~~
−	~~NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT~~
−	~~sdb 8:0 1 14.9G 0 disk~~
−	~~├─sdb4 8:4 1 128M 0 part /media/user/data~~
−	~~├─sdb2 8:2 1 7.3G 0 part /media/user/primary~~
−	~~├─sdb3 8:3 1 7.3G 0 part /media/user/secondary~~
−	~~└─sdb1 8:1 1 16M 0 part /media/user/boot~~
−
−	~~===Unmount Auto-mounted Partitions===~~
−	Some operating systems by default will auto-mount the partitions on a block device when it is attached. Before writing a new disk image to the SD card, you should first unmount any mounted partitions. This can be done with the Linux utility <code>umount</code> as shown below:
−
−	~~$ sudo umount /media/user/data~~
−	~~$ sudo umount /media/user/primary~~
−	~~$ sudo umount /media/user/secondary~~
−	~~$ sudo umount /media/user/boot~~
−
−	~~Running the command <code>lsblk</code> again will show these partitions have been unmounted:~~
−
−	~~Example Output:~~
−
−	~~$ lsblk~~
−	~~NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT~~
−	~~sdb 8:0 1 14.9G 0 disk~~
−	~~├─sdb4 8:4 1 128M 0 part~~
−	~~├─sdb2 8:2 1 7.3G 0 part~~
−	~~├─sdb3 8:3 1 7.3G 0 part~~
−	~~└─sdb1 8:1 d1 16M 0 part~~
−
−	~~===Writing the SD Card Image===~~
−	'''WARNING:''' The Linux utility <code>dd</code> can cause unrecoverable data loss if the incorrect disk is selected, or if the parameters are input incorrectly. Ensure you have selected the correct input and output parameters for your system configuration.
−
−	~~NOTE: You must use a 16GB or larger SD card.~~
−
−	~~The <code><SD_CARD_DEV_NAME></code> device node depends on your operating system and which other devices are plugged in. Typical values are <code>sdb</code> or <code>mmcblk0</code>.~~
−
−	~~In the examples above:~~
−
−	~~<IMAGE>=/usr/local/share/uhd/images/usrp_n3xx_fs.sdimg~~
−
−	~~<SD_CARD_DEV_NAME>=/dev/sdb~~
−
−	~~Write the disk image with the command:~~
−
−	~~$ sudo dd if=<IMAGE> of=<SD_CARD_DEV_NAME> bs=1M~~
−
−	~~The step of writing the disk image to the SD card can take a while to complete.~~
−
−	~~Example Output:~~
−
−	~~$ sudo dd if=/usr/local/share/uhd/images/usrp_n3xx_fs.sdimg of=/dev/sdb bs=1M~~
−	~~15160+0 records in~~
−	~~15160+0 records out~~
−	~~15896412160 bytes (16 GB, 15 GiB) copied, 1160.93 s, 13.7 MB/s~~
−
−	~~To ensure the disk is synchronized, run the <code>sync</code> command:~~
−
−	~~$ sync~~
−
−	~~You can now remove the microSD card from your Host computer and insert it into the USRP N310.~~
−
−	~~For more information on updating the file-system, refer to the UHD Manual at http://uhd.ettus.com.~~

	==Connecting the Device==		==Connecting the Device==

← Older revision		Revision as of 01:32, 18 February 2019
Line 54:		Line 54:

	White Rabbit Ethernet-Based Synchronization of the N3xx USRP requires UHD version 3.12.0.0 or later. For additional details on White Rabbit Ethernet-Based Synchronization, please see the application note, [[Using Ethernet-Based Synchronization on the USRP™ N3xx Devices]].		White Rabbit Ethernet-Based Synchronization of the N3xx USRP requires UHD version 3.12.0.0 or later. For additional details on White Rabbit Ethernet-Based Synchronization, please see the application note, [[Using Ethernet-Based Synchronization on the USRP™ N3xx Devices]].
−
−	~~It is recommended to use the [https://github.com/ettusresearch/uhd/tree/UHD-3.13 UHD-3.13 maintenance branch] at the time of this writing.~~

	NOTE: Before operating the device, it is strongly recommended to update to the latest version of the Embedded Linux file system. If you are operating the device in Network Mode, the version of UHD running on the host machine and N3xx USRP must match.		NOTE: Before operating the device, it is strongly recommended to update to the latest version of the Embedded Linux file system. If you are operating the device in Network Mode, the version of UHD running on the host machine and N3xx USRP must match.