xref: /freebsd/sys/cam/ctl/ctl_private.h (revision efe3b0de1438e7a8473d92f2be57072394559e3c)
1 /*-
2  * Copyright (c) 2003, 2004, 2005, 2008 Silicon Graphics International Corp.
3  * Copyright (c) 2014-2017 Alexander Motin <mav@FreeBSD.org>
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
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.
17  *
18  * NO WARRANTY
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.
30  *
31  * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_private.h#7 $
32  * $FreeBSD$
33  */
34 /*
35  * CAM Target Layer driver private data structures/definitions.
36  *
37  * Author: Ken Merry <ken@FreeBSD.org>
38  */
39 
40 #ifndef	_CTL_PRIVATE_H_
41 #define	_CTL_PRIVATE_H_
42 
43 #include <cam/scsi/scsi_all.h>
44 #include <cam/scsi/scsi_cd.h>
45 #include <cam/scsi/scsi_da.h>
46 
47 /*
48  * SCSI vendor and product names.
49  */
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       "
55 
56 #define CTL_POOL_ENTRIES_OTHER_SC   200
57 
58 struct ctl_io_pool {
59 	char			name[64];
60 	uint32_t		id;
61 	struct ctl_softc	*ctl_softc;
62 	struct uma_zone		*zone;
63 };
64 
65 typedef enum {
66 	CTL_SER_BLOCK,
67 	CTL_SER_BLOCKOPT,
68 	CTL_SER_EXTENT,
69 	CTL_SER_EXTENTOPT,
70 	CTL_SER_EXTENTSEQ,
71 	CTL_SER_PASS,
72 	CTL_SER_SKIP
73 } ctl_serialize_action;
74 
75 typedef enum {
76 	CTL_ACTION_BLOCK,
77 	CTL_ACTION_OVERLAP,
78 	CTL_ACTION_OVERLAP_TAG,
79 	CTL_ACTION_PASS,
80 	CTL_ACTION_SKIP,
81 	CTL_ACTION_ERROR
82 } ctl_action;
83 
84 /*
85  * WARNING:  Keep the bottom nibble here free, we OR in the data direction
86  * flags for each command.
87  *
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
91  */
92 typedef enum {
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
108 } ctl_cmd_flags;
109 
110 typedef enum {
111 	CTL_SERIDX_TUR	= 0,
112 	CTL_SERIDX_READ,
113 	CTL_SERIDX_WRITE,
114 	CTL_SERIDX_UNMAP,
115 	CTL_SERIDX_SYNC,
116 	CTL_SERIDX_MD_SNS,
117 	CTL_SERIDX_MD_SEL,
118 	CTL_SERIDX_RQ_SNS,
119 	CTL_SERIDX_INQ,
120 	CTL_SERIDX_RD_CAP,
121 	CTL_SERIDX_RES,
122 	CTL_SERIDX_LOG_SNS,
123 	CTL_SERIDX_FORMAT,
124 	CTL_SERIDX_START,
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
128 } ctl_seridx;
129 
130 typedef int	ctl_opfunc(struct ctl_scsiio *ctsio);
131 
132 struct ctl_cmd_entry {
133 	ctl_opfunc		*execute;
134 	ctl_seridx		seridx;
135 	ctl_cmd_flags		flags;
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. */
140 };
141 
142 typedef enum {
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_READONLY	= 0x800,
155 	CTL_LUN_PEER_SC_PRIMARY	= 0x1000,
156 	CTL_LUN_REMOVABLE	= 0x2000
157 } ctl_lun_flags;
158 
159 typedef enum {
160 	CTLBLOCK_FLAG_NONE	= 0x00,
161 	CTLBLOCK_FLAG_INVALID	= 0x01
162 } ctlblock_flags;
163 
164 union ctl_softcs {
165 	struct ctl_softc	*ctl_softc;
166 	struct ctlblock_softc	*ctlblock_softc;
167 };
168 
169 /*
170  * Mode page defaults.
171  */
172 #if 0
173 /*
174  * These values make Solaris trim off some of the capacity.
175  */
176 #define	CTL_DEFAULT_SECTORS_PER_TRACK	63
177 #define	CTL_DEFAULT_HEADS		255
178 /*
179  * These values seem to work okay.
180  */
181 #define	CTL_DEFAULT_SECTORS_PER_TRACK	63
182 #define	CTL_DEFAULT_HEADS		16
183 /*
184  * These values work reasonably well.
185  */
186 #define	CTL_DEFAULT_SECTORS_PER_TRACK	512
187 #define	CTL_DEFAULT_HEADS		64
188 #endif
189 
190 /*
191  * Solaris is somewhat picky about how many heads and sectors per track you
192  * have defined in mode pages 3 and 4.  These values seem to cause Solaris
193  * to get the capacity more or less right when you run the format tool.
194  * They still have problems when dealing with devices larger than 1TB,
195  * but there isn't anything we can do about that.
196  *
197  * For smaller LUN sizes, this ends up causing the number of cylinders to
198  * work out to 0.  Solaris actually recognizes that and comes up with its
199  * own bogus geometry to fit the actual capacity of the drive.  They really
200  * should just give up on geometry and stick to the read capacity
201  * information alone for modern disk drives.
202  *
203  * One thing worth mentioning about Solaris' mkfs command is that it
204  * doesn't like sectors per track values larger than 256.  512 seems to
205  * work okay for format, but causes problems when you try to make a
206  * filesystem.
207  *
208  * Another caveat about these values:  the product of these two values
209  * really should be a power of 2.  This is because of the simplistic
210  * shift-based calculation that we have to use on the i386 platform to
211  * calculate the number of cylinders here.  (If you use a divide, you end
212  * up calling __udivdi3(), which is a hardware FP call on the PC.  On the
213  * XScale, it is done in software, so you can do that from inside the
214  * kernel.)
215  *
216  * So for the current values (256 S/T, 128 H), we get 32768, which works
217  * very nicely for calculating cylinders.
218  *
219  * If you want to change these values so that their product is no longer a
220  * power of 2, re-visit the calculation in ctl_init_page_index().  You may
221  * need to make it a bit more complicated to get the number of cylinders
222  * right.
223  */
224 #define	CTL_DEFAULT_SECTORS_PER_TRACK	256
225 #define	CTL_DEFAULT_HEADS		128
226 
227 #define	CTL_DEFAULT_ROTATION_RATE	SVPD_NON_ROTATING
228 
229 struct ctl_page_index;
230 
231 typedef int	ctl_modesen_handler(struct ctl_scsiio *ctsio,
232 				    struct ctl_page_index *page_index,
233 				    int pc);
234 typedef int	ctl_modesel_handler(struct ctl_scsiio *ctsio,
235 				    struct ctl_page_index *page_index,
236 				    uint8_t *page_ptr);
237 
238 typedef enum {
239 	CTL_PAGE_FLAG_NONE	 = 0x00,
240 	CTL_PAGE_FLAG_DIRECT	 = 0x01,
241 	CTL_PAGE_FLAG_PROC	 = 0x02,
242 	CTL_PAGE_FLAG_CDROM	 = 0x04,
243 	CTL_PAGE_FLAG_ALL	 = 0x07
244 } ctl_page_flags;
245 
246 struct ctl_page_index {
247 	uint8_t			page_code;
248 	uint8_t			subpage;
249 	uint16_t		page_len;
250 	uint8_t			*page_data;
251 	ctl_page_flags		page_flags;
252 	ctl_modesen_handler	*sense_handler;
253 	ctl_modesel_handler	*select_handler;
254 };
255 
256 #define	CTL_PAGE_CURRENT	0x00
257 #define	CTL_PAGE_CHANGEABLE	0x01
258 #define	CTL_PAGE_DEFAULT	0x02
259 #define	CTL_PAGE_SAVED		0x03
260 
261 #define CTL_NUM_LBP_PARAMS	4
262 #define CTL_NUM_LBP_THRESH	4
263 #define CTL_LBP_EXPONENT	11	/* 2048 sectors */
264 #define CTL_LBP_PERIOD		10	/* 10 seconds */
265 #define CTL_LBP_UA_PERIOD	300	/* 5 minutes */
266 
267 struct ctl_logical_block_provisioning_page {
268 	struct scsi_logical_block_provisioning_page	main;
269 	struct scsi_logical_block_provisioning_page_descr descr[CTL_NUM_LBP_THRESH];
270 };
271 
272 static const struct ctl_page_index page_index_template[] = {
273 	{SMS_RW_ERROR_RECOVERY_PAGE, 0, sizeof(struct scsi_da_rw_recovery_page), NULL,
274 	 CTL_PAGE_FLAG_DIRECT | CTL_PAGE_FLAG_CDROM, NULL, ctl_default_page_handler},
275 	{SMS_FORMAT_DEVICE_PAGE, 0, sizeof(struct scsi_format_page), NULL,
276 	 CTL_PAGE_FLAG_DIRECT, NULL, NULL},
277 	{SMS_RIGID_DISK_PAGE, 0, sizeof(struct scsi_rigid_disk_page), NULL,
278 	 CTL_PAGE_FLAG_DIRECT, NULL, NULL},
279 	{SMS_VERIFY_ERROR_RECOVERY_PAGE, 0, sizeof(struct scsi_da_verify_recovery_page), NULL,
280 	 CTL_PAGE_FLAG_DIRECT | CTL_PAGE_FLAG_CDROM, NULL, ctl_default_page_handler},
281 	{SMS_CACHING_PAGE, 0, sizeof(struct scsi_caching_page), NULL,
282 	 CTL_PAGE_FLAG_DIRECT | CTL_PAGE_FLAG_CDROM,
283 	 NULL, ctl_default_page_handler},
284 	{SMS_CONTROL_MODE_PAGE, 0, sizeof(struct scsi_control_page), NULL,
285 	 CTL_PAGE_FLAG_ALL, NULL, ctl_default_page_handler},
286 	{SMS_CONTROL_MODE_PAGE | SMPH_SPF, 0x01,
287 	 sizeof(struct scsi_control_ext_page), NULL,
288 	 CTL_PAGE_FLAG_ALL, NULL, ctl_default_page_handler},
289 	{SMS_INFO_EXCEPTIONS_PAGE, 0, sizeof(struct scsi_info_exceptions_page), NULL,
290 	 CTL_PAGE_FLAG_ALL, NULL, ctl_ie_page_handler},
291 	{SMS_INFO_EXCEPTIONS_PAGE | SMPH_SPF, 0x02,
292 	 sizeof(struct ctl_logical_block_provisioning_page), NULL,
293 	 CTL_PAGE_FLAG_DIRECT, NULL, ctl_default_page_handler},
294 	{SMS_CDDVD_CAPS_PAGE, 0,
295 	 sizeof(struct scsi_cddvd_capabilities_page), NULL,
296 	 CTL_PAGE_FLAG_CDROM, NULL, NULL},
297 };
298 
299 #define	CTL_NUM_MODE_PAGES sizeof(page_index_template)/   \
300 			   sizeof(page_index_template[0])
301 
302 struct ctl_mode_pages {
303 	struct scsi_da_rw_recovery_page	rw_er_page[4];
304 	struct scsi_format_page		format_page[4];
305 	struct scsi_rigid_disk_page	rigid_disk_page[4];
306 	struct scsi_da_verify_recovery_page	verify_er_page[4];
307 	struct scsi_caching_page	caching_page[4];
308 	struct scsi_control_page	control_page[4];
309 	struct scsi_control_ext_page	control_ext_page[4];
310 	struct scsi_info_exceptions_page ie_page[4];
311 	struct ctl_logical_block_provisioning_page lbp_page[4];
312 	struct scsi_cddvd_capabilities_page cddvd_page[4];
313 	struct ctl_page_index		index[CTL_NUM_MODE_PAGES];
314 };
315 
316 #define	MODE_RWER	mode_pages.rw_er_page[CTL_PAGE_CURRENT]
317 #define	MODE_FMT	mode_pages.format_page[CTL_PAGE_CURRENT]
318 #define	MODE_RDISK	mode_pages.rigid_disk_page[CTL_PAGE_CURRENT]
319 #define	MODE_VER	mode_pages.verify_er_page[CTL_PAGE_CURRENT]
320 #define	MODE_CACHING	mode_pages.caching_page[CTL_PAGE_CURRENT]
321 #define	MODE_CTRL	mode_pages.control_page[CTL_PAGE_CURRENT]
322 #define	MODE_CTRLE	mode_pages.control_ext_page[CTL_PAGE_CURRENT]
323 #define	MODE_IE		mode_pages.ie_page[CTL_PAGE_CURRENT]
324 #define	MODE_LBP	mode_pages.lbp_page[CTL_PAGE_CURRENT]
325 #define	MODE_CDDVD	mode_pages.cddvd_page[CTL_PAGE_CURRENT]
326 
327 static const struct ctl_page_index log_page_index_template[] = {
328 	{SLS_SUPPORTED_PAGES_PAGE, 0, 0, NULL,
329 	 CTL_PAGE_FLAG_ALL, NULL, NULL},
330 	{SLS_SUPPORTED_PAGES_PAGE, SLS_SUPPORTED_SUBPAGES_SUBPAGE, 0, NULL,
331 	 CTL_PAGE_FLAG_ALL, NULL, NULL},
332 	{SLS_LOGICAL_BLOCK_PROVISIONING, 0, 0, NULL,
333 	 CTL_PAGE_FLAG_DIRECT, ctl_lbp_log_sense_handler, NULL},
334 	{SLS_STAT_AND_PERF, 0, 0, NULL,
335 	 CTL_PAGE_FLAG_ALL, ctl_sap_log_sense_handler, NULL},
336 	{SLS_IE_PAGE, 0, 0, NULL,
337 	 CTL_PAGE_FLAG_ALL, ctl_ie_log_sense_handler, NULL},
338 };
339 
340 #define	CTL_NUM_LOG_PAGES sizeof(log_page_index_template)/   \
341 			  sizeof(log_page_index_template[0])
342 
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 stat_page {
348 		struct scsi_log_stat_and_perf sap;
349 		struct scsi_log_idle_time it;
350 		struct scsi_log_time_interval ti;
351 	} stat_page;
352 	struct scsi_log_informational_exceptions	ie_page;
353 	struct ctl_page_index		index[CTL_NUM_LOG_PAGES];
354 };
355 
356 struct ctl_lun_delay_info {
357 	ctl_delay_type		datamove_type;
358 	uint32_t		datamove_delay;
359 	ctl_delay_type		done_type;
360 	uint32_t		done_delay;
361 };
362 
363 #define CTL_PR_ALL_REGISTRANTS  0xFFFFFFFF
364 #define CTL_PR_NO_RESERVATION   0xFFFFFFF0
365 
366 struct ctl_devid {
367 	int		len;
368 	uint8_t		data[];
369 };
370 
371 #define NUM_HA_SHELVES		2
372 
373 #define CTL_WRITE_BUFFER_SIZE	262144
374 
375 struct tpc_list;
376 struct ctl_lun {
377 	struct mtx			lun_lock;
378 	uint64_t			lun;
379 	ctl_lun_flags			flags;
380 	STAILQ_HEAD(,ctl_error_desc)	error_list;
381 	uint64_t			error_serial;
382 	struct ctl_softc		*ctl_softc;
383 	struct ctl_be_lun		*be_lun;
384 	struct ctl_backend_driver	*backend;
385 	struct ctl_lun_delay_info	delay_info;
386 #ifdef CTL_TIME_IO
387 	sbintime_t			idle_time;
388 	sbintime_t			last_busy;
389 #endif
390 	TAILQ_HEAD(ctl_ooaq, ctl_io_hdr)  ooa_queue;
391 	TAILQ_HEAD(ctl_blockq,ctl_io_hdr) blocked_queue;
392 	STAILQ_ENTRY(ctl_lun)		links;
393 	struct scsi_sense_data		*pending_sense[CTL_MAX_PORTS];
394 	ctl_ua_type			*pending_ua[CTL_MAX_PORTS];
395 	uint8_t				ua_tpt_info[8];
396 	time_t				lasttpt;
397 	uint8_t				ie_asc;	/* Informational exceptions */
398 	uint8_t				ie_ascq;
399 	int				ie_reported;	/* Already reported */
400 	uint32_t			ie_reportcnt;	/* REPORT COUNT */
401 	struct callout			ie_callout;	/* INTERVAL TIMER */
402 	struct ctl_mode_pages		mode_pages;
403 	struct ctl_log_pages		log_pages;
404 #ifdef CTL_LEGACY_STATS
405 	struct ctl_lun_io_stats		legacy_stats;
406 #endif /* CTL_LEGACY_STATS */
407 	struct ctl_io_stats		stats;
408 	uint32_t			res_idx;
409 	uint32_t			pr_generation;
410 	uint64_t			*pr_keys[CTL_MAX_PORTS];
411 	int				pr_key_count;
412 	uint32_t			pr_res_idx;
413 	uint8_t				pr_res_type;
414 	int				prevent_count;
415 	uint32_t			*prevent;
416 	uint8_t				*write_buffer;
417 	struct ctl_devid		*lun_devid;
418 	TAILQ_HEAD(tpc_lists, tpc_list) tpc_lists;
419 };
420 
421 typedef enum {
422 	CTL_FLAG_ACTIVE_SHELF	= 0x04
423 } ctl_gen_flags;
424 
425 #define CTL_MAX_THREADS		16
426 
427 struct ctl_thread {
428 	struct mtx_padalign queue_lock;
429 	struct ctl_softc	*ctl_softc;
430 	struct thread		*thread;
431 	STAILQ_HEAD(, ctl_io_hdr) incoming_queue;
432 	STAILQ_HEAD(, ctl_io_hdr) rtr_queue;
433 	STAILQ_HEAD(, ctl_io_hdr) done_queue;
434 	STAILQ_HEAD(, ctl_io_hdr) isc_queue;
435 };
436 
437 struct tpc_token;
438 struct ctl_softc {
439 	struct mtx		ctl_lock;
440 	struct cdev		*dev;
441 	int			num_luns;
442 	ctl_gen_flags		flags;
443 	ctl_ha_mode		ha_mode;
444 	int			ha_id;
445 	int			is_single;
446 	ctl_ha_link_state	ha_link;
447 	int			port_min;
448 	int			port_max;
449 	int			port_cnt;
450 	int			init_min;
451 	int			init_max;
452 	struct sysctl_ctx_list	sysctl_ctx;
453 	struct sysctl_oid	*sysctl_tree;
454 	void			*othersc_pool;
455 	struct proc		*ctl_proc;
456 	uint32_t		ctl_lun_mask[(CTL_MAX_LUNS + 31) / 32];
457 	struct ctl_lun		*ctl_luns[CTL_MAX_LUNS];
458 	uint32_t		ctl_port_mask[(CTL_MAX_PORTS + 31) / 32];
459 	STAILQ_HEAD(, ctl_lun)	lun_list;
460 	STAILQ_HEAD(, ctl_be_lun)	pending_lun_queue;
461 	uint32_t		num_frontends;
462 	STAILQ_HEAD(, ctl_frontend)	fe_list;
463 	uint32_t		num_ports;
464 	STAILQ_HEAD(, ctl_port)	port_list;
465 	struct ctl_port		*ctl_ports[CTL_MAX_PORTS];
466 	uint32_t		num_backends;
467 	STAILQ_HEAD(, ctl_backend_driver)	be_list;
468 	struct uma_zone		*io_zone;
469 	uint32_t		cur_pool_id;
470 	int			shutdown;
471 	struct ctl_thread	threads[CTL_MAX_THREADS];
472 	struct thread		*lun_thread;
473 	struct thread		*thresh_thread;
474 	TAILQ_HEAD(tpc_tokens, tpc_token)	tpc_tokens;
475 	struct callout		tpc_timeout;
476 	struct mtx		tpc_lock;
477 };
478 
479 #ifdef _KERNEL
480 
481 extern const struct ctl_cmd_entry ctl_cmd_table[256];
482 
483 uint32_t ctl_get_initindex(struct ctl_nexus *nexus);
484 int ctl_lun_map_init(struct ctl_port *port);
485 int ctl_lun_map_deinit(struct ctl_port *port);
486 int ctl_lun_map_set(struct ctl_port *port, uint32_t plun, uint32_t glun);
487 int ctl_lun_map_unset(struct ctl_port *port, uint32_t plun);
488 uint32_t ctl_lun_map_from_port(struct ctl_port *port, uint32_t plun);
489 uint32_t ctl_lun_map_to_port(struct ctl_port *port, uint32_t glun);
490 int ctl_pool_create(struct ctl_softc *ctl_softc, const char *pool_name,
491 		    uint32_t total_ctl_io, void **npool);
492 void ctl_pool_free(struct ctl_io_pool *pool);
493 int ctl_scsi_release(struct ctl_scsiio *ctsio);
494 int ctl_scsi_reserve(struct ctl_scsiio *ctsio);
495 int ctl_start_stop(struct ctl_scsiio *ctsio);
496 int ctl_prevent_allow(struct ctl_scsiio *ctsio);
497 int ctl_sync_cache(struct ctl_scsiio *ctsio);
498 int ctl_format(struct ctl_scsiio *ctsio);
499 int ctl_read_buffer(struct ctl_scsiio *ctsio);
500 int ctl_write_buffer(struct ctl_scsiio *ctsio);
501 int ctl_write_same(struct ctl_scsiio *ctsio);
502 int ctl_unmap(struct ctl_scsiio *ctsio);
503 int ctl_mode_select(struct ctl_scsiio *ctsio);
504 int ctl_mode_sense(struct ctl_scsiio *ctsio);
505 int ctl_log_sense(struct ctl_scsiio *ctsio);
506 int ctl_read_capacity(struct ctl_scsiio *ctsio);
507 int ctl_read_capacity_16(struct ctl_scsiio *ctsio);
508 int ctl_read_defect(struct ctl_scsiio *ctsio);
509 int ctl_read_toc(struct ctl_scsiio *ctsio);
510 int ctl_read_write(struct ctl_scsiio *ctsio);
511 int ctl_cnw(struct ctl_scsiio *ctsio);
512 int ctl_report_luns(struct ctl_scsiio *ctsio);
513 int ctl_request_sense(struct ctl_scsiio *ctsio);
514 int ctl_tur(struct ctl_scsiio *ctsio);
515 int ctl_verify(struct ctl_scsiio *ctsio);
516 int ctl_inquiry(struct ctl_scsiio *ctsio);
517 int ctl_get_config(struct ctl_scsiio *ctsio);
518 int ctl_get_event_status(struct ctl_scsiio *ctsio);
519 int ctl_mechanism_status(struct ctl_scsiio *ctsio);
520 int ctl_persistent_reserve_in(struct ctl_scsiio *ctsio);
521 int ctl_persistent_reserve_out(struct ctl_scsiio *ctsio);
522 int ctl_report_tagret_port_groups(struct ctl_scsiio *ctsio);
523 int ctl_report_supported_opcodes(struct ctl_scsiio *ctsio);
524 int ctl_report_supported_tmf(struct ctl_scsiio *ctsio);
525 int ctl_report_timestamp(struct ctl_scsiio *ctsio);
526 int ctl_get_lba_status(struct ctl_scsiio *ctsio);
527 
528 void ctl_tpc_init(struct ctl_softc *softc);
529 void ctl_tpc_shutdown(struct ctl_softc *softc);
530 void ctl_tpc_lun_init(struct ctl_lun *lun);
531 void ctl_tpc_lun_clear(struct ctl_lun *lun, uint32_t initidx);
532 void ctl_tpc_lun_shutdown(struct ctl_lun *lun);
533 int ctl_inquiry_evpd_tpc(struct ctl_scsiio *ctsio, int alloc_len);
534 int ctl_receive_copy_status_lid1(struct ctl_scsiio *ctsio);
535 int ctl_receive_copy_failure_details(struct ctl_scsiio *ctsio);
536 int ctl_receive_copy_status_lid4(struct ctl_scsiio *ctsio);
537 int ctl_receive_copy_operating_parameters(struct ctl_scsiio *ctsio);
538 int ctl_extended_copy_lid1(struct ctl_scsiio *ctsio);
539 int ctl_extended_copy_lid4(struct ctl_scsiio *ctsio);
540 int ctl_copy_operation_abort(struct ctl_scsiio *ctsio);
541 int ctl_populate_token(struct ctl_scsiio *ctsio);
542 int ctl_write_using_token(struct ctl_scsiio *ctsio);
543 int ctl_receive_rod_token_information(struct ctl_scsiio *ctsio);
544 int ctl_report_all_rod_tokens(struct ctl_scsiio *ctsio);
545 
546 #endif	/* _KERNEL */
547 
548 #endif	/* _CTL_PRIVATE_H_ */
549 
550 /*
551  * vim: ts=8
552  */
553