^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0-only */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Copyright (c) 2008-2009 Cisco Systems, Inc. All rights reserved.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) * Copyright (c) 2007-2008 Intel Corporation. All rights reserved.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) * Maintained at www.Open-FCoE.org
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) #ifndef _LIBFCOE_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) #define _LIBFCOE_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) #include <linux/etherdevice.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #include <linux/if_ether.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #include <linux/netdevice.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) #include <linux/skbuff.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #include <linux/workqueue.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) #include <linux/random.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) #include <scsi/fc/fc_fcoe.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #include <scsi/libfc.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) #include <scsi/fcoe_sysfs.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #define FCOE_MAX_CMD_LEN 16 /* Supported CDB length */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) * Max MTU for FCoE: 14 (FCoE header) + 24 (FC header) + 2112 (max FC payload)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) * + 4 (FC CRC) + 4 (FCoE trailer) = 2158 bytes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) #define FCOE_MTU 2158
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) * FIP tunable parameters.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) #define FCOE_CTLR_START_DELAY 2000 /* mS after first adv. to choose FCF */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) #define FCOE_CTLR_SOL_TOV 2000 /* min. solicitation interval (mS) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) #define FCOE_CTLR_FCF_LIMIT 20 /* max. number of FCF entries */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) #define FCOE_CTLR_VN2VN_LOGIN_LIMIT 3 /* max. VN2VN rport login retries */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) * enum fip_state - internal state of FCoE controller.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) * @FIP_ST_DISABLED: controller has been disabled or not yet enabled.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) * @FIP_ST_LINK_WAIT: the physical link is down or unusable.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) * @FIP_ST_AUTO: determining whether to use FIP or non-FIP mode.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) * @FIP_ST_NON_FIP: non-FIP mode selected.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) * @FIP_ST_ENABLED: FIP mode selected.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) * @FIP_ST_VNMP_START: VN2VN multipath mode start, wait
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) * @FIP_ST_VNMP_PROBE1: VN2VN sent first probe, listening
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) * @FIP_ST_VNMP_PROBE2: VN2VN sent second probe, listening
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) * @FIP_ST_VNMP_CLAIM: VN2VN sent claim, waiting for responses
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) * @FIP_ST_VNMP_UP: VN2VN multipath mode operation
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) enum fip_state {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) FIP_ST_DISABLED,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) FIP_ST_LINK_WAIT,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) FIP_ST_AUTO,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) FIP_ST_NON_FIP,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) FIP_ST_ENABLED,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) FIP_ST_VNMP_START,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) FIP_ST_VNMP_PROBE1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) FIP_ST_VNMP_PROBE2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) FIP_ST_VNMP_CLAIM,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) FIP_ST_VNMP_UP,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) * Modes:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) * The mode is the state that is to be entered after link up.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) * It must not change after fcoe_ctlr_init() sets it.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) enum fip_mode {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) FIP_MODE_AUTO,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) FIP_MODE_NON_FIP,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) FIP_MODE_FABRIC,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) FIP_MODE_VN2VN,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) * struct fcoe_ctlr - FCoE Controller and FIP state
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) * @state: internal FIP state for network link and FIP or non-FIP mode.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) * @mode: LLD-selected mode.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) * @lp: &fc_lport: libfc local port.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) * @sel_fcf: currently selected FCF, or NULL.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) * @fcfs: list of discovered FCFs.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) * @cdev: (Optional) pointer to sysfs fcoe_ctlr_device.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) * @fcf_count: number of discovered FCF entries.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) * @sol_time: time when a multicast solicitation was last sent.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) * @sel_time: time after which to select an FCF.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) * @port_ka_time: time of next port keep-alive.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) * @ctlr_ka_time: time of next controller keep-alive.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) * @timer: timer struct used for all delayed events.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) * @timer_work: &work_struct for doing keep-alives and resets.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) * @recv_work: &work_struct for receiving FIP frames.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) * @fip_recv_list: list of received FIP frames.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) * @flogi_req: clone of FLOGI request sent
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) * @rnd_state: state for pseudo-random number generator.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) * @port_id: proposed or selected local-port ID.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) * @user_mfs: configured maximum FC frame size, including FC header.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) * @flogi_oxid: exchange ID of most recent fabric login.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) * @flogi_req_send: send of FLOGI requested
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) * @flogi_count: number of FLOGI attempts in AUTO mode.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) * @map_dest: use the FC_MAP mode for destination MAC addresses.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) * @fip_resp: start FIP VLAN discovery responder
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) * @spma: supports SPMA server-provided MACs mode
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) * @probe_tries: number of FC_IDs probed
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) * @priority: DCBx FCoE APP priority
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) * @dest_addr: MAC address of the selected FC forwarder.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) * @ctl_src_addr: the native MAC address of our local port.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) * @send: LLD-supplied function to handle sending FIP Ethernet frames
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) * @update_mac: LLD-supplied function to handle changes to MAC addresses.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) * @get_src_addr: LLD-supplied function to supply a source MAC address.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) * @ctlr_mutex: lock protecting this structure.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) * @ctlr_lock: spinlock covering flogi_req
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) * This structure is used by all FCoE drivers. It contains information
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) * needed by all FCoE low-level drivers (LLDs) as well as internal state
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) * for FIP, and fields shared with the LLDS.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) struct fcoe_ctlr {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) enum fip_state state;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) enum fip_mode mode;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) struct fc_lport *lp;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) struct fcoe_fcf *sel_fcf;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) struct list_head fcfs;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) struct fcoe_ctlr_device *cdev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) u16 fcf_count;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) unsigned long sol_time;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) unsigned long sel_time;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) unsigned long port_ka_time;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) unsigned long ctlr_ka_time;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) struct timer_list timer;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) struct work_struct timer_work;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) struct work_struct recv_work;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) struct sk_buff_head fip_recv_list;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) struct sk_buff *flogi_req;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) struct rnd_state rnd_state;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) u32 port_id;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) u16 user_mfs;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) u16 flogi_oxid;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) u8 flogi_req_send;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) u8 flogi_count;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) bool map_dest;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) bool fip_resp;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) u8 spma;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) u8 probe_tries;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) u8 priority;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) u8 dest_addr[ETH_ALEN];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) u8 ctl_src_addr[ETH_ALEN];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) void (*send)(struct fcoe_ctlr *, struct sk_buff *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) void (*update_mac)(struct fc_lport *, u8 *addr);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) u8 * (*get_src_addr)(struct fc_lport *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) struct mutex ctlr_mutex;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) spinlock_t ctlr_lock;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) * fcoe_ctlr_priv() - Return the private data from a fcoe_ctlr
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) * @cltr: The fcoe_ctlr whose private data will be returned
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) static inline void *fcoe_ctlr_priv(const struct fcoe_ctlr *ctlr)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) return (void *)(ctlr + 1);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) * This assumes that the fcoe_ctlr (x) is allocated with the fcoe_ctlr_device.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) #define fcoe_ctlr_to_ctlr_dev(x) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) (x)->cdev
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) * struct fcoe_fcf - Fibre-Channel Forwarder
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) * @list: list linkage
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) * @event_work: Work for FC Transport actions queue
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) * @event: The event to be processed
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) * @fip: The controller that the FCF was discovered on
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) * @fcf_dev: The associated fcoe_fcf_device instance
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) * @time: system time (jiffies) when an advertisement was last received
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) * @switch_name: WWN of switch from advertisement
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) * @fabric_name: WWN of fabric from advertisement
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) * @fc_map: FC_MAP value from advertisement
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) * @fcf_mac: Ethernet address of the FCF for FIP traffic
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) * @fcoe_mac: Ethernet address of the FCF for FCoE traffic
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) * @vfid: virtual fabric ID
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) * @pri: selection priority, smaller values are better
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) * @flogi_sent: current FLOGI sent to this FCF
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) * @flags: flags received from advertisement
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) * @fka_period: keep-alive period, in jiffies
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) * A Fibre-Channel Forwarder (FCF) is the entity on the Ethernet that
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) * passes FCoE frames on to an FC fabric. This structure represents
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) * one FCF from which advertisements have been received.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) * When looking up an FCF, @switch_name, @fabric_name, @fc_map, @vfid, and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) * @fcf_mac together form the lookup key.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) struct fcoe_fcf {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) struct list_head list;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) struct work_struct event_work;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) struct fcoe_ctlr *fip;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) struct fcoe_fcf_device *fcf_dev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) unsigned long time;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) u64 switch_name;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) u64 fabric_name;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) u32 fc_map;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208) u16 vfid;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209) u8 fcf_mac[ETH_ALEN];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210) u8 fcoe_mac[ETH_ALEN];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 211)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 212) u8 pri;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 213) u8 flogi_sent;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 214) u16 flags;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 215) u32 fka_period;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 216) u8 fd_flags:1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 217) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 218)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 219) #define fcoe_fcf_to_fcf_dev(x) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 220) ((x)->fcf_dev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 221)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 222) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 223) * struct fcoe_rport - VN2VN remote port
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 224) * @time: time of create or last beacon packet received from node
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 225) * @fcoe_len: max FCoE frame size, not including VLAN or Ethernet headers
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 226) * @flags: flags from probe or claim
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 227) * @login_count: number of unsuccessful rport logins to this port
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 228) * @enode_mac: E_Node control MAC address
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 229) * @vn_mac: VN_Node assigned MAC address for data
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 230) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 231) struct fcoe_rport {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 232) struct fc_rport_priv rdata;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 233) unsigned long time;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 234) u16 fcoe_len;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 235) u16 flags;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 236) u8 login_count;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 237) u8 enode_mac[ETH_ALEN];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 238) u8 vn_mac[ETH_ALEN];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 239) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 240)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 241) /* FIP API functions */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 242) void fcoe_ctlr_init(struct fcoe_ctlr *, enum fip_mode);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 243) void fcoe_ctlr_destroy(struct fcoe_ctlr *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 244) void fcoe_ctlr_link_up(struct fcoe_ctlr *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 245) int fcoe_ctlr_link_down(struct fcoe_ctlr *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 246) int fcoe_ctlr_els_send(struct fcoe_ctlr *, struct fc_lport *, struct sk_buff *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 247) void fcoe_ctlr_recv(struct fcoe_ctlr *, struct sk_buff *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 248) int fcoe_ctlr_recv_flogi(struct fcoe_ctlr *, struct fc_lport *,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 249) struct fc_frame *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 250)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 251) /* libfcoe funcs */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 252) u64 fcoe_wwn_from_mac(unsigned char mac[MAX_ADDR_LEN], unsigned int, unsigned int);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 253) int fcoe_libfc_config(struct fc_lport *, struct fcoe_ctlr *,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 254) const struct libfc_function_template *, int init_fcp);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 255) u32 fcoe_fc_crc(struct fc_frame *fp);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 256) int fcoe_start_io(struct sk_buff *skb);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 257) int fcoe_get_wwn(struct net_device *netdev, u64 *wwn, int type);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 258) void __fcoe_get_lesb(struct fc_lport *lport, struct fc_els_lesb *fc_lesb,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 259) struct net_device *netdev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 260) void fcoe_wwn_to_str(u64 wwn, char *buf, int len);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 261) int fcoe_validate_vport_create(struct fc_vport *vport);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 262) int fcoe_link_speed_update(struct fc_lport *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 263) void fcoe_get_lesb(struct fc_lport *, struct fc_els_lesb *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 264) void fcoe_ctlr_get_lesb(struct fcoe_ctlr_device *ctlr_dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 265)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 266) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 267) * is_fip_mode() - returns true if FIP mode selected.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 268) * @fip: FCoE controller.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 269) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 270) static inline bool is_fip_mode(struct fcoe_ctlr *fip)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 271) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 272) return fip->state == FIP_ST_ENABLED;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 273) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 274)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 275) /* helper for FCoE SW HBA drivers, can include subven and subdev if needed. The
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 276) * modpost would use pci_device_id table to auto-generate formatted module alias
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 277) * into the corresponding .mod.c file, but there may or may not be a pci device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 278) * id table for FCoE drivers so we use the following helper for build the fcoe
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 279) * driver module alias.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 280) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 281) #define MODULE_ALIAS_FCOE_PCI(ven, dev) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 282) MODULE_ALIAS("fcoe-pci:" \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 283) "v" __stringify(ven) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 284) "d" __stringify(dev) "sv*sd*bc*sc*i*")
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 285)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 286) /* the name of the default FCoE transport driver fcoe.ko */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 287) #define FCOE_TRANSPORT_DEFAULT "fcoe"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 288)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 289) /* struct fcoe_transport - The FCoE transport interface
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 290) * @name: a vendor specific name for their FCoE transport driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 291) * @attached: whether this transport is already attached
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 292) * @list: list linkage to all attached transports
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 293) * @match: handler to allow the transport driver to match up a given netdev
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 294) * @alloc: handler to allocate per-instance FCoE structures
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 295) * (no discovery or login)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 296) * @create: handler to sysfs entry of create for FCoE instances
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 297) * @destroy: handler to delete per-instance FCoE structures
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 298) * (frees all memory)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 299) * @enable: handler to sysfs entry of enable for FCoE instances
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 300) * @disable: handler to sysfs entry of disable for FCoE instances
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 301) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 302) struct fcoe_transport {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 303) char name[IFNAMSIZ];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 304) bool attached;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 305) struct list_head list;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 306) bool (*match) (struct net_device *device);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 307) int (*alloc) (struct net_device *device);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 308) int (*create) (struct net_device *device, enum fip_mode fip_mode);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 309) int (*destroy) (struct net_device *device);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 310) int (*enable) (struct net_device *device);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 311) int (*disable) (struct net_device *device);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 312) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 313)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 314) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 315) * struct fcoe_percpu_s - The context for FCoE receive thread(s)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 316) * @kthread: The thread context (used by bnx2fc)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 317) * @work: The work item (used by fcoe)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 318) * @fcoe_rx_list: The queue of pending packets to process
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 319) * @page: The memory page for calculating frame trailer CRCs
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 320) * @crc_eof_offset: The offset into the CRC page pointing to available
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 321) * memory for a new trailer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 322) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 323) struct fcoe_percpu_s {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 324) struct task_struct *kthread;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 325) struct work_struct work;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 326) struct sk_buff_head fcoe_rx_list;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 327) struct page *crc_eof_page;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 328) int crc_eof_offset;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 329) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 330)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 331) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 332) * struct fcoe_port - The FCoE private structure
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 333) * @priv: The associated fcoe interface. The structure is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 334) * defined by the low level driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 335) * @lport: The associated local port
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 336) * @fcoe_pending_queue: The pending Rx queue of skbs
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 337) * @fcoe_pending_queue_active: Indicates if the pending queue is active
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 338) * @max_queue_depth: Max queue depth of pending queue
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 339) * @min_queue_depth: Min queue depth of pending queue
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 340) * @timer: The queue timer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 341) * @destroy_work: Handle for work context
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 342) * (to prevent RTNL deadlocks)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 343) * @data_srt_addr: Source address for data
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 344) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 345) * An instance of this structure is to be allocated along with the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 346) * Scsi_Host and libfc fc_lport structures.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 347) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 348) struct fcoe_port {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 349) void *priv;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 350) struct fc_lport *lport;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 351) struct sk_buff_head fcoe_pending_queue;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 352) u8 fcoe_pending_queue_active;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 353) u32 max_queue_depth;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 354) u32 min_queue_depth;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 355) struct timer_list timer;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 356) struct work_struct destroy_work;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 357) u8 data_src_addr[ETH_ALEN];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 358) struct net_device * (*get_netdev)(const struct fc_lport *lport);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 359) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 360)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 361) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 362) * fcoe_get_netdev() - Return the net device associated with a local port
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 363) * @lport: The local port to get the net device from
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 364) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 365) static inline struct net_device *fcoe_get_netdev(const struct fc_lport *lport)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 366) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 367) struct fcoe_port *port = ((struct fcoe_port *)lport_priv(lport));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 368)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 369) return (port->get_netdev) ? port->get_netdev(lport) : NULL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 370) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 371)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 372) void fcoe_clean_pending_queue(struct fc_lport *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 373) void fcoe_check_wait_queue(struct fc_lport *lport, struct sk_buff *skb);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 374) void fcoe_queue_timer(struct timer_list *t);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 375) int fcoe_get_paged_crc_eof(struct sk_buff *skb, int tlen,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 376) struct fcoe_percpu_s *fps);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 377)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 378) /* FCoE Sysfs helpers */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 379) void fcoe_fcf_get_selected(struct fcoe_fcf_device *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 380) void fcoe_ctlr_set_fip_mode(struct fcoe_ctlr_device *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 381)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 382) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 383) * struct netdev_list
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 384) * A mapping from netdevice to fcoe_transport
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 385) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 386) struct fcoe_netdev_mapping {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 387) struct list_head list;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 388) struct net_device *netdev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 389) struct fcoe_transport *ft;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 390) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 391)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 392) /* fcoe transports registration and deregistration */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 393) int fcoe_transport_attach(struct fcoe_transport *ft);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 394) int fcoe_transport_detach(struct fcoe_transport *ft);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 395)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 396) /* sysfs store handler for ctrl_control interface */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 397) ssize_t fcoe_ctlr_create_store(struct bus_type *bus,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 398) const char *buf, size_t count);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 399) ssize_t fcoe_ctlr_destroy_store(struct bus_type *bus,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 400) const char *buf, size_t count);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 401)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 402) #endif /* _LIBFCOE_H */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 403)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 404)