xPCI-1710 API
|
Functions | |
_INT_ | i_PCI1710_GetModuleConfiguration (HANDLE h_DeviceHandle, BYTE b_ModuleNbr, PDWORD pdw_ModuleConfiguration) |
_INT_ | i_PCI1710_ConfigureAllModule (HANDLE h_DeviceHandle, PCHAR_ pc_FileName1, PCHAR_ pc_FileName2, PCHAR_ pc_FileName3, PCHAR_ pc_FileName4, PDWORD pdw_WriteAddressError) |
_INT_ | i_PCI1710_GetNumberOfBoards (PBYTE pb_NbrOfBoards) |
_INT_ | i_PCI1710_GetBoardInformation (BYTE b_BoardIndex, PCHAR pc_Identifier, DWORD dw_IdentifierStringSize, PDWORD pdw_UINumber, PDWORD pdw_DeviceNumber, PDWORD pdw_BusNumber, PDWORD pdw_BaseAddress0, PDWORD pdw_BaseAddress1, PBYTE pb_Interrupt) |
_INT_ | i_PCI1710_OpenBoardViaIndex (BYTE b_BoardIndex, PHANDLE ph_DeviceHandle) |
_INT_ | i_PCI1710_OpenBoardViaIdentifier (PCHAR pc_Identifier, PHANDLE ph_DeviceHandle) |
_INT_ | i_PCI1710_CloseBoard (HANDLE h_DeviceHandle) |
_INT_ | i_PCI1710_GetBoardHardwareType (HANDLE b_DeviceHandle, PBYTE_ pb_HardwareType) |
_INT_ i_PCI1710_GetModuleConfiguration | ( | HANDLE | h_DeviceHandle, |
BYTE | b_ModuleNbr, | ||
PDWORD | pdw_ModuleConfiguration | ||
) |
Get the configuration of the module
[in] | h_DeviceHandle | Handle of the board |
[in] | b_ModuleNbr | Module selection |
[out] | pdw_ModuleConfiguration | Contains the 4 ASCII codes of the configuration
|
0 | : No error |
-1 | : The device handle parameter is wrong |
-2 | : Wrong module selection |
-100 | : IOCTL failed |
_INT_ i_PCI1710_ConfigureAllModule | ( | HANDLE | h_DeviceHandle, |
PCHAR_ | pc_FileName1, | ||
PCHAR_ | pc_FileName2, | ||
PCHAR_ | pc_FileName3, | ||
PCHAR_ | pc_FileName4, | ||
PDWORD | pdw_WriteAddressError | ||
) |
Configure the four module of the PCI-1710 board.
The available files are :
[in] | h_DeviceHandle | Handle of the board |
[in] | pc_FileName1 | Name of the configuration file for function module 1 |
[in] | pc_FileName2 | Name of the configuration file for function module 2 |
[in] | pc_FileName3 | Name of the configuration file for function module 3 |
[in] | pc_FileName4 | Name of the configuration file for function module 4 |
[out] | pdw_WriteAddressError | If an error occurs, return the address of the read/write register |
_INT_ i_PCI1710_GetNumberOfBoards | ( | PBYTE | pb_NbrOfBoards | ) |
Return the number of xPCI-1710 board found (pb_NbrOfBoard)
[out] | pb_NbrOfBoards | Return the number of board found |
_INT_ i_PCI1710_GetBoardInformation | ( | BYTE | b_BoardIndex, |
PCHAR | pc_Identifier, | ||
DWORD | dw_IdentifierStringSize, | ||
PDWORD | pdw_UINumber, | ||
PDWORD | pdw_DeviceNumber, | ||
PDWORD | pdw_BusNumber, | ||
PDWORD | pdw_BaseAddress0, | ||
PDWORD | pdw_BaseAddress1, | ||
PBYTE | pb_Interrupt | ||
) |
Get device information of the board.
[in] | b_BoardIndex | Index of the board |
[in] | dw_IdentifierStringSize | size of the identifier parameter |
[out] | pc_Identifier | Identifier of the board |
[out] | pdw_UINumber | This number is typically a user-perceived slot number, such as a number printed next to the slot on the board, or some other number that makes locating the physical device easier for the user. If the device is on a bus that has no UI number convention, or if the bus driver for the device cannot determine the UI number, this value is 0xFFFFFFFF. |
[out] | pdw_DeviceNumber | Device number. |
[out] | pdw_BusNumber | Bus number. |
[out] | pdw_BaseAddress0 | Base address 0 of the board |
[out] | pdw_BaseAddress1 | Base address 1 of the board |
[out] | pb_Interrupt | Interrupt number of the board |
_INT_ i_PCI1710_OpenBoardViaIndex | ( | BYTE | b_BoardIndex, |
PHANDLE | ph_DeviceHandle | ||
) |
Open the board with the index : b_BoardIndex. A handle is returned to the
user which allows to use the driver functions.
[in] | b_BoardIndex | Index of the board to open |
[out] | ph_DeviceHandle | Handle of the selected xPCI-1710 board for using the functions |
_INT_ i_PCI1710_OpenBoardViaIdentifier | ( | PCHAR | pc_Identifier, |
PHANDLE | ph_DeviceHandle | ||
) |
Open the board with the indentifier : pc_Identifier. A handle is returned to the
user which allows to use the following functions.
Handles allow to operate several boards.
[in] | pc_Identifier | Identifier of the board to open |
[out] | ph_DeviceHandle | Handle of the board xPCI-1710 for using the functions |
_INT_ i_PCI1710_CloseBoard | ( | HANDLE | h_DeviceHandle | ) |
Releases the handle of the board. Blocks the access to the board.
[in] | h_DeviceHandle | Handle of the board |
_INT_ i_PCI1710_GetBoardHardwareType | ( | HANDLE | b_DeviceHandle, |
PBYTE_ | pb_HardwareType | ||
) |
Return the type of the hardware of the PCI-1710
[in] | b_DeviceHandle | Handle of the board |
[out] | pb_HardwareType | Type of the hardware (0 -> 10K10, 1 -> 10K20) The hardware type is necessessary to be known, for the user to configure the modules. There is two subdirectories containing the config files. The path given to the function must be the good one, or the card could be destroyed. |