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
86 CTL_POOL_FLAG_NONE = 0x00,
87 CTL_POOL_FLAG_INVALID = 0x01
94 struct ctl_softc *ctl_softc;
96 uint64_t total_allocated;
100 STAILQ_HEAD(, ctl_io_hdr) free_queue;
101 STAILQ_ENTRY(ctl_io_pool) links;
105 CTL_IOCTL_FLAG_NONE = 0x00,
106 CTL_IOCTL_FLAG_ENABLED = 0x01
109 struct ctl_ioctl_info {
110 ctl_ioctl_flags flags;
111 uint32_t cur_tag_num;
112 struct ctl_port port;
123 } ctl_serialize_action;
128 CTL_ACTION_OVERLAP_TAG,
135 * WARNING: Keep the bottom nibble here free, we OR in the data direction
136 * flags for each command.
138 * Note: "OK_ON_ALL_LUNS" == we don't have to have a lun configured
139 * "OK_ON_BOTH" == we have to have a lun configured
140 * "SA5" == command has 5-bit service action at byte 1
143 CTL_CMD_FLAG_NONE = 0x0000,
144 CTL_CMD_FLAG_NO_SENSE = 0x0010,
145 CTL_CMD_FLAG_OK_ON_ALL_LUNS = 0x0020,
146 CTL_CMD_FLAG_ALLOW_ON_RESV = 0x0040,
147 CTL_CMD_FLAG_OK_ON_PROC = 0x0100,
148 CTL_CMD_FLAG_OK_ON_SLUN = 0x0200,
149 CTL_CMD_FLAG_OK_ON_BOTH = 0x0300,
150 CTL_CMD_FLAG_OK_ON_STOPPED = 0x0400,
151 CTL_CMD_FLAG_OK_ON_INOPERABLE = 0x0800,
152 CTL_CMD_FLAG_OK_ON_OFFLINE = 0x1000,
153 CTL_CMD_FLAG_OK_ON_SECONDARY = 0x2000,
154 CTL_CMD_FLAG_ALLOW_ON_PR_RESV = 0x4000,
155 CTL_CMD_FLAG_SA5 = 0x8000
172 /* TBD: others to be filled in as needed */
173 CTL_SERIDX_COUNT, /* LAST, not a normal code, provides # codes */
174 CTL_SERIDX_INVLD = CTL_SERIDX_COUNT
177 typedef int ctl_opfunc(struct ctl_scsiio *ctsio);
179 struct ctl_cmd_entry {
183 ctl_lun_error_pattern pattern;
184 uint8_t length; /* CDB length */
185 uint8_t usage[15]; /* Mask of allowed CDB bits
186 * after the opcode byte. */
190 CTL_LUN_NONE = 0x000,
191 CTL_LUN_CONTROL = 0x001,
192 CTL_LUN_RESERVED = 0x002,
193 CTL_LUN_INVALID = 0x004,
194 CTL_LUN_DISABLED = 0x008,
195 CTL_LUN_MALLOCED = 0x010,
196 CTL_LUN_STOPPED = 0x020,
197 CTL_LUN_INOPERABLE = 0x040,
198 CTL_LUN_OFFLINE = 0x080,
199 CTL_LUN_PR_RESERVED = 0x100,
200 CTL_LUN_PRIMARY_SC = 0x200,
201 CTL_LUN_SENSE_DESC = 0x400
205 CTLBLOCK_FLAG_NONE = 0x00,
206 CTLBLOCK_FLAG_INVALID = 0x01
210 struct ctl_softc *ctl_softc;
211 struct ctlblock_softc *ctlblock_softc;
215 * Mode page defaults.
219 * These values make Solaris trim off some of the capacity.
221 #define CTL_DEFAULT_SECTORS_PER_TRACK 63
222 #define CTL_DEFAULT_HEADS 255
224 * These values seem to work okay.
226 #define CTL_DEFAULT_SECTORS_PER_TRACK 63
227 #define CTL_DEFAULT_HEADS 16
229 * These values work reasonably well.
231 #define CTL_DEFAULT_SECTORS_PER_TRACK 512
232 #define CTL_DEFAULT_HEADS 64
236 * Solaris is somewhat picky about how many heads and sectors per track you
237 * have defined in mode pages 3 and 4. These values seem to cause Solaris
238 * to get the capacity more or less right when you run the format tool.
239 * They still have problems when dealing with devices larger than 1TB,
240 * but there isn't anything we can do about that.
242 * For smaller LUN sizes, this ends up causing the number of cylinders to
243 * work out to 0. Solaris actually recognizes that and comes up with its
244 * own bogus geometry to fit the actual capacity of the drive. They really
245 * should just give up on geometry and stick to the read capacity
246 * information alone for modern disk drives.
248 * One thing worth mentioning about Solaris' mkfs command is that it
249 * doesn't like sectors per track values larger than 256. 512 seems to
250 * work okay for format, but causes problems when you try to make a
253 * Another caveat about these values: the product of these two values
254 * really should be a power of 2. This is because of the simplistic
255 * shift-based calculation that we have to use on the i386 platform to
256 * calculate the number of cylinders here. (If you use a divide, you end
257 * up calling __udivdi3(), which is a hardware FP call on the PC. On the
258 * XScale, it is done in software, so you can do that from inside the
261 * So for the current values (256 S/T, 128 H), we get 32768, which works
262 * very nicely for calculating cylinders.
264 * If you want to change these values so that their product is no longer a
265 * power of 2, re-visit the calculation in ctl_init_page_index(). You may
266 * need to make it a bit more complicated to get the number of cylinders
269 #define CTL_DEFAULT_SECTORS_PER_TRACK 256
270 #define CTL_DEFAULT_HEADS 128
272 #define CTL_DEFAULT_ROTATION_RATE 10000
274 struct ctl_page_index;
276 typedef int ctl_modesen_handler(struct ctl_scsiio *ctsio,
277 struct ctl_page_index *page_index,
279 typedef int ctl_modesel_handler(struct ctl_scsiio *ctsio,
280 struct ctl_page_index *page_index,
284 CTL_PAGE_FLAG_NONE = 0x00,
285 CTL_PAGE_FLAG_DISK_ONLY = 0x01
288 struct ctl_page_index {
293 ctl_page_flags page_flags;
294 ctl_modesen_handler *sense_handler;
295 ctl_modesel_handler *select_handler;
298 #define CTL_PAGE_CURRENT 0x00
299 #define CTL_PAGE_CHANGEABLE 0x01
300 #define CTL_PAGE_DEFAULT 0x02
301 #define CTL_PAGE_SAVED 0x03
303 static const struct ctl_page_index page_index_template[] = {
304 {SMS_FORMAT_DEVICE_PAGE, 0, sizeof(struct scsi_format_page), NULL,
305 CTL_PAGE_FLAG_DISK_ONLY, NULL, NULL},
306 {SMS_RIGID_DISK_PAGE, 0, sizeof(struct scsi_rigid_disk_page), NULL,
307 CTL_PAGE_FLAG_DISK_ONLY, NULL, NULL},
308 {SMS_CACHING_PAGE, 0, sizeof(struct scsi_caching_page), NULL,
309 CTL_PAGE_FLAG_DISK_ONLY, NULL, ctl_caching_sp_handler},
310 {SMS_CONTROL_MODE_PAGE, 0, sizeof(struct scsi_control_page), NULL,
311 CTL_PAGE_FLAG_NONE, NULL, ctl_control_page_handler},
312 {SMS_VENDOR_SPECIFIC_PAGE | SMPH_SPF, PWR_SUBPAGE_CODE,
313 sizeof(struct copan_power_subpage), NULL, CTL_PAGE_FLAG_NONE,
314 ctl_power_sp_sense_handler, ctl_power_sp_handler},
315 {SMS_VENDOR_SPECIFIC_PAGE | SMPH_SPF, APS_SUBPAGE_CODE,
316 sizeof(struct copan_aps_subpage), NULL, CTL_PAGE_FLAG_NONE,
317 NULL, ctl_aps_sp_handler},
318 {SMS_VENDOR_SPECIFIC_PAGE | SMPH_SPF, DBGCNF_SUBPAGE_CODE,
319 sizeof(struct copan_debugconf_subpage), NULL, CTL_PAGE_FLAG_NONE,
320 ctl_debugconf_sp_sense_handler, ctl_debugconf_sp_select_handler},
323 #define CTL_NUM_MODE_PAGES sizeof(page_index_template)/ \
324 sizeof(page_index_template[0])
326 struct ctl_mode_pages {
327 struct scsi_format_page format_page[4];
328 struct scsi_rigid_disk_page rigid_disk_page[4];
329 struct scsi_caching_page caching_page[4];
330 struct scsi_control_page control_page[4];
331 struct copan_power_subpage power_subpage[4];
332 struct copan_aps_subpage aps_subpage[4];
333 struct copan_debugconf_subpage debugconf_subpage[4];
334 struct ctl_page_index index[CTL_NUM_MODE_PAGES];
337 struct ctl_lun_delay_info {
338 ctl_delay_type datamove_type;
339 uint32_t datamove_delay;
340 ctl_delay_type done_type;
345 CTL_ERR_INJ_NONE = 0x00,
346 CTL_ERR_INJ_ABORTED = 0x01
347 } ctl_err_inject_flags;
350 CTL_PR_FLAG_NONE = 0x00,
351 CTL_PR_FLAG_REGISTERED = 0x01,
352 CTL_PR_FLAG_ACTIVE_RES = 0x02
355 struct ctl_per_res_info {
356 struct scsi_per_res_key res_key;
360 #define CTL_PR_ALL_REGISTRANTS 0xFFFFFFFF
361 #define CTL_PR_NO_RESERVATION 0xFFFFFFF0
369 * For report target port groups.
371 #define NUM_TARGET_PORT_GROUPS 2
376 struct ctl_id target;
379 STAILQ_HEAD(,ctl_error_desc) error_list;
380 uint64_t error_serial;
381 struct ctl_softc *ctl_softc;
382 struct ctl_be_lun *be_lun;
383 struct ctl_backend_driver *backend;
385 struct ctl_lun_delay_info delay_info;
388 TAILQ_HEAD(ctl_ooaq, ctl_io_hdr) ooa_queue;
389 TAILQ_HEAD(ctl_blockq,ctl_io_hdr) blocked_queue;
390 STAILQ_ENTRY(ctl_lun) links;
391 STAILQ_ENTRY(ctl_lun) run_links;
393 uint32_t have_ca[CTL_MAX_INITIATORS >> 5];
394 struct scsi_sense_data pending_sense[CTL_MAX_INITIATORS];
396 ctl_ua_type pending_ua[CTL_MAX_INITIATORS];
397 struct ctl_mode_pages mode_pages;
398 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[262144];
406 struct ctl_devid *lun_devid;
407 TAILQ_HEAD(tpc_lists, tpc_list) tpc_lists;
411 CTL_FLAG_REAL_SYNC = 0x02,
412 CTL_FLAG_MASTER_SHELF = 0x04
415 #define CTL_MAX_THREADS 16
418 struct mtx_padalign queue_lock;
419 struct ctl_softc *ctl_softc;
420 struct thread *thread;
421 STAILQ_HEAD(, ctl_io_hdr) incoming_queue;
422 STAILQ_HEAD(, ctl_io_hdr) rtr_queue;
423 STAILQ_HEAD(, ctl_io_hdr) done_queue;
424 STAILQ_HEAD(, ctl_io_hdr) isc_queue;
432 struct ctl_id target;
437 int inquiry_pq_no_lun;
438 struct sysctl_ctx_list sysctl_ctx;
439 struct sysctl_oid *sysctl_tree;
440 struct ctl_ioctl_info ioctl_info;
441 struct ctl_io_pool *internal_pool;
442 struct ctl_io_pool *emergency_pool;
443 struct ctl_io_pool *othersc_pool;
444 struct proc *ctl_proc;
446 uint32_t ctl_lun_mask[(CTL_MAX_LUNS + 31) / 32];
447 struct ctl_lun *ctl_luns[CTL_MAX_LUNS];
448 uint32_t ctl_port_mask[(CTL_MAX_PORTS + 31) / 32];
449 uint64_t aps_locked_lun;
450 STAILQ_HEAD(, ctl_lun) lun_list;
451 STAILQ_HEAD(, ctl_be_lun) pending_lun_queue;
452 uint32_t num_frontends;
453 STAILQ_HEAD(, ctl_frontend) fe_list;
455 STAILQ_HEAD(, ctl_port) port_list;
456 struct ctl_port *ctl_ports[CTL_MAX_PORTS];
457 uint32_t num_backends;
458 STAILQ_HEAD(, ctl_backend_driver) be_list;
459 struct mtx pool_lock;
461 uint32_t cur_pool_id;
462 STAILQ_HEAD(, ctl_io_pool) io_pools;
463 time_t last_print_jiffies;
464 uint32_t skipped_prints;
465 struct ctl_thread threads[CTL_MAX_THREADS];
466 TAILQ_HEAD(tpc_tokens, tpc_token) tpc_tokens;
467 struct callout tpc_timeout;
472 extern const struct ctl_cmd_entry ctl_cmd_table[256];
474 uint32_t ctl_get_initindex(struct ctl_nexus *nexus);
475 uint32_t ctl_get_resindex(struct ctl_nexus *nexus);
476 uint32_t ctl_port_idx(int port_num);
477 int ctl_pool_create(struct ctl_softc *ctl_softc, ctl_pool_type pool_type,
478 uint32_t total_ctl_io, struct ctl_io_pool **npool);
479 void ctl_pool_free(struct ctl_io_pool *pool);
480 int ctl_scsi_release(struct ctl_scsiio *ctsio);
481 int ctl_scsi_reserve(struct ctl_scsiio *ctsio);
482 int ctl_start_stop(struct ctl_scsiio *ctsio);
483 int ctl_sync_cache(struct ctl_scsiio *ctsio);
484 int ctl_format(struct ctl_scsiio *ctsio);
485 int ctl_read_buffer(struct ctl_scsiio *ctsio);
486 int ctl_write_buffer(struct ctl_scsiio *ctsio);
487 int ctl_write_same(struct ctl_scsiio *ctsio);
488 int ctl_unmap(struct ctl_scsiio *ctsio);
489 int ctl_mode_select(struct ctl_scsiio *ctsio);
490 int ctl_mode_sense(struct ctl_scsiio *ctsio);
491 int ctl_read_capacity(struct ctl_scsiio *ctsio);
492 int ctl_read_capacity_16(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_persistent_reserve_in(struct ctl_scsiio *ctsio);
501 int ctl_persistent_reserve_out(struct ctl_scsiio *ctsio);
502 int ctl_report_tagret_port_groups(struct ctl_scsiio *ctsio);
503 int ctl_report_supported_opcodes(struct ctl_scsiio *ctsio);
504 int ctl_report_supported_tmf(struct ctl_scsiio *ctsio);
505 int ctl_report_timestamp(struct ctl_scsiio *ctsio);
506 int ctl_isc(struct ctl_scsiio *ctsio);
508 void ctl_tpc_init(struct ctl_softc *softc);
509 void ctl_tpc_shutdown(struct ctl_softc *softc);
510 void ctl_tpc_lun_init(struct ctl_lun *lun);
511 void ctl_tpc_lun_shutdown(struct ctl_lun *lun);
512 int ctl_inquiry_evpd_tpc(struct ctl_scsiio *ctsio, int alloc_len);
513 int ctl_receive_copy_status_lid1(struct ctl_scsiio *ctsio);
514 int ctl_receive_copy_failure_details(struct ctl_scsiio *ctsio);
515 int ctl_receive_copy_status_lid4(struct ctl_scsiio *ctsio);
516 int ctl_receive_copy_operating_parameters(struct ctl_scsiio *ctsio);
517 int ctl_extended_copy_lid1(struct ctl_scsiio *ctsio);
518 int ctl_extended_copy_lid4(struct ctl_scsiio *ctsio);
519 int ctl_copy_operation_abort(struct ctl_scsiio *ctsio);
520 int ctl_populate_token(struct ctl_scsiio *ctsio);
521 int ctl_write_using_token(struct ctl_scsiio *ctsio);
522 int ctl_receive_rod_token_information(struct ctl_scsiio *ctsio);
523 int ctl_report_all_rod_tokens(struct ctl_scsiio *ctsio);
527 #endif /* _CTL_PRIVATE_H_ */