libfcoe.h 13 KB

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