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