2 * sbp2.h - Defines and prototypes for sbp2.c
4 * Copyright (C) 2000 James Goodwin, Filanet Corporation (www.filanet.com)
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.
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.
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.
25 #define SBP2_DEVICE_NAME "sbp2"
28 * SBP2 specific structures and defines
31 #define ORB_DIRECTION_WRITE_TO_MEDIA 0x0
32 #define ORB_DIRECTION_READ_FROM_MEDIA 0x1
33 #define ORB_DIRECTION_NO_DATA_TRANSFER 0x2
35 #define ORB_SET_NULL_PTR(value) ((value & 0x1) << 31)
36 #define ORB_SET_NOTIFY(value) ((value & 0x1) << 31)
37 #define ORB_SET_RQ_FMT(value) ((value & 0x3) << 29) /* unused ? */
38 #define ORB_SET_NODE_ID(value) ((value & 0xffff) << 16)
39 #define ORB_SET_DATA_SIZE(value) (value & 0xffff)
40 #define ORB_SET_PAGE_SIZE(value) ((value & 0x7) << 16)
41 #define ORB_SET_PAGE_TABLE_PRESENT(value) ((value & 0x1) << 19)
42 #define ORB_SET_MAX_PAYLOAD(value) ((value & 0xf) << 20)
43 #define ORB_SET_SPEED(value) ((value & 0x7) << 24)
44 #define ORB_SET_DIRECTION(value) ((value & 0x1) << 27)
46 struct sbp2_command_orb {
47 volatile u32 next_ORB_hi;
48 volatile u32 next_ORB_lo;
49 u32 data_descriptor_hi;
50 u32 data_descriptor_lo;
55 #define LOGIN_REQUEST 0x0
56 #define QUERY_LOGINS_REQUEST 0x1
57 #define RECONNECT_REQUEST 0x3
58 #define SET_PASSWORD_REQUEST 0x4
59 #define LOGOUT_REQUEST 0x7
60 #define ABORT_TASK_REQUEST 0xb
61 #define ABORT_TASK_SET 0xc
62 #define LOGICAL_UNIT_RESET 0xe
63 #define TARGET_RESET_REQUEST 0xf
65 #define ORB_SET_LUN(value) (value & 0xffff)
66 #define ORB_SET_FUNCTION(value) ((value & 0xf) << 16)
67 #define ORB_SET_RECONNECT(value) ((value & 0xf) << 20)
68 #define ORB_SET_EXCLUSIVE(value) ((value & 0x1) << 28)
69 #define ORB_SET_LOGIN_RESP_LENGTH(value) (value & 0xffff)
70 #define ORB_SET_PASSWD_LENGTH(value) ((value & 0xffff) << 16)
72 struct sbp2_login_orb {
75 u32 login_response_hi;
76 u32 login_response_lo;
78 u32 passwd_resp_lengths;
83 #define RESPONSE_GET_LOGIN_ID(value) (value & 0xffff)
84 #define RESPONSE_GET_LENGTH(value) ((value >> 16) & 0xffff)
85 #define RESPONSE_GET_RECONNECT_HOLD(value) (value & 0xffff)
87 struct sbp2_login_response {
89 u32 command_block_agent_hi;
90 u32 command_block_agent_lo;
94 #define ORB_SET_LOGIN_ID(value) (value & 0xffff)
96 #define ORB_SET_QUERY_LOGINS_RESP_LENGTH(value) (value & 0xffff)
98 struct sbp2_query_logins_orb {
101 u32 query_response_hi;
102 u32 query_response_lo;
104 u32 reserved_resp_length;
109 #define RESPONSE_GET_MAX_LOGINS(value) (value & 0xffff)
110 #define RESPONSE_GET_ACTIVE_LOGINS(value) ((RESPONSE_GET_LENGTH(value) - 4) / 12)
112 struct sbp2_query_logins_response {
113 u32 length_max_logins;
115 u32 initiator_misc_hi;
116 u32 initiator_misc_lo;
119 struct sbp2_reconnect_orb {
130 struct sbp2_logout_orb {
141 #define PAGE_TABLE_SET_SEGMENT_BASE_HI(value) (value & 0xffff)
142 #define PAGE_TABLE_SET_SEGMENT_LENGTH(value) ((value & 0xffff) << 16)
144 struct sbp2_unrestricted_page_table {
145 u32 length_segment_base_hi;
149 #define RESP_STATUS_REQUEST_COMPLETE 0x0
150 #define RESP_STATUS_TRANSPORT_FAILURE 0x1
151 #define RESP_STATUS_ILLEGAL_REQUEST 0x2
152 #define RESP_STATUS_VENDOR_DEPENDENT 0x3
154 #define SBP2_STATUS_NO_ADDITIONAL_INFO 0x0
155 #define SBP2_STATUS_REQ_TYPE_NOT_SUPPORTED 0x1
156 #define SBP2_STATUS_SPEED_NOT_SUPPORTED 0x2
157 #define SBP2_STATUS_PAGE_SIZE_NOT_SUPPORTED 0x3
158 #define SBP2_STATUS_ACCESS_DENIED 0x4
159 #define SBP2_STATUS_LU_NOT_SUPPORTED 0x5
160 #define SBP2_STATUS_MAX_PAYLOAD_TOO_SMALL 0x6
161 #define SBP2_STATUS_RESOURCES_UNAVAILABLE 0x8
162 #define SBP2_STATUS_FUNCTION_REJECTED 0x9
163 #define SBP2_STATUS_LOGIN_ID_NOT_RECOGNIZED 0xa
164 #define SBP2_STATUS_DUMMY_ORB_COMPLETED 0xb
165 #define SBP2_STATUS_REQUEST_ABORTED 0xc
166 #define SBP2_STATUS_UNSPECIFIED_ERROR 0xff
168 #define SFMT_CURRENT_ERROR 0x0
169 #define SFMT_DEFERRED_ERROR 0x1
170 #define SFMT_VENDOR_DEPENDENT_STATUS 0x3
172 #define SBP2_SCSI_STATUS_GOOD 0x0
173 #define SBP2_SCSI_STATUS_CHECK_CONDITION 0x2
174 #define SBP2_SCSI_STATUS_CONDITION_MET 0x4
175 #define SBP2_SCSI_STATUS_BUSY 0x8
176 #define SBP2_SCSI_STATUS_RESERVATION_CONFLICT 0x18
177 #define SBP2_SCSI_STATUS_COMMAND_TERMINATED 0x22
179 #define SBP2_SCSI_STATUS_SELECTION_TIMEOUT 0xff
181 #define STATUS_GET_ORB_OFFSET_HI(value) (value & 0xffff)
182 #define STATUS_GET_SBP_STATUS(value) ((value >> 16) & 0xff)
183 #define STATUS_GET_LENGTH(value) ((value >> 24) & 0x7)
184 #define STATUS_GET_DEAD_BIT(value) ((value >> 27) & 0x1)
185 #define STATUS_GET_RESP(value) ((value >> 28) & 0x3)
186 #define STATUS_GET_SRC(value) ((value >> 30) & 0x3)
188 struct sbp2_status_block {
189 u32 ORB_offset_hi_misc;
191 u8 command_set_dependent[24];
195 * Miscellaneous SBP2 related config rom defines
199 * The status fifo address definition below is used as a status base, with a chunk
200 * separately assigned for each sbp2 device detected. For example, 0xfffe00000000ULL
201 * is used for the first sbp2 device detected, 0xfffe00000020ULL for the next sbp2
204 * Note: We could use a single status fifo address for all sbp2 devices, and figure
205 * out which sbp2 device the status belongs to by looking at the source node id of
206 * the status write... but, using separate addresses for each sbp2 device allows for
207 * better code and the ability to support multiple luns within a single 1394 node.
209 * Also note that we choose the address range below as it is a region specified for
210 * write posting, where the ohci controller will automatically send an ack_complete
211 * when the status is written by the sbp2 device... saving a split transaction. =)
213 #define SBP2_STATUS_FIFO_ADDRESS 0xfffe00000000ULL
214 #define SBP2_STATUS_FIFO_ADDRESS_HI 0xfffe
215 #define SBP2_STATUS_FIFO_ADDRESS_LO 0x0
217 #define SBP2_STATUS_FIFO_ENTRY_TO_OFFSET(entry) ((entry) << 5)
218 #define SBP2_STATUS_FIFO_OFFSET_TO_ENTRY(offset) ((offset) >> 5)
220 #define SBP2_UNIT_DIRECTORY_OFFSET_KEY 0xd1
221 #define SBP2_CSR_OFFSET_KEY 0x54
222 #define SBP2_UNIT_SPEC_ID_KEY 0x12
223 #define SBP2_UNIT_SW_VERSION_KEY 0x13
224 #define SBP2_COMMAND_SET_SPEC_ID_KEY 0x38
225 #define SBP2_COMMAND_SET_KEY 0x39
226 #define SBP2_UNIT_CHARACTERISTICS_KEY 0x3a
227 #define SBP2_DEVICE_TYPE_AND_LUN_KEY 0x14
228 #define SBP2_FIRMWARE_REVISION_KEY 0x3c
230 #define SBP2_DEVICE_TYPE(q) (((q) >> 16) & 0x1f)
231 #define SBP2_DEVICE_LUN(q) ((q) & 0xffff)
233 #define SBP2_AGENT_STATE_OFFSET 0x00ULL
234 #define SBP2_AGENT_RESET_OFFSET 0x04ULL
235 #define SBP2_ORB_POINTER_OFFSET 0x08ULL
236 #define SBP2_DOORBELL_OFFSET 0x10ULL
237 #define SBP2_UNSOLICITED_STATUS_ENABLE_OFFSET 0x14ULL
238 #define SBP2_UNSOLICITED_STATUS_VALUE 0xf
240 #define SBP2_BUSY_TIMEOUT_ADDRESS 0xfffff0000210ULL
241 #define SBP2_BUSY_TIMEOUT_VALUE 0xf
243 #define SBP2_AGENT_RESET_DATA 0xf
246 * Unit spec id and sw version entry for SBP-2 devices
249 #define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e
250 #define SBP2_SW_VERSION_ENTRY 0x00010483
255 #define SBP2_128KB_BROKEN_FIRMWARE 0xa0b800
257 #define SBP2_DEVICE_TYPE_LUN_UNINITIALIZED 0xffffffff
260 * SCSI specific stuff
263 #define SBP2_MAX_SG_ELEMENT_LENGTH 0xf000
264 #define SBP2SCSI_MAX_SCSI_IDS 32 /* Max sbp2 device instances supported */
265 #define SBP2_MAX_SECTORS 255 /* Max sectors supported */
268 #define TYPE_SDAD 0x0e /* simplified direct access device */
272 * SCSI direction table...
273 * (now used as a back-up in case the direction passed down from above is "unknown")
275 * DIN = IN data direction
276 * DOU = OUT data direction
277 * DNO = No data transfer
278 * DUN = Unknown data direction
280 * Opcode 0xec (Teac specific "opc execute") possibly should be DNO,
281 * but we'll change it when somebody reports a problem with this.
283 #define DIN ORB_DIRECTION_READ_FROM_MEDIA
284 #define DOU ORB_DIRECTION_WRITE_TO_MEDIA
285 #define DNO ORB_DIRECTION_NO_DATA_TRANSFER
288 static unchar sbp2scsi_direction_table[0x100] = {
289 DNO,DNO,DIN,DIN,DOU,DIN,DIN,DOU,DIN,DUN,DOU,DOU,DUN,DUN,DUN,DIN,
290 DNO,DIN,DIN,DOU,DIN,DOU,DNO,DNO,DOU,DNO,DIN,DNO,DIN,DOU,DNO,DUN,
291 DIN,DUN,DIN,DIN,DOU,DIN,DUN,DUN,DIN,DIN,DOU,DNO,DUN,DIN,DOU,DOU,
292 DOU,DOU,DOU,DNO,DIN,DNO,DNO,DIN,DOU,DOU,DOU,DOU,DIN,DOU,DIN,DOU,
293 DOU,DOU,DIN,DIN,DIN,DNO,DIN,DNO,DNO,DNO,DUN,DNO,DOU,DIN,DNO,DUN,
294 DUN,DIN,DIN,DNO,DNO,DOU,DUN,DUN,DNO,DIN,DIN,DNO,DIN,DOU,DUN,DUN,
295 DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,
296 DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,
297 DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,
298 DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,
299 DUN,DNO,DOU,DOU,DIN,DNO,DNO,DNO,DIN,DNO,DOU,DUN,DNO,DIN,DOU,DOU,
300 DOU,DOU,DOU,DNO,DUN,DIN,DOU,DIN,DIN,DIN,DNO,DNO,DNO,DIN,DIN,DUN,
301 DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,
302 DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,
303 DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DOU,DUN,DUN,DUN,DUN,DUN,
304 DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN
307 /* This should be safe. If there's more than one LUN per node, we could
308 * saturate the tlabel's though. */
309 #define SBP2_MAX_CMDS_PER_LUN 8
310 #define SBP2_MAX_SCSI_QUEUE (SBP2_MAX_CMDS_PER_LUN * SBP2SCSI_MAX_SCSI_IDS)
311 #define SBP2_MAX_COMMAND_ORBS SBP2_MAX_SCSI_QUEUE
313 /* This is the two dma types we use for cmd_dma below */
321 * Encapsulates all the info necessary for an outstanding command.
323 struct sbp2_command_info {
325 struct list_head list;
326 struct sbp2_command_orb command_orb ____cacheline_aligned;
327 dma_addr_t command_orb_dma ____cacheline_aligned;
328 Scsi_Cmnd *Current_SCpnt;
329 void (*Current_done)(Scsi_Cmnd *);
331 /* Also need s/g structure for each sbp2 command */
332 struct sbp2_unrestricted_page_table scatter_gather_element[SG_ALL] ____cacheline_aligned;
333 dma_addr_t sge_dma ____cacheline_aligned;
336 enum cmd_dma_types dma_type;
337 unsigned long dma_size;
342 /* A list of flags for detected oddities and brokeness. */
343 #define SBP2_BREAKAGE_128K_MAX_TRANSFER 0x1
344 #define SBP2_BREAKAGE_INQUIRY_HACK 0x2
347 struct sbp2scsi_host_info;
351 * Information needed on a per scsi id basis (one for each sbp2 device)
353 struct scsi_id_instance_data {
358 * Various sbp2 specific structures
360 struct sbp2_command_orb *last_orb;
361 dma_addr_t last_orb_dma;
362 struct sbp2_login_orb *login_orb;
363 dma_addr_t login_orb_dma;
364 struct sbp2_login_response *login_response;
365 dma_addr_t login_response_dma;
366 struct sbp2_query_logins_orb *query_logins_orb;
367 dma_addr_t query_logins_orb_dma;
368 struct sbp2_query_logins_response *query_logins_response;
369 dma_addr_t query_logins_response_dma;
370 struct sbp2_reconnect_orb *reconnect_orb;
371 dma_addr_t reconnect_orb_dma;
372 struct sbp2_logout_orb *logout_orb;
373 dma_addr_t logout_orb_dma;
374 struct sbp2_status_block status_block;
377 * Stuff we need to know about the sbp2 device itself
379 u64 sbp2_management_agent_addr;
380 u64 sbp2_command_block_agent_addr;
382 u32 max_payload_size;
385 * Values pulled from the device's unit directory
387 u32 sbp2_command_set_spec_id;
388 u32 sbp2_command_set;
389 u32 sbp2_unit_characteristics;
390 u32 sbp2_device_type_and_lun;
391 u32 sbp2_firmware_revision;
394 * Variable used for logins, reconnects, logouts, query logins
396 atomic_t sbp2_login_complete;
399 * Pool of command orbs, so we can have more than overlapped command per id
401 spinlock_t sbp2_command_orb_lock;
402 struct list_head sbp2_command_orb_inuse;
403 struct list_head sbp2_command_orb_completed;
405 struct list_head list;
407 /* Node entry, as retrieved from NodeMgr entries */
408 struct node_entry *ne;
410 /* A backlink to our host_info */
411 struct sbp2scsi_host_info *hi;
413 /* Device specific workarounds/brokeness */
418 /* Describes a per-ud scsi_id group */
419 struct scsi_id_group {
420 struct list_head scsi_id_list;
425 * Sbp2 host data structure (one per sbp2 host)
427 struct sbp2scsi_host_info {
428 struct hpsb_host *host;
431 * Spin locks for command processing
433 spinlock_t sbp2_command_lock;
436 * This is the scsi host we register with the scsi mid level.
437 * We keep a reference to it here, so we can unregister it
438 * when the hpsb_host is removed.
440 struct Scsi_Host *scsi_host;
443 * SCSI ID instance data (one for each sbp2 device instance possible)
445 struct scsi_id_instance_data *scsi_id[SBP2SCSI_MAX_SCSI_IDS];
449 * Function prototypes
453 * Various utility prototypes
455 static int sbp2util_create_command_orb_pool(struct scsi_id_instance_data *scsi_id);
456 static void sbp2util_remove_command_orb_pool(struct scsi_id_instance_data *scsi_id);
457 static struct sbp2_command_info *sbp2util_find_command_for_orb(struct scsi_id_instance_data *scsi_id, dma_addr_t orb);
458 static struct sbp2_command_info *sbp2util_find_command_for_SCpnt(struct scsi_id_instance_data *scsi_id, void *SCpnt);
459 static struct sbp2_command_info *sbp2util_allocate_command_orb(struct scsi_id_instance_data *scsi_id,
460 Scsi_Cmnd *Current_SCpnt,
461 void (*Current_done)(Scsi_Cmnd *));
462 static void sbp2util_mark_command_completed(struct scsi_id_instance_data *scsi_id,
463 struct sbp2_command_info *command);
466 * IEEE-1394 core driver related prototypes
468 static struct sbp2scsi_host_info *sbp2_add_host(struct hpsb_host *host);
469 static void sbp2_remove_host(struct hpsb_host *host);
471 static int sbp2_probe(struct device *dev);
472 static int sbp2_remove(struct device *dev);
473 static void sbp2_update(struct unit_directory *ud);
475 static int sbp2_start_ud(struct sbp2scsi_host_info *hi,
476 struct unit_directory *ud);
477 static int sbp2_start_device(struct scsi_id_instance_data *scsi_id);
478 static void sbp2_remove_device(struct scsi_id_instance_data *scsi_id);
480 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
481 static int sbp2_handle_physdma_write(struct hpsb_host *host, int nodeid, int destid, quadlet_t *data,
482 u64 addr, size_t length, u16 flags);
483 static int sbp2_handle_physdma_read(struct hpsb_host *host, int nodeid, quadlet_t *data,
484 u64 addr, size_t length, u16 flags);
488 * SBP-2 protocol related prototypes
490 static int sbp2_query_logins(struct scsi_id_instance_data *scsi_id);
491 static int sbp2_login_device(struct scsi_id_instance_data *scsi_id);
492 static int sbp2_reconnect_device(struct scsi_id_instance_data *scsi_id);
493 static int sbp2_logout_device(struct scsi_id_instance_data *scsi_id);
494 static int sbp2_handle_status_write(struct hpsb_host *host, int nodeid, int destid,
495 quadlet_t *data, u64 addr, size_t length, u16 flags);
496 static int sbp2_agent_reset(struct scsi_id_instance_data *scsi_id, int wait);
497 static int sbp2_create_command_orb(struct scsi_id_instance_data *scsi_id,
498 struct sbp2_command_info *command,
500 unsigned int scsi_use_sg,
501 unsigned int scsi_request_bufflen,
502 void *scsi_request_buffer,
503 unsigned char scsi_dir);
504 static int sbp2_link_orb_command(struct scsi_id_instance_data *scsi_id,
505 struct sbp2_command_info *command);
506 static int sbp2_send_command(struct scsi_id_instance_data *scsi_id,
507 Scsi_Cmnd *SCpnt, void (*done)(Scsi_Cmnd *));
508 static unsigned int sbp2_status_to_sense_data(unchar *sbp2_status, unchar *sense_data);
509 static void sbp2_check_sbp2_command(struct scsi_id_instance_data *scsi_id, unchar *cmd);
510 static void sbp2_check_sbp2_response(struct scsi_id_instance_data *scsi_id, Scsi_Cmnd *SCpnt);
511 static void sbp2_parse_unit_directory(struct scsi_id_group *scsi_group,
512 struct unit_directory *ud);
513 static int sbp2_set_busy_timeout(struct scsi_id_instance_data *scsi_id);
514 static int sbp2_max_speed_and_size(struct scsi_id_instance_data *scsi_id);