diff options
| author | Jakub Kicinski <kuba@kernel.org> | 2023-04-06 18:25:32 -0700 |
|---|---|---|
| committer | Jakub Kicinski <kuba@kernel.org> | 2023-04-10 17:56:17 -0700 |
| commit | 8336462539ae751cbf7d59822eb331602a69df99 (patch) | |
| tree | f516108ffd5a580ae892d0794cf1b2296fd539a0 /Documentation | |
| parent | da4f0f82ee9d5a128b48c959e8db7f41b59848c8 (diff) | |
docs: net: use C syntax highlight in driver.rst
Use syntax highlight, comment out the "..." since they are
not valid C.
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/networking/driver.rst | 30 |
1 files changed, 20 insertions, 10 deletions
diff --git a/Documentation/networking/driver.rst b/Documentation/networking/driver.rst index bfbd66871bb3..19c363291d04 100644 --- a/Documentation/networking/driver.rst +++ b/Documentation/networking/driver.rst @@ -43,7 +43,9 @@ there is no way your device can tell ahead of time when its transmit function will become busy. Instead it must maintain the queue properly. For example, -for a driver implementing scatter-gather this means:: +for a driver implementing scatter-gather this means: + +.. code-block:: c static netdev_tx_t drv_hard_start_xmit(struct sk_buff *skb, struct net_device *dev) @@ -51,7 +53,7 @@ for a driver implementing scatter-gather this means:: struct drv *dp = netdev_priv(dev); lock_tx(dp); - ... + //... /* This is a hard error log it. */ if (TX_BUFFS_AVAIL(dp) <= (skb_shinfo(skb)->nr_frags + 1)) { netif_stop_queue(dev); @@ -61,34 +63,42 @@ for a driver implementing scatter-gather this means:: return NETDEV_TX_BUSY; } - ... queue packet to card ... - ... update tx consumer index ... + //... queue packet to card ... + //... update tx consumer index ... if (TX_BUFFS_AVAIL(dp) <= (MAX_SKB_FRAGS + 1)) netif_stop_queue(dev); - ... + //... unlock_tx(dp); - ... + //... return NETDEV_TX_OK; } -And then at the end of your TX reclamation event handling:: +And then at the end of your TX reclamation event handling: + +.. code-block:: c if (netif_queue_stopped(dp->dev) && TX_BUFFS_AVAIL(dp) > (MAX_SKB_FRAGS + 1)) netif_wake_queue(dp->dev); -For a non-scatter-gather supporting card, the three tests simply become:: +For a non-scatter-gather supporting card, the three tests simply become: + +.. code-block:: c /* This is a hard error log it. */ if (TX_BUFFS_AVAIL(dp) <= 0) -and:: +and: + +.. code-block:: c if (TX_BUFFS_AVAIL(dp) == 0) -and:: +and: + +.. code-block:: c if (netif_queue_stopped(dp->dev) && TX_BUFFS_AVAIL(dp) > 0) |