DlnI2cSlaveGetEvent() Function

The DlnI2cSlaveGetEvent() function retrieves settings for I²C event generation for the specified I²C slave port and I²C slave address.

Syntax

C/C++

DLN_RESULT DlnI2cSlaveGetEvent(
   HDLN handle,
   uint8_t port,
   uint16_t slaveAddressNumber
   uint8_t* eventType,
);

Parameters

handle

A handle to the DLN-series adapter.

port

A number of the I²C slave port.

slaveAddressNumber

A number of the I²C slave address to retrieve settings for. Use the DlnI2cSlaveGetAddressCount() function to obtain the total number of supported I²C slave addresses.

eventType

A pointer to an unsigned 8-bit integer that receives the current event generation settings. The following values are supported:

I2C_SLAVE_EVENT_NONE (0) - No I²C slave events are generated.
I2C_SLAVE_EVENT_READ (1) - I²C slave events are generated when an I²C master device reads data from the PC-I2C adapter.
I2C_SLAVE_EVENT_WRITE (2) - I²C slave events are generated when an I²C master device writes data to the PC-I²C adapter.
I2C_SLAVE_EVENT_READ_WRITE (1) - I²C slave events are generated both for read and write transactions.

Refer to I2C Slave Events section for additional information.

Return Value

DLN_RES_SUCCESS (0x00): The function successfully retrieved the current I²C slave events configuration.
DLN_RES_INVALID_PORT_NUMBER (0xA8): The port number is not valid. Use the DlnI2cSlaveGetPortCount() function to find the maximum possible port number.

Remarks

The DlnI2cSlaveGetEvent() function is defined in the dln_i2c_slave.h file.