flexPTP 1.0
An IEEE 1588 PTP implementation designed for microcontrollers
Loading...
Searching...
No Matches
settings_interface.h
Go to the documentation of this file.
1
10#ifndef FLEXPTP_SETTINGS_INTERFACE_H_
11#define FLEXPTP_SETTINGS_INTERFACE_H_
12
13#include <stdint.h>
14
15#include "ptp_types.h"
16
22void ptp_set_clock_offset(int32_t offset); // set clock offset in nanoseconds
23
29int32_t ptp_get_clock_offset();
30
36void ptp_prefer_master_clock(uint64_t clockId);
37
41void ptp_unprefer_master_clock(); // allow slave to synchronize to the BMCA-elected master
42
49
56
62void ptp_set_domain(uint8_t domain);
63
69uint8_t ptp_get_domain();
70
76void ptp_set_addend(uint32_t addend);
77
83uint32_t ptp_get_addend();
84
91
98
105
112
119
126
132void ptp_set_tlv_chain_by_name(const char * tlvSet);
133
139const char * ptp_get_loaded_tlv_chain();
140
146void ptp_set_profile_flags(uint8_t flags);
147
153uint8_t ptp_get_profile_flags();
154
160void ptp_load_profile(const PtpProfile * pProfile); // load profile preset
161
168
174void ptp_set_delay_req_log_period(int8_t drlp);
175
182
188void ptp_set_sync_log_period(int8_t slp);
189
196
202void ptp_set_announce_log_period(int8_t alp);
203
209void ptp_set_coarse_threshold(uint64_t ns);
210
216uint64_t ptp_get_coarse_threshold();
217
221void ptp_set_priority1(uint8_t p1);
222
228uint8_t ptp_get_priority1();
229
233void ptp_set_priority2(uint8_t p2);
234
240uint8_t ptp_get_priority2();
241
246
253
258
265
269void ptp_set_clock_variance(uint16_t var);
270
276uint16_t ptp_get_clock_variance();
277
281void ptp_set_local_steps_removed(uint16_t lsr);
282
289
295void ptp_time(TimestampU * pT);
296
297#endif /* FLEXPTP_SETTINGS_INTERFACE_H_ */
This module defines the fundamental PTP message and state machine type, flags, bitfields and the PTP ...
PtpTransportType
PTP transport type enumeration.
Definition: ptp_types.h:128
PtpClockClass
Standard PTP clock classes.
Definition: ptp_types.h:179
PtpClockAccuracy
Standard clock accuray definitions.
Definition: ptp_types.h:195
PtpDelayMechanism
PTP Delay mechanism enumeration.
Definition: ptp_types.h:136
PtpTransportSpecific
PTP transport specific enumeration.
Definition: ptp_types.h:144
void ptp_time(TimestampU *pT)
uint16_t ptp_get_local_steps_removed()
void ptp_set_delay_mechanism(PtpDelayMechanism dm)
uint64_t ptp_get_coarse_threshold()
void ptp_set_clock_variance(uint16_t var)
void ptp_set_announce_log_period(int8_t alp)
PtpDelayMechanism ptp_get_delay_mechanism()
void ptp_set_delay_req_log_period(int8_t drlp)
PtpClockClass ptp_get_clock_class()
int8_t ptp_get_announce_log_period()
void ptp_set_transport_type(PtpTransportType tp)
void ptp_set_clock_offset(int32_t offset)
PtpTransportType ptp_get_transport_type()
uint8_t ptp_get_priority2()
uint8_t ptp_get_profile_flags()
uint64_t ptp_get_current_master_clock_identity()
int8_t ptp_get_sync_log_period()
uint8_t ptp_get_priority1()
int8_t ptp_get_delay_req_log_period()
int32_t ptp_get_clock_offset()
uint8_t ptp_get_domain()
void ptp_set_domain(uint8_t domain)
void ptp_set_local_steps_removed(uint16_t lsr)
PtpClockAccuracy ptp_get_clock_accuracy()
void ptp_set_priority2(uint8_t p2)
void ptp_set_addend(uint32_t addend)
PtpTransportSpecific ptp_get_transport_specific()
void ptp_set_sync_log_period(int8_t slp)
void ptp_set_transport_specific(PtpTransportSpecific tspec)
void ptp_unprefer_master_clock()
void ptp_prefer_master_clock(uint64_t clockId)
uint64_t ptp_get_own_clock_identity()
void ptp_set_clock_accuracy(PtpClockAccuracy ca)
void ptp_set_tlv_chain_by_name(const char *tlvSet)
void ptp_set_clock_class(PtpClockClass cc)
void ptp_set_priority1(uint8_t p1)
uint16_t ptp_get_clock_variance()
void ptp_set_profile_flags(uint8_t flags)
const char * ptp_get_loaded_tlv_chain()
uint32_t ptp_get_addend()
void ptp_load_profile(const PtpProfile *pProfile)
void ptp_set_coarse_threshold(uint64_t ns)
PTP profile structure.
Definition: ptp_types.h:331
Timestamp (unsigned)
Definition: timeutils.h:20