uart.h File Reference

#include <stdbool.h>
#include <stdint.h>

Data Structures
struct	kfsw_uart_info
struct	kfsw_uart_test_result

Types
typedef bool(*	kfsw_uart_visitor_t) (const struct kfsw_uart_info *uart_info, void *context)

Functions
void	kfsw_uart_get_info (struct kfsw_uart_info *info)
void	kfsw_uart_visit (kfsw_uart_visitor_t visitor, void *context)
int	kfsw_uart_test (uint32_t timeout_ms, struct kfsw_uart_test_result *test_result)
int	kfsw_uart_test_peer (uint16_t peer, uint32_t timeout_ms, struct kfsw_uart_test_result *test_result)

Description

UART/KISS status and peer tests.

Function Documentation

kfsw_uart_get_info()

void kfsw_uart_get_info

(

struct kfsw_uart_info *

info

)

Read the first CSP UART configuration for legacy one-interface callers.

kfsw_uart_test()

int kfsw_uart_test	(	uint32_t	timeout_ms,
		struct kfsw_uart_test_result *	test_result
	)

Ping the configured peer after verifying that its route uses this UART.

kfsw_uart_test_peer()

int kfsw_uart_test_peer	(	uint16_t	peer,
		uint32_t	timeout_ms,
		struct kfsw_uart_test_result *	test_result
	)

Ping a peer and report the KISS/UART interface selected by the CSP route.

kfsw_uart_visit()

void kfsw_uart_visit	(	kfsw_uart_visitor_t	visitor,
		void *	context
	)

Visit every independently configured CSP KISS/UART interface.