ctl.h revision 288790
170656Sobrien/*- 270656Sobrien * Copyright (c) 2003 Silicon Graphics International Corp. 370656Sobrien * All rights reserved. 470656Sobrien * 570656Sobrien * Redistribution and use in source and binary forms, with or without 670656Sobrien * modification, are permitted provided that the following conditions 770656Sobrien * are met: 870656Sobrien * 1. Redistributions of source code must retain the above copyright 970656Sobrien * notice, this list of conditions, and the following disclaimer, 1070656Sobrien * without modification. 1170656Sobrien * 2. Redistributions in binary form must reproduce at minimum a disclaimer 1270656Sobrien * substantially similar to the "NO WARRANTY" disclaimer below 1370656Sobrien * ("Disclaimer") and any redistribution must be conditioned upon 1470656Sobrien * including a substantially similar Disclaimer requirement for further 1570656Sobrien * binary redistribution. 1670656Sobrien * 1770656Sobrien * NO WARRANTY 1870656Sobrien * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1970656Sobrien * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2070656Sobrien * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 2170656Sobrien * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2270656Sobrien * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2370656Sobrien * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2470656Sobrien * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2570656Sobrien * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 26216338Sdim * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 27216338Sdim * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28216338Sdim * POSSIBILITY OF SUCH DAMAGES. 2970656Sobrien * 30209869Snwhitehorn * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl.h#5 $ 31209869Snwhitehorn * $FreeBSD: stable/10/sys/cam/ctl/ctl.h 288790 2015-10-05 10:54:06Z mav $ 3270656Sobrien */ 3370656Sobrien/* 3470656Sobrien * Function definitions used both within CTL and potentially in various CTL 3570656Sobrien * clients. 3670656Sobrien * 37209869Snwhitehorn * Author: Ken Merry <ken@FreeBSD.org> 38209869Snwhitehorn */ 3970656Sobrien 4070656Sobrien#ifndef _CTL_H_ 41217399Skib#define _CTL_H_ 42217399Skib 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_ALL = 0xff, 57 CTL_PORT_ISC = 0x100 // FC port for inter-shelf communication 58} ctl_port_type; 59 60struct 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 74struct ctl_modepage_header { 75 uint8_t page_code; 76 uint8_t subpage; 77 int32_t len_used; 78 int32_t len_left; 79}; 80 81struct ctl_modepage_aps { 82 struct ctl_modepage_header header; 83 uint8_t lock_active; 84}; 85 86union 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 */ 113typedef 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_INQ_CHANGE = 0x0100, 124 CTL_UA_RES_PREEMPT = 0x0400, 125 CTL_UA_RES_RELEASE = 0x0800, 126 CTL_UA_REG_PREEMPT = 0x1000, 127 CTL_UA_ASYM_ACC_CHANGE = 0x2000, 128 CTL_UA_CAPACITY_CHANGED = 0x4000, 129 CTL_UA_THIN_PROV_THRES = 0x8000 130} ctl_ua_type; 131 132#ifdef _KERNEL 133 134MALLOC_DECLARE(M_CTL); 135 136struct ctl_page_index; 137 138#ifdef SYSCTL_DECL /* from sysctl.h */ 139SYSCTL_DECL(_kern_cam_ctl); 140#endif 141 142struct ctl_lun; 143struct ctl_port; 144struct ctl_softc; 145 146/* 147 * Put a string into an sbuf, escaping characters that are illegal or not 148 * recommended in XML. Note this doesn't escape everything, just > < and &. 149 */ 150int ctl_sbuf_printf_esc(struct sbuf *sb, char *str, int size); 151 152int ctl_ffz(uint32_t *mask, uint32_t first, uint32_t last); 153int ctl_set_mask(uint32_t *mask, uint32_t bit); 154int ctl_clear_mask(uint32_t *mask, uint32_t bit); 155int ctl_is_set(uint32_t *mask, uint32_t bit); 156int ctl_caching_sp_handler(struct ctl_scsiio *ctsio, 157 struct ctl_page_index *page_index, uint8_t *page_ptr); 158int ctl_control_page_handler(struct ctl_scsiio *ctsio, 159 struct ctl_page_index *page_index, 160 uint8_t *page_ptr); 161int ctl_debugconf_sp_sense_handler(struct ctl_scsiio *ctsio, 162 struct ctl_page_index *page_index, 163 int pc); 164int ctl_debugconf_sp_select_handler(struct ctl_scsiio *ctsio, 165 struct ctl_page_index *page_index, 166 uint8_t *page_ptr); 167int ctl_lbp_log_sense_handler(struct ctl_scsiio *ctsio, 168 struct ctl_page_index *page_index, 169 int pc); 170int ctl_sap_log_sense_handler(struct ctl_scsiio *ctsio, 171 struct ctl_page_index *page_index, 172 int pc); 173int ctl_config_move_done(union ctl_io *io); 174void ctl_datamove(union ctl_io *io); 175void ctl_serseq_done(union ctl_io *io); 176void ctl_done(union ctl_io *io); 177void ctl_data_submit_done(union ctl_io *io); 178void ctl_config_read_done(union ctl_io *io); 179void ctl_config_write_done(union ctl_io *io); 180void ctl_portDB_changed(int portnum); 181int ctl_ioctl_io(struct cdev *dev, u_long cmd, caddr_t addr, int flag, 182 struct thread *td); 183 184void ctl_est_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua); 185void ctl_est_ua_port(struct ctl_lun *lun, int port, uint32_t except, 186 ctl_ua_type ua); 187void ctl_est_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua); 188void ctl_clr_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua); 189void ctl_clr_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua); 190void ctl_clr_ua_allluns(struct ctl_softc *ctl_softc, uint32_t initidx, 191 ctl_ua_type ua_type); 192 193void ctl_isc_announce_lun(struct ctl_lun *lun); 194void ctl_isc_announce_port(struct ctl_port *port); 195void ctl_isc_announce_iid(struct ctl_port *port, int iid); 196void ctl_isc_announce_mode(struct ctl_lun *lun, uint32_t initidx, 197 uint8_t page, uint8_t subpage); 198 199/* 200 * KPI to manipulate LUN/port options 201 */ 202 203struct ctl_option { 204 STAILQ_ENTRY(ctl_option) links; 205 char *name; 206 char *value; 207}; 208typedef STAILQ_HEAD(ctl_options, ctl_option) ctl_options_t; 209 210struct ctl_be_arg; 211void ctl_init_opts(ctl_options_t *opts, int num_args, struct ctl_be_arg *args); 212void ctl_update_opts(ctl_options_t *opts, int num_args, 213 struct ctl_be_arg *args); 214void ctl_free_opts(ctl_options_t *opts); 215char * ctl_get_opt(ctl_options_t *opts, const char *name); 216int ctl_expand_number(const char *buf, uint64_t *num); 217 218#endif /* _KERNEL */ 219 220#endif /* _CTL_H_ */ 221 222/* 223 * vim: ts=8 224 */ 225