include/scsi/libfcoe.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
3  * Copyright (c) 2008-2009 Cisco Systems, Inc.  All rights reserved.
4  * Copyright (c) 2007-2008 Intel Corporation.  All rights reserved.
6  * Maintained at www.Open-FCoE.org
39  * enum fip_state - internal state of FCoE controller.
42  * @FIP_ST_AUTO:	determining whether to use FIP or non-FIP mode.
43  * @FIP_ST_NON_FIP:	non-FIP mode selected.
77  * struct fcoe_ctlr - FCoE Controller and FIP state
78  * @state:	   internal FIP state for network link and FIP or non-FIP mode.
79  * @mode:	   LLD-selected mode.
80  * @lp:		   &fc_lport: libfc local port.
87  * @port_ka_time:  time of next port keep-alive.
88  * @ctlr_ka_time:  time of next controller keep-alive.
90  * @timer_work:	   &work_struct for doing keep-alives and resets.
94  * @rnd_state:	   state for pseudo-random number generator.
95  * @port_id:	   proposed or selected local-port ID.
100  * @map_dest:	   use the FC_MAP mode for destination MAC addresses.
102  * @spma:	   supports SPMA server-provided MACs mode
105  * @dest_addr:	   MAC address of the selected FC forwarder.
106  * @ctl_src_addr:  the native MAC address of our local port.
107  * @send:	   LLD-supplied function to handle sending FIP Ethernet frames
108  * @update_mac:    LLD-supplied function to handle changes to MAC addresses.
109  * @get_src_addr:  LLD-supplied function to supply a source MAC address.
114  * needed by all FCoE low-level drivers (LLDs) as well as internal state
158  * fcoe_ctlr_priv() - Return the private data from a fcoe_ctlr
170 	(x)->cdev
173  * struct fcoe_fcf - Fibre-Channel Forwarder
183  * @fcf_mac:	 Ethernet address of the FCF for FIP traffic
184  * @fcoe_mac:	 Ethernet address of the FCF for FCoE traffic
189  * @fka_period:	 keep-alive period, in jiffies
191  * A Fibre-Channel Forwarder (FCF) is the entity on the Ethernet that
220 	((x)->fcf_dev)
223  * struct fcoe_rport - VN2VN remote port
228  * @enode_mac:	E_Node control MAC address
229  * @vn_mac:	VN_Node assigned MAC address for data
252 u64 fcoe_wwn_from_mac(unsigned char mac[], unsigned int, unsigned int);
267  * is_fip_mode() - returns true if FIP mode selected.
272 	return fip->state == FIP_ST_ENABLED;  in is_fip_mode()
276  * modpost would use pci_device_id table to auto-generate formatted module alias
282 	MODULE_ALIAS("fcoe-pci:"	\
289 /* struct fcoe_transport - The FCoE transport interface
294  * @alloc:      handler to allocate per-instance FCoE structures
297  * @destroy:    handler to delete per-instance FCoE structures
315  * struct fcoe_percpu_s - The context for FCoE receive thread(s)
332  * struct fcoe_port - The FCoE private structure
335  * @lport:		       The associated local port
343  * @data_srt_addr:	       Source address for data
362  * fcoe_get_netdev() - Return the net device associated with a local port
363  * @lport: The local port to get the net device from
369 	return (port->get_netdev) ? port->get_netdev(lport) : NULL;  in fcoe_get_netdev()