Analog Devices VisualDSP++ 5.0 User manual

a
W5.0
Device Drivers and System Services
Manual for Blackfin®Processors
Revision 3.2, August 2008
Part Number
82-000430-01
Analog Devices, Inc.
One Technology Way
Norwood, Mass. 02062-9106

Copyright Information
©2008 Analog Devices, Inc., ALL RIGHTS RESERVED. This document
may not be reproduced in any form without prior, express written consent
from Analog Devices, Inc.
Printed in the USA.
Disclaimer
Analog Devices, Inc. reserves the right to change this product without
prior notice. Information furnished by Analog Devices is believed to be
accurate and reliable. However, no responsibility is assumed by Analog
Devices for its use; nor for any infringement of patents or other rights of
third parties which may result from its use. No license is granted by impli-
cation or otherwise under the patent rights of Analog Devices, Inc.
Trademark and Service Mark Notice
The Analog Devices logo and icon bar, Blackfin, the Blackfin logo,
EZ-KIT Lite, SHARC, TigerSHARC, and VisualDSP++ are registered
trademarks of Analog Devices, Inc.
All other brand and product names are trademarks or service marks of
their respective owners.

VisualDSP++ 5.0 Device Drivers and System iii
Services Manual for Blackfin Processors
CONTENTS
PREFACE
Purpose of This Manual ............................................................... xxxi
Intended Audience ....................................................................... xxxi
Manual Contents Description ..................................................... xxxii
Technical or Customer Support .................................................. xxxiii
Supported Processors .................................................................. xxxiv
Product Information .................................................................. xxxiv
MyAnalog.com ..................................................................... xxxiv
Processor Product Information ............................................... xxxv
Related Documents .............................................................. xxxvi
Online Technical Documentation ........................................ xxxvii
Accessing Documentation From the Web ......................... xxxvii
Viewing Help Files .......................................................... xxxvii
Notation Conventions .............................................................. xxxviii
INTRODUCTION
System Services Overview .............................................................. 1-2
General ................................................................................... 1-3
Application Interface ............................................................... 1-7

Contents
iv VisualDSP++ 5.0 Device Drivers and System
Services Manual for Blackfin Processors
Dependencies .......................................................................... 1-8
Initialization ......................................................................... 1-10
Termination .......................................................................... 1-10
System Services Directory and File Structure .......................... 1-11
Accessing the System Services API ..................................... 1-11
Linking in the System Services Library .............................. 1-13
Rebuilding the System Services Library ............................. 1-15
Examples .......................................................................... 1-16
Dual-Core Considerations ................................................ 1-16
RTOS Considerations ................................................................. 1-17
Interoperability of System Services With VDK ....................... 1-17
Deployment of Services Within a Multi-Threaded
Application ........................................................................ 1-18
Device Driver Overview .............................................................. 1-19
Application Interface ............................................................. 1-20
Device Driver Architecture .................................................... 1-21
Interaction With System Services ...................................... 1-23
Initialization ......................................................................... 1-23
Termination .......................................................................... 1-24
Device Driver Directory and File Structure ............................ 1-24
Accessing the Device Driver API ....................................... 1-25
Device Driver File Locations ............................................. 1-27
Linking in the Device Driver Library ................................ 1-28
Rebuilding the Device Driver Library ................................ 1-29
Examples on Distribution ................................................. 1-30

VisualDSP++ 5.0 Device Drivers and System v
Services Manual for Blackfin Processors
Contents
INTERRUPT MANAGER
Introduction ................................................................................. 2-2
Interrupt Manager Initialization .................................................... 2-4
Interrupt Manager Termination ..................................................... 2-5
Core Event Controller Functions ................................................... 2-6
adi_int_CECHook() Function ................................................. 2-6
adi_int_CECUnhook() Function ............................................. 2-8
Interrupt Handlers .................................................................. 2-8
System Interrupt Controller Functions .......................................... 2-9
adi_int_SICDisable ............................................................... 2-10
adi_int_SICEnable ................................................................ 2-10
adi_int_SICGetIVG .............................................................. 2-10
adi_int_SICInterruptAsserted ................................................ 2-10
adi_int_SICSetIVG ............................................................... 2-11
adi_int_SICWakeup .............................................................. 2-11
Protecting Critical Code Regions ................................................. 2-12
Modifying IMASK ...................................................................... 2-14
Examples .................................................................................... 2-15
File Structure .............................................................................. 2-16
Interrupt Manager API Reference ................................................ 2-17
Notation Conventions ........................................................... 2-17
adi_int_Init ........................................................................... 2-18
adi_int_Terminate ................................................................. 2-19
adi_int_CECHook ................................................................ 2-20

Contents
vi VisualDSP++ 5.0 Device Drivers and System
Services Manual for Blackfin Processors
adi_int_CECUnhook ............................................................ 2-22
adi_int_ClearIMaskBits ........................................................ 2-24
adi_int_EnterCriticalRegion .................................................. 2-26
adi_int_ExitCriticalRegion .................................................... 2-28
adi_int_SICDisable ............................................................... 2-29
adi_int_SICEnable ................................................................ 2-30
adi_int_SICGetIVG .............................................................. 2-31
adi_int_SICInterruptAsserted ................................................ 2-32
adi_int_SICSetIVG .............................................................. 2-33
adi_int_SetIMaskBits ............................................................ 2-34
adi_int_SICWakeup .............................................................. 2-36
POWER MANAGEMENT MODULE
Introduction ................................................................................. 3-2
PM Module Operation – Getting Started ...................................... 3-3
Dual-Core Considerations ............................................................ 3-5
Using Automatic Synchronization ........................................... 3-5
Synchronization Requirement .................................................. 3-6
Running Applications on One Core Only ................................ 3-7
Running Applications on Both Cores ....................................... 3-8
Synchronization Between Cores ............................................. 3-10
Built-In Lock Variable and Linking Considerations ................ 3-10
SDRAM Initialization Prior to Loading an Executable ................. 3-13

VisualDSP++ 5.0 Device Drivers and System vii
Services Manual for Blackfin Processors
Contents
Power Management API Reference .............................................. 3-15
Notation Conventions ........................................................... 3-15
adi_pwr_AdjustFreq .............................................................. 3-16
adi_pwr_Control ................................................................... 3-18
adi_pwr_GetConfigSize ......................................................... 3-20
adi_pwr_GetFreq .................................................................. 3-21
adi_pwr_GetPowerMode ....................................................... 3-22
adi_pwr_GetPowerSaving ...................................................... 3-23
adi_pwr_Init ......................................................................... 3-24
adi_pwr_LoadConfig ............................................................. 3-30
adi_pwr_Reset ....................................................................... 3-31
adi_pwr_SaveConfig .............................................................. 3-32
adi_pwr_SetFreq ................................................................... 3-33
adi_pwr_SetMaxFreqForVolt ................................................. 3-35
adi_pwr_SetPowerMode ........................................................ 3-36
adi_pwr_SetVoltageRegulator ................................................ 3-38
Public Data Types and Enumerations ........................................... 3-42
ADI_PWR_COMMAND ..................................................... 3-42
ADI_PWR_COMMAND_PAIR ........................................... 3-47
ADI_PWR_CSEL ................................................................. 3-47
ADI_PWR_DF ..................................................................... 3-48
ADI_PWR_INPUT_DELAY ................................................. 3-48
ADI_PWR_OUTPUT_DELAY ............................................. 3-48
ADI_PWR_MODE .............................................................. 3-49

Contents
viii VisualDSP++ 5.0 Device Drivers and System
Services Manual for Blackfin Processors
ADI_PWR_PACKAGE_KIND ............................................. 3-49
ADI_PWR_PCC133_COMPLIANCE .................................. 3-50
ADI_PWR_PROC_KIND .................................................... 3-50
ADI_PWR_RESULT ............................................................ 3-50
ADI_PWR_SSEL .................................................................. 3-52
ADI_PWR_VDDEXT .......................................................... 3-53
ADI_PWR_VLEV ................................................................ 3-53
ADI_PWR_VR_CANWE ..................................................... 3-54
ADI_PWR_VR_USBWE ...................................................... 3-54
ADI_PWR_VR_CKELOW ................................................... 3-54
ADI_PWR_VR_CLKBUFOE ............................................... 3-55
ADI_PWR_VR_FREQ ......................................................... 3-55
ADI_PWR_VR_GAIN ......................................................... 3-55
ADI_PWR_VR_PHYWE ..................................................... 3-56
ADI_PWR_VR_WAKE ........................................................ 3-56
PM Module Macros .................................................................... 3-56
EXTERNAL BUS INTERFACE UNIT MODULE
Introduction ................................................................................. 4-2
Using the EBIU Module ............................................................... 4-3
EBIU API Reference ................................................................... 4-10
Notation Conventions ........................................................... 4-10
adi_ebiu_AdjustSDRAM ....................................................... 4-11
adi_ebiu_Control .................................................................. 4-12
adi_ebiu_GetConfigSize ........................................................ 4-15

VisualDSP++ 5.0 Device Drivers and System ix
Services Manual for Blackfin Processors
Contents
adi_ebiu_Init ........................................................................ 4-16
adi_ebiu_LoadConfig ............................................................ 4-22
adi_ebiu_SaveConfig ............................................................. 4-23
Public Data Types and Enumerations ........................................... 4-24
ADI_EBIU_RESULT ............................................................ 4-24
ADI_EBIU_SDRAM_BANK_VALUE ................................... 4-27
ADI_EBIU_TIME ................................................................ 4-27
ADI_EBIU_TIMING_VALUE ............................................. 4-28
ADI_EBIU_ASYNCH_BANK_TIMING .............................. 4-29
ADI_EBIU_ASYNCH_BANK_VALUE ................................. 4-30
Setting Control Values in the EBIU Module ................................ 4-31
ADI_EBIU_COMMAND ..................................................... 4-31
ADI_EBIU_COMMAND_PAIR ........................................... 4-38
Command Value Enumerations ............................................. 4-38
ADI_EBIU_SDRAM_ENABLE ........................................ 4-38
ADI_EBIU_SDRAM_BANK_SIZE .................................. 4-39
ADI_EBIU_SDRAM_BANK_COL_WIDTH ................... 4-39
ADI_EBIU_SDRAM_MODULE_TYPE .......................... 4-39
ADI_EBIU_CMD_SET_SDRAM_SCTLE ....................... 4-40
ADI_EBIU_SDRAM_EMREN ......................................... 4-40
ADI_EBIU_SDRAM_PASR ............................................. 4-41
ADI_EBIU_SDRAM_TCSR ............................................. 4-41
ADI_EBIU_SDRAM_SRFS .............................................. 4-41
ADI_EBIU_SDRAM_EBUFE .......................................... 4-42

Contents
x VisualDSP++ 5.0 Device Drivers and System
Services Manual for Blackfin Processors
ADI_EBIU_SDRAM_PUPSD .......................................... 4-42
ADI_EBIU_SDRAM_PSM .............................................. 4-43
ADI_EBIU_SDRAM_FBBRW ......................................... 4-43
ADI_EBIU_SDRAM_CDDBG ........................................ 4-44
ADI_EBIU_BANK_NUMBER ........................................ 4-44
ADI_EBIU_ASYNCH_BANK_ENABLE ......................... 4-45
ADI_EBIU_ASYNCH_CLKOUT .................................... 4-45
ADI_EBIU_ASYNCH_BANK_DATA_PATH .................. 4-45
ADI_EBIU_ASYNCH_BANK_ARDY_ENABLE ............. 4-46
ADI_EBIU_ASYNCH_BANK_ARDY_POLARITY ......... 4-46
ADI_EBIU_ASYNCH_HOLD_TIME ............................. 4-46
ADI_EBIU_ASYNCH_SETUP_TIME ............................. 4-47
ADI_EBIU_ASYNCH_TRANSITION_TIME ................. 4-47
DEFERRED CALLBACK MANAGER
Introduction ................................................................................. 5-1
Using the Deferred Callback Manager ........................................... 5-3
Interoperability With an RTOS ..................................................... 5-8
adi_dcb_Forward .................................................................... 5-9
adi_dcb_RegisterISR ............................................................. 5-11
Handling Critical Regions Within Callbacks .......................... 5-11
DCB Manager API Reference ...................................................... 5-12
Notation Conventions ........................................................... 5-12
adi_dcb_Close ...................................................................... 5-13
adi_dcb_Control ................................................................... 5-14