NAI BSP Guide for VxWorks 7 — NIU2A
Applies to VxWorks 7 SR0660, 22.09, 23.03, and 24.03.
Warnings
- The NIU2A is built with the ARMARCH7 CPU (Cortex-A9).
- Booting from SATA requires U-Boot
2014.01 Sep 18 2024 - 14:57:25 00002.00004or later on the NIU2A — see section 5.4. - 2018 builds of the NIU2A need a device-tree source change before the VSB is built — see Appendix A. The BSP as delivered is configured for 2014 builds.
Overview
This guide covers installing the NIU2A BSP and building a VxWorks 7 kernel image from it: the VxWorks Source Build (VSB), the VxWorks Image Project (VIP), and the SSK2 downloadable kernel module (DKM) that carries the NAI libraries and sample applications. It then covers booting the finished image on the NIU2A with U-Boot, over the network or from SATA.
The supplied delivery contains the following folders:
base
naiNIU2A
DocumentationnaiNIU2A is the NIU2A BSP. base contains the NAI library (SSK) and its BSP
files, along with the sample application sources for the NIU2A and its function
modules. Documentation contains the NAI library documentation for each
function call in the SSK.
1. Install the BSP
Copy the naiNIU2A folder into the VxWorks installation’s board directory for
your release.
For VxWorks 7 SR0660:
$(WIND_BASE)/pkgs_v2/os/board/xilinx/For VxWorks 7 22.09, 23.03, and 24.03:
$(WIND_BASE)/source/os/arch/arm/board/xilinx/NOTE: If your NIU2A is a 2018 build, edit
_dts/naiNIU2A.dtsas described in Appendix A before creating the VSB.
2. Create the VxWorks Source Build (VSB)
- Open Workbench and select File > New > Wind River Workbench Project.
- Click Based on Category > select Platform Development.
- Click Build Type > select VxWorks Source Build > Next.
- Name the project (for example
naiNIU2A-vsb) > Next. - Click the BSP dropdown and select
naiNIU2A_x_x_x_xwith CPU ARMARCH7. - Ensure “Link in sources to project” is checked.
- Click Finish to create the VSB.
- Right-click the VSB project and select Build Project.
Once the VSB has been built, the VIP and the DKM can be created.
3. Create the VxWorks Image Project (VIP)
- Open Workbench and select File > New > Wind River Workbench Project.
- Click Based on Category > select Platform Development.
- Click Build Type > select VxWorks Image Project > Next.
- Name the project (for example
naiNIU2A-vip) > Next. - Base the VIP on the VSB project built in section 2. Make sure the VSB project and BSP name are correct, then click Next.
- Click Profile > select PROFILE_DEVELOPMENT > Finish.
NOTE: PROFILE_DEVELOPMENT is recommended while a project is in the development phase.
Then configure the kernel:
- Expand the VIP project and double-click Kernel Configuration > Bundles.
- Right-click NAI BSP default components > Add.
- Right-click Standalone kernel shell > Add.
- File > Save (or
Ctrl+S).
NOTE: The NAI BSP default components bundle includes the NAI BSP in its entirety. The standalone kernel shell adds components useful during development. The VIP is built at the end of section 4, after the DKM is referenced.
4. SSK2 Downloadable Kernel Module (DKM)
The DKM carries the NAI BSP object code, the NAI libraries (SSK) and the sample applications, and is linked into the kernel image through a VIP project reference.
4.1 Create the DKM
- Open Workbench and select File > New > Wind River Workbench Project.
- Click Based on Category > select Application Development.
- Click Build Type > select Downloadable Kernel Module > Next.
- Name the project (for example
naiNIU2A-dkm) > Next. - Click Based on > select a source build project, ensure the VSB from section 2 is selected, then click Finish.
- Delete the automatically created
dkm.c. - Add the
nai_bsp,nai_libs,mbcore_base, andnai_sample_appsfolders (from the delivery’sbasefolder) into the DKM project.
NOTE: If
nai_bspcontains more than onenaibsp_config_<sbc>_vxworks7folder, bring in only the one for this board —naibsp_config_niu2a_vxworks7.
4.2 DKM include paths
-
Right-click the DKM project and select Rebuild Project. On the first build you are prompted to generate the include paths.
-
Click Generate Includes… > Next > Add and add the following paths to the DKM project:
$(PRJ_ROOT_DIR) $(PRJ_ROOT_DIR)/nai_bsp $(PRJ_ROOT_DIR)/nai_bsp/naibsp_config_niu2a_vxworks7 $(PRJ_ROOT_DIR)/mbcore_base/common/include -
Click Finish.
-
Right-click the DKM project > Rebuild Project.
4.3 Reference the DKM from the VIP
-
Right-click the VIP project and select Properties > Project References.
-
Check the box for the DKM project and click Apply and Close.
-
Right-click the VIP project again and select Properties > Build Properties > Paths > Add, then add the following paths, replacing
<PATH_TO_DKM_PROJECT>with the actual DKM project path:<PATH_TO_DKM_PROJECT>/nai_bsp/naibsp_config_niu2a_vxworks7 <PATH_TO_DKM_PROJECT>/nai_bsp -
Click Apply and Close.
-
Right-click the VIP project > Rebuild Project.
At this point the kernel image is built and ready to be loaded onto the NIU2A.
5. Booting VxWorks 7 with U-Boot
This section covers booting the newly created VxWorks image with U-Boot, over the network via TFTP or from SATA.
Before starting, attach a serial cable between the NIU2A and the host PC, connect the board to the same network as the host, and open a terminal emulator on the host. Every prompt from section 5.3 onward — U-Boot and the VxWorks shell — is reached over that console.
Baud rate: 115200
Data: 8 bit
Parity: None
Stop: 1 bit
Flow control: None5.1 Host TFTP server
Start a TFTP server on the host PC. For Windows:
$(WIND_BASE)/host/x86-win32/bin/tftpd32.exeSet Current Directory to the directory that contains the uVxWorks and
naiNIU2A.dtb files:
$(WIND_HOME)/workspace/<VIP_PROJECT>/default5.2 Host FTP server (WFTPD)
The TFTP server only hands uVxWorks and the DTB to U-Boot. The FTP server
backs the /host.host file system the running VxWorks kernel mounts (it appears
in the devs listing in section 5.4.2), using the u=/pw= credentials from
the boot line. The mount is made at boot, so start the FTP server before booting
the target. Booting continues without it, but section 5.4.3 copies the image
files off /host.host to SATA — that step needs the mount in place.
Start an FTP server on the host PC. For Windows:
$(WIND_BASE)/host/x86-win32/bin/wftpd32.exeConfigure the FTP server as follows:
- Click the Security tab > users/rights > New User.
- Username:
winner - Password:
winner - Home Directory: the same directory the TFTP server points to.
NOTE: The username and password must match the
u=andpw=values in thevxargsboot line (sections 5.3 and 5.4). If you choose different credentials here, change them there as well.
5.3 U-Boot network boot
Stop U-Boot on the NIU2A by pressing the Esc key. Once at the U-Boot prompt,
modify the U-Boot environment variables to reflect your environment. During boot
the VxWorks kernel reads the bootargs variable to get the host, target and
network mask, as well as the username and password for the FTP server running on
the host.
U-Boot environment variables:
setenv ipaddr 192.168.1.16
setenv netmask 255.255.255.0
setenv serverip 192.168.1.5
setenv vxargs 'setenv bootargs gem(0,0)host:vxWorks h=192.168.1.5 e=192.168.1.16:ffffff00 u=winner pw=winner f=0x00'
saveenvNOTE:
hinvxargsandserveripare based on your host PC IP configuration.
To boot the VxWorks kernel over the network:
tftpboot 0x05000000 uVxWorks
tftpboot 0x04000000 naiNIU2A.dtb
run vxargs
bootm 0x05000000 - 0x04000000To automate booting over the network:
setenv vxBootTftp 'tftpboot 0x05000000 uVxWorks && tftpboot 0x04000000 naiNIU2A.dtb && bootm 0x05000000 - 0x04000000'
setenv vxBootCmdTftp 'echo Loading VxWorks from TFTP... && run vxargs && run vxBootTftp'
setenv default_bootcmd run vxBootCmdTftp
saveenvNOTE: The NIU2A’s U-Boot runs
default_bootcmdat power-up rather thanbootcmd.
On the next power cycle, the target boots VxWorks over the network automatically.
5.4 Booting from SATA
The NIU2A supports booting the VxWorks image directly from SATA. The board is first booted once over TFTP so the SATA drive can be formatted and the image files copied to it from the VxWorks shell.
To boot from SATA, the U-Boot on the NIU2A must be the version shown below or later. Contact the factory for an updated U-Boot if the version on the NIU2A is older.
U-Boot 2014.01 Sep 18 2024 - 14:57:25 00002.000045.4.1 Set up the U-Boot environment
Stop U-Boot on the NIU2A by pressing the Esc key. Once at the U-Boot prompt,
set up the environment exactly as in section 5.3 (ipaddr, netmask,
serverip and vxargs, followed by saveenv). If you have already worked
through section 5.3, saveenv stored those values and they are still in place.
Then load and boot the kernel over TFTP:
tftpboot 0x05000000 uVxWorks
tftpboot 0x04000000 naiNIU2A.dtb
run vxargs
bootm 0x05000000 - 0x040000005.4.2 Format the SATA drive
U-Boot needs a FAT32 filesystem to boot a VxWorks kernel. After booting the image, retrieve the name of the SATA device on the NIU2A. Enter the following at the VxWorks command line:
devsThe SATA device appears in the listing as /ata0a:
drv refs name
3 [ 3] /ata0a
9 [ 3] /host.host
0 [ 5] /null
1 [ 5] /ttyS0
2 [ 3] /vxbusIf /host.host is missing from the listing, the FTP server was not up when the
kernel booted — start it (section 5.2), boot VxWorks again over TFTP as in
section 5.4.1, and repeat this section.
NOTE: The mount is named
host.<host-name>after the host-name field of thevxargsboot line (section 5.3), sogem(0,0)myPC:vxWorkswould give/host.myPCinstead. Section 5.4.3 refers to it as/host.host.
To write to the SATA on the NIU2A, the SATA write protection must be disabled. Enter the following at the VxWorks command line:
naiSetSataWriteProtect 0Then format for FAT32:
dosFsVolFormat "/ata0a",0x20The format reports its progress and ends with OK.
5.4.3 Copy the VxWorks image to SATA
Once the SATA drive has been formatted, copy naiNIU2A.dtb and uVxWorks to
it.
The FTP server’s home directory (section 5.2) is the VIP’s default folder, and
the running kernel mounts it as /host.host — the image files are reached
there directly. On the VxWorks command line:
cd "/host.host"
cp "naiNIU2A.dtb","/ata0a"
cp "uVxWorks","/ata0a"Once both files have been copied to SATA, power cycle the NIU2A to configure U-Boot.
5.4.4 Configure U-Boot for SATA boot
Stop U-Boot on the NIU2A by pressing the Esc key. Once at the U-Boot prompt, modify the U-Boot environment variables to reflect your environment:
setenv dtbvipbootstart 0x04000000
setenv vipbootstart 0x05000000
setenv vxBootSata 'sata init && fatload sata 0 ${vipbootstart} uVxWorks && fatload sata 0 ${dtbvipbootstart} naiNIU2A.dtb && bootm ${vipbootstart} - ${dtbvipbootstart}'
setenv vxBootCmdSata 'echo Loading VxWorks from SATA... && run vxargs && run vxBootSata'
setenv default_bootcmd run vxBootCmdSata
saveenvOn the next power cycle of the target, VxWorks boots from SATA automatically.
Appendix A — Ethernet for 2018 Builds of the NIU2A
The BSP’s device tree is configured for 2014 builds of the NIU2A. If you are
using a 2018 build, the device-tree source _dts/naiNIU2A.dts in the BSP must
be changed before the VSB is built (section 2), otherwise Ethernet does not come
up.
-
Near line 10 of
naiNIU2A.dts, uncomment the programmable-logic include:#include "naiNIU2A_PL.dtsi" -
Then comment out the include below it:
#include "naiNIU2A.dtsi" -
Near line 68 of
naiNIU2A.dts, a&gem0section is followed by a&gem1section. Both are commented out for 2014 builds. Uncomment them for 2018 builds.
Revision History
| Rev | Revision Date | Description | Author |
|---|---|---|---|
| 1 | June 28, 2021 | Initial Release | HP |
| 2 | December 12, 2023 | Updated for VxWorks 22.03 and later | MS |
| 3 | December 21, 2023 | Fixed booting from QSPI instructions | MS |
| 4 | March 21, 2024 | Changed tftp to tftpboot in boot instructions | MS |
| 5 | July 16, 2024 | Added note about Ethernet on 2018 NIU2A | MS |
| 6 | September 20, 2024 | Added support to boot VxWorks from SATA | HP |
| 7 | August 26, 2025 | Fix typos | MS |
| 8 | September 17, 2026 | Markdown edition of this guide, replacing the Rev 7 Word/PDF version | EZ |
