DLN_I2C_MASTER_GET_FREQUENCY Command and Response
The DLN_I2C_GET_FREQUENCY command is used to retrieve current I2C bus clock frequency.
DLN_I2C_MASTER_GET_FREQUENCY Command
typedef struct
{
DLN_MSG_HEADER header;
uint8_t port;
} __PACKED_ATTR DLN_I2C_MASTER_GET_FREQUENCY_CMD;
Parameters:
- header
-
Defines the DLN message header DLN_MSG_HEADER. The header contains several predefined fields and is used to identify and route messages. You must fill the following fields before sending the command:
Field Description size The size of the message. Must be equal to the size of the DLN_I2C_MASTER_GET_FREQUENCY_CMD structure. msgId Identifies the message. For the DLN_I2C_MASTER_GET_FREQUENCY command it must be set to 0x0305. You can use the DLN_MSG_ID_I2C_MASTER_GET_FREQUENCY constant. echoCounter Can be used to link a command to a response. The response will have the same echoCounter value. This field can be any numerical value from 0 to 0xFFFF (65536). handle A handle to the DLN-series adapter. - port
- A number of the I2C master port to retrieve information from.
DLN_I2C_MASTER_GET_FREQUENCY Response
The adapter sends the DLN_I2C_MASTER_GET_FREQUENCY response after the DLN_I2C_MASTER_GET_FREQUENCY command execution. The response contains current I2C clock frequency setting.
typedef struct
{
DLN_MSG_HEADER header;
DLN_RESULT result;
uint32_t frequency;
} __PACKED_ATTR DLN_I2C_MASTER_GET_FREQUENCY_RSP;
Parameters:
- header
-
Defines the DLN message header DLN_MSG_HEADER. The response header contains the following fields:
Field Description size The size of the message. It is equal to the size of the DLN_I2C_MASTER_GET_FREQUENCY_RSP structure. msgId Contains the message id. For the DLN_I2C_MASTER_GET_FREQUENCY response it is set to 0x0305. The DLN_MSG_ID_I2C_MASTER_GET_FREQUENCY constant can be used to check the message ID. echoCounter Links a command to a response. The echoCounter value is copied from the respective command header. handle A handle to the DLN-series adapter. You can use the handle field to determine the adapter that have sent the response. - result
-
Contains the result of the command execution. For DLN_I2C_MASTER_GET_FREQUENCY command DLN-series adapter can return the following result values:
Return Code Description DLN_RES_SUCCESS Current I2C clock frequency has been successfully retrieved. - frequency
- Contains current I2C bus clock frequency in Hz.
2006-2012