2 * Copyright (c) 2003, 2004, 2005, 2008 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_private.h#7 $
34 * CAM Target Layer driver private data structures/definitions.
36 * Author: Ken Merry <ken@FreeBSD.org>
39 #ifndef _CTL_PRIVATE_H_
40 #define _CTL_PRIVATE_H_
43 * SCSI vendor and product names.
45 #define CTL_VENDOR "FREEBSD "
46 #define CTL_DIRECT_PRODUCT "CTLDISK "
47 #define CTL_PROCESSOR_PRODUCT "CTLPROCESSOR "
48 #define CTL_UNKNOWN_PRODUCT "CTLDEVICE "
50 struct ctl_fe_ioctl_startstop_info {
52 struct ctl_hard_startstop_info hs_info;
55 struct ctl_fe_ioctl_bbrread_info {
57 struct ctl_bbrread_info *bbr_info;
68 struct ctl_fe_ioctl_params {
71 ctl_fe_ioctl_state state;
74 #define CTL_POOL_ENTRIES_INTERNAL 200
75 #define CTL_POOL_ENTRIES_EMERGENCY 300
76 #define CTL_POOL_ENTRIES_OTHER_SC 200
87 CTL_POOL_FLAG_NONE = 0x00,
88 CTL_POOL_FLAG_INVALID = 0x01
95 struct ctl_softc *ctl_softc;
97 uint64_t total_allocated;
101 STAILQ_HEAD(, ctl_io_hdr) free_queue;
102 STAILQ_ENTRY(ctl_io_pool) links;
106 CTL_IOCTL_FLAG_NONE = 0x00,
107 CTL_IOCTL_FLAG_ENABLED = 0x01
110 struct ctl_ioctl_info {
111 ctl_ioctl_flags flags;
112 uint32_t cur_tag_num;
113 struct ctl_frontend fe;
122 } ctl_serialize_action;
127 CTL_ACTION_OVERLAP_TAG,
134 * WARNING: Keep the bottom nibble here free, we OR in the data direction
135 * flags for each command.
137 * Note: "OK_ON_ALL_LUNS" == we don't have to have a lun configured
138 * "OK_ON_BOTH" == we have to have a lun configured
139 * "SA5" == command has 5-bit service action at byte 1
142 CTL_CMD_FLAG_NONE = 0x0000,
143 CTL_CMD_FLAG_NO_SENSE = 0x0010,
144 CTL_CMD_FLAG_OK_ON_ALL_LUNS = 0x0020,
145 CTL_CMD_FLAG_ALLOW_ON_RESV = 0x0040,
146 CTL_CMD_FLAG_OK_ON_PROC = 0x0100,
147 CTL_CMD_FLAG_OK_ON_SLUN = 0x0200,
148 CTL_CMD_FLAG_OK_ON_BOTH = 0x0300,
149 CTL_CMD_FLAG_OK_ON_STOPPED = 0x0400,
150 CTL_CMD_FLAG_OK_ON_INOPERABLE = 0x0800,
151 CTL_CMD_FLAG_OK_ON_OFFLINE = 0x1000,
152 CTL_CMD_FLAG_OK_ON_SECONDARY = 0x2000,
153 CTL_CMD_FLAG_ALLOW_ON_PR_RESV = 0x4000,
154 CTL_CMD_FLAG_SA5 = 0x8000
175 /* TBD: others to be filled in as needed */
176 CTL_SERIDX_COUNT, /* LAST, not a normal code, provides # codes */
177 CTL_SERIDX_INVLD = CTL_SERIDX_COUNT
180 typedef int ctl_opfunc(struct ctl_scsiio *ctsio);
182 struct ctl_cmd_entry {
186 ctl_lun_error_pattern pattern;
187 uint8_t length; /* CDB length */
188 uint8_t usage[15]; /* Mask of allowed CDB bits
189 * after the opcode byte. */
193 CTL_LUN_NONE = 0x000,
194 CTL_LUN_CONTROL = 0x001,
195 CTL_LUN_RESERVED = 0x002,
196 CTL_LUN_INVALID = 0x004,
197 CTL_LUN_DISABLED = 0x008,
198 CTL_LUN_MALLOCED = 0x010,
199 CTL_LUN_STOPPED = 0x020,
200 CTL_LUN_INOPERABLE = 0x040,
201 CTL_LUN_OFFLINE = 0x080,
202 CTL_LUN_PR_RESERVED = 0x100,
203 CTL_LUN_PRIMARY_SC = 0x200,
204 CTL_LUN_SENSE_DESC = 0x400
208 CTLBLOCK_FLAG_NONE = 0x00,
209 CTLBLOCK_FLAG_INVALID = 0x01
213 struct ctl_softc *ctl_softc;
214 struct ctlblock_softc *ctlblock_softc;
218 * Mode page defaults.
222 * These values make Solaris trim off some of the capacity.
224 #define CTL_DEFAULT_SECTORS_PER_TRACK 63
225 #define CTL_DEFAULT_HEADS 255
227 * These values seem to work okay.
229 #define CTL_DEFAULT_SECTORS_PER_TRACK 63
230 #define CTL_DEFAULT_HEADS 16
232 * These values work reasonably well.
234 #define CTL_DEFAULT_SECTORS_PER_TRACK 512
235 #define CTL_DEFAULT_HEADS 64
239 * Solaris is somewhat picky about how many heads and sectors per track you
240 * have defined in mode pages 3 and 4. These values seem to cause Solaris
241 * to get the capacity more or less right when you run the format tool.
242 * They still have problems when dealing with devices larger than 1TB,
243 * but there isn't anything we can do about that.
245 * For smaller LUN sizes, this ends up causing the number of cylinders to
246 * work out to 0. Solaris actually recognizes that and comes up with its
247 * own bogus geometry to fit the actual capacity of the drive. They really
248 * should just give up on geometry and stick to the read capacity
249 * information alone for modern disk drives.
251 * One thing worth mentioning about Solaris' mkfs command is that it
252 * doesn't like sectors per track values larger than 256. 512 seems to
253 * work okay for format, but causes problems when you try to make a
256 * Another caveat about these values: the product of these two values
257 * really should be a power of 2. This is because of the simplistic
258 * shift-based calculation that we have to use on the i386 platform to
259 * calculate the number of cylinders here. (If you use a divide, you end
260 * up calling __udivdi3(), which is a hardware FP call on the PC. On the
261 * XScale, it is done in software, so you can do that from inside the
264 * So for the current values (256 S/T, 128 H), we get 32768, which works
265 * very nicely for calculating cylinders.
267 * If you want to change these values so that their product is no longer a
268 * power of 2, re-visit the calculation in ctl_init_page_index(). You may
269 * need to make it a bit more complicated to get the number of cylinders
272 #define CTL_DEFAULT_SECTORS_PER_TRACK 256
273 #define CTL_DEFAULT_HEADS 128
275 #define CTL_DEFAULT_ROTATION_RATE 10000
277 struct ctl_page_index;
279 typedef int ctl_modesen_handler(struct ctl_scsiio *ctsio,
280 struct ctl_page_index *page_index,
282 typedef int ctl_modesel_handler(struct ctl_scsiio *ctsio,
283 struct ctl_page_index *page_index,
287 CTL_PAGE_FLAG_NONE = 0x00,
288 CTL_PAGE_FLAG_DISK_ONLY = 0x01
291 struct ctl_page_index {
296 ctl_page_flags page_flags;
297 ctl_modesen_handler *sense_handler;
298 ctl_modesel_handler *select_handler;
301 #define CTL_PAGE_CURRENT 0x00
302 #define CTL_PAGE_CHANGEABLE 0x01
303 #define CTL_PAGE_DEFAULT 0x02
304 #define CTL_PAGE_SAVED 0x03
306 static const struct ctl_page_index page_index_template[] = {
307 {SMS_FORMAT_DEVICE_PAGE, 0, sizeof(struct scsi_format_page), NULL,
308 CTL_PAGE_FLAG_DISK_ONLY, NULL, NULL},
309 {SMS_RIGID_DISK_PAGE, 0, sizeof(struct scsi_rigid_disk_page), NULL,
310 CTL_PAGE_FLAG_DISK_ONLY, NULL, NULL},
311 {SMS_CACHING_PAGE, 0, sizeof(struct scsi_caching_page), NULL,
312 CTL_PAGE_FLAG_DISK_ONLY, NULL, NULL},
313 {SMS_CONTROL_MODE_PAGE, 0, sizeof(struct scsi_control_page), NULL,
314 CTL_PAGE_FLAG_NONE, NULL, ctl_control_page_handler},
315 {SMS_VENDOR_SPECIFIC_PAGE | SMPH_SPF, PWR_SUBPAGE_CODE,
316 sizeof(struct copan_power_subpage), NULL, CTL_PAGE_FLAG_NONE,
317 ctl_power_sp_sense_handler, ctl_power_sp_handler},
318 {SMS_VENDOR_SPECIFIC_PAGE | SMPH_SPF, APS_SUBPAGE_CODE,
319 sizeof(struct copan_aps_subpage), NULL, CTL_PAGE_FLAG_NONE,
320 NULL, ctl_aps_sp_handler},
321 {SMS_VENDOR_SPECIFIC_PAGE | SMPH_SPF, DBGCNF_SUBPAGE_CODE,
322 sizeof(struct copan_debugconf_subpage), NULL, CTL_PAGE_FLAG_NONE,
323 ctl_debugconf_sp_sense_handler, ctl_debugconf_sp_select_handler},
326 #define CTL_NUM_MODE_PAGES sizeof(page_index_template)/ \
327 sizeof(page_index_template[0])
329 struct ctl_mode_pages {
330 struct scsi_format_page format_page[4];
331 struct scsi_rigid_disk_page rigid_disk_page[4];
332 struct scsi_caching_page caching_page[4];
333 struct scsi_control_page control_page[4];
334 struct copan_power_subpage power_subpage[4];
335 struct copan_aps_subpage aps_subpage[4];
336 struct copan_debugconf_subpage debugconf_subpage[4];
337 struct ctl_page_index index[CTL_NUM_MODE_PAGES];
340 struct ctl_pending_sense {
341 ctl_ua_type ua_pending;
342 struct scsi_sense_data sense;
345 struct ctl_lun_delay_info {
346 ctl_delay_type datamove_type;
347 uint32_t datamove_delay;
348 ctl_delay_type done_type;
353 CTL_ERR_INJ_NONE = 0x00,
354 CTL_ERR_INJ_ABORTED = 0x01
355 } ctl_err_inject_flags;
358 CTL_PR_FLAG_NONE = 0x00,
359 CTL_PR_FLAG_REGISTERED = 0x01,
360 CTL_PR_FLAG_ACTIVE_RES = 0x02
363 struct ctl_per_res_info {
364 struct scsi_per_res_key res_key;
368 #define CTL_PR_ALL_REGISTRANTS 0xFFFF
369 #define CTL_PR_NO_RESERVATION 0xFFF0
372 * For report target port groups.
374 #define NUM_TARGET_PORT_GROUPS 2
375 #define NUM_PORTS_PER_GRP 2
379 struct ctl_id target;
382 STAILQ_HEAD(,ctl_error_desc) error_list;
383 uint64_t error_serial;
384 struct ctl_softc *ctl_softc;
385 struct ctl_be_lun *be_lun;
386 struct ctl_backend_driver *backend;
388 struct ctl_lun_delay_info delay_info;
391 TAILQ_HEAD(ctl_ooaq, ctl_io_hdr) ooa_queue;
392 TAILQ_HEAD(ctl_blockq,ctl_io_hdr) blocked_queue;
393 STAILQ_ENTRY(ctl_lun) links;
394 STAILQ_ENTRY(ctl_lun) run_links;
395 struct ctl_nexus rsv_nexus;
396 uint32_t have_ca[CTL_MAX_INITIATORS >> 5];
397 struct ctl_pending_sense pending_sense[CTL_MAX_INITIATORS];
398 struct ctl_mode_pages mode_pages;
399 struct ctl_lun_io_stats stats;
400 struct ctl_per_res_info per_res[2*CTL_MAX_INITIATORS];
401 unsigned int PRGeneration;
405 uint8_t write_buffer[524288];
409 CTL_FLAG_REAL_SYNC = 0x02,
410 CTL_FLAG_MASTER_SHELF = 0x04
413 struct ctl_wwpn_iid {
420 #define CTL_MAX_THREADS 16
423 struct mtx_padalign queue_lock;
424 struct ctl_softc *ctl_softc;
425 struct thread *thread;
426 STAILQ_HEAD(, ctl_io_hdr) incoming_queue;
427 STAILQ_HEAD(, ctl_io_hdr) rtr_queue;
428 STAILQ_HEAD(, ctl_io_hdr) done_queue;
429 STAILQ_HEAD(, ctl_io_hdr) isc_queue;
436 struct ctl_id target;
441 int inquiry_pq_no_lun;
442 struct sysctl_ctx_list sysctl_ctx;
443 struct sysctl_oid *sysctl_tree;
444 struct ctl_ioctl_info ioctl_info;
445 struct ctl_io_pool *internal_pool;
446 struct ctl_io_pool *emergency_pool;
447 struct ctl_io_pool *othersc_pool;
448 struct proc *ctl_proc;
450 uint32_t ctl_lun_mask[CTL_MAX_LUNS >> 5];
451 struct ctl_lun *ctl_luns[CTL_MAX_LUNS];
452 struct ctl_wwpn_iid wwpn_iid[CTL_MAX_PORTS][CTL_MAX_INIT_PER_PORT];
453 uint32_t ctl_port_mask;
454 uint64_t aps_locked_lun;
455 STAILQ_HEAD(, ctl_lun) lun_list;
456 STAILQ_HEAD(, ctl_be_lun) pending_lun_queue;
457 uint32_t num_frontends;
458 STAILQ_HEAD(, ctl_frontend) fe_list;
459 struct ctl_frontend *ctl_ports[CTL_MAX_PORTS];
460 uint32_t num_backends;
461 STAILQ_HEAD(, ctl_backend_driver) be_list;
462 struct mtx pool_lock;
464 uint32_t cur_pool_id;
465 STAILQ_HEAD(, ctl_io_pool) io_pools;
466 time_t last_print_jiffies;
467 uint32_t skipped_prints;
468 struct ctl_thread threads[CTL_MAX_THREADS];
473 extern const struct ctl_cmd_entry ctl_cmd_table[256];
475 uint32_t ctl_get_initindex(struct ctl_nexus *nexus);
476 int ctl_pool_create(struct ctl_softc *ctl_softc, ctl_pool_type pool_type,
477 uint32_t total_ctl_io, struct ctl_io_pool **npool);
478 void ctl_pool_free(struct ctl_io_pool *pool);
479 int ctl_scsi_release(struct ctl_scsiio *ctsio);
480 int ctl_scsi_reserve(struct ctl_scsiio *ctsio);
481 int ctl_start_stop(struct ctl_scsiio *ctsio);
482 int ctl_sync_cache(struct ctl_scsiio *ctsio);
483 int ctl_format(struct ctl_scsiio *ctsio);
484 int ctl_read_buffer(struct ctl_scsiio *ctsio);
485 int ctl_write_buffer(struct ctl_scsiio *ctsio);
486 int ctl_write_same(struct ctl_scsiio *ctsio);
487 int ctl_unmap(struct ctl_scsiio *ctsio);
488 int ctl_mode_select(struct ctl_scsiio *ctsio);
489 int ctl_mode_sense(struct ctl_scsiio *ctsio);
490 int ctl_read_capacity(struct ctl_scsiio *ctsio);
491 int ctl_read_capacity_16(struct ctl_scsiio *ctsio);
492 int ctl_read_write(struct ctl_scsiio *ctsio);
493 int ctl_cnw(struct ctl_scsiio *ctsio);
494 int ctl_report_luns(struct ctl_scsiio *ctsio);
495 int ctl_request_sense(struct ctl_scsiio *ctsio);
496 int ctl_tur(struct ctl_scsiio *ctsio);
497 int ctl_verify(struct ctl_scsiio *ctsio);
498 int ctl_inquiry(struct ctl_scsiio *ctsio);
499 int ctl_persistent_reserve_in(struct ctl_scsiio *ctsio);
500 int ctl_persistent_reserve_out(struct ctl_scsiio *ctsio);
501 int ctl_report_tagret_port_groups(struct ctl_scsiio *ctsio);
502 int ctl_report_supported_opcodes(struct ctl_scsiio *ctsio);
503 int ctl_report_supported_tmf(struct ctl_scsiio *ctsio);
504 int ctl_isc(struct ctl_scsiio *ctsio);
508 #endif /* _CTL_PRIVATE_H_ */