1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 #ifndef _FCT_H 26 #define _FCT_H 27 28 /* 29 * Definitions for common FC Target. 30 */ 31 #include <sys/note.h> 32 #include <sys/stmf_defines.h> 33 #include <sys/fct_defines.h> 34 #include <sys/portif.h> 35 36 #ifdef __cplusplus 37 extern "C" { 38 #endif 39 40 typedef enum fct_struct_id { 41 FCT_STRUCT_LOCAL_PORT = 1, 42 FCT_STRUCT_REMOTE_PORT, 43 FCT_STRUCT_CMD_RCVD_ELS, 44 FCT_STRUCT_CMD_SOL_ELS, 45 FCT_STRUCT_CMD_SOL_CT, 46 FCT_STRUCT_CMD_RCVD_ABTS, 47 FCT_STRUCT_CMD_FCP_XCHG, 48 FCT_STRUCT_DBUF_STORE, 49 50 FCT_MAX_STRUCT_IDS 51 } fct_struct_id_t; 52 53 typedef struct fct_remote_port { 54 void *rp_fct_private; 55 void *rp_fca_private; 56 57 struct fct_local_port *rp_port; 58 char rp_nwwn_str[FC_WWN_BUFLEN]; 59 char rp_pwwn_str[FC_WWN_BUFLEN]; 60 uint8_t rp_nwwn[FC_WWN_LEN]; 61 uint8_t rp_pwwn[FC_WWN_LEN]; 62 uint32_t rp_id; /* 8 or 24 bit */ 63 uint32_t rp_hard_address; 64 uint16_t rp_handle; 65 } fct_remote_port_t; 66 67 #define FCT_HANDLE_NONE 0xffff 68 69 typedef struct fct_cmd { 70 void *cmd_fct_private; 71 void *cmd_fca_private; 72 void *cmd_specific; 73 74 struct fct_local_port *cmd_port; 75 76 /* During cmd porting this can be set to NULL */ 77 struct fct_remote_port *cmd_rp; 78 79 /* To link cmds together for handling things like ABTS. */ 80 struct fct_cmd *cmd_link; 81 uint8_t cmd_type; 82 uint8_t cmd_rsvd1; 83 84 /* During cmd posting this can be set to FCT_HANDLE_NONE */ 85 uint16_t cmd_rp_handle; 86 uint32_t cmd_handle; 87 uint32_t cmd_rportid; 88 uint32_t cmd_lportid; 89 uint32_t cmd_rsvd2; 90 uint16_t cmd_oxid; 91 uint16_t cmd_rxid; 92 fct_status_t cmd_comp_status; 93 } fct_cmd_t; 94 95 /* 96 * fcmd_cmd_handle: Bit definitions. 97 * 31 23 15 7 0 98 * +--------------+------------+------------+------------+ 99 * | V |uniq_cntr |fca specific| cmd slot index | 100 * +--------------+------------+------------+------------+ 101 * V = handle valid. 102 */ 103 #define CMD_HANDLE_SLOT_INDEX(x) ((x) & 0xffff) 104 #define CMD_HANDLE_VALID(x) ((x) & 0x80000000) 105 106 enum fct_cmd_types { 107 FCT_CMD_FCP_XCHG = 0x0001, 108 FCT_CMD_RCVD_ELS = 0x0002, 109 FCT_CMD_SOL_ELS = 0x0004, 110 FCT_CMD_RCVD_ABTS = 0x0008, 111 FCT_CMD_SOL_CT = 0x0010, 112 113 FCT_CMD_TYPE_ALL = 0xffff 114 }; 115 116 typedef struct fct_els { 117 uint16_t els_req_size; 118 uint16_t els_resp_size; 119 uint16_t els_req_alloc_size; 120 uint16_t els_resp_alloc_size; 121 uint8_t *els_req_payload; 122 uint8_t *els_resp_payload; 123 } fct_els_t; 124 125 typedef struct fct_sol_ct { 126 uint16_t ct_req_size; 127 uint16_t ct_resp_size; 128 uint16_t ct_req_alloc_size; 129 uint16_t ct_resp_alloc_size; 130 uint8_t *ct_req_payload; 131 uint8_t *ct_resp_payload; 132 } fct_sol_ct_t; 133 134 typedef struct fct_rcvd_abts { 135 uint8_t abts_resp_rctl; /* Can be BA_ACC or BA_RJT */ 136 uint8_t abts_state; 137 uint16_t rsvd; 138 uint8_t abts_resp_payload[12]; 139 } fct_rcvd_abts_t; 140 141 /* 142 * abts state 143 */ 144 #define ABTS_STATE_RECEIVED 0 145 #define ABTS_STATE_RESPONDED 1 146 #define ABTS_STATE_COMPLETED 2 147 #define ABTS_STATE_ABORT_REQUESTED 3 148 #define ABTS_STATE_ABORT_COMPLETED 4 149 150 #define FCHBA_MANUFACTURER_LEN 64 151 #define FCHBA_SERIAL_NUMBER_LEN 64 152 #define FCHBA_MODEL_LEN 256 153 #define FCHBA_MODEL_DESCRIPTION_LEN 256 154 #define FCHBA_HARDWARE_VERSION_LEN 256 155 #define FCHBA_DRIVER_VERSION_LEN 256 156 #define FCHBA_OPTION_ROM_VERSION_LEN 256 157 #define FCHBA_FIRMWARE_VERSION_LEN 256 158 #define FCHBA_DRIVER_NAME_LEN 256 159 #define FCHBA_SYMB_NAME_LEN 255 160 161 typedef struct fct_port_attrs { 162 char manufacturer[FCHBA_MANUFACTURER_LEN]; 163 char serial_number[FCHBA_SERIAL_NUMBER_LEN]; 164 char model[FCHBA_MODEL_LEN]; 165 char model_description[FCHBA_MODEL_DESCRIPTION_LEN]; 166 char hardware_version[FCHBA_HARDWARE_VERSION_LEN]; 167 char driver_version[FCHBA_DRIVER_VERSION_LEN]; 168 char option_rom_version[FCHBA_OPTION_ROM_VERSION_LEN]; 169 char firmware_version[FCHBA_FIRMWARE_VERSION_LEN]; 170 char driver_name[FCHBA_DRIVER_NAME_LEN]; 171 uint32_t vendor_specific_id; 172 uint32_t supported_cos; 173 uint32_t supported_speed; 174 uint32_t max_frame_size; 175 } fct_port_attrs_t; 176 177 typedef struct fct_dbuf_store { 178 void *fds_fct_private; 179 void *fds_fca_private; 180 struct stmf_dbuf_store *fds_ds; 181 182 stmf_data_buf_t *(*fds_alloc_data_buf)(struct fct_local_port *port, 183 uint32_t size, uint32_t *pminsize, uint32_t flags); 184 void (*fds_free_data_buf)(struct fct_dbuf_store *fds, 185 stmf_data_buf_t *dbuf); 186 } fct_dbuf_store_t; 187 188 typedef struct fct_local_port { 189 void *port_fct_private; 190 void *port_fca_private; 191 stmf_local_port_t *port_lport; 192 193 char port_nwwn_str[FC_WWN_BUFLEN]; 194 char port_pwwn_str[FC_WWN_BUFLEN]; 195 uint8_t port_nwwn[FC_WWN_LEN]; 196 uint8_t port_pwwn[FC_WWN_LEN]; 197 char *port_default_alias; 198 char *port_sym_node_name; 199 char *port_sym_port_name; 200 201 stmf_port_provider_t *port_pp; 202 203 uint32_t port_hard_address; 204 uint16_t port_max_logins; 205 uint16_t port_max_xchges; 206 uint32_t port_fca_fcp_cmd_size; 207 uint32_t port_fca_rp_private_size; 208 uint32_t port_fca_sol_els_private_size; 209 uint32_t port_fca_sol_ct_private_size; 210 211 /* in milliseconds */ 212 uint32_t port_fca_abort_timeout; 213 214 fct_dbuf_store_t *port_fds; 215 fct_status_t (*port_get_link_info)( 216 struct fct_local_port *port, struct fct_link_info *li); 217 fct_status_t (*port_register_remote_port)( 218 struct fct_local_port *port, struct fct_remote_port *rp, 219 struct fct_cmd *login_els); 220 fct_status_t (*port_deregister_remote_port)( 221 struct fct_local_port *port, struct fct_remote_port *rp); 222 fct_status_t (*port_send_cmd)(fct_cmd_t *cmd); 223 fct_status_t (*port_xfer_scsi_data)(fct_cmd_t *cmd, 224 stmf_data_buf_t *dbuf, uint32_t flags); 225 fct_status_t (*port_send_cmd_response)(fct_cmd_t *cmd, 226 uint32_t ioflags); 227 fct_status_t (*port_abort_cmd)(struct fct_local_port *port, 228 fct_cmd_t *cmd, uint32_t flags); 229 void (*port_ctl)(struct fct_local_port *port, 230 int cmd, void *arg); 231 fct_status_t (*port_flogi_xchg)(struct fct_local_port *port, 232 struct fct_flogi_xchg *fx); 233 void (*port_populate_hba_details)( 234 struct fct_local_port *port, struct fct_port_attrs *port_attrs); 235 } fct_local_port_t; 236 237 /* 238 * Common struct used during FLOGI exchange. 239 */ 240 typedef struct fct_flogi_xchg { 241 uint8_t fx_op; /* ELS_OP_FLOGI or ELS_OP_ACC/RJT */ 242 uint8_t fx_rjt_reason; 243 uint8_t fx_rjt_expl; 244 uint8_t fx_sec_timeout; /* Timeout in seconds */ 245 uint32_t fx_fport:1, /* 0=N_port, 1=F_port */ 246 rsvd2:31; 247 uint32_t fx_sid; /* 24 bit SID to use */ 248 uint32_t fx_did; /* 24 bit DID to use */ 249 uint8_t fx_pwwn[8]; 250 uint8_t fx_nwwn[8]; 251 } fct_flogi_xchg_t; 252 253 typedef struct fct_link_info { 254 uint32_t portid; 255 uint8_t port_topology; 256 uint8_t port_speed; 257 258 uint8_t rsvd:5, 259 260 /* 261 * FCA sets this bit to indicate that fct does not need to do FLOGI 262 * because either FCA did the FLOGI or it determined that its a private 263 * loop. Setting this bit by FCA is optional. 264 */ 265 port_no_fct_flogi:1, 266 267 /* FCA sets this bit to indicate that it did FLOGI */ 268 port_fca_flogi_done:1, 269 270 /* FCT sets this bit to indicate that it did FLOGI */ 271 port_fct_flogi_done:1; 272 273 uint8_t rsvd1; 274 275 /* The fields below are only valid if someone did a successful flogi */ 276 uint8_t port_rnwwn[8]; 277 uint8_t port_rpwwn[8]; 278 } fct_link_info_t; 279 280 /* 281 * port topology 282 */ 283 #define PORT_TOPOLOGY_UNKNOWN 0 284 #define PORT_TOPOLOGY_PT_TO_PT 1 285 #define PORT_TOPOLOGY_PRIVATE_LOOP 2 286 #define PORT_TOPOLOGY_PUBLIC_LOOP 6 287 #define PORT_TOPOLOGY_FABRIC_PT_TO_PT 5 288 #define PORT_TOPOLOGY_FABRIC_BIT 4 289 290 #define PORT_FLOGI_DONE(li) (((li)->port_fca_flogi_done) || \ 291 ((li)->port_fct_flogi_done)) 292 293 /* 294 * port speed 295 */ 296 #define PORT_SPEED_UNKNOWN 0 297 #define PORT_SPEED_1G 1 298 #define PORT_SPEED_2G 2 299 #define PORT_SPEED_4G 4 300 #define PORT_SPEED_8G 8 301 #define PORT_SPEED_10G 16 302 303 /* 304 * Abort commands 305 */ 306 #define FCT_TERMINATE_CMD 1 307 308 /* 309 * FCT port states. 310 */ 311 #define FCT_STATE_OFFLINE 0 312 #define FCT_STATE_ONLINING 1 313 #define FCT_STATE_ONLINE 2 314 #define FCT_STATE_OFFLINING 3 315 316 /* 317 * fct ctl commands. These should not conflict with stmf ctl commands 318 */ 319 #define FCT_CMD_PORT_ONLINE (STMF_LPORT_CTL_CMDS | 0x01) 320 #define FCT_CMD_PORT_ONLINE_COMPLETE (STMF_LPORT_CTL_CMDS | 0x02) 321 #define FCT_CMD_PORT_OFFLINE (STMF_LPORT_CTL_CMDS | 0x03) 322 #define FCT_CMD_PORT_OFFLINE_COMPLETE (STMF_LPORT_CTL_CMDS | 0x04) 323 #define FCT_ACK_PORT_ONLINE_COMPLETE (STMF_LPORT_CTL_CMDS | 0x05) 324 #define FCT_ACK_PORT_OFFLINE_COMPLETE (STMF_LPORT_CTL_CMDS | 0x06) 325 326 /* 327 * IO flags for cmd flow. 328 */ 329 #define FCT_IOF_FCA_DONE 0x10000 330 #define FCT_IOF_FORCE_FCA_DONE 0x20000 331 332 /* 333 * Fill CTIU preample 334 */ 335 #ifdef lint 336 #define FCT_FILL_CTIU_PREAMPLE(x_payload, x_ctop) _NOTE(EMPTY) 337 #else 338 #define FCT_FILL_CTIU_PREAMPLE(x_payload, x_ctop) \ 339 do { \ 340 x_payload[0] = 0x02; \ 341 x_payload[4] = 0xFC; \ 342 x_payload[5] = 0x02; \ 343 x_payload[8] = 0xFF & (x_ctop >> 8); \ 344 x_payload[9] = 0xFF & (x_ctop); \ 345 } while (0) 346 #endif 347 348 uint64_t fct_netbuf_to_value(uint8_t *buf, uint8_t nbytes); 349 void fct_value_to_netbuf(uint64_t value, uint8_t *buf, uint8_t nbytes); 350 void *fct_alloc(fct_struct_id_t struct_id, int additional_size, int flags); 351 void fct_free(void *ptr); 352 fct_cmd_t *fct_scsi_task_alloc(struct fct_local_port *port, 353 uint16_t rp_handle, uint32_t rportid, uint8_t *lun, 354 uint16_t cdb_length, uint16_t task_ext); 355 fct_status_t fct_register_local_port(fct_local_port_t *port); 356 fct_status_t fct_deregister_local_port(fct_local_port_t *port); 357 void fct_handle_event(fct_local_port_t *port, int event_id, 358 uint32_t event_flags, caddr_t arg); 359 void fct_post_rcvd_cmd(fct_cmd_t *cmd, stmf_data_buf_t *dbuf); 360 void fct_queue_cmd_for_termination(fct_cmd_t *cmd, fct_status_t s); 361 void fct_queue_scsi_task_for_termination(fct_cmd_t *cmd, fct_status_t s); 362 fct_cmd_t *fct_handle_to_cmd(fct_local_port_t *port, uint32_t fct_handle); 363 void fct_ctl(struct stmf_local_port *lport, int cmd, void *arg); 364 void fct_cmd_fca_aborted(fct_cmd_t *cmd, fct_status_t s, uint32_t ioflags); 365 uint16_t fct_get_rp_handle(fct_local_port_t *port, uint32_t rportid); 366 void fct_send_response_done(fct_cmd_t *cmd, fct_status_t s, uint32_t ioflags); 367 void fct_send_cmd_done(fct_cmd_t *cmd, fct_status_t s, uint32_t ioflags); 368 void fct_scsi_data_xfer_done(fct_cmd_t *cmd, stmf_data_buf_t *dbuf, 369 uint32_t ioflags); 370 fct_status_t fct_port_initialize(fct_local_port_t *port, uint32_t rflags, 371 char *additional_info); 372 fct_status_t fct_port_shutdown(fct_local_port_t *port, uint32_t rflags, 373 char *additional_info); 374 fct_status_t fct_handle_rcvd_flogi(fct_local_port_t *port, 375 fct_flogi_xchg_t *fx); 376 void fct_log_local_port_event(fct_local_port_t *port, char *subclass); 377 void fct_log_remote_port_event(fct_local_port_t *port, char *subclass, 378 uint8_t *rp_pwwn, uint32_t rp_id); 379 void fct_wwn_to_str(char *to_ptr, const uint8_t *from_ptr); 380 381 #ifdef __cplusplus 382 } 383 #endif 384 385 #endif /* _FCT_H */ 386