Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * sbp2.h - Defines and prototypes for sbp2.c | |
3 | * | |
4 | * Copyright (C) 2000 James Goodwin, Filanet Corporation (www.filanet.com) | |
5 | * jamesg@filanet.com | |
6 | * | |
7 | * This program is free software; you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License as published by | |
9 | * the Free Software Foundation; either version 2 of the License, or | |
10 | * (at your option) any later version. | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, | |
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | * GNU General Public License for more details. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License | |
18 | * along with this program; if not, write to the Free Software Foundation, | |
19 | * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | |
20 | */ | |
21 | ||
22 | #ifndef SBP2_H | |
23 | #define SBP2_H | |
24 | ||
25 | #define SBP2_DEVICE_NAME "sbp2" | |
26 | ||
27 | /* | |
28 | * SBP2 specific structures and defines | |
29 | */ | |
30 | ||
31 | #define ORB_DIRECTION_WRITE_TO_MEDIA 0x0 | |
32 | #define ORB_DIRECTION_READ_FROM_MEDIA 0x1 | |
33 | #define ORB_DIRECTION_NO_DATA_TRANSFER 0x2 | |
34 | ||
35 | #define ORB_SET_NULL_PTR(value) ((value & 0x1) << 31) | |
35bdddb8 SR |
36 | #define ORB_SET_NOTIFY(value) ((value & 0x1) << 31) |
37 | #define ORB_SET_RQ_FMT(value) ((value & 0x3) << 29) /* unused ? */ | |
1da177e4 | 38 | #define ORB_SET_NODE_ID(value) ((value & 0xffff) << 16) |
35bdddb8 SR |
39 | #define ORB_SET_STATUS_FIFO_HI(value, id) (value >> 32 | ORB_SET_NODE_ID(id)) |
40 | #define ORB_SET_STATUS_FIFO_LO(value) (value & 0xffffffff) | |
41 | #define ORB_SET_DATA_SIZE(value) (value & 0xffff) | |
42 | #define ORB_SET_PAGE_SIZE(value) ((value & 0x7) << 16) | |
43 | #define ORB_SET_PAGE_TABLE_PRESENT(value) ((value & 0x1) << 19) | |
44 | #define ORB_SET_MAX_PAYLOAD(value) ((value & 0xf) << 20) | |
45 | #define ORB_SET_SPEED(value) ((value & 0x7) << 24) | |
46 | #define ORB_SET_DIRECTION(value) ((value & 0x1) << 27) | |
1da177e4 LT |
47 | |
48 | struct sbp2_command_orb { | |
49 | volatile u32 next_ORB_hi; | |
50 | volatile u32 next_ORB_lo; | |
51 | u32 data_descriptor_hi; | |
52 | u32 data_descriptor_lo; | |
53 | u32 misc; | |
54 | u8 cdb[12]; | |
55 | }; | |
56 | ||
57 | #define SBP2_LOGIN_REQUEST 0x0 | |
58 | #define SBP2_QUERY_LOGINS_REQUEST 0x1 | |
59 | #define SBP2_RECONNECT_REQUEST 0x3 | |
60 | #define SBP2_SET_PASSWORD_REQUEST 0x4 | |
61 | #define SBP2_LOGOUT_REQUEST 0x7 | |
62 | #define SBP2_ABORT_TASK_REQUEST 0xb | |
63 | #define SBP2_ABORT_TASK_SET 0xc | |
64 | #define SBP2_LOGICAL_UNIT_RESET 0xe | |
65 | #define SBP2_TARGET_RESET_REQUEST 0xf | |
66 | ||
67 | #define ORB_SET_LUN(value) (value & 0xffff) | |
68 | #define ORB_SET_FUNCTION(value) ((value & 0xf) << 16) | |
69 | #define ORB_SET_RECONNECT(value) ((value & 0xf) << 20) | |
70 | #define ORB_SET_EXCLUSIVE(value) ((value & 0x1) << 28) | |
71 | #define ORB_SET_LOGIN_RESP_LENGTH(value) (value & 0xffff) | |
72 | #define ORB_SET_PASSWD_LENGTH(value) ((value & 0xffff) << 16) | |
73 | ||
74 | struct sbp2_login_orb { | |
75 | u32 password_hi; | |
76 | u32 password_lo; | |
77 | u32 login_response_hi; | |
78 | u32 login_response_lo; | |
79 | u32 lun_misc; | |
80 | u32 passwd_resp_lengths; | |
35bdddb8 SR |
81 | u32 status_fifo_hi; |
82 | u32 status_fifo_lo; | |
1da177e4 LT |
83 | }; |
84 | ||
85 | #define RESPONSE_GET_LOGIN_ID(value) (value & 0xffff) | |
86 | #define RESPONSE_GET_LENGTH(value) ((value >> 16) & 0xffff) | |
87 | #define RESPONSE_GET_RECONNECT_HOLD(value) (value & 0xffff) | |
88 | ||
89 | struct sbp2_login_response { | |
90 | u32 length_login_ID; | |
91 | u32 command_block_agent_hi; | |
92 | u32 command_block_agent_lo; | |
93 | u32 reconnect_hold; | |
94 | }; | |
95 | ||
96 | #define ORB_SET_LOGIN_ID(value) (value & 0xffff) | |
97 | ||
98 | #define ORB_SET_QUERY_LOGINS_RESP_LENGTH(value) (value & 0xffff) | |
99 | ||
100 | struct sbp2_query_logins_orb { | |
101 | u32 reserved1; | |
102 | u32 reserved2; | |
103 | u32 query_response_hi; | |
104 | u32 query_response_lo; | |
105 | u32 lun_misc; | |
106 | u32 reserved_resp_length; | |
35bdddb8 SR |
107 | u32 status_fifo_hi; |
108 | u32 status_fifo_lo; | |
1da177e4 LT |
109 | }; |
110 | ||
111 | #define RESPONSE_GET_MAX_LOGINS(value) (value & 0xffff) | |
112 | #define RESPONSE_GET_ACTIVE_LOGINS(value) ((RESPONSE_GET_LENGTH(value) - 4) / 12) | |
113 | ||
114 | struct sbp2_query_logins_response { | |
115 | u32 length_max_logins; | |
116 | u32 misc_IDs; | |
117 | u32 initiator_misc_hi; | |
118 | u32 initiator_misc_lo; | |
119 | }; | |
120 | ||
121 | struct sbp2_reconnect_orb { | |
122 | u32 reserved1; | |
123 | u32 reserved2; | |
a237f35f SR |
124 | u32 reserved3; |
125 | u32 reserved4; | |
1da177e4 LT |
126 | u32 login_ID_misc; |
127 | u32 reserved5; | |
35bdddb8 SR |
128 | u32 status_fifo_hi; |
129 | u32 status_fifo_lo; | |
1da177e4 LT |
130 | }; |
131 | ||
132 | struct sbp2_logout_orb { | |
133 | u32 reserved1; | |
134 | u32 reserved2; | |
a237f35f SR |
135 | u32 reserved3; |
136 | u32 reserved4; | |
1da177e4 LT |
137 | u32 login_ID_misc; |
138 | u32 reserved5; | |
35bdddb8 SR |
139 | u32 status_fifo_hi; |
140 | u32 status_fifo_lo; | |
1da177e4 LT |
141 | }; |
142 | ||
143 | #define PAGE_TABLE_SET_SEGMENT_BASE_HI(value) (value & 0xffff) | |
144 | #define PAGE_TABLE_SET_SEGMENT_LENGTH(value) ((value & 0xffff) << 16) | |
145 | ||
146 | struct sbp2_unrestricted_page_table { | |
147 | u32 length_segment_base_hi; | |
148 | u32 segment_base_lo; | |
149 | }; | |
150 | ||
151 | #define RESP_STATUS_REQUEST_COMPLETE 0x0 | |
152 | #define RESP_STATUS_TRANSPORT_FAILURE 0x1 | |
153 | #define RESP_STATUS_ILLEGAL_REQUEST 0x2 | |
154 | #define RESP_STATUS_VENDOR_DEPENDENT 0x3 | |
155 | ||
156 | #define SBP2_STATUS_NO_ADDITIONAL_INFO 0x0 | |
157 | #define SBP2_STATUS_REQ_TYPE_NOT_SUPPORTED 0x1 | |
158 | #define SBP2_STATUS_SPEED_NOT_SUPPORTED 0x2 | |
159 | #define SBP2_STATUS_PAGE_SIZE_NOT_SUPPORTED 0x3 | |
160 | #define SBP2_STATUS_ACCESS_DENIED 0x4 | |
161 | #define SBP2_STATUS_LU_NOT_SUPPORTED 0x5 | |
162 | #define SBP2_STATUS_MAX_PAYLOAD_TOO_SMALL 0x6 | |
163 | #define SBP2_STATUS_RESOURCES_UNAVAILABLE 0x8 | |
164 | #define SBP2_STATUS_FUNCTION_REJECTED 0x9 | |
165 | #define SBP2_STATUS_LOGIN_ID_NOT_RECOGNIZED 0xa | |
166 | #define SBP2_STATUS_DUMMY_ORB_COMPLETED 0xb | |
167 | #define SBP2_STATUS_REQUEST_ABORTED 0xc | |
168 | #define SBP2_STATUS_UNSPECIFIED_ERROR 0xff | |
169 | ||
170 | #define SFMT_CURRENT_ERROR 0x0 | |
171 | #define SFMT_DEFERRED_ERROR 0x1 | |
172 | #define SFMT_VENDOR_DEPENDENT_STATUS 0x3 | |
173 | ||
174 | #define SBP2_SCSI_STATUS_GOOD 0x0 | |
175 | #define SBP2_SCSI_STATUS_CHECK_CONDITION 0x2 | |
176 | #define SBP2_SCSI_STATUS_CONDITION_MET 0x4 | |
177 | #define SBP2_SCSI_STATUS_BUSY 0x8 | |
178 | #define SBP2_SCSI_STATUS_RESERVATION_CONFLICT 0x18 | |
179 | #define SBP2_SCSI_STATUS_COMMAND_TERMINATED 0x22 | |
180 | ||
181 | #define SBP2_SCSI_STATUS_SELECTION_TIMEOUT 0xff | |
182 | ||
183 | #define STATUS_GET_ORB_OFFSET_HI(value) (value & 0xffff) | |
184 | #define STATUS_GET_SBP_STATUS(value) ((value >> 16) & 0xff) | |
185 | #define STATUS_GET_LENGTH(value) ((value >> 24) & 0x7) | |
186 | #define STATUS_GET_DEAD_BIT(value) ((value >> 27) & 0x1) | |
187 | #define STATUS_GET_RESP(value) ((value >> 28) & 0x3) | |
188 | #define STATUS_GET_SRC(value) ((value >> 30) & 0x3) | |
189 | ||
190 | struct sbp2_status_block { | |
191 | u32 ORB_offset_hi_misc; | |
192 | u32 ORB_offset_lo; | |
a237f35f | 193 | u8 command_set_dependent[24]; |
1da177e4 LT |
194 | }; |
195 | ||
196 | /* | |
197 | * Miscellaneous SBP2 related config rom defines | |
198 | */ | |
199 | ||
1da177e4 LT |
200 | #define SBP2_UNIT_DIRECTORY_OFFSET_KEY 0xd1 |
201 | #define SBP2_CSR_OFFSET_KEY 0x54 | |
202 | #define SBP2_UNIT_SPEC_ID_KEY 0x12 | |
203 | #define SBP2_UNIT_SW_VERSION_KEY 0x13 | |
204 | #define SBP2_COMMAND_SET_SPEC_ID_KEY 0x38 | |
205 | #define SBP2_COMMAND_SET_KEY 0x39 | |
206 | #define SBP2_UNIT_CHARACTERISTICS_KEY 0x3a | |
207 | #define SBP2_DEVICE_TYPE_AND_LUN_KEY 0x14 | |
208 | #define SBP2_FIRMWARE_REVISION_KEY 0x3c | |
209 | ||
1da177e4 LT |
210 | #define SBP2_AGENT_STATE_OFFSET 0x00ULL |
211 | #define SBP2_AGENT_RESET_OFFSET 0x04ULL | |
212 | #define SBP2_ORB_POINTER_OFFSET 0x08ULL | |
213 | #define SBP2_DOORBELL_OFFSET 0x10ULL | |
214 | #define SBP2_UNSOLICITED_STATUS_ENABLE_OFFSET 0x14ULL | |
215 | #define SBP2_UNSOLICITED_STATUS_VALUE 0xf | |
216 | ||
217 | #define SBP2_BUSY_TIMEOUT_ADDRESS 0xfffff0000210ULL | |
218 | #define SBP2_BUSY_TIMEOUT_VALUE 0xf | |
219 | ||
220 | #define SBP2_AGENT_RESET_DATA 0xf | |
221 | ||
222 | /* | |
223 | * Unit spec id and sw version entry for SBP-2 devices | |
224 | */ | |
225 | ||
226 | #define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e | |
227 | #define SBP2_SW_VERSION_ENTRY 0x00010483 | |
228 | ||
1da177e4 LT |
229 | /* |
230 | * SCSI specific stuff | |
231 | */ | |
232 | ||
233 | #define SBP2_MAX_SG_ELEMENT_LENGTH 0xf000 | |
1da177e4 | 234 | #define SBP2_MAX_SECTORS 255 /* Max sectors supported */ |
43863eba | 235 | #define SBP2_MAX_CMDS 8 /* This should be safe */ |
1da177e4 | 236 | |
24d3bf88 SR |
237 | /* Flags for detected oddities and brokeness */ |
238 | #define SBP2_WORKAROUND_128K_MAX_TRANS 0x1 | |
239 | #define SBP2_WORKAROUND_INQUIRY_36 0x2 | |
240 | #define SBP2_WORKAROUND_MODE_SENSE_8 0x4 | |
e9a1c52c | 241 | #define SBP2_WORKAROUND_FIX_CAPACITY 0x8 |
24d3bf88 | 242 | |
1da177e4 LT |
243 | /* This is the two dma types we use for cmd_dma below */ |
244 | enum cmd_dma_types { | |
245 | CMD_DMA_NONE, | |
246 | CMD_DMA_PAGE, | |
247 | CMD_DMA_SINGLE | |
248 | }; | |
249 | ||
250 | /* | |
251 | * Encapsulates all the info necessary for an outstanding command. | |
252 | */ | |
253 | struct sbp2_command_info { | |
254 | ||
255 | struct list_head list; | |
256 | struct sbp2_command_orb command_orb ____cacheline_aligned; | |
257 | dma_addr_t command_orb_dma ____cacheline_aligned; | |
258 | struct scsi_cmnd *Current_SCpnt; | |
259 | void (*Current_done)(struct scsi_cmnd *); | |
260 | ||
261 | /* Also need s/g structure for each sbp2 command */ | |
262 | struct sbp2_unrestricted_page_table scatter_gather_element[SG_ALL] ____cacheline_aligned; | |
263 | dma_addr_t sge_dma ____cacheline_aligned; | |
264 | void *sge_buffer; | |
265 | dma_addr_t cmd_dma; | |
266 | enum cmd_dma_types dma_type; | |
267 | unsigned long dma_size; | |
268 | int dma_dir; | |
269 | ||
270 | }; | |
271 | ||
1da177e4 LT |
272 | struct sbp2scsi_host_info; |
273 | ||
1da177e4 LT |
274 | /* |
275 | * Information needed on a per scsi id basis (one for each sbp2 device) | |
276 | */ | |
277 | struct scsi_id_instance_data { | |
278 | /* | |
279 | * Various sbp2 specific structures | |
280 | */ | |
281 | struct sbp2_command_orb *last_orb; | |
282 | dma_addr_t last_orb_dma; | |
283 | struct sbp2_login_orb *login_orb; | |
284 | dma_addr_t login_orb_dma; | |
285 | struct sbp2_login_response *login_response; | |
286 | dma_addr_t login_response_dma; | |
287 | struct sbp2_query_logins_orb *query_logins_orb; | |
288 | dma_addr_t query_logins_orb_dma; | |
289 | struct sbp2_query_logins_response *query_logins_response; | |
290 | dma_addr_t query_logins_response_dma; | |
291 | struct sbp2_reconnect_orb *reconnect_orb; | |
292 | dma_addr_t reconnect_orb_dma; | |
293 | struct sbp2_logout_orb *logout_orb; | |
294 | dma_addr_t logout_orb_dma; | |
295 | struct sbp2_status_block status_block; | |
296 | ||
297 | /* | |
298 | * Stuff we need to know about the sbp2 device itself | |
299 | */ | |
300 | u64 sbp2_management_agent_addr; | |
301 | u64 sbp2_command_block_agent_addr; | |
302 | u32 speed_code; | |
303 | u32 max_payload_size; | |
304 | ||
305 | /* | |
306 | * Values pulled from the device's unit directory | |
307 | */ | |
308 | u32 sbp2_command_set_spec_id; | |
309 | u32 sbp2_command_set; | |
310 | u32 sbp2_unit_characteristics; | |
e309fc6d | 311 | u32 sbp2_lun; |
1da177e4 LT |
312 | u32 sbp2_firmware_revision; |
313 | ||
35bdddb8 SR |
314 | /* |
315 | * Address for the device to write status blocks to | |
316 | */ | |
317 | u64 status_fifo_addr; | |
318 | ||
1da177e4 LT |
319 | /* |
320 | * Variable used for logins, reconnects, logouts, query logins | |
321 | */ | |
322 | atomic_t sbp2_login_complete; | |
323 | ||
324 | /* | |
325 | * Pool of command orbs, so we can have more than overlapped command per id | |
326 | */ | |
327 | spinlock_t sbp2_command_orb_lock; | |
328 | struct list_head sbp2_command_orb_inuse; | |
329 | struct list_head sbp2_command_orb_completed; | |
330 | ||
331 | struct list_head scsi_list; | |
332 | ||
333 | /* Node entry, as retrieved from NodeMgr entries */ | |
334 | struct node_entry *ne; | |
335 | struct unit_directory *ud; | |
336 | ||
337 | /* A backlink to our host_info */ | |
338 | struct sbp2scsi_host_info *hi; | |
339 | ||
340 | /* SCSI related pointers */ | |
341 | struct scsi_device *sdev; | |
342 | struct Scsi_Host *scsi_host; | |
343 | ||
344 | /* Device specific workarounds/brokeness */ | |
24d3bf88 | 345 | unsigned workarounds; |
1da177e4 LT |
346 | }; |
347 | ||
1da177e4 LT |
348 | /* Sbp2 host data structure (one per IEEE1394 host) */ |
349 | struct sbp2scsi_host_info { | |
350 | struct hpsb_host *host; /* IEEE1394 host */ | |
351 | struct list_head scsi_ids; /* List of scsi ids on this host */ | |
352 | }; | |
353 | ||
354 | /* | |
355 | * Function prototypes | |
356 | */ | |
357 | ||
358 | /* | |
359 | * Various utility prototypes | |
360 | */ | |
361 | static int sbp2util_create_command_orb_pool(struct scsi_id_instance_data *scsi_id); | |
362 | static void sbp2util_remove_command_orb_pool(struct scsi_id_instance_data *scsi_id); | |
363 | static struct sbp2_command_info *sbp2util_find_command_for_orb(struct scsi_id_instance_data *scsi_id, dma_addr_t orb); | |
364 | static struct sbp2_command_info *sbp2util_find_command_for_SCpnt(struct scsi_id_instance_data *scsi_id, void *SCpnt); | |
365 | static struct sbp2_command_info *sbp2util_allocate_command_orb(struct scsi_id_instance_data *scsi_id, | |
366 | struct scsi_cmnd *Current_SCpnt, | |
367 | void (*Current_done)(struct scsi_cmnd *)); | |
368 | static void sbp2util_mark_command_completed(struct scsi_id_instance_data *scsi_id, | |
369 | struct sbp2_command_info *command); | |
370 | ||
371 | ||
372 | static int sbp2_start_device(struct scsi_id_instance_data *scsi_id); | |
373 | static void sbp2_remove_device(struct scsi_id_instance_data *scsi_id); | |
374 | ||
375 | #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA | |
376 | static int sbp2_handle_physdma_write(struct hpsb_host *host, int nodeid, int destid, quadlet_t *data, | |
377 | u64 addr, size_t length, u16 flags); | |
378 | static int sbp2_handle_physdma_read(struct hpsb_host *host, int nodeid, quadlet_t *data, | |
379 | u64 addr, size_t length, u16 flags); | |
380 | #endif | |
381 | ||
382 | /* | |
383 | * SBP-2 protocol related prototypes | |
384 | */ | |
385 | static int sbp2_query_logins(struct scsi_id_instance_data *scsi_id); | |
386 | static int sbp2_login_device(struct scsi_id_instance_data *scsi_id); | |
387 | static int sbp2_reconnect_device(struct scsi_id_instance_data *scsi_id); | |
388 | static int sbp2_logout_device(struct scsi_id_instance_data *scsi_id); | |
389 | static int sbp2_handle_status_write(struct hpsb_host *host, int nodeid, int destid, | |
390 | quadlet_t *data, u64 addr, size_t length, u16 flags); | |
391 | static int sbp2_agent_reset(struct scsi_id_instance_data *scsi_id, int wait); | |
1da177e4 LT |
392 | static int sbp2_link_orb_command(struct scsi_id_instance_data *scsi_id, |
393 | struct sbp2_command_info *command); | |
394 | static int sbp2_send_command(struct scsi_id_instance_data *scsi_id, | |
395 | struct scsi_cmnd *SCpnt, | |
396 | void (*done)(struct scsi_cmnd *)); | |
397 | static unsigned int sbp2_status_to_sense_data(unchar *sbp2_status, unchar *sense_data); | |
1da177e4 LT |
398 | static void sbp2_check_sbp2_response(struct scsi_id_instance_data *scsi_id, |
399 | struct scsi_cmnd *SCpnt); | |
400 | static void sbp2_parse_unit_directory(struct scsi_id_instance_data *scsi_id, | |
401 | struct unit_directory *ud); | |
402 | static int sbp2_set_busy_timeout(struct scsi_id_instance_data *scsi_id); | |
403 | static int sbp2_max_speed_and_size(struct scsi_id_instance_data *scsi_id); | |
404 | ||
405 | #endif /* SBP2_H */ |