nv-tegra-mirror/linux-nv-oot
1
0
Fork 0
mirror of git://nv-tegra.nvidia.com/linux-nv-oot.git synced 2025-12-22 09:11:26 +03:00
Code Issues Packages Projects Releases Wiki Activity

bindings:nvpps:update nvpps binding doc

Browse Source 
update nvpps binding doc :
 * remove references to xavier platforms
 * remove memmap_phc_regs property
 * correction - primary-emac property is mandatory
 * update other property description and cleanup examples

bug 5175333

Change-Id: I2555011b83f1f969059c2a728f30feeeee2653af
Signed-off-by: Sheetal Tigadoli <stigadoli@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/c/linux-nv-oot/+/3321943
Reviewed-by: Kiran Kumar Bobbu <kbobbu@nvidia.com>
Reviewed-by: svcacv <svcacv@nvidia.com>
Reviewed-by: Sumeet Gupta <sumeetg@nvidia.com>
GVS: buildbot_gerritrpt <buildbot_gerritrpt@nvidia.com>
This commit is contained in:
Sheetal Tigadoli
2025-03-18 20:33:30 +00:00
committed by Jon Hunter
parent 9c0c7558d3
commit b656843df9
1 changed files with 67 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

118
Documentation/devicetree/bindings/nvpps/nvpps.txt
View File

@@ -1,13 +1,12 @@
NVIDIA nvpps driver bindings
Nvpps is a Linux Kernel mode driver to support the Xavier & Orin time domain
correlation feature.
Nvpps is a Linux Kernel mode driver to support Time domain correlation feature on
Nvidia Tegra SOCs
Required properties:
- compatible: This should be nvidia,tegra194-nvpps for Xavier and nvidia,tegra234-nvpps for Orin.
- compatible: This should be nvidia,tegra264-nvpps for Thor and nvidia,tegra234-nvpps for Orin.
Optional properties:
- primary-emac: specifies ethernet emac device DT. This is the primary ethernet MAC device utilized
to calculate PTP time. For example, if MGBE0 is used to calculate the PTP time,
then phandle of the device tree node corresponding to MGBE0 needs to be passed.
@@ -16,31 +15,33 @@ Optional properties:
mgbe0: ethernet@6800000
eqos: ethernet@2310000
For Example for Xavier:
eqos: ethernet@2490000
For Example for Thor:
mgbe3: ethernet@a808e10000
Optional properties:
- sec-emac: specifies secondary ethernet MAC device DT node to be used to calculate PTP time.
- memmap_phc_regs: boolean flag to indicate MAC PHC regs to be memory mapped
for getting PTP time. If not defined ptp notifer method will
be used with selected interface
- ptp_tsc_lock_threshold: specifies the threshold value which is used by HW to determine
if the TSC PTP sync/Lock is lost. The lock is deemed to be lost if the HW
determined absolute diff between PTP & TSC time exceed this value.
The value is a 16bit hexa-decimal value. The minimum value(0x1F) supported
correspond to 1us and max value(0xFFFF) supported correspond to approx 2.1ms.
If unspecified, NvPPS driver uses 0x26C(corresponding to 20us) by default
On Thor based platforms, Minimum value(1) supported correspond to 1ns and
Max value(16777215) correspond to approx 16.77ms
- ptp_tsc_sync_dis: boolean flag to indicate if nvpps should disable PTP TSC sync logic.
- ptp_tsc_sync_dis: Define this boolean flag if PTP TSC rate sync logic needs to be disabled in nvpps driver.
The default behaviour is to keep PTP TSC sync logic enabled.
- ptp_tsc_lock_threshold: specifies the threshold value in nsecs which is used by HW to determine
if the TSC PTP sync/Lock is lost. The lock is deemed to be lost if the HW
determined absolute diff between PTP & TSC time domains exceed this value.
On Orin platforms, The Min & Max values are 1us & 2.114ms. The default value used is 20us.
Since the resolution is 1usec & the value should be specified in nanosecs.
1us is specified as 1000 and 2.114ms is specified as 2114000
On Thor platforms, The Min & Max values are 1ns & 16.777215ms. The default value used is 20us
1ns is specified as 1 and 16.777215ms is specified as 16777215
When ptp_tsc_sync_dis is not set, this property is mandatory.
- ptp_tsc_sync_trig_interval: Defines interval(in terms of PPS edge count) at which PTP-TSC sync
alignment should be triggered eg: if value 3 is provided, then an attempt is
made to sync TSC with PTP(if not synchronized) on every 3rd PPS edge.
Supported min & max values are 1 & 8 respectively and by default, value
of 1 is used to trigger TSC sync on every PPS edge.
When ptp_tsc_sync_dis is not set, this property is mandatory.
- reg: specifies start address and registers count details of TSC module.
When ptp_tsc_sync_dis is not set, this property is mandatory.
- reg: specifies start address and registers count details of TSC module. It is only applicable for Orin.
- nvpps-gpios: specifies GPIO number for PPS input signal.
- nvpps-gpios: specifies GPIO number for PPS input signal. If not provided, then Timer mode is default operating mode
- timestamps: specifies timestamp for the GPIO provided by HTE.
- timestamp-names: specifies name for GPIO timestamp.
- ts-capture-interval: Defines the interval between timestamp captures in milliseconds.
@@ -63,33 +64,7 @@ nvpps {
compatible = "nvidia,tegra234-nvpps";
primary-emac = <&mgbe0>;
sec-emac = <&mgbe0>;
reg = <0x0 0xc6a0000 0x0 0x1000>;
};
Example: Timer mode on Xavier
eqos: ethernet@2490000{
};
nvpps {
status = "okay";
compatible = "nvidia,tegra194-nvpps";
primary-emac = <&eqos>;
sec-emac = <&eqos>;
};
Example: MAC PHC regs to be memory mapped on Orin
mgbe0: ethernet@6800000{
};
nvpps {
status = "okay";
compatible = "nvidia,tegra234-nvpps";
primary-emac = <&mgbe0>
sec-emac = <&mgbe0>;
memmap_phc_regs;
reg = <0x0 0xc6a0000 0x0 0x1000>;
ptp_tsc_sync_dis;
};
@@ -101,10 +76,11 @@ mgbe0: ethernet@6800000{
nvpps {
status = "okay";
compatible = "nvidia,tegra234-nvpps";
reg = <0x0 0xc6a0000 0x0 0x1000>;
ptp_tsc_sync_dis;
nvpps-gpios = <&gpio_aon TEGRA234_AON_GPIO(BB, 0) GPIO_ACTIVE_HIGH>;
timestamps = <&hte_aon TEGRA234_AON_GPIO(BB, 0)>;
timestamp-names = "nvpps_gpio";
ts-capture-interval = <1000>;
nvpps-event-mode-init = <1>; /* 1 for GPIO mode, 2 for TIMER mode */
};
@@ -118,10 +94,50 @@ nvpps {
status = "okay";
compatible = "nvidia,tegra234-nvpps";
primary-emac = <&mgbe0>;
sec-emac = <&mgbe0>;
reg = <0x0 0xc6a0000 0x0 0x1000>;
ptp_tsc_lock_threshold = /bits/ 16 <0x26C>;
ptp_tsc_sync_dis;
ptp_tsc_lock_threshold = <20000>;
ptp_tsc_sync_trig_interval = <3>;
ts-capture-interval = <1000>;
nvpps-event-mode-init = <2>; /* 1 for GPIO mode, 2 for TIMER mode */
};
Example: Timer mode on Thor with additional properties.
mgbe1: ethernet@a808b10000{
};
mgbe3: ethernet@a808e10000{
};
nvpps {
status = "okay";
compatible = "nvidia,tegra264-nvpps";
primary-emac = <&mgbe3>;
sec-emac = <&mgbe1>;
reg = <0x0 0xc230000 0x0 0x1000>;
ptp_tsc_lock_threshold = <20000>; // 20us
ptp_tsc_sync_trig_interval = <3>; // trigger tsc sync on every 3 PPS edges
ts-capture-interval = <1000>;
nvpps-event-mode-init = <2>; /* 1 for GPIO mode, 2 for TIMER mode */
};
Example: GPIO mode on Thor with additional properties.
mgbe1: ethernet@a808b10000{
};
mgbe3: ethernet@a808e10000{
};
nvpps {
status = "okay";
compatible = "nvidia,tegra264-nvpps";
primary-emac = <&mgbe3>;
sec-emac = <&mgbe1>;
reg = <0x0 0xc230000 0x0 0x1000>;
ptp_tsc_lock_threshold = <20000>; // 20us
ptp_tsc_sync_trig_interval = <3>; // trigger tsc sync on every 3 PPS edges
nvpps-gpios = <&gpio_aon TEGRA264_AON_GPIO(AA, 6) GPIO_ACTIVE_HIGH>; // GPIO PPS input pin PAA.6
ts-capture-interval = <1000>;
nvpps-event-mode-init = <1>; /* 1 for GPIO mode, 2 for TIMER mode */
};