diff options
Diffstat (limited to 'daemons/gptp/common/common_tstamper.hpp')
| -rw-r--r-- | daemons/gptp/common/common_tstamper.hpp | 153 |
1 files changed, 0 insertions, 153 deletions
diff --git a/daemons/gptp/common/common_tstamper.hpp b/daemons/gptp/common/common_tstamper.hpp deleted file mode 100644 index cfaf3abd..00000000 --- a/daemons/gptp/common/common_tstamper.hpp +++ /dev/null @@ -1,153 +0,0 @@ -/****************************************************************************** - - Copyright (c) 2009-2012, Intel Corporation - All rights reserved. - - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions are met: - - 1. Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimer. - - 2. Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the distribution. - - 3. Neither the name of the Intel Corporation nor the names of its - contributors may be used to endorse or promote products derived from - this software without specific prior written permission. - - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE - LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - POSSIBILITY OF SUCH DAMAGE. - -******************************************************************************/ - -#ifndef COMMON_TSTAMPER_HPP -#define COMMON_TSTAMPER_HPP - -#include <unordered_map> -#include <stdint.h> -#include <avbts_message.hpp> - -#define HWTIMESTAMPER_EXTENDED_MESSAGE_SIZE 4096 /*!< Maximum size of HWTimestamper extended message */ - -/** - * @brief Provides a generic interface for hardware timestamping - */ -class CommonTimestamper { -protected: - uint8_t version; //!< HWTimestamper version - -public: - /** - * @brief Initializes the hardware timestamp unit - * @param iface_label [in] Interface label - * @param iface [in] Network interface - * @return true - */ - virtual bool HWTimestamper_init - ( InterfaceLabel *iface_label, OSNetworkInterface *iface ) - { return true; } - - /** - * @brief Reset the hardware timestamp unit - * @return void - */ - virtual void HWTimestamper_reset(void) { - } - - /** - * @brief This method is called before the object is de-allocated. - * @return void - */ - virtual void HWTimestamper_final(void) { - } - - /** - * @brief Adjusts the hardware clock frequency - * @param frequency_offset Frequency offset - * @return false - */ - virtual bool HWTimestamper_adjclockrate - ( float frequency_offset ) const - { return false; } - - /** - * @brief Adjusts the hardware clock phase - * @param phase_adjust Phase offset - * @return false - */ - virtual bool HWTimestamper_adjclockphase( int64_t phase_adjust ) - { return false; } - - /** - * @brief Get the cross timestamping information. - * The gPTP subsystem uses these samples to calculate - * ratios which can be used to translate or extrapolate - * one clock into another clock reference. The gPTP service - * uses these supplied cross timestamps to perform internal - * rate estimation and conversion functions. - * @param system_time [out] System time - * @param device_time [out] Device time - * @param local_clock [out] Local clock - * @param nominal_clock_rate [out] Nominal clock rate - * @return True in case of success. FALSE in case of error - */ - virtual bool HWTimestamper_gettime(Timestamp * system_time, - Timestamp * device_time, - uint32_t * local_clock, - uint32_t * nominal_clock_rate) const = 0; - - /** - * @brief Gets a string with the error from the hardware timestamp block - * @param msg [out] String error - * @return void - * @todo There is no current implementation for this method. - */ - virtual void HWTimestamper_get_extderror(char *msg) const - { - *msg = '\0'; - } - - /** - * @brief Starts the PPS (pulse per second) interface - * @return false - */ - virtual bool HWTimestamper_PPS_start() { return false; }; - - /** - * @brief Stops the PPS (pulse per second) interface - * @return true - */ - virtual bool HWTimestamper_PPS_stop() { return true; }; - - /** - * @brief Gets the HWTimestamper version - * @return version (signed integer) - */ - int getVersion() const - { - return version; - } - - /** - * @brief Default constructor. Sets version to zero. - */ - CommonTimestamper() { version = 0; } - - /** - * @brief Deletes HWtimestamper object - */ - virtual ~CommonTimestamper() { } -}; - -#endif/*COMMON_TSTAMPER_HPP*/ |