-
Notifications
You must be signed in to change notification settings - Fork 2
/
pmc_agent.h
184 lines (163 loc) · 6.64 KB
/
pmc_agent.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
/**
* @file pmc_agent.h
* @brief Client code for making PTP management requests.
* @note Copyright (C) 2013 Miroslav Lichvar <[email protected]>
* @note Copyright (C) 2020 Richard Cochran <[email protected]>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef HAVE_PMC_AGENT_H
#define HAVE_PMC_AGENT_H
#include <stdbool.h>
#include "fsm.h"
#include "pmc_common.h"
struct pmc_agent;
typedef int pmc_node_recv_subscribed_t(void *context, struct ptp_message *msg,
int excluded);
int init_pmc_node(struct config *cfg, struct pmc_agent *agent, const char *uds,
pmc_node_recv_subscribed_t *recv_subscribed, void *context);
int run_pmc_wait_sync(struct pmc_agent *agent, int timeout);
/**
* Creates an instance of a PMC agent.
* @return Pointer to a PMC instance on success, NULL otherwise.
*/
struct pmc_agent *pmc_agent_create(void);
/**
* Destroys an instance of a PMC agent.
* @param agent Pointer to a PMC instance obtained via @ref pmc_agent_create().
*/
void pmc_agent_destroy(struct pmc_agent *agent);
/**
* Disconnects the PMC agent from the ptp4l service.
* @param agent Pointer to a PMC instance obtained via @ref pmc_agent_create().
*/
void pmc_agent_disable(struct pmc_agent *agent);
/**
* Gets the current leap adjustment.
* @param agent Pointer to a PMC instance obtained via @ref pmc_agent_create().
* @return The leap adjustment in seconds, either 1, 0, or -1.
*/
int pmc_agent_get_leap(struct pmc_agent *agent);
/**
* Gets the number of local ports from the default data set. Users
* should first call pmc_agent_query_dds() before invoking this
* function.
*
* @param agent Pointer to a PMC instance obtained via @ref pmc_agent_create().
* @return The non-negative number of ports, or -1 if unknown.
*/
int pmc_agent_get_number_ports(struct pmc_agent *agent);
/**
* Gets the TAI-UTC offset.
* @param agent Pointer to a PMC instance obtained via @ref pmc_agent_create().
* @return Current offset in seconds.
*/
int pmc_agent_get_sync_offset(struct pmc_agent *agent);
/**
* Queries the local clock's default data set from the ptp4l service.
* The result of the query will be cached inside of the agent.
*
* In addition:
*
* - The port state notification callback might be invoked.
*
* @param agent Pointer to a PMC instance obtained via @ref pmc_agent_create().
* @param timeout Transmit and receive timeout in milliseconds.
* @return Zero on success, negative error code otherwise.
*/
int pmc_agent_query_dds(struct pmc_agent *agent, int timeout);
/**
* Queries the port properties of a given port from the ptp4l service.
*
* In addition:
*
* - The port state notification callback might be invoked.
*
* @param agent Pointer to a PMC instance obtained via @ref pmc_agent_create().
* @param timeout Transmit and receive timeout in milliseconds.
* @param port The port index of interest.
* @param state Buffer to hold the returned port state.
* @param tstamping Buffer to hold the returned time stamping flavor.
* @param phc_index Buffer to hold the returned PHC index.
* @param iface Buffer to hold the returned interface name.
* @return Zero on success, negative error code otherwise.
*/
int pmc_agent_query_port_properties(struct pmc_agent *agent, int timeout,
unsigned int port, enum port_state *state,
int *tstamping, int *phc_index,
char *iface);
/**
* Queries the TAI-UTC offset and the current leap adjustment from the
* ptp4l service.
*
* In addition:
*
* - The port state notification callback might be invoked.
*
* @param agent Pointer to a PMC instance obtained via @ref pmc_agent_create().
* @param timeout Transmit and receive timeout in milliseconds.
* @return Zero on success, negative error code otherwise.
*/
int pmc_agent_query_utc_offset(struct pmc_agent *agent, int timeout);
/**
* Sets the TAI-UTC offset.
* @param agent Pointer to a PMC instance obtained via @ref pmc_agent_create().
* @param offset Desired offset in seconds.
*/
void pmc_agent_set_sync_offset(struct pmc_agent *agent, int offset);
/**
* Subscribes to push notifications of changes in port state.
* @param agent Pointer to a PMC instance obtained via @ref pmc_agent_create().
* @param timeout Transmit and receive timeout in milliseconds.
* @param interval Maximum expected interval between @ref pmc_agent_update()
* calls in seconds. This value controls the ptp4l subscription
* duration.
* @return Zero on success, negative error code otherwise.
*/
int pmc_agent_subscribe(struct pmc_agent *agent, int timeout, int interval);
/**
* Polls for push notifications from the local ptp4l service.
*
* In addition:
*
* - Queries the local ptp4l instance to update the TAI-UTC offset and
* the current leap second flags.
* - Any active port state subscription will be renewed.
* - The port state notification callback might be invoked.
*
* This function should be called periodically at least once per
* minute to keep both the port state and the leap second flags up to
* date. Note that the PMC agent rate limits the query to once per
* minute, and so the caller may safely invoke this method more often
* than that.
*
* @param agent Pointer to a PMC instance obtained via @ref pmc_agent_create().
* @return Zero on success, negative error code otherwise.
*/
int pmc_agent_update(struct pmc_agent *agent);
/**
* Checks if last successful subscription did not run out, i.e. ptp4l is still
* responding (assuming pmc_agent_update() is called frequently enough).
* @param agent Pointer to a PMC instance obtained via @ref pmc_agent_create().
* @return True if subscribed, false otherwise.
*/
int pmc_agent_is_subscribed(struct pmc_agent *agent);
/**
* Tests whether the current UTC offset is traceable.
* @param agent Pointer to a PMC instance obtained via @ref pmc_agent_create().
* @return True is the offset is traceable, false otherwise.
*/
bool pmc_agent_utc_offset_traceable(struct pmc_agent *agent);
#endif