/drivers/ieee1394/sbp2.h
C Header | 484 lines | 308 code | 73 blank | 103 comment | 0 complexity | df250fbfb41f76d99892f9025b64d6f8 MD5 | raw file
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) 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) 45 46struct 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; 51 u32 misc; 52 u8 cdb[12]; 53}; 54 55#define SBP2_LOGIN_REQUEST 0x0 56#define SBP2_QUERY_LOGINS_REQUEST 0x1 57#define SBP2_RECONNECT_REQUEST 0x3 58#define SBP2_SET_PASSWORD_REQUEST 0x4 59#define SBP2_LOGOUT_REQUEST 0x7 60#define SBP2_ABORT_TASK_REQUEST 0xb 61#define SBP2_ABORT_TASK_SET 0xc 62#define SBP2_LOGICAL_UNIT_RESET 0xe 63#define SBP2_TARGET_RESET_REQUEST 0xf 64 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) 71 72struct sbp2_login_orb { 73 u32 password_hi; 74 u32 password_lo; 75 u32 login_response_hi; 76 u32 login_response_lo; 77 u32 lun_misc; 78 u32 passwd_resp_lengths; 79 u32 status_FIFO_hi; 80 u32 status_FIFO_lo; 81}; 82 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) 86 87struct sbp2_login_response { 88 u32 length_login_ID; 89 u32 command_block_agent_hi; 90 u32 command_block_agent_lo; 91 u32 reconnect_hold; 92}; 93 94#define ORB_SET_LOGIN_ID(value) (value & 0xffff) 95 96#define ORB_SET_QUERY_LOGINS_RESP_LENGTH(value) (value & 0xffff) 97 98struct sbp2_query_logins_orb { 99 u32 reserved1; 100 u32 reserved2; 101 u32 query_response_hi; 102 u32 query_response_lo; 103 u32 lun_misc; 104 u32 reserved_resp_length; 105 u32 status_FIFO_hi; 106 u32 status_FIFO_lo; 107}; 108 109#define RESPONSE_GET_MAX_LOGINS(value) (value & 0xffff) 110#define RESPONSE_GET_ACTIVE_LOGINS(value) ((RESPONSE_GET_LENGTH(value) - 4) / 12) 111 112struct sbp2_query_logins_response { 113 u32 length_max_logins; 114 u32 misc_IDs; 115 u32 initiator_misc_hi; 116 u32 initiator_misc_lo; 117}; 118 119struct sbp2_reconnect_orb { 120 u32 reserved1; 121 u32 reserved2; 122 u32 reserved3; 123 u32 reserved4; 124 u32 login_ID_misc; 125 u32 reserved5; 126 u32 status_FIFO_hi; 127 u32 status_FIFO_lo; 128}; 129 130struct sbp2_logout_orb { 131 u32 reserved1; 132 u32 reserved2; 133 u32 reserved3; 134 u32 reserved4; 135 u32 login_ID_misc; 136 u32 reserved5; 137 u32 status_FIFO_hi; 138 u32 status_FIFO_lo; 139}; 140 141#define PAGE_TABLE_SET_SEGMENT_BASE_HI(value) (value & 0xffff) 142#define PAGE_TABLE_SET_SEGMENT_LENGTH(value) ((value & 0xffff) << 16) 143 144struct sbp2_unrestricted_page_table { 145 u32 length_segment_base_hi; 146 u32 segment_base_lo; 147}; 148 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 153 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 167 168#define SFMT_CURRENT_ERROR 0x0 169#define SFMT_DEFERRED_ERROR 0x1 170#define SFMT_VENDOR_DEPENDENT_STATUS 0x3 171 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 178 179#define SBP2_SCSI_STATUS_SELECTION_TIMEOUT 0xff 180 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) 187 188struct sbp2_status_block { 189 u32 ORB_offset_hi_misc; 190 u32 ORB_offset_lo; 191 u8 command_set_dependent[24]; 192}; 193 194/* 195 * Miscellaneous SBP2 related config rom defines 196 */ 197 198/* The status fifo address definition below is used as a base for each 199 * node, which a chunk seperately assigned to each unit directory in the 200 * node. For example, 0xfffe00000000ULL is used for the first sbp2 device 201 * detected on node 0, 0xfffe00000020ULL for the next sbp2 device on node 202 * 0, and so on. 203 * 204 * Note: We could use a single status fifo address for all sbp2 devices, 205 * and figure out which sbp2 device the status belongs to by looking at 206 * the source node id of the status write... but, using separate addresses 207 * for each sbp2 unit directory allows for better code and the ability to 208 * support multiple luns within a single 1394 node. 209 * 210 * Also note that we choose the address range below as it is a region 211 * specified for write posting, where the ohci controller will 212 * automatically send an ack_complete when the status is written by the 213 * sbp2 device... saving a split transaction. =) 214 */ 215#define SBP2_STATUS_FIFO_ADDRESS 0xfffe00000000ULL 216#define SBP2_STATUS_FIFO_ADDRESS_HI 0xfffe 217#define SBP2_STATUS_FIFO_ADDRESS_LO 0x0 218 219#define SBP2_STATUS_FIFO_ENTRY_TO_OFFSET(entry) ((entry) << 5) 220#define SBP2_STATUS_FIFO_OFFSET_TO_ENTRY(offset) ((offset) >> 5) 221 222#define SBP2_UNIT_DIRECTORY_OFFSET_KEY 0xd1 223#define SBP2_CSR_OFFSET_KEY 0x54 224#define SBP2_UNIT_SPEC_ID_KEY 0x12 225#define SBP2_UNIT_SW_VERSION_KEY 0x13 226#define SBP2_COMMAND_SET_SPEC_ID_KEY 0x38 227#define SBP2_COMMAND_SET_KEY 0x39 228#define SBP2_UNIT_CHARACTERISTICS_KEY 0x3a 229#define SBP2_DEVICE_TYPE_AND_LUN_KEY 0x14 230#define SBP2_FIRMWARE_REVISION_KEY 0x3c 231 232#define SBP2_DEVICE_TYPE(q) (((q) >> 16) & 0x1f) 233#define SBP2_DEVICE_LUN(q) ((q) & 0xffff) 234 235#define SBP2_AGENT_STATE_OFFSET 0x00ULL 236#define SBP2_AGENT_RESET_OFFSET 0x04ULL 237#define SBP2_ORB_POINTER_OFFSET 0x08ULL 238#define SBP2_DOORBELL_OFFSET 0x10ULL 239#define SBP2_UNSOLICITED_STATUS_ENABLE_OFFSET 0x14ULL 240#define SBP2_UNSOLICITED_STATUS_VALUE 0xf 241 242#define SBP2_BUSY_TIMEOUT_ADDRESS 0xfffff0000210ULL 243#define SBP2_BUSY_TIMEOUT_VALUE 0xf 244 245#define SBP2_AGENT_RESET_DATA 0xf 246 247/* 248 * Unit spec id and sw version entry for SBP-2 devices 249 */ 250 251#define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e 252#define SBP2_SW_VERSION_ENTRY 0x00010483 253 254/* 255 * Other misc defines 256 */ 257#define SBP2_128KB_BROKEN_FIRMWARE 0xa0b800 258 259#define SBP2_DEVICE_TYPE_LUN_UNINITIALIZED 0xffffffff 260 261/* 262 * SCSI specific stuff 263 */ 264 265#define SBP2_MAX_SG_ELEMENT_LENGTH 0xf000 266#define SBP2_MAX_UDS_PER_NODE 16 /* Maximum scsi devices per node */ 267#define SBP2_MAX_SECTORS 255 /* Max sectors supported */ 268 269#ifndef TYPE_SDAD 270#define TYPE_SDAD 0x0e /* simplified direct access device */ 271#endif 272 273/* 274 * SCSI direction table... 275 * (now used as a back-up in case the direction passed down from above is "unknown") 276 * 277 * DIN = IN data direction 278 * DOU = OUT data direction 279 * DNO = No data transfer 280 * DUN = Unknown data direction 281 * 282 * Opcode 0xec (Teac specific "opc execute") possibly should be DNO, 283 * but we'll change it when somebody reports a problem with this. 284 */ 285#define DIN ORB_DIRECTION_READ_FROM_MEDIA 286#define DOU ORB_DIRECTION_WRITE_TO_MEDIA 287#define DNO ORB_DIRECTION_NO_DATA_TRANSFER 288#define DUN DIN 289 290static unchar sbp2scsi_direction_table[0x100] = { 291 DNO,DNO,DIN,DIN,DOU,DIN,DIN,DOU,DIN,DUN,DOU,DOU,DUN,DUN,DUN,DIN, 292 DNO,DIN,DIN,DOU,DIN,DOU,DNO,DNO,DOU,DNO,DIN,DNO,DIN,DOU,DNO,DUN, 293 DIN,DUN,DIN,DIN,DOU,DIN,DUN,DUN,DIN,DIN,DOU,DNO,DUN,DIN,DOU,DOU, 294 DOU,DOU,DOU,DNO,DIN,DNO,DNO,DIN,DOU,DOU,DOU,DOU,DIN,DOU,DIN,DOU, 295 DOU,DOU,DIN,DIN,DIN,DNO,DIN,DNO,DNO,DNO,DUN,DNO,DOU,DIN,DNO,DUN, 296 DUN,DIN,DIN,DNO,DNO,DOU,DUN,DUN,DNO,DIN,DIN,DNO,DIN,DOU,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,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN, 300 DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN, 301 DUN,DNO,DOU,DOU,DIN,DNO,DNO,DNO,DIN,DNO,DOU,DUN,DNO,DIN,DOU,DOU, 302 DOU,DOU,DOU,DNO,DUN,DIN,DOU,DIN,DIN,DIN,DNO,DNO,DNO,DIN,DIN,DUN, 303 DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN, 304 DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN, 305 DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DOU,DUN,DUN,DUN,DUN,DUN, 306 DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN,DUN 307}; 308 309/* This should be safe */ 310#define SBP2_MAX_CMDS 8 311 312/* This is the two dma types we use for cmd_dma below */ 313enum cmd_dma_types { 314 CMD_DMA_NONE, 315 CMD_DMA_PAGE, 316 CMD_DMA_SINGLE 317}; 318 319/* 320 * Encapsulates all the info necessary for an outstanding command. 321 */ 322struct sbp2_command_info { 323 324 struct list_head list; 325 struct sbp2_command_orb command_orb ____cacheline_aligned; 326 dma_addr_t command_orb_dma ____cacheline_aligned; 327 struct scsi_cmnd *Current_SCpnt; 328 void (*Current_done)(struct scsi_cmnd *); 329 330 /* Also need s/g structure for each sbp2 command */ 331 struct sbp2_unrestricted_page_table scatter_gather_element[SG_ALL] ____cacheline_aligned; 332 dma_addr_t sge_dma ____cacheline_aligned; 333 void *sge_buffer; 334 dma_addr_t cmd_dma; 335 enum cmd_dma_types dma_type; 336 unsigned long dma_size; 337 int dma_dir; 338 339}; 340 341/* A list of flags for detected oddities and brokeness. */ 342#define SBP2_BREAKAGE_128K_MAX_TRANSFER 0x1 343#define SBP2_BREAKAGE_INQUIRY_HACK 0x2 344 345 346struct sbp2scsi_host_info; 347 348 349/* 350 * Information needed on a per scsi id basis (one for each sbp2 device) 351 */ 352struct scsi_id_instance_data { 353 /* 354 * Various sbp2 specific structures 355 */ 356 struct sbp2_command_orb *last_orb; 357 dma_addr_t last_orb_dma; 358 struct sbp2_login_orb *login_orb; 359 dma_addr_t login_orb_dma; 360 struct sbp2_login_response *login_response; 361 dma_addr_t login_response_dma; 362 struct sbp2_query_logins_orb *query_logins_orb; 363 dma_addr_t query_logins_orb_dma; 364 struct sbp2_query_logins_response *query_logins_response; 365 dma_addr_t query_logins_response_dma; 366 struct sbp2_reconnect_orb *reconnect_orb; 367 dma_addr_t reconnect_orb_dma; 368 struct sbp2_logout_orb *logout_orb; 369 dma_addr_t logout_orb_dma; 370 struct sbp2_status_block status_block; 371 372 /* 373 * Stuff we need to know about the sbp2 device itself 374 */ 375 u64 sbp2_management_agent_addr; 376 u64 sbp2_command_block_agent_addr; 377 u32 speed_code; 378 u32 max_payload_size; 379 380 /* 381 * Values pulled from the device's unit directory 382 */ 383 u32 sbp2_command_set_spec_id; 384 u32 sbp2_command_set; 385 u32 sbp2_unit_characteristics; 386 u32 sbp2_device_type_and_lun; 387 u32 sbp2_firmware_revision; 388 389 /* 390 * Variable used for logins, reconnects, logouts, query logins 391 */ 392 atomic_t sbp2_login_complete; 393 394 /* 395 * Pool of command orbs, so we can have more than overlapped command per id 396 */ 397 spinlock_t sbp2_command_orb_lock; 398 struct list_head sbp2_command_orb_inuse; 399 struct list_head sbp2_command_orb_completed; 400 401 struct list_head scsi_list; 402 403 /* Node entry, as retrieved from NodeMgr entries */ 404 struct node_entry *ne; 405 struct unit_directory *ud; 406 407 /* A backlink to our host_info */ 408 struct sbp2scsi_host_info *hi; 409 410 /* SCSI related pointers */ 411 struct scsi_device *sdev; 412 struct Scsi_Host *scsi_host; 413 414 /* Device specific workarounds/brokeness */ 415 u32 workarounds; 416}; 417 418 419/* Sbp2 host data structure (one per IEEE1394 host) */ 420struct sbp2scsi_host_info { 421 struct hpsb_host *host; /* IEEE1394 host */ 422 struct list_head scsi_ids; /* List of scsi ids on this host */ 423}; 424 425/* 426 * Function prototypes 427 */ 428 429/* 430 * Various utility prototypes 431 */ 432static int sbp2util_create_command_orb_pool(struct scsi_id_instance_data *scsi_id); 433static void sbp2util_remove_command_orb_pool(struct scsi_id_instance_data *scsi_id); 434static struct sbp2_command_info *sbp2util_find_command_for_orb(struct scsi_id_instance_data *scsi_id, dma_addr_t orb); 435static struct sbp2_command_info *sbp2util_find_command_for_SCpnt(struct scsi_id_instance_data *scsi_id, void *SCpnt); 436static struct sbp2_command_info *sbp2util_allocate_command_orb(struct scsi_id_instance_data *scsi_id, 437 struct scsi_cmnd *Current_SCpnt, 438 void (*Current_done)(struct scsi_cmnd *)); 439static void sbp2util_mark_command_completed(struct scsi_id_instance_data *scsi_id, 440 struct sbp2_command_info *command); 441 442 443static int sbp2_start_device(struct scsi_id_instance_data *scsi_id); 444static void sbp2_remove_device(struct scsi_id_instance_data *scsi_id); 445 446#ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA 447static int sbp2_handle_physdma_write(struct hpsb_host *host, int nodeid, int destid, quadlet_t *data, 448 u64 addr, size_t length, u16 flags); 449static int sbp2_handle_physdma_read(struct hpsb_host *host, int nodeid, quadlet_t *data, 450 u64 addr, size_t length, u16 flags); 451#endif 452 453/* 454 * SBP-2 protocol related prototypes 455 */ 456static int sbp2_query_logins(struct scsi_id_instance_data *scsi_id); 457static int sbp2_login_device(struct scsi_id_instance_data *scsi_id); 458static int sbp2_reconnect_device(struct scsi_id_instance_data *scsi_id); 459static int sbp2_logout_device(struct scsi_id_instance_data *scsi_id); 460static int sbp2_handle_status_write(struct hpsb_host *host, int nodeid, int destid, 461 quadlet_t *data, u64 addr, size_t length, u16 flags); 462static int sbp2_agent_reset(struct scsi_id_instance_data *scsi_id, int wait); 463static int sbp2_create_command_orb(struct scsi_id_instance_data *scsi_id, 464 struct sbp2_command_info *command, 465 unchar *scsi_cmd, 466 unsigned int scsi_use_sg, 467 unsigned int scsi_request_bufflen, 468 void *scsi_request_buffer, 469 enum dma_data_direction dma_dir); 470static int sbp2_link_orb_command(struct scsi_id_instance_data *scsi_id, 471 struct sbp2_command_info *command); 472static int sbp2_send_command(struct scsi_id_instance_data *scsi_id, 473 struct scsi_cmnd *SCpnt, 474 void (*done)(struct scsi_cmnd *)); 475static unsigned int sbp2_status_to_sense_data(unchar *sbp2_status, unchar *sense_data); 476static void sbp2_check_sbp2_command(struct scsi_id_instance_data *scsi_id, unchar *cmd); 477static void sbp2_check_sbp2_response(struct scsi_id_instance_data *scsi_id, 478 struct scsi_cmnd *SCpnt); 479static void sbp2_parse_unit_directory(struct scsi_id_instance_data *scsi_id, 480 struct unit_directory *ud); 481static int sbp2_set_busy_timeout(struct scsi_id_instance_data *scsi_id); 482static int sbp2_max_speed_and_size(struct scsi_id_instance_data *scsi_id); 483 484#endif /* SBP2_H */