1/*
2 * Copyright(c) 2007 Intel Corporation. All rights reserved.
3 *
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
11 * more details.
12 *
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
16 *
17 * Maintained at www.Open-FCoE.org
18 */
19
20#ifndef _FC_FCOE_H_
21#define _FC_FCOE_H_
22
23/*
24 * FCoE - Fibre Channel over Ethernet.
25 * See T11 FC-BB-5 Rev 2.00 (09-056v5.pdf)
26 */
27
28/*
29 * Default FC_FCOE_OUI / FC-MAP value.
30 */
31#define FC_FCOE_OUI 0x0efc00 /* upper 24 bits of FCOE MAC */
32
33/*
34 * Fabric Login (FLOGI) MAC for non-FIP use. Non-FIP use is deprecated.
35 */
36#define FC_FCOE_FLOGI_MAC { 0x0e, 0xfc, 0x00, 0xff, 0xff, 0xfe }
37
38#define FC_FCOE_VER 0 /* version */
39
40/*
41 * Ethernet Addresses based on FC S_ID and D_ID.
42 * Generated by FC_FCOE_OUI | S_ID/D_ID
43 */
44#define FC_FCOE_ENCAPS_ID(n) (((u64) FC_FCOE_OUI << 24) | (n))
45#define FC_FCOE_DECAPS_ID(n) ((n) >> 24)
46
47/*
48 * FCoE frame header - 14 bytes
49 * This follows the VLAN header, which includes the ethertype.
50 */
51struct fcoe_hdr {
52 __u8 fcoe_ver; /* version field - upper 4 bits */
53 __u8 fcoe_resvd[12]; /* reserved - send zero and ignore */
54 __u8 fcoe_sof; /* start of frame per RFC 3643 */
55};
56
57#define FC_FCOE_DECAPS_VER(hp) ((hp)->fcoe_ver >> 4)
58#define FC_FCOE_ENCAPS_VER(hp, ver) ((hp)->fcoe_ver = (ver) << 4)
59
60/*
61 * FCoE CRC & EOF - 8 bytes.
62 */
63struct fcoe_crc_eof {
64 __le32 fcoe_crc32; /* CRC for FC packet */
65 __u8 fcoe_eof; /* EOF from RFC 3643 */
66 __u8 fcoe_resvd[3]; /* reserved - send zero and ignore */
67} __attribute__((packed));
68
69/*
70 * Minimum FCoE + FC header length
71 * 14 bytes FCoE header + 24 byte FC header = 38 bytes
72 */
73#define FCOE_HEADER_LEN 38
74
75/*
76 * Minimum FCoE frame size
77 * 14 bytes FCoE header + 24 byte FC header + 8 byte FCoE trailer = 46 bytes
78 */
79#define FCOE_MIN_FRAME 46
80
81/*
82 * FCoE Link Error Status Block: T11 FC-BB-5 Rev2.0, Clause 7.10.
83 */
84struct fcoe_fc_els_lesb {
85 __be32 lesb_link_fail; /* link failure count */
86 __be32 lesb_vlink_fail; /* virtual link failure count */
87 __be32 lesb_miss_fka; /* missing FIP keep-alive count */
88 __be32 lesb_symb_err; /* symbol error during carrier count */
89 __be32 lesb_err_block; /* errored block count */
90 __be32 lesb_fcs_error; /* frame check sequence error count */
91};
92
93/*
94 * fc_fcoe_set_mac - Store OUI + DID into MAC address field.
95 * @mac: mac address to be set
96 * @did: fc dest id to use
97 */
98static inline void fc_fcoe_set_mac(u8 *mac, u8 *did)
99{
100 mac[0] = (u8) (FC_FCOE_OUI >> 16);
101 mac[1] = (u8) (FC_FCOE_OUI >> 8);
102 mac[2] = (u8) FC_FCOE_OUI;
103 mac[3] = did[0];
104 mac[4] = did[1];
105 mac[5] = did[2];
106}
107
108#endif /* _FC_FCOE_H_ */
109