2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2003, 2004, 2005, 2008 Silicon Graphics International Corp.
5 * Copyright (c) 2014-2017 Alexander Motin <mav@FreeBSD.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions, and the following disclaimer,
13 * without modification.
14 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
15 * substantially similar to the "NO WARRANTY" disclaimer below
16 * ("Disclaimer") and any redistribution must be conditioned upon
17 * including a substantially similar Disclaimer requirement for further
18 * binary redistribution.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
29 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
30 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGES.
33 * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_private.h#7 $
36 * CAM Target Layer driver private data structures/definitions.
38 * Author: Ken Merry <ken@FreeBSD.org>
41 #ifndef _CTL_PRIVATE_H_
42 #define _CTL_PRIVATE_H_
44 #include <sys/sysctl.h>
45 #include <cam/scsi/scsi_all.h>
46 #include <cam/scsi/scsi_cd.h>
47 #include <cam/scsi/scsi_da.h>
50 * SCSI vendor and product names.
52 #define CTL_VENDOR "FREEBSD "
53 #define CTL_DIRECT_PRODUCT "CTLDISK "
54 #define CTL_PROCESSOR_PRODUCT "CTLPROCESSOR "
55 #define CTL_CDROM_PRODUCT "CTLCDROM "
56 #define CTL_UNKNOWN_PRODUCT "CTLDEVICE "
58 #define CTL_POOL_ENTRIES_OTHER_SC 200
63 struct ctl_softc *ctl_softc;
64 struct uma_zone *zone;
74 } ctl_serialize_action;
81 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_STOPPED = 0x020,
149 CTL_LUN_NO_MEDIA = 0x040,
150 CTL_LUN_EJECTED = 0x080,
151 CTL_LUN_PR_RESERVED = 0x100,
152 CTL_LUN_PRIMARY_SC = 0x200,
153 CTL_LUN_READONLY = 0x800,
154 CTL_LUN_PEER_SC_PRIMARY = 0x1000,
155 CTL_LUN_REMOVABLE = 0x2000
159 CTLBLOCK_FLAG_NONE = 0x00,
160 CTLBLOCK_FLAG_INVALID = 0x01
164 struct ctl_softc *ctl_softc;
165 struct ctlblock_softc *ctlblock_softc;
169 * Mode page defaults.
171 #define CTL_DEFAULT_ROTATION_RATE SVPD_NON_ROTATING
173 struct ctl_page_index;
175 typedef int ctl_modesen_handler(struct ctl_scsiio *ctsio,
176 struct ctl_page_index *page_index,
178 typedef int ctl_modesel_handler(struct ctl_scsiio *ctsio,
179 struct ctl_page_index *page_index,
183 CTL_PAGE_FLAG_NONE = 0x00,
184 CTL_PAGE_FLAG_DIRECT = 0x01,
185 CTL_PAGE_FLAG_PROC = 0x02,
186 CTL_PAGE_FLAG_CDROM = 0x04,
187 CTL_PAGE_FLAG_ALL = 0x07
190 struct ctl_page_index {
195 ctl_page_flags page_flags;
196 ctl_modesen_handler *sense_handler;
197 ctl_modesel_handler *select_handler;
200 #define CTL_PAGE_CURRENT 0x00
201 #define CTL_PAGE_CHANGEABLE 0x01
202 #define CTL_PAGE_DEFAULT 0x02
203 #define CTL_PAGE_SAVED 0x03
205 #define CTL_NUM_LBP_PARAMS 4
206 #define CTL_NUM_LBP_THRESH 4
207 #define CTL_LBP_EXPONENT 11 /* 2048 sectors */
208 #define CTL_LBP_PERIOD 10 /* 10 seconds */
209 #define CTL_LBP_UA_PERIOD 300 /* 5 minutes */
211 struct ctl_logical_block_provisioning_page {
212 struct scsi_logical_block_provisioning_page main;
213 struct scsi_logical_block_provisioning_page_descr descr[CTL_NUM_LBP_THRESH];
216 static const struct ctl_page_index page_index_template[] = {
217 {SMS_RW_ERROR_RECOVERY_PAGE, 0, sizeof(struct scsi_da_rw_recovery_page), NULL,
218 CTL_PAGE_FLAG_DIRECT | CTL_PAGE_FLAG_CDROM, NULL, ctl_default_page_handler},
219 {SMS_VERIFY_ERROR_RECOVERY_PAGE, 0, sizeof(struct scsi_da_verify_recovery_page), NULL,
220 CTL_PAGE_FLAG_DIRECT | CTL_PAGE_FLAG_CDROM, NULL, ctl_default_page_handler},
221 {SMS_CACHING_PAGE, 0, sizeof(struct scsi_caching_page), NULL,
222 CTL_PAGE_FLAG_DIRECT | CTL_PAGE_FLAG_CDROM,
223 NULL, ctl_default_page_handler},
224 {SMS_CONTROL_MODE_PAGE, 0, sizeof(struct scsi_control_page), NULL,
225 CTL_PAGE_FLAG_ALL, NULL, ctl_default_page_handler},
226 {SMS_CONTROL_MODE_PAGE | SMPH_SPF, 0x01,
227 sizeof(struct scsi_control_ext_page), NULL,
228 CTL_PAGE_FLAG_ALL, NULL, ctl_default_page_handler},
229 {SMS_INFO_EXCEPTIONS_PAGE, 0, sizeof(struct scsi_info_exceptions_page), NULL,
230 CTL_PAGE_FLAG_ALL, NULL, ctl_ie_page_handler},
231 {SMS_INFO_EXCEPTIONS_PAGE | SMPH_SPF, 0x02,
232 sizeof(struct ctl_logical_block_provisioning_page), NULL,
233 CTL_PAGE_FLAG_DIRECT, NULL, ctl_default_page_handler},
234 {SMS_CDDVD_CAPS_PAGE, 0,
235 sizeof(struct scsi_cddvd_capabilities_page), NULL,
236 CTL_PAGE_FLAG_CDROM, NULL, NULL},
239 #define CTL_NUM_MODE_PAGES sizeof(page_index_template)/ \
240 sizeof(page_index_template[0])
242 struct ctl_mode_pages {
243 struct scsi_da_rw_recovery_page rw_er_page[4];
244 struct scsi_da_verify_recovery_page verify_er_page[4];
245 struct scsi_caching_page caching_page[4];
246 struct scsi_control_page control_page[4];
247 struct scsi_control_ext_page control_ext_page[4];
248 struct scsi_info_exceptions_page ie_page[4];
249 struct ctl_logical_block_provisioning_page lbp_page[4];
250 struct scsi_cddvd_capabilities_page cddvd_page[4];
251 struct ctl_page_index index[CTL_NUM_MODE_PAGES];
254 #define MODE_RWER mode_pages.rw_er_page[CTL_PAGE_CURRENT]
255 #define MODE_VER mode_pages.verify_er_page[CTL_PAGE_CURRENT]
256 #define MODE_CACHING mode_pages.caching_page[CTL_PAGE_CURRENT]
257 #define MODE_CTRL mode_pages.control_page[CTL_PAGE_CURRENT]
258 #define MODE_CTRLE mode_pages.control_ext_page[CTL_PAGE_CURRENT]
259 #define MODE_IE mode_pages.ie_page[CTL_PAGE_CURRENT]
260 #define MODE_LBP mode_pages.lbp_page[CTL_PAGE_CURRENT]
261 #define MODE_CDDVD mode_pages.cddvd_page[CTL_PAGE_CURRENT]
263 static const struct ctl_page_index log_page_index_template[] = {
264 {SLS_SUPPORTED_PAGES_PAGE, 0, 0, NULL,
265 CTL_PAGE_FLAG_ALL, NULL, NULL},
266 {SLS_SUPPORTED_PAGES_PAGE, SLS_SUPPORTED_SUBPAGES_SUBPAGE, 0, NULL,
267 CTL_PAGE_FLAG_ALL, NULL, NULL},
268 {SLS_TEMPERATURE, 0, 0, NULL,
269 CTL_PAGE_FLAG_DIRECT, ctl_temp_log_sense_handler, NULL},
270 {SLS_LOGICAL_BLOCK_PROVISIONING, 0, 0, NULL,
271 CTL_PAGE_FLAG_DIRECT, ctl_lbp_log_sense_handler, NULL},
272 {SLS_STAT_AND_PERF, 0, 0, NULL,
273 CTL_PAGE_FLAG_ALL, ctl_sap_log_sense_handler, NULL},
274 {SLS_IE_PAGE, 0, 0, NULL,
275 CTL_PAGE_FLAG_ALL, ctl_ie_log_sense_handler, NULL},
278 #define CTL_NUM_LOG_PAGES sizeof(log_page_index_template)/ \
279 sizeof(log_page_index_template[0])
281 struct ctl_log_pages {
282 uint8_t pages_page[CTL_NUM_LOG_PAGES];
283 uint8_t subpages_page[CTL_NUM_LOG_PAGES * 2];
284 uint8_t lbp_page[12*CTL_NUM_LBP_PARAMS];
286 struct scsi_log_stat_and_perf sap;
287 struct scsi_log_idle_time it;
288 struct scsi_log_time_interval ti;
290 struct scsi_log_temperature temp_page[2];
291 struct scsi_log_informational_exceptions ie_page;
292 struct ctl_page_index index[CTL_NUM_LOG_PAGES];
295 struct ctl_lun_delay_info {
296 ctl_delay_type datamove_type;
297 uint32_t datamove_delay;
298 ctl_delay_type done_type;
302 #define CTL_PR_ALL_REGISTRANTS 0xFFFFFFFF
303 #define CTL_PR_NO_RESERVATION 0xFFFFFFF0
310 #define NUM_HA_SHELVES 2
312 #define CTL_WRITE_BUFFER_SIZE 262144
319 STAILQ_HEAD(,ctl_error_desc) error_list;
320 uint64_t error_serial;
321 struct ctl_softc *ctl_softc;
322 struct ctl_be_lun *be_lun;
323 struct ctl_backend_driver *backend;
324 struct ctl_lun_delay_info delay_info;
326 sbintime_t idle_time;
327 sbintime_t last_busy;
329 LIST_HEAD(ctl_ooaq, ctl_io_hdr) ooa_queue;
330 STAILQ_ENTRY(ctl_lun) links;
331 struct scsi_sense_data **pending_sense;
332 ctl_ua_type **pending_ua;
333 uint8_t ua_tpt_info[8];
335 uint8_t ie_asc; /* Informational exceptions */
337 int ie_reported; /* Already reported */
338 uint32_t ie_reportcnt; /* REPORT COUNT */
339 struct callout ie_callout; /* INTERVAL TIMER */
340 struct ctl_mode_pages mode_pages;
341 struct ctl_log_pages log_pages;
342 struct ctl_io_stats stats;
344 uint32_t pr_generation;
351 uint8_t *write_buffer;
352 struct ctl_devid *lun_devid;
353 TAILQ_HEAD(tpc_lists, tpc_list) tpc_lists;
357 CTL_FLAG_ACTIVE_SHELF = 0x04
360 #define CTL_MAX_THREADS 16
363 struct mtx_padalign queue_lock;
364 struct ctl_softc *ctl_softc;
365 struct thread *thread;
366 STAILQ_HEAD(, ctl_io_hdr) incoming_queue;
367 STAILQ_HEAD(, ctl_io_hdr) rtr_queue;
368 STAILQ_HEAD(, ctl_io_hdr) done_queue;
369 STAILQ_HEAD(, ctl_io_hdr) isc_queue;
381 ctl_ha_link_state ha_link;
387 struct sysctl_ctx_list sysctl_ctx;
388 struct sysctl_oid *sysctl_tree;
390 struct proc *ctl_proc;
391 uint32_t *ctl_lun_mask;
392 struct ctl_lun **ctl_luns;
393 uint32_t *ctl_port_mask;
394 STAILQ_HEAD(, ctl_lun) lun_list;
395 uint32_t num_frontends;
396 STAILQ_HEAD(, ctl_frontend) fe_list;
398 STAILQ_HEAD(, ctl_port) port_list;
399 struct ctl_port **ctl_ports;
400 uint32_t num_backends;
401 STAILQ_HEAD(, ctl_backend_driver) be_list;
402 struct uma_zone *io_zone;
403 uint32_t cur_pool_id;
405 struct ctl_thread threads[CTL_MAX_THREADS];
406 struct thread *thresh_thread;
407 TAILQ_HEAD(tpc_tokens, tpc_token) tpc_tokens;
408 struct callout tpc_timeout;
414 extern const struct ctl_cmd_entry ctl_cmd_table[256];
416 uint32_t ctl_get_initindex(struct ctl_nexus *nexus);
417 int ctl_lun_map_init(struct ctl_port *port);
418 int ctl_lun_map_deinit(struct ctl_port *port);
419 int ctl_lun_map_set(struct ctl_port *port, uint32_t plun, uint32_t glun);
420 int ctl_lun_map_unset(struct ctl_port *port, uint32_t plun);
421 uint32_t ctl_lun_map_from_port(struct ctl_port *port, uint32_t plun);
422 uint32_t ctl_lun_map_to_port(struct ctl_port *port, uint32_t glun);
423 int ctl_pool_create(struct ctl_softc *ctl_softc, const char *pool_name,
424 uint32_t total_ctl_io, void **npool);
425 void ctl_pool_free(struct ctl_io_pool *pool);
426 int ctl_scsi_release(struct ctl_scsiio *ctsio);
427 int ctl_scsi_reserve(struct ctl_scsiio *ctsio);
428 int ctl_start_stop(struct ctl_scsiio *ctsio);
429 int ctl_prevent_allow(struct ctl_scsiio *ctsio);
430 int ctl_sync_cache(struct ctl_scsiio *ctsio);
431 int ctl_format(struct ctl_scsiio *ctsio);
432 int ctl_read_buffer(struct ctl_scsiio *ctsio);
433 int ctl_write_buffer(struct ctl_scsiio *ctsio);
434 int ctl_write_same(struct ctl_scsiio *ctsio);
435 int ctl_unmap(struct ctl_scsiio *ctsio);
436 int ctl_mode_select(struct ctl_scsiio *ctsio);
437 int ctl_mode_sense(struct ctl_scsiio *ctsio);
438 int ctl_log_sense(struct ctl_scsiio *ctsio);
439 int ctl_read_capacity(struct ctl_scsiio *ctsio);
440 int ctl_read_capacity_16(struct ctl_scsiio *ctsio);
441 int ctl_read_defect(struct ctl_scsiio *ctsio);
442 int ctl_read_toc(struct ctl_scsiio *ctsio);
443 int ctl_read_write(struct ctl_scsiio *ctsio);
444 int ctl_cnw(struct ctl_scsiio *ctsio);
445 int ctl_report_luns(struct ctl_scsiio *ctsio);
446 int ctl_request_sense(struct ctl_scsiio *ctsio);
447 int ctl_tur(struct ctl_scsiio *ctsio);
448 int ctl_verify(struct ctl_scsiio *ctsio);
449 int ctl_inquiry(struct ctl_scsiio *ctsio);
450 int ctl_get_config(struct ctl_scsiio *ctsio);
451 int ctl_get_event_status(struct ctl_scsiio *ctsio);
452 int ctl_mechanism_status(struct ctl_scsiio *ctsio);
453 int ctl_persistent_reserve_in(struct ctl_scsiio *ctsio);
454 int ctl_persistent_reserve_out(struct ctl_scsiio *ctsio);
455 int ctl_report_ident_info(struct ctl_scsiio *ctsio);
456 int ctl_report_tagret_port_groups(struct ctl_scsiio *ctsio);
457 int ctl_report_supported_opcodes(struct ctl_scsiio *ctsio);
458 int ctl_report_supported_tmf(struct ctl_scsiio *ctsio);
459 int ctl_report_timestamp(struct ctl_scsiio *ctsio);
460 int ctl_get_lba_status(struct ctl_scsiio *ctsio);
462 void ctl_tpc_init(struct ctl_softc *softc);
463 void ctl_tpc_shutdown(struct ctl_softc *softc);
464 void ctl_tpc_lun_init(struct ctl_lun *lun);
465 void ctl_tpc_lun_clear(struct ctl_lun *lun, uint32_t initidx);
466 void ctl_tpc_lun_shutdown(struct ctl_lun *lun);
467 int ctl_inquiry_evpd_tpc(struct ctl_scsiio *ctsio, int alloc_len);
468 int ctl_receive_copy_status_lid1(struct ctl_scsiio *ctsio);
469 int ctl_receive_copy_failure_details(struct ctl_scsiio *ctsio);
470 int ctl_receive_copy_status_lid4(struct ctl_scsiio *ctsio);
471 int ctl_receive_copy_operating_parameters(struct ctl_scsiio *ctsio);
472 int ctl_extended_copy_lid1(struct ctl_scsiio *ctsio);
473 int ctl_extended_copy_lid4(struct ctl_scsiio *ctsio);
474 int ctl_copy_operation_abort(struct ctl_scsiio *ctsio);
475 int ctl_populate_token(struct ctl_scsiio *ctsio);
476 int ctl_write_using_token(struct ctl_scsiio *ctsio);
477 int ctl_receive_rod_token_information(struct ctl_scsiio *ctsio);
478 int ctl_report_all_rod_tokens(struct ctl_scsiio *ctsio);
482 #endif /* _CTL_PRIVATE_H_ */