NSP 1.10.03.15 GA Release Notes
September 24, 2015
This NSP Release contains ethernet driver support for the evmOMAPL138
ARM9 and and the evm6748 C674X DSP. It also provides SYS/BIOS 6.x
network examples which run on both the evm6748 C674X DSP and the
evmOMAPL138 ARM9 processor.
Introduction,
Documentation,
What's New,
Upgrade Info,
Compatibility Information,
Device Support,
Validation Info,
Known Issues,
Examples,
Rebuilding The Driver Library,
Version Information,
Technical Support.
The Network Development Kit Support Package (NSP)
contains ethernet driver code, libraries and network examples for
various TI
platforms. It is meant to supplement the Network Development Kit
(NDK), which consists of the platform independent networking code.
The NSP includes demonstration software which showcases
the OMAPL138's capabilities across a range of network enabled
applications using SYS/BIOS 6.x.
The NDK examples found in this NSP can serve as a rapid prototype platform
for the development of network and packet processing applications, or to add
network connectivity to existing applications for communications,
configuration, and control. Using the components provided in the NDK and NSP,
developers can quickly move from development concepts to working
implementations attached to the network..
The following documents provide an overview of the NDK, the networking
programming API, and how to port the software to other platforms (The
following documents have not been updated to reflect changes in this
release).
-
NDK User's
Guide: Documents the NDK basics, and describes how to develop or
port a network-enabled application. It also describes how to customize
the network environment to fit your embedded environment.
- NDK Programmer's
Reference Guide: Describes the NDK library API calls in detail.
It also includes a description of the stack's internal object based
API functions.
- NDK Support
Package Ethernet Driver Design Guide:
Describes the NIMU based architecture of the Ethernet Drivers
packaged in the NSPs.
In addition, users are encouraged to monitor (and contribute to!) the
TI Embedded Processors Wiki.
Release notes from previous releases are also available in the
release website.
New Features
- This is a patch release to the NSP 1.10.02.09 product.
- Major review and all around clean up of this driver code
- Removed unused/unnecessary variables
- Changed code to conform to local coding standard
- Fixed memory leak due to private data struct not being deallocated
- Reduced number of variables used to set the MAC address and made the code to do this less confusing
- Removed unnecessary functions HwPktOpen and HwPktShutdown
- Removed unused function EMAC_timerTick
- Updated IOCTL to allow the MAC address to be changed (note this causes the stack to reboot)
- Fixed problem in which an extra 4 bytes for FCS was being appended to small sized frames, causing errors to show in Wireshark
- Changed DSP version of the driver to only disable the EMAC interrupts instead of disabling all. This allows for better real time performance.
- Updated driver to properly handle fatal HOSTPEND error
- Removed references to sin_len field in examples
Bug Fixes
- SDOCM00112837 OMAPL138 driver adds redundant 4 byte FCS padding causing errors to show in Wireshark
- SDOCM00114665 (NSP) EMAC_timerTick function is not referenced anywhere
None.
This release must be used with following component versions (or higher):
- SYS/BIOS 6.35.01.29
- CCS 5.4
- NDK 2.22.03.20
- XDCtools 3.25.00.48
- C674X: C6000 Code Generation Tools 7.4.2
- ARM9: TMS470 Code Generation Tools 5.0.4
This release supports the following devices:
- C674x: COFF and ELF
- Note: COFF support has been dropped as of NDK version 2.24. If you wish to use COFF, you must use NDK 2.23 (or earlier).
- ARM9: ELF format only
The examples in this release were built and validated against the following software
components:
- SYS/BIOS 6.42.02.29
- NDK
- COFF: 2.23.01.01
- ELF: 2.24.03.35
- XDCtools 3.31.01.33_core
- CCS 6.1.0.00104
- C674X: C6000 Code Generation Tools (COFF) 7.4.2
- C674X: C6000 Code Generation Tools (ELF) 7.4.2
- ARM9: TMS470 Code Generation Tools 5.2.2
Pre-built binaries (driver libraries) were built and validated against the following software components:
- SYS/BIOS 6.37.02.27
- NDK 2.24.03.35
- XDCtools 3.25.05.94
- C674X: C6000 Code Generation Tools (COFF) 7.4.2
- C674X: C6000 Code Generation Tools (ELF) 7.4.2
- ARM9: TMS470 Code Generation Tools 5.0.4
- Red Hat Enterprise Linux 4 (SMP)
This release was validated using the following hardware platforms:
- Starting in NDK 2.24, COFF libraries are no longer supported. If you wish to build using COFF, you must use NDK 2.23 (or earlier).
NDK examples may be found in the "packages/ti/ndk/examples"
directory . The examples are stored as archive files that are meant to be imported into CCS.
The
following set up examples archives are currently shipped with the NSP.
You should choose one of the following archives depending on the
hardware platform (evmOMAPL138 or evm6748) you are using:
- ndk_evm6748_coff_examples.zip - C674X DSP examples which build using SYS/BIOS 6.x for COFF
- ndk_evm6748_elf_examples.zip - C674X DSP examples which build using SYS/BIOS 6.x for ELF
- ndk_omapl138_arm9_examples.zip - ARM9 examples which build using SYS/BIOS 6.x
Importing The NDK Example Projects Into CCS
Before following the steps in this section, please ensure that all dependent software that is listed in the section Compatibility Information has been installed.
- Open CCS and create a new workspace.
- From within the CCS Edit View, select the menu option "Project -> Import Existing CCS/CCE Eclipse Project"
- In the window that appears, click "Select Archive File", then click the "browse" button.
- Navigate
to the location where you installed the nsp_1_10_03_15. If you
installed the NSP into C:\ti, then
navigate to:
- C:\ti\nsp_1_10_03_15\packages\ti\ndk\examples
- Once in the examples directory, you will see the set of examples archives:
- ndk_evm6748_coff_examples.zip
- ndk_evm6748_elf_examples.zip
- ndk_omapl138_arm9_examples.zip
- Choose the archive file which correpsonds to your setup and click open
- Under
"Discovered Projects" you should see the examples listed that come from
the archive(s) you selected. Click "Finish" to import the examples.
- Right click on the example project and select "Build Settings."
- Update the XDCTools, NDK, and SYS/BIOS versions for the project as appropriate.
- Click "OK" to apply the settings.
- Repeat the previous three steps for each example project you wish to build.
- You may now build the NDK examples within CCS
- NOTE: if a project with the
same name as the NDK examples already exists in the workspace, then it
will not be found in the above steps. Therefore, it is
recommended that a new workspace is used for the above steps.
The NDK Support Package includes the EMAC driver source files and a
RTSC build files that allow you to modify the driver sources and
rebuild the EMAC library. You can rebuild the EMAC driver sources in
order to modify, update or add functionality. If you edit any of the
driver source code and/or RTSC build files, you must rebuild the EMAC
library in order to incorporate these changes into it.
The instructions on this page are intended for rebuilding the EMAC
driver library on Microsoft Windows in a DOS shell using the xdc
command. However, this library may also be re-built on Linux using the
xdc command that comes packaged with XDCtools. Linux users should
substitute any Windows specific copy, explorer, or DOS shell
instructions or commands with the Linux equivalents in the steps that
follow.
Warning: This section provides details about rebuilding the EMAC
driver source code. We strongly recommend that you copy the NSP
installation to a directory with a different name and update and
rebuild that copy, rather than rebuilding the original installation.
Making A Backup Copy Of The NSP Installation
- Create
a new directory on your computer. You will use this directory to store
a copy of the NSP installation. This directory will act as a container
for your NSP modifications. The full path to this directory cannot contain any spaces.
For example, we recommend creating a directory called "C:/MYNSPBUILDS"
rather than using a location in the "My Documents" directory tree.
- Using Windows Explorer, copy the
entire NSP installation to the directory you just created. For example,
if you installed the NSP in the default installation location, then you
should copy the C:/ti/nsp_1_10_03_15
folder and all of its contents to the C:/MYNSPBUILDS folder. After this
step, the C:/MYNSPBUILDS folder should contain the nsp_1_10_03_15
folder, which is a copy of your NSP installation.
- Rename
the folder that contains the copy of the NSP installation. For example,
rename the C:/MYNSPBUILDS/nsp_1_10_03_15 directory to
C:/MYNSPBUILDS/CUSTOM_nsp_1_10_03_15
Updating The config.bld File
- Using Windows Explorer, move to the C:/MYNSPBUILDS/CUSTOM_nsp_1_10_03_15/packages/ti/drv/omapl138 directory.
- In this directory, find the file called "config.bld.default". Rename this file to be "config.bld".
- Open the config.bld file for text editing.
- Make
sure that the paths to the NDK 2.22 installation, XDCtools, and Code
Generation Tools are correct. For example, if you have installed NDK
2.22 and CCSv5.4 into the default locations, then the default values of
the following variables in config.bld should be correct. If you have
installed these components into different locations, then you must
update these variables to point to the correct installation locations:
var xdctoolsInstallDir = "C:/ti/xdctools_3_25_00_48";
var ndkInstallDir = "C:/ti/ndk_2_22_03_20";
C674.rootDir = "C:/ti/ccsv5/tools/compiler/c6000"
armElfTargets.Arm9.rootDir = "C:/ti/ccsv5.4/tools/compiler/tms470";
- Near the end of the file, look for the array called
Build.targets
.
This array contains the list of targets for which the EMAC driver
should be built. Make sure that the target for which you want the
driver built is uncommented. To build for all targets, this array
should look like the following:
Build.targets = [
C674,
C674_big_endian,
armElfTargets.Arm9,
];
- Save and exit the file.
Re-building The EMAC Driver
- In a DOS shell, navigate to the location of the copy of the NSP installation:
cd C:/MYNSPBUILDS/CUSTOM_nsp_1_10_03_15/packages/ti/drv/omapl138
- Run the XDC command to rebuild the driver library
xdc
- Or, if your XDCtools installation location is not on your path, type:
"C:/ti/xdctools_3_25_00_48"/xdc
- The driver rebuild should begin
This product's version follows a version format, M.mm.pp.bb,
where M is a single digit Major number, mm is 2 digit
minor number, pp is a 2 digit patch number, and b is an
unrestricted set of digits used as an incrementing build counter.
To support multiple side-by-side installations of the product, the
product version is encoded in the top level directory,
ex. nsp_1_10_03_15.
Subsequent releases of patch upgrades will be identified by the patch
number, ex. NSP 1.00.01 with directory nsp_1_00_01.
Typically, these patches only include critical bug fixes.
Check
the NDK
website for updates.
Last updated: September 24, 2015 Build Ver: nsp_1_10_03_15 Rev: