Commit e9bce845 authored by Yi Zou's avatar Yi Zou Committed by Jeff Kirsher
Browse files

net: add proper documentation for previously added net_device_ops for FCoE 



Add proper documentation for previously added net_device_ops ops for FCoE.

Signed-off-by: default avatarYi Zou <yi.zou@intel.com>
Signed-off-by: default avatarJeff Kirsher <jeffrey.t.kirsher@intel.com>
parent e2444d92

include/linux/netdevice.h

+36 −0
Original line number Diff line number Diff line
@@ -777,6 +777,42 @@ struct netdev_tc_txq { 
 * 	queues stopped. This allows the netdevice to perform queue management

 * 	safely.

 *

 *	Fiber Channel over Ethernet (FCoE) offload functions.

 * int (*ndo_fcoe_enable)(struct net_device *dev);

 *	Called when the FCoE protocol stack wants to start using LLD for FCoE

 *	so the underlying device can perform whatever needed configuration or

 *	initialization to support acceleration of FCoE traffic.

 *

 * int (*ndo_fcoe_disable)(struct net_device *dev);

 *	Called when the FCoE protocol stack wants to stop using LLD for FCoE

 *	so the underlying device can perform whatever needed clean-ups to

 *	stop supporting acceleration of FCoE traffic.

 *

 * int (*ndo_fcoe_ddp_setup)(struct net_device *dev, u16 xid,

 *			     struct scatterlist *sgl, unsigned int sgc);

 *	Called when the FCoE Initiator wants to initialize an I/O that

 *	is a possible candidate for Direct Data Placement (DDP). The LLD can

 *	perform necessary setup and returns 1 to indicate the device is set up

 *	successfully to perform DDP on this I/O, otherwise this returns 0.

 *

 * int (*ndo_fcoe_ddp_done)(struct net_device *dev,  u16 xid);

 *	Called when the FCoE Initiator/Target is done with the DDPed I/O as

 *	indicated by the FC exchange id 'xid', so the underlying device can

 *	clean up and reuse resources for later DDP requests.

 *

 * int (*ndo_fcoe_ddp_target)(struct net_device *dev, u16 xid,

 *			      struct scatterlist *sgl, unsigned int sgc);

 *	Called when the FCoE Target wants to initialize an I/O that

 *	is a possible candidate for Direct Data Placement (DDP). The LLD can

 *	perform necessary setup and returns 1 to indicate the device is set up

 *	successfully to perform DDP on this I/O, otherwise this returns 0.

 *

 * int (*ndo_fcoe_get_wwn)(struct net_device *dev, u64 *wwn, int type);

 *	Called when the underlying device wants to override default World Wide

 *	Name (WWN) generation mechanism in FCoE protocol stack to pass its own

 *	World Wide Port Name (WWPN) or World Wide Node Name (WWNN) to the FCoE

 *	protocol stack to use.

 *

 *	RFS acceleration.

 * int (*ndo_rx_flow_steer)(struct net_device *dev, const struct sk_buff *skb,

 *			    u16 rxq_index, u32 flow_id);