xref: /openbmc/linux/drivers/scsi/libfc/fc_libfc.h (revision 1fa6ac37)
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 _FC_LIBFC_H_
21 #define _FC_LIBFC_H_
22 
23 #define FC_LIBFC_LOGGING 0x01 /* General logging, not categorized */
24 #define FC_LPORT_LOGGING 0x02 /* lport layer logging */
25 #define FC_DISC_LOGGING	 0x04 /* discovery layer logging */
26 #define FC_RPORT_LOGGING 0x08 /* rport layer logging */
27 #define FC_FCP_LOGGING	 0x10 /* I/O path logging */
28 #define FC_EM_LOGGING	 0x20 /* Exchange Manager logging */
29 #define FC_EXCH_LOGGING	 0x40 /* Exchange/Sequence logging */
30 #define FC_SCSI_LOGGING	 0x80 /* SCSI logging (mostly error handling) */
31 
32 extern unsigned int fc_debug_logging;
33 
34 #define FC_CHECK_LOGGING(LEVEL, CMD)			\
35 	do {						\
36 		if (unlikely(fc_debug_logging & LEVEL))	\
37 			do {				\
38 				CMD;			\
39 			} while (0);			\
40 	} while (0)
41 
42 #define FC_LIBFC_DBG(fmt, args...)					\
43 	FC_CHECK_LOGGING(FC_LIBFC_LOGGING,				\
44 			 printk(KERN_INFO "libfc: " fmt, ##args))
45 
46 #define FC_LPORT_DBG(lport, fmt, args...)				\
47 	FC_CHECK_LOGGING(FC_LPORT_LOGGING,				\
48 			 printk(KERN_INFO "host%u: lport %6.6x: " fmt,	\
49 				(lport)->host->host_no,			\
50 				(lport)->port_id, ##args))
51 
52 #define FC_DISC_DBG(disc, fmt, args...)				\
53 	FC_CHECK_LOGGING(FC_DISC_LOGGING,			\
54 			 printk(KERN_INFO "host%u: disc: " fmt,	\
55 				(disc)->lport->host->host_no,	\
56 				##args))
57 
58 #define FC_RPORT_ID_DBG(lport, port_id, fmt, args...)			\
59 	FC_CHECK_LOGGING(FC_RPORT_LOGGING,				\
60 			 printk(KERN_INFO "host%u: rport %6.6x: " fmt,	\
61 				(lport)->host->host_no,			\
62 				(port_id), ##args))
63 
64 #define FC_RPORT_DBG(rdata, fmt, args...)				\
65 	FC_RPORT_ID_DBG((rdata)->local_port, (rdata)->ids.port_id, fmt, ##args)
66 
67 #define FC_FCP_DBG(pkt, fmt, args...)					\
68 	FC_CHECK_LOGGING(FC_FCP_LOGGING,				\
69 			 printk(KERN_INFO "host%u: fcp: %6.6x: " fmt,	\
70 				(pkt)->lp->host->host_no,		\
71 				pkt->rport->port_id, ##args))
72 
73 #define FC_EXCH_DBG(exch, fmt, args...)					\
74 	FC_CHECK_LOGGING(FC_EXCH_LOGGING,				\
75 			 printk(KERN_INFO "host%u: xid %4x: " fmt,	\
76 				(exch)->lp->host->host_no,		\
77 				exch->xid, ##args))
78 
79 #define FC_SCSI_DBG(lport, fmt, args...)				\
80 	FC_CHECK_LOGGING(FC_SCSI_LOGGING,				\
81 			 printk(KERN_INFO "host%u: scsi: " fmt,		\
82 				(lport)->host->host_no,	##args))
83 
84 /*
85  * Set up direct-data placement for this I/O request
86  */
87 void fc_fcp_ddp_setup(struct fc_fcp_pkt *fsp, u16 xid);
88 
89 /*
90  * Module setup functions
91  */
92 int fc_setup_exch_mgr(void);
93 void fc_destroy_exch_mgr(void);
94 int fc_setup_rport(void);
95 void fc_destroy_rport(void);
96 int fc_setup_fcp(void);
97 void fc_destroy_fcp(void);
98 
99 /*
100  * Internal libfc functions
101  */
102 const char *fc_els_resp_type(struct fc_frame *);
103 
104 /*
105  * Copies a buffer into an sg list
106  */
107 u32 fc_copy_buffer_to_sglist(void *buf, size_t len,
108 			     struct scatterlist *sg,
109 			     u32 *nents, size_t *offset,
110 			     enum km_type km_type, u32 *crc);
111 
112 #endif /* _FC_LIBFC_H_ */
113