Documentation PDF

MUXDLL  V6.58
General

Order of call
The application must respect the sequencing according to the function calling order. More...

Functions

_MUXSPEC tMuxStatus _MUXAPI MuxCheckAlignment (tMuxAlignment *hMuxAlignment, unsigned short wDisplayValues)
 Display the value of elements of the structure. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxClose (uint16_t wCard)
 Close an handle on the driver. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxCountCards (uint32_t *dwCardsCount)
 Get the number of cards managed by the DLLs. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxEthCountCards (uint32_t *dwCardsCount)
 Get the number of cards on Ethernet bus. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxEthGetCardInfo (unsigned short wCard, unsigned char *bInfo, unsigned short *wSize)
 Get information on Ethernet card. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxGetDescription (unsigned short wCard, char *szDescription)
 Get description of the card. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxGetEthernet (tETHState *hEthState)
 Get the status of the Ethernet function for 6C6L. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxGetHardwareID (unsigned short wCard, char *szHardwareID, uint32_t dwSize)
 Return the hardware info of the card. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxGetInformations (unsigned short wCard, tMuxInformations *tInfos)
 Get information of the card. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxGetInternalInfo (unsigned short wCard, tMuxInternalInfo *pstMuxInternalInfo)
 Retourne des informations spécifiques aux DLLs. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxGetLastErrorString (char **pString)
 Return a chain if there is an error. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxGetLastErrorStringEx (char *MaString)
 Return a chain if there is an error. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxGetTimings (unsigned short wCard, TTimings *ptTimings, TTimingValue *tBaseCounter)
 Get timings. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxGetVersion (unsigned short wCard, uint32_t *dwVersionDll, uint32_t *dwVersionDriver, uint32_t *dwVersionKernel, tMuxHWType *eMuxHWType)
 Get information on software of the card. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxInit (unsigned short wCard)
 Initialize parameters of VAN routines. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxOpen (unsigned short wCard, tMuxConfigMode *hMuxConfigMode)
 Open an handle on the driver. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxPciCountCards (uint32_t *dwCardsCount)
 Get the number of cards on PCI bus. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxPciGetCardInfo (uint16_t wCard, uint32_t *dwCardBus, uint32_t *dwCardSlot, uint32_t *dwCardInfo)
 Get information about the card on PCI bus. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxSetEthernet (tETHState hEthState)
 Enable (or disable) the Ethernet function for 6C6L. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxUsbCountCards (uint32_t *dwCardsCount)
 Get the number of cards on USB bus. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxUsbGetCardInfo (uint16_t wCard, uint32_t *dwHubNum, uint32_t *dwPortNum, uint32_t *dwSerialNum, uint32_t *dwDeviceAddress, uint32_t *dwProductID, uint32_t *dwUniqueId)
 Get information about the card on USB bus. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxWifiCountCards (uint32_t *dwCardsCount)
 Get the number of cards on Wifi bus. More...
 
_MUXSPEC tMuxStatus _MUXAPI MuxWifiGetCardInfo (unsigned short wCard, char *szSerial, unsigned char *szMacAddress, unsigned char *szIPAddress)
 Get the number of cards on Wifi bus. More...
 

Detailed Description

Order of call
The application must respect the sequencing according to the function calling order.

Function Documentation

◆ MuxCheckAlignment()

_MUXSPEC tMuxStatus _MUXAPI MuxCheckAlignment ( tMuxAlignment hMuxAlignment,
unsigned short  wDisplayValues 
)

Display the value of elements of the structure.

This function permit to someone to verify alignments options.

Parameters
hMuxAlignmentStructure of test of alignments that contains values to display
wDisplayValuesIndicate if a messagebox must display founded values
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
STATUS_ERR_PARAMParameters error
STATUS_ERR_ALIGNMENTAlignments error
See also
STATUS_OK, STATUS_ERR_PARAM, STATUS_ERR_ALIGNMENT

◆ MuxClose()

_MUXSPEC tMuxStatus _MUXAPI MuxClose ( uint16_t  wCard)

Close an handle on the driver.

Parameters
[in]wCardIndex of card number on PCI bus
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
STATUS_ERR_PARAMParameters error
STATUS_ERR_SEQUENCESequence error
STATUS_ERR_BOARDPCI board not supported
See also
STATUS_OK, STATUS_ERR_PARAM, STATUS_ERR_SEQUENCE, STATUS_ERR_BOARD

◆ MuxCountCards()

_MUXSPEC tMuxStatus _MUXAPI MuxCountCards ( uint32_t *  dwCardsCount)

Get the number of cards managed by the DLLs.

Parameters
[out]dwCardsCountNumber of cards
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
STATUS_ERR_OPENCan't open Windriver
See also
STATUS_OK, STATUS_ERR_OPEN

◆ MuxEthCountCards()

_MUXSPEC tMuxStatus _MUXAPI MuxEthCountCards ( uint32_t *  dwCardsCount)

Get the number of cards on Ethernet bus.

Parameters
[out]dwCardsCountNumber of cards
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
STATUS_ERR_OPENCan't open Windriver
See also
STATUS_OK, STATUS_ERR_OPEN

◆ MuxEthGetCardInfo()

_MUXSPEC tMuxStatus _MUXAPI MuxEthGetCardInfo ( unsigned short  wCard,
unsigned char *  bInfo,
unsigned short *  wSize 
)

Get information on Ethernet card.

Parameters
[in]wCardIndex of card number on USB bus
[in,out]wSizeSize of information buffer
[out]bInfoInformation buffer
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
STATUS_ERR_PARAMParameters error
STATUS_ERR_MEMORYMemory error
See also
STATUS_OK, STATUS_ERR_PARAM, STATUS_ERR_MEMORY

◆ MuxGetDescription()

_MUXSPEC tMuxStatus _MUXAPI MuxGetDescription ( unsigned short  wCard,
char *  szDescription 
)

Get description of the card.

Parameters
[in]wCardIndex of card number on PCI bus
[out]szDescriptionDescription chain
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
STATUS_ERR_PARAMParameters error
STATUS_ERR_SEQUENCESequences error
STATUS_ERR_BOARDPCI board not supported
See also
STATUS_OK, STATUS_ERR_PARAM, STATUS_ERR_SEQUENCE, STATUS_ERR_BOARD

◆ MuxGetEthernet()

_MUXSPEC tMuxStatus _MUXAPI MuxGetEthernet ( tETHState hEthState)

Get the status of the Ethernet function for 6C6L.

Parameters
[out]hEthStateStatus (Enable / Disable)
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
See also
STATUS_OK

◆ MuxGetHardwareID()

_MUXSPEC tMuxStatus _MUXAPI MuxGetHardwareID ( unsigned short  wCard,
char *  szHardwareID,
uint32_t  dwSize 
)

Return the hardware info of the card.

Parameters
[in]wCardIndex of card number on USB bus
[out]szHardwareIDArray that will receive the hardware id
[out]dwSizeSize of the array
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
STATUS_ERR_PARAMParameters error
STATUS_ERR_MEMORYMemory error
STATUS_ERR_BOARDPCI board not supported
See also
STATUS_OK, STATUS_ERR_PARAM, STATUS_ERR_MEMORY, STATUS_ERR_BOARD

◆ MuxGetInformations()

_MUXSPEC tMuxStatus _MUXAPI MuxGetInformations ( unsigned short  wCard,
tMuxInformations tInfos 
)

Get information of the card.

Parameters
[in]wCardIndex of card number on PCI bus
[out]tInfosInformation
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
STATUS_ERR_PARAMParameters error
STATUS_ERR_SEQUENCESequences error
STATUS_ERR_BOARDPCI board not supported
See also
STATUS_OK, STATUS_ERR_PARAM, STATUS_ERR_SEQUENCE, STATUS_ERR_BOARD

◆ MuxGetInternalInfo()

_MUXSPEC tMuxStatus _MUXAPI MuxGetInternalInfo ( unsigned short  wCard,
tMuxInternalInfo pstMuxInternalInfo 
)

Retourne des informations spécifiques aux DLLs.

Parameters
[in]wCardIndex of card number on USB bus
[out]pstMuxInternalInfoMux internal information
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
See also
STATUS_OK

◆ MuxGetLastErrorString()

_MUXSPEC tMuxStatus _MUXAPI MuxGetLastErrorString ( char **  pString)

Return a chain if there is an error.

Parameters
[in]pStringPointer on the chain
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
See also
STATUS_OK

◆ MuxGetLastErrorStringEx()

_MUXSPEC tMuxStatus _MUXAPI MuxGetLastErrorStringEx ( char *  MaString)

Return a chain if there is an error.

Parameters
[in]MaStringPointer on the chain
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
See also
STATUS_OK

◆ MuxGetTimings()

_MUXSPEC tMuxStatus _MUXAPI MuxGetTimings ( unsigned short  wCard,
TTimings ptTimings,
TTimingValue tBaseCounter 
)

Get timings.

Parameters
[in]wCardCard number
[out]ptTimingsTimings
[out]tBaseCounterBase counter
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
STATUS_ERR_PARAMParameters error
See also
STATUS_OK, STATUS_ERR_PARAM

◆ MuxGetVersion()

_MUXSPEC tMuxStatus _MUXAPI MuxGetVersion ( unsigned short  wCard,
uint32_t *  dwVersionDll,
uint32_t *  dwVersionDriver,
uint32_t *  dwVersionKernel,
tMuxHWType eMuxHWType 
)

Get information on software of the card.

Parameters
[out]wCardIndex of card number on PCI bus
[out]dwVersionDllDLL version
[out]dwVersionDriverULYS SOFT driver version
[out]dwVersionKernelKernel driver version
[out]eMuxHWTypeCard type
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
STATUS_ERR_PARAMParameters error
STATUS_ERR_SEQUENCESequences error
See also
STATUS_OK, STATUS_ERR_PARAM, STATUS_ERR_SEQUENCE

◆ MuxInit()

_MUXSPEC tMuxStatus _MUXAPI MuxInit ( unsigned short  wCard)

Initialize parameters of VAN routines.

Parameters
[in]wCardIndex of card number to be accessed
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
STATUS_ERR_PARAMParameters error
STATUS_ERR_SEQUENCESequences error
See also
STATUS_OK, STATUS_ERR_PARAM, STATUS_ERR_SEQUENCE

◆ MuxOpen()

_MUXSPEC tMuxStatus _MUXAPI MuxOpen ( unsigned short  wCard,
tMuxConfigMode hMuxConfigMode 
)

Open an handle on the driver.

Parameters
[in]wCardIndex of card number on PCI bus
[in]hMuxConfigModeInterface type Interface type
  • MODE_APPLI: Interruptions are treated by the thread
  • MODE_KERNEL: Interruptions are treated in kerplug mode Type d'interface
  • MODE_APPLI : Les interruptions sont traitées par le thread
  • MODE_KERNEL : Les interruptions sont traitées en mode kerplug
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
STATUS_ERR_PARAMParameters error
STATUS_ERR_OPENOpen error
See also
STATUS_OK, STATUS_ERR_PARAM, STATUS_ERR_OPEN

◆ MuxPciCountCards()

_MUXSPEC tMuxStatus _MUXAPI MuxPciCountCards ( uint32_t *  dwCardsCount)

Get the number of cards on PCI bus.

Parameters
[out]dwCardsCountNumber of cards
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
STATUS_ERR_OPENCan't open Windriver
See also
STATUS_OK, STATUS_ERR_OPEN

◆ MuxPciGetCardInfo()

_MUXSPEC tMuxStatus _MUXAPI MuxPciGetCardInfo ( uint16_t  wCard,
uint32_t *  dwCardBus,
uint32_t *  dwCardSlot,
uint32_t *  dwCardInfo 
)

Get information about the card on PCI bus.

Parameters
[in,out]wCardIndex of card number
[out]dwCardBusIndex of bus number
[out]dwCardSlotIndex of slot number
[out]dwCardInfoReserved for future use
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
STATUS_ERR_OPENCan't open Windriver
See also
STATUS_OK, STATUS_ERR_OPEN

◆ MuxSetEthernet()

_MUXSPEC tMuxStatus _MUXAPI MuxSetEthernet ( tETHState  hEthState)

Enable (or disable) the Ethernet function for 6C6L.

Parameters
[in]hEthStateEnabled parameters
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
See also
STATUS_OK

◆ MuxUsbCountCards()

_MUXSPEC tMuxStatus _MUXAPI MuxUsbCountCards ( uint32_t *  dwCardsCount)

Get the number of cards on USB bus.

Parameters
[out]dwCardsCountNumber of cards
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
STATUS_ERR_OPENCan't open Windriver
See also
STATUS_OK, STATUS_ERR_OPEN

◆ MuxUsbGetCardInfo()

_MUXSPEC tMuxStatus _MUXAPI MuxUsbGetCardInfo ( uint16_t  wCard,
uint32_t *  dwHubNum,
uint32_t *  dwPortNum,
uint32_t *  dwSerialNum,
uint32_t *  dwDeviceAddress,
uint32_t *  dwProductID,
uint32_t *  dwUniqueId 
)

Get information about the card on USB bus.

Parameters
[in,out]wCardIndex of card number on USB bus
[out]dwHubNumIndex of hub
[out]dwPortNumIndex of hub port
[out]dwSerialNumIndex of USB serie (bcd hex)
[out]dwDeviceAddressPhysical address
[out]dwProductIDProduct identifiant
[out]dwUniqueIdUnique identifiant
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
STATUS_ERR_OPENCan't open Windriver
See also
STATUS_OK, STATUS_ERR_OPEN

◆ MuxWifiCountCards()

_MUXSPEC tMuxStatus _MUXAPI MuxWifiCountCards ( uint32_t *  dwCardsCount)

Get the number of cards on Wifi bus.

Parameters
[out]dwCardsCountNumber of cards
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
See also
MuxEthCountCards
STATUS_OK
Deprecated:
Use MuxEthCountCards instead of this function.

◆ MuxWifiGetCardInfo()

_MUXSPEC tMuxStatus _MUXAPI MuxWifiGetCardInfo ( unsigned short  wCard,
char *  szSerial,
unsigned char *  szMacAddress,
unsigned char *  szIPAddress 
)

Get the number of cards on Wifi bus.

Parameters
wCardIndex of card number on USB bus
szSerialSerial
szMacAddressMAC Address
szIPAddressIP Address
Returns
Summary of the function execution
Return values
STATUS_OKSuccess
See also
MuxEthGetCardInfo
STATUS_OK
Deprecated:
Use MuxEthGetCardInfo instead of this function.