Re: [Patch net-next v6 08/13] net: dsa: microchip: ptp: add packet transmission timestamping

[Vladimir Oltean <olteanv@gmail.com>]

On Mon, Jan 02, 2023 at 10:34:54AM +0530, Arun Ramadoss wrote:
> diff --git a/drivers/net/dsa/microchip/ksz_ptp.c b/drivers/net/dsa/microchip/ksz_ptp.c
> index e72fce54188e..8f5e099b1b99 100644
> --- a/drivers/net/dsa/microchip/ksz_ptp.c
> +++ b/drivers/net/dsa/microchip/ksz_ptp.c
> @@ -18,6 +18,8 @@
>  
>  #define ptp_caps_to_data(d) container_of((d), struct ksz_ptp_data, caps)
>  #define ptp_data_to_ksz_dev(d) container_of((d), struct ksz_device, ptp_data)
> +#define work_to_xmit_work(w) \
> +		container_of((w), struct ksz_deferred_xmit_work, work)
>  
>  /* Sub-nanoseconds-adj,max * sub-nanoseconds / 40ns * 1ns
>   * = (2^30-1) * (2 ^ 32) / 40 ns * 1 ns = 6249999
> @@ -111,9 +113,15 @@ static int ksz_set_hwtstamp_config(struct ksz_device *dev,
>  
>  	switch (config->tx_type) {
>  	case HWTSTAMP_TX_OFF:
> +		prt->ptpmsg_irq[KSZ_SYNC_MSG].ts_en  = 0;
> +		prt->ptpmsg_irq[KSZ_XDREQ_MSG].ts_en = 0;
> +		prt->ptpmsg_irq[KSZ_PDRES_MSG].ts_en = 0;
>  		prt->hwts_tx_en = false;
>  		break;
>  	case HWTSTAMP_TX_ONESTEP_P2P:
> +		prt->ptpmsg_irq[KSZ_SYNC_MSG].ts_en  = 0;
> +		prt->ptpmsg_irq[KSZ_XDREQ_MSG].ts_en = 1;
> +		prt->ptpmsg_irq[KSZ_PDRES_MSG].ts_en = 0;

Please use true/false for boolean types. I believe I've said this before.

>  		prt->hwts_tx_en = true;
>  		break;
>  	default:
> @@ -232,6 +240,88 @@ bool ksz_port_rxtstamp(struct dsa_switch *ds, int port, struct sk_buff *skb,
>  	return false;
>  }
>  
> +void ksz_port_txtstamp(struct dsa_switch *ds, int port,
> +		       struct sk_buff *skb)

Function prototype fits on one line.

> +{
> +	struct ksz_device *dev	= ds->priv;

Again, I believe the tab here is misused, as there is nothing to align
the equal sign to.

> +	struct ptp_header *hdr;
> +	struct sk_buff *clone;
> +	struct ksz_port *prt;
> +	unsigned int type;
> +	u8 ptp_msg_type;
> +
> +	prt = &dev->ports[port];
> +
> +	if (!prt->hwts_tx_en)
> +		return;
> +
> +	type = ptp_classify_raw(skb);
> +	if (type == PTP_CLASS_NONE)
> +		return;
> +
> +	hdr = ptp_parse_header(skb, type);
> +	if (!hdr)
> +		return;
> +
> +	ptp_msg_type = ptp_get_msgtype(hdr, type);
> +
> +	switch (ptp_msg_type) {
> +	case PTP_MSGTYPE_PDELAY_REQ:
> +		break;
> +
> +	default:
> +		return;
> +	}
> +
> +	clone = skb_clone_sk(skb);
> +	if (!clone)
> +		return;
> +
> +	/* caching the value to be used in tag_ksz.c */
> +	KSZ_SKB_CB(skb)->clone = clone;
> +}
> +
> +static void ksz_ptp_txtstamp_skb(struct ksz_device *dev,
> +				 struct ksz_port *prt, struct sk_buff *skb)
> +{
> +	struct skb_shared_hwtstamps hwtstamps = {};
> +	int ret;
> +
> +	skb_shinfo(skb)->tx_flags |= SKBTX_IN_PROGRESS;

It would be good if you set SKBTX_IN_PROGRESS _before_ passing the skb
ownership to the DSA master (dsa_enqueue_skb). It makes a certain class
of bugs much easier to identify, because they will reproduce much more
consistently. Otherwise, as the way things are written, the DSA master
driver will sometimes see this skb as having SKBTX_IN_PROGRESS and
sometimes not in progress (because the assignment races with the
ndo_start_xmit of that other driver).

I know perfectly well that the DSA master driver should not look at the
SKBTX_IN_PROGRESS flag of a skb which it's not support to timestamp itself.
But sometimes drivers aren't all that perfect.

> +
> +	/* timeout must include tstamp latency, IRQ latency and time for
> +	 * reading the time stamp.

FWIW, also the time necessary for the DSA master to transmit the skb,
of course.

> +	 */
> +	ret = wait_for_completion_timeout(&prt->tstamp_msg_comp,
> +					  msecs_to_jiffies(100));
> +	if (!ret)
> +		return;
> +
> +	hwtstamps.hwtstamp = prt->tstamp_msg;
> +	skb_complete_tx_timestamp(skb, &hwtstamps);
> +}
> +
> +void ksz_port_deferred_xmit(struct kthread_work *work)
> +{
> +	struct ksz_deferred_xmit_work *xmit_work = work_to_xmit_work(work);
> +	struct sk_buff *clone, *skb = xmit_work->skb;
> +	struct dsa_switch *ds = xmit_work->dp->ds;
> +	struct ksz_device *dev = ds->priv;
> +	struct ksz_port *prt;
> +
> +	prt = &dev->ports[xmit_work->dp->index];
> +
> +	clone = KSZ_SKB_CB(skb)->clone;
> +
> +	reinit_completion(&prt->tstamp_msg_comp);
> +
> +	dsa_enqueue_skb(skb, skb->dev);
> +
> +	ksz_ptp_txtstamp_skb(dev, prt, clone);
> +
> +	kfree(xmit_work);
> +}
> +
>  static int _ksz_ptp_gettime(struct ksz_device *dev, struct timespec64 *ts)
>  {
>  	u32 nanoseconds;
> @@ -480,7 +570,29 @@ void ksz_ptp_clock_unregister(struct dsa_switch *ds)
>  
>  static irqreturn_t ksz_ptp_msg_thread_fn(int irq, void *dev_id)
>  {
> -	return IRQ_NONE;
> +	struct ksz_ptp_irq *ptpmsg_irq = dev_id;
> +	struct ksz_device *dev;
> +	struct ksz_port *port;
> +	u32 tstamp_raw;
> +	ktime_t tstamp;
> +	int ret;
> +
> +	port = ptpmsg_irq->port;
> +	dev = port->ksz_dev;
> +
> +	if (ptpmsg_irq->ts_en) {
> +		ret = ksz_read32(dev, ptpmsg_irq->ts_reg, &tstamp_raw);
> +		if (ret)
> +			return IRQ_NONE;
> +
> +		tstamp = ksz_decode_tstamp(tstamp_raw);
> +
> +		port->tstamp_msg = ksz_tstamp_reconstruct(dev, tstamp);
> +
> +		complete(&port->tstamp_msg_comp);
> +	}
> +
> +	return IRQ_HANDLED;
>  }