Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 3b582cc1 authored by Stephen Hemminger's avatar Stephen Hemminger Committed by David S. Miller
Browse files

[NET]: docbook fixes for netif_ functions 



Documentation updates for network interfaces.

1. Add doc for netif_napi_add
2. Remove doc for unused returns from netif_rx
3. Add doc for netif_receive_skb

[ Incorporated minor mods from Randy Dunlap -DaveM ]

Signed-off-by: default avatarStephen Hemminger <shemminger@linux-foundation.org>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent d57a9212

include/linux/netdevice.h

+10 −0
Original line number Diff line number Diff line
@@ -739,6 +739,16 @@ static inline void *netdev_priv(const struct net_device *dev) 
 */

#define SET_NETDEV_DEV(net, pdev)	((net)->dev.parent = (pdev))



/**

 *	netif_napi_add - initialize a napi context

 *	@dev:  network device

 *	@napi: napi context

 *	@poll: polling function

 *	@weight: default weight

 *

 * netif_napi_add() must be used to initialize a napi context prior to calling

 * *any* of the other napi related functions.

 */

static inline void netif_napi_add(struct net_device *dev,

				  struct napi_struct *napi,

				  int (*poll)(struct napi_struct *, int),

net/core/dev.c

+15 −3
Original line number Diff line number Diff line
@@ -1751,9 +1751,6 @@ DEFINE_PER_CPU(struct netif_rx_stats, netdev_rx_stat) = { 0, }; 
 *

 *	return values:

 *	NET_RX_SUCCESS	(no congestion)

 *	NET_RX_CN_LOW   (low congestion)

 *	NET_RX_CN_MOD   (moderate congestion)

 *	NET_RX_CN_HIGH  (high congestion)

 *	NET_RX_DROP     (packet was dropped)

 *

 */
@@ -2001,6 +1998,21 @@ static inline struct sk_buff *handle_ing(struct sk_buff *skb, 
}

#endif



/**

 *	netif_receive_skb - process receive buffer from network

 *	@skb: buffer to process

 *

 *	netif_receive_skb() is the main receive data processing function.

 *	It always succeeds. The buffer may be dropped during processing

 *	for congestion control or by the protocol layers.

 *

 *	This function may only be called from softirq context and interrupts

 *	should be enabled.

 *

 *	Return values (usually ignored):

 *	NET_RX_SUCCESS: no congestion

 *	NET_RX_DROP: packet was dropped

 */

int netif_receive_skb(struct sk_buff *skb)

{

	struct packet_type *ptype, *pt_prev;