2 * Copyright (c) 2003, 2004, 2005, 2008 Silicon Graphics International Corp.
3 * Copyright (c) 2014-2015 Alexander Motin <mav@FreeBSD.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions, and the following disclaimer,
11 * without modification.
12 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
13 * substantially similar to the "NO WARRANTY" disclaimer below
14 * ("Disclaimer") and any redistribution must be conditioned upon
15 * including a substantially similar Disclaimer requirement for further
16 * binary redistribution.
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
28 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGES.
31 * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_private.h#7 $
35 * CAM Target Layer driver private data structures/definitions.
37 * Author: Ken Merry <ken@FreeBSD.org>
40 #ifndef _CTL_PRIVATE_H_
41 #define _CTL_PRIVATE_H_
43 #include <cam/scsi/scsi_all.h>
44 #include <cam/scsi/scsi_cd.h>
45 #include <cam/scsi/scsi_da.h>
48 * SCSI vendor and product names.
50 #define CTL_VENDOR "FREEBSD "
51 #define CTL_DIRECT_PRODUCT "CTLDISK "
52 #define CTL_PROCESSOR_PRODUCT "CTLPROCESSOR "
53 #define CTL_CDROM_PRODUCT "CTLCDROM "
54 #define CTL_UNKNOWN_PRODUCT "CTLDEVICE "
56 #define CTL_POOL_ENTRIES_OTHER_SC 200
61 struct ctl_softc *ctl_softc;
62 struct uma_zone *zone;
73 } ctl_serialize_action;
78 CTL_ACTION_OVERLAP_TAG,
85 * WARNING: Keep the bottom nibble here free, we OR in the data direction
86 * flags for each command.
88 * Note: "OK_ON_NO_LUN" == we don't have to have a lun configured
89 * "OK_ON_BOTH" == we have to have a lun configured
90 * "SA5" == command has 5-bit service action at byte 1
93 CTL_CMD_FLAG_NONE = 0x0000,
94 CTL_CMD_FLAG_NO_SENSE = 0x0010,
95 CTL_CMD_FLAG_ALLOW_ON_RESV = 0x0020,
96 CTL_CMD_FLAG_ALLOW_ON_PR_RESV = 0x0040,
97 CTL_CMD_FLAG_ALLOW_ON_PR_WRESV = 0x0080,
98 CTL_CMD_FLAG_OK_ON_PROC = 0x0100,
99 CTL_CMD_FLAG_OK_ON_DIRECT = 0x0200,
100 CTL_CMD_FLAG_OK_ON_CDROM = 0x0400,
101 CTL_CMD_FLAG_OK_ON_BOTH = 0x0700,
102 CTL_CMD_FLAG_OK_ON_NO_LUN = 0x0800,
103 CTL_CMD_FLAG_OK_ON_NO_MEDIA = 0x1000,
104 CTL_CMD_FLAG_OK_ON_STANDBY = 0x2000,
105 CTL_CMD_FLAG_OK_ON_UNAVAIL = 0x4000,
106 CTL_CMD_FLAG_SA5 = 0x8000,
107 CTL_CMD_FLAG_RUN_HERE = 0x10000
125 /* TBD: others to be filled in as needed */
126 CTL_SERIDX_COUNT, /* LAST, not a normal code, provides # codes */
127 CTL_SERIDX_INVLD = CTL_SERIDX_COUNT
130 typedef int ctl_opfunc(struct ctl_scsiio *ctsio);
132 struct ctl_cmd_entry {
136 ctl_lun_error_pattern pattern;
137 uint8_t length; /* CDB length */
138 uint8_t usage[15]; /* Mask of allowed CDB bits
139 * after the opcode byte. */
143 CTL_LUN_NONE = 0x000,
144 CTL_LUN_CONTROL = 0x001,
145 CTL_LUN_RESERVED = 0x002,
146 CTL_LUN_INVALID = 0x004,
147 CTL_LUN_DISABLED = 0x008,
148 CTL_LUN_MALLOCED = 0x010,
149 CTL_LUN_STOPPED = 0x020,
150 CTL_LUN_NO_MEDIA = 0x040,
151 CTL_LUN_EJECTED = 0x080,
152 CTL_LUN_PR_RESERVED = 0x100,
153 CTL_LUN_PRIMARY_SC = 0x200,
154 CTL_LUN_SENSE_DESC = 0x400,
155 CTL_LUN_READONLY = 0x800,
156 CTL_LUN_PEER_SC_PRIMARY = 0x1000,
157 CTL_LUN_REMOVABLE = 0x2000
161 CTLBLOCK_FLAG_NONE = 0x00,
162 CTLBLOCK_FLAG_INVALID = 0x01
166 struct ctl_softc *ctl_softc;
167 struct ctlblock_softc *ctlblock_softc;
171 * Mode page defaults.
175 * These values make Solaris trim off some of the capacity.
177 #define CTL_DEFAULT_SECTORS_PER_TRACK 63
178 #define CTL_DEFAULT_HEADS 255
180 * These values seem to work okay.
182 #define CTL_DEFAULT_SECTORS_PER_TRACK 63
183 #define CTL_DEFAULT_HEADS 16
185 * These values work reasonably well.
187 #define CTL_DEFAULT_SECTORS_PER_TRACK 512
188 #define CTL_DEFAULT_HEADS 64
192 * Solaris is somewhat picky about how many heads and sectors per track you
193 * have defined in mode pages 3 and 4. These values seem to cause Solaris
194 * to get the capacity more or less right when you run the format tool.
195 * They still have problems when dealing with devices larger than 1TB,
196 * but there isn't anything we can do about that.
198 * For smaller LUN sizes, this ends up causing the number of cylinders to
199 * work out to 0. Solaris actually recognizes that and comes up with its
200 * own bogus geometry to fit the actual capacity of the drive. They really
201 * should just give up on geometry and stick to the read capacity
202 * information alone for modern disk drives.
204 * One thing worth mentioning about Solaris' mkfs command is that it
205 * doesn't like sectors per track values larger than 256. 512 seems to
206 * work okay for format, but causes problems when you try to make a
209 * Another caveat about these values: the product of these two values
210 * really should be a power of 2. This is because of the simplistic
211 * shift-based calculation that we have to use on the i386 platform to
212 * calculate the number of cylinders here. (If you use a divide, you end
213 * up calling __udivdi3(), which is a hardware FP call on the PC. On the
214 * XScale, it is done in software, so you can do that from inside the
217 * So for the current values (256 S/T, 128 H), we get 32768, which works
218 * very nicely for calculating cylinders.
220 * If you want to change these values so that their product is no longer a
221 * power of 2, re-visit the calculation in ctl_init_page_index(). You may
222 * need to make it a bit more complicated to get the number of cylinders
225 #define CTL_DEFAULT_SECTORS_PER_TRACK 256
226 #define CTL_DEFAULT_HEADS 128
228 #define CTL_DEFAULT_ROTATION_RATE SVPD_NON_ROTATING
230 struct ctl_page_index;
232 typedef int ctl_modesen_handler(struct ctl_scsiio *ctsio,
233 struct ctl_page_index *page_index,
235 typedef int ctl_modesel_handler(struct ctl_scsiio *ctsio,
236 struct ctl_page_index *page_index,
240 CTL_PAGE_FLAG_NONE = 0x00,
241 CTL_PAGE_FLAG_DIRECT = 0x01,
242 CTL_PAGE_FLAG_PROC = 0x02,
243 CTL_PAGE_FLAG_CDROM = 0x04,
244 CTL_PAGE_FLAG_ALL = 0x07
247 struct ctl_page_index {
252 ctl_page_flags page_flags;
253 ctl_modesen_handler *sense_handler;
254 ctl_modesel_handler *select_handler;
257 #define CTL_PAGE_CURRENT 0x00
258 #define CTL_PAGE_CHANGEABLE 0x01
259 #define CTL_PAGE_DEFAULT 0x02
260 #define CTL_PAGE_SAVED 0x03
262 #define CTL_NUM_LBP_PARAMS 4
263 #define CTL_NUM_LBP_THRESH 4
264 #define CTL_LBP_EXPONENT 11 /* 2048 sectors */
265 #define CTL_LBP_PERIOD 10 /* 10 seconds */
266 #define CTL_LBP_UA_PERIOD 300 /* 5 minutes */
268 struct ctl_logical_block_provisioning_page {
269 struct scsi_logical_block_provisioning_page main;
270 struct scsi_logical_block_provisioning_page_descr descr[CTL_NUM_LBP_THRESH];
273 static const struct ctl_page_index page_index_template[] = {
274 {SMS_RW_ERROR_RECOVERY_PAGE, 0, sizeof(struct scsi_da_rw_recovery_page), NULL,
275 CTL_PAGE_FLAG_DIRECT | CTL_PAGE_FLAG_CDROM, NULL, NULL},
276 {SMS_FORMAT_DEVICE_PAGE, 0, sizeof(struct scsi_format_page), NULL,
277 CTL_PAGE_FLAG_DIRECT, NULL, NULL},
278 {SMS_RIGID_DISK_PAGE, 0, sizeof(struct scsi_rigid_disk_page), NULL,
279 CTL_PAGE_FLAG_DIRECT, NULL, NULL},
280 {SMS_CACHING_PAGE, 0, sizeof(struct scsi_caching_page), NULL,
281 CTL_PAGE_FLAG_DIRECT | CTL_PAGE_FLAG_CDROM,
282 NULL, ctl_caching_sp_handler},
283 {SMS_CONTROL_MODE_PAGE, 0, sizeof(struct scsi_control_page), NULL,
284 CTL_PAGE_FLAG_ALL, NULL, ctl_control_page_handler},
285 {SMS_CONTROL_MODE_PAGE | SMPH_SPF, 0x01,
286 sizeof(struct scsi_control_ext_page), NULL,
287 CTL_PAGE_FLAG_ALL, NULL, NULL},
288 {SMS_INFO_EXCEPTIONS_PAGE, 0, sizeof(struct scsi_info_exceptions_page), NULL,
289 CTL_PAGE_FLAG_ALL, NULL, NULL},
290 {SMS_INFO_EXCEPTIONS_PAGE | SMPH_SPF, 0x02,
291 sizeof(struct ctl_logical_block_provisioning_page), NULL,
292 CTL_PAGE_FLAG_DIRECT, NULL, NULL},
293 {SMS_CDDVD_CAPS_PAGE, 0,
294 sizeof(struct scsi_cddvd_capabilities_page), NULL,
295 CTL_PAGE_FLAG_CDROM, NULL, NULL},
296 {SMS_VENDOR_SPECIFIC_PAGE | SMPH_SPF, DBGCNF_SUBPAGE_CODE,
297 sizeof(struct copan_debugconf_subpage), NULL, CTL_PAGE_FLAG_ALL,
298 ctl_debugconf_sp_sense_handler, ctl_debugconf_sp_select_handler},
301 #define CTL_NUM_MODE_PAGES sizeof(page_index_template)/ \
302 sizeof(page_index_template[0])
304 struct ctl_mode_pages {
305 struct scsi_da_rw_recovery_page rw_er_page[4];
306 struct scsi_format_page format_page[4];
307 struct scsi_rigid_disk_page rigid_disk_page[4];
308 struct scsi_caching_page caching_page[4];
309 struct scsi_control_page control_page[4];
310 struct scsi_control_ext_page control_ext_page[4];
311 struct scsi_info_exceptions_page ie_page[4];
312 struct ctl_logical_block_provisioning_page lbp_page[4];
313 struct scsi_cddvd_capabilities_page cddvd_page[4];
314 struct copan_debugconf_subpage debugconf_subpage[4];
315 struct ctl_page_index index[CTL_NUM_MODE_PAGES];
318 static const struct ctl_page_index log_page_index_template[] = {
319 {SLS_SUPPORTED_PAGES_PAGE, 0, 0, NULL,
320 CTL_PAGE_FLAG_ALL, NULL, NULL},
321 {SLS_SUPPORTED_PAGES_PAGE, SLS_SUPPORTED_SUBPAGES_SUBPAGE, 0, NULL,
322 CTL_PAGE_FLAG_ALL, NULL, NULL},
323 {SLS_LOGICAL_BLOCK_PROVISIONING, 0, 0, NULL,
324 CTL_PAGE_FLAG_DIRECT, ctl_lbp_log_sense_handler, NULL},
325 {SLS_STAT_AND_PERF, 0, 0, NULL,
326 CTL_PAGE_FLAG_ALL, ctl_sap_log_sense_handler, NULL},
329 #define CTL_NUM_LOG_PAGES sizeof(log_page_index_template)/ \
330 sizeof(log_page_index_template[0])
332 struct ctl_log_pages {
333 uint8_t pages_page[CTL_NUM_LOG_PAGES];
334 uint8_t subpages_page[CTL_NUM_LOG_PAGES * 2];
335 uint8_t lbp_page[12*CTL_NUM_LBP_PARAMS];
337 struct scsi_log_stat_and_perf sap;
338 struct scsi_log_idle_time it;
339 struct scsi_log_time_interval ti;
341 struct ctl_page_index index[CTL_NUM_LOG_PAGES];
344 struct ctl_lun_delay_info {
345 ctl_delay_type datamove_type;
346 uint32_t datamove_delay;
347 ctl_delay_type done_type;
351 #define CTL_PR_ALL_REGISTRANTS 0xFFFFFFFF
352 #define CTL_PR_NO_RESERVATION 0xFFFFFFF0
360 * For report target port groups.
362 #define NUM_TARGET_PORT_GROUPS 2
364 #define CTL_WRITE_BUFFER_SIZE 262144
371 STAILQ_HEAD(,ctl_error_desc) error_list;
372 uint64_t error_serial;
373 struct ctl_softc *ctl_softc;
374 struct ctl_be_lun *be_lun;
375 struct ctl_backend_driver *backend;
376 struct ctl_lun_delay_info delay_info;
378 sbintime_t idle_time;
379 sbintime_t last_busy;
381 TAILQ_HEAD(ctl_ooaq, ctl_io_hdr) ooa_queue;
382 TAILQ_HEAD(ctl_blockq,ctl_io_hdr) blocked_queue;
383 STAILQ_ENTRY(ctl_lun) links;
385 uint32_t have_ca[CTL_MAX_INITIATORS >> 5];
386 struct scsi_sense_data pending_sense[CTL_MAX_INITIATORS];
388 ctl_ua_type *pending_ua[CTL_MAX_PORTS];
389 uint8_t ua_tpt_info[8];
391 struct ctl_mode_pages mode_pages;
392 struct ctl_log_pages log_pages;
393 struct ctl_lun_io_stats stats;
395 uint32_t pr_generation;
396 uint64_t *pr_keys[CTL_MAX_PORTS];
401 uint32_t prevent[(CTL_MAX_INITIATORS+31)/32];
402 uint8_t *write_buffer;
403 struct ctl_devid *lun_devid;
404 TAILQ_HEAD(tpc_lists, tpc_list) tpc_lists;
408 CTL_FLAG_ACTIVE_SHELF = 0x04
411 #define CTL_MAX_THREADS 16
414 struct mtx_padalign queue_lock;
415 struct ctl_softc *ctl_softc;
416 struct thread *thread;
417 STAILQ_HEAD(, ctl_io_hdr) incoming_queue;
418 STAILQ_HEAD(, ctl_io_hdr) rtr_queue;
419 STAILQ_HEAD(, ctl_io_hdr) done_queue;
420 STAILQ_HEAD(, ctl_io_hdr) isc_queue;
432 ctl_ha_link_state ha_link;
438 struct sysctl_ctx_list sysctl_ctx;
439 struct sysctl_oid *sysctl_tree;
441 struct proc *ctl_proc;
442 uint32_t ctl_lun_mask[(CTL_MAX_LUNS + 31) / 32];
443 struct ctl_lun *ctl_luns[CTL_MAX_LUNS];
444 uint32_t ctl_port_mask[(CTL_MAX_PORTS + 31) / 32];
445 STAILQ_HEAD(, ctl_lun) lun_list;
446 STAILQ_HEAD(, ctl_be_lun) pending_lun_queue;
447 uint32_t num_frontends;
448 STAILQ_HEAD(, ctl_frontend) fe_list;
450 STAILQ_HEAD(, ctl_port) port_list;
451 struct ctl_port *ctl_ports[CTL_MAX_PORTS];
452 uint32_t num_backends;
453 STAILQ_HEAD(, ctl_backend_driver) be_list;
454 struct uma_zone *io_zone;
455 uint32_t cur_pool_id;
456 struct ctl_thread threads[CTL_MAX_THREADS];
457 TAILQ_HEAD(tpc_tokens, tpc_token) tpc_tokens;
458 struct callout tpc_timeout;
464 extern const struct ctl_cmd_entry ctl_cmd_table[256];
466 uint32_t ctl_get_initindex(struct ctl_nexus *nexus);
467 int ctl_lun_map_init(struct ctl_port *port);
468 int ctl_lun_map_deinit(struct ctl_port *port);
469 int ctl_lun_map_set(struct ctl_port *port, uint32_t plun, uint32_t glun);
470 int ctl_lun_map_unset(struct ctl_port *port, uint32_t plun);
471 uint32_t ctl_lun_map_from_port(struct ctl_port *port, uint32_t plun);
472 uint32_t ctl_lun_map_to_port(struct ctl_port *port, uint32_t glun);
473 int ctl_pool_create(struct ctl_softc *ctl_softc, const char *pool_name,
474 uint32_t total_ctl_io, void **npool);
475 void ctl_pool_free(struct ctl_io_pool *pool);
476 int ctl_scsi_release(struct ctl_scsiio *ctsio);
477 int ctl_scsi_reserve(struct ctl_scsiio *ctsio);
478 int ctl_start_stop(struct ctl_scsiio *ctsio);
479 int ctl_prevent_allow(struct ctl_scsiio *ctsio);
480 int ctl_sync_cache(struct ctl_scsiio *ctsio);
481 int ctl_format(struct ctl_scsiio *ctsio);
482 int ctl_read_buffer(struct ctl_scsiio *ctsio);
483 int ctl_write_buffer(struct ctl_scsiio *ctsio);
484 int ctl_write_same(struct ctl_scsiio *ctsio);
485 int ctl_unmap(struct ctl_scsiio *ctsio);
486 int ctl_mode_select(struct ctl_scsiio *ctsio);
487 int ctl_mode_sense(struct ctl_scsiio *ctsio);
488 int ctl_log_sense(struct ctl_scsiio *ctsio);
489 int ctl_read_capacity(struct ctl_scsiio *ctsio);
490 int ctl_read_capacity_16(struct ctl_scsiio *ctsio);
491 int ctl_read_defect(struct ctl_scsiio *ctsio);
492 int ctl_read_toc(struct ctl_scsiio *ctsio);
493 int ctl_read_write(struct ctl_scsiio *ctsio);
494 int ctl_cnw(struct ctl_scsiio *ctsio);
495 int ctl_report_luns(struct ctl_scsiio *ctsio);
496 int ctl_request_sense(struct ctl_scsiio *ctsio);
497 int ctl_tur(struct ctl_scsiio *ctsio);
498 int ctl_verify(struct ctl_scsiio *ctsio);
499 int ctl_inquiry(struct ctl_scsiio *ctsio);
500 int ctl_get_config(struct ctl_scsiio *ctsio);
501 int ctl_get_event_status(struct ctl_scsiio *ctsio);
502 int ctl_mechanism_status(struct ctl_scsiio *ctsio);
503 int ctl_persistent_reserve_in(struct ctl_scsiio *ctsio);
504 int ctl_persistent_reserve_out(struct ctl_scsiio *ctsio);
505 int ctl_report_tagret_port_groups(struct ctl_scsiio *ctsio);
506 int ctl_report_supported_opcodes(struct ctl_scsiio *ctsio);
507 int ctl_report_supported_tmf(struct ctl_scsiio *ctsio);
508 int ctl_report_timestamp(struct ctl_scsiio *ctsio);
509 int ctl_get_lba_status(struct ctl_scsiio *ctsio);
511 void ctl_tpc_init(struct ctl_softc *softc);
512 void ctl_tpc_shutdown(struct ctl_softc *softc);
513 void ctl_tpc_lun_init(struct ctl_lun *lun);
514 void ctl_tpc_lun_shutdown(struct ctl_lun *lun);
515 int ctl_inquiry_evpd_tpc(struct ctl_scsiio *ctsio, int alloc_len);
516 int ctl_receive_copy_status_lid1(struct ctl_scsiio *ctsio);
517 int ctl_receive_copy_failure_details(struct ctl_scsiio *ctsio);
518 int ctl_receive_copy_status_lid4(struct ctl_scsiio *ctsio);
519 int ctl_receive_copy_operating_parameters(struct ctl_scsiio *ctsio);
520 int ctl_extended_copy_lid1(struct ctl_scsiio *ctsio);
521 int ctl_extended_copy_lid4(struct ctl_scsiio *ctsio);
522 int ctl_copy_operation_abort(struct ctl_scsiio *ctsio);
523 int ctl_populate_token(struct ctl_scsiio *ctsio);
524 int ctl_write_using_token(struct ctl_scsiio *ctsio);
525 int ctl_receive_rod_token_information(struct ctl_scsiio *ctsio);
526 int ctl_report_all_rod_tokens(struct ctl_scsiio *ctsio);
530 #endif /* _CTL_PRIVATE_H_ */