2 * Copyright (c) 2003 Silicon Graphics International Corp.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
30 * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl.h#5 $
34 * Function definitions used both within CTL and potentially in various CTL
37 * Author: Ken Merry <ken@FreeBSD.org>
43 #define CTL_RETVAL_COMPLETE 0
44 #define CTL_RETVAL_QUEUED 1
45 #define CTL_RETVAL_ALLOCATED 2
46 #define CTL_RETVAL_ERROR 3
52 CTL_PORT_IOCTL = 0x04,
53 CTL_PORT_INTERNAL = 0x08,
54 CTL_PORT_ISCSI = 0x10,
57 CTL_PORT_ISC = 0x100 // FC port for inter-shelf communication
60 struct ctl_port_entry {
61 ctl_port_type port_type;
67 #define CTL_PORT_WWNN_VALID 0x01
68 #define CTL_PORT_WWPN_VALID 0x02
74 struct ctl_modepage_header {
81 struct ctl_modepage_aps {
82 struct ctl_modepage_header header;
86 union ctl_modepage_info {
87 struct ctl_modepage_header header;
88 struct ctl_modepage_aps aps;
92 * Serial number length, for VPD page 0x80.
97 * Device ID length, for VPD page 0x83.
99 #define CTL_DEVID_LEN 64
100 #define CTL_DEVID_MIN_LEN 16
102 * WWPN length, for VPD page 0x83.
104 #define CTL_WWPN_LEN 8
106 #define CTL_DRIVER_NAME_LEN 32
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.
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_CHANGE = 0x4000,
129 CTL_UA_THIN_PROV_THRES = 0x8000,
130 CTL_UA_MEDIUM_CHANGE = 0x10000
135 MALLOC_DECLARE(M_CTL);
137 struct ctl_page_index;
139 #ifdef SYSCTL_DECL /* from sysctl.h */
140 SYSCTL_DECL(_kern_cam_ctl);
148 * Put a string into an sbuf, escaping characters that are illegal or not
149 * recommended in XML. Note this doesn't escape everything, just > < and &.
151 int ctl_sbuf_printf_esc(struct sbuf *sb, char *str, int size);
153 int ctl_ffz(uint32_t *mask, uint32_t first, uint32_t last);
154 int ctl_set_mask(uint32_t *mask, uint32_t bit);
155 int ctl_clear_mask(uint32_t *mask, uint32_t bit);
156 int ctl_is_set(uint32_t *mask, uint32_t bit);
157 int ctl_caching_sp_handler(struct ctl_scsiio *ctsio,
158 struct ctl_page_index *page_index, uint8_t *page_ptr);
159 int ctl_control_page_handler(struct ctl_scsiio *ctsio,
160 struct ctl_page_index *page_index,
162 int ctl_debugconf_sp_sense_handler(struct ctl_scsiio *ctsio,
163 struct ctl_page_index *page_index,
165 int ctl_debugconf_sp_select_handler(struct ctl_scsiio *ctsio,
166 struct ctl_page_index *page_index,
168 int ctl_lbp_log_sense_handler(struct ctl_scsiio *ctsio,
169 struct ctl_page_index *page_index,
171 int ctl_sap_log_sense_handler(struct ctl_scsiio *ctsio,
172 struct ctl_page_index *page_index,
174 int ctl_config_move_done(union ctl_io *io);
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,
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,
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);
194 uint32_t ctl_decode_lun(uint64_t encoded);
195 uint64_t ctl_encode_lun(uint32_t decoded);
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);
204 * KPI to manipulate LUN/port options
208 STAILQ_ENTRY(ctl_option) links;
212 typedef STAILQ_HEAD(ctl_options, ctl_option) ctl_options_t;
215 void ctl_init_opts(ctl_options_t *opts, int num_args, struct ctl_be_arg *args);
216 void ctl_update_opts(ctl_options_t *opts, int num_args,
217 struct ctl_be_arg *args);
218 void ctl_free_opts(ctl_options_t *opts);
219 char * ctl_get_opt(ctl_options_t *opts, const char *name);
220 int ctl_get_opt_number(ctl_options_t *opts, const char *name, uint64_t *num);
221 int ctl_expand_number(const char *buf, uint64_t *num);