1 /* 2 * (C) Copyright 2001 3 * Denis Peter, MPL AG Switzerland 4 * 5 * SPDX-License-Identifier: GPL-2.0+ 6 */ 7 #ifndef _SCSI_H 8 #define _SCSI_H 9 10 struct scsi_cmd { 11 unsigned char cmd[16]; /* command */ 12 /* for request sense */ 13 unsigned char sense_buf[64] 14 __attribute__((aligned(ARCH_DMA_MINALIGN))); 15 unsigned char status; /* SCSI Status */ 16 unsigned char target; /* Target ID */ 17 unsigned char lun; /* Target LUN */ 18 unsigned char cmdlen; /* command len */ 19 unsigned long datalen; /* Total data length */ 20 unsigned char * pdata; /* pointer to data */ 21 unsigned char msgout[12]; /* Messge out buffer (NOT USED) */ 22 unsigned char msgin[12]; /* Message in buffer */ 23 unsigned char sensecmdlen; /* Sense command len */ 24 unsigned long sensedatalen; /* Sense data len */ 25 unsigned char sensecmd[6]; /* Sense command */ 26 unsigned long contr_stat; /* Controller Status */ 27 unsigned long trans_bytes; /* tranfered bytes */ 28 29 unsigned int priv; 30 }; 31 32 /*----------------------------------------------------------- 33 ** 34 ** SCSI constants. 35 ** 36 **----------------------------------------------------------- 37 */ 38 39 /* 40 ** Messages 41 */ 42 43 #define M_COMPLETE (0x00) 44 #define M_EXTENDED (0x01) 45 #define M_SAVE_DP (0x02) 46 #define M_RESTORE_DP (0x03) 47 #define M_DISCONNECT (0x04) 48 #define M_ID_ERROR (0x05) 49 #define M_ABORT (0x06) 50 #define M_REJECT (0x07) 51 #define M_NOOP (0x08) 52 #define M_PARITY (0x09) 53 #define M_LCOMPLETE (0x0a) 54 #define M_FCOMPLETE (0x0b) 55 #define M_RESET (0x0c) 56 #define M_ABORT_TAG (0x0d) 57 #define M_CLEAR_QUEUE (0x0e) 58 #define M_INIT_REC (0x0f) 59 #define M_REL_REC (0x10) 60 #define M_TERMINATE (0x11) 61 #define M_SIMPLE_TAG (0x20) 62 #define M_HEAD_TAG (0x21) 63 #define M_ORDERED_TAG (0x22) 64 #define M_IGN_RESIDUE (0x23) 65 #define M_IDENTIFY (0x80) 66 67 #define M_X_MODIFY_DP (0x00) 68 #define M_X_SYNC_REQ (0x01) 69 #define M_X_WIDE_REQ (0x03) 70 #define M_X_PPR_REQ (0x04) 71 72 73 /* 74 ** Status 75 */ 76 77 #define S_GOOD (0x00) 78 #define S_CHECK_COND (0x02) 79 #define S_COND_MET (0x04) 80 #define S_BUSY (0x08) 81 #define S_INT (0x10) 82 #define S_INT_COND_MET (0x14) 83 #define S_CONFLICT (0x18) 84 #define S_TERMINATED (0x20) 85 #define S_QUEUE_FULL (0x28) 86 #define S_ILLEGAL (0xff) 87 #define S_SENSE (0x80) 88 89 /* 90 * Sense_keys 91 */ 92 93 #define SENSE_NO_SENSE 0x0 94 #define SENSE_RECOVERED_ERROR 0x1 95 #define SENSE_NOT_READY 0x2 96 #define SENSE_MEDIUM_ERROR 0x3 97 #define SENSE_HARDWARE_ERROR 0x4 98 #define SENSE_ILLEGAL_REQUEST 0x5 99 #define SENSE_UNIT_ATTENTION 0x6 100 #define SENSE_DATA_PROTECT 0x7 101 #define SENSE_BLANK_CHECK 0x8 102 #define SENSE_VENDOR_SPECIFIC 0x9 103 #define SENSE_COPY_ABORTED 0xA 104 #define SENSE_ABORTED_COMMAND 0xB 105 #define SENSE_VOLUME_OVERFLOW 0xD 106 #define SENSE_MISCOMPARE 0xE 107 108 109 #define SCSI_CHANGE_DEF 0x40 /* Change Definition (Optional) */ 110 #define SCSI_COMPARE 0x39 /* Compare (O) */ 111 #define SCSI_COPY 0x18 /* Copy (O) */ 112 #define SCSI_COP_VERIFY 0x3A /* Copy and Verify (O) */ 113 #define SCSI_INQUIRY 0x12 /* Inquiry (MANDATORY) */ 114 #define SCSI_LOG_SELECT 0x4C /* Log Select (O) */ 115 #define SCSI_LOG_SENSE 0x4D /* Log Sense (O) */ 116 #define SCSI_MODE_SEL6 0x15 /* Mode Select 6-byte (Device Specific) */ 117 #define SCSI_MODE_SEL10 0x55 /* Mode Select 10-byte (Device Specific) */ 118 #define SCSI_MODE_SEN6 0x1A /* Mode Sense 6-byte (Device Specific) */ 119 #define SCSI_MODE_SEN10 0x5A /* Mode Sense 10-byte (Device Specific) */ 120 #define SCSI_READ_BUFF 0x3C /* Read Buffer (O) */ 121 #define SCSI_REQ_SENSE 0x03 /* Request Sense (MANDATORY) */ 122 #define SCSI_SEND_DIAG 0x1D /* Send Diagnostic (O) */ 123 #define SCSI_TST_U_RDY 0x00 /* Test Unit Ready (MANDATORY) */ 124 #define SCSI_WRITE_BUFF 0x3B /* Write Buffer (O) */ 125 /*************************************************************************** 126 * %%% Commands Unique to Direct Access Devices %%% 127 ***************************************************************************/ 128 #define SCSI_COMPARE 0x39 /* Compare (O) */ 129 #define SCSI_FORMAT 0x04 /* Format Unit (MANDATORY) */ 130 #define SCSI_LCK_UN_CAC 0x36 /* Lock Unlock Cache (O) */ 131 #define SCSI_PREFETCH 0x34 /* Prefetch (O) */ 132 #define SCSI_MED_REMOVL 0x1E /* Prevent/Allow medium Removal (O) */ 133 #define SCSI_READ6 0x08 /* Read 6-byte (MANDATORY) */ 134 #define SCSI_READ10 0x28 /* Read 10-byte (MANDATORY) */ 135 #define SCSI_READ16 0x48 136 #define SCSI_RD_CAPAC 0x25 /* Read Capacity (MANDATORY) */ 137 #define SCSI_RD_CAPAC10 SCSI_RD_CAPAC /* Read Capacity (10) */ 138 #define SCSI_RD_CAPAC16 0x9e /* Read Capacity (16) */ 139 #define SCSI_RD_DEFECT 0x37 /* Read Defect Data (O) */ 140 #define SCSI_READ_LONG 0x3E /* Read Long (O) */ 141 #define SCSI_REASS_BLK 0x07 /* Reassign Blocks (O) */ 142 #define SCSI_RCV_DIAG 0x1C /* Receive Diagnostic Results (O) */ 143 #define SCSI_RELEASE 0x17 /* Release Unit (MANDATORY) */ 144 #define SCSI_REZERO 0x01 /* Rezero Unit (O) */ 145 #define SCSI_SRCH_DAT_E 0x31 /* Search Data Equal (O) */ 146 #define SCSI_SRCH_DAT_H 0x30 /* Search Data High (O) */ 147 #define SCSI_SRCH_DAT_L 0x32 /* Search Data Low (O) */ 148 #define SCSI_SEEK6 0x0B /* Seek 6-Byte (O) */ 149 #define SCSI_SEEK10 0x2B /* Seek 10-Byte (O) */ 150 #define SCSI_SEND_DIAG 0x1D /* Send Diagnostics (MANDATORY) */ 151 #define SCSI_SET_LIMIT 0x33 /* Set Limits (O) */ 152 #define SCSI_START_STP 0x1B /* Start/Stop Unit (O) */ 153 #define SCSI_SYNC_CACHE 0x35 /* Synchronize Cache (O) */ 154 #define SCSI_VERIFY 0x2F /* Verify (O) */ 155 #define SCSI_WRITE6 0x0A /* Write 6-Byte (MANDATORY) */ 156 #define SCSI_WRITE10 0x2A /* Write 10-Byte (MANDATORY) */ 157 #define SCSI_WRT_VERIFY 0x2E /* Write and Verify (O) */ 158 #define SCSI_WRITE_LONG 0x3F /* Write Long (O) */ 159 #define SCSI_WRITE_SAME 0x41 /* Write Same (O) */ 160 161 /** 162 * struct scsi_platdata - stores information about SCSI controller 163 * 164 * @base: Controller base address 165 * @max_lun: Maximum number of logical units 166 * @max_id: Maximum number of target ids 167 */ 168 struct scsi_platdata { 169 unsigned long base; 170 unsigned long max_lun; 171 unsigned long max_id; 172 }; 173 174 /* Operations for SCSI */ 175 struct scsi_ops { 176 /** 177 * exec() - execute a command 178 * 179 * @dev: SCSI bus 180 * @cmd: Command to execute 181 * @return 0 if OK, -ve on error 182 */ 183 int (*exec)(struct udevice *dev, struct scsi_cmd *cmd); 184 185 /** 186 * bus_reset() - reset the bus 187 * 188 * @dev: SCSI bus to reset 189 * @return 0 if OK, -ve on error 190 */ 191 int (*bus_reset)(struct udevice *dev); 192 }; 193 194 #define scsi_get_ops(dev) ((struct scsi_ops *)(dev)->driver->ops) 195 196 extern struct scsi_ops scsi_ops; 197 198 /** 199 * scsi_exec() - execute a command 200 * 201 * @dev: SCSI bus 202 * @cmd: Command to execute 203 * @return 0 if OK, -ve on error 204 */ 205 int scsi_exec(struct udevice *dev, struct scsi_cmd *cmd); 206 207 /** 208 * scsi_bus_reset() - reset the bus 209 * 210 * @dev: SCSI bus to reset 211 * @return 0 if OK, -ve on error 212 */ 213 int scsi_bus_reset(struct udevice *dev); 214 215 /** 216 * scsi_scan() - Scan all SCSI controllers for available devices 217 * 218 * @vebose: true to show information about each device found 219 */ 220 int scsi_scan(bool verbose); 221 222 /** 223 * scsi_scan_dev() - scan a SCSI bus and create devices 224 * 225 * @dev: SCSI bus 226 * @verbose: true to show information about each device found 227 */ 228 int scsi_scan_dev(struct udevice *dev, bool verbose); 229 230 #ifndef CONFIG_DM_SCSI 231 void scsi_low_level_init(int busdevfunc); 232 void scsi_init(void); 233 #endif 234 235 #define SCSI_IDENTIFY 0xC0 /* not used */ 236 237 /* Hardware errors */ 238 #define SCSI_SEL_TIME_OUT 0x00000101 /* Selection time out */ 239 #define SCSI_HNS_TIME_OUT 0x00000102 /* Handshake */ 240 #define SCSI_MA_TIME_OUT 0x00000103 /* Phase error */ 241 #define SCSI_UNEXP_DIS 0x00000104 /* unexpected disconnect */ 242 243 #define SCSI_INT_STATE 0x00010000 /* unknown Interrupt number is stored in 16 LSB */ 244 245 #endif /* _SCSI_H */ 246