GOFORCE Drivers API Reference Manual for SC15 DA-2045-001v02 February 6, 2006 CONFIDENTIAL INFORMATION GoForce Software Development Kit DA-02045-001v02 Published by NVIDIA Corporation 2701 San Tomas Expressway Santa Clara, CA 95050 Notice ALL NVIDIA DESIGN SPECIFICATIONS, REFERENCE BOARDS, FILES, DRAWINGS, DIAGNOSTICS, LISTS, AND OTHER DOCUMENTS (TOGETHER AND SEPARATELY, “MATERIALS”) ARE BEING PROVIDED “AS IS.” NVIDIA MAKES NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. Information furnished is believed to be accurate and reliable. However, NVIDIA Corporation assumes no responsibility for the consequences of use of such information or for any infringement of patents or other rights of third parties that may result from its use. No license is granted by implication or otherwise under any patent or patent rights of NVIDIA Corporation. Specifications mentioned in this publication are subject to change without notice. This publication supersedes and replaces all information previously supplied. NVIDIA Corporation products are not authorized for use as critical components in life support devices or systems without express written approval of NVIDIA Corporation. Trademarks NVIDIA, the NVIDIA logo, 3DFX, 3DFX INTERACTIVE, the 3dfx Logo, STB, STB Systems and Design, the STB Logo, the StarBox Logo, NVIDIA nForce, GeForce, NVIDIA Quadro, NVDVD, NVIDIA Personal Cinema, NVIDIA Soundstorm, Vanta, TNT2, TNT, RIVA, RIVA TNT, VOODOO, VOODOO GRAPHICS, WAVEBAY, Accuview Antialiasing, the Audio & Nth Superscript Design Logo, CineFX, the Communications & Nth Superscript Design Logo, Detonator, Digital Vibrance Control, DualNet, FlowFX, ForceWare, GIGADUDE, Glide, GOFORCE, the Graphics & Nth Superscript Design Logo, Intellisample, M-BUFFER, nfiniteFX, NV, NVChess, nView, NVKeystone, NVOptimizer, NVPinball, NVRotate, NVSensor, NVSync, the Platform & Nth Superscript Design Logo, PowerMizer, Quincunx Antialiasing, Sceneshare, See What Youʹve Been Missing, StreamThru, SuperStability, T-BUFFER, The Way Itʹs Meant to be Played Logo, TwinBank, TwinView and the Video & Nth Superscript Design Logo are registered trademarks or trademarks of NVIDIA Corporation in the United States and/or other countries. Other company and product names may be trademarks or registered trademarks of the respective owners with which they are associated. Copyright © 2005–2006 by NVIDIA Corporation. All rights reserved. CONFIDENTIAL NVIDIA Corporation Revision History This manual is targeted for the SC15 Media Processor. Current Changes This is the preliminary release of the GoForce Drivers API Reference Manual for SC15. Date Change 1/10/06 Initial Release, with updates to GFIx, GFRmIx,GFI2C, GFJxDec, GFMxDec, GFMXDecH264, and GFMxEncH264 APIs. 2/6/06 Added “Resource Manager Read DMA (GFRmRDMA)” on page 579. DA-02045-001v02 i NVIDIA CONFIDENTIAL ForceWare GoForce Software Development Kit ii DA-02045-001v02 NVIDIA CONFIDENTIAL Table of Contents 1. GoForce Software Development Kit (GFSDK) . 1 Introduction . 1 Multithreading and Multiprocess Support . 9 Scope of This Manual . 9 GFSDK Common Data Structures and Types. 10 GFSDK Data Types . 10 GFPROPERTY . 10 GFRECT . 11 GF_RETTYPE Status and Error Codes . 12 GF_INTERRUPT_STATUS_TYPE . 15 GFGPIOSTATUS . 16 2. Resource Manager Services (GFRm) . 17 Resource Manager Services . 17 Object Manager Services . 18 Object Manager Functions . 18 GFRmOpen() . 18 GFRmClose() . 19 GFRmGetProperty() . 19 GFRmSetAttribute() . 20 GFRmGetAttribute() . 20 Object Manager Attributes . 21 Object Manager States . 22 Context Manager Services . 23 GFRmContextGet() . 23 GFRmContextRelease() . 23 GFRmContextId() . 24 Component Manager Services . 25 Component Manager Functions . 25 GFRmComponentRegister() . 25 GFRmComponentGet() . 26 GFRmComponentGetEx() . 26 GFRmComponentRelease() . 27 GFRmComponentEnum(). 28 DA-02045-001v02 iii NVIDIA CONFIDENTIAL GoForce Drivers API Reference Manual for SC15 Component Manager Structures . 29 Surface Manager Services . 31 Surface Overview . 31 Surface Manager Functions . 31 GFRmSurfaceAlloc()/GFRmSurfaceAllocWithCS() . 32 GFRmSurfaceFree()/GFRmSurfaceFreeWithCS(). 32 GFRmSurfaceLock() . 33 GFRmSurfaceUnlock() . 33 GFRmSurfaceQueryPrimaryInfo() . 34 GFRmSurfaceUpdate()/GFRmSurfaceUpdateWithCS(). 34 Surface Manager Structures . 36 GFRMSURFACE. 36 GFRMSURFACEREQUEST . 39 Memory Manager Services . 40 Memory Manager Functions and Data Structure. 40 GFRmMemInfo(). 40 GFRmMemGetOffset(). 41 GFRmMemGetPointer() . 41 GFRmMemOffsetToHandle() . 42 GFRmMemOffsetToVirt() . 42 GFRmMemVirtToOffset . 43 GFRmMemHandleAlloc() . 43 GFRmMemHandleFree() . 44 GFRMMEMORYREQUEST . 44 Operating System Manager Services . 46 GFRmOSWaitMSec() . 47 GFRmOSGetTickCount() . 47 GFRmOSEnterCS() . 48 GFRmOSEnterCSExt() . 48 GFRmOSExitCS() . 49 GFRmOSExitCSExt() . 50 GFRmOSCS() . 50 Interface Manager Services . 52 Interface Manager Functions and Address Flags. 52 GFRmInterfaceGetAddress() . ..