xref: /freebsd/sys/cam/ctl/ctl_backend.h (revision ba00ec3d539f213abbda3a45ef8c539306cac098)
1 /*-
2  * Copyright (c) 2003 Silicon Graphics International Corp.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
16  *
17  * NO WARRANTY
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.
29  *
30  * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_backend.h#2 $
31  * $FreeBSD$
32  */
33 /*
34  * CTL backend driver definitions
35  *
36  * Author: Ken Merry <ken@FreeBSD.org>
37  */
38 
39 #ifndef	_CTL_BACKEND_H_
40 #define	_CTL_BACKEND_H_
41 
42 /*
43  * XXX KDM move this to another header file?
44  */
45 #define	CTL_BE_NAME_LEN		32
46 
47 /*
48  * The ID_REQ flag is used to say that the caller has requested a
49  * particular LUN ID in the req_lun_id field.  If we cannot allocate that
50  * LUN ID, the ctl_add_lun() call will fail.
51  *
52  * The POWERED_OFF flag tells us that the LUN should default to the powered
53  * off state.  It will return 0x04,0x02 until it is powered up.  ("Logical
54  * unit not ready, initializing command required.")
55  *
56  * The INOPERABLE flag tells us that this LUN is not operable for whatever
57  * reason.  This means that user data may have been (or has been?) lost.
58  * We will return 0x31,0x00 ("Medium format corrupted") until the host
59  * issues a FORMAT UNIT command to clear the error.
60  *
61  * The PRIMARY flag tells us that this LUN is registered as a Primary LUN
62  * which is accessible via the Master shelf controller in an HA. This flag
63  * being set indicates a Primary LUN. This flag being reset represents a
64  * Secondary LUN controlled by the Secondary controller in an HA
65  * configuration. Flag is applicable at this time to T_DIRECT types.
66  *
67  * The SERIAL_NUM flag tells us that the serial_num field is filled in and
68  * valid for use in SCSI INQUIRY VPD page 0x80.
69  *
70  * The DEVID flag tells us that the device_id field is filled in and
71  * valid for use in SCSI INQUIRY VPD page 0x83.
72  *
73  * The DEV_TYPE flag tells us that the device_type field is filled in.
74  */
75 typedef enum {
76 	CTL_LUN_FLAG_ID_REQ		= 0x01,
77 	CTL_LUN_FLAG_POWERED_OFF	= 0x02,
78 	CTL_LUN_FLAG_INOPERABLE		= 0x04,
79 	CTL_LUN_FLAG_PRIMARY		= 0x08,
80 	CTL_LUN_FLAG_SERIAL_NUM		= 0x10,
81 	CTL_LUN_FLAG_DEVID		= 0x20,
82 	CTL_LUN_FLAG_DEV_TYPE		= 0x40
83 } ctl_backend_lun_flags;
84 
85 #ifdef _KERNEL
86 
87 #define CTL_BACKEND_DECLARE(name, driver) \
88 	static int name ## _modevent(module_t mod, int type, void *data) \
89 	{ \
90 		switch (type) { \
91 		case MOD_LOAD: \
92 			ctl_backend_register( \
93 				(struct ctl_backend_driver *)data); \
94 			break; \
95 		case MOD_UNLOAD: \
96 			printf(#name " module unload - not possible for this module type\n"); \
97 			return EINVAL; \
98 		default: \
99 			return EOPNOTSUPP; \
100 		} \
101 		return 0; \
102 	} \
103 	static moduledata_t name ## _mod = { \
104 		#name, \
105 		name ## _modevent, \
106 		(void *)&driver \
107 	}; \
108 	DECLARE_MODULE(name, name ## _mod, SI_SUB_CONFIGURE, SI_ORDER_FOURTH); \
109 	MODULE_DEPEND(name, ctl, 1, 1, 1); \
110 	MODULE_DEPEND(name, cam, 1, 1, 1)
111 
112 
113 typedef enum {
114 	CTL_LUN_CONFIG_OK,
115 	CTL_LUN_CONFIG_FAILURE
116 } ctl_lun_config_status;
117 
118 typedef void (*be_callback_t)(void *be_lun);
119 typedef void (*be_lun_config_t)(void *be_lun,
120 				ctl_lun_config_status status);
121 
122 /*
123  * The lun_type field is the SCSI device type of this particular LUN.  In
124  * general, this should be T_DIRECT, although backends will want to create
125  * a processor LUN, typically at LUN 0.  See scsi_all.h for the defines for
126  * the various SCSI device types.
127  *
128  * The flags are described above.
129  *
130  * The be_lun field is the backend driver's own context that will get
131  * passsed back so that it can tell which LUN CTL is referencing.
132  *
133  * maxlba is the maximum accessible LBA on the LUN.  Note that this is
134  * different from the capacity of the array.  capacity = maxlba + 1
135  *
136  * blocksize is the size, in bytes, of each LBA on the LUN.  In general
137  * this should be 512.  In theory CTL should be able to handle other block
138  * sizes.  Host application software may not deal with it very well, though.
139  *
140  * req_lun_id is the requested LUN ID.  CTL only pays attention to this
141  * field if the CTL_LUN_FLAG_ID_REQ flag is set.  If the requested LUN ID is
142  * not available, the LUN addition will fail.  If a particular LUN ID isn't
143  * requested, the first available LUN ID will be allocated.
144  *
145  * serial_num is the device serial number returned in the SCSI INQUIRY VPD
146  * page 0x80.  This should be a unique, per-shelf value.  The data inside
147  * this field should be ASCII only, left aligned, and any unused space
148  * should be padded out with ASCII spaces.  This field should NOT be NULL
149  * terminated.
150  *
151  * device_id is the T10 device identifier returned in the SCSI INQUIRY VPD
152  * page 0x83.  This should be a unique, per-LUN value.  The data inside
153  * this field should be ASCII only, left aligned, and any unused space
154  * should be padded with ASCII spaces.  This field should NOT be NULL
155  * terminated.
156  *
157  * The lun_shutdown() method is the callback for the ctl_invalidate_lun()
158  * call.  It is called when all outstanding I/O for that LUN has been
159  * completed and CTL has deleted the resources for that LUN.  When the CTL
160  * backend gets this call, it can safely free its per-LUN resources.
161  *
162  * The lun_config_status() method is the callback for the ctl_add_lun()
163  * call.  It is called when the LUN is successfully added, or when LUN
164  * addition fails.  If the LUN is successfully added, the backend may call
165  * the ctl_enable_lun() method to enable the LUN.
166  *
167  * The be field is a pointer to the ctl_backend_driver structure, which
168  * contains the backend methods to be called by CTL.
169  *
170  * The ctl_lun field is for CTL internal use only, and should not be used
171  * by the backend.
172  *
173  * The links field is for CTL internal use only, and should not be used by
174  * the backend.
175  */
176 struct ctl_be_lun {
177 	uint8_t			lun_type;	/* passed to CTL */
178 	ctl_backend_lun_flags	flags;		/* passed to CTL */
179 	void			*be_lun;	/* passed to CTL */
180 	uint64_t		maxlba;		/* passed to CTL */
181 	uint32_t		blocksize;	/* passed to CTL */
182 	uint32_t		req_lun_id;	/* passed to CTL */
183 	uint32_t		lun_id;		/* returned from CTL */
184 	uint8_t			serial_num[CTL_SN_LEN];	 /* passed to CTL */
185 	uint8_t			device_id[CTL_DEVID_LEN];/* passed to CTL */
186 	be_callback_t		lun_shutdown;	/* passed to CTL */
187 	be_lun_config_t		lun_config_status; /* passed to CTL */
188 	struct ctl_backend_driver *be;		/* passed to CTL */
189 	void			*ctl_lun;	/* used by CTL */
190 	STAILQ_ENTRY(ctl_be_lun) links;		/* used by CTL */
191 };
192 
193 typedef enum {
194 	CTL_BE_FLAG_NONE	= 0x00,	/* no flags */
195 	CTL_BE_FLAG_HAS_CONFIG	= 0x01,	/* can do config reads, writes */
196 	CTL_BE_FLAG_INTERNAL	= 0x02	/* don't inc mod refcount */
197 } ctl_backend_flags;
198 
199 typedef int (*be_init_t)(void);
200 typedef int (*be_func_t)(union ctl_io *io);
201 typedef void (*be_vfunc_t)(union ctl_io *io);
202 typedef int (*be_ioctl_t)(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
203 			  struct thread *td);
204 typedef int (*be_luninfo_t)(void *be_lun, struct sbuf *sb);
205 
206 struct ctl_backend_driver {
207 	char		  name[CTL_BE_NAME_LEN]; /* passed to CTL */
208 	ctl_backend_flags flags;	         /* passed to CTL */
209 	be_init_t	  init;			 /* passed to CTL */
210 	be_func_t	  data_submit;		 /* passed to CTL */
211 	be_func_t	  data_move_done;	 /* passed to CTL */
212 	be_func_t	  config_read;		 /* passed to CTL */
213 	be_func_t	  config_write;		 /* passed to CTL */
214 	be_ioctl_t	  ioctl;		 /* passed to CTL */
215 	be_luninfo_t	  lun_info;		 /* passed to CTL */
216 #ifdef CS_BE_CONFIG_MOVE_DONE_IS_NOT_USED
217 	be_func_t	  config_move_done;	 /* passed to backend */
218 #endif
219 #if 0
220 	be_vfunc_t	  config_write_done;	 /* passed to backend */
221 #endif
222 	u_int		  num_luns;		 /* used by CTL */
223 	STAILQ_ENTRY(ctl_backend_driver) links;	 /* used by CTL */
224 };
225 
226 int ctl_backend_register(struct ctl_backend_driver *be);
227 int ctl_backend_deregister(struct ctl_backend_driver *be);
228 struct ctl_backend_driver *ctl_backend_find(char *backend_name);
229 
230 /*
231  * To add a LUN, first call ctl_add_lun().  You will get the lun_config_status()
232  * callback when the LUN addition has either succeeded or failed.
233  *
234  * Once you get that callback, you can then call ctl_enable_lun() to enable
235  * the LUN.
236  */
237 int ctl_add_lun(struct ctl_be_lun *be_lun);
238 int ctl_enable_lun(struct ctl_be_lun *be_lun);
239 
240 /*
241  * To delete a LUN, first call ctl_disable_lun(), then
242  * ctl_invalidate_lun().  You will get the lun_shutdown() callback when all
243  * I/O to the LUN has completed and the LUN has been deleted.
244  */
245 int ctl_disable_lun(struct ctl_be_lun *be_lun);
246 int ctl_invalidate_lun(struct ctl_be_lun *be_lun);
247 
248 /*
249  * To start a LUN (transition from powered off to powered on state) call
250  * ctl_start_lun().  To stop a LUN (transition from powered on to powered
251  * off state) call ctl_stop_lun().
252  */
253 int ctl_start_lun(struct ctl_be_lun *be_lun);
254 int ctl_stop_lun(struct ctl_be_lun *be_lun);
255 
256 /*
257  * If a LUN is inoperable, call ctl_lun_inoperable().  Generally the LUN
258  * will become operable once again when the user issues the SCSI FORMAT UNIT
259  * command.  (CTL will automatically clear the inoperable flag.)  If we
260  * need to re-enable the LUN, we can call ctl_lun_operable() to enable it
261  * without a SCSI command.
262  */
263 int ctl_lun_inoperable(struct ctl_be_lun *be_lun);
264 int ctl_lun_operable(struct ctl_be_lun *be_lun);
265 
266 /*
267  * If a LUN is locked on or unlocked from a power/APS standpoint, call
268  * ctl_lun_power_lock() to update the current status in CTL's APS subpage.
269  * Set the lock flag to 1 to lock the LUN, set it to 0 to unlock the LUN.
270  */
271 int ctl_lun_power_lock(struct ctl_be_lun *be_lun, struct ctl_nexus *nexus,
272 		       int lock);
273 
274 /*
275  * To take a LUN offline, call ctl_lun_offline().  Generally the LUN will
276  * be online again once the user sends a SCSI START STOP UNIT command with
277  * the start and on/offline bits set.  The backend can bring the LUN back
278  * online via the ctl_lun_online() function, if necessary.
279  */
280 int ctl_lun_offline(struct ctl_be_lun *be_lun);
281 int ctl_lun_online(struct ctl_be_lun *be_lun);
282 
283 /*
284  * Let the backend notify the initiator about changed capacity.
285  */
286 void ctl_lun_capacity_changed(struct ctl_be_lun *be_lun);
287 
288 #endif /* _KERNEL */
289 #endif /* _CTL_BACKEND_H_ */
290 
291 /*
292  * vim: ts=8
293  */
294