aboutsummaryrefslogtreecommitdiff
path: root/drivers/ieee1394/sbp2.h
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/ieee1394/sbp2.h')
-rw-r--r--drivers/ieee1394/sbp2.h311
1 files changed, 124 insertions, 187 deletions
diff --git a/drivers/ieee1394/sbp2.h b/drivers/ieee1394/sbp2.h
index 1b16d6b9cf1..9ae842329bf 100644
--- a/drivers/ieee1394/sbp2.h
+++ b/drivers/ieee1394/sbp2.h
@@ -25,25 +25,25 @@
#define SBP2_DEVICE_NAME "sbp2"
/*
- * SBP2 specific structures and defines
+ * SBP-2 specific definitions
*/
-#define ORB_DIRECTION_WRITE_TO_MEDIA 0x0
-#define ORB_DIRECTION_READ_FROM_MEDIA 0x1
-#define ORB_DIRECTION_NO_DATA_TRANSFER 0x2
-
-#define ORB_SET_NULL_PTR(value) ((value & 0x1) << 31)
-#define ORB_SET_NOTIFY(value) ((value & 0x1) << 31)
-#define ORB_SET_RQ_FMT(value) ((value & 0x3) << 29) /* unused ? */
-#define ORB_SET_NODE_ID(value) ((value & 0xffff) << 16)
-#define ORB_SET_STATUS_FIFO_HI(value, id) (value >> 32 | ORB_SET_NODE_ID(id))
-#define ORB_SET_STATUS_FIFO_LO(value) (value & 0xffffffff)
-#define ORB_SET_DATA_SIZE(value) (value & 0xffff)
-#define ORB_SET_PAGE_SIZE(value) ((value & 0x7) << 16)
-#define ORB_SET_PAGE_TABLE_PRESENT(value) ((value & 0x1) << 19)
-#define ORB_SET_MAX_PAYLOAD(value) ((value & 0xf) << 20)
-#define ORB_SET_SPEED(value) ((value & 0x7) << 24)
-#define ORB_SET_DIRECTION(value) ((value & 0x1) << 27)
+#define ORB_DIRECTION_WRITE_TO_MEDIA 0x0
+#define ORB_DIRECTION_READ_FROM_MEDIA 0x1
+#define ORB_DIRECTION_NO_DATA_TRANSFER 0x2
+
+#define ORB_SET_NULL_PTR(v) (((v) & 0x1) << 31)
+#define ORB_SET_NOTIFY(v) (((v) & 0x1) << 31)
+#define ORB_SET_RQ_FMT(v) (((v) & 0x3) << 29)
+#define ORB_SET_NODE_ID(v) (((v) & 0xffff) << 16)
+#define ORB_SET_STATUS_FIFO_HI(v, id) ((v) >> 32 | ORB_SET_NODE_ID(id))
+#define ORB_SET_STATUS_FIFO_LO(v) ((v) & 0xffffffff)
+#define ORB_SET_DATA_SIZE(v) ((v) & 0xffff)
+#define ORB_SET_PAGE_SIZE(v) (((v) & 0x7) << 16)
+#define ORB_SET_PAGE_TABLE_PRESENT(v) (((v) & 0x1) << 19)
+#define ORB_SET_MAX_PAYLOAD(v) (((v) & 0xf) << 20)
+#define ORB_SET_SPEED(v) (((v) & 0x7) << 24)
+#define ORB_SET_DIRECTION(v) (((v) & 0x1) << 27)
struct sbp2_command_orb {
u32 next_ORB_hi;
@@ -64,12 +64,12 @@ struct sbp2_command_orb {
#define SBP2_LOGICAL_UNIT_RESET 0xe
#define SBP2_TARGET_RESET_REQUEST 0xf
-#define ORB_SET_LUN(value) (value & 0xffff)
-#define ORB_SET_FUNCTION(value) ((value & 0xf) << 16)
-#define ORB_SET_RECONNECT(value) ((value & 0xf) << 20)
-#define ORB_SET_EXCLUSIVE(value) ((value & 0x1) << 28)
-#define ORB_SET_LOGIN_RESP_LENGTH(value) (value & 0xffff)
-#define ORB_SET_PASSWD_LENGTH(value) ((value & 0xffff) << 16)
+#define ORB_SET_LUN(v) ((v) & 0xffff)
+#define ORB_SET_FUNCTION(v) (((v) & 0xf) << 16)
+#define ORB_SET_RECONNECT(v) (((v) & 0xf) << 20)
+#define ORB_SET_EXCLUSIVE(v) (((v) & 0x1) << 28)
+#define ORB_SET_LOGIN_RESP_LENGTH(v) ((v) & 0xffff)
+#define ORB_SET_PASSWD_LENGTH(v) (((v) & 0xffff) << 16)
struct sbp2_login_orb {
u32 password_hi;
@@ -82,9 +82,9 @@ struct sbp2_login_orb {
u32 status_fifo_lo;
} __attribute__((packed));
-#define RESPONSE_GET_LOGIN_ID(value) (value & 0xffff)
-#define RESPONSE_GET_LENGTH(value) ((value >> 16) & 0xffff)
-#define RESPONSE_GET_RECONNECT_HOLD(value) (value & 0xffff)
+#define RESPONSE_GET_LOGIN_ID(v) ((v) & 0xffff)
+#define RESPONSE_GET_LENGTH(v) (((v) >> 16) & 0xffff)
+#define RESPONSE_GET_RECONNECT_HOLD(v) ((v) & 0xffff)
struct sbp2_login_response {
u32 length_login_ID;
@@ -93,9 +93,8 @@ struct sbp2_login_response {
u32 reconnect_hold;
} __attribute__((packed));
-#define ORB_SET_LOGIN_ID(value) (value & 0xffff)
-
-#define ORB_SET_QUERY_LOGINS_RESP_LENGTH(value) (value & 0xffff)
+#define ORB_SET_LOGIN_ID(v) ((v) & 0xffff)
+#define ORB_SET_QUERY_LOGINS_RESP_LENGTH(v) ((v) & 0xffff)
struct sbp2_query_logins_orb {
u32 reserved1;
@@ -108,8 +107,8 @@ struct sbp2_query_logins_orb {
u32 status_fifo_lo;
} __attribute__((packed));
-#define RESPONSE_GET_MAX_LOGINS(value) (value & 0xffff)
-#define RESPONSE_GET_ACTIVE_LOGINS(value) ((RESPONSE_GET_LENGTH(value) - 4) / 12)
+#define RESPONSE_GET_MAX_LOGINS(v) ((v) & 0xffff)
+#define RESPONSE_GET_ACTIVE_LOGINS(v) ((RESPONSE_GET_LENGTH((v)) - 4) / 12)
struct sbp2_query_logins_response {
u32 length_max_logins;
@@ -140,8 +139,8 @@ struct sbp2_logout_orb {
u32 status_fifo_lo;
} __attribute__((packed));
-#define PAGE_TABLE_SET_SEGMENT_BASE_HI(value) (value & 0xffff)
-#define PAGE_TABLE_SET_SEGMENT_LENGTH(value) ((value & 0xffff) << 16)
+#define PAGE_TABLE_SET_SEGMENT_BASE_HI(v) ((v) & 0xffff)
+#define PAGE_TABLE_SET_SEGMENT_LENGTH(v) (((v) & 0xffff) << 16)
struct sbp2_unrestricted_page_table {
u32 length_segment_base_hi;
@@ -171,23 +170,14 @@ struct sbp2_unrestricted_page_table {
#define SFMT_DEFERRED_ERROR 0x1
#define SFMT_VENDOR_DEPENDENT_STATUS 0x3
-#define SBP2_SCSI_STATUS_GOOD 0x0
-#define SBP2_SCSI_STATUS_CHECK_CONDITION 0x2
-#define SBP2_SCSI_STATUS_CONDITION_MET 0x4
-#define SBP2_SCSI_STATUS_BUSY 0x8
-#define SBP2_SCSI_STATUS_RESERVATION_CONFLICT 0x18
-#define SBP2_SCSI_STATUS_COMMAND_TERMINATED 0x22
-
-#define SBP2_SCSI_STATUS_SELECTION_TIMEOUT 0xff
-
-#define STATUS_GET_SRC(value) (((value) >> 30) & 0x3)
-#define STATUS_GET_RESP(value) (((value) >> 28) & 0x3)
-#define STATUS_GET_LEN(value) (((value) >> 24) & 0x7)
-#define STATUS_GET_SBP_STATUS(value) (((value) >> 16) & 0xff)
-#define STATUS_GET_ORB_OFFSET_HI(value) ((value) & 0x0000ffff)
-#define STATUS_TEST_DEAD(value) ((value) & 0x08000000)
+#define STATUS_GET_SRC(v) (((v) >> 30) & 0x3)
+#define STATUS_GET_RESP(v) (((v) >> 28) & 0x3)
+#define STATUS_GET_LEN(v) (((v) >> 24) & 0x7)
+#define STATUS_GET_SBP_STATUS(v) (((v) >> 16) & 0xff)
+#define STATUS_GET_ORB_OFFSET_HI(v) ((v) & 0x0000ffff)
+#define STATUS_TEST_DEAD(v) ((v) & 0x08000000)
/* test 'resp' | 'dead' | 'sbp2_status' */
-#define STATUS_TEST_RDS(value) ((value) & 0x38ff0000)
+#define STATUS_TEST_RDS(v) ((v) & 0x38ff0000)
struct sbp2_status_block {
u32 ORB_offset_hi_misc;
@@ -195,66 +185,70 @@ struct sbp2_status_block {
u8 command_set_dependent[24];
} __attribute__((packed));
+
/*
- * Miscellaneous SBP2 related config rom defines
+ * SBP2 related configuration ROM definitions
*/
-#define SBP2_UNIT_DIRECTORY_OFFSET_KEY 0xd1
-#define SBP2_CSR_OFFSET_KEY 0x54
-#define SBP2_UNIT_SPEC_ID_KEY 0x12
-#define SBP2_UNIT_SW_VERSION_KEY 0x13
-#define SBP2_COMMAND_SET_SPEC_ID_KEY 0x38
-#define SBP2_COMMAND_SET_KEY 0x39
-#define SBP2_UNIT_CHARACTERISTICS_KEY 0x3a
-#define SBP2_DEVICE_TYPE_AND_LUN_KEY 0x14
-#define SBP2_FIRMWARE_REVISION_KEY 0x3c
+#define SBP2_UNIT_DIRECTORY_OFFSET_KEY 0xd1
+#define SBP2_CSR_OFFSET_KEY 0x54
+#define SBP2_UNIT_SPEC_ID_KEY 0x12
+#define SBP2_UNIT_SW_VERSION_KEY 0x13
+#define SBP2_COMMAND_SET_SPEC_ID_KEY 0x38
+#define SBP2_COMMAND_SET_KEY 0x39
+#define SBP2_UNIT_CHARACTERISTICS_KEY 0x3a
+#define SBP2_DEVICE_TYPE_AND_LUN_KEY 0x14
+#define SBP2_FIRMWARE_REVISION_KEY 0x3c
-#define SBP2_AGENT_STATE_OFFSET 0x00ULL
-#define SBP2_AGENT_RESET_OFFSET 0x04ULL
-#define SBP2_ORB_POINTER_OFFSET 0x08ULL
-#define SBP2_DOORBELL_OFFSET 0x10ULL
-#define SBP2_UNSOLICITED_STATUS_ENABLE_OFFSET 0x14ULL
-#define SBP2_UNSOLICITED_STATUS_VALUE 0xf
+#define SBP2_AGENT_STATE_OFFSET 0x00ULL
+#define SBP2_AGENT_RESET_OFFSET 0x04ULL
+#define SBP2_ORB_POINTER_OFFSET 0x08ULL
+#define SBP2_DOORBELL_OFFSET 0x10ULL
+#define SBP2_UNSOLICITED_STATUS_ENABLE_OFFSET 0x14ULL
+#define SBP2_UNSOLICITED_STATUS_VALUE 0xf
-#define SBP2_BUSY_TIMEOUT_ADDRESS 0xfffff0000210ULL
-#define SBP2_BUSY_TIMEOUT_VALUE 0xf
+#define SBP2_BUSY_TIMEOUT_ADDRESS 0xfffff0000210ULL
+/* biggest possible value for Single Phase Retry count is 0xf */
+#define SBP2_BUSY_TIMEOUT_VALUE 0xf
-#define SBP2_AGENT_RESET_DATA 0xf
+#define SBP2_AGENT_RESET_DATA 0xf
-/*
- * Unit spec id and sw version entry for SBP-2 devices
- */
+#define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e
+#define SBP2_SW_VERSION_ENTRY 0x00010483
-#define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e
-#define SBP2_SW_VERSION_ENTRY 0x00010483
/*
- * SCSI specific stuff
+ * SCSI specific definitions
*/
-#define SBP2_MAX_SG_ELEMENT_LENGTH 0xf000
-#define SBP2_MAX_SECTORS 255 /* Max sectors supported */
-#define SBP2_MAX_CMDS 8 /* This should be safe */
+#define SBP2_MAX_SG_ELEMENT_LENGTH 0xf000
+#define SBP2_MAX_SECTORS 255
+/* There is no real limitation of the queue depth (i.e. length of the linked
+ * list of command ORBs) at the target. The chosen depth is merely an
+ * implementation detail of the sbp2 driver. */
+#define SBP2_MAX_CMDS 8
+
+#define SBP2_SCSI_STATUS_GOOD 0x0
+#define SBP2_SCSI_STATUS_CHECK_CONDITION 0x2
+#define SBP2_SCSI_STATUS_CONDITION_MET 0x4
+#define SBP2_SCSI_STATUS_BUSY 0x8
+#define SBP2_SCSI_STATUS_RESERVATION_CONFLICT 0x18
+#define SBP2_SCSI_STATUS_COMMAND_TERMINATED 0x22
+#define SBP2_SCSI_STATUS_SELECTION_TIMEOUT 0xff
-/* Flags for detected oddities and brokeness */
-#define SBP2_WORKAROUND_128K_MAX_TRANS 0x1
-#define SBP2_WORKAROUND_INQUIRY_36 0x2
-#define SBP2_WORKAROUND_MODE_SENSE_8 0x4
-#define SBP2_WORKAROUND_FIX_CAPACITY 0x8
-#define SBP2_WORKAROUND_OVERRIDE 0x100
-/* This is the two dma types we use for cmd_dma below */
-enum cmd_dma_types {
+/*
+ * Representations of commands and devices
+ */
+
+enum sbp2_dma_types {
CMD_DMA_NONE,
CMD_DMA_PAGE,
CMD_DMA_SINGLE
};
-/*
- * Encapsulates all the info necessary for an outstanding command.
- */
+/* Per SCSI command */
struct sbp2_command_info {
-
struct list_head list;
struct sbp2_command_orb command_orb ____cacheline_aligned;
dma_addr_t command_orb_dma ____cacheline_aligned;
@@ -262,25 +256,25 @@ struct sbp2_command_info {
void (*Current_done)(struct scsi_cmnd *);
/* Also need s/g structure for each sbp2 command */
- struct sbp2_unrestricted_page_table scatter_gather_element[SG_ALL] ____cacheline_aligned;
+ struct sbp2_unrestricted_page_table
+ scatter_gather_element[SG_ALL] ____cacheline_aligned;
dma_addr_t sge_dma ____cacheline_aligned;
void *sge_buffer;
dma_addr_t cmd_dma;
- enum cmd_dma_types dma_type;
+ enum sbp2_dma_types dma_type;
unsigned long dma_size;
- int dma_dir;
-
+ enum dma_data_direction dma_dir;
};
-struct sbp2scsi_host_info;
+/* Per FireWire host */
+struct sbp2_fwhost_info {
+ struct hpsb_host *host;
+ struct list_head logical_units;
+};
-/*
- * Information needed on a per scsi id basis (one for each sbp2 device)
- */
-struct scsi_id_instance_data {
- /*
- * Various sbp2 specific structures
- */
+/* Per logical unit */
+struct sbp2_lu {
+ /* Operation request blocks */
struct sbp2_command_orb *last_orb;
dma_addr_t last_orb_dma;
struct sbp2_login_orb *login_orb;
@@ -297,116 +291,59 @@ struct scsi_id_instance_data {
dma_addr_t logout_orb_dma;
struct sbp2_status_block status_block;
- /*
- * Stuff we need to know about the sbp2 device itself
- */
- u64 sbp2_management_agent_addr;
- u64 sbp2_command_block_agent_addr;
+ /* How to talk to the unit */
+ u64 management_agent_addr;
+ u64 command_block_agent_addr;
u32 speed_code;
u32 max_payload_size;
+ u16 lun;
- /*
- * Values pulled from the device's unit directory
- */
- u32 sbp2_command_set_spec_id;
- u32 sbp2_command_set;
- u32 sbp2_unit_characteristics;
- u32 sbp2_lun;
- u32 sbp2_firmware_revision;
-
- /*
- * Address for the device to write status blocks to
- */
+ /* Address for the unit to write status blocks to */
u64 status_fifo_addr;
- /*
- * Waitqueue flag for logins, reconnects, logouts, query logins
- */
- int access_complete:1;
+ /* Waitqueue flag for logins, reconnects, logouts, query logins */
+ unsigned int access_complete:1;
- /*
- * Pool of command orbs, so we can have more than overlapped command per id
- */
- spinlock_t sbp2_command_orb_lock;
- struct list_head sbp2_command_orb_inuse;
- struct list_head sbp2_command_orb_completed;
+ /* Pool of command ORBs for this logical unit */
+ spinlock_t cmd_orb_lock;
+ struct list_head cmd_orb_inuse;
+ struct list_head cmd_orb_completed;
- struct list_head scsi_list;
+ /* Backlink to FireWire host; list of units attached to the host */
+ struct sbp2_fwhost_info *hi;
+ struct list_head lu_list;
- /* Node entry, as retrieved from NodeMgr entries */
+ /* IEEE 1394 core's device representations */
struct node_entry *ne;
struct unit_directory *ud;
- /* A backlink to our host_info */
- struct sbp2scsi_host_info *hi;
-
- /* SCSI related pointers */
+ /* SCSI core's device representations */
struct scsi_device *sdev;
- struct Scsi_Host *scsi_host;
+ struct Scsi_Host *shost;
/* Device specific workarounds/brokeness */
unsigned workarounds;
+ /* Connection state */
atomic_t state;
- struct delayed_work protocol_work;
+
+ /* For deferred requests to the fetch agent */
+ struct work_struct protocol_work;
};
-/* For use in scsi_id_instance_data.state */
+/* For use in sbp2_lu.state */
enum sbp2lu_state_types {
SBP2LU_STATE_RUNNING, /* all normal */
SBP2LU_STATE_IN_RESET, /* between bus reset and reconnect */
SBP2LU_STATE_IN_SHUTDOWN /* when sbp2_remove was called */
};
-/* Sbp2 host data structure (one per IEEE1394 host) */
-struct sbp2scsi_host_info {
- struct hpsb_host *host; /* IEEE1394 host */
- struct list_head scsi_ids; /* List of scsi ids on this host */
-};
-
-/*
- * Function prototypes
- */
-
-/*
- * Various utility prototypes
- */
-static int sbp2util_create_command_orb_pool(struct scsi_id_instance_data *scsi_id);
-static void sbp2util_remove_command_orb_pool(struct scsi_id_instance_data *scsi_id);
-static struct sbp2_command_info *sbp2util_find_command_for_orb(struct scsi_id_instance_data *scsi_id, dma_addr_t orb);
-static struct sbp2_command_info *sbp2util_find_command_for_SCpnt(struct scsi_id_instance_data *scsi_id, void *SCpnt);
-static struct sbp2_command_info *sbp2util_allocate_command_orb(struct scsi_id_instance_data *scsi_id,
- struct scsi_cmnd *Current_SCpnt,
- void (*Current_done)(struct scsi_cmnd *));
-static void sbp2util_mark_command_completed(struct scsi_id_instance_data *scsi_id,
- struct sbp2_command_info *command);
-
-
-static int sbp2_start_device(struct scsi_id_instance_data *scsi_id);
-static void sbp2_remove_device(struct scsi_id_instance_data *scsi_id);
-
-#ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
-static int sbp2_handle_physdma_write(struct hpsb_host *host, int nodeid, int destid, quadlet_t *data,
- u64 addr, size_t length, u16 flags);
-static int sbp2_handle_physdma_read(struct hpsb_host *host, int nodeid, quadlet_t *data,
- u64 addr, size_t length, u16 flags);
-#endif
-
-/*
- * SBP-2 protocol related prototypes
- */
-static int sbp2_query_logins(struct scsi_id_instance_data *scsi_id);
-static int sbp2_login_device(struct scsi_id_instance_data *scsi_id);
-static int sbp2_reconnect_device(struct scsi_id_instance_data *scsi_id);
-static int sbp2_logout_device(struct scsi_id_instance_data *scsi_id);
-static int sbp2_handle_status_write(struct hpsb_host *host, int nodeid, int destid,
- quadlet_t *data, u64 addr, size_t length, u16 flags);
-static int sbp2_agent_reset(struct scsi_id_instance_data *scsi_id, int wait);
-static unsigned int sbp2_status_to_sense_data(unchar *sbp2_status,
- unchar *sense_data);
-static void sbp2_parse_unit_directory(struct scsi_id_instance_data *scsi_id,
- struct unit_directory *ud);
-static int sbp2_set_busy_timeout(struct scsi_id_instance_data *scsi_id);
-static int sbp2_max_speed_and_size(struct scsi_id_instance_data *scsi_id);
+/* For use in sbp2_lu.workarounds and in the corresponding
+ * module load parameter */
+#define SBP2_WORKAROUND_128K_MAX_TRANS 0x1
+#define SBP2_WORKAROUND_INQUIRY_36 0x2
+#define SBP2_WORKAROUND_MODE_SENSE_8 0x4
+#define SBP2_WORKAROUND_FIX_CAPACITY 0x8
+#define SBP2_WORKAROUND_OVERRIDE 0x100
#endif /* SBP2_H */
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-11 08:45:21 +0000