xref: /OK3568_Linux_fs/kernel/drivers/scsi/csiostor/csio_rnode.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * This file is part of the Chelsio FCoE driver for Linux.
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * Copyright (c) 2008-2012 Chelsio Communications, Inc. All rights reserved.
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  * This software is available to you under a choice of one of two
7*4882a593Smuzhiyun  * licenses.  You may choose to be licensed under the terms of the GNU
8*4882a593Smuzhiyun  * General Public License (GPL) Version 2, available from the file
9*4882a593Smuzhiyun  * COPYING in the main directory of this source tree, or the
10*4882a593Smuzhiyun  * OpenIB.org BSD license below:
11*4882a593Smuzhiyun  *
12*4882a593Smuzhiyun  *     Redistribution and use in source and binary forms, with or
13*4882a593Smuzhiyun  *     without modification, are permitted provided that the following
14*4882a593Smuzhiyun  *     conditions are met:
15*4882a593Smuzhiyun  *
16*4882a593Smuzhiyun  *      - Redistributions of source code must retain the above
17*4882a593Smuzhiyun  *        copyright notice, this list of conditions and the following
18*4882a593Smuzhiyun  *        disclaimer.
19*4882a593Smuzhiyun  *
20*4882a593Smuzhiyun  *      - Redistributions in binary form must reproduce the above
21*4882a593Smuzhiyun  *        copyright notice, this list of conditions and the following
22*4882a593Smuzhiyun  *        disclaimer in the documentation and/or other materials
23*4882a593Smuzhiyun  *        provided with the distribution.
24*4882a593Smuzhiyun  *
25*4882a593Smuzhiyun  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26*4882a593Smuzhiyun  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27*4882a593Smuzhiyun  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28*4882a593Smuzhiyun  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29*4882a593Smuzhiyun  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30*4882a593Smuzhiyun  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31*4882a593Smuzhiyun  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32*4882a593Smuzhiyun  * SOFTWARE.
33*4882a593Smuzhiyun  */
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun #ifndef __CSIO_RNODE_H__
36*4882a593Smuzhiyun #define __CSIO_RNODE_H__
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun #include "csio_defs.h"
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun /* State machine evets */
41*4882a593Smuzhiyun enum csio_rn_ev {
42*4882a593Smuzhiyun 	CSIO_RNFE_NONE = (uint32_t)0,			/* None */
43*4882a593Smuzhiyun 	CSIO_RNFE_LOGGED_IN,				/* [N/F]Port login
44*4882a593Smuzhiyun 							 * complete.
45*4882a593Smuzhiyun 							 */
46*4882a593Smuzhiyun 	CSIO_RNFE_PRLI_DONE,				/* PRLI completed */
47*4882a593Smuzhiyun 	CSIO_RNFE_PLOGI_RECV,				/* Received PLOGI */
48*4882a593Smuzhiyun 	CSIO_RNFE_PRLI_RECV,				/* Received PLOGI */
49*4882a593Smuzhiyun 	CSIO_RNFE_LOGO_RECV,				/* Received LOGO */
50*4882a593Smuzhiyun 	CSIO_RNFE_PRLO_RECV,				/* Received PRLO */
51*4882a593Smuzhiyun 	CSIO_RNFE_DOWN,					/* Rnode is down */
52*4882a593Smuzhiyun 	CSIO_RNFE_CLOSE,				/* Close rnode */
53*4882a593Smuzhiyun 	CSIO_RNFE_NAME_MISSING,				/* Rnode name missing
54*4882a593Smuzhiyun 							 * in name server.
55*4882a593Smuzhiyun 							 */
56*4882a593Smuzhiyun 	CSIO_RNFE_MAX_EVENT,
57*4882a593Smuzhiyun };
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun /* rnode stats */
60*4882a593Smuzhiyun struct csio_rnode_stats {
61*4882a593Smuzhiyun 	uint32_t	n_err;		/* error */
62*4882a593Smuzhiyun 	uint32_t	n_err_inval;	/* invalid parameter */
63*4882a593Smuzhiyun 	uint32_t	n_err_nomem;	/* error nomem */
64*4882a593Smuzhiyun 	uint32_t	n_evt_unexp;	/* unexpected event */
65*4882a593Smuzhiyun 	uint32_t	n_evt_drop;	/* unexpected event */
66*4882a593Smuzhiyun 	uint32_t	n_evt_fw[PROTO_ERR_IMPL_LOGO + 1];	/* fw events */
67*4882a593Smuzhiyun 	enum csio_rn_ev	n_evt_sm[CSIO_RNFE_MAX_EVENT];	/* State m/c events */
68*4882a593Smuzhiyun 	uint32_t	n_lun_rst;	/* Number of resets of
69*4882a593Smuzhiyun 					 * of LUNs under this
70*4882a593Smuzhiyun 					 * target
71*4882a593Smuzhiyun 					 */
72*4882a593Smuzhiyun 	uint32_t	n_lun_rst_fail;	/* Number of LUN reset
73*4882a593Smuzhiyun 					 * failures.
74*4882a593Smuzhiyun 					 */
75*4882a593Smuzhiyun 	uint32_t	n_tgt_rst;	/* Number of target resets */
76*4882a593Smuzhiyun 	uint32_t	n_tgt_rst_fail;	/* Number of target reset
77*4882a593Smuzhiyun 					 * failures.
78*4882a593Smuzhiyun 					 */
79*4882a593Smuzhiyun };
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun /* Defines for rnode role */
82*4882a593Smuzhiyun #define	CSIO_RNFR_INITIATOR	0x1
83*4882a593Smuzhiyun #define	CSIO_RNFR_TARGET	0x2
84*4882a593Smuzhiyun #define CSIO_RNFR_FABRIC	0x4
85*4882a593Smuzhiyun #define	CSIO_RNFR_NS		0x8
86*4882a593Smuzhiyun #define CSIO_RNFR_NPORT		0x10
87*4882a593Smuzhiyun 
88*4882a593Smuzhiyun struct csio_rnode {
89*4882a593Smuzhiyun 	struct csio_sm		sm;			/* State machine -
90*4882a593Smuzhiyun 							 * should be the
91*4882a593Smuzhiyun 							 * 1st member
92*4882a593Smuzhiyun 							 */
93*4882a593Smuzhiyun 	struct csio_lnode	*lnp;			/* Pointer to owning
94*4882a593Smuzhiyun 							 * Lnode */
95*4882a593Smuzhiyun 	uint32_t		flowid;			/* Firmware ID */
96*4882a593Smuzhiyun 	struct list_head	host_cmpl_q;		/* SCSI IOs
97*4882a593Smuzhiyun 							 * pending to completed
98*4882a593Smuzhiyun 							 * to Mid-layer.
99*4882a593Smuzhiyun 							 */
100*4882a593Smuzhiyun 	/* FC identifiers for remote node */
101*4882a593Smuzhiyun 	uint32_t		nport_id;
102*4882a593Smuzhiyun 	uint16_t		fcp_flags;		/* FCP Flags */
103*4882a593Smuzhiyun 	uint8_t			cur_evt;		/* Current event */
104*4882a593Smuzhiyun 	uint8_t			prev_evt;		/* Previous event */
105*4882a593Smuzhiyun 	uint32_t		role;			/* Fabric/Target/
106*4882a593Smuzhiyun 							 * Initiator/NS
107*4882a593Smuzhiyun 							 */
108*4882a593Smuzhiyun 	struct fcoe_rdev_entry		*rdev_entry;	/* Rdev entry */
109*4882a593Smuzhiyun 	struct csio_service_parms	rn_sparm;
110*4882a593Smuzhiyun 
111*4882a593Smuzhiyun 	/* FC transport attributes */
112*4882a593Smuzhiyun 	struct fc_rport		*rport;		/* FC transport rport */
113*4882a593Smuzhiyun 	uint32_t		supp_classes;	/* Supported FC classes */
114*4882a593Smuzhiyun 	uint32_t		maxframe_size;	/* Max Frame size */
115*4882a593Smuzhiyun 	uint32_t		scsi_id;	/* Transport given SCSI id */
116*4882a593Smuzhiyun 
117*4882a593Smuzhiyun 	struct csio_rnode_stats	stats;		/* Common rnode stats */
118*4882a593Smuzhiyun };
119*4882a593Smuzhiyun 
120*4882a593Smuzhiyun #define csio_rn_flowid(rn)			((rn)->flowid)
121*4882a593Smuzhiyun #define csio_rn_wwpn(rn)			((rn)->rn_sparm.wwpn)
122*4882a593Smuzhiyun #define csio_rn_wwnn(rn)			((rn)->rn_sparm.wwnn)
123*4882a593Smuzhiyun #define csio_rnode_to_lnode(rn)			((rn)->lnp)
124*4882a593Smuzhiyun 
125*4882a593Smuzhiyun int csio_is_rnode_ready(struct csio_rnode *rn);
126*4882a593Smuzhiyun void csio_rnode_state_to_str(struct csio_rnode *rn, int8_t *str);
127*4882a593Smuzhiyun 
128*4882a593Smuzhiyun struct csio_rnode *csio_rnode_lookup_portid(struct csio_lnode *, uint32_t);
129*4882a593Smuzhiyun struct csio_rnode *csio_confirm_rnode(struct csio_lnode *,
130*4882a593Smuzhiyun 					  uint32_t, struct fcoe_rdev_entry *);
131*4882a593Smuzhiyun 
132*4882a593Smuzhiyun void csio_rnode_fwevt_handler(struct csio_rnode *rn, uint8_t fwevt);
133*4882a593Smuzhiyun 
134*4882a593Smuzhiyun void csio_put_rnode(struct csio_lnode *ln, struct csio_rnode *rn);
135*4882a593Smuzhiyun 
136*4882a593Smuzhiyun void csio_reg_rnode(struct csio_rnode *);
137*4882a593Smuzhiyun void csio_unreg_rnode(struct csio_rnode *);
138*4882a593Smuzhiyun 
139*4882a593Smuzhiyun void csio_rnode_devloss_handler(struct csio_rnode *);
140*4882a593Smuzhiyun 
141*4882a593Smuzhiyun #endif /* ifndef __CSIO_RNODE_H__ */
142