You are here

Home >
C/C++ API >
SPI Bus Interface >
SPI Slave Interface >
SPI Slave Functions >
DlnSpiSlaveGetSSIdleTimeout() Function

DlnSpiSlaveGetSSIdleTimeout() Function

The DlnSpiSlaveGetSSIdleTimeout() function retrieves the current value of SS idle timeout.

Syntax

C/C++

DLN_RESULT DlnSpiSlaveGetSSIdleTimeout(
    HDLN handle, 
    uint8_t port, 
    uint32_t *timeout
);

Parameters

handle: A handle to the DLN-series adapter.
port: A number of the SPI slave port.
timeout: A pointer to an unsigned 32 bit integer that receives the current SS idle timeout value.

Return Value

DLN_RES_SUCCESS (0x00): The function successfully retrieved the current SS idle timeout value.
DLN_RES_INVALID_PORT_NUMBER (0xA8): The port number is not valid. Use the DlnSpiSlaveGetPortCount() function to find the maximum possible port number.

Remarks

The DlnSpiSlaveGetSSIdleTimeout() function is defined in the dln_spi_slave.h file.

Printer-friendly version