Texas Instruments TMS320C6000 DSP User manual

TMS320C6000
Network Developer’s Kit (NDK) SupportPackage for EVMDM642
User's Guide
Literature Number: SPRUES5AJanuary 2007 – Revised June 2008

2 SPRUES5A – January 2007 – Revised June 2008Submit Documentation Feedback

Contents
Preface ........................................................................................................................................ 51 Getting Started .................................................................................................................... 71.1 Introduction ................................................................................................................ 71.2 Installing the Support Package .......................................................................................... 71.3 Rebuilding HAL Libraries ............................................................................................... 171.4 Required Terms and Concepts ........................................................................................ 192 User LED Driver ................................................................................................................. 193 Timer Driver ....................................................................................................................... 194 Serial Driver ....................................................................................................................... 204.1 Introduction ............................................................................................................... 204.2 Serial Port Driver ........................................................................................................ 214.3 Serial Port Mini-Driver ................................................................................................... 215 Ethernet Driver ................................................................................................................... 275.1 Introduction ............................................................................................................... 275.2 Ethernet Driver ........................................................................................................... 285.3 Ethernet Packet Mini-Driver ............................................................................................ 29Appendix A Revision History ...................................................................................................... 34
SPRUES5A – January 2007 – Revised June 2008 Table of Contents 3Submit Documentation Feedback

www.ti.com
List of Figures
1 BlackHawk560M Configuration to Connect to DM642 .................................................................. 92 DM642 Gel Load ........................................................................................................... 103 HelloWorld Project Open in Code Composer Studio Window ........................................................ 114 Configuring Build Options Through Code Composer Studio ......................................................... 125 Enabling NIMU for Build Through Code Composer Studio ........................................................... 136 DM642 Connect Procedure ............................................................................................... 147 DM642 Connect ............................................................................................................ 158 helloWorld Project Running Successfully on DM642 .................................................................. 169 Source File Addition to Existing Project ................................................................................. 1710 Ethernet HAL Build From Sources ....................................................................................... 18
List of Tables
1 Serial Module Device Driver Source Files .............................................................................. 202 Structure Entries ............................................................................................................ 223 Ethernet Packet Driver Source Files ..................................................................................... 284 Structure Entries ............................................................................................................ 30A-1 Document Revision History ............................................................................................... 34
List of Figures4 SPRUES5A – January 2007 – Revised June 2008Submit Documentation Feedback

PrefaceSPRUES5A – January 2007 – Revised June 2008
Read This First
About This Manual
This document contains information about the Network Developer’s Kit (NDK) Support Package forEVMDM642. The package includes source code for HAL drivers, and examples to reuse or modify themfor customer designed platforms. Pre-built HAL libraries are also delivered with the package.
How to Use This ManualThis document is divided into the following sections:•Section 1 – Getting Started: Introduces the NDK Support Package, which is designed to run the NDKon EVMDM642 platform.•Section 2 – User LED Driver: Describes the user LED driver for EVMDM642.•Section 3 – Timer Driver: Describes the timer driver for EVMDM642.•Section 4 – Serial Driver: Describes the serial driver for TL 16C752.•Section 5 – Ethernet Driver: Describes the EMAC driver for DM642.
Notational Conventions
This document uses the following conventions:•Program listings, program examples, and interactive displays are shown in a special typeface.•In syntax descriptions, the function or macro appears in a bold typeface and the parameters appear inplainface within parentheses. Portions of a syntax that are in bold should be entered as shown;portions of syntax that are within parentheses describe the type of information that should be entered.•Macro names are written in uppercase text; function names are written in lowercase.
Related Documentation from Texas InstrumentsThe following books describe the TMS320C6x™ devices and related support tools. To obtain a copy ofany of these TI documents, call the Texas Instruments Literature Response Center at (800) 477–8924.When ordering, please identify the book by its title and literature number. Many of these documents canbe found on the Internet at http://www.ti.com .
SPRU189 —TMS320C6000 DSP CPU and Instruction Set Reference Guide. Describes the CPUarchitecture, pipeline, instruction set, and interrupts for the TMS320C6000™ digital signalprocessors (DSPs).
SPRU190 —TMS320C6000DSP Peripherals Overview Reference Guide. Provides an overview andbriefly describes the peripherals available on the TMS320C6000™ family of digital signalprocessors (DSPs).
SPRU197 —TMS320C6000 Technical Brief. Provides an introduction to the TMS320C62x™ andTMS320C67x™ digital signal processors (DSPs) of the TMS320C6000™ DSP family. Describesthe CPU architecture, peripherals, development tools and third-party support for the C62x™ andC67x™ DSPs.
SPRU198 —TMS320C6000 Programmer's Guide. Reference for programming the TMS320C6000™digital signal processors (DSPs). Before you use this manual, you should install your codegeneration and debugging tools. Includes a brief description of the C6000 DSP architecture andcode development flow, includes C code examples and discusses optimization methods for the Ccode, describes the structure of assembly code and includes examples and discusses optimizationsfor the assembly code, and describes programming considerations for the C64x™ DSP.
SPRUES5A – January 2007 – Revised June 2008 Preface 5Submit Documentation Feedback

Related Documentation from Texas Instruments www.ti.com
SPRU509 —TMS320C6000 Code Composer Studio Development Tools v3.3 Getting Started Guideintroduces some of the basic features and functionalities in Code Composer Studio™ to enable youto create and build simple projects.
SPRU523 —TMS320C6000 Network Developer’s Kit (NDK) Software User’s Guide. Describes how touse the NDK libraries, how to develop networking applications on TMS320C6000™ platforms, andways to tune the NDK to fit a particular software environment.
SPRU524 —TMS320C6000 Network Developer’s Kit (NDK) Software Programmer’s ReferenceGuide. Describes the various API functions provided by the stack libraries, including the low levelhardware APIs.Trademarks
TMS320C6x, TMS320C6000, TMS320C62x, TMS320C67x, C62x, C67x, C64x, Code Composer Studio,DSP/BIOS are trademarks of Texas Instruments.
Read This First6 SPRUES5A – January 2007 – Revised June 2008Submit Documentation Feedback

1 Getting Started
1.1 Introduction
1.2 Installing the Support Package
User's GuideSPRUES5A – January 2007 – Revised June 2008
TMS320C6000 Network Developer’s Kit (NDK) SupportPackage for EVMDM642
This section introduces the NDK Support Package for EVMDM642.
The TMS320C6000 NDK Support Package for EVMDM642 includes:•Source codes and pre-built libraries for the NDK Hardware Adaptation Layer (HAL) drivers•NDK examples
There are four basic HAL drivers required to operate the NDK: timer, user LED, serial port, and Ethernet.The Support Package provides Ethernet, serial, and user LED drivers specific to EVMDM642 platform.The timer driver is implemented by using DSP/BIOS™ PRD module from the NDK.
1. Install the Code Composer Studio using the Code Composer Studio CD, if not installed yet. It must beinstalled before the NDK Support Package software. Be sure that you install a version of CodeComposer Studio 3.3 or higher.2. Install the NDK software, if not installed yet.3. Copy the ti.ndk.platforms.evmdm642.tar under < NDK_INSTALL_DIR>\packages directory, and untar it.The support package installs over the NDK installation. Once installed, the following directories arecreated under the < NDK_INSTALL_DIR>/packages/ti/ndk directory:•< docs/evmdm642> Documentation files for Support Package•< example/network/cfgdemo/evmdm642> Code Composer Studio project files for cfgdemo example•< example/network/client/evmdm642> Code Composer Studio project files for client example•< example/network/helloWorld/evmdm642> Code Composer Studio project files for helloWorldexample
•< example/serial/client/evmdm642> Code Composer Studio project files for serial client example•< example/serial/router/evmdm642> Code Composer Studio project files for serial router example•< example/tools/evmdm642> Common tools used by Support Package•< lib/hal/evmdm642> Pre-built HAL libraries for EVMDM642•< src/hal/evmdm642/eth_dm642> Source code for DM642 EMAC driver•< src/hal/evmdm642/ser_ti752> Source code of TI 16C752 Dual serial universal asynchronousreceiver/transmitter (UART) driver•< src/hal/evmdm642/userled_dm642> Source code for EVMDM642 LED driver4. The network management interface unit (NIMU) is introduced in NDK 1.94.00.001 as an alternative toLL packet architecture to add support for multiple instances of drivers. Several builds of the Ethernetdriver libraries are provided with NIMU and LL architectures for Big and Little Endian architecturesunder < lib/hal/evmdm642>. The libraries are named as < lib_name>.lib for little endian and< lib_name>e.lib for big endian. The libraries built using NIMU are named as < lib_name>_nimu.lib andthe ones built using LL architecture are named as < lib_name>_ll.lib.Please choose the most appropriate version of the library based on the endianness and whetherNIMU/LL is required and rename the library to just < lib_name>.lib for using it with any exampleprojects.
For example, If an application requires NIMU little endian HAL ethernet driver, rename< lib/hal/evmdm642/hal_eth_dm642_nimu.lib> to < lib/hal/evmdm642/hal_eth_dm642.lib>.
SPRUES5A – January 2007 – Revised June 2008 TMS320C6000 Network Developer’s Kit (NDK) Support Package for EVMDM642 7Submit Documentation Feedback

Getting Started www.ti.com
5. Also, choose the appropriate version of the user LED and serial drivers (if required) and rename it,based on endianness. The little endian version of the library is named as < lib_name>.lib and the bigendian counterpart is named as < lib_name>e.lib.For example, if the target board is big-endian platform then:copy < lib/hal/evmdm642/hal_userled_dm642e.lib> to< lib/hal/evmdm642/hal_userled_dm642.lib>
And if a serial port is required: copy < lib/hal/evmdm642/hal_ser_ti752e.lib> to< lib/hal/evmdm642/hal_ser_ti752.lib>.
6. Copy the correct NDK libraries for testing based on endianness and NIMU/LL architectures.For example, to compile your application with NIMU for a little endian target, change directory to< NDK_INSTALL_DIR>/packages/ti/ndk/lib/C64plus> and execute the following commands at thecommand prompt:copy netctrl_nimu.lib netctrl.libcopy nettool_nimu.lib nettool.libcopy all_stk\stk_nimu.lib stack.libFor more details on choosing and building in appropriate NDK libraries, see the NDK Libraries andBuilding in NIMU sections in TMS320C6000 Network Developer's Kit (NDK) User's Reference Guide(SPRU523 ).7. Configure the environment variables; for DM642, the following variables should be configured:NDK_INSTALL_DIR = < ndk_1_94 installation directory>8. Make sure the PC is connected through USB/JTAG to the DM642 correctly; in Figure 1 , the BlackHawkUSB560M debugger is used. Install any JTAG drivers required and be sure that PIN1 of the JTAG onDM642 board matches PIN1 of the JTAG connector. Click on the Code Composer Studio Icon,typically placed on the Desktop of the PC, to open Code Composer Studio as shown below.
TMS320C6000 Network Developer’s Kit (NDK) Support Package for EVMDM6428 SPRUES5A – January 2007 – Revised June 2008Submit Documentation Feedback

www.ti.com Getting Started
9. The following screen pops up.
Figure 1. BlackHawk560M Configuration to Connect to DM642
10. Make sure that the Blackhawk USB560M – DM640,1,2,3 emulator is selected. Remove any otherexisting platforms, if any, already configured. Click on Save & Quit to start Code Composer Studio.
SPRUES5A – January 2007 – Revised June 2008 TMS320C6000 Network Developer’s Kit (NDK) Support Package for EVMDM642 9Submit Documentation Feedback

Getting Started www.ti.com
11. Ensure the DM642 GEL file is loaded, once in Code Composer Studio. Click on File →Load Gel.Select the GEL file from the location where the DM642 BSL package was installed (see Figure 2 ).(This step is done while installing the DM642 support; there is typically a CD provided along with eachplatform).
Figure 2. DM642 Gel Load
12. Select the EVMDM642.gel and click Open. The GEL file is downloaded and the board is ready to use.Steps 11 and 12 need to be done every time the DM642 board is powered off and turned back on.
TMS320C6000 Network Developer’s Kit (NDK) Support Package for EVMDM64210 SPRUES5A – January 2007 – Revised June 2008Submit Documentation Feedback