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_OTHER_SC 200
79 struct ctl_softc *ctl_softc;
80 struct uma_zone *zone;
84 CTL_IOCTL_FLAG_NONE = 0x00,
85 CTL_IOCTL_FLAG_ENABLED = 0x01
88 struct ctl_ioctl_info {
89 ctl_ioctl_flags flags;
102 } ctl_serialize_action;
107 CTL_ACTION_OVERLAP_TAG,
114 * WARNING: Keep the bottom nibble here free, we OR in the data direction
115 * flags for each command.
117 * Note: "OK_ON_ALL_LUNS" == we don't have to have a lun configured
118 * "OK_ON_BOTH" == we have to have a lun configured
119 * "SA5" == command has 5-bit service action at byte 1
122 CTL_CMD_FLAG_NONE = 0x0000,
123 CTL_CMD_FLAG_NO_SENSE = 0x0010,
124 CTL_CMD_FLAG_OK_ON_ALL_LUNS = 0x0020,
125 CTL_CMD_FLAG_ALLOW_ON_RESV = 0x0040,
126 CTL_CMD_FLAG_ALLOW_ON_PR_WRESV = 0x0080,
127 CTL_CMD_FLAG_OK_ON_PROC = 0x0100,
128 CTL_CMD_FLAG_OK_ON_SLUN = 0x0200,
129 CTL_CMD_FLAG_OK_ON_BOTH = 0x0300,
130 CTL_CMD_FLAG_OK_ON_STOPPED = 0x0400,
131 CTL_CMD_FLAG_OK_ON_INOPERABLE = 0x0800,
132 CTL_CMD_FLAG_OK_ON_OFFLINE = 0x1000,
133 CTL_CMD_FLAG_OK_ON_SECONDARY = 0x2000,
134 CTL_CMD_FLAG_ALLOW_ON_PR_RESV = 0x4000,
135 CTL_CMD_FLAG_SA5 = 0x8000
152 /* TBD: others to be filled in as needed */
153 CTL_SERIDX_COUNT, /* LAST, not a normal code, provides # codes */
154 CTL_SERIDX_INVLD = CTL_SERIDX_COUNT
157 typedef int ctl_opfunc(struct ctl_scsiio *ctsio);
159 struct ctl_cmd_entry {
163 ctl_lun_error_pattern pattern;
164 uint8_t length; /* CDB length */
165 uint8_t usage[15]; /* Mask of allowed CDB bits
166 * after the opcode byte. */
170 CTL_LUN_NONE = 0x000,
171 CTL_LUN_CONTROL = 0x001,
172 CTL_LUN_RESERVED = 0x002,
173 CTL_LUN_INVALID = 0x004,
174 CTL_LUN_DISABLED = 0x008,
175 CTL_LUN_MALLOCED = 0x010,
176 CTL_LUN_STOPPED = 0x020,
177 CTL_LUN_INOPERABLE = 0x040,
178 CTL_LUN_OFFLINE = 0x080,
179 CTL_LUN_PR_RESERVED = 0x100,
180 CTL_LUN_PRIMARY_SC = 0x200,
181 CTL_LUN_SENSE_DESC = 0x400,
182 CTL_LUN_READONLY = 0x800
186 CTLBLOCK_FLAG_NONE = 0x00,
187 CTLBLOCK_FLAG_INVALID = 0x01
191 struct ctl_softc *ctl_softc;
192 struct ctlblock_softc *ctlblock_softc;
196 * Mode page defaults.
200 * These values make Solaris trim off some of the capacity.
202 #define CTL_DEFAULT_SECTORS_PER_TRACK 63
203 #define CTL_DEFAULT_HEADS 255
205 * These values seem to work okay.
207 #define CTL_DEFAULT_SECTORS_PER_TRACK 63
208 #define CTL_DEFAULT_HEADS 16
210 * These values work reasonably well.
212 #define CTL_DEFAULT_SECTORS_PER_TRACK 512
213 #define CTL_DEFAULT_HEADS 64
217 * Solaris is somewhat picky about how many heads and sectors per track you
218 * have defined in mode pages 3 and 4. These values seem to cause Solaris
219 * to get the capacity more or less right when you run the format tool.
220 * They still have problems when dealing with devices larger than 1TB,
221 * but there isn't anything we can do about that.
223 * For smaller LUN sizes, this ends up causing the number of cylinders to
224 * work out to 0. Solaris actually recognizes that and comes up with its
225 * own bogus geometry to fit the actual capacity of the drive. They really
226 * should just give up on geometry and stick to the read capacity
227 * information alone for modern disk drives.
229 * One thing worth mentioning about Solaris' mkfs command is that it
230 * doesn't like sectors per track values larger than 256. 512 seems to
231 * work okay for format, but causes problems when you try to make a
234 * Another caveat about these values: the product of these two values
235 * really should be a power of 2. This is because of the simplistic
236 * shift-based calculation that we have to use on the i386 platform to
237 * calculate the number of cylinders here. (If you use a divide, you end
238 * up calling __udivdi3(), which is a hardware FP call on the PC. On the
239 * XScale, it is done in software, so you can do that from inside the
242 * So for the current values (256 S/T, 128 H), we get 32768, which works
243 * very nicely for calculating cylinders.
245 * If you want to change these values so that their product is no longer a
246 * power of 2, re-visit the calculation in ctl_init_page_index(). You may
247 * need to make it a bit more complicated to get the number of cylinders
250 #define CTL_DEFAULT_SECTORS_PER_TRACK 256
251 #define CTL_DEFAULT_HEADS 128
253 #define CTL_DEFAULT_ROTATION_RATE SVPD_NON_ROTATING
255 struct ctl_page_index;
257 typedef int ctl_modesen_handler(struct ctl_scsiio *ctsio,
258 struct ctl_page_index *page_index,
260 typedef int ctl_modesel_handler(struct ctl_scsiio *ctsio,
261 struct ctl_page_index *page_index,
265 CTL_PAGE_FLAG_NONE = 0x00,
266 CTL_PAGE_FLAG_DISK_ONLY = 0x01
269 struct ctl_page_index {
274 ctl_page_flags page_flags;
275 ctl_modesen_handler *sense_handler;
276 ctl_modesel_handler *select_handler;
279 #define CTL_PAGE_CURRENT 0x00
280 #define CTL_PAGE_CHANGEABLE 0x01
281 #define CTL_PAGE_DEFAULT 0x02
282 #define CTL_PAGE_SAVED 0x03
284 #define CTL_NUM_LBP_PARAMS 4
285 #define CTL_NUM_LBP_THRESH 4
286 #define CTL_LBP_EXPONENT 11 /* 2048 sectors */
287 #define CTL_LBP_PERIOD 10 /* 10 seconds */
288 #define CTL_LBP_UA_PERIOD 300 /* 5 minutes */
290 struct ctl_logical_block_provisioning_page {
291 struct scsi_logical_block_provisioning_page main;
292 struct scsi_logical_block_provisioning_page_descr descr[CTL_NUM_LBP_THRESH];
295 static const struct ctl_page_index page_index_template[] = {
296 {SMS_RW_ERROR_RECOVERY_PAGE, 0, sizeof(struct scsi_da_rw_recovery_page), NULL,
297 CTL_PAGE_FLAG_DISK_ONLY, NULL, NULL},
298 {SMS_FORMAT_DEVICE_PAGE, 0, sizeof(struct scsi_format_page), NULL,
299 CTL_PAGE_FLAG_DISK_ONLY, NULL, NULL},
300 {SMS_RIGID_DISK_PAGE, 0, sizeof(struct scsi_rigid_disk_page), NULL,
301 CTL_PAGE_FLAG_DISK_ONLY, NULL, NULL},
302 {SMS_CACHING_PAGE, 0, sizeof(struct scsi_caching_page), NULL,
303 CTL_PAGE_FLAG_DISK_ONLY, NULL, ctl_caching_sp_handler},
304 {SMS_CONTROL_MODE_PAGE, 0, sizeof(struct scsi_control_page), NULL,
305 CTL_PAGE_FLAG_NONE, NULL, ctl_control_page_handler},
306 {SMS_INFO_EXCEPTIONS_PAGE, 0, sizeof(struct scsi_info_exceptions_page), NULL,
307 CTL_PAGE_FLAG_NONE, NULL, NULL},
308 {SMS_INFO_EXCEPTIONS_PAGE | SMPH_SPF, 0x02,
309 sizeof(struct ctl_logical_block_provisioning_page), NULL,
310 CTL_PAGE_FLAG_DISK_ONLY, NULL, NULL},
311 {SMS_VENDOR_SPECIFIC_PAGE | SMPH_SPF, DBGCNF_SUBPAGE_CODE,
312 sizeof(struct copan_debugconf_subpage), NULL, CTL_PAGE_FLAG_NONE,
313 ctl_debugconf_sp_sense_handler, ctl_debugconf_sp_select_handler},
316 #define CTL_NUM_MODE_PAGES sizeof(page_index_template)/ \
317 sizeof(page_index_template[0])
319 struct ctl_mode_pages {
320 struct scsi_da_rw_recovery_page rw_er_page[4];
321 struct scsi_format_page format_page[4];
322 struct scsi_rigid_disk_page rigid_disk_page[4];
323 struct scsi_caching_page caching_page[4];
324 struct scsi_control_page control_page[4];
325 struct scsi_info_exceptions_page ie_page[4];
326 struct ctl_logical_block_provisioning_page lbp_page[4];
327 struct copan_debugconf_subpage debugconf_subpage[4];
328 struct ctl_page_index index[CTL_NUM_MODE_PAGES];
331 static const struct ctl_page_index log_page_index_template[] = {
332 {SLS_SUPPORTED_PAGES_PAGE, 0, 0, NULL,
333 CTL_PAGE_FLAG_NONE, NULL, NULL},
334 {SLS_SUPPORTED_PAGES_PAGE, SLS_SUPPORTED_SUBPAGES_SUBPAGE, 0, NULL,
335 CTL_PAGE_FLAG_NONE, NULL, NULL},
336 {SLS_LOGICAL_BLOCK_PROVISIONING, 0, 0, NULL,
337 CTL_PAGE_FLAG_NONE, ctl_lbp_log_sense_handler, NULL},
340 #define CTL_NUM_LOG_PAGES sizeof(log_page_index_template)/ \
341 sizeof(log_page_index_template[0])
343 struct ctl_log_pages {
344 uint8_t pages_page[CTL_NUM_LOG_PAGES];
345 uint8_t subpages_page[CTL_NUM_LOG_PAGES * 2];
346 uint8_t lbp_page[12*CTL_NUM_LBP_PARAMS];
347 struct ctl_page_index index[CTL_NUM_LOG_PAGES];
350 struct ctl_lun_delay_info {
351 ctl_delay_type datamove_type;
352 uint32_t datamove_delay;
353 ctl_delay_type done_type;
358 CTL_ERR_INJ_NONE = 0x00,
359 CTL_ERR_INJ_ABORTED = 0x01
360 } ctl_err_inject_flags;
363 CTL_PR_FLAG_NONE = 0x00,
364 CTL_PR_FLAG_REGISTERED = 0x01,
365 CTL_PR_FLAG_ACTIVE_RES = 0x02
368 #define CTL_PR_ALL_REGISTRANTS 0xFFFFFFFF
369 #define CTL_PR_NO_RESERVATION 0xFFFFFFF0
377 * For report target port groups.
379 #define NUM_TARGET_PORT_GROUPS 2
381 #define CTL_WRITE_BUFFER_SIZE 262144
386 struct ctl_id target;
389 STAILQ_HEAD(,ctl_error_desc) error_list;
390 uint64_t error_serial;
391 struct ctl_softc *ctl_softc;
392 struct ctl_be_lun *be_lun;
393 struct ctl_backend_driver *backend;
395 struct ctl_lun_delay_info delay_info;
398 TAILQ_HEAD(ctl_ooaq, ctl_io_hdr) ooa_queue;
399 TAILQ_HEAD(ctl_blockq,ctl_io_hdr) blocked_queue;
400 STAILQ_ENTRY(ctl_lun) links;
401 STAILQ_ENTRY(ctl_lun) run_links;
403 uint32_t have_ca[CTL_MAX_INITIATORS >> 5];
404 struct scsi_sense_data pending_sense[CTL_MAX_INITIATORS];
406 ctl_ua_type *pending_ua[CTL_MAX_PORTS];
408 struct ctl_mode_pages mode_pages;
409 struct ctl_log_pages log_pages;
410 struct ctl_lun_io_stats stats;
412 unsigned int PRGeneration;
413 uint64_t *pr_keys[2 * CTL_MAX_PORTS];
417 uint8_t *write_buffer;
418 struct ctl_devid *lun_devid;
419 TAILQ_HEAD(tpc_lists, tpc_list) tpc_lists;
423 CTL_FLAG_REAL_SYNC = 0x02,
424 CTL_FLAG_ACTIVE_SHELF = 0x04
427 #define CTL_MAX_THREADS 16
430 struct mtx_padalign queue_lock;
431 struct ctl_softc *ctl_softc;
432 struct thread *thread;
433 STAILQ_HEAD(, ctl_io_hdr) incoming_queue;
434 STAILQ_HEAD(, ctl_io_hdr) rtr_queue;
435 STAILQ_HEAD(, ctl_io_hdr) done_queue;
436 STAILQ_HEAD(, ctl_io_hdr) isc_queue;
444 struct ctl_id target;
454 int inquiry_pq_no_lun;
455 struct sysctl_ctx_list sysctl_ctx;
456 struct sysctl_oid *sysctl_tree;
457 struct ctl_ioctl_info ioctl_info;
459 struct proc *ctl_proc;
461 uint32_t ctl_lun_mask[(CTL_MAX_LUNS + 31) / 32];
462 struct ctl_lun *ctl_luns[CTL_MAX_LUNS];
463 uint32_t ctl_port_mask[(CTL_MAX_PORTS + 31) / 32];
464 STAILQ_HEAD(, ctl_lun) lun_list;
465 STAILQ_HEAD(, ctl_be_lun) pending_lun_queue;
466 uint32_t num_frontends;
467 STAILQ_HEAD(, ctl_frontend) fe_list;
469 STAILQ_HEAD(, ctl_port) port_list;
470 struct ctl_port *ctl_ports[CTL_MAX_PORTS];
471 uint32_t num_backends;
472 STAILQ_HEAD(, ctl_backend_driver) be_list;
473 struct uma_zone *io_zone;
474 uint32_t cur_pool_id;
475 struct ctl_thread threads[CTL_MAX_THREADS];
476 TAILQ_HEAD(tpc_tokens, tpc_token) tpc_tokens;
477 struct callout tpc_timeout;
482 extern const struct ctl_cmd_entry ctl_cmd_table[256];
484 uint32_t ctl_get_initindex(struct ctl_nexus *nexus);
485 uint32_t ctl_get_resindex(struct ctl_nexus *nexus);
486 uint32_t ctl_port_idx(int port_num);
487 int ctl_pool_create(struct ctl_softc *ctl_softc, const char *pool_name,
488 uint32_t total_ctl_io, void **npool);
489 void ctl_pool_free(struct ctl_io_pool *pool);
490 int ctl_scsi_release(struct ctl_scsiio *ctsio);
491 int ctl_scsi_reserve(struct ctl_scsiio *ctsio);
492 int ctl_start_stop(struct ctl_scsiio *ctsio);
493 int ctl_sync_cache(struct ctl_scsiio *ctsio);
494 int ctl_format(struct ctl_scsiio *ctsio);
495 int ctl_read_buffer(struct ctl_scsiio *ctsio);
496 int ctl_write_buffer(struct ctl_scsiio *ctsio);
497 int ctl_write_same(struct ctl_scsiio *ctsio);
498 int ctl_unmap(struct ctl_scsiio *ctsio);
499 int ctl_mode_select(struct ctl_scsiio *ctsio);
500 int ctl_mode_sense(struct ctl_scsiio *ctsio);
501 int ctl_log_sense(struct ctl_scsiio *ctsio);
502 int ctl_read_capacity(struct ctl_scsiio *ctsio);
503 int ctl_read_capacity_16(struct ctl_scsiio *ctsio);
504 int ctl_read_defect(struct ctl_scsiio *ctsio);
505 int ctl_read_write(struct ctl_scsiio *ctsio);
506 int ctl_cnw(struct ctl_scsiio *ctsio);
507 int ctl_report_luns(struct ctl_scsiio *ctsio);
508 int ctl_request_sense(struct ctl_scsiio *ctsio);
509 int ctl_tur(struct ctl_scsiio *ctsio);
510 int ctl_verify(struct ctl_scsiio *ctsio);
511 int ctl_inquiry(struct ctl_scsiio *ctsio);
512 int ctl_persistent_reserve_in(struct ctl_scsiio *ctsio);
513 int ctl_persistent_reserve_out(struct ctl_scsiio *ctsio);
514 int ctl_report_tagret_port_groups(struct ctl_scsiio *ctsio);
515 int ctl_report_supported_opcodes(struct ctl_scsiio *ctsio);
516 int ctl_report_supported_tmf(struct ctl_scsiio *ctsio);
517 int ctl_report_timestamp(struct ctl_scsiio *ctsio);
518 int ctl_isc(struct ctl_scsiio *ctsio);
520 void ctl_tpc_init(struct ctl_softc *softc);
521 void ctl_tpc_shutdown(struct ctl_softc *softc);
522 void ctl_tpc_lun_init(struct ctl_lun *lun);
523 void ctl_tpc_lun_shutdown(struct ctl_lun *lun);
524 int ctl_inquiry_evpd_tpc(struct ctl_scsiio *ctsio, int alloc_len);
525 int ctl_receive_copy_status_lid1(struct ctl_scsiio *ctsio);
526 int ctl_receive_copy_failure_details(struct ctl_scsiio *ctsio);
527 int ctl_receive_copy_status_lid4(struct ctl_scsiio *ctsio);
528 int ctl_receive_copy_operating_parameters(struct ctl_scsiio *ctsio);
529 int ctl_extended_copy_lid1(struct ctl_scsiio *ctsio);
530 int ctl_extended_copy_lid4(struct ctl_scsiio *ctsio);
531 int ctl_copy_operation_abort(struct ctl_scsiio *ctsio);
532 int ctl_populate_token(struct ctl_scsiio *ctsio);
533 int ctl_write_using_token(struct ctl_scsiio *ctsio);
534 int ctl_receive_rod_token_information(struct ctl_scsiio *ctsio);
535 int ctl_report_all_rod_tokens(struct ctl_scsiio *ctsio);
539 #endif /* _CTL_PRIVATE_H_ */