TMS320C6000 DSP/BIOS 5.x Application Programming Interface (API)

573 Pages·2012·2.36 MB·English

TMS320C6000 DSP/BIOS 5.x
Application Programming Interface (API)
Reference Guide
Literature Number: SPRU403S
August 2012
Preface
SPRU403S—August 2012
Read This First
About This Manual
DSP/BIOS gives developers of mainstream applications on Texas Instruments TMS320C6000TM DSP
devices the ability to develop embedded real-time software. DSP/BIOS provides a small firmware real-
time library and easy-to-use tools for real-time tracing and analysis.
You should read and become familiar with the TMS320 DSP/BIOS User’s Guide, a companion volume
to this API reference guide.
Before you read this manual, you may use the Code Composer Studio online tutorial and the DSP/BIOS
section of the online help to get an overview of DSP/BIOS. This manual discusses various aspects of
DSP/BIOS in depth and assumes that you have at least a basic understanding of DSP/BIOS.
Notational Conventions
This document uses the following conventions:
•
Program listings, program examples, and interactive displays are shown in a special typeface.
Examples use a bold version of the special typeface for emphasis; interactive displays use a
bold version of the special typeface to distinguish commands that you enter from items that the
system displays (such as prompts, command output, error messages, etc.).
Here is a sample program listing:
Void copy(HST_Obj *input, HST_Obj *output)
{
PIP_Obj *in, *out;
Uns *src, *dst;
Uns size;
}
•
Square brackets ( [ and ] ) identify an optional parameter. If you use an optional parameter, you
specify the information within the brackets. Unless the square brackets are in a bold typeface, do not
enter the brackets themselves.
•
Throughout this manual, 62 represents the two-digit numeric appropriate to your specific DSP
platform. For example, DSP/BIOS assembly language API header files for the C6000 platform are
described as having a suffix of .h62. For the C64x or C67x DSP platform, substitute either 64 or 67
for each occurrence of 62.
•
Information specific to a particular device is designated with one of the following icons:
SPRU403S—August 2012 Read This First 2
Submit Documentation Feedback
Related Documentation From Texas Instruments www.ti.com
Related Documentation From Texas Instruments
The following books describe TMS320 devices and related support tools. To obtain a copy of any of these
TI documents, call the Texas Instruments Literature Response Center at [phone]. When ordering,
please identify the book by its title and literature number.
TMS320 DSP/BIOS User's Guide (literature number SPRU423) provides an overview and description of the
DSP/BIOS real-time operating system.
TMS320C6000 Optimizing C Compiler User's Guide (literature number SPRU187) describes the c6000
C/C++ compiler and the assembly optimizer. This C/C++ compiler accepts ANSI standard C/C++ source
code and produces assembly language source code for the C6000 generation of devices.
TMS320C6000 Programmer's Guide (literature number SPRU189) describes the c6000 CPU architecture,
instruction set, pipeline, and interrupts for these digital signal processors.
TMS320c6000 Peripherals Reference Guide (literature number SPRU190)
describes common peripherals available on the TMS320C6000 family of
digital signal processors. This book includes information on the internal data and program memories, the
external memory interface (EMIF), the host port, multichannel buffered serial ports, direct memory access
(DMA), clocking and phase-locked loop (PLL), and the power-down modes.
TMS320C6000 Code Composer Studio Tutorial Online Help (literature number SPRH125) introduces the
Code Composer Studio integrated development environment and software tools. Of special interest to
DSP/BIOS users are the Using DSP/BIOS lessons.
TMS320C6000 Chip Support LIbrary API Reference Guide (literature number SPRU401) contains a refer-
ence for the Chip Support Library (CSL) application programming interfaces (APIs). The CSL is a set of
APIs used to configure and control all on-chip peripherals.
Related Documentation
You can use the following books to supplement this reference guide:
The C Programming Language (second edition), by Brian W. Kernighan and Dennis M. Ritchie,
published by Prentice-Hall, Englewood Cliffs, New Jersey, 1988
Programming in C, Kochan, Steve G., Hayden Book Company
Programming Embedded Systems in C and C++, by Michael Barr, Andy Oram (Editor), published by
O'Reilly & Associates; ISBN: 1565923545, February 1999
Real-Time Systems, by Jane W. S. Liu, published by Prentice Hall; ISBN: 013099651, June 2000
Principles of Concurrent and Distributed Programming (Prentice Hall International Series in
Computer Science), by M. Ben-Ari, published by Prentice Hall; ISBN: 013711821X, May 1990
American National Standard for Information Systems-Programming Language C X3.159-1989,
American National Standards Institute (ANSI standard for C); (out of print)
Trademarks
MS-DOS, Windows, and Windows NT are trademarks of Microsoft Corporation.
3 Read This First SPRU403S—August 2012
Submit Documentation Feedback
Trademarks www.ti.com
The Texas Instruments logo and Texas Instruments are registered trademarks of Texas Instruments.
Trademarks of Texas Instruments include: TI, XDS, Code Composer, Code Composer Studio, Probe
Point, Code Explorer, DSP/BIOS, RTDX, Online DSP Lab, BIOSuite, SPOX, TMS320, TMS320C28x,
TMS320C54x, TMS320C55x, TMS320C62x, TMS320C64x, TMS320C67x, TMS320C5000, and
TMS320C6000.
All other brand or product names are trademarks or registered trademarks of their respective companies
or organizations.
August 29, 2012
4 Read This First SPRU403S—August 2012
Submit Documentation Feedback
Contents
1 API Functional Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
This chapter provides an overview to the TMS320C6000 DSP/BIOS API functions. 9
1.1 DSP/BIOS Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.2 Naming Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.3 Assembly Language Interface Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.4 DSP/BIOS Tconf Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.5 List of Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2 Application Program Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
This chapter describes the DSP/BIOS API modules and functions. 26
2.1 ATM Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
2.2 BCACHE Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
2.3 BUF Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
2.4 C62 and C64 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
2.5 CLK Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
2.6 DEV Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
2.7 ECM Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
2.8 GBL Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
2.9 GIO Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
2.10 HOOK Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
2.11 HST Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
2.12 HWI Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
2.13 IDL Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
2.14 LCK Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
2.15 LOG Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
2.16 MBX Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
2.17 MEM Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
2.18 MPC Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
2.19 MSGQ Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
2.20 PIP Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
2.21 POOL Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
2.22 PRD Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
2.23 PWRM Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
2.24 QUE Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
2.25 RTDX Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384
2.26 SEM Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
2.27 SIO Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
2.28 STS Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
2.29 SWI Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
2.30 SYS Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
2.31 TRC Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
2.32 TSK Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
2.33 std.h and stdlib.h functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
SPRU403S—August 2012 Contents 5
Submit Documentation Feedback
Contents www.ti.com
A Function Callability and Error Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
This appendix provides tables describing TMS320C6000 errors and function callability. 530
A.1 Function Callability Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
A.2 DSP/BIOS Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
B C6000 DSP/BIOS Register Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
This appendix provides tables describing the TMS320C6000TM register conventions in terms of preservation
across multi-threaded context switching and preconditions. 540
B.1 Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
B.2 Register Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
C C64x+ Exception Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
This appendix provides describes support for C64x+ exception handling. 545
C.1 C64x+ Exception Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
C.2 Using the DSP/BIOS EXC Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546
C.3 Data Types and Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
C.4 EXC Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
C.5 _MPC Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
6 Contents SPRU403S—August 2012
Submit Documentation Feedback
www.ti.com Figures
Figures
2-1 Writers and Reader of a Message Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
2-2 Components of the MSGQ Architecture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
2-3 MSGQ Function Calling Sequence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
2-4 Pipe Schematic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
2-5 Allocators and Message Pools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
2-6 Buffer Layout as Defined by STATICPOOL_Params . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
2-7 PRD Tick Cycles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
2-8 Statistics Accumulation on the Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
SPRU403S—August 2012 Figures 7
Submit Documentation Feedback
Tables www.ti.com
Tables
1-2 DSP/BIOS Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2-1 Timer Counter Rates, Targets, and Resets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
2-2 High-Resolution Time Determination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
2-4 HWI interrupts for the TMS320C6000 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
2-5 Conversion Characters for LOG_printf. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
2-6 Typical Memory Segments for c6x EVM Boards. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
2-7 Typical Memory Segment for c6711 DSK Boards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
2-8 Statistics Units for HWI, PIP, PRD, and SWI Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
2-9 Conversion Characters Recognized by SYS_printf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
2-10 Conversion Characters Recognized by SYS_sprintf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
2-11 Conversion Characters Recognized by SYS_vprintf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
2-12 Conversion Characters Recognized by SYS_vsprintf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
2-13 Events and Statistics Traced by TRC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
A-1 Function Callability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
A-2 RTS Function Calls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
A-3 Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
B-1 Register and Status Bit Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
8 Tables SPRU403S—August 2012
Submit Documentation Feedback
Chapter 1
SPRU403S—August 2012
API Functional Overview
This chapter provides an overview to the TMS320C6000 DSP/BIOS API functions.
Topic Page

1.1 DSP/BIOS Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.2 Naming Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.3 Assembly Language Interface Overview . . . . . . . . . . . . . . . . . . . . . . 10
1.4 DSP/BIOS Tconf Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.5 List of Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1.1 DSP/BIOS Modules
Table 1–1. DSP/BIOS Modules
Module Description
ATM Module Atomic functions written in assembly language
BCACHE Module Cache operation manager (C64x+ only)
BUF Module Maintains buffer pools of fixed size buffers
C62 and C64 Modules Target-specific functions
CLK Module System clock manager
DEV Module Device driver interface
ECM Module Event combiner manager (C64x+ only)
EXC Module Exception manager (C64x+ only)
GBL Module Global setting manager
GIO Module I/O module used with IOM mini-drivers
HOOK Module Hook function manager
HST Module Host channel manager
HWI Module Hardware interrupt manager
IDL Module Idle function and processing loop manager
LCK Module Resource lock manager
LOG Module Event Log manager
SPRU403S—August 2012 API Functional Overview 9
Submit Documentation Feedback
Naming Conventions www.ti.com
Module Description
MBX Module Mailboxes manager
MEM Module Memory manager
MPC Module Memory protection manager (C64x+ only)
MSGQ Module Variable-length message manager
PIP Module Buffered pipe manager
POOL Module Allocator interface module
PRD Module Periodic function manager
PWRM Module Reduce application’s power consumption
QUE Module Queue manager
RTDX Module Real-time data exchange manager
SEM Module Semaphores manager
SIO Module Stream I/O manager
STS Module Statistics object manager
SWI Module Software interrupt manager
SYS Module System services manager
TRC Module Trace manager
TSK Module Multitasking manager
std.h and stdlib.h functions Standard C library I/O functions
1.2 Naming Conventions
The format for a DSP/BIOS operation name is a 3- or 4-letter prefix for the module that contains the
operation, an underscore, and the action.
1.3 Assembly Language Interface Overview
The assembly interface that was provided for some of the DSP/BIOS APIs has been deprecated. They
are no longer documented.
Assembly functions can call C functions. Remember that the C compiler adds an underscore prefix to
function names, so when calling a C function from assembly, add an underscore to the beginning of the
C function name. For example, call _myfunction instead of myfunction. See the TMS320C6000
Optimizing Compiler User’s Guide for more details.
When you are using the DSP/BIOS Configuration Tool, use a leading underscore before the name of any
C function you configure. (The DSP/BIOS Configuration Tool generates assembly code, but does not add
the underscore automatically.) If you are using Tconf, do not add an underscore before the function
name; Tconf internally adds the underscore needed to call a C function from assembly.
All DSP/BIOS APIs follow standard C calling conventions as documented in the C programmer’s guide
for the device you are using.
10 API Functional Overview SPRU403S—August 2012
Submit Documentation Feedback