SW API reconciliation about openavnu HOT 2 OPEN

David, Do you have a list of specific changes to recommend?

from openavnu.

Hi Andrew,

The following items intend to be a direct map of what we have to what is missing:

Required Interfaces

1. Objects
   1.1. Clock Object: The class IEEE1588 clock provides the clock object. It defines several methods for dealing with the clock information.
   Missing intefaces:
   a) Enumeration clock type. There is no direct structure for the clock type information, but it uses different types of clock and it can be implied based on the clock's name.
   b) Phase offset: No direct way of getting. Its accessible through the timestamper.
   c) RateRatio minus one is a desirable value to improve round off errors.
2. Data types
   2.1. Clock Time: The clock time data type is accessible through IEEE1588Clock::getTime(). It returns a Timestamp structure with time in seconds (64 bits) + 32 bits nanoseconds
   2.2. Clock Type: No direct structure for that.
   2.3. gPTP clock time: Its possible to get the ptp time through HWTimestamper_gettime method.
   2.4. Grandmaster status: Its accessible through the IEEE1588Port::getPortState.
3. Data member definintion
   3.1. Slave-Only mode: On the IEEE1588Clock constructor, the flag forceOrdinarySlave should force it to slave. Also, there is an internal flag called slave_only that is not being used. On the daemon initialization, the gPTP can be forced to be slave by using the -L switch.
   3.2. gPTP rate ratio: The method IEEE1588Clock::calcMasterLocalClockRateDifference provides this information.
   3.3. Path delay: Its accessible throught the IEEE1588Port on the method getLinkDelay
   3.4. Neighbor delay: The ability to adjust the neighbor delay can be achieved through IEEE1588Port:setLinkDelay
   3.5. Descontinuity Threshold: A configurable threshold on the gPTP subsystem to control when the clock master is unreliable is not available on open-avb gPTP. This is not avaible on gPTP.
4. Operation Definitions.
   4.1. Grandmaster change: On IEEE1588Port::ProcessEvent there is a verification to check if the grandmaster has changed based on the clock identity, The state STATE_CHANGE_EVENT indicates that.
   4.2. Master time discontinuity: An event detected by the gPTP subsystem indicating the absolute Master Time has changed at a rate in excess of the selected Discontinuity Threshold. Its not currently implemented
   4.3. Initialize clock: IEEE1588Clock constructor initializes the 1588 clock
   4.4. Clock cross timestamps: HWTimestamper::HWTimestamper_gettime() provides the clock cross timestamps.
   4.5. Translate clock: There is no explicit interface as translate clock is defined on sw apis documentation. It could be achieved by calling HWTimestamper_gettime()
   4.6. Get gPTP clock: IEEE1588Clock::getSystemTime provides the 1588 clock information
   4.7. Get clock quality IEEE1588Clock::getClockQuality prvoides the clock quality information

from openavnu.