Socket BAL (Windows) More...

Collaboration diagram for Component : Socket (Windows):

Data Structures
struct	phbalReg_SocketWin_DataParams_t
	SocketWin(Windows) BAL parameter structure. More...

Macros
#define	PHBAL_REG_SOCKETWIN_ID 0x09U
	ID for SOCKETWIN component.

Typedefs
typedef void(*	TySocketWinCallback) (uint8_t *data, uint32_t length, TyTransferType transferType)
	function pointer to register socketWin Callback.

Enumerations
enum	TyTransferType
	\ Socket Win Callback Transfer Type.

Functions
phStatus_t	phbalReg_SocketWin_Init (phbalReg_SocketWin_DataParams_t pDataParams, uint16_t wSizeOfDataParams, uint8_t bMode, uint16_t wTxBufSize, uint8_t pTxBuffer, uint16_t wWsaBufferSize, uint8_t *pWsaBuffer)
	Initialise the Socket Win BAL component. More...

SocketWin specific configs
#define	PHBAL_REG_SOCKETWIN_CONFIG_MODE (PH_CONFIG_CUSTOM_BEGIN + 0)
	Set operating mode. More...

#define	PHBAL_REG_SOCKETWIN_CONFIG_BITRATE (PH_CONFIG_CUSTOM_BEGIN + 1)
	Configure communication speed.

#define	PHBAL_REG_SOCKETWIN_CONFIG_I2C_SLAVE_ADDR (PH_CONFIG_CUSTOM_BEGIN + 2)
	Configure slave address for I2C communication mod.

#define	PHBAL_REG_SOCKETWIN_CONFIG_SETCARD (PH_CONFIG_CUSTOM_BEGIN + 3)
	Set card configuration for simulation.

#define	PHBAL_REG_SOCKETWIN_CONFIG_RESET (PH_CONFIG_CUSTOM_BEGIN + 4)
	Reset the simulation.

SocketWin operation mode values
#define	PHBAL_REG_SOCKETWIN_MODE_RAW 0x00U
	RAW exchange mode. More...

#define	PHBAL_REG_SOCKETWIN_MODE_RS232 0x01U
	RS232 exchange mode according to Maat DigiSpec; Exchanges binary data.

#define	PHBAL_REG_SOCKETWIN_MODE_I2C 0x02U
	I2C exchange mode according to Maat DigiSpec; Exchanges binary data.

#define	PHBAL_REG_SOCKETWIN_MODE_SPI 0x03U
	SPI exchange mode according to Maat DigiSpec; Exchanges binary data.

#define	PHBAL_REG_SOCKETWIN_MODE_HEX 0x04U
	RAW exchange mode. More...

#define	PHBAL_REG_SOCKETWIN_MODE_TELNET 0x05U
	Telnet exchange mode.

SocketWin Bitrate Values
#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_RS232_9600 0x0000U
	9600 kBit/s RS232.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_RS232_19200 0x0001U
	19200 kBit/s RS232.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_RS232_38400 0x0002U
	38400 kBit/s RS232.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_RS232_57600 0x0003U
	57600 kBit/s RS232.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_RS232_115200 0x0004U
	115200 kBit/s RS232.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_RS232_128000 0x0005U
	128000 kBit/s RS232.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_RS232_230400 0x0006U
	230400 kBit/s RS232.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_RS232_460800 0x0007U
	460800 kBit/s RS232.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_RS232_921600 0x0008U
	921600 kBit/s RS232.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_RS232_1228800 0x0009U
	1228800 kBit/s RS232.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_SPI_10K 0x0010U
	10 kBit/s SPI.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_SPI_100K 0x0011U
	100 kBit/s SPI.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_SPI_1M 0x0012U
	1 MBit/s SPI.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_SPI_3M 0x0013U
	3 MBit/s SPI.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_SPI_5M 0x0014U
	5 MBit/s SPI.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_SPI_8M 0x0015U
	8 MBit/s SPI.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_I2C_10K 0x0020U
	10 KBit/s I2C.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_I2C_100K 0x0021U
	100 KBit/s I2C.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_I2C_200K 0x0022U
	200 KBit/s I2C.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_I2C_400K 0x0023U
	400 KBit/s I2C.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_I2CL_1M 0x0044U
	1 MBit/s I2CL.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_I2CL_3M 0x0045U
	3 MBit/s I2CL.

#define	PHBAL_REG_SOCKETWIN_VALUE_BITRATE_I2CL_5M 0x0046U
	5 MBit/s I2CL.

SocketWin Card Values
Note: Set in MSB(yte), they set the TX-Mode, in the LSB the RX-Mode.
#define	PHBAL_REG_SOCKETWIN_TX_TWO_CARDS 0x80U
	Set this in the MSB(yte) to have two cards instead of one.

#define	PHBAL_REG_SOCKETWIN_RXTX_MIFARE_106 0x00U
	MIFARE(R) Operating mode at 106kbit/s.

#define	PHBAL_REG_SOCKETWIN_RXTX_MIFARE_212 0x01U
	MIFARE(R) Operating mode at 212kbit/s.

#define	PHBAL_REG_SOCKETWIN_RXTX_MIFARE_424 0x02U
	MIFARE(R) Operating mode at 424kbit/s.

#define	PHBAL_REG_SOCKETWIN_RXTX_MIFARE_848 0x03U
	MIFARE(R) Operating mode at 848kbit/s.

#define	PHBAL_REG_SOCKETWIN_RXTX_TYPEB_106 0x04U
	ISO14443B Operating mode at 106kbit/s.

#define	PHBAL_REG_SOCKETWIN_RXTX_TYPEB_212 0x05U
	ISO14443B Operating mode at 212kbit/s.

#define	PHBAL_REG_SOCKETWIN_RXTX_TYPEB_424 0x06U
	ISO14443B Operating mode at 424kbit/s.

#define	PHBAL_REG_SOCKETWIN_RXTX_TYPEB_848 0x07U
	ISO14443B Operating mode at 848kbit/s.

#define	PHBAL_REG_SOCKETWIN_RXTX_FELICA_212 0x08U
	FeliCa Operating mode at 212kbit/s.

#define	PHBAL_REG_SOCKETWIN_RXTX_FELICA_424 0x09U
	FeliCa Operating mode at 424kbit/s.

#define	PHBAL_REG_SOCKETWIN_RXTX_I15693_1OO4 0x0AU
	ISO15693 One-Out-Of-Four Operating mode.

#define	PHBAL_REG_SOCKETWIN_RXTX_I15693_1OO256 0x0BU
	ISO15693 One-Out-Of-256 Operating mode.

#define	PHBAL_REG_SOCKETWIN_RXTX_EPCV2_424_DUAL 0x0FU
	ICode EPC V2 424 kBit/s (2 Subcarriers).

#define	PHBAL_REG_SOCKETWIN_RXTX_EPCV2_424_QUAD 0x10U
	ICode EPC V2 424 kBit/s (4 Subcarriers).

#define	PHBAL_REG_SOCKETWIN_RXTX_EPCV2_848_DUAL 0x11U
	ICode EPC V2 848 kBit/s (2 Subcarriers).

#define	PHBAL_REG_SOCKETWIN_RXTX_EPCV2_848_QUAD 0x12U
	ICode EPC V2 848 kBit/s (4 Subcarriers).

Detailed Description

Socket BAL (Windows)

Interfaces NCSim Simulation over Network Sockets.

Macro Definition Documentation

◆ PHBAL_REG_SOCKETWIN_CONFIG_MODE

#define PHBAL_REG_SOCKETWIN_CONFIG_MODE (PH_CONFIG_CUSTOM_BEGIN + 0)

Set operating mode.

(e.g. PHBAL_REG_SOCKETWIN_MODE_RS232).

◆ PHBAL_REG_SOCKETWIN_MODE_RAW

#define PHBAL_REG_SOCKETWIN_MODE_RAW 0x00U

RAW exchange mode.

Exchanges null-terminated strings.

◆ PHBAL_REG_SOCKETWIN_MODE_HEX

#define PHBAL_REG_SOCKETWIN_MODE_HEX 0x04U

RAW exchange mode.

Exchanges of hex data.

Function Documentation

◆ phbalReg_SocketWin_Init()

phStatus_t phbalReg_SocketWin_Init	(	phbalReg_SocketWin_DataParams_t *	pDataParams,
		uint16_t	wSizeOfDataParams,
		uint8_t	bMode,
		uint16_t	wTxBufSize,
		uint8_t *	pTxBuffer,
		uint16_t	wWsaBufferSize,
		uint8_t *	pWsaBuffer
	)

Initialise the Socket Win BAL component.

Returns: Status code

Return values

PH_ERR_SUCCESS	Operation successful.
PH_ERR_INVALID_DATA_PARAMS	Parameter structure size is invalid.
PH_ERR_INVALID_PARAMETER	bMode or wTxBufSize is invalid.
PH_ERR_BUFFER_OVERFLOW	pWsaBuffer size is too small.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	wSizeOfDataParams	[In] Specifies the size of the data parameter structure.
[in]	bMode	[In] Initial operating mode;

See also: PHBAL_REG_SOCKETWIN_CONFIG_MODE.

Parameters

[in]	wTxBufSize	[In] Size of the global transmit buffer.
[in]	pTxBuffer	[In] Pointer to global transmit buffer used by the Exchange() function.
[in]	wWsaBufferSize	[In] Size of the Windsocket WSADATA structure buffer; Refer to WinSock documentation (should be about 400 bytes).
[in]	pWsaBuffer	[In] Pointer to the Winsocket WSADATA structure buffer.

Data Structures

Macros

Typedefs

Enumerations

Functions

SocketWin specific configs

SocketWin operation mode values

SocketWin Bitrate Values