ptp: ocp: TOD and monitoring updates
cover ptp: ocp: TOD and monitoring updates
Add a series of patches for monitoring the status of the driver and adjusting TOD handling, especially around leap seconds.
Add documentation for the new sysfs nodes.
Jonathan Lemon (1):
docs: ABI: Document new timecard sysfs nodes.
Vadim Fedorenko (4):
ptp: ocp: add TOD debug information
ptp: ocp: Expose clock status drift and offset
ptp: ocp: add tod_correction attribute
ptp: ocp: adjust utc_tai_offset to TOD info
Documentation/ABI/testing/sysfs-timecard | 22 +++ drivers/ptp/ptp_ocp.c | 232 +++++++++++++++++------ 2 files changed, 198 insertions(+), 56 deletions(-)
Signature · 1 line
2.31.1
PATCH 1/5 ptp: ocp: add TOD debug information
From: Vadim Fedorenko <[email protected]>
TOD information is currently displayed only on module load, which doesn't provide updated information as the system runs.
Create a debug file which provides the current TOD status information, and move the information display there.
--- drivers/ptp/ptp_ocp.c | 106 ++++++++++++++++++++++++++++-------------- 1 file changed, 70 insertions(+), 36 deletions(-)
drivers/ptp/ptp_ocp.c +70 -36
@@ -88,9 +88,10 @@ struct tod_reg {#define TOD_CTRL_GNSS_MASK ((1U << 4) - 1)#define TOD_CTRL_GNSS_SHIFT 24 -#define TOD_STATUS_UTC_MASK 0xff -#define TOD_STATUS_UTC_VALID BIT(8) -#define TOD_STATUS_LEAP_VALID BIT(16) +#define TOD_STATUS_UTC_MASK 0xff +#define TOD_STATUS_UTC_VALID BIT(8) +#define TOD_STATUS_LEAP_ANNOUNCE BIT(12) +#define TOD_STATUS_LEAP_VALID BIT(16)struct ts_reg {u32 enable;
@@ -883,45 +884,26 @@ ptp_ocp_tod_init(struct ptp_ocp *bp)ptp_ocp_utc_distribute (bp, reg &TOD_STATUS_UTC_MASK ); } -static void -ptp_ocp_tod_info (struct ptp_ocp *bp) +static const char * +ptp_ocp_tod_proto_name (const int idx) {static const char *const proto_name[] = {"NMEA" ,"NMEA_ZDA" ,"NMEA_RMC" ,"NMEA_none" ,"UBX" ,"UBX_UTC" ,"UBX_LS" ,"UBX_none" }; +return proto_name[idx]; +} + +static const char * +ptp_ocp_tod_gnss_name (int idx) +{static const char *const gnss_name[] = {"ALL" ,"COMBINED" ,"GPS" ,"GLONASS" ,"GALILEO" ,"BEIDOU" , +"Unknown" }; -u32 version, ctrl, reg; -int idx; - - version =ioread32 (&bp->tod->version); -dev_info (&bp->pdev->dev,"TOD Version %d.%d.%d\n" , - version >>24 , (version >>16 ) &0xff , version &0xffff ); - - ctrl =ioread32 (&bp->tod->ctrl); - idx = ctrl &TOD_CTRL_PROTOCOL ?4 :0 ; - idx += (ctrl >>16 ) &3 ; -dev_info (&bp->pdev->dev,"control: %x\n" , ctrl); -dev_info (&bp->pdev->dev,"TOD Protocol %s %s\n" , proto_name[idx], - ctrl &TOD_CTRL_ENABLE ?"enabled" :"" ); - - idx = (ctrl >>TOD_CTRL_GNSS_SHIFT ) &TOD_CTRL_GNSS_MASK ; -if (idx <ARRAY_SIZE (gnss_name)) -dev_info (&bp->pdev->dev,"GNSS %s\n" , gnss_name[idx]); - - reg =ioread32 (&bp->tod->status); -dev_info (&bp->pdev->dev,"status: %x\n" , reg); - - reg =ioread32 (&bp->tod->adj_sec); -dev_info (&bp->pdev->dev,"correction: %d\n" , reg); - - reg =ioread32 (&bp->tod->utc_status); -dev_info (&bp->pdev->dev,"utc_status: %x\n" , reg); -dev_info (&bp->pdev->dev,"utc_offset: %d valid:%d leap_valid:%d\n" , - reg &TOD_STATUS_UTC_MASK , reg &TOD_STATUS_UTC_VALID ?1 :0 , - reg &TOD_STATUS_LEAP_VALID ?1 :0 ); +if (idx >ARRAY_SIZE (gnss_name)) + idx =ARRAY_SIZE (gnss_name) -1 ; +return gnss_name[idx]; } static int
@@ -2200,6 +2182,57 @@ ptp_ocp_summary_show(struct seq_file *s, void *data) }DEFINE_SHOW_ATTRIBUTE (ptp_ocp_summary); +static int +ptp_ocp_tod_status_show (struct seq_file *s,void *data) +{ +struct device *dev = s->private; +struct ptp_ocp *bp; +u32 val; +int idx; + + bp =dev_get_drvdata (dev); + + val =ioread32 (&bp->tod->ctrl); +if (!(val &TOD_CTRL_ENABLE )) { +seq_printf (s,"TOD Slave disabled\n" ); +return 0 ; + } +seq_printf (s,"TOD Slave enabled, Control Register 0x%08X\n" , val); + + idx = val &TOD_CTRL_PROTOCOL ?4 :0 ; + idx += (val >>16 ) &3 ; +seq_printf (s,"Protocol %s\n" ,ptp_ocp_tod_proto_name (idx)); + + idx = (val >>TOD_CTRL_GNSS_SHIFT ) &TOD_CTRL_GNSS_MASK ; +seq_printf (s,"GNSS %s\n" ,ptp_ocp_tod_gnss_name (idx)); + + val =ioread32 (&bp->tod->version); +seq_printf (s,"TOD Version %d.%d.%d\n" , + val >>24 , (val >>16 ) &0xff , val &0xffff ); + + val =ioread32 (&bp->tod->status); +seq_printf (s,"Status register: 0x%08X\n" , val); + + val =ioread32 (&bp->tod->adj_sec); + idx = (val & ~INT_MAX ) ?-1 :1 ; + idx *= (val &INT_MAX ); +seq_printf (s,"Correction seconds: %d\n" , idx); + + val =ioread32 (&bp->tod->utc_status); +seq_printf (s,"UTC status register: 0x%08X\n" , val); +seq_printf (s,"UTC offset: %d valid:%d\n" , + val &TOD_STATUS_UTC_MASK , val &TOD_STATUS_UTC_VALID ?1 :0 ); +seq_printf (s,"Leap second info valid:%d, Leap second announce %d\n" , + val &TOD_STATUS_LEAP_VALID ?1 :0 , + val &TOD_STATUS_LEAP_ANNOUNCE ?1 :0 ); + + val =ioread32 (&bp->tod->leap); +seq_printf (s,"Time to next leap second (in sec): %d\n" , (s32 ) val); + +return 0 ; +} +DEFINE_SHOW_ATTRIBUTE (ptp_ocp_tod_status); +static struct dentry *ptp_ocp_debugfs_root; static void
@@ -2211,6 +2244,9 @@ ptp_ocp_debugfs_add_device(struct ptp_ocp *bp) bp->debug_root = d;debugfs_create_file ("summary" ,0444 , bp->debug_root, &bp->dev, &ptp_ocp_summary_fops); +if (bp->tod) +debugfs_create_file ("tod_status" ,0444 , bp->debug_root, + &bp->dev, &ptp_ocp_tod_status_fops); } static void
@@ -2389,8 +2425,6 @@ ptp_ocp_info(struct ptp_ocp *bp)u32 reg;ptp_ocp_phc_info (bp); -if (bp->tod) -ptp_ocp_tod_info (bp);if (bp->image) {u32 ver =ioread32 (&bp->image->version);
Signature · 1 line
2.31.1
PATCH 2/5 ptp: ocp: Expose clock status drift and offset
In reply to Jonathan LemonFrom: Vadim Fedorenko <[email protected]>
Monitoring of clock variance could be done through checking the offset and the drift updates that are applied to atomic clocks. Expose these values as attributes for the timecard.
--- drivers/ptp/ptp_ocp.c | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+)
drivers/ptp/ptp_ocp.c +34 -0
@@ -52,6 +52,8 @@ struct ocp_reg {u32 servo_offset_i;u32 servo_drift_p;u32 servo_drift_i; +u32 status_offset; +u32 status_drift; };#define OCP_CTRL_ENABLE BIT(0)
@@ -1956,6 +1958,36 @@ available_clock_sources_show(struct device *dev, }static DEVICE_ATTR_RO (available_clock_sources); +static ssize_t +clock_status_drift_show (struct device *dev, +struct device_attribute *attr,char *buf) +{ +struct ptp_ocp *bp =dev_get_drvdata (dev); +u32 val; +int res; + + val =ioread32 (&bp->reg->status_drift); + res = (val & ~INT_MAX ) ?-1 :1 ; + res *= (val &INT_MAX ); +return sysfs_emit (buf,"%d\n" , res); +} +static DEVICE_ATTR_RO (clock_status_drift); + +static ssize_t +clock_status_offset_show (struct device *dev, +struct device_attribute *attr,char *buf) +{ +struct ptp_ocp *bp =dev_get_drvdata (dev); +u32 val; +int res; + + val =ioread32 (&bp->reg->status_offset); + res = (val & ~INT_MAX ) ?-1 :1 ; + res *= (val &INT_MAX ); +return sysfs_emit (buf,"%d\n" , res); +} +static DEVICE_ATTR_RO (clock_status_offset); +static struct attribute *timecard_attrs[] = { &dev_attr_serialnum.attr, &dev_attr_gnss_sync.attr,
@@ -1967,6 +1999,8 @@ static struct attribute *timecard_attrs[] = { &dev_attr_sma4.attr, &dev_attr_available_sma_inputs.attr, &dev_attr_available_sma_outputs.attr, + &dev_attr_clock_status_drift.attr, + &dev_attr_clock_status_offset.attr, &dev_attr_irig_b_mode.attr, &dev_attr_utc_tai_offset.attr, &dev_attr_ts_window_adjust.attr,
Signature · 1 line
2.31.1
PATCH 3/5 ptp: ocp: add tod_correction attribute
In reply to Jonathan LemonFrom: Vadim Fedorenko <[email protected]>
TOD correction register is used to compensate for leap seconds in different domains. Export it as an attribute with write access.
--- drivers/ptp/ptp_ocp.c | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+)
drivers/ptp/ptp_ocp.c +41 -0
@@ -1988,6 +1988,46 @@ clock_status_offset_show(struct device *dev, }static DEVICE_ATTR_RO (clock_status_offset); +static ssize_t +tod_correction_show (struct device *dev, +struct device_attribute *attr,char *buf) +{ +struct ptp_ocp *bp =dev_get_drvdata (dev); +u32 val; +int res; + + val =ioread32 (&bp->tod->adj_sec); + res = (val & ~INT_MAX ) ?-1 :1 ; + res *= (val &INT_MAX ); +return sysfs_emit (buf,"%d\n" , res); +} + +static ssize_t +tod_correction_store (struct device *dev,struct device_attribute *attr, +const char *buf,size_t count) +{ +struct ptp_ocp *bp =dev_get_drvdata (dev); +unsigned long flags; +int err, res; +u32 val =0 ; + + err =kstrtos32 (buf,0 , &res); +if (err) +return err; +if (res <0 ) { + res *=-1 ; + val |=BIT (31 ); + } + val |= res; + +spin_lock_irqsave (&bp->lock, flags); +iowrite32 (val, &bp->tod->adj_sec); +spin_unlock_irqrestore (&bp->lock, flags); + +return count; +} +static DEVICE_ATTR_RW (tod_correction); +static struct attribute *timecard_attrs[] = { &dev_attr_serialnum.attr, &dev_attr_gnss_sync.attr,
@@ -2004,6 +2044,7 @@ static struct attribute *timecard_attrs[] = { &dev_attr_irig_b_mode.attr, &dev_attr_utc_tai_offset.attr, &dev_attr_ts_window_adjust.attr, + &dev_attr_tod_correction.attr,NULL , };ATTRIBUTE_GROUPS (timecard);
Signature · 1 line
2.31.1
PATCH 4/5 ptp: ocp: adjust utc_tai_offset to TOD info
In reply to Jonathan LemonFrom: Vadim Fedorenko <[email protected]>
utc_tai_offset is used to correct IRIG, DCF and NMEA outputs and is set during initialisation but is not corrected during leap second announce event. Add watchdog code to control this correction.
--- drivers/ptp/ptp_ocp.c | 51 ++++++++++++++++++++++++++----------------- 1 file changed, 31 insertions(+), 20 deletions(-)
drivers/ptp/ptp_ocp.c +31 -20
@@ -762,12 +762,31 @@ __ptp_ocp_clear_drift_locked(struct ptp_ocp *bp)iowrite32 (select >>16 , &bp->reg->select); } +static void +ptp_ocp_utc_distribute (struct ptp_ocp *bp,u32 val) +{ +unsigned long flags; + +spin_lock_irqsave (&bp->lock, flags); + + bp->utc_tai_offset = val; + +if (bp->irig_out) +iowrite32 (val, &bp->irig_out->adj_sec); +if (bp->dcf_out) +iowrite32 (val, &bp->dcf_out->adj_sec); +if (bp->nmea_out) +iowrite32 (val, &bp->nmea_out->adj_sec); + +spin_unlock_irqrestore (&bp->lock, flags); +} +static void ptp_ocp_watchdog (struct timer_list *t) {struct ptp_ocp *bp =from_timer (bp, t, watchdog);unsigned long flags; -u32 status; +u32 status, utc_offset; status =ioread32 (&bp->pps_to_clk->status);
@@ -784,6 +803,17 @@ ptp_ocp_watchdog(struct timer_list *t) bp->gnss_lost =0 ; } +/* if GNSS provides correct data we can rely on +* it to get leap second information +*/ +if (bp->tod) { + status =ioread32 (&bp->tod->utc_status); + utc_offset = status &TOD_STATUS_UTC_MASK ; +if (status &TOD_STATUS_UTC_VALID && + utc_offset != bp->utc_tai_offset) +ptp_ocp_utc_distribute (bp, utc_offset); + } +mod_timer (&bp->watchdog, jiffies +HZ ); }
@@ -852,25 +882,6 @@ ptp_ocp_init_clock(struct ptp_ocp *bp)return 0 ; } -static void -ptp_ocp_utc_distribute (struct ptp_ocp *bp,u32 val) -{ -unsigned long flags; - -spin_lock_irqsave (&bp->lock, flags); - - bp->utc_tai_offset = val; - -if (bp->irig_out) -iowrite32 (val, &bp->irig_out->adj_sec); -if (bp->dcf_out) -iowrite32 (val, &bp->dcf_out->adj_sec); -if (bp->nmea_out) -iowrite32 (val, &bp->nmea_out->adj_sec); - -spin_unlock_irqrestore (&bp->lock, flags); -} -static void ptp_ocp_tod_init (struct ptp_ocp *bp) {
Signature · 1 line
2.31.1
PATCH 5/5 docs: ABI: Document new timecard sysfs nodes.
In reply to Jonathan LemonAdd documentation for the tod_correction, clock_status_drift, and clock_status_offset nodes.
--- Documentation/ABI/testing/sysfs-timecard | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+)
Documentation/ABI/testing/sysfs-timecard +22 -0
@@ -63,6 +63,18 @@ Description: (RW) Contains the current synchronization source used by the PHC. May be changed by writing one of the listed values from the available_clock_sources attribute set. +What: /sys/class/timecard/ocpN/clock_status_drift +Date: March 2022 +Contact: Jonathan Lemon <[email protected]> +Description: (RO) Contains the current drift value used by the firmware + for internal disciplining of the atomic clock. + +What: /sys/class/timecard/ocpN/clock_status_offset +Date: March 2022 +Contact: Jonathan Lemon <[email protected]> +Description: (RO) Contains the current offset value used by the firmware + for internal disciplining of the atomic clock. + What: /sys/class/timecard/ocpN/gnss_sync Date: September 2021 Contact: Jonathan Lemon <[email protected]>
@@ -126,6 +138,16 @@ Description: (RW) These attributes specify the direction of the signal The 10Mhz reference clock input is currently only valid on SMA1 and may not be combined with other destination sinks. +What: /sys/class/timecard/ocpN/tod_correction +Date: March 2022 +Contact: Jonathan Lemon <[email protected]> +Description: (RW) The incoming GNSS signal is in UTC time, and the NMEA + format messages do not provide a TAI offset. This sets the + correction value for the incoming time. + + If UBX_LS is enabled, this should be 0, and the offset is + taken from the UBX-NAV-TIMELS message. + What: /sys/class/timecard/ocpN/ts_window_adjust Date: September 2021 Contact: Jonathan Lemon <[email protected]>
Signature · 1 line
2.31.1
This series was applied to netdev/net-next.git (master) by David S. Miller <[email protected]>:
Hello:
This series was applied to netdev/net-next.git (master) by David S. Miller <[email protected]>:
Quoted 9 lines · On Wed, 2 Mar 2022 13:34:54 -0800 you wrote:
Add a series of patches for monitoring the status of the driver and adjusting TOD handling, especially around leap seconds.
Add documentation for the new sysfs nodes.
Jonathan Lemon (1):
docs: ABI: Document new timecard sysfs nodes.[...]
Here is the summary with links:
- [net-next,1/5] ptp: ocp: add TOD debug information
https://git.kernel.org/netdev/net-next/c/9f492c4cb235 - [net-next,2/5] ptp: ocp: Expose clock status drift and offset https://git.kernel.org/netdev/net-next/c/2f23f486cf62 - [net-next,3/5] ptp: ocp: add tod_correction attribute https://git.kernel.org/netdev/net-next/c/44a412d13b31 - [net-next,4/5] ptp: ocp: adjust utc_tai_offset to TOD info https://git.kernel.org/netdev/net-next/c/e68462a0d99d - [net-next,5/5] docs: ABI: Document new timecard sysfs nodes. https://git.kernel.org/netdev/net-next/c/4db073174f95
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html