1 /*
2 * Copyright (c) 2005-2010 Brocade Communications Systems, Inc.
3 * All rights reserved
4 * www.brocade.com
5 *
6 * Linux driver for Brocade Fibre Channel Host Bus Adapter.
7 *
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
11 *
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.
16 */
17 /*
18 * fcbuild.h - FC link service frame building and parsing routines
19 */
20
21 #ifndef __FCBUILD_H__
22 #define __FCBUILD_H__
23
24 #include "bfad_drv.h"
25 #include "bfa_fc.h"
26 #include "bfa_defs_fcs.h"
27
28 /*
29 * Utility Macros/functions
30 */
31
32 #define wwn_is_equal(_wwn1, _wwn2) \
33 (memcmp(&(_wwn1), &(_wwn2), sizeof(wwn_t)) == 0)
34
35 #define fc_roundup(_l, _s) (((_l) + ((_s) - 1)) & ~((_s) - 1))
36
37 /*
38 * Given the fc response length, this routine will return
39 * the length of the actual payload bytes following the CT header.
40 *
41 * Assumes the input response length does not include the crc, eof, etc.
42 */
43 static inline u32
fc_get_ctresp_pyld_len(u32 resp_len)44 fc_get_ctresp_pyld_len(u32 resp_len)
45 {
46 return resp_len - sizeof(struct ct_hdr_s);
47 }
48
49 /*
50 * Convert bfa speed to rpsc speed value.
51 */
52 static inline enum bfa_port_speed
fc_rpsc_operspeed_to_bfa_speed(enum fc_rpsc_op_speed speed)53 fc_rpsc_operspeed_to_bfa_speed(enum fc_rpsc_op_speed speed)
54 {
55 switch (speed) {
56
57 case RPSC_OP_SPEED_1G:
58 return BFA_PORT_SPEED_1GBPS;
59
60 case RPSC_OP_SPEED_2G:
61 return BFA_PORT_SPEED_2GBPS;
62
63 case RPSC_OP_SPEED_4G:
64 return BFA_PORT_SPEED_4GBPS;
65
66 case RPSC_OP_SPEED_8G:
67 return BFA_PORT_SPEED_8GBPS;
68
69 case RPSC_OP_SPEED_16G:
70 return BFA_PORT_SPEED_16GBPS;
71
72 case RPSC_OP_SPEED_10G:
73 return BFA_PORT_SPEED_10GBPS;
74
75 default:
76 return BFA_PORT_SPEED_UNKNOWN;
77 }
78 }
79
80 /*
81 * Convert RPSC speed to bfa speed value.
82 */
83 static inline enum fc_rpsc_op_speed
fc_bfa_speed_to_rpsc_operspeed(enum bfa_port_speed op_speed)84 fc_bfa_speed_to_rpsc_operspeed(enum bfa_port_speed op_speed)
85 {
86 switch (op_speed) {
87
88 case BFA_PORT_SPEED_1GBPS:
89 return RPSC_OP_SPEED_1G;
90
91 case BFA_PORT_SPEED_2GBPS:
92 return RPSC_OP_SPEED_2G;
93
94 case BFA_PORT_SPEED_4GBPS:
95 return RPSC_OP_SPEED_4G;
96
97 case BFA_PORT_SPEED_8GBPS:
98 return RPSC_OP_SPEED_8G;
99
100 case BFA_PORT_SPEED_16GBPS:
101 return RPSC_OP_SPEED_16G;
102
103 case BFA_PORT_SPEED_10GBPS:
104 return RPSC_OP_SPEED_10G;
105
106 default:
107 return RPSC_OP_SPEED_NOT_EST;
108 }
109 }
110
111 enum fc_parse_status {
112 FC_PARSE_OK = 0,
113 FC_PARSE_FAILURE = 1,
114 FC_PARSE_BUSY = 2,
115 FC_PARSE_LEN_INVAL,
116 FC_PARSE_ACC_INVAL,
117 FC_PARSE_PWWN_NOT_EQUAL,
118 FC_PARSE_NWWN_NOT_EQUAL,
119 FC_PARSE_RXSZ_INVAL,
120 FC_PARSE_NOT_FCP,
121 FC_PARSE_OPAFLAG_INVAL,
122 FC_PARSE_RPAFLAG_INVAL,
123 FC_PARSE_OPA_INVAL,
124 FC_PARSE_RPA_INVAL,
125
126 };
127
128 struct fc_templates_s {
129 struct fchs_s fc_els_req;
130 struct fchs_s fc_bls_req;
131 struct fc_logi_s plogi;
132 struct fc_rrq_s rrq;
133 };
134
135 void fcbuild_init(void);
136
137 u16 fc_flogi_build(struct fchs_s *fchs, struct fc_logi_s *flogi,
138 u32 s_id, u16 ox_id, wwn_t port_name, wwn_t node_name,
139 u16 pdu_size, u8 set_npiv, u8 set_auth,
140 u16 local_bb_credits);
141
142 u16 fc_fdisc_build(struct fchs_s *buf, struct fc_logi_s *flogi, u32 s_id,
143 u16 ox_id, wwn_t port_name, wwn_t node_name,
144 u16 pdu_size);
145
146 u16 fc_flogi_acc_build(struct fchs_s *fchs, struct fc_logi_s *flogi,
147 u32 s_id, __be16 ox_id,
148 wwn_t port_name, wwn_t node_name,
149 u16 pdu_size,
150 u16 local_bb_credits, u8 bb_scn);
151
152 u16 fc_plogi_build(struct fchs_s *fchs, void *pld, u32 d_id,
153 u32 s_id, u16 ox_id, wwn_t port_name,
154 wwn_t node_name, u16 pdu_size, u16 bb_cr);
155
156 enum fc_parse_status fc_plogi_parse(struct fchs_s *fchs);
157
158 u16 fc_abts_build(struct fchs_s *buf, u32 d_id, u32 s_id,
159 u16 ox_id);
160
161 enum fc_parse_status fc_abts_rsp_parse(struct fchs_s *buf, int len);
162
163 u16 fc_rrq_build(struct fchs_s *buf, struct fc_rrq_s *rrq, u32 d_id,
164 u32 s_id, u16 ox_id, u16 rrq_oxid);
165 enum fc_parse_status fc_rrq_rsp_parse(struct fchs_s *buf, int len);
166
167 u16 fc_rspnid_build(struct fchs_s *fchs, void *pld, u32 s_id,
168 u16 ox_id, u8 *name);
169
170 u16 fc_rftid_build(struct fchs_s *fchs, void *pld, u32 s_id,
171 u16 ox_id, enum bfa_lport_role role);
172
173 u16 fc_rftid_build_sol(struct fchs_s *fchs, void *pyld, u32 s_id,
174 u16 ox_id, u8 *fc4_bitmap,
175 u32 bitmap_size);
176
177 u16 fc_rffid_build(struct fchs_s *fchs, void *pyld, u32 s_id,
178 u16 ox_id, u8 fc4_type, u8 fc4_ftrs);
179
180 u16 fc_gidpn_build(struct fchs_s *fchs, void *pyld, u32 s_id,
181 u16 ox_id, wwn_t port_name);
182
183 u16 fc_gpnid_build(struct fchs_s *fchs, void *pld, u32 s_id,
184 u16 ox_id, u32 port_id);
185
186 u16 fc_gs_rjt_build(struct fchs_s *fchs, struct ct_hdr_s *cthdr,
187 u32 d_id, u32 s_id, u16 ox_id,
188 u8 reason_code, u8 reason_code_expl);
189
190 u16 fc_scr_build(struct fchs_s *fchs, struct fc_scr_s *scr,
191 u8 set_br_reg, u32 s_id, u16 ox_id);
192
193 u16 fc_plogi_acc_build(struct fchs_s *fchs, void *pld, u32 d_id,
194 u32 s_id, u16 ox_id,
195 wwn_t port_name, wwn_t node_name,
196 u16 pdu_size, u16 bb_cr);
197
198 u16 fc_adisc_build(struct fchs_s *fchs, struct fc_adisc_s *adisc,
199 u32 d_id, u32 s_id, __be16 ox_id, wwn_t port_name,
200 wwn_t node_name);
201
202 enum fc_parse_status fc_adisc_parse(struct fchs_s *fchs, void *pld,
203 u32 host_dap, wwn_t node_name, wwn_t port_name);
204
205 enum fc_parse_status fc_adisc_rsp_parse(struct fc_adisc_s *adisc, int len,
206 wwn_t port_name, wwn_t node_name);
207
208 u16 fc_adisc_acc_build(struct fchs_s *fchs, struct fc_adisc_s *adisc,
209 u32 d_id, u32 s_id, __be16 ox_id,
210 wwn_t port_name, wwn_t node_name);
211 u16 fc_ls_rjt_build(struct fchs_s *fchs, struct fc_ls_rjt_s *ls_rjt,
212 u32 d_id, u32 s_id, __be16 ox_id,
213 u8 reason_code, u8 reason_code_expl);
214 u16 fc_ls_acc_build(struct fchs_s *fchs, struct fc_els_cmd_s *els_cmd,
215 u32 d_id, u32 s_id, __be16 ox_id);
216 u16 fc_prli_build(struct fchs_s *fchs, void *pld, u32 d_id,
217 u32 s_id, u16 ox_id);
218
219 enum fc_parse_status fc_prli_rsp_parse(struct fc_prli_s *prli, int len);
220
221 u16 fc_prli_acc_build(struct fchs_s *fchs, void *pld, u32 d_id,
222 u32 s_id, __be16 ox_id,
223 enum bfa_lport_role role);
224
225 u16 fc_rnid_build(struct fchs_s *fchs, struct fc_rnid_cmd_s *rnid,
226 u32 d_id, u32 s_id, u16 ox_id,
227 u32 data_format);
228
229 u16 fc_rnid_acc_build(struct fchs_s *fchs,
230 struct fc_rnid_acc_s *rnid_acc, u32 d_id, u32 s_id,
231 __be16 ox_id, u32 data_format,
232 struct fc_rnid_common_id_data_s *common_id_data,
233 struct fc_rnid_general_topology_data_s *gen_topo_data);
234
235 u16 fc_rpsc2_build(struct fchs_s *fchs, struct fc_rpsc2_cmd_s *rps2c,
236 u32 d_id, u32 s_id, u32 *pid_list, u16 npids);
237 u16 fc_rpsc_build(struct fchs_s *fchs, struct fc_rpsc_cmd_s *rpsc,
238 u32 d_id, u32 s_id, u16 ox_id);
239 u16 fc_rpsc_acc_build(struct fchs_s *fchs,
240 struct fc_rpsc_acc_s *rpsc_acc, u32 d_id, u32 s_id,
241 __be16 ox_id, struct fc_rpsc_speed_info_s *oper_speed);
242 u16 fc_gid_ft_build(struct fchs_s *fchs, void *pld, u32 s_id,
243 u8 fc4_type);
244
245 u16 fc_rpnid_build(struct fchs_s *fchs, void *pyld, u32 s_id,
246 u32 port_id, wwn_t port_name);
247
248 u16 fc_rnnid_build(struct fchs_s *fchs, void *pyld, u32 s_id,
249 u32 port_id, wwn_t node_name);
250
251 u16 fc_rcsid_build(struct fchs_s *fchs, void *pyld, u32 s_id,
252 u32 port_id, u32 cos);
253
254 u16 fc_rptid_build(struct fchs_s *fchs, void *pyld, u32 s_id,
255 u32 port_id, u8 port_type);
256
257 u16 fc_ganxt_build(struct fchs_s *fchs, void *pyld, u32 s_id,
258 u32 port_id);
259
260 u16 fc_logo_build(struct fchs_s *fchs, struct fc_logo_s *logo, u32 d_id,
261 u32 s_id, u16 ox_id, wwn_t port_name);
262
263 u16 fc_logo_acc_build(struct fchs_s *fchs, void *pld, u32 d_id,
264 u32 s_id, __be16 ox_id);
265
266 u16 fc_fdmi_reqhdr_build(struct fchs_s *fchs, void *pyld, u32 s_id,
267 u16 cmd_code);
268 u16 fc_gmal_req_build(struct fchs_s *fchs, void *pyld, u32 s_id, wwn_t wwn);
269 u16 fc_gfn_req_build(struct fchs_s *fchs, void *pyld, u32 s_id, wwn_t wwn);
270
271 void fc_get_fc4type_bitmask(u8 fc4_type, u8 *bit_mask);
272
273 void fc_els_req_build(struct fchs_s *fchs, u32 d_id, u32 s_id,
274 __be16 ox_id);
275
276 enum fc_parse_status fc_els_rsp_parse(struct fchs_s *fchs, int len);
277
278 enum fc_parse_status fc_plogi_rsp_parse(struct fchs_s *fchs, int len,
279 wwn_t port_name);
280
281 enum fc_parse_status fc_prli_parse(struct fc_prli_s *prli);
282
283 enum fc_parse_status fc_pdisc_parse(struct fchs_s *fchs, wwn_t node_name,
284 wwn_t port_name);
285
286 u16 fc_ba_acc_build(struct fchs_s *fchs, struct fc_ba_acc_s *ba_acc, u32 d_id,
287 u32 s_id, __be16 ox_id, u16 rx_id);
288
289 int fc_logout_params_pages(struct fchs_s *fc_frame, u8 els_code);
290
291 u16 fc_tprlo_acc_build(struct fchs_s *fchs, struct fc_tprlo_acc_s *tprlo_acc,
292 u32 d_id, u32 s_id, __be16 ox_id, int num_pages);
293
294 u16 fc_prlo_acc_build(struct fchs_s *fchs, struct fc_prlo_acc_s *prlo_acc,
295 u32 d_id, u32 s_id, __be16 ox_id, int num_pages);
296
297 u16 fc_logo_rsp_parse(struct fchs_s *fchs, int len);
298
299 u16 fc_pdisc_build(struct fchs_s *fchs, u32 d_id, u32 s_id,
300 u16 ox_id, wwn_t port_name, wwn_t node_name,
301 u16 pdu_size);
302
303 u16 fc_pdisc_rsp_parse(struct fchs_s *fchs, int len, wwn_t port_name);
304
305 u16 fc_prlo_build(struct fchs_s *fchs, u32 d_id, u32 s_id,
306 u16 ox_id, int num_pages);
307
308 u16 fc_prlo_rsp_parse(struct fchs_s *fchs, int len);
309
310 u16 fc_tprlo_build(struct fchs_s *fchs, u32 d_id, u32 s_id,
311 u16 ox_id, int num_pages, enum fc_tprlo_type tprlo_type,
312 u32 tpr_id);
313
314 u16 fc_tprlo_rsp_parse(struct fchs_s *fchs, int len);
315
316 u16 fc_ba_rjt_build(struct fchs_s *fchs, u32 d_id, u32 s_id,
317 __be16 ox_id, u32 reason_code, u32 reason_expl);
318
319 u16 fc_gnnid_build(struct fchs_s *fchs, void *pyld, u32 s_id, u16 ox_id,
320 u32 port_id);
321
322 u16 fc_ct_rsp_parse(struct ct_hdr_s *cthdr);
323
324 u16 fc_rscn_build(struct fchs_s *fchs, struct fc_rscn_pl_s *rscn, u32 s_id,
325 u16 ox_id);
326 #endif
327