flexptp Directory Reference

Directory dependency graph for flexptp:

Directories
directory	port
directory	servo

Files
file	bmca.c [code]
file	bmca.h [code]
	This module implements the Best Master Clock Algorithm.
file	cli_cmds.c [code]
file	cli_cmds.h [code]
	This module handles and registers CLI commands. Commands:
file	clock_utils.c [code]
file	clock_utils.h [code]
	This module defines clock identity related operations.
file	common.c [code]
file	common.h [code]
	This module defines messaging functions for both the slave and master modules.
file	config.c [code]
file	config.h [code]
	This module defines functions for storing and loading flexPTP configurations.
file	event.c [code]
file	event.h [code]
	In this module are the core and user events defined.
file	format_utils.c [code]
file	format_utils.h [code]
	This module defines format conversion functions between network and host byte order and conversion functions between PTP logarithmic interval designator and time duration value.
file	logging.c [code]
file	logging.h [code]
	This module handles various logging capabilities.
file	master.c [code]
file	master.h [code]
	This module implements the master clock functionality.
file	msg_utils.c [code]
file	msg_utils.h [code]
	This module defines functions that deal with actual PTP messages; they can extract or insert headers, timestamps or any data of other kind.
file	network_stack_driver.h [code]
	This file is a header for the employed Network Stack Driver (NSD). A NSD must define ALL four functions listed below.
file	profiles.c [code]
file	profiles.h [code]
	This module implements defines a single method that prints a verbose summary of the operating PTP profile.
file	ptp_core.c [code]
file	ptp_core.h [code]
	Core of the PTP implementation. Defines functions for message processing, clock tuning, storing and loading configurations and managing event callbacks.
file	ptp_defs.c [code]
file	ptp_defs.h [code]
	In here reside a multitude of fundamental PTP-related constants and definitions.
file	ptp_profile_presets.c [code]
file	ptp_profile_presets.h [code]
	This module manages predefined profile presets. It allows their fetching by name or ID.
file	ptp_raw_msg_circbuf.c [code]
file	ptp_raw_msg_circbuf.h [code]
	This module implements a circular buffer that is used for accepting and omitting received and to be transmissed packets in a controlled way. The implementation does not rely on any OS features, will not block.
file	ptp_servo_types.h [code]
	This module defines the basic servo types.
file	ptp_sync_cycle_data.h [code]
	This module defines the context object of a full synchronization cycle. In SLAVE mode four timestamps are used when operating in E2E and six when in P2P mode. Timestamps explained:
file	ptp_types.h [code]
	This module defines the fundamental PTP message and state machine type, flags, bitfields and the PTP engine's internal state types.
file	settings_interface.c [code]
file	settings_interface.h [code]
	This module features functions to tweak around the PTP engine's almost every property.
file	slave.c [code]
file	slave.h [code]
	This module implements the slave clock functionality.
file	stats.c [code]
file	stats.h [code]
	This is the statistics module that gathers data of the operating PTP-engine.
file	task_ptp.c [code]
file	task_ptp.h [code]
	The entry point of the whole PTP-implementation. Calling reg_task_ptp() initializes the PTP-engine, invoking unreg_task_ptp() shuts it down.
file	timeutils.c [code]
file	timeutils.h [code]
	This module defines storage classes for timestamps and operations on time values.
file	tlv.c [code]
file	tlv.h [code]
	This module implements the TLV-related functionality.