TMS320C55x DSP/BIOS 5.x Application Programming Interface (API) Reference Guide Literature Number: SPRU404Q August 2012 Preface SPRU404Q—August 2012 Read This First About This Manual DSP/BIOS gives developers of mainstream applications on Texas Instruments TMS320C5000TM 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. 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 (800) 477-8924. 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. SPRU404Q—August 2012 Read This First 2 Submit Documentation Feedback Related Documentation www.ti.com TMS320C55x Optimizing C Compiler User’s Guide (literature number SPRU281) describes the C55x C compiler. This C compiler accepts ANSI standard C source code and produces TMS320 assembly language source code for the C55x generation of devices. TMS320C55x Programmer's Guide (literature number SPRU376) describes ways to optimize C and assembly code for the TMS320C55x DSPs and includes application program examples. TMS320C55x Code Composer Studio Tutorial Online Help (literature number SPRH097) introduces the Code Composer Studio integrated development environment and software tools. Of special interest to DSP/BIOS users are the Using DSP/BIOS lessons. 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. 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 3 Read This First SPRU404Q—August 2012 Submit Documentation Feedback Contents 1 API Functional Overview . 8 1.1 DSP/BIOS Modules . 8 1.2 Naming Conventions . 9 1.3 Assembly Language Interface Overview . 9 1.4 DSP/BIOS Tconf Overview. 10 1.5 List of Operations . 11 2 Application Program Interface . 22 2.1 ATM Module . 23 2.2 BUF Module . 36 2.3 C55 Module . 46 2.4 CLK Module . 59 2.5 DEV Module . 77 2.6 GBL Module . 119 2.7 GIO Module . 128 2.8 HOOK Module . 144 2.9 HST Module . 149 2.10 HWI Module . 153 2.11 IDL Module . 173 2.12 LCK Module . 177 2.13 LOG Module . 183 2.14 MBX Module . 195 2.15 MEM Module. 201 2.16 MSGQ Module . 224 2.17 PIP Module . 259 2.18 POOL Module . 277 2.19 PRD Module . 281 2.20 PWRM Module . 288 2.21 QUE Module . 323 2.22 RTDX Module . 338 2.23 SEM Module . 354 2.24 SIO Module. 365 2.25 STS Module . 390 2.26 SWI Module . 399 2.27 SYS Module . 426 2.28 TRC Module . 442 2.29 TSK Module . 446 2.30 std.h and stdlib.h functions . 482 A Function Callability and Error Tables . 484 A.1 Function Callability Table . 484 A.2 DSP/BIOS Error Codes . 491 B C55x DSP/BIOS Register Usage . 493 B.1 Overview. 493 SPRU404Q—August 2012 Contents 4 Submit Documentation Feedback Contents www.ti.com B.2 Register Conventions . 493 B.3 Status Register Conventions . 495 C DSP/BIOS for OMAP 2320 . ..