DLN_SPI_MASTER_SET_MODE Command and Response

The DLN_SPI_MASTER_SET_MODE command is used to set SPI transmission parameters (CPOL and CPHA).

DLN_SPI_MASTER_SET_MODE Command

Go to response

 typedef struct
 {
    DLN_MSG_HEADER header;
    uint8_t port;
    uint8_t mode;
 }__PACKED_ATTR DLN_SPI_MASTER_SET_MODE_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_SPI_MASTER_SET_MODE_CMD structure.
msgId Identifies the message. For the DLN_SPI_MASTER_SET_MODE command it must be set to 0x0214. You can use the DLN_MSG_ID_SPI_MASTER_SET_MODE 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 SPI master port to apply configuration to.
mode
A bit field consisting of 8 bits. The bits 0 and 1 correspond to CPOL and CPHA parameters correspondingly and define the SPI mode. The rest of the bits is not used. You can also use special constants, defined in the dln_spi_master.h file for each of the bits. See SPI Transfer Modes section for additional info.
Bit Value Description Constant
0 0 CPOL=0 DLN_SPI_MASTER_CPOL_0
0 1 CPOL=1 DLN_SPI_MASTER_CPOL_1
1 0 CPHA=0 DLN_SPI_MASTER_CPHA_0
1 1 CPHA=1 DLN_SPI_MASTER_CPHA_1

DLN_SPI_MASTER_SET_MODE Response

Go to command

The adapter sends the DLN_SPI_MASTER_SET_MODE response after the DLN_SPI_MASTER_SET_MODE command execution. The result field informs a user whether the configuration has been successfully changed.

 typedef struct
 {
    DLN_MSG_HEADER header;
    DLN_RESULT result;
 }__PACKED_ATTR DLN_SPI_MASTER_SET_MODE_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_SPI_MASTER_SET_MODE_RSP structure.
msgId Contains the message id. For the DLN_SPI_MASTER_SET_MODE response it is set to 0x0214. The DLN_MSG_ID_SPI_MASTER_SET_MODE 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_SPI_MASTER_SET_MODE command DLN-series adapter can return the following result values:

Return Code Description
DLN_RES_SUCCESS The configuration has been successfully set.