[Midnightbsd-cvs] src [8430] trunk/sys/dev/netmap/ixgbe_netmap.h: reword comment

[laffer1 at midnightbsd.org]

Revision: 8430
          http://svnweb.midnightbsd.org/src/?rev=8430
Author:   laffer1
Date:     2016-09-18 17:13:36 -0400 (Sun, 18 Sep 2016)
Log Message:
-----------
reword comment

Modified Paths:
--------------
    trunk/sys/dev/netmap/ixgbe_netmap.h

Modified: trunk/sys/dev/netmap/ixgbe_netmap.h
===================================================================
--- trunk/sys/dev/netmap/ixgbe_netmap.h	2016-09-18 21:13:20 UTC (rev 8429)
+++ trunk/sys/dev/netmap/ixgbe_netmap.h	2016-09-18 21:13:36 UTC (rev 8430)
@@ -198,14 +198,17 @@
  * Reconcile kernel and user view of the transmit ring.
  * This routine might be called frequently so it must be efficient.
  *
- * Userspace has filled tx slots up to ring->cur (excluded).
- * The last unused slot previously known to the kernel was kring->nkr_hwcur,
- * and the last interrupt reported kring->nr_hwavail slots available.
+ * ring->cur holds the userspace view of the current ring index.  Userspace
+ * has filled the tx slots from the previous call's ring->cur up to but not
+ * including ring->cur for this call.  In this function the kernel updates
+ * kring->nr_hwcur to ring->cur, thus slots [kring->nr_hwcur, ring->cur) are
+ * now ready to transmit.  At the last interrupt kring->nr_hwavail slots were
+ * available.
  *
  * This function runs under lock (acquired from the caller or internally).
  * It must first update ring->avail to what the kernel knows,
- * subtract the newly used slots (ring->cur - kring->nkr_hwcur)
- * from both avail and nr_hwavail, and set ring->nkr_hwcur = ring->cur
+ * subtract the newly used slots (ring->cur - kring->nr_hwcur)
+ * from both avail and nr_hwavail, and set ring->nr_hwcur = ring->cur
  * issuing a dmamap_sync on all slots.
  *
  * Since ring comes from userspace, its content must be read only once,