usart_os_set_flow_control

Specify action for flow control pins.

int32_t usart_os_set_flow_control(
    struct usart_os_descriptor *const descr,
    const union usart_flow_control_state state
)

This function sets the action (or state) for flow control pins if the flow control is enabled. It sets the state of flow control pins only if the automatic support of the flow control is not supported by the hardware.

Parameters

descr

Type: struct usart_os_descriptor Struct *const

A USART descriptor which is used to communicate via USART

state

Type: const union usart_flow_control_state

A state to set the flow control pins

Returns

Type: int32_t

The status of the flow control action setup.

-1

Passed parameters were invalid or the interface is not initialized

0

The flow control action is set successfully