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 uint16_t len_used; 78 uint16_t len_left; 79 }; 80 81 union ctl_modepage_info { 82 struct ctl_modepage_header header; 83 }; 84 85 /* 86 * Serial number length, for VPD page 0x80. 87 */ 88 #define CTL_SN_LEN 16 89 90 /* 91 * Device ID length, for VPD page 0x83. 92 */ 93 #define CTL_DEVID_LEN 64 94 #define CTL_DEVID_MIN_LEN 16 95 /* 96 * WWPN length, for VPD page 0x83. 97 */ 98 #define CTL_WWPN_LEN 8 99 100 #define CTL_DRIVER_NAME_LEN 32 101 102 /* 103 * Unit attention types. ASC/ASCQ values for these should be placed in 104 * ctl_build_ua. These are also listed in order of reporting priority. 105 * i.e. a poweron UA is reported first, bus reset second, etc. 106 */ 107 typedef enum { 108 CTL_UA_NONE = 0x0000, 109 CTL_UA_POWERON = 0x0001, 110 CTL_UA_BUS_RESET = 0x0002, 111 CTL_UA_TARG_RESET = 0x0004, 112 CTL_UA_I_T_NEXUS_LOSS = 0x0008, 113 CTL_UA_LUN_RESET = 0x0010, 114 CTL_UA_LUN_CHANGE = 0x0020, 115 CTL_UA_MODE_CHANGE = 0x0040, 116 CTL_UA_LOG_CHANGE = 0x0080, 117 CTL_UA_INQ_CHANGE = 0x0100, 118 CTL_UA_RES_PREEMPT = 0x0400, 119 CTL_UA_RES_RELEASE = 0x0800, 120 CTL_UA_REG_PREEMPT = 0x1000, 121 CTL_UA_ASYM_ACC_CHANGE = 0x2000, 122 CTL_UA_CAPACITY_CHANGE = 0x4000, 123 CTL_UA_THIN_PROV_THRES = 0x8000, 124 CTL_UA_MEDIUM_CHANGE = 0x10000, 125 CTL_UA_IE = 0x20000 126 } ctl_ua_type; 127 128 #ifdef _KERNEL 129 130 MALLOC_DECLARE(M_CTL); 131 132 struct ctl_page_index; 133 134 #ifdef SYSCTL_DECL /* from sysctl.h */ 135 SYSCTL_DECL(_kern_cam_ctl); 136 #endif 137 138 struct ctl_lun; 139 struct ctl_port; 140 struct ctl_softc; 141 142 /* 143 * Put a string into an sbuf, escaping characters that are illegal or not 144 * recommended in XML. Note this doesn't escape everything, just > < and &. 145 */ 146 int ctl_sbuf_printf_esc(struct sbuf *sb, char *str, int size); 147 148 int ctl_ffz(uint32_t *mask, uint32_t first, uint32_t last); 149 int ctl_set_mask(uint32_t *mask, uint32_t bit); 150 int ctl_clear_mask(uint32_t *mask, uint32_t bit); 151 int ctl_is_set(uint32_t *mask, uint32_t bit); 152 int ctl_default_page_handler(struct ctl_scsiio *ctsio, 153 struct ctl_page_index *page_index, 154 uint8_t *page_ptr); 155 int ctl_ie_page_handler(struct ctl_scsiio *ctsio, 156 struct ctl_page_index *page_index, 157 uint8_t *page_ptr); 158 int ctl_lbp_log_sense_handler(struct ctl_scsiio *ctsio, 159 struct ctl_page_index *page_index, 160 int pc); 161 int ctl_sap_log_sense_handler(struct ctl_scsiio *ctsio, 162 struct ctl_page_index *page_index, 163 int pc); 164 int ctl_ie_log_sense_handler(struct ctl_scsiio *ctsio, 165 struct ctl_page_index *page_index, 166 int pc); 167 int ctl_config_move_done(union ctl_io *io); 168 void ctl_datamove(union ctl_io *io); 169 void ctl_serseq_done(union ctl_io *io); 170 void ctl_done(union ctl_io *io); 171 void ctl_data_submit_done(union ctl_io *io); 172 void ctl_config_read_done(union ctl_io *io); 173 void ctl_config_write_done(union ctl_io *io); 174 void ctl_portDB_changed(int portnum); 175 int ctl_ioctl_io(struct cdev *dev, u_long cmd, caddr_t addr, int flag, 176 struct thread *td); 177 178 void ctl_est_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua); 179 void ctl_est_ua_port(struct ctl_lun *lun, int port, uint32_t except, 180 ctl_ua_type ua); 181 void ctl_est_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua); 182 void ctl_clr_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua); 183 void ctl_clr_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua); 184 void ctl_clr_ua_allluns(struct ctl_softc *ctl_softc, uint32_t initidx, 185 ctl_ua_type ua_type); 186 187 uint32_t ctl_decode_lun(uint64_t encoded); 188 uint64_t ctl_encode_lun(uint32_t decoded); 189 190 void ctl_isc_announce_lun(struct ctl_lun *lun); 191 void ctl_isc_announce_port(struct ctl_port *port); 192 void ctl_isc_announce_iid(struct ctl_port *port, int iid); 193 void ctl_isc_announce_mode(struct ctl_lun *lun, uint32_t initidx, 194 uint8_t page, uint8_t subpage); 195 196 /* 197 * KPI to manipulate LUN/port options 198 */ 199 200 struct ctl_option { 201 STAILQ_ENTRY(ctl_option) links; 202 char *name; 203 char *value; 204 }; 205 typedef STAILQ_HEAD(ctl_options, ctl_option) ctl_options_t; 206 207 struct ctl_be_arg; 208 void ctl_init_opts(ctl_options_t *opts, int num_args, struct ctl_be_arg *args); 209 void ctl_update_opts(ctl_options_t *opts, int num_args, 210 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_get_opt_number(ctl_options_t *opts, const char *name, uint64_t *num); 214 int ctl_expand_number(const char *buf, uint64_t *num); 215 216 #endif /* _KERNEL */ 217 218 #endif /* _CTL_H_ */ 219 220 /* 221 * vim: ts=8 222 */ 223