Zephyr API Documentation  3.6.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
gptp.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2017 Intel Corporation.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
13#ifndef ZEPHYR_INCLUDE_NET_GPTP_H_
14#define ZEPHYR_INCLUDE_NET_GPTP_H_
15
23#include <zephyr/net/net_core.h>
24#include <zephyr/net/ptp_time.h>
25#include <stdbool.h>
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
33#define GPTP_OFFSET_SCALED_LOG_VAR_UNKNOWN 0x436A
34
35#define GPTP_PRIORITY1_NON_GM_CAPABLE 255
36#define GPTP_PRIORITY1_GM_CAPABLE 248
37
38#if defined(CONFIG_NET_GPTP_BMCA_PRIORITY2)
39#define GPTP_PRIORITY2_DEFAULT CONFIG_NET_GPTP_BMCA_PRIORITY2
40#else
41#define GPTP_PRIORITY2_DEFAULT 248
42#endif
43
52
55} __packed;
56
63
66} __packed;
67
70#if defined(CONFIG_NEWLIB_LIBC)
71#include <math.h>
72
73#define GPTP_POW2(exp) pow(2, exp)
74#else
75
76static inline double gptp_pow2(int exp)
77{
78 double res;
79
80 if (exp >= 0) {
81 res = 1 << exp;
82 } else {
83 res = 1.0;
84
85 while (exp++) {
86 res /= 2;
87 }
88 }
89
90 return res;
91}
92
93#define GPTP_POW2(exp) gptp_pow2(exp)
94#endif
95
96/* Pre-calculated constants */
97/* 2^16 */
98#define GPTP_POW2_16 65536.0
99/* 2^41 */
100#define GPTP_POW2_41 2199023255552.0
101
102/* Message types. Event messages have BIT(3) set to 0, and general messages
103 * have that bit set to 1. IEEE 802.1AS chapter 10.5.2.2.2
104 */
105#define GPTP_SYNC_MESSAGE 0x00
106#define GPTP_DELAY_REQ_MESSAGE 0x01
107#define GPTP_PATH_DELAY_REQ_MESSAGE 0x02
108#define GPTP_PATH_DELAY_RESP_MESSAGE 0x03
109#define GPTP_FOLLOWUP_MESSAGE 0x08
110#define GPTP_DELAY_RESP_MESSAGE 0x09
111#define GPTP_PATH_DELAY_FOLLOWUP_MESSAGE 0x0a
112#define GPTP_ANNOUNCE_MESSAGE 0x0b
113#define GPTP_SIGNALING_MESSAGE 0x0c
114#define GPTP_MANAGEMENT_MESSAGE 0x0d
115
116#define GPTP_IS_EVENT_MSG(msg_type) (!((msg_type) & BIT(3)))
117
118#define GPTP_CLOCK_ID_LEN 8
119
127 uint8_t clk_id[GPTP_CLOCK_ID_LEN];
128
131} __packed;
132
135 union {
138
141 };
142} __packed;
143
145struct gptp_hdr {
148
151
154
157
160
163
166
169
172
175
178
181
184
187} __packed;
188
191#define GPTP_GET_CURRENT_TIME_USCALED_NS(port, uscaled_ns_ptr) \
192 do { \
193 (uscaled_ns_ptr)->low = \
194 gptp_get_current_time_nanosecond(port) << 16; \
195 (uscaled_ns_ptr)->high = 0; \
196 } while (false)
197
214 uint8_t *gm_identity,
215 uint16_t *time_base,
216 struct gptp_scaled_ns *last_gm_ph_change,
217 double *last_gm_freq_change);
218
230
233};
234
243
246
249
252};
253
262
269
274
284int gptp_event_capture(struct net_ptp_time *slave_time, bool *gm_present);
285
295char *gptp_sprint_clock_id(const uint8_t *clk_id, char *output,
296 size_t output_len);
297
306typedef void (*gptp_port_cb_t)(int port, struct net_if *iface,
307 void *user_data);
308
315void gptp_foreach_port(gptp_port_cb_t cb, void *user_data);
316
323struct gptp_domain *gptp_get_domain(void);
324
332
340struct gptp_hdr *gptp_get_hdr(struct net_pkt *pkt);
341
342#ifdef __cplusplus
343}
344#endif
345
350#endif /* ZEPHYR_INCLUDE_NET_GPTP_H_ */
void gptp_foreach_port(gptp_port_cb_t cb, void *user_data)
Go through all the gPTP ports and call callback for each of them.
void(* gptp_port_cb_t)(int port, struct net_if *iface, void *user_data)
Callback used while iterating over gPTP ports.
Definition: gptp.h:306
void(* gptp_phase_dis_callback_t)(uint8_t *gm_identity, uint16_t *time_base, struct gptp_scaled_ns *last_gm_ph_change, double *last_gm_freq_change)
Define callback that is called after a phase discontinuity has been sent by the grandmaster.
Definition: gptp.h:213
void gptp_call_phase_dis_cb(void)
Call a phase discontinuity callback function.
char * gptp_sprint_clock_id(const uint8_t *clk_id, char *output, size_t output_len)
Utility function to print clock id to a user supplied buffer.
void gptp_unregister_phase_dis_cb(struct gptp_phase_dis_cb *phase_dis)
Unregister a phase discontinuity callback.
struct gptp_hdr * gptp_get_hdr(struct net_pkt *pkt)
Return pointer to gPTP packet header in network packet.
int gptp_event_capture(struct net_ptp_time *slave_time, bool *gm_present)
Get gPTP time.
void gptp_clk_src_time_invoke(struct gptp_clk_src_time_invoke_params *arg)
This interface is used by the ClockSource entity to provide time to the ClockMaster entity of a time-...
void gptp_register_phase_dis_cb(struct gptp_phase_dis_cb *phase_dis, gptp_phase_dis_callback_t cb)
Register a phase discontinuity callback.
struct gptp_domain * gptp_get_domain(void)
Get gPTP domain.
struct _snode sys_snode_t
Single-linked list node structure.
Definition: slist.h:39
Network core definitions.
flags
Definition: parser.h:96
Public functions for the Precision Time Protocol time specification.
__UINT32_TYPE__ uint32_t
Definition: stdint.h:90
__INT32_TYPE__ int32_t
Definition: stdint.h:74
__UINT64_TYPE__ uint64_t
Definition: stdint.h:91
__UINT8_TYPE__ uint8_t
Definition: stdint.h:88
__UINT16_TYPE__ uint16_t
Definition: stdint.h:89
__INT64_TYPE__ int64_t
Definition: stdint.h:75
__INT8_TYPE__ int8_t
Definition: stdint.h:72
ClockSourceTime.invoke function parameters.
Definition: gptp.h:240
struct net_ptp_extended_time src_time
The time this function is invoked.
Definition: gptp.h:245
double last_gm_freq_change
Frequency change on the last Time Base Indicator Change.
Definition: gptp.h:242
struct gptp_scaled_ns last_gm_phase_change
Phase change on the last Time Base Indicator Change.
Definition: gptp.h:248
uint16_t time_base_indicator
Time Base - changed only if Phase or Frequency changes.
Definition: gptp.h:251
gPTP message flags
Definition: gptp.h:134
uint16_t all
Whole field access.
Definition: gptp.h:140
uint8_t octets[2]
Byte access.
Definition: gptp.h:137
gPTP message header
Definition: gptp.h:145
int64_t correction_field
Correction Field.
Definition: gptp.h:171
uint8_t domain_number
Domain number, always 0.
Definition: gptp.h:162
uint16_t sequence_id
Sequence Id.
Definition: gptp.h:180
int8_t log_msg_interval
Message Interval in Log2 for Sync and Announce messages.
Definition: gptp.h:186
uint8_t control
Control value.
Definition: gptp.h:183
struct gptp_port_identity port_id
Port Identity of the sender.
Definition: gptp.h:177
uint8_t ptp_version
Version of the PTP, always 2.
Definition: gptp.h:153
uint16_t message_length
Total length of the message from the header to the last TLV.
Definition: gptp.h:159
uint32_t reserved2
Reserved field.
Definition: gptp.h:174
uint8_t transport_specific
Transport specific, always 1.
Definition: gptp.h:150
uint8_t message_type
Type of the message.
Definition: gptp.h:147
uint8_t reserved1
Reserved field.
Definition: gptp.h:165
uint8_t reserved0
Reserved field.
Definition: gptp.h:156
Phase discontinuity callback structure.
Definition: gptp.h:227
gptp_phase_dis_callback_t cb
Phase discontinuity callback.
Definition: gptp.h:232
sys_snode_t node
Node information for the slist.
Definition: gptp.h:229
Port Identity.
Definition: gptp.h:125
uint16_t port_number
Number of the port.
Definition: gptp.h:130
uint8_t clk_id[GPTP_CLOCK_ID_LEN]
Clock identity of the port.
Definition: gptp.h:127
Scaled Nanoseconds.
Definition: gptp.h:49
int64_t low
Low half.
Definition: gptp.h:54
int32_t high
High half.
Definition: gptp.h:51
UScaled Nanoseconds.
Definition: gptp.h:60
uint32_t high
High half.
Definition: gptp.h:62
uint64_t low
Low half.
Definition: gptp.h:65
Network Interface structure.
Definition: net_if.h:678
Network packet.
Definition: net_pkt.h:67
Generalized Precision Time Protocol Extended Timestamp format.
Definition: ptp_time.h:152
(Generalized) Precision Time Protocol Timestamp format.
Definition: ptp_time.h:109