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_IOCTL_H 26 #define _STMF_IOCTL_H 27 28 #ifdef __cplusplus 29 extern "C" { 30 #endif 31 32 #define STMF_VERSION_1 1 33 34 #define STMF_IOCTL (((uint32_t)'S') << 24) 35 #define STMF_IOCTL_LU_LIST (STMF_IOCTL | 1) 36 #define STMF_IOCTL_TARGET_PORT_LIST (STMF_IOCTL | 2) 37 #define STMF_IOCTL_SESSION_LIST (STMF_IOCTL | 3) 38 #define STMF_IOCTL_GET_LU_PROPERTIES (STMF_IOCTL | 4) 39 #define STMF_IOCTL_GET_TARGET_PORT_PROPERTIES (STMF_IOCTL | 5) 40 #define STMF_IOCTL_SET_STMF_STATE (STMF_IOCTL | 6) 41 #define STMF_IOCTL_GET_STMF_STATE (STMF_IOCTL | 7) 42 #define STMF_IOCTL_SET_LU_STATE (STMF_IOCTL | 8) 43 #define STMF_IOCTL_SET_TARGET_PORT_STATE (STMF_IOCTL | 9) 44 #define STMF_IOCTL_CREATE_HOST_GROUP (STMF_IOCTL | 10) 45 #define STMF_IOCTL_REMOVE_HOST_GROUP (STMF_IOCTL | 11) 46 #define STMF_IOCTL_ADD_HG_ENTRY (STMF_IOCTL | 12) 47 #define STMF_IOCTL_REMOVE_HG_ENTRY (STMF_IOCTL | 13) 48 #define STMF_IOCTL_CREATE_TARGET_GROUP (STMF_IOCTL | 14) 49 #define STMF_IOCTL_REMOVE_TARGET_GROUP (STMF_IOCTL | 15) 50 #define STMF_IOCTL_ADD_TG_ENTRY (STMF_IOCTL | 16) 51 #define STMF_IOCTL_REMOVE_TG_ENTRY (STMF_IOCTL | 17) 52 #define STMF_IOCTL_ADD_VIEW_ENTRY (STMF_IOCTL | 18) 53 #define STMF_IOCTL_REMOVE_VIEW_ENTRY (STMF_IOCTL | 19) 54 #define STMF_IOCTL_GET_HG_LIST (STMF_IOCTL | 20) 55 #define STMF_IOCTL_GET_TG_LIST (STMF_IOCTL | 21) 56 #define STMF_IOCTL_GET_HG_ENTRIES (STMF_IOCTL | 22) 57 #define STMF_IOCTL_GET_TG_ENTRIES (STMF_IOCTL | 23) 58 #define STMF_IOCTL_GET_VE_LIST (STMF_IOCTL | 24) 59 #define STMF_IOCTL_LOAD_PP_DATA (STMF_IOCTL | 25) 60 #define STMF_IOCTL_CLEAR_PP_DATA (STMF_IOCTL | 26) 61 #define STMF_IOCTL_GET_PP_DATA (STMF_IOCTL | 27) 62 #define STMF_IOCTL_CLEAR_TRACE (STMF_IOCTL | 28) 63 #define STMF_IOCTL_ADD_TRACE (STMF_IOCTL | 29) 64 #define STMF_IOCTL_GET_TRACE_POSITION (STMF_IOCTL | 30) 65 #define STMF_IOCTL_GET_TRACE (STMF_IOCTL | 31) 66 #define STMF_IOCTL_REG_LU_LIST (STMF_IOCTL | 32) 67 #define STMF_IOCTL_VE_LU_LIST (STMF_IOCTL | 33) 68 #define STMF_IOCTL_LU_VE_LIST (STMF_IOCTL | 34) 69 #define STMF_IOCTL_VALIDATE_VIEW (STMF_IOCTL | 35) 70 71 typedef struct stmf_iocdata { 72 uint32_t stmf_version; 73 uint32_t stmf_error; 74 uint32_t stmf_ibuf_size; 75 uint32_t stmf_obuf_size; 76 uint32_t stmf_obuf_nentries; /* # entries xferred */ 77 uint32_t stmf_obuf_max_nentries; /* #,could have been xferred */ 78 uint64_t stmf_ibuf; 79 uint64_t stmf_obuf; 80 } stmf_iocdata_t; 81 82 typedef struct slist_lu { 83 uint8_t lu_guid[16]; 84 } slist_lu_t; 85 86 typedef struct slist_target_port { 87 uint8_t target[260]; 88 } slist_target_port_t; 89 90 typedef struct slist_scsi_session { 91 uint8_t initiator[260]; 92 /* creation_time is really time_t. But time_t is defined as long. */ 93 uint32_t creation_time; 94 char alias[256]; 95 } slist_scsi_session_t; 96 97 /* 98 * States for LUs and LPORTs 99 */ 100 #define STMF_STATE_OFFLINE 0 101 #define STMF_STATE_ONLINING 1 102 #define STMF_STATE_ONLINE 2 103 #define STMF_STATE_OFFLINING 3 104 105 /* 106 * States for the STMF config. 107 */ 108 #define STMF_CONFIG_NONE 0 109 #define STMF_CONFIG_INIT 1 110 #define STMF_CONFIG_INIT_DONE 2 111 112 typedef struct sioc_lu_props { 113 uint8_t lu_guid[16]; 114 uint8_t lu_state:4, 115 lu_present:1, 116 lu_rsvd:3; 117 char lu_provider_name[255]; 118 char lu_alias[256]; 119 } sioc_lu_props_t; 120 121 typedef struct sioc_target_port_props { 122 uint8_t tgt_id[260]; 123 uint8_t tgt_state:4, 124 tgt_present:1, 125 tgt_rsvd:3; 126 char tgt_provider_name[255]; 127 char tgt_alias[256]; 128 } sioc_target_port_props_t; 129 130 /* 131 * This struct is used for getting and setting state of LU/LPORT or STMF. 132 */ 133 typedef struct stmf_state_desc { 134 uint8_t ident[260]; /* N/A for STMF itself */ 135 uint8_t state; 136 uint8_t config_state; /* N/A for LU/LPORTs */ 137 } stmf_state_desc_t; 138 139 /* Error definitions for group/view entry/provider dataioctls */ 140 #define STMF_IOCERR_NONE 0 141 #define STMF_IOCERR_HG_EXISTS 1 142 #define STMF_IOCERR_INVALID_HG 2 143 #define STMF_IOCERR_TG_EXISTS 3 144 #define STMF_IOCERR_INVALID_TG 4 145 #define STMF_IOCERR_HG_ENTRY_EXISTS 5 146 #define STMF_IOCERR_INVALID_HG_ENTRY 6 147 #define STMF_IOCERR_TG_ENTRY_EXISTS 7 148 #define STMF_IOCERR_INVALID_TG_ENTRY 8 149 #define STMF_IOCERR_TG_UPDATE_NEED_SVC_OFFLINE 9 150 #define STMF_IOCERR_LU_NUMBER_IN_USE 10 151 #define STMF_IOCERR_INVALID_LU_ID 11 152 #define STMF_IOCERR_VIEW_ENTRY_CONFLICT 12 153 #define STMF_IOCERR_HG_IN_USE 13 154 #define STMF_IOCERR_TG_IN_USE 14 155 #define STMF_IOCERR_INVALID_VIEW_ENTRY 15 156 #define STMF_IOCERR_INVALID_VE_ID 16 157 #define STMF_IOCERR_UPDATE_NEED_CFG_INIT 17 158 #define STMF_IOCERR_PPD_UPDATED 18 159 #define STMF_IOCERR_INSUFFICIENT_BUF 19 160 #define STMF_IOCERR_TG_NEED_TG_OFFLINE 20 161 162 163 typedef struct stmf_group_name { 164 uint16_t name_size; /* in bytes */ 165 uint16_t rsvd_1; 166 uint32_t rsvd_2; 167 uint8_t name[512]; /* 256 * wchar_t */ 168 } stmf_group_name_t; 169 170 /* 171 * struct used to operate (add/remove entry) on a group. 172 */ 173 174 typedef struct stmf_ge_ident { 175 uint16_t ident_size; 176 uint8_t ident[256]; 177 } stmf_ge_ident_t; 178 179 typedef struct stmf_group_op_data { 180 stmf_group_name_t group; 181 uint8_t ident[260]; 182 } stmf_group_op_data_t; 183 184 typedef struct stmf_view_op_entry { 185 uint32_t ve_ndx_valid:1, 186 ve_lu_number_valid:1, 187 ve_all_hosts:1, 188 ve_all_targets:1, 189 rsvd:28; 190 uint32_t ve_ndx; 191 uint8_t ve_lu_nbr[8]; 192 uint8_t ve_guid[16]; 193 stmf_group_name_t ve_host_group; 194 stmf_group_name_t ve_target_group; 195 } stmf_view_op_entry_t; 196 197 typedef struct stmf_ppioctl_data { 198 char ppi_name[255]; /* Provider name including \0 */ 199 uint8_t ppi_port_provider:1, 200 ppi_lu_provider:1, 201 ppi_token_valid:1, 202 ppt_rsvd:5; 203 uint64_t ppi_token; 204 uint64_t ppi_data_size; 205 uint8_t ppi_data[8]; 206 } stmf_ppioctl_data_t; 207 208 /* 209 * SCSI device ID descriptor as per SPC3 7.6.3 210 */ 211 typedef struct scsi_devid_desc { 212 #ifdef _BIT_FIELDS_HTOL 213 uint8_t protocol_id:4, 214 code_set:4; 215 uint8_t piv:1, 216 rsvd1:1, 217 association:2, 218 ident_type:4; 219 #else 220 uint8_t code_set:4, 221 protocol_id:4; 222 uint8_t ident_type:4, 223 association:2, 224 rsvd1:1, 225 piv:1; 226 #endif 227 uint8_t rsvd2; 228 uint8_t ident_length; 229 uint8_t ident[1]; 230 } scsi_devid_desc_t; 231 232 /* 233 * Protocol Identifier 234 */ 235 #define PROTOCOL_FIBRE_CHANNEL 0 236 #define PROTOCOL_PARALLEL_SCSI 1 237 #define PROTOCOL_SSA 2 238 #define PROTOCOL_IEEE_1394 3 239 #define PROTOCOL_SRP 4 240 #define PROTOCOL_iSCSI 5 241 #define PROTOCOL_SAS 6 242 #define PROTOCOL_ADT 7 243 #define PROTOCOL_ATAPI 8 244 #define PROTOCOL_ANY 15 245 246 /* 247 * Code set definitions 248 */ 249 #define CODE_SET_BINARY 1 250 #define CODE_SET_ASCII 2 251 #define CODE_SET_UTF8 3 252 253 /* 254 * Association values 255 */ 256 #define ID_IS_LOGICAL_UNIT 0 257 #define ID_IS_TARGET_PORT 1 258 #define ID_IS_TARGET_CONTAINING_LU 2 259 260 /* 261 * ident type 262 */ 263 #define ID_TYPE_VENDOR_SPECIFIC 0 264 #define ID_TYPE_T10_VID 1 265 #define ID_TYPE_EUI64 2 266 #define ID_TYPE_NAA 3 267 #define ID_TYPE_RELATIVE_TARGET_PORT 4 268 #define ID_TYPE_TARGET_PORT_GROUP 5 269 #define ID_TYPE_LOGICAL_UNIT_GROUP 6 270 #define ID_TYPE_MD5_LOGICAL_UNIT 7 271 #define ID_TYPE_SCSI_NAME_STRING 8 272 273 int stmf_copyin_iocdata(intptr_t data, int mode, stmf_iocdata_t **iocd, 274 void **ibuf, void **obuf); 275 int stmf_copyout_iocdata(intptr_t data, int mode, stmf_iocdata_t *iocd, 276 void *obuf); 277 278 #ifdef __cplusplus 279 } 280 #endif 281 282 #endif /* _STMF_IOCTL_H */ 283