Texas-instruments TMS320C6000 User Manual

TMS320C6000 DSKBoard Support LibraryAPI User’s GuideLiterature Number: SPRU432AOctober 2001Printed on Recycled Paper

BSL Introduction 1-21.1 BSL Introduction The BSL provides a C-language interface for configuring and controlling all on-board devices. The library con

BSL API Modules1-3BSL Overview1.2 BSL API Modules For each on-board device, one header file and one source file will be gener-ated with the following

BSL API Modules 1-46711 DSK Module Support Table 1–3 shows which board each API module is supported on. Currently, allmodules described in the followi

BSL Project Settings1-5BSL Overview1.3 BSL Project Settings 1.3.1 User’s Program SettingDue to the interdependancies between CSL and BSL, the CSL is

2-1AD535 API ModuleThis chapter provides a description of the AD535 API module, lists the individ-ual APIs within the module, and includes a reference

AD535 API Module Description 2-22.1 AD535 API Module DescriptionThe AD535 module (audio codec supported by the C6711 DSK) serves as alevel of abstract

AD535 API Module Description2-3AD535 API ModulePageDescriptionTypeSyntaxAD535_write F Writes data to be sent 2-16AD535_writeHwi F Writes data to be se

AD535_Config2-5 AD535 API Module2.2 AD535 API Reference Closes codec channelAD535_closeFunction Void AD535_close( AD535_Handle hAD535);Arguments hAD

AD535_config2-6 Description This is the AD535 configuration structure used to set up a codec channel.You create and initialize this structure and then

AD553_freeMcbsp2-7 AD535 API ModuleDescription Sets 1 to the FREE field of the SPCR register of the given McBSP port.When FREE is set to 1, the serial

IMPORTANT NOTICETexas Instruments Incorporated and its subsidiaries (TI) reserve the right to make corrections,modifications, enhancements, improvemen

AD535_getMcbspHandle2-8 Returns McBSP HandleAD535_getMcbspHandleFunction Mcbsp_Handle AD535_getMcbspHandle( AD535_Handle hAD535,);Arguments hAD535 Ha

AD535_Id2-9 AD535 API ModuleDescription This AD535_Id structure is used to allocate a codec channel. You createand initialize this structure, then pas

AD535_inGain2-10 Sets AD535’s input gainAD535_inGainFunction void AD535_inGain( AD535_Handle hAD535, float inGain);Arguments hAD535 Handle to

AD535_modifyReg2-11 AD535 API ModuleModifies specified control registerAD535_modifyRegFunction void AD535_modifyReg( AD535_Handle hAD535, AD535_Reg

AD535_open2-12 Opens codec channelAD535_openFunction AD535_Handle AD535_open ( AD535_Id *myId);Arguments myId Pointer to an object of type AD535_Id.

AD535_powerDown2-13 AD535 API ModuleSets AD535’s output gainAD535_outGainFunction void AD535_outGain( AD535_Handle hAD535, float outGain);A

AD535_read2-14 Returns value of ouput from ADCAD535_readFunction int AD535_read( AD535_Handle hAD535);Arguments hAD535 Handle to codec channel, see A

AD535_readReg2-15 AD535 API Modulead535Register Control register enumeration:- AD535_REG_CTRL0- AD535_REG_CTRL1- AD535_REG_CTRL2- AD535_REG_CTRL3- AD5

AD535_reset2-16 Asserts software resetAD535_resetFunction void AD535_reset( AD535_Handle hAD535 );Arguments hAD535 Handle to codec channel, see AD535

AD535_writeReg2-17 AD535 API ModuleWrites value to input of DACAD535_writeHwiFunction void AD535_writeHwi( AD535_Handle hAD535, int val );Argument

iiiRead This FirstPrefaceRead This FirstAbout This Manual The TMS320C6000t DSK Board Support Library (BSL) is a set of applicationprogramming interfa

AD535_writeReg2-18 Description Writes value to the specified control register.6711 DSKNote: Only the Voice channel is available on this board. This me

3-1BOARD API ModuleThis chapter provides a description of the BOARD API module, lists the individ-ual APIs within the module, and includes a reference

BOARD API Module Description 3-23.1 BOARD API Module DescriptionThe BOARD module is where we put board-specific content. This module hasthe potential

BOARD_SUPPORT3-3 BOARD API Module3.2 BOARD API Reference Returns value of specified memory-mapped registerBOARD_readRegFunction Uint32 BOARD_readReg(

BOARD_writeReg3-4 Writes value to specified memory-mapped registerBOARD_writeRegFunction void BOARD_writeReg( BOARD_Reg boardRegister, Uint32

4-1BSL API ModuleThis chapter provides a description of the BSL API module and includes a ref-erence section showing the single API function within th

BSL API Module Description 4-24.1 BSL API Module DescriptionThe BSL module serves to initialize the API modules supported by theboard.The following un

BSL_init4-3 BSL API Module4.2 BSL API ReferenceInitializes all programmable modules on boardBSL_initFunction void BSL_init();Arguments noneReturn Valu

5-1DIP API ModuleThis chapter provides a description of the DIP API module, lists the individualAPIs within the module, and includes a reference secti

DIP API Module Description 5-25.1 DIP API Module DescriptionThis module has the following single API for reading DIP switch positions:DIP_get(dip#) re

How to Use This Manualiv Notational Conventions This document uses the following conventions:- Program listings, program examples, and interactive

DIP_SUPPORT5-3 DIP API Module5.2 DIP API Reference Returns current value of specified DIP switchDIP_getFunction Uint32 DIP_get( Uint32 dipNum);Argum

6-1FLASH API ModuleThis chapter provides a description of the FLASH API module, lists the individ-ual APIs within the module, and includes a reference

FLASH API Module Description 6-26.1 FLASH API Module Description The FLASH module allows access to on-board flash and executes datamemory manipulatio

FLASH_checksum6-3 FLASH API Module6.2 FLASH API Reference Returns checksum of specified Flash dataFLASH_checksumFunction Uint32 FLASH_checksum( Ui

FLASH_erase6-4 Erases specified segment of Flash memoryFLASH_eraseFunction void FLASH_erase( Uint32 locator, Uint32 length);Arguments locator Addre

FLASH_read6-5 FLASH API ModuleReads data from FLASH addressFLASH_readFunction void FLASH_read( Uint32 locator, Uint32 dst, Uint32 length);Argumen

FLASH_SUPPORT6-6 Compile time constantFLASH_SUPPORTConstant FLASH_SUPPORTDescription Compile time constant that has a value of 1 if the board supports

FLASH_write6-7 FLASH API ModuleDescription Writes data to the Flash address (locator) from a source address (src).This function is limited by the page

7-1LED API ModuleThis chapter provides a description of the LED API module, lists the individualAPIs within the module, and includes a reference secti

LED API Module Description 7-27.1 LED API Module DescriptionThis module has a simple API for configuring on-board LED outputs. Threestates can be set

How to Use This ManualvRead This FirstTMS320C6000 Programmer’s Guide (literature number SPRU198)describes ways to optimize C and assembly code for the

LED_on7-3 LED API Module7.2 LED API Reference Turns off specified LEDLED_offFunction void LED_off( Uint32 LedNum);Arguments LedNum Specifies which

LED_SUPPORT7-4 Description Turns on the specified LED.C6711 DSK- LED_1 = USER_LED1- LED_2 = USER_LED2- LED_3 = USER_LED3 - LED_ALL = all user LEDsExam

A-1Appendix AGlossaryAAD535: The audio codec API module. Currently supported by the6711 DSK. address: The location of program code or data stored; an

Glossary A-2block: The three least significant bits of the program address. These corre-spond to the address within a fetch packet of the first instru

GlossaryA-3Glossaryclock cycle: A periodic or sequence of events based on the input from theexternal clock. clock modes: Options used by the clock gen

Glossary A-4device ID: Configuration register that identifies each peripheral componentinterconnect (PCI). digital signal processor (DSP): A semicondu

GlossaryA-5Glossaryexternal interrupt: A hardware interrupt triggered by a specific value on apin. external memory interface (EMIF): Microprocessor ha

Glossary A-6indirect addressing: An addressing mode in which an address points toanother pointer rather than to the actual data; this mode is prohibit

GlossaryA-7Glossarylittle endian: An addressing protocol in which bytes are numbered from rightto left within a word. More significant bytes in a word

Glossary A-8Pperipheral: A device connected to and usually controlled by a host device.program cache: A fast memory cache for storing program instruct

ContentsviiContents1 BSL Overview 1-1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GlossaryA-9Glossarysynchronous dynamic random-access memory (SDRAM): RAM whosecontents is refreshed periodically so the data is not lost. Transfer of

IndexIndex-1IndexAAD535 API module, 2-1API constant, 2-5AD535_SUPPORT, 2-16API functionsAD535_close, 2-5AD535_config, 2-6AD535_getMcbspHandle, 2-8AD53

IndexIndex-2 LLED API module, 7-1API constant, 7-3LED_SUPPORT, 7-4API functionsLED_off, 7-3LED_on, 7-3LED_toggle, 7-4API summary table, 7-2description

Contentsviii 5 DIP API Module 5-1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

TablesixContentsTables1–1. BSL Modules and Include Files 1-3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1-1BSL OverviewThis chapter provides an overview of the board support library (BSL), de-scribes its beneficial features, and lists each of its API mod