1 /*- 2 * Copyright (c) 2003 Silicon Graphics International Corp. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions, and the following disclaimer, 10 * without modification. 11 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 12 * substantially similar to the "NO WARRANTY" disclaimer below 13 * ("Disclaimer") and any redistribution must be conditioned upon 14 * including a substantially similar Disclaimer requirement for further 15 * binary redistribution. 16 * 17 * NO WARRANTY 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 27 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28 * POSSIBILITY OF SUCH DAMAGES. 29 * 30 * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl.h#5 $ 31 * $FreeBSD$ 32 */ 33 /* 34 * Function definitions used both within CTL and potentially in various CTL 35 * clients. 36 * 37 * Author: Ken Merry <ken@FreeBSD.org> 38 */ 39 40 #ifndef _CTL_H_ 41 #define _CTL_H_ 42 43 #define CTL_RETVAL_COMPLETE 0 44 #define CTL_RETVAL_QUEUED 1 45 #define CTL_RETVAL_ALLOCATED 2 46 #define CTL_RETVAL_ERROR 3 47 48 typedef enum { 49 CTL_PORT_NONE = 0x00, 50 CTL_PORT_FC = 0x01, 51 CTL_PORT_SCSI = 0x02, 52 CTL_PORT_IOCTL = 0x04, 53 CTL_PORT_INTERNAL = 0x08, 54 CTL_PORT_ISCSI = 0x10, 55 CTL_PORT_SAS = 0x20, 56 CTL_PORT_ALL = 0xff, 57 CTL_PORT_ISC = 0x100 // FC port for inter-shelf communication 58 } ctl_port_type; 59 60 struct ctl_port_entry { 61 ctl_port_type port_type; 62 char port_name[64]; 63 int32_t targ_port; 64 int physical_port; 65 int virtual_port; 66 u_int flags; 67 #define CTL_PORT_WWNN_VALID 0x01 68 #define CTL_PORT_WWPN_VALID 0x02 69 uint64_t wwnn; 70 uint64_t wwpn; 71 int online; 72 }; 73 74 struct ctl_modepage_header { 75 uint8_t page_code; 76 uint8_t subpage; 77 int32_t len_used; 78 int32_t len_left; 79 }; 80 81 struct ctl_modepage_aps { 82 struct ctl_modepage_header header; 83 uint8_t lock_active; 84 }; 85 86 union ctl_modepage_info { 87 struct ctl_modepage_header header; 88 struct ctl_modepage_aps aps; 89 }; 90 91 /* 92 * Serial number length, for VPD page 0x80. 93 */ 94 #define CTL_SN_LEN 16 95 96 /* 97 * Device ID length, for VPD page 0x83. 98 */ 99 #define CTL_DEVID_LEN 64 100 #define CTL_DEVID_MIN_LEN 16 101 /* 102 * WWPN length, for VPD page 0x83. 103 */ 104 #define CTL_WWPN_LEN 8 105 106 #define CTL_DRIVER_NAME_LEN 32 107 108 /* 109 * Unit attention types. ASC/ASCQ values for these should be placed in 110 * ctl_build_ua. These are also listed in order of reporting priority. 111 * i.e. a poweron UA is reported first, bus reset second, etc. 112 */ 113 typedef enum { 114 CTL_UA_NONE = 0x0000, 115 CTL_UA_POWERON = 0x0001, 116 CTL_UA_BUS_RESET = 0x0002, 117 CTL_UA_TARG_RESET = 0x0004, 118 CTL_UA_I_T_NEXUS_LOSS = 0x0008, 119 CTL_UA_LUN_RESET = 0x0010, 120 CTL_UA_LUN_CHANGE = 0x0020, 121 CTL_UA_MODE_CHANGE = 0x0040, 122 CTL_UA_LOG_CHANGE = 0x0080, 123 CTL_UA_RES_PREEMPT = 0x0400, 124 CTL_UA_RES_RELEASE = 0x0800, 125 CTL_UA_REG_PREEMPT = 0x1000, 126 CTL_UA_ASYM_ACC_CHANGE = 0x2000, 127 CTL_UA_CAPACITY_CHANGED = 0x4000, 128 CTL_UA_THIN_PROV_THRES = 0x8000 129 } ctl_ua_type; 130 131 #ifdef _KERNEL 132 133 MALLOC_DECLARE(M_CTL); 134 135 struct ctl_page_index; 136 137 #ifdef SYSCTL_DECL /* from sysctl.h */ 138 SYSCTL_DECL(_kern_cam_ctl); 139 #endif 140 141 /* 142 * Call these routines to enable or disable front end ports. 143 */ 144 int ctl_port_enable(ctl_port_type port_type); 145 int ctl_port_disable(ctl_port_type port_type); 146 /* 147 * This routine grabs a list of frontend ports. 148 */ 149 int ctl_port_list(struct ctl_port_entry *entries, int num_entries_alloced, 150 int *num_entries_filled, int *num_entries_dropped, 151 ctl_port_type port_type, int no_virtual); 152 153 /* 154 * Put a string into an sbuf, escaping characters that are illegal or not 155 * recommended in XML. Note this doesn't escape everything, just > < and &. 156 */ 157 int ctl_sbuf_printf_esc(struct sbuf *sb, char *str, int size); 158 159 int ctl_ffz(uint32_t *mask, uint32_t size); 160 int ctl_set_mask(uint32_t *mask, uint32_t bit); 161 int ctl_clear_mask(uint32_t *mask, uint32_t bit); 162 int ctl_is_set(uint32_t *mask, uint32_t bit); 163 int ctl_caching_sp_handler(struct ctl_scsiio *ctsio, 164 struct ctl_page_index *page_index, uint8_t *page_ptr); 165 int ctl_control_page_handler(struct ctl_scsiio *ctsio, 166 struct ctl_page_index *page_index, 167 uint8_t *page_ptr); 168 /** 169 int ctl_failover_sp_handler(struct ctl_scsiio *ctsio, 170 struct ctl_page_index *page_index, 171 uint8_t *page_ptr); 172 **/ 173 int ctl_debugconf_sp_sense_handler(struct ctl_scsiio *ctsio, 174 struct ctl_page_index *page_index, 175 int pc); 176 int ctl_debugconf_sp_select_handler(struct ctl_scsiio *ctsio, 177 struct ctl_page_index *page_index, 178 uint8_t *page_ptr); 179 int ctl_lbp_log_sense_handler(struct ctl_scsiio *ctsio, 180 struct ctl_page_index *page_index, 181 int pc); 182 int ctl_sap_log_sense_handler(struct ctl_scsiio *ctsio, 183 struct ctl_page_index *page_index, 184 int pc); 185 int ctl_config_move_done(union ctl_io *io); 186 void ctl_datamove(union ctl_io *io); 187 void ctl_done(union ctl_io *io); 188 void ctl_data_submit_done(union ctl_io *io); 189 void ctl_config_read_done(union ctl_io *io); 190 void ctl_config_write_done(union ctl_io *io); 191 void ctl_portDB_changed(int portnum); 192 #ifdef notyet 193 void ctl_init_isc_msg(void); 194 #endif 195 int ctl_ioctl_io(struct cdev *dev, u_long cmd, caddr_t addr, int flag, 196 struct thread *td); 197 198 /* 199 * KPI to manipulate LUN/port options 200 */ 201 202 struct ctl_option { 203 STAILQ_ENTRY(ctl_option) links; 204 char *name; 205 char *value; 206 }; 207 typedef STAILQ_HEAD(ctl_options, ctl_option) ctl_options_t; 208 209 struct ctl_be_arg; 210 void ctl_init_opts(ctl_options_t *opts, int num_args, struct ctl_be_arg *args); 211 void ctl_free_opts(ctl_options_t *opts); 212 char * ctl_get_opt(ctl_options_t *opts, const char *name); 213 int ctl_expand_number(const char *buf, uint64_t *num); 214 215 #endif /* _KERNEL */ 216 217 #endif /* _CTL_H_ */ 218 219 /* 220 * vim: ts=8 221 */ 222