Difference between revisions of "TFTP Boot and NFS Root Filesystems"

From eLinux.org
Jump to: navigation, search
m (Try SD boot before tftp boot - as a fall-back.)
(Updated to include Shared NFS Root Filesystems)
Line 2: Line 2:
 
= How To Set Up TFTP Boot And NFS Root Filesystems On Parallella =
 
= How To Set Up TFTP Boot And NFS Root Filesystems On Parallella =
 
This Guide describes how to set up the Parallella U-Boot to network boot using TFTP. <br />
 
This Guide describes how to set up the Parallella U-Boot to network boot using TFTP. <br />
Also, it describes how to set up mounting a root filesystem (''rootfs'') via NFS. <br />
+
Also, it describes how to set up mounting a root filesystem (''rootfs'') via NFS, so that a Parallella is run as a 'Thick Client'. <br />
 
See the Manual for [http://www.denx.de/wiki/DULG/Manual Das U-Boot]<br />
 
See the Manual for [http://www.denx.de/wiki/DULG/Manual Das U-Boot]<br />
The following is based on the original blog post by [https://plus.google.com/+shogunx/posts/K5taMhPKurp Scott Johnson] describing how to set up a Parallella cluster to use TFTP/NFS, but has been tweaked - mainly to minimise the need to edit/update the U-Boot variables via the Serial/UART cable, and provide more flexibility by using PC-based editors and storage.<br />
+
The following is based on the original blog post by [https://plus.google.com/+shogunx/posts/K5taMhPKurp Scott Johnson] describing how to set up a Parallella cluster to use TFTP/NFS, but has been tweaked - mainly to minimise the need to edit/update the U-Boot variables via the Serial/UART cable, and provide more flexibility by using PC-based editors and storage.<br /><br />
 
By editing a ''bootscript'' on the TFTP server (and re-booting), a Parallella can be re-configured to a different boot mode (headless,HDMI) and/or different root filesystem (Ubuntu, Debian, nano) - all without having to 'burn' another Parallella SD card (perhaps ever..?).<br />
 
By editing a ''bootscript'' on the TFTP server (and re-booting), a Parallella can be re-configured to a different boot mode (headless,HDMI) and/or different root filesystem (Ubuntu, Debian, nano) - all without having to 'burn' another Parallella SD card (perhaps ever..?).<br />
 
Tweak the example below to suit your  needs.
 
Tweak the example below to suit your  needs.
Line 11: Line 11:
 
== Summary ==
 
== Summary ==
 
This Guide describes:
 
This Guide describes:
* An IP addressing and naming scheme to support different boot modes (headless, HDMI) and NFS root filesystems.
+
* An IP addressing and naming scheme using DHCP to support different boot modes (headless, HDMI) and NFS root filesystems.
 
* Setting up TFTP and a directory layout for TFTP ''bootscripts'' and boot mode image files.
 
* Setting up TFTP and a directory layout for TFTP ''bootscripts'' and boot mode image files.
 
* Changing the way the boot arguments are passed to the kernel, i.e. in the U-Boot 'bootargs' rather than devicetree.
 
* Changing the way the boot arguments are passed to the kernel, i.e. in the U-Boot 'bootargs' rather than devicetree.
Line 18: Line 18:
 
* An example ''bootscript'' for TFTP boot and NFS root filesystem.
 
* An example ''bootscript'' for TFTP boot and NFS root filesystem.
 
* Use of mkimage to convert the ''bootscript'' text file into a U-Boot script image file.
 
* Use of mkimage to convert the ''bootscript'' text file into a U-Boot script image file.
* A breakdown of the ''bootscript'' to show how it might be altered to suit different environments.
+
* A breakdown of the ''bootscript'' to show different options.
 
IMPORTANT NOTE:  
 
IMPORTANT NOTE:  
 
* {Sept 2014} There is a problem in Parallella U-Boot w.r.t. the Ethernet interface after any network activity in U-Boot (e.g. TFTP). (See the post on the Parallella forum post by [http://forums.parallella.org/viewtopic.php?f=48&t=1667#p10409 tajama]). The ethernet interface is left in an unuseable state.  A workaround is included in the script example below; but before attempting to apply it - you MUST check the U-Boot version. (Revisit)
 
* {Sept 2014} There is a problem in Parallella U-Boot w.r.t. the Ethernet interface after any network activity in U-Boot (e.g. TFTP). (See the post on the Parallella forum post by [http://forums.parallella.org/viewtopic.php?f=48&t=1667#p10409 tajama]). The ethernet interface is left in an unuseable state.  A workaround is included in the script example below; but before attempting to apply it - you MUST check the U-Boot version. (Revisit)
 
* {Sept 2014} the Parallella U-Boot is being updated which just might affect the script below. (Revisit).  
 
* {Sept 2014} the Parallella U-Boot is being updated which just might affect the script below. (Revisit).  
 
<br />
 
<br />
= Prepare File Service Environments =
+
= Set up IP Addresses Using DHCP =
== Set up IP Addresses ==
 
 
Allocate IP addresses for the Parallella(s) and the TFTP/NFS servers in your DHCP server based on MAC address. The Parallella MAC address is printed on the board, and is also a U-Boot variable (see later).<br />
 
Allocate IP addresses for the Parallella(s) and the TFTP/NFS servers in your DHCP server based on MAC address. The Parallella MAC address is printed on the board, and is also a U-Boot variable (see later).<br />
 
Refer to the documentation of your DHCP server, or discuss with your network admin. <br />
 
Refer to the documentation of your DHCP server, or discuss with your network admin. <br />
Line 30: Line 29:
 
* U-Boot tftpboot command requests a ''bootscript'' file, and needs the TFTP server IP address <serverip>, and its own IP address <ipaddr>.
 
* U-Boot tftpboot command requests a ''bootscript'' file, and needs the TFTP server IP address <serverip>, and its own IP address <ipaddr>.
 
* U-Boot tells Linux to use DHCP.  
 
* U-Boot tells Linux to use DHCP.  
* NFS uses IP addresses to control access to the rootfs directories.
+
* The NFS server uses IP addresses to control access to the exported rootfs directories.
 
This is an example IP address allocation and naming convention (your network may vary):
 
This is an example IP address allocation and naming convention (your network may vary):
 
<blockquote>
 
<blockquote>
 
<pre>
 
<pre>
192.168.1.201 para1 // <ipaddr> IP address of Parallella "para"<n>
+
192.168.1.21 para1 // <ipaddr> IP address of Parallella "para"<n>
192.168.1.202 para2
+
192.168.1.22 para2
 
...
 
...
192.168.1.208  para8    // ... I wish
+
192.168.1.28 para8    // ... I wish :)
 
192.168.1.50 TFTP server // IP address of TFTP server "serverip"
 
192.168.1.50 TFTP server // IP address of TFTP server "serverip"
 
192.168.1.50 NFS server // IP address of NFS server "nfs_ip"
 
192.168.1.50 NFS server // IP address of NFS server "nfs_ip"
 
</pre>
 
</pre>
 
</blockquote>
 
</blockquote>
Note: The TFTP and NFS services do not need to be on the same physical server, or even the same operating system. Here, a Debian (Wheezy) PC provides both services.
+
Note: The TFTP and NFS services do not need to be on the same physical server, or even the same operating system. A Debian (Wheezy) PC provides both services in this example.
  
== Prepare the TFTP Service ==
+
= Prepare the TFTP Service =
 
Get the required software if not already set up. On Debian:
 
Get the required software if not already set up. On Debian:
 
<pre>
 
<pre>
 
apt-get install tftpd-hpa
 
apt-get install tftpd-hpa
 
</pre>
 
</pre>
The TFTP service does not start automatically. Start the tftpd-hpa service automatically by adding a command to ''/etc/rc.local'' (just before the exit 0 line).
+
The TFTP service does not start automatically. <br />
 +
(Note: There are a number of examples in various forums, etc, of how to automatically start the TFTP service - but not all are successful on all Linux distro's it seems! The following may work for you.)<br />
 +
Start the tftpd-hpa service automatically by adding a command to ''/etc/rc.local'' (just before the exit 0 line).
 
<pre>
 
<pre>
 
sudo nano /etc/rc.local
 
sudo nano /etc/rc.local
Line 62: Line 63:
 
<pre>
 
<pre>
 
sudo service tftpd-hpa restart // to restart, or use 'stop', or 'start' as needed.
 
sudo service tftpd-hpa restart // to restart, or use 'stop', or 'start' as needed.
 +
</pre>
 +
To check the status of the TFTP service from the command line use:
 +
<pre>
 +
sudo service tftpd-hpa status
 +
[ ok ] in.tftpd is running.        // Service is Up
 +
[FAIL] in.tftpd is not running ... failed!    // Service is Down
 
</pre>
 
</pre>
  
=== Set up the TFTP Directories ===
+
== Set up the TFTP Directories ==
 
By default, the tftpd-hpa service looks for requested files under ''/srv/tftp/''. <br />
 
By default, the tftpd-hpa service looks for requested files under ''/srv/tftp/''. <br />
Each Parallella has its own ''bootscript'', e.g. ''para1''. This is a U-Boot script image file, created using ''mkimage'' from a text file (see below). The ''bootscript'' points U-Boot to a boot mode directory. The ''bootscript'' also provides U-Boot with the Linux boot parameters to mount the NFS root filesystem, and finally to boot the kernel. <br />
+
Each Parallella has its own ''bootscript'', e.g. ''para1'', ''para2'',  in the TFTP service directory. The ''bootscript'' is a U-Boot script image file, created using ''mkimage'' from a text file (see below). <br />
Each boot mode (headless, HDMI, etc) has a separate directory containing the equivalent of the ''BOOT'' partition on a Parallella SD card, that is, the kernel, parallella.bit.bin and devicetree image files. <br />
+
The ''bootscript'' points U-Boot to a boot mode sub-directory holding the boot image files.<br />
Different sets of image files can be held in different directories, e.g. ''hdmi_7010_new_kernel/'', ''test_usb_fix/''. <br />
+
Each boot mode directory is the equivalent of the ''BOOT'' partition on a Parallella SD card, containing the kernel, parallella.bit.bin and devicetree image files.<br />
Note: only one directory per boot mode - not one per Parallella.<br />
+
Different sets of boot image files may be held in different directories, e.g. ''headless_7010'', ''hdmi_7010'', ''test_new_kernel''. By pointing at a different directory, the ''bootscript'' controls how the Parallella will be booted. <br />
Create a boot mode directory:
+
Note: only needs one directory per boot mode - not one per Parallella.<br />
 +
The ''bootscript'' provides U-Boot with the TFTP commands to load the image files and to boot the kernel.<br />
 +
The ''bootscript'' also provides the Linux boot parameters (''bootargs'') to mount the NFS root filesystem. <br />
 +
=== Create a Boot Mode Directory and Prepare the Image Files ===
 
<pre>
 
<pre>
 
sudo mkdir -p /srv/tftp/<name> // replace <name> with boot mode, e.g. hdmi_7010
 
sudo mkdir -p /srv/tftp/<name> // replace <name> with boot mode, e.g. hdmi_7010
 
</pre>
 
</pre>
 
+
Follow the instructions for creating the SD card (download, extract and rename the kernel uImage, parallella.bit.bin and devicetree.dtb files) but instead of 'burning' to a SD card simply copy the image files to the boot mode directory (as root).<br />
=== Prepare the Image Files ===
 
Follow the instructions for creating the SD card (that is, download, extract and rename the kernel uImage, parallella.bit.bin and devicetree.dtb files), but instead of 'burning' to a SD card simply copy the image files to the boot mode directory (as root).<br />
 
 
The TFTP service directory layout (for this example) will look something like:
 
The TFTP service directory layout (for this example) will look something like:
 
<blockquote>
 
<blockquote>
Line 89: Line 97:
 
devicetree.dtb
 
devicetree.dtb
 
uImage
 
uImage
hdmi_7010_new_kernel/ // boot mode = temp testing variation
+
test_new_kernel/ // boot mode = temp testing variation
 
paralella.bit.bin
 
paralella.bit.bin
 
devicetree.dtb
 
devicetree.dtb
Line 101: Line 109:
 
Note: The image files follow the same naming convention as for SD card booting.
 
Note: The image files follow the same naming convention as for SD card booting.
  
=== Remove Bootargs from Devicetree ===
+
== Remove Bootargs from Devicetree ==
The devicetree as supplied by Adapteva passes the boot arguments to support booting from the SD card. Instead, the boot arguments are passed to the kernel by U-Boot, as defined in the ''bootscript''. <br />
+
The Parallella devicetrees, as supplied by Adapteva,  pass the boot arguments to support booting from the SD card. Instead, the boot arguments are passed to the kernel by U-Boot, as defined in the ''bootscript'' (see below). The devicetree image files need to be edited to remove the boot commands. <br />
 
Install the devicetree compiler if not already installed. On Debian:
 
Install the devicetree compiler if not already installed. On Debian:
 
<pre>
 
<pre>
Line 116: Line 124:
 
<blockquote>
 
<blockquote>
 
<pre>
 
<pre>
chosen {  
+
chosen { }
}
 
 
</pre>
 
</pre>
 
</blockquote>
 
</blockquote>
Line 126: Line 133:
 
</pre>
 
</pre>
  
== Prepare the NFS Service ==
+
= Prepare the NFS Service =
 
Get the required software if not already set up. On Debian:
 
Get the required software if not already set up. On Debian:
 
<pre>
 
<pre>
Line 134: Line 141:
 
<pre>
 
<pre>
 
sudo service nfs-kernel-server restart // to restart, or use 'stop', or 'start' as needed.
 
sudo service nfs-kernel-server restart // to restart, or use 'stop', or 'start' as needed.
 +
</pre>
 +
To check the status of the NFS service from the command line use:
 +
<pre>
 +
sudo service nfs-kernel-server status
 +
nfsd running          // Service is Up
 +
nfsd not running    // Service is Down
 
</pre>
 
</pre>
  
=== Set up the NFS Directories ===
+
== Set up the NFS Directories ==
Each Parallella has one or more NFS directory containing a root filesystem. Each Parallella may have alternative root filesystems (e.g. Ubuntu, Linaro Nano) - just like preparing and swapping alternative Parallella SD cards. <br />
+
A Parallella may have one or more Linux root filesystem held in different NFS directories, to hold different configurations or versions. These alternative root filesystems (e.g. Ubuntu, Linaro Nano, with/without SDK) are just like burning and booting off multiple SD cards. <br />
Create a top directory ''/srv/nfs'', and create a Parallella NFS directory under that for each root filesystem choice for that Parallella board. For example:<br />
+
A root filesystem on the NFS server may also be shared by a number of Parallellas, say, in a cluster. The many advantages include saving space on the server, and mainly not having to replicate SD cards for each cluster member.<br />
 +
 
 +
Create a top directory ''/srv/nfs'', and create a NFS directory under that for each root filesystem being created. <br />
 +
Here are some examples of NFS filesystem directories, including shared root filesystems and where a Parallella may have a choice of root filesystems.<br />
 
<pre>
 
<pre>
 
sudo mkdir -p /srv/nfs
 
sudo mkdir -p /srv/nfs
sudo mkdir -p /srv/nfs/para1_ubuntu
+
sudo mkdir -p /srv/nfs/ubuntu // rootfs based on standard Parallella Ubuntu build, to be shared by all cluster members
sudo mkdir -p /srv/nfs/para1_nano
+
sudo mkdir -p /srv/nfs/nano // rootfs based on a slim linaro nano build, to be shared by all cluster members
sudo mkdir -p /srv/nfs/para2_ubuntu
+
sudo mkdir -p /srv/nfs/ubuntu_SDK // rootfs based on Parallella Ubuntu build, with latest SDK, to be used by para1 which has HDMI, and USB devices.
 +
sudo mkdir -p /srv/nfs/nano_X_server // rootfs based on a linaro nano build with SDK, X server, to be used by para1 which has HDMI, and USB devices.
 
</pre>
 
</pre>
Here is an example layout of NFS filesystem directories showing separate branches for each Parallella, after adding root filesystem contents.
 
<blockquote>
 
<pre>
 
/srv/nfs/
 
para1_ubuntu/ // rootfs for para1, based on, say, Parallella Ubuntu
 
bin/
 
boot/
 
                etc/
 
...
 
para1_deb/ // rootfs for para1, with 9600's Debian and ESDK
 
bin/
 
boot/
 
                etc/
 
...
 
para1_nano/ // rootfs for para1 based on linaro_nano
 
bin/
 
boot/
 
                etc/
 
...
 
para2_ubuntu/ // rootfs for para2, based on, say, Parallella Ubuntu
 
bin/
 
boot/
 
                etc/
 
...
 
        ...
 
para8_ubuntu/       // rootfs for para8, based on, say, Parallella Ubuntu
 
...       // etc, etc
 
</pre>
 
</blockquote>
 
  
=== Update NFS Exports File ===
+
== Set up Parallella NFS Root Filesystems ==
 +
Instead of 'burning' a filesystem image to a partition on the SD card, place the payload root filesystem in the NFS directory, e.g. ''/srv/nfs/ubuntu/''. <br />
 +
Each source of root filesystem may involve different preparation to enable the NFS access to work smoothly. <br />
 +
See the examples in the [[Parallella NFS rootfs Setup|How-to for Extracting Parallella NFS rootfs]] <br />
 +
 
 +
== Update NFS Exports File ==
 
The NFS server requires ''/etc/exports'' to be configured correctly, to control access to each NFS filesystem directory to specific hosts.<br />
 
The NFS server requires ''/etc/exports'' to be configured correctly, to control access to each NFS filesystem directory to specific hosts.<br />
For each Paralella root filesystem that is created, add the export control line to ''/etc/exports'', adjusting (as you should for all examples herein) for your local IP address and directory naming scheme. The following is an example based on the layout described above.
+
For each Paralella root filesystem that is created, add the export control line to ''/etc/exports'', adjusting (as you should for all examples herein) for your local IP address and directory naming scheme. The following is an example based on the layout described above. <br />
 +
Note that where multiple hosts share an exported directory, the 'hostIP(attributes)' are separated by a <space>. There is no <space> between hostIP and (attributes). Continuation lines may be used for clarity, but care must be taken to ensure that the <space> syntax is followed: continuation is " \" only (no hidden tabs, etc).
 
<pre>
 
<pre>
 
sudo nano /etc/exports
 
sudo nano /etc/exports
Line 184: Line 178:
 
<blockquote>
 
<blockquote>
 
<pre>
 
<pre>
/srv/nfs/para1_ubuntu 192.168.1.201(rw,sync,no_root_squash,no_subtree_check)
+
/srv/nfs/ubuntu 192.168.1.21(rw,sync,no_root_squash,no_subtree_check) \
/srv/nfs/para1_deb 192.168.1.201(rw,sync,no_root_squash,no_subtree_check)
+
192.168.1.22(rw,sync,no_root_squash,no_subtree_check) \
/srv/nfs/para1_nano 192.168.1.201(rw,sync,no_root_squash,no_subtree_check)
+
192.168.1.23(rw,sync,no_root_squash,no_subtree_check) \
/srv/nfs/para2_ubuntu 192.168.1.202(rw,sync,no_root_squash,no_subtree_check)
+
192.168.1.24(rw,sync,no_root_squash,no_subtree_check)
/srv/nfs/para8_ubuntu 192.168.1.208(rw,sync,no_root_squash,no_subtree_check)
+
/srv/nfs/ubuntu_SDK 192.168.1.21(rw,sync,no_root_squash,no_subtree_check)
 +
/srv/nfs/nano 192.168.1.21(rw,sync,no_root_squash,no_subtree_check) \
 +
192.168.1.22(rw,sync,no_root_squash,no_subtree_check) \
 +
192.168.1.23(rw,sync,no_root_squash,no_subtree_check) \
 +
192.168.1.24(rw,sync,no_root_squash,no_subtree_check)
 +
/srv/nfs/nano_X_server 192.168.1.22(rw,sync,no_root_squash,no_subtree_check)
 
</pre>
 
</pre>
 
</blockquote>
 
</blockquote>
Note: The ''bootscript'' ensures that only one of the optional filesystems will be accessed/mounted by a Parallella on a re-boot.
+
Note: The ''bootscript'' ensures that only one of the optional filesystems will be accessed/mounted at any one time by a Parallella on a re-boot.
  
=== Export the NFS Directories ===
+
== Export the NFS Directories ==
 
Ensure that these directories are made visible by the NFS service. Either:
 
Ensure that these directories are made visible by the NFS service. Either:
 
<pre>
 
<pre>
Line 203: Line 202:
 
</pre>
 
</pre>
  
=== Set up Parallella NFS Root Filesystems ===
 
Instead of 'burning' a filesystem image to a partition on the SD card, place the payload root filesystem in the NFS directory, e.g. ''/srv/nfs/para1_ubuntu/''. <br />
 
Each source of root filesystem may involve different preparation to enable the NFS access to work smoothly. <br />
 
See the examples in the [[Parallella NFS rootfs Setup|How-to for Extracting Parallella NFS rootfs]] <br />
 
 
<br /><br />
 
<br /><br />
 
= Set Up the Parallella to TFTP Boot =
 
= Set Up the Parallella to TFTP Boot =
Line 219: Line 214:
 
* set the ''hostname'' variable which will be used as the ''bootscript'' name. Change for each Parallella.
 
* set the ''hostname'' variable which will be used as the ''bootscript'' name. Change for each Parallella.
 
* set the IP address of the Parallella and the TFTP server. Change for each Parallella.
 
* set the IP address of the Parallella and the TFTP server. Change for each Parallella.
 +
* set the Ip address of the TFTP server. Usually the same for all Parallellas.
 
* create a variable ''t-boot'' which contains the commands to fetch and then execute the ''bootscript''.  
 
* create a variable ''t-boot'' which contains the commands to fetch and then execute the ''bootscript''.  
 
* change the U-Boot bootcmd so that it will run the ''t-boot'' TFTP boot sequence, only if no SD card is present.  
 
* change the U-Boot bootcmd so that it will run the ''t-boot'' TFTP boot sequence, only if no SD card is present.  
 
<pre>
 
<pre>
 
setenv hostname para1
 
setenv hostname para1
setenv ipaddr 192.168.1.201
+
setenv ipaddr 192.168.1.21
 
setenv serverip 192.168.1.50
 
setenv serverip 192.168.1.50
 +
 
setenv t-addr 0x100000
 
setenv t-addr 0x100000
 
setenv t-boot 'tftpboot ${t-addr} ${hostname} ; source ${t-addr}'
 
setenv t-boot 'tftpboot ${t-addr} ${hostname} ; source ${t-addr}'
Line 247: Line 244:
  
 
= Write a Parallella Bootscript =
 
= Write a Parallella Bootscript =
On the PC host, the ''bootscript'' image file is created and edited as a text file, and compiled into a U-Boot executable image using mkimage.<br />
+
On the TFTP server host, the ''bootscript'' image file is initially created and edited as a text file, and compiled into a U-Boot executable image using ''mkimage''.<br />
 +
<br />
 
Create a working directory to hold the ''bootscript'' text file(s).
 
Create a working directory to hold the ''bootscript'' text file(s).
 
<pre>
 
<pre>
 
mkdir ~/Documents/bootscr
 
mkdir ~/Documents/bootscr
 
</pre>
 
</pre>
Create a text file and copy/paste the text below as a template. The following is an example ''bootscript''. This loads the headless image files.<br />
+
Create a text file and copy/paste the text below as a template. The following is an example ''bootscript'' which is described below. This loads the headless image files for a 7010, and will load the shared linaro nano root filesystem.<br />
 
<pre>
 
<pre>
 
cd ~/Documents/bootscr
 
cd ~/Documents/bootscr
Line 260: Line 258:
 
<blockquote><pre>
 
<blockquote><pre>
 
setenv tftp_dir headless_7010
 
setenv tftp_dir headless_7010
setenv nfs_rfs /srv/tftp/para1_ubuntu
+
setenv nfs_rfs /srv/tftp/nano
  
 
setenv bootargs ip=dhcp
 
setenv bootargs ip=dhcp
Line 289: Line 287:
 
run fpga_tftp fpga_load kernel_tftp fdt_tftp rset_phy boot_now
 
run fpga_tftp fpga_load kernel_tftp fdt_tftp rset_phy boot_now
 
</pre></blockquote>
 
</pre></blockquote>
Copy the file to create a ''bootscript'' for each Parallella, changing the filename, e.g. para2.txt, and edit the values of the ''tftp_dir'' and ''nfs_rfs'' variables in each file as required. <br />
+
Copy the file to create a ''bootscript'' for each Parallella, changing the filename, e.g. para2.txt.
 +
Edit the values of the ''tftp_dir'' and ''nfs_rfs'' variables in each file as required. If the boot mode is the same and the NFS rootfs is shared, then there are usually no edits required. <br />
 +
To change the mode of a Parallella boot, edit the 'paraX.txt' file to change the ''tftp_dir'' and/or ''nfs_rfs'' variables, before re-making the image.<br />
 
The directory structure on the Debian PC will then look something like this:
 
The directory structure on the Debian PC will then look something like this:
 
<blockquote><pre>
 
<blockquote><pre>
Line 301: Line 301:
  
 
== Make the Bootscript Image ==
 
== Make the Bootscript Image ==
Install the mkimage package if not already installed. On Debian:
+
Install ''mkimage'', which is part of the Das U-Boot tool-set, if not already installed. On Debian:
 
<pre>
 
<pre>
 
sudo apt-get install u-boot-tools
 
sudo apt-get install u-boot-tools
 
</pre>
 
</pre>
Convert each ''bootscript'' text file into a loadable image by mkimage, and place the image in the TFTP server directory. For example:
+
Convert each ''bootscript'' text file into a loadable image by ''mkimage'', and place each image in the TFTP server directory. For example:
 
<pre>
 
<pre>
 
cd ~/Documents/bootscr
 
cd ~/Documents/bootscr
 
sudo mkimage -A arm -O u-boot -T script -C none -a 0 -e 0 -n "t-Boot Script" -d para1.txt /srv/tftp/para1
 
sudo mkimage -A arm -O u-boot -T script -C none -a 0 -e 0 -n "t-Boot Script" -d para1.txt /srv/tftp/para1
 +
sudo mkimage -A arm -O u-boot -T script -C none -a 0 -e 0 -n "t-Boot Script" -d para2.txt /srv/tftp/para2
 +
...
 +
sudo mkimage -A arm -O u-boot -T script -C none -a 0 -e 0 -n "t-Boot Script" -d para8.txt /srv/tftp/para8
 
</pre>
 
</pre>
  
 
== Reboot the Parallella ==
 
== Reboot the Parallella ==
 
Reboot by power off, wait a few seconds, power on. <br />
 
Reboot by power off, wait a few seconds, power on. <br />
The output to the UART Serial terminal screen shows initialisation of the board and network, and then the boot sequence looking for the TFTP server.  
+
The output to the UART Serial terminal screen shows initialisation of the board and network, and then the boot sequence looking for the TFTP server.<br />
 
If the TFTP 'Loading:' line puts out a few 'T T T's, then it's retrying. Give it a few moments but if there's a line of 'T's then check that the TFTP service is actually running, and that the IP addresses and filename of the ''bootscript'' are valid. <br />
 
If the TFTP 'Loading:' line puts out a few 'T T T's, then it's retrying. Give it a few moments but if there's a line of 'T's then check that the TFTP service is actually running, and that the IP addresses and filename of the ''bootscript'' are valid. <br />
 
Once the small (~1kb) ''bootscript'' has been loaded and is executed by U-Boot, further TFTP requests will be seen as the image files are downloaded before U-Boot hands over to the kernel.
 
Once the small (~1kb) ''bootscript'' has been loaded and is executed by U-Boot, further TFTP requests will be seen as the image files are downloaded before U-Boot hands over to the kernel.
  
== Breakdown of the Bootscript ==
+
= Breakdown of the Bootscript =
 
This section takes the ''bootscript'' example and breaks it down to illustrate what may be changed to support your local environment.<br />
 
This section takes the ''bootscript'' example and breaks it down to illustrate what may be changed to support your local environment.<br />
  
Line 323: Line 326:
 
<blockquote><pre>
 
<blockquote><pre>
 
setenv tftp_dir headless_7010         // or, hdmi_7010, etc
 
setenv tftp_dir headless_7010         // or, hdmi_7010, etc
setenv nfs_rootfs /srv/nfs/para1_ubuntu       // or /srv/nfs/para1_deb, etc
+
setenv nfs_rootfs /srv/nfs/nano         // or /srv/nfs/nano_sdk, etc
 
</pre></blockquote>
 
</pre></blockquote>
 
* Set the initial ''bootargs'' string to tell the kernel to use DHCP when loaded.
 
* Set the initial ''bootargs'' string to tell the kernel to use DHCP when loaded.

Revision as of 11:08, 29 November 2014

How To Set Up TFTP Boot And NFS Root Filesystems On Parallella

This Guide describes how to set up the Parallella U-Boot to network boot using TFTP.
Also, it describes how to set up mounting a root filesystem (rootfs) via NFS, so that a Parallella is run as a 'Thick Client'.
See the Manual for Das U-Boot
The following is based on the original blog post by Scott Johnson describing how to set up a Parallella cluster to use TFTP/NFS, but has been tweaked - mainly to minimise the need to edit/update the U-Boot variables via the Serial/UART cable, and provide more flexibility by using PC-based editors and storage.

By editing a bootscript on the TFTP server (and re-booting), a Parallella can be re-configured to a different boot mode (headless,HDMI) and/or different root filesystem (Ubuntu, Debian, nano) - all without having to 'burn' another Parallella SD card (perhaps ever..?).
Tweak the example below to suit your needs.

Requirements

Linux PC, Parallella board(s), USB to Serial (TTL/UART) adapter, DHCP server.

Summary

This Guide describes:

  • An IP addressing and naming scheme using DHCP to support different boot modes (headless, HDMI) and NFS root filesystems.
  • Setting up TFTP and a directory layout for TFTP bootscripts and boot mode image files.
  • Changing the way the boot arguments are passed to the kernel, i.e. in the U-Boot 'bootargs' rather than devicetree.
  • Setting up NFS and a directory layout for NFS root filesystems, allowing a choice of root filesystems for each Parallella.
  • Changing the U-Boot boot command to fetch a small bootscript file using TFTP.
  • An example bootscript for TFTP boot and NFS root filesystem.
  • Use of mkimage to convert the bootscript text file into a U-Boot script image file.
  • A breakdown of the bootscript to show different options.

IMPORTANT NOTE:

  • {Sept 2014} There is a problem in Parallella U-Boot w.r.t. the Ethernet interface after any network activity in U-Boot (e.g. TFTP). (See the post on the Parallella forum post by tajama). The ethernet interface is left in an unuseable state. A workaround is included in the script example below; but before attempting to apply it - you MUST check the U-Boot version. (Revisit)
  • {Sept 2014} the Parallella U-Boot is being updated which just might affect the script below. (Revisit).


Set up IP Addresses Using DHCP

Allocate IP addresses for the Parallella(s) and the TFTP/NFS servers in your DHCP server based on MAC address. The Parallella MAC address is printed on the board, and is also a U-Boot variable (see later).
Refer to the documentation of your DHCP server, or discuss with your network admin.
The IP addresses are used as follows:

  • U-Boot tftpboot command requests a bootscript file, and needs the TFTP server IP address <serverip>, and its own IP address <ipaddr>.
  • U-Boot tells Linux to use DHCP.
  • The NFS server uses IP addresses to control access to the exported rootfs directories.

This is an example IP address allocation and naming convention (your network may vary):

192.168.1.21	para1		// <ipaddr> IP address of Parallella "para"<n>
192.168.1.22	para2
...
192.168.1.28	para8     	// ... I wish :)
192.168.1.50	TFTP server	// IP address of TFTP server "serverip"
192.168.1.50	NFS server	// IP address of NFS server "nfs_ip"

Note: The TFTP and NFS services do not need to be on the same physical server, or even the same operating system. A Debian (Wheezy) PC provides both services in this example.

Prepare the TFTP Service

Get the required software if not already set up. On Debian:

apt-get install tftpd-hpa

The TFTP service does not start automatically.
(Note: There are a number of examples in various forums, etc, of how to automatically start the TFTP service - but not all are successful on all Linux distro's it seems! The following may work for you.)
Start the tftpd-hpa service automatically by adding a command to /etc/rc.local (just before the exit 0 line).

sudo nano /etc/rc.local

(Edit and save)

service tftpd-hpa start

To control the TFTP service from the command line use:

sudo service tftpd-hpa restart	// to restart, or use 'stop', or 'start' as needed.

To check the status of the TFTP service from the command line use:

sudo service tftpd-hpa status
[ ok ] in.tftpd is running.     	     	// Service is Up
[FAIL] in.tftpd is not running ... failed!     	// Service is Down

Set up the TFTP Directories

By default, the tftpd-hpa service looks for requested files under /srv/tftp/.
Each Parallella has its own bootscript, e.g. para1, para2, in the TFTP service directory. The bootscript is a U-Boot script image file, created using mkimage from a text file (see below).
The bootscript points U-Boot to a boot mode sub-directory holding the boot image files.
Each boot mode directory is the equivalent of the BOOT partition on a Parallella SD card, containing the kernel, parallella.bit.bin and devicetree image files.
Different sets of boot image files may be held in different directories, e.g. headless_7010, hdmi_7010, test_new_kernel. By pointing at a different directory, the bootscript controls how the Parallella will be booted.
Note: only needs one directory per boot mode - not one per Parallella.
The bootscript provides U-Boot with the TFTP commands to load the image files and to boot the kernel.
The bootscript also provides the Linux boot parameters (bootargs) to mount the NFS root filesystem.

Create a Boot Mode Directory and Prepare the Image Files

sudo mkdir -p /srv/tftp/<name>		// replace <name> with boot mode, e.g. hdmi_7010

Follow the instructions for creating the SD card (download, extract and rename the kernel uImage, parallella.bit.bin and devicetree.dtb files) but instead of 'burning' to a SD card simply copy the image files to the boot mode directory (as root).
The TFTP service directory layout (for this example) will look something like:

/svr/tftp/				// TFTP service directory
	hdmi_7010/			// boot mode = Zynq 7010 with HDMI support
		paralella.bit.bin
		devicetree.dtb
		uImage
	headless_7010/			// boot mode = Zynq 7010 Parallella configured as headless
		paralella.bit.bin
		devicetree.dtb
		uImage
	test_new_kernel/		// boot mode = temp testing variation
		paralella.bit.bin
		devicetree.dtb
		uImage
	para1			        // bootscript for para1
	para2			        // bootscript for para2
	...
	para8			        // bootscript for para8, etc

Note: The image files follow the same naming convention as for SD card booting.

Remove Bootargs from Devicetree

The Parallella devicetrees, as supplied by Adapteva, pass the boot arguments to support booting from the SD card. Instead, the boot arguments are passed to the kernel by U-Boot, as defined in the bootscript (see below). The devicetree image files need to be edited to remove the boot commands.
Install the devicetree compiler if not already installed. On Debian:

sudo apt-get install device-tree-compiler

Extract/edit/rebuild the devicetree.dtb file to remove the parameters from the chosen {} branch. Repeat for all supplied devicetree.dtb files in each boot mode directory.

cd /srv/tftp/<name>		// replace <name> with boot mode, e.g. hdmi_7010
sudo dtc -I dtb -o dev.dts -O dts devicetree.dtb
sudo nano dev.dts

Look for the chosen { } branch, remove the arguments, and save.

	chosen { }

Recompile the devicetree.dtb and delete the dev.dts text file.

sudo dtc -I dts -O dtb -o devicetree.dtb dev.dts
sudo rm dev.dts

Prepare the NFS Service

Get the required software if not already set up. On Debian:

apt-get install nfs-kernel-server

The NFS service starts automatically. To control NFS services use:

sudo service nfs-kernel-server restart		// to restart, or use 'stop', or 'start' as needed.

To check the status of the NFS service from the command line use:

sudo service nfs-kernel-server status
nfsd running          	// Service is Up
nfsd not running     	// Service is Down

Set up the NFS Directories

A Parallella may have one or more Linux root filesystem held in different NFS directories, to hold different configurations or versions. These alternative root filesystems (e.g. Ubuntu, Linaro Nano, with/without SDK) are just like burning and booting off multiple SD cards.
A root filesystem on the NFS server may also be shared by a number of Parallellas, say, in a cluster. The many advantages include saving space on the server, and mainly not having to replicate SD cards for each cluster member.

Create a top directory /srv/nfs, and create a NFS directory under that for each root filesystem being created.
Here are some examples of NFS filesystem directories, including shared root filesystems and where a Parallella may have a choice of root filesystems.

sudo mkdir -p /srv/nfs
sudo mkdir -p /srv/nfs/ubuntu		// rootfs based on standard Parallella Ubuntu build, to be shared by all cluster members
sudo mkdir -p /srv/nfs/nano		// rootfs based on a slim linaro nano build, to be shared by all cluster members
sudo mkdir -p /srv/nfs/ubuntu_SDK	// rootfs based on Parallella Ubuntu build, with latest SDK, to be used by para1 which has HDMI, and USB devices.
sudo mkdir -p /srv/nfs/nano_X_server	// rootfs based on a linaro nano build with SDK, X server, to be used by para1 which has HDMI, and USB devices.

Set up Parallella NFS Root Filesystems

Instead of 'burning' a filesystem image to a partition on the SD card, place the payload root filesystem in the NFS directory, e.g. /srv/nfs/ubuntu/.
Each source of root filesystem may involve different preparation to enable the NFS access to work smoothly.
See the examples in the How-to for Extracting Parallella NFS rootfs

Update NFS Exports File

The NFS server requires /etc/exports to be configured correctly, to control access to each NFS filesystem directory to specific hosts.
For each Paralella root filesystem that is created, add the export control line to /etc/exports, adjusting (as you should for all examples herein) for your local IP address and directory naming scheme. The following is an example based on the layout described above.
Note that where multiple hosts share an exported directory, the 'hostIP(attributes)' are separated by a <space>. There is no <space> between hostIP and (attributes). Continuation lines may be used for clarity, but care must be taken to ensure that the <space> syntax is followed: continuation is " \" only (no hidden tabs, etc).

sudo nano /etc/exports

(Edit and save)

/srv/nfs/ubuntu 192.168.1.21(rw,sync,no_root_squash,no_subtree_check) \
192.168.1.22(rw,sync,no_root_squash,no_subtree_check) \
192.168.1.23(rw,sync,no_root_squash,no_subtree_check) \
192.168.1.24(rw,sync,no_root_squash,no_subtree_check)
/srv/nfs/ubuntu_SDK 192.168.1.21(rw,sync,no_root_squash,no_subtree_check)
/srv/nfs/nano 192.168.1.21(rw,sync,no_root_squash,no_subtree_check) \
192.168.1.22(rw,sync,no_root_squash,no_subtree_check) \
192.168.1.23(rw,sync,no_root_squash,no_subtree_check) \
192.168.1.24(rw,sync,no_root_squash,no_subtree_check)
/srv/nfs/nano_X_server 192.168.1.22(rw,sync,no_root_squash,no_subtree_check)

Note: The bootscript ensures that only one of the optional filesystems will be accessed/mounted at any one time by a Parallella on a re-boot.

Export the NFS Directories

Ensure that these directories are made visible by the NFS service. Either:

sudo exportfs -a

or

sudo service nfs-kernel-server restart



Set Up the Parallella to TFTP Boot

Power off the Parallella and remove the ethernet, USB peripheral and HDMI cables and SD card.
Connect a USB serial cable to the 3-pin UART header on the Parallella. An example device from Adafruit, and see connecting a UART serial cable to the Parallella
On the PC, use a terminal program (e.g. screen, minicom) to connect to the UART Serial device. On minicom, set hardware flow control to off, and point the logfile to, say, ~/minicomlog' for diagnostics.
Power up the Parallella.
After the boot failure messages, you should get the zynq-uboot> prompt in the terminal window.
Display a list of the current state of the U-Boot environment variables using the printenv command.
Check the value of the ethaddr=xx:xx:xx:xx:xx:xx variable; this should be the same as the label on the board, and the MAC address you are using for this Parallella in your DHCP server.
Enter the following commands at the zynq-uboot> prompt in order to:

  • set the hostname variable which will be used as the bootscript name. Change for each Parallella.
  • set the IP address of the Parallella and the TFTP server. Change for each Parallella.
  • set the Ip address of the TFTP server. Usually the same for all Parallellas.
  • create a variable t-boot which contains the commands to fetch and then execute the bootscript.
  • change the U-Boot bootcmd so that it will run the t-boot TFTP boot sequence, only if no SD card is present.
setenv hostname para1
setenv ipaddr 192.168.1.21
setenv serverip 192.168.1.50

setenv t-addr 0x100000
setenv t-boot 'tftpboot ${t-addr} ${hostname} ; source ${t-addr}'
setenv bootcmd 'run modeboot ; run t-boot'

Trying and failing to find an SD card will add a few seconds to the boot sequence, but this is a useful fall-back. Optionally, to go straight to tftp boot, replace the bootcmd above with the following:

setenv bootcmd 'run t-boot'

Check that the variables have been set correctly, using printenv command, and save to flash memory, using saveenv command. Power off.
Reconnect the ethernet cable and any USB peripherals or HDMI you intend to use on the Parallella.
Ready to TFTP boot.
Notes:

  • It's worthwhile checking (again) after a power recycle that the U-Boot variables have been set correctly
  • To correct/change a variable, use the setenv command with new/correct value.
  • To remove a variable e.g. 'badvarible', use the setenv command with no value, e.g. setenv badvarible
  • U-Boot autocompletes commands so print, set, save will also work.


Write a Parallella Bootscript

On the TFTP server host, the bootscript image file is initially created and edited as a text file, and compiled into a U-Boot executable image using mkimage.

Create a working directory to hold the bootscript text file(s).

mkdir ~/Documents/bootscr

Create a text file and copy/paste the text below as a template. The following is an example bootscript which is described below. This loads the headless image files for a 7010, and will load the shared linaro nano root filesystem.

cd ~/Documents/bootscr
nano para1.txt

(Edit and save)

setenv tftp_dir headless_7010
setenv nfs_rfs /srv/tftp/nano

setenv bootargs ip=dhcp
setenv bootargs ${bootargs} console=ttyPS0,115200

setenv nfs_ip 192.168.1.50
setenv bootargs ${bootargs} root=/dev/nfs rw nfsroot=${nfs_ip}:${nfs_rfs}

setenv fpga_image parallella.bit.bin
setenv fpga_addr 0x4000000
setenv fpga_size 0x3dbafc
setenv fpga_tftp 'tftpboot ${fpga_addr} ${tftp_dir}/${fpga_image}'
setenv fpga_load 'fpga load 0 ${fpga_addr} ${fpga_size}'

setenv fdt_image devicetree.dtb
setenv fdt_addr 0x2A00000
setenv fdt_tftp 'tftpboot ${fdt_addr} ${tftp_dir}/${fdt_image}'

setenv kernel_image uImage
setenv kernel_addr 0x3000000
setenv kernel_tftp 'tftpboot ${kernel_addr} ${tftp_dir}/${kernel_image}'

setenv phy_rst 'mw.w f8000008 df0d ; mw.w f8000140 00100801 ; mw.w f8000004 767b'
setenv rset_phy 'run phy_rst'

setenv boot_now 'bootm ${kernel_addr} - ${fdt_addr}'

run fpga_tftp fpga_load kernel_tftp fdt_tftp rset_phy boot_now

Copy the file to create a bootscript for each Parallella, changing the filename, e.g. para2.txt. Edit the values of the tftp_dir and nfs_rfs variables in each file as required. If the boot mode is the same and the NFS rootfs is shared, then there are usually no edits required.
To change the mode of a Parallella boot, edit the 'paraX.txt' file to change the tftp_dir and/or nfs_rfs variables, before re-making the image.
The directory structure on the Debian PC will then look something like this:

/home/{username}/Documents/bootscr/   	
      para1.txt	
      para2.txt
      ...
      para8.txt

Make the Bootscript Image

Install mkimage, which is part of the Das U-Boot tool-set, if not already installed. On Debian:

sudo apt-get install u-boot-tools

Convert each bootscript text file into a loadable image by mkimage, and place each image in the TFTP server directory. For example:

cd ~/Documents/bootscr
sudo mkimage -A arm -O u-boot -T script -C none -a 0 -e 0 -n "t-Boot Script" -d para1.txt /srv/tftp/para1
sudo mkimage -A arm -O u-boot -T script -C none -a 0 -e 0 -n "t-Boot Script" -d para2.txt /srv/tftp/para2
...
sudo mkimage -A arm -O u-boot -T script -C none -a 0 -e 0 -n "t-Boot Script" -d para8.txt /srv/tftp/para8

Reboot the Parallella

Reboot by power off, wait a few seconds, power on.
The output to the UART Serial terminal screen shows initialisation of the board and network, and then the boot sequence looking for the TFTP server.
If the TFTP 'Loading:' line puts out a few 'T T T's, then it's retrying. Give it a few moments but if there's a line of 'T's then check that the TFTP service is actually running, and that the IP addresses and filename of the bootscript are valid.
Once the small (~1kb) bootscript has been loaded and is executed by U-Boot, further TFTP requests will be seen as the image files are downloaded before U-Boot hands over to the kernel.

Breakdown of the Bootscript

This section takes the bootscript example and breaks it down to illustrate what may be changed to support your local environment.

  • Set up the bootscript to point to the required boot mode (i.e. TFTP sub-directory) and the NFS filesystem directory chosen for this Paralella. By editing these first two lines, a Parallella can be re-booted using a different FPGA, kernel and/or a different NFS root filesystem. Note that the the NFS filepath is the same as the line in NFS exports.
setenv tftp_dir headless_7010	   	      // or, hdmi_7010, etc
setenv nfs_rootfs /srv/nfs/nano	   	      // or /srv/nfs/nano_sdk, etc
  • Set the initial bootargs string to tell the kernel to use DHCP when loaded.
setenv bootargs ip=dhcp
  • Add the console argument to the bootargs string. If the console is not required, delete this line.
setenv bootargs ${bootargs} console=ttyPS0,115200
  • Add the NFS boot arguments to the bootargs string. Note the NFS server IP variable is not the same as the TFTP serverip variable, although they may have the same value.
setenv nfs_ip 192.168.1.50
setenv bootargs ${bootargs} root=/dev/nfs rw nfsroot=${nfs_ip}:${nfs_rfs}
  • If required, add additional kernel boot diagnostic flags to the bootargs string. If not required, delete this line.
setenv bootargs ${bootargs} nfsrootdebug earlyprintk
  • Set up the variables for the command to tftpboot the fpga image, and the command to load the image into the fpga.
setenv fpga_image parallella.bit.bin
setenv fpga_addr 0x4000000
setenv fpga_size 0x3dbafc
setenv fpga_tftp 'tftpboot ${fpga_addr} ${tftp_dir}/${fpga_image}'
setenv fpga_load 'fpga load 0 ${fpga_addr} ${fpga_size}'
  • Set up the variables for the command to tftpboot the devicetree image.
setenv fdt_image devicetree.dtb
setenv fdt_addr 0x2A00000
setenv fdt_tftp 'tftpboot ${fdt_addr} ${tftp_dir}/${fdt_image}'
  • Set up the variables for the command to tftpboot the kernel image.
setenv kernel_image uImage
setenv kernel_addr 0x3000000
setenv kernel_tftp 'tftpboot ${kernel_addr} ${tftp_dir}/${kernel_image}'
  • Patch U-Boot network handling. This is a workround for the problem identified by tajama, and referred to above. It MAY apply to your version but YOU MUST CHECK!! This U-Boot patch applies to the following version, which is output initially by U-Boot:
U-Boot 2012.10-00003-g792c31c (Jan 03 2014 - 12:24:08)
setenv phy_rst 'mw.w f8000008 df0d ; mw.w f8000140 00100801 ; mw.w f8000004 767b'
setenv rset_phy 'run phy_rst'
  • Set up the variable for the command to boot into the kernel, passing the kernel and devicetree image addresses.
setenv boot_now 'bootm ${kernel_addr} - ${fdt_addr}'
  • Finally, run the sequence of individual commands and boot. If any of the command sequence fails, then the 'run' command will halt. Note there are no ';' separators in the command parameters.
run fpga_tftp fpga_load kernel_tftp fdt_tftp rset_phy boot_now