xref: /linux/include/scsi/libfcoe.h (revision b8bb76713ec50df2f11efee386e16f93d51e1076)
1 /*
2  * Copyright(c) 2007 - 2008 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 _LIBFCOE_H
21 #define _LIBFCOE_H
22 
23 #include <linux/netdevice.h>
24 #include <linux/skbuff.h>
25 #include <scsi/fc/fc_fcoe.h>
26 #include <scsi/libfc.h>
27 
28 /*
29  * this percpu struct for fcoe
30  */
31 struct fcoe_percpu_s {
32 	int		cpu;
33 	struct task_struct *thread;
34 	struct sk_buff_head fcoe_rx_list;
35 	struct page *crc_eof_page;
36 	int crc_eof_offset;
37 };
38 
39 /*
40  * the fcoe sw transport private data
41  */
42 struct fcoe_softc {
43 	struct list_head list;
44 	struct fc_lport *lp;
45 	struct net_device *real_dev;
46 	struct net_device *phys_dev;		/* device with ethtool_ops */
47 	struct packet_type  fcoe_packet_type;
48 	struct sk_buff_head fcoe_pending_queue;
49 	u8	fcoe_pending_queue_active;
50 
51 	u8 dest_addr[ETH_ALEN];
52 	u8 ctl_src_addr[ETH_ALEN];
53 	u8 data_src_addr[ETH_ALEN];
54 	/*
55 	 * fcoe protocol address learning related stuff
56 	 */
57 	u16 flogi_oxid;
58 	u8 flogi_progress;
59 	u8 address_mode;
60 };
61 
62 static inline struct net_device *fcoe_netdev(
63 	const struct fc_lport *lp)
64 {
65 	return ((struct fcoe_softc *)lport_priv(lp))->real_dev;
66 }
67 
68 static inline struct fcoe_hdr *skb_fcoe_header(const struct sk_buff *skb)
69 {
70 	return (struct fcoe_hdr *)skb_network_header(skb);
71 }
72 
73 static inline int skb_fcoe_offset(const struct sk_buff *skb)
74 {
75 	return skb_network_offset(skb);
76 }
77 
78 static inline struct fc_frame_header *skb_fc_header(const struct sk_buff *skb)
79 {
80 	return (struct fc_frame_header *)skb_transport_header(skb);
81 }
82 
83 static inline int skb_fc_offset(const struct sk_buff *skb)
84 {
85 	return skb_transport_offset(skb);
86 }
87 
88 static inline void skb_reset_fc_header(struct sk_buff *skb)
89 {
90 	skb_reset_network_header(skb);
91 	skb_set_transport_header(skb, skb_network_offset(skb) +
92 				 sizeof(struct fcoe_hdr));
93 }
94 
95 static inline bool skb_fc_is_data(const struct sk_buff *skb)
96 {
97 	return skb_fc_header(skb)->fh_r_ctl == FC_RCTL_DD_SOL_DATA;
98 }
99 
100 static inline bool skb_fc_is_cmd(const struct sk_buff *skb)
101 {
102 	return skb_fc_header(skb)->fh_r_ctl == FC_RCTL_DD_UNSOL_CMD;
103 }
104 
105 static inline bool skb_fc_has_exthdr(const struct sk_buff *skb)
106 {
107 	return (skb_fc_header(skb)->fh_r_ctl == FC_RCTL_VFTH) ||
108 	    (skb_fc_header(skb)->fh_r_ctl == FC_RCTL_IFRH) ||
109 	    (skb_fc_header(skb)->fh_r_ctl == FC_RCTL_ENCH);
110 }
111 
112 static inline bool skb_fc_is_roff(const struct sk_buff *skb)
113 {
114 	return skb_fc_header(skb)->fh_f_ctl[2] & FC_FC_REL_OFF;
115 }
116 
117 static inline u16 skb_fc_oxid(const struct sk_buff *skb)
118 {
119 	return be16_to_cpu(skb_fc_header(skb)->fh_ox_id);
120 }
121 
122 static inline u16 skb_fc_rxid(const struct sk_buff *skb)
123 {
124 	return be16_to_cpu(skb_fc_header(skb)->fh_rx_id);
125 }
126 
127 /* libfcoe funcs */
128 int fcoe_reset(struct Scsi_Host *shost);
129 u64 fcoe_wwn_from_mac(unsigned char mac[MAX_ADDR_LEN],
130 		      unsigned int scheme, unsigned int port);
131 
132 u32 fcoe_fc_crc(struct fc_frame *fp);
133 int fcoe_xmit(struct fc_lport *, struct fc_frame *);
134 int fcoe_rcv(struct sk_buff *, struct net_device *,
135 	     struct packet_type *, struct net_device *);
136 
137 int fcoe_percpu_receive_thread(void *arg);
138 void fcoe_clean_pending_queue(struct fc_lport *lp);
139 void fcoe_percpu_clean(struct fc_lport *lp);
140 void fcoe_watchdog(ulong vp);
141 int fcoe_link_ok(struct fc_lport *lp);
142 
143 struct fc_lport *fcoe_hostlist_lookup(const struct net_device *);
144 int fcoe_hostlist_add(const struct fc_lport *);
145 int fcoe_hostlist_remove(const struct fc_lport *);
146 
147 struct Scsi_Host *fcoe_host_alloc(struct scsi_host_template *, int);
148 int fcoe_libfc_config(struct fc_lport *, struct libfc_function_template *);
149 
150 /* fcoe sw hba */
151 int __init fcoe_sw_init(void);
152 int __exit fcoe_sw_exit(void);
153 #endif /* _LIBFCOE_H */
154