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