xref: /openbmc/linux/drivers/scsi/fcoe/fcoe.h (revision 565d76cb)
1 /*
2  * Copyright(c) 2009 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 _FCOE_H_
21 #define _FCOE_H_
22 
23 #include <linux/skbuff.h>
24 #include <linux/kthread.h>
25 
26 #define FCOE_MAX_QUEUE_DEPTH	256
27 #define FCOE_MIN_QUEUE_DEPTH	32
28 
29 #define FCOE_WORD_TO_BYTE	4
30 
31 #define FCOE_VERSION	"0.1"
32 #define FCOE_NAME	"fcoe"
33 #define FCOE_VENDOR	"Open-FCoE.org"
34 
35 #define FCOE_MAX_LUN		0xFFFF
36 #define FCOE_MAX_FCP_TARGET	256
37 
38 #define FCOE_MAX_OUTSTANDING_COMMANDS	1024
39 
40 #define FCOE_MIN_XID		0x0000	/* the min xid supported by fcoe_sw */
41 #define FCOE_MAX_XID		0x0FFF	/* the max xid supported by fcoe_sw */
42 
43 unsigned int fcoe_debug_logging;
44 module_param_named(debug_logging, fcoe_debug_logging, int, S_IRUGO|S_IWUSR);
45 MODULE_PARM_DESC(debug_logging, "a bit mask of logging levels");
46 
47 #define FCOE_LOGGING	    0x01 /* General logging, not categorized */
48 #define FCOE_NETDEV_LOGGING 0x02 /* Netdevice logging */
49 
50 #define FCOE_CHECK_LOGGING(LEVEL, CMD)					\
51 do {                                                            	\
52 	if (unlikely(fcoe_debug_logging & LEVEL))			\
53 		do {							\
54 			CMD;						\
55 		} while (0);						\
56 } while (0)
57 
58 #define FCOE_DBG(fmt, args...)						\
59 	FCOE_CHECK_LOGGING(FCOE_LOGGING,				\
60 			   printk(KERN_INFO "fcoe: " fmt, ##args);)
61 
62 #define FCOE_NETDEV_DBG(netdev, fmt, args...)			\
63 	FCOE_CHECK_LOGGING(FCOE_NETDEV_LOGGING,			\
64 			   printk(KERN_INFO "fcoe: %s: " fmt,	\
65 				  netdev->name, ##args);)
66 
67 /**
68  * struct fcoe_interface - A FCoE interface
69  * @list:	      Handle for a list of FCoE interfaces
70  * @netdev:	      The associated net device
71  * @fcoe_packet_type: FCoE packet type
72  * @fip_packet_type:  FIP packet type
73  * @ctlr:	      The FCoE controller (for FIP)
74  * @oem:	      The offload exchange manager for all local port
75  *		      instances associated with this port
76  * @kref:	      The kernel reference
77  *
78  * This structure is 1:1 with a net devive.
79  */
80 struct fcoe_interface {
81 	struct list_head   list;
82 	struct net_device  *netdev;
83 	struct packet_type fcoe_packet_type;
84 	struct packet_type fip_packet_type;
85 	struct fcoe_ctlr   ctlr;
86 	struct fc_exch_mgr *oem;
87 	struct kref	   kref;
88 };
89 
90 #define fcoe_from_ctlr(fip) container_of(fip, struct fcoe_interface, ctlr)
91 
92 /**
93  * fcoe_netdev() - Return the net device associated with a local port
94  * @lport: The local port to get the net device from
95  */
96 static inline struct net_device *fcoe_netdev(const struct fc_lport *lport)
97 {
98 	return ((struct fcoe_interface *)
99 			((struct fcoe_port *)lport_priv(lport))->priv)->netdev;
100 }
101 
102 #endif /* _FCOE_H_ */
103