1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 * 21 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 22 * Use is subject to license terms. 23 */ 24 25 #ifndef _SYS_USB_SCSA2USB_H 26 #define _SYS_USB_SCSA2USB_H 27 28 29 #ifdef __cplusplus 30 extern "C" { 31 #endif 32 33 #include <sys/usb/usba/usbai_private.h> 34 35 /* 36 * SCSA2USB: This header file contains the internal structures 37 * and variable definitions used in USB mass storage disk driver. 38 */ 39 40 41 #define SCSA2USB_INITIAL_ALLOC 4 /* initial soft space alloc */ 42 43 #define MAX_COMPAT_NAMES 1 /* max compatible names for children */ 44 #define SERIAL_NUM_LEN 64 /* for reading string descriptor */ 45 #define SCSA2USB_SERIAL_LEN 12 /* len of serial no in scsi_inquiry */ 46 47 #define SCSA2USB_MAX_LUNS 0x10 /* maximum luns supported. */ 48 49 /* 50 * limit the max transfer size to under <= 64K. Some devices 51 * have problems with large transfers 52 */ 53 #define SCSA2USB_MAX_BULK_XFER_SIZE (64 * 1024) 54 55 /* Blacklist some vendors whose devices could cause problems */ 56 #define MS_HAGIWARA_SYS_COM_VID 0x693 /* VendorId of Hagiwara Sys-Com */ 57 #define MS_HAGIWARA_SYSCOM_PID1 0x1 /* PID for SmartMedia(SM) device */ 58 #define MS_HAGIWARA_SYSCOM_PID2 0x3 /* PID for CompactFlash(CF) device */ 59 #define MS_HAGIWARA_SYSCOM_PID3 0x5 /* PID for SM/CF Combo device */ 60 #define MS_HAGIWARA_SYSCOM_PID4 0x2 /* PID for new SM device */ 61 #define MS_HAGIWARA_SYSCOM_PID5 0x4 /* PID for new CF device */ 62 63 #define MS_IOMEGA_VID 0x59b /* VendorId of Iomega */ 64 #define MS_IOMEGA_PID1_ZIP100 0x1 /* PID of an Older Iomega Zip100 */ 65 #define MS_IOMEGA_PID2_ZIP100 0x2 /* PID of Newer Iomega Zip100 */ 66 #define MS_IOMEGA_PID3_ZIP100 0x31 /* PID of Newer Iomega Zip100 */ 67 #define MS_IOMEGA_PID_ZIP250 0x30 /* PID of Newer Iomega Zip250 */ 68 #define MS_IOMEGA_PID_CLIK 0x60 /* PID of Iomega Clik! drive */ 69 70 #define MS_MITSUMI_VID 0x3ee /* VendorId of Mitsumi Inc */ 71 #define MS_MITSUMI_DEVICE_242 0x242 /* bcdDevice of Mitsumi CR-4804TU */ 72 #define MS_MITSUMI_DEVICE_24 0x24 /* bcdDevice of Mitsumi CR-4802TU */ 73 74 #define MS_YEDATA_VID 0x57b /* VendorId of Y-E Data Corp */ 75 #define MS_SMSC_VID 0x424 /* Vendor Id of SMSC */ 76 #define MS_SMSC_PID0 0xfdc /* floppy from SMSC */ 77 78 #define MS_NEODIO_VID 0xaec /* Neodio Technologies Corporation */ 79 #define MS_NEODIO_DEVICE_3050 0x3050 /* PID of ND3050/Soyo BayOne */ 80 /* SM/CF/MS/SD */ 81 #define MS_SONY_FLASH_VID 0x54c /* sony flash device */ 82 #define MS_SONY_FLASH_PID 0x8b 83 84 #define MS_TREK_FLASH_VID 0xa16 /* Trek flash device */ 85 #define MS_TREK_FLASH_PID 0x9988 86 87 #define MS_PENN_FLASH_VID 0xd7d /* Penn flash device */ 88 #define MS_PENN_FLASH_PID 0x1320 89 90 #define MS_SIMPLETECH_VID 0x7c4 /* VendorId of Simpltech */ 91 #define MS_SIMPLETECH_PID1 0xa400 /* PID for UCF-100 device */ 92 93 #define MS_ADDONICS_CARD_READER_VID 0x7cc /* addonics */ 94 #define MS_ADDONICS_CARD_READER_PID 0x320 95 96 #define MS_ACOMDATA_VID 0xc0b /* VendorId of DMI (Acomdata) */ 97 #define MS_ACOMDATA_PID1 0x5fab /* PID for 80GB USB/1394 disk */ 98 99 #define MS_OTI_VID 0xea0 /* VendorID of OTI */ 100 #define MS_OTI_DEVICE_6828 0x6828 /* PID for 6828 flash disk */ 101 102 #define MS_SCANLOGIC_VID 0x04ce /* VendorID of ScanLogic */ 103 #define MS_SCANLOGIC_PID1 0x0002 /* SL USB Storage Device */ 104 105 #define MS_SUPERTOP_VID 0x14cd /* Super Top USB 2.0 IDE enclosure */ 106 #define MS_SUPERTOP_DEVICE_6600 0x6600 107 108 #define MS_AIGO_VID 0xed1 /* VendorID of Aigo */ 109 #define MS_AIGO_DEVICE_6981 0x6981 /* Aigo Miniking Device NEHFSP14 */ 110 111 #define MS_ALCOR_VID 0x58f /* Vendor ID of Alcor Micro Corp */ 112 #define MS_ALCOR_PID0 0x6387 /* PID for 6387 flash disk */ 113 114 /* 115 * The AMI virtual floppy device is not a real USB storage device, but 116 * emulated by the SP firmware shipped together with important Sun x86 117 * products such as Galaxy and Thumper platforms. The device causes 118 * very long delay in boot process of these platforms which is a big 119 * performance issue. Improvement in firmware may solve the issue, but 120 * before the firmware is fixed, it needs to be taken care of by software 121 * to avoid the huge impact on user experience. 122 * 123 * The long boot delay is caused by timeouts and retries of READ CAPACITY 124 * command issued to the device. The device is a USB ufi subclass device 125 * using CBI protocol. When READ CAPACITY command is issued, the device 126 * returns STALL on the bulk endpoint during the data stage, however, it 127 * doesn't return status on the intr pipe during status stage, so the intr 128 * pipe can only fail with timeout. 129 * 130 * Reducing timeout value to 1 second can help a little bit, but the delay 131 * is still noticeable, because the target driver would make many retries 132 * for this command. It is not desirable to mess with the target driver 133 * for a broken USB device. So adding the device to the scsa2usb blacklist 134 * is the best choice we have. 135 * 136 * It is found that the READ CAPACITY failure only happens when there is 137 * no media in the floppy drive. When there is a media, the device works 138 * just fine. So READ CAPACITY command cannot be arbitrarily disabled. 139 * Media status needs to be checked before issuing the command by sending 140 * an additional TEST UNIT READY command. If TEST UNIT READY command 141 * return STATUS_GOOD, it means the media is ready and then READ CAPACITY 142 * can be issued. 143 * 144 * SCSA2USB_ATTRS_NO_MEDIA_CHECK is added below for this purpose. It is 145 * overrided in scsa2usb.c for the AMI virtual floppy device to take care 146 * of the special need. 147 */ 148 #define MS_AMI_VID 0x46b /* VendorId of AMI */ 149 #define MS_AMI_VIRTUAL_FLOPPY 0xff40 /* PID for AMI virtual floppy */ 150 151 /* 152 * List the attributes that need special case in the driver 153 * SCSA2USB_ATTRS_GET_LUN: Bulk Only Transport Get_Max_Lun class specific 154 * command is not implemented by these devices 155 * SCSA2USB_ATTRS_PM: Some devices don't like being power managed. 156 * SCSA2USB_ATTRS_START_STOP: Some devices don't do anything with 157 * SCMD_START_STOP opcode (for e.g. SmartMedia/CompactFlash/ 158 * Clik!/MemoryStick/MMC USB readers/writers. 159 * SCSA2USB_ATTRS_GET_CONF: SCMD_GET_CONFIGURATION is not supported 160 * SCMD_TEST_UNIT_READY: for floppies this needs to be converted to 161 * SCMD_START_STOP as floppies don't support this 162 * SCSA2USB_ATTRS_GET_PERF: SCMD_GET_PERFORMANCE not supported by 163 * Mitsumi's CD-RW devices. 164 * SCSA2USB_ATTRS_BIG_TIMEOUT: Mitsumi's CD-RW devices need large 165 * timeout with SCMD_START_STOP cmd 166 * SCSA2USB_ATTRS_RMB: Pay attention to the device's RMB setting, 167 * instead of automatically treating it as removable 168 * SCSA2USB_ATTRS_USE_CSW_RESIDUE: Some devices report false residue in 169 * the CSW of bulk-only transfer status stage though data 170 * was successfully transfered, so need to ignore residue. 171 * SCSA2USB_ATTRS_NO_MEDIA_CHECK: AMI Virtual Floppy devices need to 172 * check if media is ready before issuing READ CAPACITY. 173 * SCSA2USB_ATTRS_NO_CAP_ADJUST: Some devices return total logical block number 174 * instead of highest logical block address on READ_CAPACITY cmd. 175 * 176 * NOTE: If a device simply STALLs the GET_MAX_LUN BO class-specific command 177 * and recovers then it will not be added to the scsa2usb_blacklist[] table 178 * in scsa2usb.c. The other attributes will not be taken of the table unless 179 * their inclusion causes a recovery and retries (thus seriously affecting 180 * the driver performance). 181 */ 182 #define SCSA2USB_ATTRS_GET_LUN 0x01 /* GET_MAX_LUN (Bulk Only) */ 183 #define SCSA2USB_ATTRS_PM 0x02 /* Some don't support PM */ 184 #define SCSA2USB_ATTRS_START_STOP 0x04 /* SCMD_START_STOP */ 185 #define SCSA2USB_ATTRS_GET_CONF 0x08 /* SCMD_GET_CONFIGURATION */ 186 #define SCSA2USB_ATTRS_GET_PERF 0x10 /* SCMD_GET_PERFORMANCE */ 187 #define SCSA2USB_ATTRS_BIG_TIMEOUT 0x40 /* for SCMD_START_STOP */ 188 #define SCSA2USB_ATTRS_DOORLOCK 0x80 /* for SCMD_DOORLOCK */ 189 #define SCSA2USB_ATTRS_RMB 0x100 /* Pay attention to RMB */ 190 #define SCSA2USB_ATTRS_MODE_SENSE 0x200 /* SCMD_MODE_SENSE */ 191 #define SCSA2USB_ATTRS_INQUIRY 0x400 /* SCMD_INQUIRY */ 192 #define SCSA2USB_ATTRS_USE_CSW_RESIDUE 0x800 /* for residue checking */ 193 #define SCSA2USB_ATTRS_NO_MEDIA_CHECK 0x1000 /* for media checking */ 194 #define SCSA2USB_ATTRS_NO_CAP_ADJUST 0x2000 /* for CAPACITY adjusting */ 195 #define SCSA2USB_ATTRS_REDUCED_CMD \ 196 (SCSA2USB_ATTRS_DOORLOCK|SCSA2USB_ATTRS_MODE_SENSE| \ 197 SCSA2USB_ATTRS_START_STOP|SCSA2USB_ATTRS_INQUIRY| \ 198 SCSA2USB_ATTRS_USE_CSW_RESIDUE) 199 200 #define SCSA2USB_ALL_ATTRS 0xFFFF /* All of the above */ 201 202 /* max inquiry length */ 203 #define SCSA2USB_MAX_INQ_LEN (offsetof(struct scsi_inquiry, inq_serial)) 204 205 /* page code of scsi mode page */ 206 #ifndef SD_MODE_SENSE_PAGE3_CODE 207 #define SD_MODE_SENSE_PAGE3_CODE 0x03 208 #endif 209 210 #ifndef SD_MODE_SENSE_PAGE4_CODE 211 #define SD_MODE_SENSE_PAGE4_CODE 0x04 212 #endif 213 214 /* 215 * PM support 216 */ 217 typedef struct scsa2usb_power { 218 /* device busy accounting */ 219 int scsa2usb_pm_busy; 220 /* this is the bit mask of the power states that device has */ 221 uint8_t scsa2usb_pwr_states; 222 223 uint8_t scsa2usb_wakeup_enabled; 224 225 /* current power level the device is in */ 226 uint8_t scsa2usb_current_power; 227 } scsa2usb_power_t; 228 229 /* 230 * CPR support: 231 * keep track of the last command issued to the drive. If it 232 * was TUR or EJECT then allow issuing a CPR suspend. 233 */ 234 #define LOEJECT 2 /* eject bit in start/stop cmd */ 235 236 typedef struct scsa2usb_last_cmd { 237 /* this is the cdb of the last command issued */ 238 uchar_t cdb[SCSI_CDB_SIZE]; 239 240 /* this is the status of the last command issued */ 241 uint_t status; 242 } scsa2usb_last_cmd_t; 243 244 /* 245 * override values 246 * These values may be set in scsa2usb.conf for particular devices 247 */ 248 typedef struct scsa2usb_ov { 249 int vid; /* vendor id */ 250 int pid; /* product id */ 251 int rev; /* revision */ 252 int subclass; /* subclass override */ 253 int protocol; /* protocol override */ 254 int pmoff; /* power management override */ 255 int fake_removable; /* removable device override */ 256 int no_modesense; /* no mode sense */ 257 /* no modesense, doorlock, PM, start/stop */ 258 int reduced_cmd_support; 259 } scsa2usb_ov_t; 260 261 262 /* 263 * Per bulk device "state" data structure. 264 */ 265 typedef struct scsa2usb_state { 266 int scsa2usb_instance; /* Instance number */ 267 int scsa2usb_dev_state; /* USB device state */ 268 int scsa2usb_flags; /* Per instance flags */ 269 int scsa2usb_intfc_num; /* Interface number */ 270 dev_info_t *scsa2usb_dip; /* Per device. info */ 271 scsa2usb_power_t *scsa2usb_pm; /* PM state info */ 272 273 int scsa2usb_transport_busy; /* ugen/sd traffic */ 274 int scsa2usb_ugen_open_count; 275 kcondvar_t scsa2usb_transport_busy_cv; 276 kthread_t *scsa2usb_busy_thread; 277 278 kmutex_t scsa2usb_mutex; /* Per instance lock */ 279 280 struct scsi_hba_tran *scsa2usb_tran; /* SCSI transport ptr */ 281 struct scsi_pkt *scsa2usb_cur_pkt; /* SCSI packet ptr */ 282 283 usba_list_entry_t scsa2usb_waitQ[SCSA2USB_MAX_LUNS]; 284 /* waitQ list */ 285 struct scsa2usb_cmd *scsa2usb_arq_cmd; /* ARQ cmd */ 286 struct buf *scsa2usb_arq_bp; /* ARQ buf */ 287 288 dev_info_t *scsa2usb_lun_dip[SCSA2USB_MAX_LUNS]; 289 /* store devinfo per LUN */ 290 struct scsi_inquiry scsa2usb_lun_inquiry[SCSA2USB_MAX_LUNS]; 291 /* store inquiry per LUN */ 292 usb_if_descr_t scsa2usb_intfc_descr; /* Interface descr */ 293 usb_ep_descr_t scsa2usb_bulkin_ept; /* Bulk In descriptor */ 294 usb_ep_descr_t scsa2usb_bulkout_ept; /* Bulkout descriptor */ 295 usb_ep_descr_t scsa2usb_intr_ept; /* Intr ept descr */ 296 297 usb_pipe_handle_t scsa2usb_default_pipe; /* Default pipe Hndle */ 298 usb_pipe_handle_t scsa2usb_intr_pipe; /* Intr polling Hndle */ 299 usb_pipe_handle_t scsa2usb_bulkin_pipe; /* Bulk Inpipe Handle */ 300 usb_pipe_handle_t scsa2usb_bulkout_pipe; /* Bulk Outpipe Hndle */ 301 302 uint_t scsa2usb_pipe_state; /* resetting state */ 303 uint_t scsa2usb_tag; /* current tag */ 304 uint_t scsa2usb_pkt_state; /* packet state */ 305 uint_t scsa2usb_n_luns; /* number of luns */ 306 307 usb_log_handle_t scsa2usb_log_handle; /* log handle */ 308 struct scsa2usb_cpr *scsa2usb_panic_info; /* for cpr info */ 309 310 size_t scsa2usb_lbasize[SCSA2USB_MAX_LUNS]; 311 /* sector size */ 312 size_t scsa2usb_totalsec[SCSA2USB_MAX_LUNS]; 313 /* total sectors */ 314 size_t scsa2usb_secsz[SCSA2USB_MAX_LUNS]; 315 /* sector size */ 316 size_t scsa2usb_max_bulk_xfer_size; /* from HCD */ 317 318 usb_client_dev_data_t *scsa2usb_dev_data; /* USB registration */ 319 scsa2usb_last_cmd_t scsa2usb_last_cmd; /* last/prev command */ 320 321 uint_t scsa2usb_attrs; /* for bad devices */ 322 uint_t scsa2usb_cmd_protocol; /* CMD protocol used */ 323 kthread_t *scsa2usb_work_thread_id; /* handle commands */ 324 325 /* conf file override values */ 326 uint_t scsa2usb_subclass_override; 327 uint_t scsa2usb_protocol_override; 328 char *scsa2usb_override_str; 329 330 /* suppress repetitive disconnect warnings */ 331 boolean_t scsa2usb_warning_given; 332 333 boolean_t scsa2usb_rcvd_not_ready; /* received NOT */ 334 /* READY sense data */ 335 336 usb_ugen_hdl_t scsa2usb_ugen_hdl; /* ugen support */ 337 } scsa2usb_state_t; 338 339 340 /* for warlock */ 341 _NOTE(MUTEX_PROTECTS_DATA(scsa2usb_state::scsa2usb_mutex, scsa2usb_state)) 342 _NOTE(DATA_READABLE_WITHOUT_LOCK(scsa2usb_state::scsa2usb_instance)) 343 _NOTE(DATA_READABLE_WITHOUT_LOCK(scsa2usb_state::scsa2usb_dip)) 344 _NOTE(DATA_READABLE_WITHOUT_LOCK(scsa2usb_state::scsa2usb_arq_cmd)) 345 _NOTE(DATA_READABLE_WITHOUT_LOCK(scsa2usb_state::scsa2usb_arq_bp)) 346 _NOTE(DATA_READABLE_WITHOUT_LOCK(scsa2usb_state::scsa2usb_bulkin_ept)) 347 _NOTE(DATA_READABLE_WITHOUT_LOCK(scsa2usb_state::scsa2usb_bulkout_ept)) 348 _NOTE(DATA_READABLE_WITHOUT_LOCK(scsa2usb_state::scsa2usb_intr_ept)) 349 _NOTE(DATA_READABLE_WITHOUT_LOCK(scsa2usb_state::scsa2usb_default_pipe)) 350 _NOTE(DATA_READABLE_WITHOUT_LOCK(scsa2usb_state::scsa2usb_intr_pipe)) 351 _NOTE(DATA_READABLE_WITHOUT_LOCK(scsa2usb_state::scsa2usb_bulkin_pipe)) 352 _NOTE(DATA_READABLE_WITHOUT_LOCK(scsa2usb_state::scsa2usb_bulkout_pipe)) 353 _NOTE(DATA_READABLE_WITHOUT_LOCK(scsa2usb_state::scsa2usb_log_handle)) 354 _NOTE(DATA_READABLE_WITHOUT_LOCK(scsa2usb_state::scsa2usb_intfc_num)) 355 _NOTE(DATA_READABLE_WITHOUT_LOCK(scsa2usb_state::scsa2usb_dev_data)) 356 _NOTE(DATA_READABLE_WITHOUT_LOCK(scsa2usb_state::scsa2usb_ugen_hdl)) 357 _NOTE(DATA_READABLE_WITHOUT_LOCK(scsa2usb_state::scsa2usb_pm)) 358 _NOTE(SCHEME_PROTECTS_DATA("stable data", scsa2usb_power_t)) 359 _NOTE(SCHEME_PROTECTS_DATA("stable data", scsi_hba_tran_t)) 360 _NOTE(SCHEME_PROTECTS_DATA("unshared data", usb_bulk_req_t)) 361 362 /* scsa2usb_pipe_state values */ 363 #define SCSA2USB_PIPE_NORMAL 0x00 /* no reset or clearing */ 364 #define SCSA2USB_PIPE_CLOSING 0x01 /* closing all pipes */ 365 #define SCSA2USB_PIPE_DEV_RESET 0x02 /* device specific reset */ 366 367 /* pkt xfer state machine */ 368 #define SCSA2USB_PKT_NONE 0 /* device is idle */ 369 #define SCSA2USB_PKT_PROCESS_CSW 1 /* device doing status again */ 370 #define SCSA2USB_PKT_DO_COMP 2 /* device is done xfer */ 371 372 /* scsa2usb_flags values */ 373 #define SCSA2USB_FLAGS_PIPES_OPENED 0x001 /* usb pipes are open */ 374 #define SCSA2USB_FLAGS_HBA_ATTACH_SETUP 0x002 /* scsi hba setup done */ 375 #define SCSA2USB_FLAGS_LOCKS_INIT 0x004 /* basic inits done */ 376 377 /* scsa2usb_cmd_protocol values */ 378 #define SCSA2USB_UNKNOWN_PROTOCOL 0x0000 /* unknown wire protocol */ 379 #define SCSA2USB_CB_PROTOCOL 0x0001 /* CBI wire protocol */ 380 #define SCSA2USB_CBI_PROTOCOL 0x0002 /* CBI w/ intr wire protocol */ 381 #define SCSA2USB_BULK_ONLY_PROTOCOL 0x0004 /* Bulk Only wire protocol */ 382 383 #define SCSA2USB_SCSI_CMDSET 0x1000 /* SCSI command set followed */ 384 #define SCSA2USB_ATAPI_CMDSET 0x2000 /* ATAPI command set followed */ 385 #define SCSA2USB_UFI_CMDSET 0x4000 /* UFI command set followed */ 386 #define SCSA2USB_CMDSET_MASK 0x7000 /* OR al the above */ 387 388 #define SCSA2USB_IS_UFI_CMDSET(s) \ 389 (((s)->scsa2usb_cmd_protocol & SCSA2USB_UFI_CMDSET)) 390 #define SCSA2USB_IS_SCSI_CMDSET(s) \ 391 (((s)->scsa2usb_cmd_protocol & SCSA2USB_SCSI_CMDSET)) 392 #define SCSA2USB_IS_ATAPI_CMDSET(s) \ 393 (((s)->scsa2usb_cmd_protocol & SCSA2USB_ATAPI_CMDSET)) 394 395 #define SCSA2USB_IS_CB(s) \ 396 (((s)->scsa2usb_cmd_protocol & SCSA2USB_CB_PROTOCOL)) 397 398 #define SCSA2USB_IS_CBI(s) \ 399 (((s)->scsa2usb_cmd_protocol & SCSA2USB_CBI_PROTOCOL)) 400 401 #define SCSA2USB_IS_BULK_ONLY(s) \ 402 (((s)->scsa2usb_cmd_protocol & SCSA2USB_BULK_ONLY_PROTOCOL)) 403 404 /* check if it is ok to access the device and send command to it */ 405 #define SCSA2USB_DEVICE_ACCESS_OK(s) \ 406 ((s)->scsa2usb_dev_state == USB_DEV_ONLINE) 407 408 /* check if we are in any reset */ 409 #define SCSA2USB_IN_RESET(s) \ 410 (((s)->scsa2usb_pipe_state & SCSA2USB_PIPE_DEV_RESET) != 0) 411 412 /* check if the device is busy */ 413 #define SCSA2USB_BUSY(s) \ 414 (((s)->scsa2usb_cur_pkt) || \ 415 ((s)->scsa2usb_pipe_state != SCSA2USB_PIPE_NORMAL) || \ 416 ((s)->scsa2usb_pkt_state != SCSA2USB_PKT_NONE)) 417 418 /* check if we're doing cpr */ 419 #define SCSA2USB_CHK_CPR(s) \ 420 (((s)->scsa2usb_dev_state == USB_DEV_SUSPENDED)) 421 422 /* check if we're either paniced or in cpr state */ 423 #define SCSA2USB_CHK_PANIC_CPR(s) \ 424 (ddi_in_panic() || SCSA2USB_CHK_CPR(s)) 425 426 /* reset scsa2usb state after pkt_comp is called */ 427 #define SCSA2USB_RESET_CUR_PKT(s) \ 428 (s)->scsa2usb_cur_pkt = NULL; \ 429 (s)->scsa2usb_pkt_state = SCSA2USB_PKT_NONE; 430 431 /* print a panic sync message to the console */ 432 #define SCSA2USB_PRINT_SYNC_MSG(m, s) \ 433 if ((m) == B_TRUE) { \ 434 USB_DPRINTF_L1(DPRINT_MASK_SCSA, (s)->scsa2usb_log_handle, \ 435 "syncing not supported"); \ 436 (m) = B_FALSE; \ 437 } 438 439 /* Cancel callbacks registered during attach time */ 440 #define SCSA2USB_CANCEL_CB(id) \ 441 if ((id)) { \ 442 (void) callb_delete((id)); \ 443 (id) = 0; \ 444 } 445 446 /* Set SCSA2USB_PKT_DO_COMP state if there is active I/O */ 447 #define SCSA2USB_SET_PKT_DO_COMP_STATE(s) \ 448 if ((s)->scsa2usb_cur_pkt) { \ 449 (s)->scsa2usb_pkt_state = SCSA2USB_PKT_DO_COMP; \ 450 } 451 452 #define SCSA2USB_FREE_MSG(data) \ 453 if ((data)) { \ 454 freemsg((data)); \ 455 } 456 457 #define SCSA2USB_FREE_BULK_REQ(req) \ 458 if ((req)) { \ 459 usb_free_bulk_req((req)); /* Free request */ \ 460 } 461 462 463 /* SCSA related */ 464 #define ADDR2TRAN(ap) ((ap)->a_hba_tran) 465 #define TRAN2SCSA2USB(tran) ((scsa2usb_state_t *)(tran)->tran_hba_private) 466 #define ADDR2SCSA2USB(ap) (TRAN2SCSA2USB(ADDR2TRAN(ap))) 467 468 #define PKT_PRIV_LEN 16 469 470 #define PKT_DEFAULT_TIMEOUT 5 471 472 /* 473 * auto request sense 474 */ 475 #define RQ_MAKECOM_COMMON(pktp, flag, cmd) \ 476 (pktp)->pkt_flags = (flag), \ 477 ((union scsi_cdb *)(pktp)->pkt_cdbp)->scc_cmd = (cmd), \ 478 ((union scsi_cdb *)(pktp)->pkt_cdbp)->scc_lun = \ 479 (pktp)->pkt_address.a_lun 480 481 #define RQ_MAKECOM_G0(pktp, flag, cmd, addr, cnt) \ 482 RQ_MAKECOM_COMMON((pktp), (flag), (cmd)), \ 483 FORMG0ADDR(((union scsi_cdb *)(pktp)->pkt_cdbp), (addr)), \ 484 FORMG0COUNT(((union scsi_cdb *)(pktp)->pkt_cdbp), (cnt)) 485 486 487 /* transport related */ 488 #define SCSA2USB_JUST_ACCEPT 0 489 #define SCSA2USB_TRANSPORT 1 490 #define SCSA2USB_REJECT -1 491 492 /* 493 * The scsa2usb_cpr_info data structure is used for cpr related 494 * callbacks. It is used for panic callbacks as well. 495 */ 496 typedef struct scsa2usb_cpr { 497 callb_cpr_t cpr; /* for cpr related info */ 498 struct scsa2usb_state *statep; /* for scsa2usb state info */ 499 kmutex_t lockp; /* mutex used by cpr_info_t */ 500 } scsa2usb_cpr_t; 501 502 _NOTE(DATA_READABLE_WITHOUT_LOCK(scsa2usb_cpr_t::cpr)) 503 _NOTE(DATA_READABLE_WITHOUT_LOCK(scsa2usb_cpr_t::statep)) 504 505 /* 506 * The scsa2usb_cmd data structure is defined here. It gets 507 * initialized per command that is sent to the device. 508 */ 509 typedef struct scsa2usb_cmd { 510 struct scsi_pkt *cmd_pkt; /* copy of pkt ptr */ 511 struct buf *cmd_bp; /* copy of bp ptr */ 512 size_t cmd_xfercount; /* current xfer count */ 513 size_t cmd_resid_xfercount; /* last xfer resid */ 514 int cmd_scblen; /* status length */ 515 int cmd_tag; /* tag */ 516 int cmd_timeout; /* copy of pkt_time */ 517 uchar_t cmd_cdb[SCSI_CDB_SIZE]; /* CDB */ 518 uchar_t cmd_dir; /* direction */ 519 uchar_t cmd_actual_len; /* cdb len */ 520 uchar_t cmd_cdblen; /* requested cdb len */ 521 struct scsi_arq_status cmd_scb; /* status, w/ arq */ 522 523 /* used in multiple xfers */ 524 size_t cmd_total_xfercount; /* total xfer val */ 525 size_t cmd_offset; /* offset into buf */ 526 int cmd_lba; /* current xfer lba */ 527 int cmd_done; /* command done? */ 528 int cmd_blksize; /* block size */ 529 usba_list_entry_t cmd_waitQ; /* waitQ element */ 530 } scsa2usb_cmd_t; 531 532 /* for warlock */ 533 _NOTE(SCHEME_PROTECTS_DATA("unique per packet or safe sharing", 534 scsi_cdb scsi_status scsi_pkt buf scsa2usb_cmd scsi_arq_status)) 535 _NOTE(SCHEME_PROTECTS_DATA("stable data", scsi_device scsi_address)) 536 537 /* scsa2usb_cdb position of fields in CDB */ 538 #define SCSA2USB_OPCODE 0 /* Opcode field */ 539 #define SCSA2USB_LUN 1 /* LUN field */ 540 #define SCSA2USB_LBA_0 2 /* LBA[0] field */ 541 #define SCSA2USB_LBA_1 3 /* LBA[1] field */ 542 #define SCSA2USB_LBA_2 4 /* LBA[2] field */ 543 #define SCSA2USB_LBA_3 5 /* LBA[3] field */ 544 #define SCSA2USB_LEN_0 7 /* LEN[0] field */ 545 #define SCSA2USB_LEN_1 8 /* LEN[1] field */ 546 547 /* macros to calculate LBA for 6/10/12-byte commands */ 548 #define SCSA2USB_LBA_6BYTE(pkt) \ 549 (((pkt)->pkt_cdbp[1] & 0x1f) << 16) + \ 550 ((pkt)->pkt_cdbp[2] << 8) + (pkt)->pkt_cdbp[3] 551 #define SCSA2USB_LEN_6BYTE(pkt) (pkt)->pkt_cdbp[4] 552 553 #define SCSA2USB_LEN_10BYTE(pkt) \ 554 ((pkt)->pkt_cdbp[7] << 8) + (pkt)->pkt_cdbp[8] 555 #define SCSA2USB_LBA_10BYTE(pkt) \ 556 ((pkt)->pkt_cdbp[2] << 24) + ((pkt)->pkt_cdbp[3] << 16) + \ 557 ((pkt)->pkt_cdbp[4] << 8) + (pkt)->pkt_cdbp[5] 558 559 #define SCSA2USB_LEN_12BYTE(pkt) \ 560 ((pkt)->pkt_cdbp[6] << 24) + ((pkt)->pkt_cdbp[7] << 16) + \ 561 ((pkt)->pkt_cdbp[8] << 8) + (pkt)->pkt_cdbp[9] 562 #define SCSA2USB_LBA_12BYTE(pkt) \ 563 ((pkt)->pkt_cdbp[2] << 24) + ((pkt)->pkt_cdbp[3] << 16) + \ 564 ((pkt)->pkt_cdbp[4] << 8) + (pkt)->pkt_cdbp[5] 565 566 /* macros to convert a pkt to cmd and vice-versa */ 567 #define PKT2CMD(pkt) ((scsa2usb_cmd_t *)(pkt)->pkt_ha_private) 568 #define CMD2PKT(sp) ((sp)->cmd_pkt 569 570 /* bulk pipe default timeout value - how long the command to be tried? */ 571 #define SCSA2USB_BULK_PIPE_TIMEOUT (2 * USB_PIPE_TIMEOUT) 572 573 /* drain timeout in seconds on the work thread */ 574 #define SCSA2USB_DRAIN_TIMEOUT 60 575 576 /* scsa2usb pkt xfer status phase retry times */ 577 #define SCSA2USB_STATUS_RETRIES 3 578 579 /* 580 * limit on the number of requests that can be queued per LUN: 581 * 3 for untagged queueing, 1 for scsiwatch and a margin of 2 582 */ 583 #define SCSA2USB_MAX_REQ_PER_LUN 6 584 585 /* 586 * The following data structure is used to save the values returned 587 * by the READ_CAPACITY command. lba is the max allowed logical block 588 * address and blen is max allowed block size. 589 */ 590 typedef struct scsa2usb_read_cap { 591 uchar_t scsa2usb_read_cap_lba3; /* Max lba supported */ 592 uchar_t scsa2usb_read_cap_lba2; 593 uchar_t scsa2usb_read_cap_lba1; 594 uchar_t scsa2usb_read_cap_lba0; 595 uchar_t scsa2usb_read_cap_blen3; /* Max block size supported */ 596 uchar_t scsa2usb_read_cap_blen2; 597 uchar_t scsa2usb_read_cap_blen1; 598 uchar_t scsa2usb_read_cap_blen0; 599 } scsa2usb_read_cap_t; 600 601 #define SCSA2USB_MK_32BIT(a, b, c, d) \ 602 (((a) << 24) | ((b) << 16) | ((c) << 8) | (d)) 603 604 /* position of fields for SCMD_READ_CD CDB */ 605 #define SCSA2USB_READ_CD_LEN_0 6 /* LEN[0] of SCMD_READ_CD */ 606 #define SCSA2USB_READ_CD_LEN_1 7 /* LEN[1] of SCMD_READ_CD */ 607 #define SCSA2USB_READ_CD_LEN_2 8 /* LEN[2] of SCMD_READ_CD */ 608 609 /* macro to calculate LEN for SCMD_READ_CD command */ 610 #define SCSA2USB_LEN_READ_CD(pkt) \ 611 (((pkt)->pkt_cdbp[SCSA2USB_READ_CD_LEN_0] << 16) +\ 612 ((pkt)->pkt_cdbp[SCSA2USB_READ_CD_LEN_1] << 8) +\ 613 (pkt)->pkt_cdbp[SCSA2USB_READ_CD_LEN_2]) 614 615 /* Figure out Block Size before issuing a WRITE to CD-RW device */ 616 #define SCSA2USB_CDRW_BLKSZ(bcount, len) ((bcount) / (len)); 617 #define SCSA2USB_VALID_CDRW_BLKSZ(blksz) \ 618 (((blksz) == CDROM_BLK_2048) || ((blksz) == CDROM_BLK_2352) || \ 619 ((blksz) == CDROM_BLK_2336) || ((blksz) == CDROM_BLK_2324) || \ 620 ((blksz) == 0)) 621 622 /* debug and error msg logging */ 623 #define DPRINT_MASK_SCSA 0x0001 /* for SCSA */ 624 #define DPRINT_MASK_ATTA 0x0002 /* for ATTA */ 625 #define DPRINT_MASK_EVENTS 0x0004 /* for event handling */ 626 #define DPRINT_MASK_CALLBACKS 0x0008 /* for callbacks */ 627 #define DPRINT_MASK_TIMEOUT 0x0010 /* for timeouts */ 628 #define DPRINT_MASK_DUMPING 0x0020 /* for dumping */ 629 #define DPRINT_MASK_PM 0x0040 /* for pwr mgmt */ 630 #define DPRINT_MASK_ALL 0xffffffff /* for everything */ 631 632 #ifdef DEBUG 633 #define SCSA2USB_PRINT_CDB scsa2usb_print_cdb 634 #else 635 #define SCSA2USB_PRINT_CDB 0 && 636 #endif 637 638 /* ugen support */ 639 #define SCSA2USB_MINOR_UGEN_BITS_MASK 0xff 640 #define SCSA2USB_MINOR_INSTANCE_MASK ~SCSA2USB_MINOR_UGEN_BITS_MASK 641 #define SCSA2USB_MINOR_INSTANCE_SHIFT 8 642 643 #define SCSA2USB_MINOR_TO_INSTANCE(minor) \ 644 (((minor) & SCSA2USB_MINOR_INSTANCE_MASK) >> \ 645 SCSA2USB_MINOR_INSTANCE_SHIFT) 646 647 #ifdef __cplusplus 648 } 649 #endif 650 651 #endif /* _SYS_USB_SCSA2USB_H */ 652