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