xPCI-1500 API
APCI-1500 DLL ADDI-DATA W32-Bit Driver for x86 General functions

Functions

_INT_ i_APCI1500_InitCompiler (BYTE_ b_CompilerDefine)
 
_INT_ i_APCI1500_CheckAndGetPCISlotNumber (PBYTE_ pb_SlotNumberArray)
 
_INT_ i_APCI1500_GetHardwareInformation (BYTE_ b_BoardHandle, PUINT_ pui_BaseAddress, PBYTE_ pb_InterruptNbr, PBYTE_ pb_SlotNumber)
 
_INT_ i_APCI1500_GetSerialNumber (BYTE_ b_BoardHandle, DWORD *serialNumber)
 
_INT_ i_APCI1500_GetFirmwareVersion (BYTE_ b_BoardHandle, DWORD *firmwareVersion)
 
_INT_ i_APCI1500_SetSerialNumber (BYTE_ b_BoardHandle, DWORD serialNumber)
 
_INT_ i_APCI1500_SetBoardInformation (BYTE_ b_SlotNumberArray, PBYTE_ pb_BoardHandle)
 
_INT_ i_APCI1500_SetBoardInformationViaIdentifer (PCHAR_ pc_Identifier, PBYTE_ ph_DeviceHandle)
 
_INT_ i_APCI1500_CloseBoardHandle (BYTE_ b_BoardHandle)
 

Detailed Description

Function Documentation

_INT_ i_APCI1500_InitCompiler ( BYTE_  b_CompilerDefine)

This function is only available in a windows environment

Parameters
[in]b_CompilerDefine: Program Language selection.
Return values
0: no error
_INT_ i_APCI1500_CheckAndGetPCISlotNumber ( PBYTE_  pb_SlotNumberArray)

Check all APCI-1500 and return the slot number of each APCI-1500 board.
| Each pb_SlotNumberArray member contain the slot
number (1 to 8) from 1 APCI-1500 Board.

Parameters
[in]pb_SlotNumberArray: Slot number list.
Return values
>0: Number of boards found
0: No board found
-101: Error while getting the number of boards
-102: Unable to open the board via index
-103: Error when calling driver's IOCTL
_INT_ i_APCI1500_GetHardwareInformation ( BYTE_  b_BoardHandle,
PUINT_  pui_BaseAddress,
PBYTE_  pb_InterruptNbr,
PBYTE_  pb_SlotNumber 
)

Get device information of the board.

Parameters
[in]b_BoardHandle: Index of the board
[out]pb_SlotNumber: Slot number.
[out]pui_BaseAddress: Base address of the board
[out]pb_InterruptNbr: Interrupt line of the board
Return values
0: No error
-1: Wrong device handle
_INT_ i_APCI1500_GetSerialNumber ( BYTE_  b_BoardHandle,
DWORD *  serialNumber 
)

Get serialNumber of the board.

Parameters
[in]b_BoardHandle: Index of the board
[out]serialNumber: return the serial number of the card.
Return values
0: No error
-1: Wrong device handle
_INT_ i_APCI1500_GetFirmwareVersion ( BYTE_  b_BoardHandle,
DWORD *  firmwareVersion 
)

Get firmwareVersion of the board.

Parameters
[in]b_BoardHandle: Index of the board
o]v_FunctionName : Address of the callback function
[out]firmwareVersion: Firmware Version of the Board Contains the 4 ASCII codes of the configuration
bits 0 -> 7 ASCII code (version low)
bits 8 -> 15 ASCII code (version high)
bits 16 -> 23 ASCII code (functionality name second digit)
bits 24 -> 31 ASCII code (functionality name first digit)
to read them select one of the four bits and print it using a char printf("%c", )
Return values
0: No error
-1: Wrong device handle
_INT_ i_APCI1500_SetSerialNumber ( BYTE_  b_BoardHandle,
DWORD  serialNumber 
)

Set serialNumber of the board.

Parameters
[in]b_BoardHandle: Index of the board
[in]serialNumber: enter the new serial number of the card.
Return values
0: No error
-1: Wrong device handle
_INT_ i_APCI1500_SetBoardInformation ( BYTE_  b_SlotNumberArray,
PBYTE_  pb_BoardHandle 
)

Open board with slot number.

Parameters
[in]b_SlotNumberArray: Index of the board to open
[out]pb_BoardHandle: Handle of the selected APCI-1500 board for using the functions
Return values
0: No error
-1: Not available slot number
-101: Unable to get the number of available boards
-103: Error while getting the device's class
-104: Error while getting informations about the device
-105: Memory allocation error
-106: Get device interface detail error
-107: Error while creating communication handle
-108: Error in the initialization callback function
_INT_ i_APCI1500_SetBoardInformationViaIdentifer ( PCHAR_  pc_Identifier,
PBYTE_  ph_DeviceHandle 
)

Open the board with the indentifier : pc_Identifier. A handle is returned to the
user which allows to use the following functions.

Parameters
[in]pc_Identifier: Identifier of the board to open
[out]ph_DeviceHandle: Handle of the board APCI-1500 for using the functions
Return values
0: No Error
-1: Not available identifier
-101: Unable to get the number of available boards
-102: Unable to get the board identifier
-103: Unable to open the board
-104: Identifier not found
_INT_ i_APCI1500_CloseBoardHandle ( BYTE_  b_BoardHandle)

Release the handle of the board. Block the access to the board.

Parameters
[in]b_BoardHandle: Handle of the board
Return values
0: No Error
-1: The device handle parameter is wrong