Aim MIL-STD-1553 - 2 Library Administration and Initialization Functions; Table 2-I - General Library Administration Function Descriptions; Table 2-II - VME Specific Library Administration Function Descriptions

MIL-STD-1553 Reference Manual
13
Chapter 2 - Library Administration and Initialization Functions
2 LIBRARY ADMINISTRATION AND INITIALIZATION FUNCTIONS
Chapter 2 defines the Library Administration function calls of the API S/W Library. The
Library Administration functions provide general library initialization, and shutdown,
interrupt handler setup, and error message handling setup. Table 3-I defines the list
and definition of general Library Administration functions, Table 3-II the VME specific
administration functions. The function calls in this table are listed in a functional order,
however, the detailed descriptions of the Library Administration function calls in the
following sections are in alphabetical order.
Table 2-I – General Library Administration Function Descriptions
Function
Description
ApiClose
Closes AIM module interface - called last
ApiConnectToServer
Establishes a network connection to a specified PC server where AIM
Network Server (ANS) software is running.
ApiDelIntHandler
Removes the pointer interface to the interrupt handler function
ApiDisconnectFromServer
Disconnects the network connection
ApiExit
This function cleans up the library resources so it is safe to unload
ApiGetBoardInfo
Get information about the assigned hardware
ApiGetDeviceConfig
Get the device config
ApiGetErrorDescription
Get a error message for a given error code
ApiGetLibraryInfo
Reads extended information about the current library settings
ApiGetOpenErr
Gets error code after unsuccessful ApiOpen
ApiGetServerInfo
Retrieves information about AIM boards installed on the ANS PC
ApiGetTcomStatus
Gets target communication status of command execution
ApiGetTgEmul
Gets target command emulation state
ApiInit
Initializes the API S/W Library Application Interface - performed first
ApiInstIntHandler
Provides a pointer to the interrupt handler function
ApiOpen
Initializes the AIM module & provides the handle for future board
commands
ApiOpenEx
Initializes the AIM module & stream & provides the handle for future board
commands
ApiPrintfOnServer
Prints message on console output of ANS console
ApiSetDeviceConfig
Sets the device config
ApiSetDllDbgLevel
Sets the debug output level
ApiSetTgEmul
Enables/disables target command emulation mode
Table 2-II – VME Specific Library Administration Function Descriptions
Function
Description
AiVmeExamineSlot
Examines the board(s) on a specific VME slot/ A16 address and runs a
PCI config cycle
Ai1553CheckModule
Checks the type of module
AiPciScan
Scans the local PCI bus for known boards and returns the number of
boards handled by this driver