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