Aim MIL-STD-1553 - Table of Contents

v
TABLE OF CONTENTS
Section Title Page
1 INTRODUCTION ......................................................................................................... 1
1.1 Welcome ................................................................................................................. 1
1.2 How This Manual is Organized ................................................................................ 1
1.3 Conventions Used ................................................................................................... 3
1.3.1 General Documentation Conventions .................................................................. 3
1.3.2 Naming Conventions ........................................................................................... 3
1.3.3 Function Call Documentation Conventions .......................................................... 5
1.3.3.1 Conventions for parameters ‘ul_ModuleHandle’ and ‘biu’ ......................................... 6
1.3.4 Function Calling Convention ................................................................................ 6
1.3.5 Buffer Header ID, Buffer ID and Transfer ID Ranges ........................................... 7
1.4 Special Board Functionality ..................................................................................... 8
1.5 Applicable Documents ............................................................................................. 9
1.5.1 Industry Documents ............................................................................................ 9
1.5.2 AIM Document Family ......................................................................................... 9
1.6 C Header Files ...................................................................................................... 11
2 LIBRARY ADMINISTRATION AND INITIALIZATION FUNCTIONS .......................... 13
2.1 General Library Administration Functions .............................................................. 15
2.1.1 ApiClose ............................................................................................................ 15
2.1.2 ApiConnectToServer ......................................................................................... 16
2.1.3 ApiDelIntHandler ............................................................................................... 17
2.1.4 ApiDisconnectFromServer................................................................................. 18
2.1.5 ApiExit ............................................................................................................... 19
2.1.6 ApiGetBoardInfo ................................................................................................ 20
2.1.7 ApiGetDeviceConfig .......................................................................................... 24
2.1.8 ApiGetDriverInfo ................................................................................................ 26
2.1.9 ApiGetErrorDescription ..................................................................................... 28
2.1.10 ApiGetLibraryInfo .............................................................................................. 29
2.1.11 ApiGetOpenErr .................................................................................................. 30
2.1.12 ApiGetServerInfo ............................................................................................... 31
2.1.13 ApiGetTcomStatus ............................................................................................ 33
2.1.14 ApiGetTgEmul ................................................................................................... 34
2.1.15 ApiInit ................................................................................................................ 35
2.1.16 ApiInstIntHandler ............................................................................................... 36
2.1.17 ApiOpen ............................................................................................................ 43
2.1.18 ApiOpenEx ........................................................................................................ 45
2.1.19 ApiPrintfOnServer ............................................................................................. 47
2.1.20 ApiSetDeviceConfig .......................................................................................... 48
2.1.21 ApiSetDllDbgLevel ............................................................................................ 50
2.1.22 ApiSetTgEmul ................................................................................................... 51
2.2 VME Intialization Functions ................................................................................... 52
2.2.1 AiVmeExamineSlot ........................................................................................... 52
2.2.2 Ai1553CheckModule ......................................................................................... 54
2.2.3 AiPciScan .......................................................................................................... 55
2.2.4 AiPciGetHeader ................................................................................................ 56
2.2.5 AiVmeInitGenericInterrupt ................................................................................. 57
2.2.6 AiVme1553MapModule ..................................................................................... 59
2.2.7 AiVme1553UnmapModule................................................................................. 61