DLN_SPI_SLAVE_DISABLE Command and Response

The DLN_SPI_SLAVE_DISABLE command is used to deactivate the specified SPI slave port of your DLN-series adapter.

DLN_SPI_SLAVE_DISABLE Command

Go to response

 typedef struct
 {
    DLN_MSG_HEADER header;
    uint8_t port;
    uint8_t waitForTransferCompletion;
 }__PACKED_ATTR DLN_SPI_SLAVE_DISABLE_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_SLAVE_DISABLE_CMD structure.
msgId Identifies the message. For the DLN_SPI_SLAVE_DISABLE command it must be set to 0x0B02. You can use the DLN_MSG_ID_SPI_SLAVE_DISABLE 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 slave port to be deactivated.
waitForTransferCompletion
Used to choose whether the DLN-series adapter should wait for current data transfers to complete before deactivating the SPI slave port. The following values are available:
1 or DLN_SPI_SLAVE_WAIT_FOR_TRANSFERS wait until transfers are completed
0 or DLN_SPI_SLAVE_CANCEL_TRANSFERS cancel data transfers

DLN_SPI_SLAVE_DISABLE Response

Go to command

The adapter sends the DLN_SPI_SLAVE_DISABLE response after the DLN_SPI_SLAVE_DISABLE command execution. The result field informs a user if the specified SPI slave port has been successfully deactivated.

 typedef struct
 {
    DLN_MSG_HEADER header;
    DLN_RESULT result;
 }__PACKED_ATTR DLN_SPI_SLAVE_DISABLE_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_SLAVE_DISABLE_RSP structure.
msgId Contains the message id. For the DLN_SPI_SLAVE_DISABLE response it is set to 0x0B02. The DLN_MSG_ID_SPI_SLAVE_DISABLE 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_SLAVE_DISABLE command DLN-series adapter can return the following result values:

Return Code Description
DLN_RES_SUCCESS The specified SPI slave port has been successfully deactivated.