NDK 2.24.02.31 GA Release Notes
April 14, 2015
This GA release of the NDK contains documentation updates, support
for graphical configuration pages, and major bug fixes.
This release is intended to support
SYS/BIOS 6.37.02.27 or greater.
Introduction,
Documentation,
What's New,
Upgrade Info,
Compatibility Information,
Device Support,
Validation Info,
Known Issues,
Benchmarks,
Examples,
Rebuilding The NDK Core Libraries,
Version Information,
Technical Support.
The Network Developer's Kit (NDK) is a platform for development
and demonstration of network enabled applications on TI embedded
processors,
currently limited to the TMS320C6000 family and ARM processors.
The code included in this NDK release is generic C code which runs
on any C64P, C66, C674, ARM9, Cortex-A8, Cortex-A9, Cortex-A15, Cortex-M3,
or Cortex-M4 device.
Users can obtain an appropriate NDK Support Package (NSP) for the various
supported
platforms separately. The NDK Support Packages include demonstration
software
showcasing capabilities across a range of network enabled
applications. In addition, the stack serves 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,
developers can quickly move from development concepts to working
implementations attached to the network. Please check the
release website
for previous release notes and NDK Support Packages.
The following documents provide an overview of the NDK, the networking
programming API, and how to port the software to other platforms:
-
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 Microsoft HTML
.chm API Guide: Doxygen generated API documentation
which includes IPv6 APIs.
- NDK Support
Package Ethernet Driver Design Guide:
Describes the NIMU based architecture of the Ethernet and serial drivers
packaged in the NSPs.
-
C6000 NDK Getting Started Guide: Note that this older document contains
an outdated set of lab exercises, relative to this latest NDK release.
However, the document does provide an overview of networking and it is
still a good reference guide in relation to gaining a better understanding
of how the NDK works. It highly recommended that the user use the guide for
informational purposes only and not to attempt the lab steps.
- SNTP and MYTIME Preliminary API
Documentation: API guide describing the SNTP and MYTIME modules and
how they can be used.
-
Static Analysis Reports
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 notes archive directory and the
release website.
New Features
- This is a patch release to NDK 2.24.00.11
- Many fixes and improvements to getaddrinfo, including DNS support for host
name resolution.
- Fixed various issues found in PPP deinit code.
- Fixed issue which caused IPv6 to fail intermittently.
- Fixed issue in which sockets blocked on an accept() call would not be
closed during stack reboot.
- Allow apps to configure IP address as "none".
- New hook configuration feature added - "stack reboot hook" - which allows
an application hook function to be called immediately after the return
from NC_NetStart.
- Updated NDK Support
Package Ethernet Driver Design Guide to include information for serial
based drivers.
Bug Fixes in NDK 2.24.02.31
- SDOCM00090817 IPv6 init command fails sporadically
- SDOCM00115732 remove #ifdef in NETIF_DEVICE struct
- SDOCM00115513 stack does not clean IP address to port bindings on reboot
- SDOCM00115318 Previously bound IP address automatically added back upon stack reboot
- SDOCM00115208 Need more hooks in NDK config for handling app needs during NDK reboot
- SDOCM00115010 Update Ethernet Driver Design document for Serial driver API
- SDOCM00114840 getaddrinfo needs to support flags AI_NUMERICHOST and AI_PASSIVE
- SDOCM00114814 getaddrinfo needs to support returning a (linked) list of addrinfo results
- SDOCM00114813 getaddrinfo does not handle server case properly
- SDOCM00114494 update release notes to warn users that Getting Started Guide steps are out of date
- SDOCM00114486 PPP adds duplicate IP address entries when NDK is rebooted
- SDOCM00114485 need to be able to configure app for NO ip address
- SDOCM00114368 can't properly deinitialize HDLC/PPP due to deinit order for PPPStop, pppFree calls
- SDOCM00114367 can't properly deinitialize HDLC/PPP due to illegal calls to llExit/llEnter
- SDOCM00114252 getaddrinfo needs to support host name resolution
- SDOCM00114145 DebugLevel enums in .xdc are different than osif.h
- SDOCM00113848 NDK config files should use "Program" instead of "prog"
- SDOCM00113020 NDK has incorrect Ethernet type value for IPv6
- SDOCM00107288 NDK's manifest needs a copy of the BSD license
All the libraries in this release support either IPv4 or IPv6 (or both)
and NIMU. The low-level (LL) packet driver architecture has been
deprecated since NDK v2.0.0 release.
The NDK stack in this release supports SYS/BIOS 6.37.02.27 (or
greater) and is meant to be used with CCSv5.4 and up. The OS Abstraction Layer
(OSAL) and HAL libraries
have been provided for SYS/BIOS 6.x only. DSP/BIOS 5.x support
can be found in previous versions of the NDK.
Network Support Packages (NSPs), which contains Ethernet drivers, are released
independently of this product and are usually shipped as part of a sofware
development kit (SDK). The NSPs for evmOMAPL138 and evm6748 platforms can be
obtained from the
NDK website.
Ethernet drivers for MCU devices can be found in the TI-RTOS product (see the
TI-RTOS download website).
For other devices, please contact your FAE for where to obtain the appropriate
SDK.
Removal of sa_len, sin_len and sin6_len socket address struct members
Starting in NDK 2.24, the socket address structures have been redefined to remove the following fields:
Applications which contain references to these fields must be updated due to this change!
This was done in order to make the NDK conform to industry standards, which recommend that these length fields not be implemented, nor used. Removal of these length fields also increases compatiblity between network stacks interoperating with the NDK.
The NDK's socket address structures are now defined as follows:
struct sockaddr {
UINT8 sa_family; /* address family */
char sa_data[14]; /* socket data */
};
struct sockaddr_in {
UINT8 sin_family; /* address family */
UINT16 sin_port; /* port */
struct in_addr sin_addr;
INT8 sin_zero[8]; /* fixed length address value */
};
struct sockaddr_in6 {
UINT8 sin6_family; /* address family */
UINT16 sin6_port; /* port */
UINT32 sin6_flowinfo; /* IPv6 flow information */
struct in6_addr sin6_addr; /* IPv6 address */
UINT32 sin6_scope_id; /* scope id */
};
This release must be used with following component versions (or higher):
- SYS/BIOS 6.37.02.27
- CCS 5.4
- XDCtools 3.25.05.94
- TI Code Generation Tools Versions
- 64xx+: Code Generation Tools 7.3.1
- 66xx: Code Generation Tools 7.3.1
- 674x+: Code Generation Tools 7.3.1
- Arm9: Code Generation Tools 5.0.1
- Cortex-A8: Code Generation Tools 5.0.1
- GNU Code Generation Tools Versions (for ARM only)
- Arm version gcc-arm-none-eabi-4_7-2012q4 or later
- IAR Code Generation Tools Versions (for ARM Cortex-M only)
This release supports the following devices:
- 66xx: ELF format, big and little endian
- 674x+: ELF format, little endian
- Arm9: ELF format
- Cortex-A8: ELF format and GCC
- Cortex-A9: GCC only
- Cortex-A15: GCC only
- Cortex-M3: ELF format, GCC and IAR
- Cortex-M4: ELF format, GCC and IAR
The following component versions were used to build and run test applications
to validiate this release:
- SYS/BIOS 6.41.00.26
- NSP 1.10.02.09 (evm6748)
- CCS 6.1
- TI-RTOS 2.12.00.20_eng (EK-TM4C1294XL)
- XDCtools 3.30.04.52
- Code Generation Tools 5.1.5 (evm6748 ARM9 Application Build)
- Code Generation Tools 7.2.0 (evm6748 C674X Application Build)
- Code Generation Tools 5.2.2 (EK-TM4C1294XL Application Build)
- GNU Code Generation Tools gcc-arm-none-eabi-4_7-2012q4 (EK-TM4C1294XL Application Build)
- IAR Code Generation Tools 6.70.1 (EK-TM4C1294XL Application Build)
This release was validated using the following hardware platforms:
- evm6748 (ARM9 only)
- EK-TM4C1294XL
GNU Applications Must Define _POSIX_SOURCE:
Both the NDK and GNU define the fd_set structure. Since SYS/BIOS ships GNU
header files, this conflict may arise when building NDK applications using GCC.
In order to avoid such conflicts, GCC apps need to throw -D_POSIX_SOURCE in
the application's compiler options in order to take the NDK's definition of
fd_set.
Terminated Tasks Must Be Automatically Deleted:
The NDK has been updated to take advantage of the new SYS/BIOS feature
which automatically deletes dynamically created Task objects which have
reached the terminated state. If your application configuration
is loading the package 'ti.ndk.config' and/or using the
'ti.ndk.config.Global.xdc' module, then Task clean up will be set up
correctly for you.
However, if your application configuration is
not loading the 'ti.ndk.config' package or the
'ti.ndk.config.Global.xdc' module, then you must add the following
lines of code to your application configuration (*.cfg) file:
var Task = xdc.useModule('ti.sysbios.knl.Task');
Task.deleteTerminatedTasks = true;
If not, you may experience out of memory issues due to improper Task clean up. Please refer to section 5.2.2 TaskCreate(), TaskExit(), and TaskDestroy() of the NDK User's
Guide for more information.
Known Bugs:
- SDOCM00115751 - PPP does not work with Linux modem manager
- SDOCM00115654 - HDLC and PPP shut down the stack if a bad packet received
- SDOCM00098788 - ARM9 IPv6 telnet console echo application shows negative number for send rate
- SDOCM00075040 - running ping command within a telnet session on the ndk causes the terminal and telnet session to hang
- SDSCM00025064 - DSP crash on Reboot with a PPPoE server on NDK.
Workaround: Ensure that the PPPoE server of the NDK stack is closed
before rebooting the stack.
- SDSCM00024506 - PPPoE client connection handle is not removed after
PPPoE session timeout. Workaround: Ensure that the session timeout on the
PPPoE server is configured to be a large value to avoid this issue.
NDK throughput benchmarks (described here: Network Developer's Kit (NDK) Benchmark and Sizing)
were re-built and run using the TMDXDOCKH52C1 (Concerto) platform in order to
obtain throughput and CPU load information against the NDK.
The benchmarks were run using with both IPv6 enabled and disabled (for pure
IPv4).
Sizing benchmarks were obtained from applications that, although basic,
demonstrate "real world" usage of the TCP/IP stack. The following
summarizes the size benchmark applications:
- basic - The base application; a
bare minimum, ping-able NDK application. Contains no sockets, uses
DHCP to obtain IP address.
- tcpSocket
- Minimized configuration for the TI-RTOS tcpEcho example that
contains a single TCP socket running in a single task. The TCP
send/receive buffers have been lowered to a value of 512 bytes. Uses
DHCP to obtain IP address.
- tcpEchoServer
- Minimal configuration for application that creates a TCP echo daemon
for the NDK library function "dtask_tcp_echo" (from
ti/ndk/tools/servers). The program echoes data received back to
its sender. Uses DHCP to obtain IP address.
- udpSocket
- Minimized configuration of the TI-RTOS udpEcho example that
contains a single UDP socket running in a single task. The UDP
receive buffer has been lowered to a value of 512 bytes. Uses
DHCP to obtain IP address.
- udpEchoServer
- Minimal configuration for application that creates a UDP echo daemon
for the NDK library function "dtask_udp_echo" (from
ti/ndk/tools/servers). The program echoes data received back to
its sender. Uses DHCP to obtain IP address.
- httpServer - Minimal
configuration for an HTTP server with a very basic web page and CGI
script. Uses DHCP to obtain IP address.
Please find the bench mark results here:
Timing and Size Benchmarks
NDK examples are no longer included as part of the NDK core release. All
examples are now located in a seperate Network Support Package (NSP).
This NDK release was validated using the latest NSP 1.10.02.09 product for the
evmOMAPL138 and evm6748 and so works best with the examples found in that
product. Users who have the evmOMAPL138 or evm6748 hardware platforms should
make sure to use the latest NSP product with this NDK release.
The latest NSP product may be downloaded from the
NDK website
For all other hardware platforms, the corresponding NSP products and
examples may be found in the previous NDK 2.00 and NDK 2.01.00 products,
which are also found at the
NDK website.
The NDK product includes source files and build scripts that allow the user to modify its sources and rebuild its libraries.
You can do this in order to modify, update, or add functionality. If you
edit
the NDK source code and/or corresponding build scripts, you must also
rebuild the NDK in order to create new libraries containing these
modifications.
The NDK ships with a make file which may be used to rebuild the NDK libraries after sources have been modified.
Please refer to the following web page for instructions on how to rebuild
the NDK: Rebuilding The NDK Core With Gmake
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. ndk_2_24_02_31.
Subsequent releases of patch upgrades will be identified by the patch
number, ex. NDK 2.20.01 with directory ndk_2_20_01.
Typically, these patches only include critical bug fixes.
Check
the NDK
website for updates.
Last updated: April 14, 2015 Build Ver: ndk_2_24_02_31 Rev: e31