chao
/
linuxptp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
linuxptp/ts2phc_slave.h

21 lines
531 B
C
Raw Normal View History

Introduce the ts2phc program. Some PTP Hardware Clocks have input pins that can generate time stamps on the edges of external signals. This functionality can be used in various ways. For example, one can synchronize a PHC device to a global time source by taking a Pulse Per Second signal from the source into the PHC. This patch adds support for synchronizing one or more PHC slaves to a given master clock. The implementation follows a modular design that allows adding different kinds of master clocks in the future. This patch starts off with a single "generic" PPS master, meaning a PPS signal that lacks and time or date information. The generic master assumes that the Linux system time is approximately correct (by NTP or RTC for example) in order to calculate the time of the incoming PPS edges. Signed-off-by: Richard Cochran <richardcochran@gmail.com> Signed-off-by: Balint Ferencz <fernya@gmail.com>
2019-07-08 07:47:48 +08:00
/**
* @file ts2phc_slave.h
* @brief Utility program to synchronize the PHC clock to external events
* @note Copyright (C) 2019 Balint Ferencz <fernya@sch.bme.hu>
* @note SPDX-License-Identifier: GPL-2.0+
*/
#ifndef HAVE_TS2PHC_SLAVE_H
#define HAVE_TS2PHC_SLAVE_H
ts2phc: create a private data structure Eliminate the ad-hoc use of global variables in the ts2phc program by introducing one data structure that incorporates them. This might make the code more understandable to people coming from a kernel background, since it resembles the type of data organization used there. It is also now closer to the data organization of phc2sys, a similar program in both purpose and implementation. The reason why this is needed has to do with the ts2phc polymorphism for a PPS master. In the next patches, PPS masters will expose a struct clock, which will be synchronized from the main ts2phc.c. Not all PPS masters will expose a clock, only the PHC kind will. So the current object encapsulation model needs to be loosened up little bit, because the main ts2phc.c needs to synchronize a list of clocks, list which is populated by the slaves and the masters which are capable of being synchronized. So instead of having the translation modules of ts2phc communicate through global variables, let's make struct ts2phc_private the common working space for the entire program, which is a paradigm that is more natural. Signed-off-by: Vladimir Oltean <olteanv@gmail.com> Reviewed-by: Jacob Keller <jacob.e.keller@intel.com>
2020-06-29 03:02:38 +08:00
#include "ts2phc.h"
Introduce the ts2phc program. Some PTP Hardware Clocks have input pins that can generate time stamps on the edges of external signals. This functionality can be used in various ways. For example, one can synchronize a PHC device to a global time source by taking a Pulse Per Second signal from the source into the PHC. This patch adds support for synchronizing one or more PHC slaves to a given master clock. The implementation follows a modular design that allows adding different kinds of master clocks in the future. This patch starts off with a single "generic" PPS master, meaning a PPS signal that lacks and time or date information. The generic master assumes that the Linux system time is approximately correct (by NTP or RTC for example) in order to calculate the time of the incoming PPS edges. Signed-off-by: Richard Cochran <richardcochran@gmail.com> Signed-off-by: Balint Ferencz <fernya@gmail.com>
2019-07-08 07:47:48 +08:00
ts2phc: create a private data structure Eliminate the ad-hoc use of global variables in the ts2phc program by introducing one data structure that incorporates them. This might make the code more understandable to people coming from a kernel background, since it resembles the type of data organization used there. It is also now closer to the data organization of phc2sys, a similar program in both purpose and implementation. The reason why this is needed has to do with the ts2phc polymorphism for a PPS master. In the next patches, PPS masters will expose a struct clock, which will be synchronized from the main ts2phc.c. Not all PPS masters will expose a clock, only the PHC kind will. So the current object encapsulation model needs to be loosened up little bit, because the main ts2phc.c needs to synchronize a list of clocks, list which is populated by the slaves and the masters which are capable of being synchronized. So instead of having the translation modules of ts2phc communicate through global variables, let's make struct ts2phc_private the common working space for the entire program, which is a paradigm that is more natural. Signed-off-by: Vladimir Oltean <olteanv@gmail.com> Reviewed-by: Jacob Keller <jacob.e.keller@intel.com>
2020-06-29 03:02:38 +08:00
int ts2phc_slave_add(struct ts2phc_private *priv, const char *name);
Introduce the ts2phc program. Some PTP Hardware Clocks have input pins that can generate time stamps on the edges of external signals. This functionality can be used in various ways. For example, one can synchronize a PHC device to a global time source by taking a Pulse Per Second signal from the source into the PHC. This patch adds support for synchronizing one or more PHC slaves to a given master clock. The implementation follows a modular design that allows adding different kinds of master clocks in the future. This patch starts off with a single "generic" PPS master, meaning a PPS signal that lacks and time or date information. The generic master assumes that the Linux system time is approximately correct (by NTP or RTC for example) in order to calculate the time of the incoming PPS edges. Signed-off-by: Richard Cochran <richardcochran@gmail.com> Signed-off-by: Balint Ferencz <fernya@gmail.com>
2019-07-08 07:47:48 +08:00
ts2phc: create a private data structure Eliminate the ad-hoc use of global variables in the ts2phc program by introducing one data structure that incorporates them. This might make the code more understandable to people coming from a kernel background, since it resembles the type of data organization used there. It is also now closer to the data organization of phc2sys, a similar program in both purpose and implementation. The reason why this is needed has to do with the ts2phc polymorphism for a PPS master. In the next patches, PPS masters will expose a struct clock, which will be synchronized from the main ts2phc.c. Not all PPS masters will expose a clock, only the PHC kind will. So the current object encapsulation model needs to be loosened up little bit, because the main ts2phc.c needs to synchronize a list of clocks, list which is populated by the slaves and the masters which are capable of being synchronized. So instead of having the translation modules of ts2phc communicate through global variables, let's make struct ts2phc_private the common working space for the entire program, which is a paradigm that is more natural. Signed-off-by: Vladimir Oltean <olteanv@gmail.com> Reviewed-by: Jacob Keller <jacob.e.keller@intel.com>
2020-06-29 03:02:38 +08:00
int ts2phc_slaves_init(struct ts2phc_private *priv);
Introduce the ts2phc program. Some PTP Hardware Clocks have input pins that can generate time stamps on the edges of external signals. This functionality can be used in various ways. For example, one can synchronize a PHC device to a global time source by taking a Pulse Per Second signal from the source into the PHC. This patch adds support for synchronizing one or more PHC slaves to a given master clock. The implementation follows a modular design that allows adding different kinds of master clocks in the future. This patch starts off with a single "generic" PPS master, meaning a PPS signal that lacks and time or date information. The generic master assumes that the Linux system time is approximately correct (by NTP or RTC for example) in order to calculate the time of the incoming PPS edges. Signed-off-by: Richard Cochran <richardcochran@gmail.com> Signed-off-by: Balint Ferencz <fernya@gmail.com>
2019-07-08 07:47:48 +08:00
ts2phc: create a private data structure Eliminate the ad-hoc use of global variables in the ts2phc program by introducing one data structure that incorporates them. This might make the code more understandable to people coming from a kernel background, since it resembles the type of data organization used there. It is also now closer to the data organization of phc2sys, a similar program in both purpose and implementation. The reason why this is needed has to do with the ts2phc polymorphism for a PPS master. In the next patches, PPS masters will expose a struct clock, which will be synchronized from the main ts2phc.c. Not all PPS masters will expose a clock, only the PHC kind will. So the current object encapsulation model needs to be loosened up little bit, because the main ts2phc.c needs to synchronize a list of clocks, list which is populated by the slaves and the masters which are capable of being synchronized. So instead of having the translation modules of ts2phc communicate through global variables, let's make struct ts2phc_private the common working space for the entire program, which is a paradigm that is more natural. Signed-off-by: Vladimir Oltean <olteanv@gmail.com> Reviewed-by: Jacob Keller <jacob.e.keller@intel.com>
2020-06-29 03:02:38 +08:00
void ts2phc_slave_cleanup(struct ts2phc_private *priv);
Introduce the ts2phc program. Some PTP Hardware Clocks have input pins that can generate time stamps on the edges of external signals. This functionality can be used in various ways. For example, one can synchronize a PHC device to a global time source by taking a Pulse Per Second signal from the source into the PHC. This patch adds support for synchronizing one or more PHC slaves to a given master clock. The implementation follows a modular design that allows adding different kinds of master clocks in the future. This patch starts off with a single "generic" PPS master, meaning a PPS signal that lacks and time or date information. The generic master assumes that the Linux system time is approximately correct (by NTP or RTC for example) in order to calculate the time of the incoming PPS edges. Signed-off-by: Richard Cochran <richardcochran@gmail.com> Signed-off-by: Balint Ferencz <fernya@gmail.com>
2019-07-08 07:47:48 +08:00
ts2phc: create a private data structure Eliminate the ad-hoc use of global variables in the ts2phc program by introducing one data structure that incorporates them. This might make the code more understandable to people coming from a kernel background, since it resembles the type of data organization used there. It is also now closer to the data organization of phc2sys, a similar program in both purpose and implementation. The reason why this is needed has to do with the ts2phc polymorphism for a PPS master. In the next patches, PPS masters will expose a struct clock, which will be synchronized from the main ts2phc.c. Not all PPS masters will expose a clock, only the PHC kind will. So the current object encapsulation model needs to be loosened up little bit, because the main ts2phc.c needs to synchronize a list of clocks, list which is populated by the slaves and the masters which are capable of being synchronized. So instead of having the translation modules of ts2phc communicate through global variables, let's make struct ts2phc_private the common working space for the entire program, which is a paradigm that is more natural. Signed-off-by: Vladimir Oltean <olteanv@gmail.com> Reviewed-by: Jacob Keller <jacob.e.keller@intel.com>
2020-06-29 03:02:38 +08:00
int ts2phc_slave_poll(struct ts2phc_private *priv);
Introduce the ts2phc program. Some PTP Hardware Clocks have input pins that can generate time stamps on the edges of external signals. This functionality can be used in various ways. For example, one can synchronize a PHC device to a global time source by taking a Pulse Per Second signal from the source into the PHC. This patch adds support for synchronizing one or more PHC slaves to a given master clock. The implementation follows a modular design that allows adding different kinds of master clocks in the future. This patch starts off with a single "generic" PPS master, meaning a PPS signal that lacks and time or date information. The generic master assumes that the Linux system time is approximately correct (by NTP or RTC for example) in order to calculate the time of the incoming PPS edges. Signed-off-by: Richard Cochran <richardcochran@gmail.com> Signed-off-by: Balint Ferencz <fernya@gmail.com>
2019-07-08 07:47:48 +08:00
#endif