From: Jacob Keller <jacob.e.keller@intel.com>
To: Ahmad Fatoum <a.fatoum@pengutronix.de>,
Richard Cochran <richardcochran@gmail.com>
Cc: kernel@pengutronix.de, netdev@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH net-next v1] ptp: document struct ptp_clock_request members
Date: Wed, 18 Nov 2020 13:35:29 -0800 [thread overview]
Message-ID: <26e16e25-c5ac-1474-fcc9-466cea4bcf9a@intel.com> (raw)
In-Reply-To: <20201117213826.18235-1-a.fatoum@pengutronix.de>
On 11/17/2020 1:38 PM, Ahmad Fatoum wrote:
> It's arguable most people interested in configuring a PPS signal
> want it as external output, not as kernel input. PTP_CLK_REQ_PPS
> is for input though. Add documentation to nudge readers into
> the correct direction.
Agreed. I think at least one driver has abused the PPS in the past as a
way to request that we enable the PPS hardware, resulting in effectively
using it as a limited form of the EXTTS interface. Hopefully this helps
reduce the confusion here!
Reviewed-by: Jacob Keller <jacob.e.keller@intel.com>
>
> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
> ---
> Prompted by Richard's comment here:
> https://lore.kernel.org/netdev/20180525170247.r4gn323udrucmyv6@localhost/
> ---
> include/linux/ptp_clock_kernel.h | 13 +++++++++++++
> 1 file changed, 13 insertions(+)
>
> diff --git a/include/linux/ptp_clock_kernel.h b/include/linux/ptp_clock_kernel.h
> index d3e8ba5c7125..0d47fd33b228 100644
> --- a/include/linux/ptp_clock_kernel.h
> +++ b/include/linux/ptp_clock_kernel.h
> @@ -12,6 +12,19 @@
> #include <linux/pps_kernel.h>
> #include <linux/ptp_clock.h>
>
> +/**
> + * struct ptp_clock_request - request PTP clock event
> + *
> + * @type: The type of the request.
> + * EXTTS: Configure external trigger timestamping
> + * PEROUT: Configure periodic output signal (e.g. PPS)
> + * PPS: trigger internal PPS event for input
> + * into kernel PPS subsystem
> + * @extts: describes configuration for external trigger timestamping.
> + * This is only valid when event == PTP_CLK_REQ_EXTTS.
> + * @perout: describes configuration for periodic output.
> + * This is only valid when event == PTP_CLK_REQ_PEROUT.
> + */
>
> struct ptp_clock_request {
> enum {
>
prev parent reply other threads:[~2020-11-18 21:35 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-17 21:38 [PATCH net-next v1] ptp: document struct ptp_clock_request members Ahmad Fatoum
2020-11-18 13:05 ` Richard Cochran
2020-11-18 18:51 ` Jakub Kicinski
2020-11-18 21:35 ` Jacob Keller [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=26e16e25-c5ac-1474-fcc9-466cea4bcf9a@intel.com \
--to=jacob.e.keller@intel.com \
--cc=a.fatoum@pengutronix.de \
--cc=kernel@pengutronix.de \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=richardcochran@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).