PM / sleep: Asynchronous threads for suspend_noirq
[linux/fpc-iii.git] / drivers / scsi / bfa / bfa_fcs.h
blob42bcb970445a8a7212fafa1aa7285639d5c7d8a3
1 /*
2 * Copyright (c) 2005-2010 Brocade Communications Systems, Inc.
3 * All rights reserved
4 * www.brocade.com
6 * Linux driver for Brocade Fibre Channel Host Bus Adapter.
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License (GPL) Version 2 as
10 * published by the Free Software Foundation
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
18 #ifndef __BFA_FCS_H__
19 #define __BFA_FCS_H__
21 #include "bfa_cs.h"
22 #include "bfa_defs.h"
23 #include "bfa_defs_fcs.h"
24 #include "bfa_modules.h"
25 #include "bfa_fc.h"
27 #define BFA_FCS_OS_STR_LEN 64
30 * lps_pvt BFA LPS private functions
33 enum bfa_lps_event {
34 BFA_LPS_SM_LOGIN = 1, /* login request from user */
35 BFA_LPS_SM_LOGOUT = 2, /* logout request from user */
36 BFA_LPS_SM_FWRSP = 3, /* f/w response to login/logout */
37 BFA_LPS_SM_RESUME = 4, /* space present in reqq queue */
38 BFA_LPS_SM_DELETE = 5, /* lps delete from user */
39 BFA_LPS_SM_OFFLINE = 6, /* Link is offline */
40 BFA_LPS_SM_RX_CVL = 7, /* Rx clear virtual link */
41 BFA_LPS_SM_SET_N2N_PID = 8, /* Set assigned PID for n2n */
46 * !!! Only append to the enums defined here to avoid any versioning
47 * !!! needed between trace utility and driver version
49 enum {
50 BFA_TRC_FCS_FCS = 1,
51 BFA_TRC_FCS_PORT = 2,
52 BFA_TRC_FCS_RPORT = 3,
53 BFA_TRC_FCS_FCPIM = 4,
57 struct bfa_fcs_s;
59 #define __fcs_min_cfg(__fcs) ((__fcs)->min_cfg)
61 #define BFA_FCS_BRCD_SWITCH_OUI 0x051e
62 #define N2N_LOCAL_PID 0x010000
63 #define N2N_REMOTE_PID 0x020000
64 #define BFA_FCS_RETRY_TIMEOUT 2000
65 #define BFA_FCS_MAX_NS_RETRIES 5
66 #define BFA_FCS_PID_IS_WKA(pid) ((bfa_ntoh3b(pid) > 0xFFF000) ? 1 : 0)
67 #define BFA_FCS_MAX_RPORT_LOGINS 1024
69 struct bfa_fcs_lport_ns_s {
70 bfa_sm_t sm; /* state machine */
71 struct bfa_timer_s timer;
72 struct bfa_fcs_lport_s *port; /* parent port */
73 struct bfa_fcxp_s *fcxp;
74 struct bfa_fcxp_wqe_s fcxp_wqe;
75 u8 num_rnnid_retries;
76 u8 num_rsnn_nn_retries;
80 struct bfa_fcs_lport_scn_s {
81 bfa_sm_t sm; /* state machine */
82 struct bfa_timer_s timer;
83 struct bfa_fcs_lport_s *port; /* parent port */
84 struct bfa_fcxp_s *fcxp;
85 struct bfa_fcxp_wqe_s fcxp_wqe;
89 struct bfa_fcs_lport_fdmi_s {
90 bfa_sm_t sm; /* state machine */
91 struct bfa_timer_s timer;
92 struct bfa_fcs_lport_ms_s *ms; /* parent ms */
93 struct bfa_fcxp_s *fcxp;
94 struct bfa_fcxp_wqe_s fcxp_wqe;
95 u8 retry_cnt; /* retry count */
96 u8 rsvd[3];
100 struct bfa_fcs_lport_ms_s {
101 bfa_sm_t sm; /* state machine */
102 struct bfa_timer_s timer;
103 struct bfa_fcs_lport_s *port; /* parent port */
104 struct bfa_fcxp_s *fcxp;
105 struct bfa_fcxp_wqe_s fcxp_wqe;
106 struct bfa_fcs_lport_fdmi_s fdmi; /* FDMI component of MS */
107 u8 retry_cnt; /* retry count */
108 u8 rsvd[3];
112 struct bfa_fcs_lport_fab_s {
113 struct bfa_fcs_lport_ns_s ns; /* NS component of port */
114 struct bfa_fcs_lport_scn_s scn; /* scn component of port */
115 struct bfa_fcs_lport_ms_s ms; /* MS component of port */
118 #define MAX_ALPA_COUNT 127
120 struct bfa_fcs_lport_loop_s {
121 u8 num_alpa; /* Num of ALPA entries in the map */
122 u8 alpabm_valid; /* alpa bitmap valid or not (1 or 0) */
123 u8 alpa_pos_map[MAX_ALPA_COUNT]; /* ALPA Positional Map */
124 struct bfa_fcs_lport_s *port; /* parent port */
127 struct bfa_fcs_lport_n2n_s {
128 u32 rsvd;
129 __be16 reply_oxid; /* ox_id from the req flogi to be
130 *used in flogi acc */
131 wwn_t rem_port_wwn; /* Attached port's wwn */
135 union bfa_fcs_lport_topo_u {
136 struct bfa_fcs_lport_fab_s pfab;
137 struct bfa_fcs_lport_loop_s ploop;
138 struct bfa_fcs_lport_n2n_s pn2n;
142 struct bfa_fcs_lport_s {
143 struct list_head qe; /* used by port/vport */
144 bfa_sm_t sm; /* state machine */
145 struct bfa_fcs_fabric_s *fabric; /* parent fabric */
146 struct bfa_lport_cfg_s port_cfg; /* port configuration */
147 struct bfa_timer_s link_timer; /* timer for link offline */
148 u32 pid:24; /* FC address */
149 u8 lp_tag; /* lport tag */
150 u16 num_rports; /* Num of r-ports */
151 struct list_head rport_q; /* queue of discovered r-ports */
152 struct bfa_fcs_s *fcs; /* FCS instance */
153 union bfa_fcs_lport_topo_u port_topo; /* fabric/loop/n2n details */
154 struct bfad_port_s *bfad_port; /* driver peer instance */
155 struct bfa_fcs_vport_s *vport; /* NULL for base ports */
156 struct bfa_fcxp_s *fcxp;
157 struct bfa_fcxp_wqe_s fcxp_wqe;
158 struct bfa_lport_stats_s stats;
159 struct bfa_wc_s wc; /* waiting counter for events */
161 #define BFA_FCS_GET_HAL_FROM_PORT(port) (port->fcs->bfa)
162 #define BFA_FCS_GET_NS_FROM_PORT(port) (&port->port_topo.pfab.ns)
163 #define BFA_FCS_GET_SCN_FROM_PORT(port) (&port->port_topo.pfab.scn)
164 #define BFA_FCS_GET_MS_FROM_PORT(port) (&port->port_topo.pfab.ms)
165 #define BFA_FCS_GET_FDMI_FROM_PORT(port) (&port->port_topo.pfab.ms.fdmi)
166 #define BFA_FCS_VPORT_IS_INITIATOR_MODE(port) \
167 (port->port_cfg.roles & BFA_LPORT_ROLE_FCP_IM)
170 * forward declaration
172 struct bfad_vf_s;
174 enum bfa_fcs_fabric_type {
175 BFA_FCS_FABRIC_UNKNOWN = 0,
176 BFA_FCS_FABRIC_SWITCHED = 1,
177 BFA_FCS_FABRIC_N2N = 2,
178 BFA_FCS_FABRIC_LOOP = 3,
182 struct bfa_fcs_fabric_s {
183 struct list_head qe; /* queue element */
184 bfa_sm_t sm; /* state machine */
185 struct bfa_fcs_s *fcs; /* FCS instance */
186 struct bfa_fcs_lport_s bport; /* base logical port */
187 enum bfa_fcs_fabric_type fab_type; /* fabric type */
188 enum bfa_port_type oper_type; /* current link topology */
189 u8 is_vf; /* is virtual fabric? */
190 u8 is_npiv; /* is NPIV supported ? */
191 u8 is_auth; /* is Security/Auth supported ? */
192 u16 bb_credit; /* BB credit from fabric */
193 u16 vf_id; /* virtual fabric ID */
194 u16 num_vports; /* num vports */
195 u16 rsvd;
196 struct list_head vport_q; /* queue of virtual ports */
197 struct list_head vf_q; /* queue of virtual fabrics */
198 struct bfad_vf_s *vf_drv; /* driver vf structure */
199 struct bfa_timer_s link_timer; /* Link Failure timer. Vport */
200 wwn_t fabric_name; /* attached fabric name */
201 bfa_boolean_t auth_reqd; /* authentication required */
202 struct bfa_timer_s delay_timer; /* delay timer */
203 union {
204 u16 swp_vfid;/* switch port VF id */
205 } event_arg;
206 struct bfa_wc_s wc; /* wait counter for delete */
207 struct bfa_vf_stats_s stats; /* fabric/vf stats */
208 struct bfa_lps_s *lps; /* lport login services */
209 u8 fabric_ip_addr[BFA_FCS_FABRIC_IPADDR_SZ];
210 /* attached fabric's ip addr */
211 struct bfa_wc_s stop_wc; /* wait counter for stop */
214 #define bfa_fcs_fabric_npiv_capable(__f) ((__f)->is_npiv)
215 #define bfa_fcs_fabric_is_switched(__f) \
216 ((__f)->fab_type == BFA_FCS_FABRIC_SWITCHED)
219 * The design calls for a single implementation of base fabric and vf.
221 #define bfa_fcs_vf_t struct bfa_fcs_fabric_s
223 struct bfa_vf_event_s {
224 u32 undefined;
227 struct bfa_fcs_s;
228 struct bfa_fcs_fabric_s;
231 * @todo : need to move to a global config file.
232 * Maximum Rports supported per port (physical/logical).
234 #define BFA_FCS_MAX_RPORTS_SUPP 256 /* @todo : tentative value */
236 #define bfa_fcs_lport_t struct bfa_fcs_lport_s
239 * Symbolic Name related defines
240 * Total bytes 255.
241 * Physical Port's symbolic name 128 bytes.
242 * For Vports, Vport's symbolic name is appended to the Physical port's
243 * Symbolic Name.
245 * Physical Port's symbolic name Format : (Total 128 bytes)
246 * Adapter Model number/name : 16 bytes
247 * Driver Version : 10 bytes
248 * Host Machine Name : 30 bytes
249 * Host OS Info : 44 bytes
250 * Host OS PATCH Info : 16 bytes
251 * ( remaining 12 bytes reserved to be used for separator)
253 #define BFA_FCS_PORT_SYMBNAME_SEPARATOR " | "
255 #define BFA_FCS_PORT_SYMBNAME_MODEL_SZ 16
256 #define BFA_FCS_PORT_SYMBNAME_VERSION_SZ 10
257 #define BFA_FCS_PORT_SYMBNAME_MACHINENAME_SZ 30
258 #define BFA_FCS_PORT_SYMBNAME_OSINFO_SZ 44
259 #define BFA_FCS_PORT_SYMBNAME_OSPATCH_SZ 16
262 * Get FC port ID for a logical port.
264 #define bfa_fcs_lport_get_fcid(_lport) ((_lport)->pid)
265 #define bfa_fcs_lport_get_pwwn(_lport) ((_lport)->port_cfg.pwwn)
266 #define bfa_fcs_lport_get_nwwn(_lport) ((_lport)->port_cfg.nwwn)
267 #define bfa_fcs_lport_get_psym_name(_lport) ((_lport)->port_cfg.sym_name)
268 #define bfa_fcs_lport_get_nsym_name(_lport) ((_lport)->port_cfg.node_sym_name)
269 #define bfa_fcs_lport_is_initiator(_lport) \
270 ((_lport)->port_cfg.roles & BFA_LPORT_ROLE_FCP_IM)
271 #define bfa_fcs_lport_get_nrports(_lport) \
272 ((_lport) ? (_lport)->num_rports : 0)
274 static inline struct bfad_port_s *
275 bfa_fcs_lport_get_drvport(struct bfa_fcs_lport_s *port)
277 return port->bfad_port;
280 #define bfa_fcs_lport_get_opertype(_lport) ((_lport)->fabric->oper_type)
281 #define bfa_fcs_lport_get_fabric_name(_lport) ((_lport)->fabric->fabric_name)
282 #define bfa_fcs_lport_get_fabric_ipaddr(_lport) \
283 ((_lport)->fabric->fabric_ip_addr)
286 * bfa fcs port public functions
289 bfa_boolean_t bfa_fcs_lport_is_online(struct bfa_fcs_lport_s *port);
290 struct bfa_fcs_lport_s *bfa_fcs_get_base_port(struct bfa_fcs_s *fcs);
291 void bfa_fcs_lport_get_rport_quals(struct bfa_fcs_lport_s *port,
292 struct bfa_rport_qualifier_s rport[], int *nrports);
293 wwn_t bfa_fcs_lport_get_rport(struct bfa_fcs_lport_s *port, wwn_t wwn,
294 int index, int nrports, bfa_boolean_t bwwn);
296 struct bfa_fcs_lport_s *bfa_fcs_lookup_port(struct bfa_fcs_s *fcs,
297 u16 vf_id, wwn_t lpwwn);
299 void bfa_fcs_lport_set_symname(struct bfa_fcs_lport_s *port, char *symname);
300 void bfa_fcs_lport_get_info(struct bfa_fcs_lport_s *port,
301 struct bfa_lport_info_s *port_info);
302 void bfa_fcs_lport_get_attr(struct bfa_fcs_lport_s *port,
303 struct bfa_lport_attr_s *port_attr);
304 void bfa_fcs_lport_get_stats(struct bfa_fcs_lport_s *fcs_port,
305 struct bfa_lport_stats_s *port_stats);
306 void bfa_fcs_lport_clear_stats(struct bfa_fcs_lport_s *fcs_port);
307 enum bfa_port_speed bfa_fcs_lport_get_rport_max_speed(
308 struct bfa_fcs_lport_s *port);
310 /* MS FCS routines */
311 void bfa_fcs_lport_ms_init(struct bfa_fcs_lport_s *port);
312 void bfa_fcs_lport_ms_offline(struct bfa_fcs_lport_s *port);
313 void bfa_fcs_lport_ms_online(struct bfa_fcs_lport_s *port);
314 void bfa_fcs_lport_ms_fabric_rscn(struct bfa_fcs_lport_s *port);
316 /* FDMI FCS routines */
317 void bfa_fcs_lport_fdmi_init(struct bfa_fcs_lport_ms_s *ms);
318 void bfa_fcs_lport_fdmi_offline(struct bfa_fcs_lport_ms_s *ms);
319 void bfa_fcs_lport_fdmi_online(struct bfa_fcs_lport_ms_s *ms);
320 void bfa_fcs_lport_uf_recv(struct bfa_fcs_lport_s *lport, struct fchs_s *fchs,
321 u16 len);
322 void bfa_fcs_lport_attach(struct bfa_fcs_lport_s *lport, struct bfa_fcs_s *fcs,
323 u16 vf_id, struct bfa_fcs_vport_s *vport);
324 void bfa_fcs_lport_init(struct bfa_fcs_lport_s *lport,
325 struct bfa_lport_cfg_s *port_cfg);
326 void bfa_fcs_lport_online(struct bfa_fcs_lport_s *port);
327 void bfa_fcs_lport_offline(struct bfa_fcs_lport_s *port);
328 void bfa_fcs_lport_delete(struct bfa_fcs_lport_s *port);
329 void bfa_fcs_lport_stop(struct bfa_fcs_lport_s *port);
330 struct bfa_fcs_rport_s *bfa_fcs_lport_get_rport_by_pid(
331 struct bfa_fcs_lport_s *port, u32 pid);
332 struct bfa_fcs_rport_s *bfa_fcs_lport_get_rport_by_old_pid(
333 struct bfa_fcs_lport_s *port, u32 pid);
334 struct bfa_fcs_rport_s *bfa_fcs_lport_get_rport_by_pwwn(
335 struct bfa_fcs_lport_s *port, wwn_t pwwn);
336 struct bfa_fcs_rport_s *bfa_fcs_lport_get_rport_by_nwwn(
337 struct bfa_fcs_lport_s *port, wwn_t nwwn);
338 struct bfa_fcs_rport_s *bfa_fcs_lport_get_rport_by_qualifier(
339 struct bfa_fcs_lport_s *port, wwn_t pwwn, u32 pid);
340 void bfa_fcs_lport_add_rport(struct bfa_fcs_lport_s *port,
341 struct bfa_fcs_rport_s *rport);
342 void bfa_fcs_lport_del_rport(struct bfa_fcs_lport_s *port,
343 struct bfa_fcs_rport_s *rport);
344 void bfa_fcs_lport_ns_init(struct bfa_fcs_lport_s *vport);
345 void bfa_fcs_lport_ns_offline(struct bfa_fcs_lport_s *vport);
346 void bfa_fcs_lport_ns_online(struct bfa_fcs_lport_s *vport);
347 void bfa_fcs_lport_ns_query(struct bfa_fcs_lport_s *port);
348 void bfa_fcs_lport_ns_util_send_rspn_id(void *cbarg,
349 struct bfa_fcxp_s *fcxp_alloced);
350 void bfa_fcs_lport_scn_init(struct bfa_fcs_lport_s *vport);
351 void bfa_fcs_lport_scn_offline(struct bfa_fcs_lport_s *vport);
352 void bfa_fcs_lport_fab_scn_online(struct bfa_fcs_lport_s *vport);
353 void bfa_fcs_lport_scn_process_rscn(struct bfa_fcs_lport_s *port,
354 struct fchs_s *rx_frame, u32 len);
355 void bfa_fcs_lport_lip_scn_online(bfa_fcs_lport_t *port);
357 struct bfa_fcs_vport_s {
358 struct list_head qe; /* queue elem */
359 bfa_sm_t sm; /* state machine */
360 bfa_fcs_lport_t lport; /* logical port */
361 struct bfa_timer_s timer;
362 struct bfad_vport_s *vport_drv; /* Driver private */
363 struct bfa_vport_stats_s vport_stats; /* vport statistics */
364 struct bfa_lps_s *lps; /* Lport login service*/
365 int fdisc_retries;
368 #define bfa_fcs_vport_get_port(vport) \
369 ((struct bfa_fcs_lport_s *)(&vport->port))
372 * bfa fcs vport public functions
374 bfa_status_t bfa_fcs_vport_create(struct bfa_fcs_vport_s *vport,
375 struct bfa_fcs_s *fcs, u16 vf_id,
376 struct bfa_lport_cfg_s *port_cfg,
377 struct bfad_vport_s *vport_drv);
378 bfa_status_t bfa_fcs_pbc_vport_create(struct bfa_fcs_vport_s *vport,
379 struct bfa_fcs_s *fcs, u16 vf_id,
380 struct bfa_lport_cfg_s *port_cfg,
381 struct bfad_vport_s *vport_drv);
382 bfa_boolean_t bfa_fcs_is_pbc_vport(struct bfa_fcs_vport_s *vport);
383 bfa_status_t bfa_fcs_vport_delete(struct bfa_fcs_vport_s *vport);
384 bfa_status_t bfa_fcs_vport_start(struct bfa_fcs_vport_s *vport);
385 bfa_status_t bfa_fcs_vport_stop(struct bfa_fcs_vport_s *vport);
386 void bfa_fcs_vport_get_attr(struct bfa_fcs_vport_s *vport,
387 struct bfa_vport_attr_s *vport_attr);
388 struct bfa_fcs_vport_s *bfa_fcs_vport_lookup(struct bfa_fcs_s *fcs,
389 u16 vf_id, wwn_t vpwwn);
390 void bfa_fcs_vport_cleanup(struct bfa_fcs_vport_s *vport);
391 void bfa_fcs_vport_online(struct bfa_fcs_vport_s *vport);
392 void bfa_fcs_vport_offline(struct bfa_fcs_vport_s *vport);
393 void bfa_fcs_vport_delete_comp(struct bfa_fcs_vport_s *vport);
394 void bfa_fcs_vport_fcs_delete(struct bfa_fcs_vport_s *vport);
395 void bfa_fcs_vport_fcs_stop(struct bfa_fcs_vport_s *vport);
396 void bfa_fcs_vport_stop_comp(struct bfa_fcs_vport_s *vport);
398 #define BFA_FCS_RPORT_DEF_DEL_TIMEOUT 90 /* in secs */
399 #define BFA_FCS_RPORT_MAX_RETRIES (5)
402 * forward declarations
404 struct bfad_rport_s;
406 struct bfa_fcs_itnim_s;
407 struct bfa_fcs_tin_s;
408 struct bfa_fcs_iprp_s;
410 /* Rport Features (RPF) */
411 struct bfa_fcs_rpf_s {
412 bfa_sm_t sm; /* state machine */
413 struct bfa_fcs_rport_s *rport; /* parent rport */
414 struct bfa_timer_s timer; /* general purpose timer */
415 struct bfa_fcxp_s *fcxp; /* FCXP needed for discarding */
416 struct bfa_fcxp_wqe_s fcxp_wqe; /* fcxp wait queue element */
417 int rpsc_retries; /* max RPSC retry attempts */
418 enum bfa_port_speed rpsc_speed;
419 /* Current Speed from RPSC. O if RPSC fails */
420 enum bfa_port_speed assigned_speed;
422 * Speed assigned by the user. will be used if RPSC is
423 * not supported by the rport.
427 struct bfa_fcs_rport_s {
428 struct list_head qe; /* used by port/vport */
429 struct bfa_fcs_lport_s *port; /* parent FCS port */
430 struct bfa_fcs_s *fcs; /* fcs instance */
431 struct bfad_rport_s *rp_drv; /* driver peer instance */
432 u32 pid; /* port ID of rport */
433 u32 old_pid; /* PID before rport goes offline */
434 u16 maxfrsize; /* maximum frame size */
435 __be16 reply_oxid; /* OX_ID of inbound requests */
436 enum fc_cos fc_cos; /* FC classes of service supp */
437 bfa_boolean_t cisc; /* CISC capable device */
438 bfa_boolean_t prlo; /* processing prlo or LOGO */
439 bfa_boolean_t plogi_pending; /* Rx Plogi Pending */
440 wwn_t pwwn; /* port wwn of rport */
441 wwn_t nwwn; /* node wwn of rport */
442 struct bfa_rport_symname_s psym_name; /* port symbolic name */
443 bfa_sm_t sm; /* state machine */
444 struct bfa_timer_s timer; /* general purpose timer */
445 struct bfa_fcs_itnim_s *itnim; /* ITN initiator mode role */
446 struct bfa_fcs_tin_s *tin; /* ITN initiator mode role */
447 struct bfa_fcs_iprp_s *iprp; /* IP/FC role */
448 struct bfa_rport_s *bfa_rport; /* BFA Rport */
449 struct bfa_fcxp_s *fcxp; /* FCXP needed for discarding */
450 int plogi_retries; /* max plogi retry attempts */
451 int ns_retries; /* max NS query retry attempts */
452 struct bfa_fcxp_wqe_s fcxp_wqe; /* fcxp wait queue element */
453 struct bfa_rport_stats_s stats; /* rport stats */
454 enum bfa_rport_function scsi_function; /* Initiator/Target */
455 struct bfa_fcs_rpf_s rpf; /* Rport features module */
456 bfa_boolean_t scn_online; /* SCN online flag */
459 static inline struct bfa_rport_s *
460 bfa_fcs_rport_get_halrport(struct bfa_fcs_rport_s *rport)
462 return rport->bfa_rport;
466 * bfa fcs rport API functions
468 void bfa_fcs_rport_get_attr(struct bfa_fcs_rport_s *rport,
469 struct bfa_rport_attr_s *attr);
470 struct bfa_fcs_rport_s *bfa_fcs_rport_lookup(struct bfa_fcs_lport_s *port,
471 wwn_t rpwwn);
472 struct bfa_fcs_rport_s *bfa_fcs_rport_lookup_by_nwwn(
473 struct bfa_fcs_lport_s *port, wwn_t rnwwn);
474 void bfa_fcs_rport_set_del_timeout(u8 rport_tmo);
475 void bfa_fcs_rport_set_max_logins(u32 max_logins);
476 void bfa_fcs_rport_uf_recv(struct bfa_fcs_rport_s *rport,
477 struct fchs_s *fchs, u16 len);
478 void bfa_fcs_rport_scn(struct bfa_fcs_rport_s *rport);
480 struct bfa_fcs_rport_s *bfa_fcs_rport_create(struct bfa_fcs_lport_s *port,
481 u32 pid);
482 void bfa_fcs_rport_start(struct bfa_fcs_lport_s *port, struct fchs_s *rx_fchs,
483 struct fc_logi_s *plogi_rsp);
484 void bfa_fcs_rport_plogi_create(struct bfa_fcs_lport_s *port,
485 struct fchs_s *rx_fchs,
486 struct fc_logi_s *plogi);
487 void bfa_fcs_rport_plogi(struct bfa_fcs_rport_s *rport, struct fchs_s *fchs,
488 struct fc_logi_s *plogi);
489 void bfa_fcs_rport_prlo(struct bfa_fcs_rport_s *rport, __be16 ox_id);
491 void bfa_fcs_rport_itntm_ack(struct bfa_fcs_rport_s *rport);
492 void bfa_fcs_rport_fcptm_offline_done(struct bfa_fcs_rport_s *rport);
493 int bfa_fcs_rport_get_state(struct bfa_fcs_rport_s *rport);
494 struct bfa_fcs_rport_s *bfa_fcs_rport_create_by_wwn(
495 struct bfa_fcs_lport_s *port, wwn_t wwn);
496 void bfa_fcs_rpf_init(struct bfa_fcs_rport_s *rport);
497 void bfa_fcs_rpf_rport_online(struct bfa_fcs_rport_s *rport);
498 void bfa_fcs_rpf_rport_offline(struct bfa_fcs_rport_s *rport);
501 * forward declarations
503 struct bfad_itnim_s;
505 struct bfa_fcs_itnim_s {
506 bfa_sm_t sm; /* state machine */
507 struct bfa_fcs_rport_s *rport; /* parent remote rport */
508 struct bfad_itnim_s *itnim_drv; /* driver peer instance */
509 struct bfa_fcs_s *fcs; /* fcs instance */
510 struct bfa_timer_s timer; /* timer functions */
511 struct bfa_itnim_s *bfa_itnim; /* BFA itnim struct */
512 u32 prli_retries; /* max prli retry attempts */
513 bfa_boolean_t seq_rec; /* seq recovery support */
514 bfa_boolean_t rec_support; /* REC supported */
515 bfa_boolean_t conf_comp; /* FCP_CONF support */
516 bfa_boolean_t task_retry_id; /* task retry id supp */
517 struct bfa_fcxp_wqe_s fcxp_wqe; /* wait qelem for fcxp */
518 struct bfa_fcxp_s *fcxp; /* FCXP in use */
519 struct bfa_itnim_stats_s stats; /* itn statistics */
521 #define bfa_fcs_fcxp_alloc(__fcs, __req) \
522 bfa_fcxp_req_rsp_alloc(NULL, (__fcs)->bfa, 0, 0, \
523 NULL, NULL, NULL, NULL, __req)
524 #define bfa_fcs_fcxp_alloc_wait(__bfa, __wqe, __alloc_cbfn, \
525 __alloc_cbarg, __req) \
526 bfa_fcxp_req_rsp_alloc_wait(__bfa, __wqe, __alloc_cbfn, \
527 __alloc_cbarg, NULL, 0, 0, NULL, NULL, NULL, NULL, __req)
529 static inline struct bfad_port_s *
530 bfa_fcs_itnim_get_drvport(struct bfa_fcs_itnim_s *itnim)
532 return itnim->rport->port->bfad_port;
536 static inline struct bfa_fcs_lport_s *
537 bfa_fcs_itnim_get_port(struct bfa_fcs_itnim_s *itnim)
539 return itnim->rport->port;
543 static inline wwn_t
544 bfa_fcs_itnim_get_nwwn(struct bfa_fcs_itnim_s *itnim)
546 return itnim->rport->nwwn;
550 static inline wwn_t
551 bfa_fcs_itnim_get_pwwn(struct bfa_fcs_itnim_s *itnim)
553 return itnim->rport->pwwn;
557 static inline u32
558 bfa_fcs_itnim_get_fcid(struct bfa_fcs_itnim_s *itnim)
560 return itnim->rport->pid;
564 static inline u32
565 bfa_fcs_itnim_get_maxfrsize(struct bfa_fcs_itnim_s *itnim)
567 return itnim->rport->maxfrsize;
571 static inline enum fc_cos
572 bfa_fcs_itnim_get_cos(struct bfa_fcs_itnim_s *itnim)
574 return itnim->rport->fc_cos;
578 static inline struct bfad_itnim_s *
579 bfa_fcs_itnim_get_drvitn(struct bfa_fcs_itnim_s *itnim)
581 return itnim->itnim_drv;
585 static inline struct bfa_itnim_s *
586 bfa_fcs_itnim_get_halitn(struct bfa_fcs_itnim_s *itnim)
588 return itnim->bfa_itnim;
592 * bfa fcs FCP Initiator mode API functions
594 void bfa_fcs_itnim_get_attr(struct bfa_fcs_itnim_s *itnim,
595 struct bfa_itnim_attr_s *attr);
596 void bfa_fcs_itnim_get_stats(struct bfa_fcs_itnim_s *itnim,
597 struct bfa_itnim_stats_s *stats);
598 struct bfa_fcs_itnim_s *bfa_fcs_itnim_lookup(struct bfa_fcs_lport_s *port,
599 wwn_t rpwwn);
600 bfa_status_t bfa_fcs_itnim_attr_get(struct bfa_fcs_lport_s *port, wwn_t rpwwn,
601 struct bfa_itnim_attr_s *attr);
602 bfa_status_t bfa_fcs_itnim_stats_get(struct bfa_fcs_lport_s *port, wwn_t rpwwn,
603 struct bfa_itnim_stats_s *stats);
604 bfa_status_t bfa_fcs_itnim_stats_clear(struct bfa_fcs_lport_s *port,
605 wwn_t rpwwn);
606 struct bfa_fcs_itnim_s *bfa_fcs_itnim_create(struct bfa_fcs_rport_s *rport);
607 void bfa_fcs_itnim_delete(struct bfa_fcs_itnim_s *itnim);
608 void bfa_fcs_itnim_rport_offline(struct bfa_fcs_itnim_s *itnim);
609 void bfa_fcs_itnim_brp_online(struct bfa_fcs_itnim_s *itnim);
610 bfa_status_t bfa_fcs_itnim_get_online_state(struct bfa_fcs_itnim_s *itnim);
611 void bfa_fcs_itnim_is_initiator(struct bfa_fcs_itnim_s *itnim);
612 void bfa_fcs_fcpim_uf_recv(struct bfa_fcs_itnim_s *itnim,
613 struct fchs_s *fchs, u16 len);
615 #define BFA_FCS_FDMI_SUPP_SPEEDS_4G (FDMI_TRANS_SPEED_1G | \
616 FDMI_TRANS_SPEED_2G | \
617 FDMI_TRANS_SPEED_4G)
619 #define BFA_FCS_FDMI_SUPP_SPEEDS_8G (FDMI_TRANS_SPEED_1G | \
620 FDMI_TRANS_SPEED_2G | \
621 FDMI_TRANS_SPEED_4G | \
622 FDMI_TRANS_SPEED_8G)
624 #define BFA_FCS_FDMI_SUPP_SPEEDS_16G (FDMI_TRANS_SPEED_2G | \
625 FDMI_TRANS_SPEED_4G | \
626 FDMI_TRANS_SPEED_8G | \
627 FDMI_TRANS_SPEED_16G)
629 #define BFA_FCS_FDMI_SUPP_SPEEDS_10G FDMI_TRANS_SPEED_10G
631 #define BFA_FCS_FDMI_VENDOR_INFO_LEN 8
632 #define BFA_FCS_FDMI_FC4_TYPE_LEN 32
635 * HBA Attribute Block : BFA internal representation. Note : Some variable
636 * sizes have been trimmed to suit BFA For Ex : Model will be "Brocade". Based
637 * on this the size has been reduced to 16 bytes from the standard's 64 bytes.
639 struct bfa_fcs_fdmi_hba_attr_s {
640 wwn_t node_name;
641 u8 manufacturer[64];
642 u8 serial_num[64];
643 u8 model[16];
644 u8 model_desc[128];
645 u8 hw_version[8];
646 u8 driver_version[BFA_VERSION_LEN];
647 u8 option_rom_ver[BFA_VERSION_LEN];
648 u8 fw_version[BFA_VERSION_LEN];
649 u8 os_name[256];
650 __be32 max_ct_pyld;
651 struct bfa_lport_symname_s node_sym_name;
652 u8 vendor_info[BFA_FCS_FDMI_VENDOR_INFO_LEN];
653 __be32 num_ports;
654 wwn_t fabric_name;
655 u8 bios_ver[BFA_VERSION_LEN];
659 * Port Attribute Block
661 struct bfa_fcs_fdmi_port_attr_s {
662 u8 supp_fc4_types[BFA_FCS_FDMI_FC4_TYPE_LEN];
663 __be32 supp_speed; /* supported speed */
664 __be32 curr_speed; /* current Speed */
665 __be32 max_frm_size; /* max frame size */
666 u8 os_device_name[256]; /* OS device Name */
667 u8 host_name[256]; /* host name */
668 wwn_t port_name;
669 wwn_t node_name;
670 struct bfa_lport_symname_s port_sym_name;
671 __be32 port_type;
672 enum fc_cos scos;
673 wwn_t port_fabric_name;
674 u8 port_act_fc4_type[BFA_FCS_FDMI_FC4_TYPE_LEN];
675 __be32 port_state;
676 __be32 num_ports;
679 struct bfa_fcs_stats_s {
680 struct {
681 u32 untagged; /* untagged receive frames */
682 u32 tagged; /* tagged receive frames */
683 u32 vfid_unknown; /* VF id is unknown */
684 } uf;
687 struct bfa_fcs_driver_info_s {
688 u8 version[BFA_VERSION_LEN]; /* Driver Version */
689 u8 host_machine_name[BFA_FCS_OS_STR_LEN];
690 u8 host_os_name[BFA_FCS_OS_STR_LEN]; /* OS name and version */
691 u8 host_os_patch[BFA_FCS_OS_STR_LEN]; /* patch or service pack */
692 u8 os_device_name[BFA_FCS_OS_STR_LEN]; /* Driver Device Name */
695 struct bfa_fcs_s {
696 struct bfa_s *bfa; /* corresponding BFA bfa instance */
697 struct bfad_s *bfad; /* corresponding BDA driver instance */
698 struct bfa_trc_mod_s *trcmod; /* tracing module */
699 bfa_boolean_t vf_enabled; /* VF mode is enabled */
700 bfa_boolean_t fdmi_enabled; /* FDMI is enabled */
701 bfa_boolean_t min_cfg; /* min cfg enabled/disabled */
702 u16 port_vfid; /* port default VF ID */
703 struct bfa_fcs_driver_info_s driver_info;
704 struct bfa_fcs_fabric_s fabric; /* base fabric state machine */
705 struct bfa_fcs_stats_s stats; /* FCS statistics */
706 struct bfa_wc_s wc; /* waiting counter */
707 int fcs_aen_seq;
708 u32 num_rport_logins;
712 * fcs_fabric_sm fabric state machine functions
716 * Fabric state machine events
718 enum bfa_fcs_fabric_event {
719 BFA_FCS_FABRIC_SM_CREATE = 1, /* create from driver */
720 BFA_FCS_FABRIC_SM_DELETE = 2, /* delete from driver */
721 BFA_FCS_FABRIC_SM_LINK_DOWN = 3, /* link down from port */
722 BFA_FCS_FABRIC_SM_LINK_UP = 4, /* link up from port */
723 BFA_FCS_FABRIC_SM_CONT_OP = 5, /* flogi/auth continue op */
724 BFA_FCS_FABRIC_SM_RETRY_OP = 6, /* flogi/auth retry op */
725 BFA_FCS_FABRIC_SM_NO_FABRIC = 7, /* from flogi/auth */
726 BFA_FCS_FABRIC_SM_PERF_EVFP = 8, /* from flogi/auth */
727 BFA_FCS_FABRIC_SM_ISOLATE = 9, /* from EVFP processing */
728 BFA_FCS_FABRIC_SM_NO_TAGGING = 10, /* no VFT tagging from EVFP */
729 BFA_FCS_FABRIC_SM_DELAYED = 11, /* timeout delay event */
730 BFA_FCS_FABRIC_SM_AUTH_FAILED = 12, /* auth failed */
731 BFA_FCS_FABRIC_SM_AUTH_SUCCESS = 13, /* auth successful */
732 BFA_FCS_FABRIC_SM_DELCOMP = 14, /* all vports deleted event */
733 BFA_FCS_FABRIC_SM_LOOPBACK = 15, /* Received our own FLOGI */
734 BFA_FCS_FABRIC_SM_START = 16, /* from driver */
735 BFA_FCS_FABRIC_SM_STOP = 17, /* Stop from driver */
736 BFA_FCS_FABRIC_SM_STOPCOMP = 18, /* Stop completion */
737 BFA_FCS_FABRIC_SM_LOGOCOMP = 19, /* FLOGO completion */
741 * fcs_rport_sm FCS rport state machine events
744 enum rport_event {
745 RPSM_EVENT_PLOGI_SEND = 1, /* new rport; start with PLOGI */
746 RPSM_EVENT_PLOGI_RCVD = 2, /* Inbound PLOGI from remote port */
747 RPSM_EVENT_PLOGI_COMP = 3, /* PLOGI completed to rport */
748 RPSM_EVENT_LOGO_RCVD = 4, /* LOGO from remote device */
749 RPSM_EVENT_LOGO_IMP = 5, /* implicit logo for SLER */
750 RPSM_EVENT_FCXP_SENT = 6, /* Frame from has been sent */
751 RPSM_EVENT_DELETE = 7, /* RPORT delete request */
752 RPSM_EVENT_FAB_SCN = 8, /* state change notification */
753 RPSM_EVENT_ACCEPTED = 9, /* Good response from remote device */
754 RPSM_EVENT_FAILED = 10, /* Request to rport failed. */
755 RPSM_EVENT_TIMEOUT = 11, /* Rport SM timeout event */
756 RPSM_EVENT_HCB_ONLINE = 12, /* BFA rport online callback */
757 RPSM_EVENT_HCB_OFFLINE = 13, /* BFA rport offline callback */
758 RPSM_EVENT_FC4_OFFLINE = 14, /* FC-4 offline complete */
759 RPSM_EVENT_ADDRESS_CHANGE = 15, /* Rport's PID has changed */
760 RPSM_EVENT_ADDRESS_DISC = 16, /* Need to Discover rport's PID */
761 RPSM_EVENT_PRLO_RCVD = 17, /* PRLO from remote device */
762 RPSM_EVENT_PLOGI_RETRY = 18, /* Retry PLOGI continuously */
763 RPSM_EVENT_SCN_OFFLINE = 19, /* loop scn offline */
764 RPSM_EVENT_SCN_ONLINE = 20, /* loop scn online */
765 RPSM_EVENT_FC4_FCS_ONLINE = 21, /* FC-4 FCS online complete */
769 * fcs_itnim_sm FCS itnim state machine events
771 enum bfa_fcs_itnim_event {
772 BFA_FCS_ITNIM_SM_FCS_ONLINE = 1, /* rport online event */
773 BFA_FCS_ITNIM_SM_OFFLINE = 2, /* rport offline */
774 BFA_FCS_ITNIM_SM_FRMSENT = 3, /* prli frame is sent */
775 BFA_FCS_ITNIM_SM_RSP_OK = 4, /* good response */
776 BFA_FCS_ITNIM_SM_RSP_ERROR = 5, /* error response */
777 BFA_FCS_ITNIM_SM_TIMEOUT = 6, /* delay timeout */
778 BFA_FCS_ITNIM_SM_HCB_OFFLINE = 7, /* BFA online callback */
779 BFA_FCS_ITNIM_SM_HCB_ONLINE = 8, /* BFA offline callback */
780 BFA_FCS_ITNIM_SM_INITIATOR = 9, /* rport is initiator */
781 BFA_FCS_ITNIM_SM_DELETE = 10, /* delete event from rport */
782 BFA_FCS_ITNIM_SM_PRLO = 11, /* delete event from rport */
783 BFA_FCS_ITNIM_SM_RSP_NOT_SUPP = 12, /* cmd not supported rsp */
784 BFA_FCS_ITNIM_SM_HAL_ONLINE = 13, /* bfa rport online event */
788 * bfa fcs API functions
790 void bfa_fcs_attach(struct bfa_fcs_s *fcs, struct bfa_s *bfa,
791 struct bfad_s *bfad,
792 bfa_boolean_t min_cfg);
793 void bfa_fcs_init(struct bfa_fcs_s *fcs);
794 void bfa_fcs_pbc_vport_init(struct bfa_fcs_s *fcs);
795 void bfa_fcs_update_cfg(struct bfa_fcs_s *fcs);
796 void bfa_fcs_driver_info_init(struct bfa_fcs_s *fcs,
797 struct bfa_fcs_driver_info_s *driver_info);
798 void bfa_fcs_exit(struct bfa_fcs_s *fcs);
799 void bfa_fcs_stop(struct bfa_fcs_s *fcs);
802 * bfa fcs vf public functions
804 bfa_fcs_vf_t *bfa_fcs_vf_lookup(struct bfa_fcs_s *fcs, u16 vf_id);
805 void bfa_fcs_vf_get_ports(bfa_fcs_vf_t *vf, wwn_t vpwwn[], int *nports);
808 * fabric protected interface functions
810 void bfa_fcs_fabric_attach(struct bfa_fcs_s *fcs);
811 void bfa_fcs_fabric_modinit(struct bfa_fcs_s *fcs);
812 void bfa_fcs_fabric_modexit(struct bfa_fcs_s *fcs);
813 void bfa_fcs_fabric_link_up(struct bfa_fcs_fabric_s *fabric);
814 void bfa_fcs_fabric_link_down(struct bfa_fcs_fabric_s *fabric);
815 void bfa_fcs_fabric_addvport(struct bfa_fcs_fabric_s *fabric,
816 struct bfa_fcs_vport_s *vport);
817 void bfa_fcs_fabric_delvport(struct bfa_fcs_fabric_s *fabric,
818 struct bfa_fcs_vport_s *vport);
819 struct bfa_fcs_vport_s *bfa_fcs_fabric_vport_lookup(
820 struct bfa_fcs_fabric_s *fabric, wwn_t pwwn);
821 void bfa_fcs_fabric_modstart(struct bfa_fcs_s *fcs);
822 void bfa_fcs_fabric_uf_recv(struct bfa_fcs_fabric_s *fabric,
823 struct fchs_s *fchs, u16 len);
824 void bfa_fcs_fabric_psymb_init(struct bfa_fcs_fabric_s *fabric);
825 void bfa_fcs_fabric_nsymb_init(struct bfa_fcs_fabric_s *fabric);
826 void bfa_fcs_fabric_set_fabric_name(struct bfa_fcs_fabric_s *fabric,
827 wwn_t fabric_name);
828 u16 bfa_fcs_fabric_get_switch_oui(struct bfa_fcs_fabric_s *fabric);
829 void bfa_fcs_uf_attach(struct bfa_fcs_s *fcs);
830 void bfa_fcs_port_attach(struct bfa_fcs_s *fcs);
831 void bfa_fcs_fabric_modstop(struct bfa_fcs_s *fcs);
832 void bfa_fcs_fabric_sm_online(struct bfa_fcs_fabric_s *fabric,
833 enum bfa_fcs_fabric_event event);
834 void bfa_fcs_fabric_sm_loopback(struct bfa_fcs_fabric_s *fabric,
835 enum bfa_fcs_fabric_event event);
836 void bfa_fcs_fabric_sm_auth_failed(struct bfa_fcs_fabric_s *fabric,
837 enum bfa_fcs_fabric_event event);
840 * BFA FCS callback interfaces
844 * fcb Main fcs callbacks
847 struct bfad_port_s;
848 struct bfad_vf_s;
849 struct bfad_vport_s;
850 struct bfad_rport_s;
853 * lport callbacks
855 struct bfad_port_s *bfa_fcb_lport_new(struct bfad_s *bfad,
856 struct bfa_fcs_lport_s *port,
857 enum bfa_lport_role roles,
858 struct bfad_vf_s *vf_drv,
859 struct bfad_vport_s *vp_drv);
862 * vport callbacks
864 void bfa_fcb_pbc_vport_create(struct bfad_s *bfad, struct bfi_pbc_vport_s);
867 * rport callbacks
869 bfa_status_t bfa_fcb_rport_alloc(struct bfad_s *bfad,
870 struct bfa_fcs_rport_s **rport,
871 struct bfad_rport_s **rport_drv);
874 * itnim callbacks
876 void bfa_fcb_itnim_alloc(struct bfad_s *bfad, struct bfa_fcs_itnim_s **itnim,
877 struct bfad_itnim_s **itnim_drv);
878 void bfa_fcb_itnim_free(struct bfad_s *bfad,
879 struct bfad_itnim_s *itnim_drv);
880 void bfa_fcb_itnim_online(struct bfad_itnim_s *itnim_drv);
881 void bfa_fcb_itnim_offline(struct bfad_itnim_s *itnim_drv);
883 #endif /* __BFA_FCS_H__ */