iscsi: new module from Ronnie.
[ccan] / ccan / iscsi / scsi-lowlevel.h
1 /* 
2    Copyright (C) 2010 by Ronnie Sahlberg <ronniesahlberg@gmail.com>
3    
4    This program is free software; you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation; either version 3 of the License, or
7    (at your option) any later version.
8    
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13    
14    You should have received a copy of the GNU General Public License
15    along with this program; if not, see <http://www.gnu.org/licenses/>.
16 */
17
18 #ifndef _U_
19 #define _U_
20 #endif
21
22 #define SCSI_CDB_MAX_SIZE                       16
23
24 enum scsi_opcode {SCSI_OPCODE_TESTUNITREADY=0x00,
25                   SCSI_OPCODE_INQUIRY=0x12,
26                   SCSI_OPCODE_MODESENSE6=0x1a,
27                   SCSI_OPCODE_READCAPACITY10=0x25,
28                   SCSI_OPCODE_READ10=0x28,
29                   SCSI_OPCODE_WRITE10=0x2A,
30                   SCSI_OPCODE_REPORTLUNS=0xA0};
31
32 /* sense keys */
33 #define SCSI_SENSE_KEY_ILLEGAL_REQUEST                  0x05
34 #define SCSI_SENSE_KEY_UNIT_ATTENTION                   0x06
35
36 /* ascq */
37 #define SCSI_SENSE_ASCQ_INVALID_FIELD_IN_CDB            0x2400
38 #define SCSI_SENSE_ASCQ_BUS_RESET                       0x2900
39
40 enum scsi_xfer_dir {SCSI_XFER_NONE=0,
41                     SCSI_XFER_READ=1,
42                     SCSI_XFER_WRITE=2};
43
44 struct scsi_reportluns_params {
45        int report_type;
46 };
47 struct scsi_readcapacity10_params {
48        int lba;
49        int pmi;
50 };
51 struct scsi_inquiry_params {
52        int evpd;
53        int page_code;
54 };
55 struct scsi_modesense6_params {
56        int dbd;
57        int pc;
58        int page_code;
59        int sub_page_code;
60 };
61
62 struct scsi_sense {
63        unsigned char error_type;
64        unsigned char key;
65        int           ascq;
66 };
67
68 struct scsi_data {
69        int size;
70        unsigned char *data;
71 };
72
73 struct scsi_allocated_memory {
74        struct scsi_allocated_memory *prev, *next;
75        void *ptr;
76 };
77
78 struct scsi_task {
79        int cdb_size;
80        int xfer_dir;
81        int expxferlen;
82        unsigned char cdb[SCSI_CDB_MAX_SIZE];
83        union {
84              struct scsi_readcapacity10_params readcapacity10;
85              struct scsi_reportluns_params     reportluns;
86              struct scsi_inquiry_params        inquiry;
87              struct scsi_modesense6_params     modesense6;
88        } params;
89
90        struct scsi_sense sense;
91        struct scsi_data datain;
92        struct scsi_allocated_memory *mem;
93 };
94
95 void scsi_free_scsi_task(struct scsi_task *task);
96
97
98 /*
99  * TESTUNITREADY
100  */
101 struct scsi_task *scsi_cdb_testunitready(void);
102
103
104 /*
105  * REPORTLUNS
106  */
107 #define SCSI_REPORTLUNS_REPORT_ALL_LUNS                         0x00
108 #define SCSI_REPORTLUNS_REPORT_WELL_KNOWN_ONLY                  0x01
109 #define SCSI_REPORTLUNS_REPORT_AVAILABLE_LUNS_ONLY              0x02
110
111 struct scsi_reportluns_list {
112        uint32_t num;
113        uint16_t luns[0];
114 };
115
116 struct scsi_task *scsi_reportluns_cdb(int report_type, int alloc_len);
117
118 /*
119  * READCAPACITY10
120  */
121 struct scsi_readcapacity10 {
122        uint32_t lba;
123        uint32_t block_size;
124 };
125 struct scsi_task *scsi_cdb_readcapacity10(int lba, int pmi);
126
127
128 /*
129  * INQUIRY
130  */
131 enum scsi_inquiry_peripheral_qualifier {SCSI_INQUIRY_PERIPHERAL_QUALIFIER_CONNECTED=0x00,
132                                         SCSI_INQUIRY_PERIPHERAL_QUALIFIER_DISCONNECTED=0x01,
133                                         SCSI_INQUIRY_PERIPHERAL_QUALIFIER_NOT_SUPPORTED=0x03};
134
135 enum scsi_inquiry_peripheral_device_type {SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_DIRECT_ACCESS=0x00,
136                                           SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_SEQUENTIAL_ACCESS=0x01,
137                                           SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_PRINTER=0x02,
138                                           SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_PROCESSOR=0x03,
139                                           SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_WRITE_ONCE=0x04,
140                                           SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_MMC=0x05,
141                                           SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_SCANNER=0x06,
142                                           SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_OPTICAL_MEMORY=0x07,
143                                           SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_MEDIA_CHANGER=0x08,
144                                           SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_COMMUNICATIONS=0x09,
145                                           SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_STORAGE_ARRAY_CONTROLLER=0x0c,
146                                           SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_ENCLOSURE_SERVICES=0x0d,
147                                           SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_SIMPLIFIED_DIRECT_ACCESS=0x0e,
148                                           SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_OPTICAL_CARD_READER=0x0f,
149                                           SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_BRIDGE_CONTROLLER=0x10,
150                                           SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_OSD=0x11,
151                                           SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_AUTOMATION=0x12,
152                                           SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_SEQURITY_MANAGER=0x13,
153                                           SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_WELL_KNOWN_LUN=0x1e,
154                                           SCSI_INQUIRY_PERIPHERAL_DEVICE_TYPE_UNKNOWN=0x1f};
155
156 struct scsi_inquiry_standard {
157        enum scsi_inquiry_peripheral_qualifier periperal_qualifier;
158        enum scsi_inquiry_peripheral_device_type periperal_device_type;
159        int rmb;
160        int version;
161        int normaca;
162        int hisup;
163        int response_data_format;
164
165        char vendor_identification[8+1];
166        char product_identification[16+1];
167        char product_revision_level[4+1];
168 }; 
169
170 struct scsi_task *scsi_cdb_inquiry(int evpd, int page_code, int alloc_len);
171
172
173
174 /*
175  * MODESENSE6
176  */
177 enum scsi_modesense_page_control {SCSI_MODESENSE_PC_CURRENT=0x00,
178                                   SCSI_MODESENSE_PC_CHANGEABLE=0x01,
179                                   SCSI_MODESENSE_PC_DEFAULT=0x02,
180                                   SCSI_MODESENSE_PC_SAVED=0x03};
181
182 enum scsi_modesense_page_code {SCSI_MODESENSE_PAGECODE_RETURN_ALL_PAGES=0x3f};
183
184 struct scsi_task *scsi_cdb_modesense6(int dbd, enum scsi_modesense_page_control pc, enum scsi_modesense_page_code page_code, int sub_page_code, unsigned char alloc_len);
185
186
187
188
189 int scsi_datain_getfullsize(struct scsi_task *task);
190 void *scsi_datain_unmarshall(struct scsi_task *task);
191
192 struct scsi_task *scsi_cdb_read10(int lba, int xferlen, int blocksize);
193 struct scsi_task *scsi_cdb_write10(int lba, int xferlen, int fua, int fuanv, int blocksize);
194