ctl.h revision 268678
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/10/sys/cam/ctl/ctl.h 268678 2014-07-15 16:58:38Z mav $ 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_min(x,y) (((x) < (y)) ? (x) : (y)) 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_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/* 107 * Unit attention types. ASC/ASCQ values for these should be placed in 108 * ctl_build_ua. These are also listed in order of reporting priority. 109 * i.e. a poweron UA is reported first, bus reset second, etc. 110 */ 111typedef enum { 112 CTL_UA_NONE = 0x0000, 113 CTL_UA_POWERON = 0x0001, 114 CTL_UA_BUS_RESET = 0x0002, 115 CTL_UA_TARG_RESET = 0x0004, 116 CTL_UA_LUN_RESET = 0x0008, 117 CTL_UA_LUN_CHANGE = 0x0010, 118 CTL_UA_MODE_CHANGE = 0x0020, 119 CTL_UA_LOG_CHANGE = 0x0040, 120 CTL_UA_LVD = 0x0080, 121 CTL_UA_SE = 0x0100, 122 CTL_UA_RES_PREEMPT = 0x0200, 123 CTL_UA_RES_RELEASE = 0x0400, 124 CTL_UA_REG_PREEMPT = 0x0800, 125 CTL_UA_ASYM_ACC_CHANGE = 0x1000, 126 CTL_UA_CAPACITY_CHANGED = 0x2000 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 139/* 140 * Call these routines to enable or disable front end ports. 141 */ 142int ctl_port_enable(ctl_port_type port_type); 143int ctl_port_disable(ctl_port_type port_type); 144/* 145 * This routine grabs a list of frontend ports. 146 */ 147int ctl_port_list(struct ctl_port_entry *entries, int num_entries_alloced, 148 int *num_entries_filled, int *num_entries_dropped, 149 ctl_port_type port_type, int no_virtual); 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); 156 157int ctl_ffz(uint32_t *mask, uint32_t size); 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_control_page_handler(struct ctl_scsiio *ctsio, 162 struct ctl_page_index *page_index, 163 uint8_t *page_ptr); 164/** 165int ctl_failover_sp_handler(struct ctl_scsiio *ctsio, 166 struct ctl_page_index *page_index, 167 uint8_t *page_ptr); 168**/ 169int ctl_power_sp_handler(struct ctl_scsiio *ctsio, 170 struct ctl_page_index *page_index, uint8_t *page_ptr); 171int ctl_power_sp_sense_handler(struct ctl_scsiio *ctsio, 172 struct ctl_page_index *page_index, int pc); 173int ctl_aps_sp_handler(struct ctl_scsiio *ctsio, 174 struct ctl_page_index *page_index, uint8_t *page_ptr); 175int ctl_debugconf_sp_sense_handler(struct ctl_scsiio *ctsio, 176 struct ctl_page_index *page_index, 177 int pc); 178int ctl_debugconf_sp_select_handler(struct ctl_scsiio *ctsio, 179 struct ctl_page_index *page_index, 180 uint8_t *page_ptr); 181int ctl_config_move_done(union ctl_io *io); 182void ctl_datamove(union ctl_io *io); 183void ctl_done(union ctl_io *io); 184void ctl_data_submit_done(union ctl_io *io); 185void ctl_config_write_done(union ctl_io *io); 186void ctl_portDB_changed(int portnum); 187void ctl_init_isc_msg(void); 188 189/* 190 * KPI to manipulate LUN/port options 191 */ 192 193struct ctl_option { 194 STAILQ_ENTRY(ctl_option) links; 195 char *name; 196 char *value; 197}; 198typedef STAILQ_HEAD(ctl_options, ctl_option) ctl_options_t; 199 200struct ctl_be_arg; 201void ctl_init_opts(ctl_options_t *opts, int num_args, struct ctl_be_arg *args); 202void ctl_free_opts(ctl_options_t *opts); 203char * ctl_get_opt(ctl_options_t *opts, const char *name); 204 205#endif /* _KERNEL */ 206 207#endif /* _CTL_H_ */ 208 209/* 210 * vim: ts=8 211 */ 212