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