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