Skip to content

arch/arm/stm32h7: timestamp the transmitted frames in hardware #20213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xiaoxiang781216 merged 1 commit into from
Sep 21, 2026
+160 −3
Merged

arch/arm/stm32h7: timestamp the transmitted frames in hardware #20213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion arch/arm/src/common/stm32/Kconfig.eth
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ config STM32_ETH_TIMESTAMP_RX

config STM32_ETH_TIMESTAMP_TX
bool "Hardware timestamping of transmitted packets"
depends on STM32_COMMON_LEGACY && STM32_ETH_PTP && NET_TIMESTAMP && STM32_ETH_ENHANCEDDESC
depends on STM32_ETH_PTP && NET_TIMESTAMP && (STM32_COMMON_H7_H5 || (STM32_COMMON_LEGACY && STM32_ETH_ENHANCEDDESC))
default n
---help---
Enables hardware timestamp capture on transmitted Ethernet frames.
Expand Down
161 changes: 159 additions & 2 deletions arch/arm/src/stm32h7/stm32_ethernet.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -775,6 +775,18 @@ struct stm32_ethmac_s

struct mdio_bus_s *mdio;

#ifdef CONFIG_STM32_ETH_TIMESTAMP_TX
struct iob_queue_s txtstampq; /* Timestamped frames to loop back */

/* Per TX descriptor: the copy of the frame that is waiting for its
* timestamp, and its buffer, because the MAC writes the timestamp over
* the address of the buffer in the descriptor.
*/

struct iob_s *txmeta[CONFIG_STM32_ETH_NTXDESC];
uint32_t txmetabuf[CONFIG_STM32_ETH_NTXDESC];
#endif

#if defined(CONFIG_STM32_ETH_PTP) && defined(CONFIG_PTP_CLOCK)
struct ptp_lowerhalf_s ptp_lower; /* PTP hardware clock lower half */
#endif
Expand Down Expand Up @@ -856,6 +868,9 @@ static int stm32_recvframe(struct stm32_ethmac_s *priv);
static void stm32_receive(struct stm32_ethmac_s *priv);
static void stm32_freeframe(struct stm32_ethmac_s *priv);
static void stm32_txdone(struct stm32_ethmac_s *priv);
#ifdef CONFIG_STM32_ETH_TIMESTAMP_TX
static void stm32_txtstamp_flush(struct stm32_ethmac_s *priv);
#endif

static void stm32_interrupt_work(void *arg);
static int stm32_interrupt(int irq, void *context, void *arg);
Expand Down Expand Up @@ -1199,6 +1214,23 @@ static struct eth_desc_s *stm32_get_next_txdesc(struct stm32_ethmac_s *priv,
return &next->desc;
}

#ifdef CONFIG_STM32_ETH_TIMESTAMP_TX
/****************************************************************************
* Function: stm32_txindex
*
* Description:
* Get the position of a TX descriptor in the ring. The descriptors of the
* ring are the size of the union that also holds an RX descriptor.
*
****************************************************************************/

static inline int stm32_txindex(struct stm32_ethmac_s *priv,
struct eth_desc_s *txdesc)
{
return (union stm32_desc_u *)txdesc - (union stm32_desc_u *)priv->txchbase;
}
#endif

/****************************************************************************
* Function: stm32_transmit
*
Expand Down Expand Up @@ -1363,6 +1395,31 @@ static int stm32_transmit(struct stm32_ethmac_s *priv)
DEBUGASSERT(priv->dev.d_len <= CONFIG_NET_ETH_PKTSIZE);
txdesc->des2 = priv->dev.d_len | ETH_TDES2_RD_IOC;

#ifdef CONFIG_STM32_ETH_TIMESTAMP_TX
/* If a packet socket asked for the transmit timestamp, keep a copy of
* the frame to loop back with it, and ask the MAC to timestamp.
*/

if (priv->dev.d_iob != NULL && priv->dev.d_iob->io_conn != NULL)
{
struct iob_s *clone = netdev_iob_clone(&priv->dev, false);

if (clone != NULL)
{
int txindex = stm32_txindex(priv, txdesc);

clone->io_conn = priv->dev.d_iob->io_conn;
priv->txmeta[txindex] = clone;
priv->txmetabuf[txindex] = (uint32_t)priv->dev.d_buf;
txdesc->des2 |= ETH_TDES2_RD_TTSE;
}
else
{
nerr("ERROR: Failed to clone the IOB for the TX timestamp\n");
}
}
#endif

/* The single descriptor is both the first and last segment. */

/* Set OWN bit of the TX descriptor des3. This gives the buffer to
Expand Down Expand Up @@ -2134,6 +2191,43 @@ static int stm32_recvframe(struct stm32_ethmac_s *priv)
return -EAGAIN;
}

#ifdef CONFIG_STM32_ETH_TIMESTAMP_TX
/****************************************************************************
* Function: stm32_txtstamp_flush
*
* Description:
* Give the frames that have been transmitted, with their hardware
* timestamp, back to the network stack, that delivers them to the error
* queue of the packet socket that asked for it.
*
* Assumptions:
* The network is locked.
*
****************************************************************************/

static void stm32_txtstamp_flush(struct stm32_ethmac_s *priv)
{
struct net_driver_s *dev = &priv->dev;
struct iob_s *iob;

while ((iob = iob_remove_queue(&priv->txtstampq)) != NULL)
{
dev->d_iob = iob;
dev->d_len = iob->io_pktlen;

#ifdef CONFIG_NET_PKT
pkt_input(dev);
#endif

dev->d_iob = NULL;
dev->d_len = 0;

iob->io_conn = NULL;
iob_free_chain(iob);
}
}
#endif /* CONFIG_STM32_ETH_TIMESTAMP_TX */

/****************************************************************************
* Function: stm32_receive
*
Expand All @@ -2155,6 +2249,12 @@ static void stm32_receive(struct stm32_ethmac_s *priv)
{
struct net_driver_s *dev = &priv->dev;

#ifdef CONFIG_STM32_ETH_TIMESTAMP_TX
/* Loop back the frames that have their transmit timestamp first */

stm32_txtstamp_flush(priv);
#endif

/* Loop while while stm32_recvframe() successfully retrieves valid
* Ethernet frames.
*/
Expand Down Expand Up @@ -2334,6 +2434,11 @@ static void stm32_freeframe(struct stm32_ethmac_s *priv)
{
struct eth_desc_s *txdesc;
uint32_t des3_tmp;
uint8_t *buffer;
#ifdef CONFIG_STM32_ETH_TIMESTAMP_TX
struct iob_s *clone;
int txindex;
#endif

ninfo("txhead: %p txtail: %p inflight: %d\n",
priv->txhead, priv->txtail, priv->inflight);
Expand All @@ -2360,11 +2465,40 @@ static void stm32_freeframe(struct stm32_ethmac_s *priv)
" des2: %08" PRIx32 " des3: %08" PRIx32 "\n",
txdesc, txdesc->des0, txdesc->des2, txdesc->des3);

DEBUGASSERT(txdesc->des0 != 0);
buffer = (uint8_t *)txdesc->des0;

#ifdef CONFIG_STM32_ETH_TIMESTAMP_TX
txindex = stm32_txindex(priv, txdesc);
clone = priv->txmeta[txindex];
if (clone != NULL)
{
/* The MAC wrote the timestamp over the buffer address, and
* the seconds over the second word. All ones is not valid.
*/

buffer = (uint8_t *)priv->txmetabuf[txindex];
priv->txmeta[txindex] = NULL;

if ((txdesc->des3 & ETH_TDES3_WB_TTSS) != 0 &&
(txdesc->des0 != UINT32_MAX ||
txdesc->des1 != UINT32_MAX))
{
clone->io_time.tv_sec = txdesc->des1;
clone->io_time.tv_nsec = txdesc->des0;
iob_add_queue(clone, &priv->txtstampq);
}
else
{
iob_free_chain(clone);
}
}
#endif

DEBUGASSERT(buffer != NULL);

/* Yes.. Free the buffer */

stm32_freebuffer(priv, (uint8_t *)txdesc->des0);
stm32_freebuffer(priv, buffer);

/* In any event, make sure that des0-3 are nullified. */

Expand Down Expand Up @@ -2453,6 +2587,12 @@ static void stm32_txdone(struct stm32_ethmac_s *priv)

stm32_freeframe(priv);

#ifdef CONFIG_STM32_ETH_TIMESTAMP_TX
/* Loop back the frames that have their transmit timestamp */

stm32_txtstamp_flush(priv);
#endif

/* If no further xmits are pending, then cancel the TX timeout */

if (priv->inflight <= 0)
Expand Down Expand Up @@ -2796,6 +2936,9 @@ static int stm32_ifdown(struct net_driver_s *dev)
{
struct stm32_ethmac_s *priv = (struct stm32_ethmac_s *)dev->d_private;
irqstate_t flags;
#ifdef CONFIG_STM32_ETH_TIMESTAMP_TX
int i;
#endif

ninfo("Taking the network down\n");

Expand All @@ -2815,6 +2958,20 @@ static int stm32_ifdown(struct net_driver_s *dev)

stm32_ethreset(priv);

#ifdef CONFIG_STM32_ETH_TIMESTAMP_TX
/* Drop the frames that were waiting for their transmit timestamp */

iob_free_queue(&priv->txtstampq);
for (i = 0; i < CONFIG_STM32_ETH_NTXDESC; i++)
{
if (priv->txmeta[i] != NULL)
{
iob_free_chain(priv->txmeta[i]);
priv->txmeta[i] = NULL;
}
}
#endif

/* Mark the device "down" */

priv->ifup = false;
Expand Down
Loading