You are here

DlnSpiMasterGetCpol() Function

The DlnSpiMasterGetCpol() function retrieves the current value of clock polarity (CPOL).

Syntax

C/C++

DLN_RESULT DlnSpiMasterGetCpol(
    HDLN handle, 
    uint8_t port, 
    uint8_t *cpol
);

Parameters

handle: A handle to the DLN-series adapter.
port: A number of the SPI master port.
cpol: The pointer to uint8_t variable which will be filled with current CPOL value.

Return Value

DLN_RES_SUCCESS (0x00): The function successfully retrieved the SPI master CPOL value.
DLN_RES_INVALID_PORT_NUMBER (0xA8): The port number is not valid. Use the DlnSpiMasterGetPortCount() function to find the maximum possible port number.

Remarks

The DlnSpiMasterGetCpol() function is defined in the dln_spi_master.h file.

Printer-friendly version