1/*- 2 * SPDX-License-Identifier: BSD-2-Clause 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 */ 34/* 35 * Function definitions used both within CTL and potentially in various CTL 36 * clients. 37 * 38 * Author: Ken Merry <ken@FreeBSD.org> 39 */ 40 41#ifndef _CTL_H_ 42#define _CTL_H_ 43 44#define CTL_RETVAL_COMPLETE 0 45#define CTL_RETVAL_QUEUED 1 46#define CTL_RETVAL_ALLOCATED 2 47#define CTL_RETVAL_ERROR 3 48 49typedef enum { 50 CTL_PORT_NONE = 0x00, 51 CTL_PORT_FC = 0x01, 52 CTL_PORT_SCSI = 0x02, 53 CTL_PORT_IOCTL = 0x04, 54 CTL_PORT_INTERNAL = 0x08, 55 CTL_PORT_ISCSI = 0x10, 56 CTL_PORT_SAS = 0x20, 57 CTL_PORT_UMASS = 0x40, 58 CTL_PORT_NVMF = 0x80, 59 CTL_PORT_ALL = 0xff, 60 CTL_PORT_ISC = 0x100 // FC port for inter-shelf communication 61} ctl_port_type; 62 63struct 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 77struct ctl_modepage_header { 78 uint8_t page_code; 79 uint8_t subpage; 80 uint16_t len_used; 81 uint16_t len_left; 82}; 83 84union 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 */ 110typedef 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#ifdef MALLOC_DECLARE /* from malloc.h */ 134MALLOC_DECLARE(M_CTL); 135#endif 136 137struct ctl_page_index; 138 139#ifdef SYSCTL_DECL /* from sysctl.h */ 140SYSCTL_DECL(_kern_cam_ctl); 141#endif 142 143struct cdev; 144struct ctl_lun; 145struct ctl_port; 146struct ctl_softc; 147struct ctl_scsiio; 148struct sbuf; 149union ctl_io; 150 151/* 152 * Put a string into an sbuf, escaping characters that are illegal or not 153 * recommended in XML. Note this doesn't escape everything, just > < and &. 154 */ 155int ctl_sbuf_printf_esc(struct sbuf *sb, char *str, int size); 156 157int ctl_ffz(uint32_t *mask, uint32_t first, uint32_t last); 158int ctl_set_mask(uint32_t *mask, uint32_t bit); 159int ctl_clear_mask(uint32_t *mask, uint32_t bit); 160int ctl_is_set(uint32_t *mask, uint32_t bit); 161int ctl_default_page_handler(struct ctl_scsiio *ctsio, 162 struct ctl_page_index *page_index, 163 uint8_t *page_ptr); 164int ctl_ie_page_handler(struct ctl_scsiio *ctsio, 165 struct ctl_page_index *page_index, 166 uint8_t *page_ptr); 167int ctl_temp_log_sense_handler(struct ctl_scsiio *ctsio, 168 struct ctl_page_index *page_index, 169 int pc); 170int ctl_lbp_log_sense_handler(struct ctl_scsiio *ctsio, 171 struct ctl_page_index *page_index, 172 int pc); 173int ctl_sap_log_sense_handler(struct ctl_scsiio *ctsio, 174 struct ctl_page_index *page_index, 175 int pc); 176int ctl_ie_log_sense_handler(struct ctl_scsiio *ctsio, 177 struct ctl_page_index *page_index, 178 int pc); 179int ctl_config_move_done(union ctl_io *io, bool samethr); 180void ctl_datamove_done(union ctl_io *io, bool samethr); 181void ctl_datamove(union ctl_io *io); 182void ctl_serseq_done(union ctl_io *io); 183void ctl_done(union ctl_io *io); 184void ctl_data_submit_done(union ctl_io *io); 185void ctl_config_read_done(union ctl_io *io); 186void ctl_config_write_done(union ctl_io *io); 187void ctl_portDB_changed(int portnum); 188int ctl_ioctl_io(struct cdev *dev, u_long cmd, caddr_t addr, int flag, 189 struct thread *td); 190 191void ctl_est_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua); 192void ctl_est_ua_port(struct ctl_lun *lun, int port, uint32_t except, 193 ctl_ua_type ua); 194void ctl_est_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua); 195void ctl_clr_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua); 196void ctl_clr_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua); 197void ctl_clr_ua_allluns(struct ctl_softc *ctl_softc, uint32_t initidx, 198 ctl_ua_type ua_type); 199 200uint32_t ctl_decode_lun(uint64_t encoded); 201uint64_t ctl_encode_lun(uint32_t decoded); 202 203void ctl_isc_announce_lun(struct ctl_lun *lun); 204void ctl_isc_announce_port(struct ctl_port *port); 205void ctl_isc_announce_iid(struct ctl_port *port, int iid); 206void ctl_isc_announce_mode(struct ctl_lun *lun, uint32_t initidx, 207 uint8_t page, uint8_t subpage); 208 209int ctl_expand_number(const char *buf, uint64_t *num); 210 211#endif /* _KERNEL */ 212 213#endif /* _CTL_H_ */ 214 215/* 216 * vim: ts=8 217 */ 218