rte_clocksync.c File Reference

Implementation of the pluggable clock-sync OSAdapter (ADR-017). More...

#include "rte/oal/clocksync/rte_clocksync.h"
#include "rte/utils/lifecycle/rte_lifecycle.h"
#include "rte_osadapter/clocksync/rte_osadapter_clocksync.h"

Include dependency graph for rte_clocksync.c:

Go to the source code of this file.

Functions
rte_status_t	rte_osadapter_clocksync_register (const rte_osadapter_clocksync_t *osadapter)
	Registers the OSAdapter clock synchronization implementation.
rte_status_t	rte_clocksync_get_offset_ms (int64_t *out_offset_ms)
	Reports this node's estimated clock offset (diagnostic/timeout- sizing only - see the file-level note; never use this to decide whether channel results are comparable).
rte_status_t	rte_clocksync_get_quality (rte_clocksync_quality_t *out_quality)
	Reports the OSAdapter's current confidence in the clock offset.

Variables
static const rte_osadapter_clocksync_t *	s_osadapter = NULL

Detailed Description

Implementation of the pluggable clock-sync OSAdapter (ADR-017).

Definition in file rte_clocksync.c.

Function Documentation

rte_osadapter_clocksync_register()

rte_status_t rte_osadapter_clocksync_register

(

const rte_osadapter_clocksync_t *

adapter

)

Registers the OSAdapter clock synchronization implementation.

Global variables declarations Local function declarations Global functions

Parameters

adapter

Pointer to clocksync operations vtable.

Returns

RTE_STATUS_OK on success, RTE_STATUS_INVALID_PARAM if adapter is NULL, or RTE_STATUS_INVALID_STATE if the setup phase is already locked (REQ-LIFECYCLE-001, ADR-026; the previous registration, if any, is kept).

Definition at line 26 of file rte_clocksync.c.

Variable Documentation

s_osadapter

const rte_osadapter_clocksync_t* s_osadapter = NULL

static

Local makros Local types declarations Local variables declarations Single global OSAdapter, following ADR-005's established convention (see rte_timer/rte_ipc). NULL until rte_osadapter_clocksync_register() is called.

Definition at line 18 of file rte_clocksync.c.