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
32  * FIP tunable parameters.
40  * enum fip_state - internal state of FCoE controller.
43  * @FIP_ST_AUTO:	determining whether to use FIP or non-FIP mode.
44  * @FIP_ST_NON_FIP:	non-FIP mode selected.
78  * struct fcoe_ctlr - FCoE Controller and FIP state
79  * @state:	   internal FIP state for network link and FIP or non-FIP mode.
80  * @mode:	   LLD-selected mode.
88  * @port_ka_time:  time of next port keep-alive.
89  * @ctlr_ka_time:  time of next controller keep-alive.
91  * @timer_work:	   &work_struct for doing keep-alives and resets.
95  * @rnd_state:	   state for pseudo-random number generator.
96  * @port_id:	   proposed or selected local-port ID.
103  * @spma:	   supports SPMA server-provided MACs mode
108  * @send:	   LLD-supplied function to handle sending FIP Ethernet frames
109  * @update_mac:    LLD-supplied function to handle changes to MAC addresses.
110  * @get_src_addr:  LLD-supplied function to supply a source MAC address.
115  * needed by all FCoE low-level drivers (LLDs) as well as internal state
159  * fcoe_ctlr_priv() - Return the private data from a fcoe_ctlr
171 	(x)->cdev
174  * struct fcoe_fcf - Fibre-Channel Forwarder
190  * @fka_period:	 keep-alive period, in jiffies
192  * A Fibre-Channel Forwarder (FCF) is the entity on the Ethernet that
221 	((x)->fcf_dev)
224  * struct fcoe_rport - VN2VN remote port
269  * is_fip_mode() - returns true if FIP mode selected.
274 	return fip->state == FIP_ST_ENABLED;  in is_fip_mode()
278  * modpost would use pci_device_id table to auto-generate formatted module alias
284 	MODULE_ALIAS("fcoe-pci:"	\
291 /* struct fcoe_transport - The FCoE transport interface
296  * @alloc:      handler to allocate per-instance FCoE structures
299  * @destroy:    handler to delete per-instance FCoE structures
317  * struct fcoe_percpu_s - The context for FCoE receive thread(s)
335  * struct fcoe_port - The FCoE private structure
365  * fcoe_get_netdev() - Return the net device associated with a local port
372 	return (port->get_netdev) ? port->get_netdev(lport) : NULL;  in fcoe_get_netdev()