History

ptp: document behavior of PTP_STRICT_FLAGS

Commit 6138e687c7b6 ("ptp: Introduce strict checking of external time stamp options.") added the PTP_STRICT_FLAGS to the set of flags supported for the external timestamp request ioctl. It is only supported by PTP_EXTTS_REQUEST2, as it was introduced the introduction of the new ioctls. Further, the kernel has always set this flag for PTP_EXTTS_REQUEST2 regardless of whether or not the user requested the behavior. This effectively means that the flag is not useful for userspace. If the user issues a PTP_EXTTS_REQUEST ioctl, the flag is ignored due to not being supported on the old ioctl. If the user issues a PTP_EXTTS_REQUEST2 ioctl, the flag will be set by the kernel regardless of whether the user set the flag in their structure. Add a comment documenting this behavior in the uAPI header file.

Jacob Keller committed 1 year ago

Commit cd875621 parent 3200fdd1 file · +3 −0Browse files

Showing the changes to include/uapi (1 of 1 file). Show all

Unified · Split

include/uapi/linux/ptp_clock.h+3−0
@@ -37,6 +37,9 @@ · 36 unmodified lines
3737
3838 /*
3939 * flag fields valid for the new PTP_EXTTS_REQUEST2 ioctl.
40+ *
41+ * Note: PTP_STRICT_FLAGS is always enabled by the kernel for
42+ * PTP_EXTTS_REQUEST2 regardless of whether it is set by userspace.
4043 */
4144 #define PTP_EXTTS_VALID_FLAGS (PTP_ENABLE_FEATURE | \
4245 PTP_RISING_EDGE | \