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