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