xref: /OK3568_Linux_fs/kernel/include/scsi/fc/fc_fcoe.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright(c) 2007 Intel Corporation. All rights reserved.
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Maintained at www.Open-FCoE.org
6*4882a593Smuzhiyun  */
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #ifndef _FC_FCOE_H_
9*4882a593Smuzhiyun #define	_FC_FCOE_H_
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun /*
12*4882a593Smuzhiyun  * FCoE - Fibre Channel over Ethernet.
13*4882a593Smuzhiyun  * See T11 FC-BB-5 Rev 2.00 (09-056v5.pdf)
14*4882a593Smuzhiyun  */
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun /*
17*4882a593Smuzhiyun  * Default FC_FCOE_OUI / FC-MAP value.
18*4882a593Smuzhiyun  */
19*4882a593Smuzhiyun #define	FC_FCOE_OUI	0x0efc00	/* upper 24 bits of FCOE MAC */
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun /*
22*4882a593Smuzhiyun  * Fabric Login (FLOGI) MAC for non-FIP use.  Non-FIP use is deprecated.
23*4882a593Smuzhiyun  */
24*4882a593Smuzhiyun #define	FC_FCOE_FLOGI_MAC { 0x0e, 0xfc, 0x00, 0xff, 0xff, 0xfe }
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun #define	FC_FCOE_VER	0			/* version */
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun /*
29*4882a593Smuzhiyun  * Ethernet Addresses based on FC S_ID and D_ID.
30*4882a593Smuzhiyun  * Generated by FC_FCOE_OUI | S_ID/D_ID
31*4882a593Smuzhiyun  */
32*4882a593Smuzhiyun #define	FC_FCOE_ENCAPS_ID(n)	(((u64) FC_FCOE_OUI << 24) | (n))
33*4882a593Smuzhiyun #define	FC_FCOE_DECAPS_ID(n)	((n) >> 24)
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun /*
36*4882a593Smuzhiyun  * FCoE frame header - 14 bytes
37*4882a593Smuzhiyun  * This follows the VLAN header, which includes the ethertype.
38*4882a593Smuzhiyun  */
39*4882a593Smuzhiyun struct fcoe_hdr {
40*4882a593Smuzhiyun 	__u8		fcoe_ver;	/* version field - upper 4 bits */
41*4882a593Smuzhiyun 	__u8		fcoe_resvd[12];	/* reserved - send zero and ignore */
42*4882a593Smuzhiyun 	__u8		fcoe_sof;	/* start of frame per RFC 3643 */
43*4882a593Smuzhiyun };
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun #define FC_FCOE_DECAPS_VER(hp)	    ((hp)->fcoe_ver >> 4)
46*4882a593Smuzhiyun #define FC_FCOE_ENCAPS_VER(hp, ver) ((hp)->fcoe_ver = (ver) << 4)
47*4882a593Smuzhiyun 
48*4882a593Smuzhiyun /*
49*4882a593Smuzhiyun  * FCoE CRC & EOF - 8 bytes.
50*4882a593Smuzhiyun  */
51*4882a593Smuzhiyun struct fcoe_crc_eof {
52*4882a593Smuzhiyun 	__le32		fcoe_crc32;	/* CRC for FC packet */
53*4882a593Smuzhiyun 	__u8		fcoe_eof;	/* EOF from RFC 3643 */
54*4882a593Smuzhiyun 	__u8		fcoe_resvd[3];	/* reserved - send zero and ignore */
55*4882a593Smuzhiyun } __attribute__((packed));
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun /*
58*4882a593Smuzhiyun  * Minimum FCoE + FC header length
59*4882a593Smuzhiyun  * 14 bytes FCoE header + 24 byte FC header = 38 bytes
60*4882a593Smuzhiyun  */
61*4882a593Smuzhiyun #define FCOE_HEADER_LEN 38
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun /*
64*4882a593Smuzhiyun  * Minimum FCoE frame size
65*4882a593Smuzhiyun  * 14 bytes FCoE header + 24 byte FC header + 8 byte FCoE trailer = 46 bytes
66*4882a593Smuzhiyun  */
67*4882a593Smuzhiyun #define FCOE_MIN_FRAME 46
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun /*
70*4882a593Smuzhiyun  * FCoE Link Error Status Block: T11 FC-BB-5 Rev2.0, Clause 7.10.
71*4882a593Smuzhiyun  */
72*4882a593Smuzhiyun struct fcoe_fc_els_lesb {
73*4882a593Smuzhiyun 	__be32		lesb_link_fail;	/* link failure count */
74*4882a593Smuzhiyun 	__be32		lesb_vlink_fail; /* virtual link failure count */
75*4882a593Smuzhiyun 	__be32		lesb_miss_fka;	/* missing FIP keep-alive count */
76*4882a593Smuzhiyun 	__be32		lesb_symb_err;	/* symbol error during carrier count */
77*4882a593Smuzhiyun 	__be32		lesb_err_block;	/* errored block count */
78*4882a593Smuzhiyun 	__be32		lesb_fcs_error; /* frame check sequence error count */
79*4882a593Smuzhiyun };
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun /*
82*4882a593Smuzhiyun  * fc_fcoe_set_mac - Store OUI + DID into MAC address field.
83*4882a593Smuzhiyun  * @mac: mac address to be set
84*4882a593Smuzhiyun  * @did: fc dest id to use
85*4882a593Smuzhiyun  */
fc_fcoe_set_mac(u8 * mac,u8 * did)86*4882a593Smuzhiyun static inline void fc_fcoe_set_mac(u8 *mac, u8 *did)
87*4882a593Smuzhiyun {
88*4882a593Smuzhiyun 	mac[0] = (u8) (FC_FCOE_OUI >> 16);
89*4882a593Smuzhiyun 	mac[1] = (u8) (FC_FCOE_OUI >> 8);
90*4882a593Smuzhiyun 	mac[2] = (u8) FC_FCOE_OUI;
91*4882a593Smuzhiyun 	mac[3] = did[0];
92*4882a593Smuzhiyun 	mac[4] = did[1];
93*4882a593Smuzhiyun 	mac[5] = did[2];
94*4882a593Smuzhiyun }
95*4882a593Smuzhiyun 
96*4882a593Smuzhiyun #endif /* _FC_FCOE_H_ */
97