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 _STMF_H 26 #define _STMF_H 27 28 #include <sys/stmf_defines.h> 29 30 #ifdef __cplusplus 31 extern "C" { 32 #endif 33 34 typedef enum stmf_struct_id { 35 STMF_STRUCT_LU_PROVIDER = 1, 36 STMF_STRUCT_PORT_PROVIDER, 37 STMF_STRUCT_STMF_LOCAL_PORT, 38 STMF_STRUCT_STMF_LU, 39 STMF_STRUCT_SCSI_SESSION, 40 STMF_STRUCT_SCSI_TASK, 41 STMF_STRUCT_DATA_BUF, 42 STMF_STRUCT_DBUF_STORE, 43 STMF_MAX_STRUCT_IDS 44 } stmf_struct_id_t; 45 46 /* 47 * Provider callback commands 48 */ 49 #define STMF_PROVIDER_DATA_UPDATED 0x01 50 51 /* 52 * Provider callback flags 53 */ 54 #define STMF_PCB_STMF_ONLINING 0x0001 55 #define STMF_PCB_PREG_COMPLETE 0x0002 56 57 typedef void *data_seg_handle_t; 58 #define STMF_MAX_LU_CACHE_NTASKS 16 59 60 #define STMF_NO_HANDLE 0xffffffff 61 62 #define COMPANY_ID_NONE 0xFFFFFFFF 63 #define COMPANY_ID_SUN 0x00144F 64 65 typedef struct stmf_data_buf { 66 void *db_stmf_private; 67 void *db_port_private; 68 void *db_lu_private; 69 uint32_t db_buf_size; /* Total size of this buffer */ 70 uint32_t db_data_size; /* Intended xfer size of this buffer */ 71 uint32_t db_relative_offset; 72 uint16_t db_sglist_length; 73 uint16_t db_flags; /* Direction, auto status etc */ 74 stmf_status_t db_xfer_status; 75 uint8_t db_handle; /* To track parallel buffers */ 76 struct stmf_sglist_ent { 77 uint32_t seg_length; 78 uint8_t *seg_addr; 79 } db_sglist[1]; 80 } stmf_data_buf_t; 81 82 /* 83 * db_flags 84 */ 85 #define DB_DIRECTION_TO_RPORT 0x0001 86 #define DB_DIRECTION_FROM_RPORT 0x0002 87 #define DB_SEND_STATUS_GOOD 0x0004 88 #define DB_STATUS_GOOD_SENT 0x0008 89 #define DB_DONT_CACHE 0x0010 90 #define DB_DONT_REUSE 0x0020 91 92 typedef struct scsi_task { 93 void *task_stmf_private; 94 void *task_port_private; 95 96 void *task_lu_private; 97 struct stmf_scsi_session *task_session; 98 struct stmf_local_port *task_lport; 99 struct stmf_lu *task_lu; 100 void *task_lu_itl_handle; /* Assigned by LU */ 101 102 /* CMD information from initiator */ 103 uint8_t task_lun_no[8]; 104 uint8_t task_flags; /* See def. for task flags */ 105 uint8_t task_priority; /* As per SAM-3 */ 106 uint8_t task_mgmt_function; /* If this is a TM request */ 107 uint8_t task_max_nbufs; 108 uint8_t task_cur_nbufs; 109 uint8_t task_csn_size; /* cmd seq no size in bits */ 110 uint16_t task_additional_flags; 111 uint32_t task_cmd_seq_no; 112 uint32_t task_expected_xfer_length; 113 uint32_t task_timeout; /* In seconds */ 114 uint16_t task_ext_id; 115 uint16_t task_cdb_length; 116 uint8_t *task_cdb; 117 118 /* Fields to manage data phase */ 119 uint32_t task_cmd_xfer_length; /* xfer len based on CDB */ 120 uint32_t task_nbytes_transferred; 121 122 /* Status Phase */ 123 stmf_status_t task_completion_status; 124 uint32_t task_resid; 125 uint8_t task_status_ctrl; /* See def. for status ctrl */ 126 uint8_t task_scsi_status; 127 uint16_t task_sense_length; 128 uint8_t *task_sense_data; 129 130 /* Misc. task data */ 131 void *task_extended_cmd; 132 133 } scsi_task_t; 134 135 /* 136 * Maximum expected transfer length. Can also be used when the transfer 137 * length is unknown when the task is allocated (e.g. SAS) 138 */ 139 140 #define TASK_MAX_XFER_LENGTH 0xFFFFFFFF 141 142 /* 143 * task_flags definitions. 144 */ 145 /* 146 * If TF_INITIAL_BURST is set, the dbuf passed with new_task() contains 147 * data from initial burst. Otherwise its just a buffer which the port 148 * passed to the LU. 149 */ 150 #define TF_INITIAL_BURST 0x80 151 /* Both READ_DATA and WRITE_DATA can be set for bidirectional xfers */ 152 #define TF_READ_DATA 0x40 153 #define TF_WRITE_DATA 0x20 154 #define TF_ATTR_MASK 0x07 155 #define TF_ATTR_UNTAGGED 0x0 156 #define TF_ATTR_SIMPLE_QUEUE 0x1 157 #define TF_ATTR_ORDERED_QUEUE 0x2 158 #define TF_ATTR_HEAD_OF_QUEUE 0x3 159 #define TF_ATTR_ACA 0x4 160 161 /* 162 * Task Management flags. 163 */ 164 #define TM_NONE 0x00 165 #define TM_ABORT_TASK 0x01 166 #define TM_ABORT_TASK_SET 0x02 167 #define TM_CLEAR_ACA 0x03 168 #define TM_CLEAR_TASK_SET 0x04 169 #define TM_LUN_RESET 0x05 170 #define TM_TARGET_WARM_RESET 0x06 171 #define TM_TARGET_COLD_RESET 0x07 172 #define TM_TASK_REASSIGN 0x08 173 #define TM_TARGET_RESET 0x09 174 #define TM_QUERY_TASK 0x0A 175 176 /* 177 * additional flags 178 */ 179 #define TASK_AF_ENABLE_COMP_CONF 0x01 180 #define TASK_AF_PORT_LOAD_HIGH 0x02 181 #define TASK_AF_NO_EXPECTED_XFER_LENGTH 0x04 182 183 /* 184 * scsi_task_t extension identifiers 185 */ 186 #define STMF_TASK_EXT_NONE 0 187 188 /* 189 * max_nbufs 190 */ 191 #define STMF_BUFS_MAX 255 192 193 /* 194 * Task status ctrl 195 */ 196 #define TASK_SCTRL_OVER 1 197 #define TASK_SCTRL_UNDER 2 198 199 /* 200 * The flags used by I/O flow. 201 */ 202 #define STMF_IOF_LU_DONE 0x0001 203 #define STMF_IOF_LPORT_DONE 0x0002 204 205 /* 206 * struct allocation flags 207 */ 208 #define AF_FORCE_NOSLEEP 0x0001 209 210 typedef struct stmf_state_change_info { 211 uint64_t st_rflags; /* Reason behin this change */ 212 char *st_additional_info; 213 } stmf_state_change_info_t; 214 215 typedef struct stmf_change_status { 216 stmf_status_t st_completion_status; 217 char *st_additional_info; 218 } stmf_change_status_t; 219 220 /* 221 * conditions causing or affecting the change. 222 */ 223 #define STMF_RFLAG_USER_REQUEST 0x0001 224 #define STMF_RFLAG_FATAL_ERROR 0x0002 225 #define STMF_RFLAG_STAY_OFFLINED 0x0004 226 #define STMF_RFLAG_RESET 0x0008 227 #define STMF_RFLAG_COLLECT_DEBUG_DUMP 0x0010 228 #define STMF_RFLAG_LU_ABORT 0x0020 229 #define STMF_RFLAG_LPORT_ABORT 0x0040 230 231 #define STMF_CHANGE_INFO_LEN 160 232 233 /* 234 * cmds to stmf_abort entry point 235 */ 236 #define STMF_QUEUE_TASK_ABORT 1 237 #define STMF_REQUEUE_TASK_ABORT_LPORT 2 238 #define STMF_REQUEUE_TASK_ABORT_LU 3 239 #define STMF_QUEUE_ABORT_LU 4 240 241 /* 242 * cmds to be used by stmf ctl 243 */ 244 #define STMF_CMD_LU_OP 0x0100 245 #define STMF_CMD_LPORT_OP 0x0200 246 #define STMF_CMD_MASK 0x00ff 247 #define STMF_CMD_ONLINE 0x0001 248 #define STMF_CMD_OFFLINE 0x0002 249 #define STMF_CMD_GET_STATUS 0x0003 250 #define STMF_CMD_ONLINE_COMPLETE 0x0004 251 #define STMF_CMD_OFFLINE_COMPLETE 0x0005 252 #define STMF_ACK_ONLINE_COMPLETE 0x0006 253 #define STMF_ACK_OFFLINE_COMPLETE 0x0007 254 255 #define STMF_CMD_LU_ONLINE (STMF_CMD_LU_OP | STMF_CMD_ONLINE) 256 #define STMF_CMD_LU_OFFLINE (STMF_CMD_LU_OP | STMF_CMD_OFFLINE) 257 #define STMF_CMD_LPORT_ONLINE (STMF_CMD_LPORT_OP | STMF_CMD_ONLINE) 258 #define STMF_CMD_LPORT_OFFLINE (STMF_CMD_LPORT_OP | STMF_CMD_OFFLINE) 259 #define STMF_CMD_GET_LU_STATUS (STMF_CMD_LU_OP | STMF_CMD_GET_STATUS) 260 #define STMF_CMD_GET_LPORT_STATUS \ 261 (STMF_CMD_LPORT_OP | STMF_CMD_GET_STATUS) 262 #define STMF_CMD_LU_ONLINE_COMPLETE \ 263 (STMF_CMD_LU_OP | STMF_CMD_ONLINE_COMPLETE) 264 #define STMF_CMD_LPORT_ONLINE_COMPLETE \ 265 (STMF_CMD_LPORT_OP | STMF_CMD_ONLINE_COMPLETE) 266 #define STMF_ACK_LU_ONLINE_COMPLETE \ 267 (STMF_CMD_LU_OP | STMF_ACK_ONLINE_COMPLETE) 268 #define STMF_ACK_LPORT_ONLINE_COMPLETE \ 269 (STMF_CMD_LPORT_OP | STMF_ACK_ONLINE_COMPLETE) 270 #define STMF_CMD_LU_OFFLINE_COMPLETE \ 271 (STMF_CMD_LU_OP | STMF_CMD_OFFLINE_COMPLETE) 272 #define STMF_CMD_LPORT_OFFLINE_COMPLETE \ 273 (STMF_CMD_LPORT_OP | STMF_CMD_OFFLINE_COMPLETE) 274 #define STMF_ACK_LU_OFFLINE_COMPLETE \ 275 (STMF_CMD_LU_OP | STMF_ACK_OFFLINE_COMPLETE) 276 #define STMF_ACK_LPORT_OFFLINE_COMPLETE \ 277 (STMF_CMD_LPORT_OP | STMF_ACK_OFFLINE_COMPLETE) 278 /* 279 * For LPORTs and LUs to create their own ctl cmds which dont 280 * conflict with stmf ctl cmds. 281 */ 282 #define STMF_LPORT_CTL_CMDS 0x1000 283 #define STMF_LU_CTL_CMDS 0x2000 284 285 /* 286 * Commands for various info routines. 287 */ 288 /* Command classifiers */ 289 #define SI_LPORT 0x1000000 290 #define SI_STMF 0x2000000 291 #define SI_LU 0x4000000 292 #define SI_LPORT_FC 0x0000000 293 #define SI_LPORT_ISCSI 0x0010000 294 #define SI_LPORT_SAS 0x0020000 295 #define SI_STMF_LU 0x0010000 296 #define SI_STMF_LPORT 0x0020000 297 298 #define SI_GET_CLASS(v) ((v) & 0xFF000000) 299 #define SI_GET_SUBCLASS(v) ((v) & 0x00FF0000) 300 301 /* Commands for LPORT info routines */ 302 /* XXX - Implement these. */ 303 #if 0 304 #define SI_LPORT_FC_PORTINFO (SI_LPORT | SI_LPORT_FC | 1) 305 #define SI_RPORT_FC_PORTINFO (SI_LPORT | SI_LPORT_FC | 2) 306 #endif 307 308 /* 309 * Events 310 */ 311 #define STMF_EVENT_ALL ((int)-1) 312 #define LPORT_EVENT_INITIAL_LUN_MAPPED 0 313 314 /* 315 * This needs to go into common/ddi/sunddi.h 316 */ 317 #define DDI_NT_STMF "ddi_scsi_target:framework" 318 #define DDI_NT_STMF_LP "ddi_scsi_target:lu_provider" 319 #define DDI_NT_STMF_PP "ddi_scsi_target:port_provider" 320 321 /* 322 * VPD page bits. 323 */ 324 #define STMF_VPD_LU_ID 0x01 325 #define STMF_VPD_TARGET_ID 0x02 326 #define STMF_VPD_TP_GROUP 0x04 327 #define STMF_VPD_RELATIVE_TP_ID 0x08 328 329 /* 330 * Common macros to simplify coding 331 */ 332 #define STMF_SEC2TICK(x_sec) (drv_usectohz((x_sec) * 1000000)) 333 334 void stmf_trace(caddr_t ident, const char *fmt, ...); 335 void *stmf_alloc(stmf_struct_id_t sid, int additional_size, int alloc_flags); 336 void stmf_free(void *struct_ptr); 337 struct scsi_task *stmf_task_alloc(struct stmf_local_port *lport, 338 struct stmf_scsi_session *ss, uint8_t *lun, uint16_t cdb_length, 339 uint16_t ext_id); 340 void stmf_post_task(scsi_task_t *task, stmf_data_buf_t *dbuf); 341 stmf_data_buf_t *stmf_alloc_dbuf(scsi_task_t *task, uint32_t size, 342 uint32_t *pminsize, uint32_t flags); 343 void stmf_free_dbuf(scsi_task_t *task, stmf_data_buf_t *dbuf); 344 stmf_status_t stmf_xfer_data(scsi_task_t *task, stmf_data_buf_t *dbuf, 345 uint32_t ioflags); 346 stmf_status_t stmf_send_scsi_status(scsi_task_t *task, uint32_t ioflags); 347 void stmf_data_xfer_done(scsi_task_t *task, stmf_data_buf_t *dbuf, 348 uint32_t iof); 349 void stmf_send_status_done(scsi_task_t *task, stmf_status_t s, uint32_t iof); 350 void stmf_task_lu_done(scsi_task_t *task); 351 void stmf_abort(int abort_cmd, scsi_task_t *task, stmf_status_t s, void *arg); 352 void stmf_task_lu_aborted(scsi_task_t *task, stmf_status_t s, uint32_t iof); 353 void stmf_task_lport_aborted(scsi_task_t *task, stmf_status_t s, uint32_t iof); 354 stmf_status_t stmf_task_poll_lu(scsi_task_t *task, uint32_t timeout); 355 stmf_status_t stmf_task_poll_lport(scsi_task_t *task, uint32_t timeout); 356 stmf_status_t stmf_ctl(int cmd, void *obj, void *arg); 357 stmf_status_t stmf_register_itl_handle(struct stmf_lu *lu, uint8_t *lun, 358 struct stmf_scsi_session *ss, uint64_t session_id, void *itl_handle); 359 stmf_status_t stmf_deregister_itl_handle(struct stmf_lu *lu, uint8_t *lun, 360 struct stmf_scsi_session *ss, uint64_t session_id, void *itl_handle); 361 stmf_status_t stmf_deregister_all_lu_itl_handles(struct stmf_lu *lu); 362 stmf_status_t stmf_get_itl_handle(struct stmf_lu *lu, uint8_t *lun, 363 struct stmf_scsi_session *ss, uint64_t session_id, void **itl_handle_retp); 364 stmf_data_buf_t *stmf_handle_to_buf(scsi_task_t *task, uint8_t h); 365 stmf_status_t stmf_lu_add_event(struct stmf_lu *lu, int eventid); 366 stmf_status_t stmf_lu_remove_event(struct stmf_lu *lu, int eventid); 367 stmf_status_t stmf_lport_add_event(struct stmf_local_port *lport, int eventid); 368 stmf_status_t stmf_lport_remove_event(struct stmf_local_port *lport, 369 int eventid); 370 void stmf_wwn_to_devid_desc(struct scsi_devid_desc *sdid, uint8_t *wwn, 371 uint8_t protocol_id); 372 stmf_status_t stmf_scsilib_uniq_lu_id(uint32_t company_id, 373 struct scsi_devid_desc *lu_id); 374 void stmf_scsilib_send_status(scsi_task_t *task, uint8_t st, uint32_t saa); 375 uint32_t stmf_scsilib_prepare_vpd_page83(scsi_task_t *task, uint8_t *page, 376 uint32_t page_len, uint8_t byte0, uint32_t vpd_mask); 377 void stmf_scsilib_handle_report_tpgs(scsi_task_t *task, stmf_data_buf_t *dbuf); 378 void stmf_scsilib_handle_task_mgmt(scsi_task_t *task); 379 380 #ifdef __cplusplus 381 } 382 #endif 383 384 #endif /* _STMF_H */ 385