From: Michael Brown <mcb30@ipxe.org>
Date: Sun, 29 Nov 2020 11:23:41 +0000 (+0000)
Subject: [netdevice] Fix misleading comment on netdev_rx()
X-Git-Tag: v1.21.1~31
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a2e5cf1a3fb7bbffb4136a12daea9145577a3241;p=thirdparty%2Fipxe.git

[netdevice] Fix misleading comment on netdev_rx()

Unlike netdev_rx_err(), there is no valid circumstance under which
netdev_rx() may be called with a null I/O buffer, since a call to
netdev_rx() represents the successful reception of a packet.  Fix the
code comment to reflect this.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---

diff --git a/src/net/netdevice.c b/src/net/netdevice.c
index 754799cd1..6e685630c 100644
--- a/src/net/netdevice.c
+++ b/src/net/netdevice.c
@@ -478,7 +478,7 @@ static void netdev_tx_flush ( struct net_device *netdev ) {
  * Add packet to receive queue
  *
  * @v netdev		Network device
- * @v iobuf		I/O buffer, or NULL
+ * @v iobuf		I/O buffer
  *
  * The packet is added to the network device's RX queue.  This
  * function takes ownership of the I/O buffer.