ctl_backend.h revision 273311
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: stable/10/sys/cam/ctl/ctl_backend.h 273311 2014-10-20 07:33:41Z mav $ 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 * The UNMAP flag tells us that this LUN supports UNMAP. 76 */ 77typedef enum { 78 CTL_LUN_FLAG_ID_REQ = 0x01, 79 CTL_LUN_FLAG_POWERED_OFF = 0x02, 80 CTL_LUN_FLAG_INOPERABLE = 0x04, 81 CTL_LUN_FLAG_PRIMARY = 0x08, 82 CTL_LUN_FLAG_SERIAL_NUM = 0x10, 83 CTL_LUN_FLAG_DEVID = 0x20, 84 CTL_LUN_FLAG_DEV_TYPE = 0x40, 85 CTL_LUN_FLAG_UNMAP = 0x80 86} ctl_backend_lun_flags; 87 88#ifdef _KERNEL 89 90#define CTL_BACKEND_DECLARE(name, driver) \ 91 static int name ## _modevent(module_t mod, int type, void *data) \ 92 { \ 93 switch (type) { \ 94 case MOD_LOAD: \ 95 ctl_backend_register( \ 96 (struct ctl_backend_driver *)data); \ 97 break; \ 98 case MOD_UNLOAD: \ 99 printf(#name " module unload - not possible for this module type\n"); \ 100 return EINVAL; \ 101 default: \ 102 return EOPNOTSUPP; \ 103 } \ 104 return 0; \ 105 } \ 106 static moduledata_t name ## _mod = { \ 107 #name, \ 108 name ## _modevent, \ 109 (void *)&driver \ 110 }; \ 111 DECLARE_MODULE(name, name ## _mod, SI_SUB_CONFIGURE, SI_ORDER_FOURTH); \ 112 MODULE_DEPEND(name, ctl, 1, 1, 1); \ 113 MODULE_DEPEND(name, cam, 1, 1, 1) 114 115 116typedef enum { 117 CTL_LUN_CONFIG_OK, 118 CTL_LUN_CONFIG_FAILURE 119} ctl_lun_config_status; 120 121typedef void (*be_callback_t)(void *be_lun); 122typedef void (*be_lun_config_t)(void *be_lun, 123 ctl_lun_config_status status); 124 125/* 126 * The lun_type field is the SCSI device type of this particular LUN. In 127 * general, this should be T_DIRECT, although backends will want to create 128 * a processor LUN, typically at LUN 0. See scsi_all.h for the defines for 129 * the various SCSI device types. 130 * 131 * The flags are described above. 132 * 133 * The be_lun field is the backend driver's own context that will get 134 * passsed back so that it can tell which LUN CTL is referencing. 135 * 136 * maxlba is the maximum accessible LBA on the LUN. Note that this is 137 * different from the capacity of the array. capacity = maxlba + 1 138 * 139 * blocksize is the size, in bytes, of each LBA on the LUN. In general 140 * this should be 512. In theory CTL should be able to handle other block 141 * sizes. Host application software may not deal with it very well, though. 142 * 143 * pblockexp is the log2() of number of LBAs on the LUN per physical sector. 144 * 145 * pblockoff is the lowest LBA on the LUN aligned ot physical sector. 146 * 147 * atomicblock is the number of blocks that can be written atomically. 148 * 149 * req_lun_id is the requested LUN ID. CTL only pays attention to this 150 * field if the CTL_LUN_FLAG_ID_REQ flag is set. If the requested LUN ID is 151 * not available, the LUN addition will fail. If a particular LUN ID isn't 152 * requested, the first available LUN ID will be allocated. 153 * 154 * serial_num is the device serial number returned in the SCSI INQUIRY VPD 155 * page 0x80. This should be a unique, per-shelf value. The data inside 156 * this field should be ASCII only, left aligned, and any unused space 157 * should be padded out with ASCII spaces. This field should NOT be NULL 158 * terminated. 159 * 160 * device_id is the T10 device identifier returned in the SCSI INQUIRY VPD 161 * page 0x83. This should be a unique, per-LUN value. The data inside 162 * this field should be ASCII only, left aligned, and any unused space 163 * should be padded with ASCII spaces. This field should NOT be NULL 164 * terminated. 165 * 166 * The lun_shutdown() method is the callback for the ctl_invalidate_lun() 167 * call. It is called when all outstanding I/O for that LUN has been 168 * completed and CTL has deleted the resources for that LUN. When the CTL 169 * backend gets this call, it can safely free its per-LUN resources. 170 * 171 * The lun_config_status() method is the callback for the ctl_add_lun() 172 * call. It is called when the LUN is successfully added, or when LUN 173 * addition fails. If the LUN is successfully added, the backend may call 174 * the ctl_enable_lun() method to enable the LUN. 175 * 176 * The be field is a pointer to the ctl_backend_driver structure, which 177 * contains the backend methods to be called by CTL. 178 * 179 * The ctl_lun field is for CTL internal use only, and should not be used 180 * by the backend. 181 * 182 * The links field is for CTL internal use only, and should not be used by 183 * the backend. 184 */ 185struct ctl_be_lun { 186 uint8_t lun_type; /* passed to CTL */ 187 ctl_backend_lun_flags flags; /* passed to CTL */ 188 void *be_lun; /* passed to CTL */ 189 uint64_t maxlba; /* passed to CTL */ 190 uint32_t blocksize; /* passed to CTL */ 191 uint16_t pblockexp; /* passed to CTL */ 192 uint16_t pblockoff; /* passed to CTL */ 193 uint32_t atomicblock; /* passed to CTL */ 194 uint32_t req_lun_id; /* passed to CTL */ 195 uint32_t lun_id; /* returned from CTL */ 196 uint8_t serial_num[CTL_SN_LEN]; /* passed to CTL */ 197 uint8_t device_id[CTL_DEVID_LEN];/* passed to CTL */ 198 be_callback_t lun_shutdown; /* passed to CTL */ 199 be_lun_config_t lun_config_status; /* passed to CTL */ 200 struct ctl_backend_driver *be; /* passed to CTL */ 201 void *ctl_lun; /* used by CTL */ 202 ctl_options_t options; /* passed to CTL */ 203 STAILQ_ENTRY(ctl_be_lun) links; /* used by CTL */ 204}; 205 206typedef enum { 207 CTL_BE_FLAG_NONE = 0x00, /* no flags */ 208 CTL_BE_FLAG_HAS_CONFIG = 0x01, /* can do config reads, writes */ 209 CTL_BE_FLAG_INTERNAL = 0x02 /* don't inc mod refcount */ 210} ctl_backend_flags; 211 212typedef int (*be_init_t)(void); 213typedef int (*be_func_t)(union ctl_io *io); 214typedef void (*be_vfunc_t)(union ctl_io *io); 215typedef int (*be_ioctl_t)(struct cdev *dev, u_long cmd, caddr_t addr, int flag, 216 struct thread *td); 217typedef int (*be_luninfo_t)(void *be_lun, struct sbuf *sb); 218 219struct ctl_backend_driver { 220 char name[CTL_BE_NAME_LEN]; /* passed to CTL */ 221 ctl_backend_flags flags; /* passed to CTL */ 222 be_init_t init; /* passed to CTL */ 223 be_func_t data_submit; /* passed to CTL */ 224 be_func_t data_move_done; /* passed to CTL */ 225 be_func_t config_read; /* passed to CTL */ 226 be_func_t config_write; /* passed to CTL */ 227 be_ioctl_t ioctl; /* passed to CTL */ 228 be_luninfo_t lun_info; /* passed to CTL */ 229#ifdef CS_BE_CONFIG_MOVE_DONE_IS_NOT_USED 230 be_func_t config_move_done; /* passed to backend */ 231#endif 232#if 0 233 be_vfunc_t config_write_done; /* passed to backend */ 234#endif 235 u_int num_luns; /* used by CTL */ 236 STAILQ_ENTRY(ctl_backend_driver) links; /* used by CTL */ 237}; 238 239int ctl_backend_register(struct ctl_backend_driver *be); 240int ctl_backend_deregister(struct ctl_backend_driver *be); 241struct ctl_backend_driver *ctl_backend_find(char *backend_name); 242 243/* 244 * To add a LUN, first call ctl_add_lun(). You will get the lun_config_status() 245 * callback when the LUN addition has either succeeded or failed. 246 * 247 * Once you get that callback, you can then call ctl_enable_lun() to enable 248 * the LUN. 249 */ 250int ctl_add_lun(struct ctl_be_lun *be_lun); 251int ctl_enable_lun(struct ctl_be_lun *be_lun); 252 253/* 254 * To delete a LUN, first call ctl_disable_lun(), then 255 * ctl_invalidate_lun(). You will get the lun_shutdown() callback when all 256 * I/O to the LUN has completed and the LUN has been deleted. 257 */ 258int ctl_disable_lun(struct ctl_be_lun *be_lun); 259int ctl_invalidate_lun(struct ctl_be_lun *be_lun); 260 261/* 262 * To start a LUN (transition from powered off to powered on state) call 263 * ctl_start_lun(). To stop a LUN (transition from powered on to powered 264 * off state) call ctl_stop_lun(). 265 */ 266int ctl_start_lun(struct ctl_be_lun *be_lun); 267int ctl_stop_lun(struct ctl_be_lun *be_lun); 268 269/* 270 * If a LUN is inoperable, call ctl_lun_inoperable(). Generally the LUN 271 * will become operable once again when the user issues the SCSI FORMAT UNIT 272 * command. (CTL will automatically clear the inoperable flag.) If we 273 * need to re-enable the LUN, we can call ctl_lun_operable() to enable it 274 * without a SCSI command. 275 */ 276int ctl_lun_inoperable(struct ctl_be_lun *be_lun); 277int ctl_lun_operable(struct ctl_be_lun *be_lun); 278 279/* 280 * If a LUN is locked on or unlocked from a power/APS standpoint, call 281 * ctl_lun_power_lock() to update the current status in CTL's APS subpage. 282 * Set the lock flag to 1 to lock the LUN, set it to 0 to unlock the LUN. 283 */ 284int ctl_lun_power_lock(struct ctl_be_lun *be_lun, struct ctl_nexus *nexus, 285 int lock); 286 287/* 288 * To take a LUN offline, call ctl_lun_offline(). Generally the LUN will 289 * be online again once the user sends a SCSI START STOP UNIT command with 290 * the start and on/offline bits set. The backend can bring the LUN back 291 * online via the ctl_lun_online() function, if necessary. 292 */ 293int ctl_lun_offline(struct ctl_be_lun *be_lun); 294int ctl_lun_online(struct ctl_be_lun *be_lun); 295 296/* 297 * Let the backend notify the initiator about changed capacity. 298 */ 299void ctl_lun_capacity_changed(struct ctl_be_lun *be_lun); 300 301#endif /* _KERNEL */ 302#endif /* _CTL_BACKEND_H_ */ 303 304/* 305 * vim: ts=8 306 */ 307