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
|
/**
* @file phc.h
* @note Copyright (C) 2011 Richard Cochran <richardcochran@gmail.com>
*
* 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_PHC_H
#define HAVE_PHC_H
#include "missing.h"
/**
* Opens a PTP hardware clock device.
*
* @param phc The device to open.
*
* @return A valid clock ID on success, CLOCK_INVALID otherwise.
*/
clockid_t phc_open(const char *phc);
/**
* Closes a PTP hardware clock device.
*
* @param clkid A clock ID obtained using phc_open().
*/
void phc_close(clockid_t clkid);
/**
* Query the maximum frequency adjustment of a PTP hardware clock device.
*
* @param clkid A clock ID obtained using phc_open().
*
* @return The clock's maximum frequency adjustment in parts per billion.
*/
int phc_max_adj(clockid_t clkid);
/**
* Queries the number of programmable pins of a PTP hardware clock device.
*
* @param clkid A clock ID obtained using phc_open().
*
* @return The number of pins supported by the clock.
*/
int phc_number_pins(clockid_t clkid);
/**
* Configures a pin of a PTP hardware clock device.
*
* @param clkid A clock ID obtained using phc_open().
*
* @param desc Pointer to a pin descriptor with the 'index', 'func',
* and 'chan' fields set.
*
* @return Zero on success, non-zero otherwise.
*/
int phc_pin_setfunc(clockid_t clkid, struct ptp_pin_desc *desc);
/**
* Checks whether the given PTP hardware clock device supports PPS output.
*
* @param clkid A clock ID obtained using phc_open().
*
* @return Zero if PPS output is not supported by the clock, non-zero
* otherwise.
*/
int phc_has_pps(clockid_t clkid);
/**
* Checks whether the given PTP hardware clock device supports write phase mode.
*
* @param clkid A clock ID obtained using phc_open().
*
* @return Zero if write phase mode is not supported by the clock, non-zero
* otherwise.
*/
int phc_has_writephase(clockid_t clkid);
#endif
|
