[deliverable/linux.git] / drivers / ieee1394 / sbp2.h

/*
 * sbp2.h - Defines and prototypes for sbp2.c
 *
 * Copyright (C) 2000 James Goodwin, Filanet Corporation (www.filanet.com)
 * jamesg@filanet.com
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef SBP2_H
#define SBP2_H

#define SBP2_DEVICE_NAME		"sbp2"

/*
 * 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(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;
	u32 next_ORB_lo;
	u32 data_descriptor_hi;
	u32 data_descriptor_lo;
	u32 misc;
	u8 cdb[12];
} __attribute__((packed));

#define SBP2_LOGIN_REQUEST		0x0
#define SBP2_QUERY_LOGINS_REQUEST	0x1
#define SBP2_RECONNECT_REQUEST		0x3
#define SBP2_SET_PASSWORD_REQUEST	0x4
#define SBP2_LOGOUT_REQUEST		0x7
#define SBP2_ABORT_TASK_REQUEST		0xb
#define SBP2_ABORT_TASK_SET		0xc
#define SBP2_LOGICAL_UNIT_RESET		0xe
#define SBP2_TARGET_RESET_REQUEST	0xf

#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) ? 1 << 28 : 0)
#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;
	u32 password_lo;
	u32 login_response_hi;
	u32 login_response_lo;
	u32 lun_misc;
	u32 passwd_resp_lengths;
	u32 status_fifo_hi;
	u32 status_fifo_lo;
} __attribute__((packed));

#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;
	u32 command_block_agent_hi;
	u32 command_block_agent_lo;
	u32 reconnect_hold;
} __attribute__((packed));

#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;
	u32 reserved2;
	u32 query_response_hi;
	u32 query_response_lo;
	u32 lun_misc;
	u32 reserved_resp_length;
	u32 status_fifo_hi;
	u32 status_fifo_lo;
} __attribute__((packed));

#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;
	u32 misc_IDs;
	u32 initiator_misc_hi;
	u32 initiator_misc_lo;
} __attribute__((packed));

struct sbp2_reconnect_orb {
	u32 reserved1;
	u32 reserved2;
	u32 reserved3;
	u32 reserved4;
	u32 login_ID_misc;
	u32 reserved5;
	u32 status_fifo_hi;
	u32 status_fifo_lo;
} __attribute__((packed));

struct sbp2_logout_orb {
	u32 reserved1;
	u32 reserved2;
	u32 reserved3;
	u32 reserved4;
	u32 login_ID_misc;
	u32 reserved5;
	u32 status_fifo_hi;
	u32 status_fifo_lo;
} __attribute__((packed));

struct sbp2_unrestricted_page_table {
	__be32 high;
	__be32 low;
};

#define RESP_STATUS_REQUEST_COMPLETE		0x0
#define RESP_STATUS_TRANSPORT_FAILURE		0x1
#define RESP_STATUS_ILLEGAL_REQUEST		0x2
#define RESP_STATUS_VENDOR_DEPENDENT		0x3

#define SBP2_STATUS_NO_ADDITIONAL_INFO		0x0
#define SBP2_STATUS_REQ_TYPE_NOT_SUPPORTED	0x1
#define SBP2_STATUS_SPEED_NOT_SUPPORTED		0x2
#define SBP2_STATUS_PAGE_SIZE_NOT_SUPPORTED	0x3
#define SBP2_STATUS_ACCESS_DENIED		0x4
#define SBP2_STATUS_LU_NOT_SUPPORTED		0x5
#define SBP2_STATUS_MAX_PAYLOAD_TOO_SMALL	0x6
#define SBP2_STATUS_RESOURCES_UNAVAILABLE	0x8
#define SBP2_STATUS_FUNCTION_REJECTED		0x9
#define SBP2_STATUS_LOGIN_ID_NOT_RECOGNIZED	0xa
#define SBP2_STATUS_DUMMY_ORB_COMPLETED		0xb
#define SBP2_STATUS_REQUEST_ABORTED		0xc
#define SBP2_STATUS_UNSPECIFIED_ERROR		0xff

#define SFMT_CURRENT_ERROR			0x0
#define SFMT_DEFERRED_ERROR			0x1
#define SFMT_VENDOR_DEPENDENT_STATUS		0x3

#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(v)			((v) & 0x38ff0000)

struct sbp2_status_block {
	u32 ORB_offset_hi_misc;
	u32 ORB_offset_lo;
	u8 command_set_dependent[24];
} __attribute__((packed));


/*
 * 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_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
/* biggest possible value for Single Phase Retry count is 0xf */
#define SBP2_BUSY_TIMEOUT_VALUE			0xf

#define SBP2_AGENT_RESET_DATA			0xf

#define SBP2_UNIT_SPEC_ID_ENTRY			0x0000609e
#define SBP2_SW_VERSION_ENTRY			0x00010483

/*
 * The default maximum s/g segment size of a FireWire controller is
 * usually 0x10000, but SBP-2 only allows 0xffff. Since buffers have to
 * be quadlet-aligned, we set the length limit to 0xffff & ~3.
 */
#define SBP2_MAX_SEG_SIZE			0xfffc

/*
 * 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


/*
 * Representations of commands and devices
 */

/* Per SCSI command */
struct sbp2_command_info {
	struct list_head list;
	struct sbp2_command_orb command_orb;
	dma_addr_t command_orb_dma;
	struct scsi_cmnd *Current_SCpnt;
	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] __attribute__((aligned(8)));
	dma_addr_t sge_dma;
};

/* Per FireWire host */
struct sbp2_fwhost_info {
	struct hpsb_host *host;
	struct list_head logical_units;
};

/* 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;
	dma_addr_t login_orb_dma;
	struct sbp2_login_response *login_response;
	dma_addr_t login_response_dma;
	struct sbp2_query_logins_orb *query_logins_orb;
	dma_addr_t query_logins_orb_dma;
	struct sbp2_query_logins_response *query_logins_response;
	dma_addr_t query_logins_response_dma;
	struct sbp2_reconnect_orb *reconnect_orb;
	dma_addr_t reconnect_orb_dma;
	struct sbp2_logout_orb *logout_orb;
	dma_addr_t logout_orb_dma;
	struct sbp2_status_block status_block;

	/* How to talk to the unit */
	u64 management_agent_addr;
	u64 command_block_agent_addr;
	u32 speed_code;
	u32 max_payload_size;
	u16 lun;

	/* Address for the unit to write status blocks to */
	u64 status_fifo_addr;

	/* Waitqueue flag for logins, reconnects, logouts, query logins */
	unsigned int access_complete:1;

	/* 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;

	/* Backlink to FireWire host; list of units attached to the host */
	struct sbp2_fwhost_info *hi;
	struct list_head lu_list;

	/* IEEE 1394 core's device representations */
	struct node_entry *ne;
	struct unit_directory *ud;

	/* SCSI core's device representations */
	struct scsi_device *sdev;
	struct Scsi_Host *shost;

	/* Device specific workarounds/brokeness */
	unsigned workarounds;

	/* Connection state */
	atomic_t state;

	/* For deferred requests to the fetch agent */
	struct work_struct protocol_work;
};

/* 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 */
};

/* 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_DELAY_INQUIRY	0x10
#define SBP2_INQUIRY_DELAY		12
#define SBP2_WORKAROUND_POWER_CONDITION	0x20
#define SBP2_WORKAROUND_OVERRIDE	0x100

#endif /* SBP2_H */
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	/*
e8ca5668	28	* SBP-2 specific definitions
1da177e4 LT	29	*/
1da177e4 LT	30
424a9642 SR	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(v) (((v) & 0x1) << 31)
	36	#define ORB_SET_NOTIFY(v) (((v) & 0x1) << 31)
	37	#define ORB_SET_RQ_FMT(v) (((v) & 0x3) << 29)
	38	#define ORB_SET_NODE_ID(v) (((v) & 0xffff) << 16)
	39	#define ORB_SET_STATUS_FIFO_HI(v, id) ((v) >> 32 \| ORB_SET_NODE_ID(id))
	40	#define ORB_SET_STATUS_FIFO_LO(v) ((v) & 0xffffffff)
	41	#define ORB_SET_DATA_SIZE(v) ((v) & 0xffff)
	42	#define ORB_SET_PAGE_SIZE(v) (((v) & 0x7) << 16)
	43	#define ORB_SET_PAGE_TABLE_PRESENT(v) (((v) & 0x1) << 19)
	44	#define ORB_SET_MAX_PAYLOAD(v) (((v) & 0xf) << 20)
	45	#define ORB_SET_SPEED(v) (((v) & 0x7) << 24)
	46	#define ORB_SET_DIRECTION(v) (((v) & 0x1) << 27)
1da177e4 LT	47
1da177e4 LT	48	struct sbp2_command_orb {
cc078189 SR	49	u32 next_ORB_hi;
cc078189 SR	50	u32 next_ORB_lo;
1da177e4 LT	51	u32 data_descriptor_hi;
	52	u32 data_descriptor_lo;
	53	u32 misc;
	54	u8 cdb[12];
05db5055	55	} __attribute__((packed));
1da177e4 LT	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
424a9642 SR	67	#define ORB_SET_LUN(v) ((v) & 0xffff)
	68	#define ORB_SET_FUNCTION(v) (((v) & 0xf) << 16)
	69	#define ORB_SET_RECONNECT(v) (((v) & 0xf) << 20)
77bba7ae	70	#define ORB_SET_EXCLUSIVE(v) ((v) ? 1 << 28 : 0)
424a9642 SR	71	#define ORB_SET_LOGIN_RESP_LENGTH(v) ((v) & 0xffff)
424a9642 SR	72	#define ORB_SET_PASSWD_LENGTH(v) (((v) & 0xffff) << 16)
1da177e4 LT	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;
35bdddb8 SR	82	u32 status_fifo_lo;
05db5055	83	} __attribute__((packed));
1da177e4	84
424a9642 SR	85	#define RESPONSE_GET_LOGIN_ID(v) ((v) & 0xffff)
	86	#define RESPONSE_GET_LENGTH(v) (((v) >> 16) & 0xffff)
	87	#define RESPONSE_GET_RECONNECT_HOLD(v) ((v) & 0xffff)
1da177e4 LT	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;
05db5055	94	} __attribute__((packed));
1da177e4	95
424a9642 SR	96	#define ORB_SET_LOGIN_ID(v) ((v) & 0xffff)
424a9642 SR	97	#define ORB_SET_QUERY_LOGINS_RESP_LENGTH(v) ((v) & 0xffff)
1da177e4 LT	98
	99	struct sbp2_query_logins_orb {
	100	u32 reserved1;
	101	u32 reserved2;
	102	u32 query_response_hi;
	103	u32 query_response_lo;
	104	u32 lun_misc;
	105	u32 reserved_resp_length;
35bdddb8 SR	106	u32 status_fifo_hi;
35bdddb8 SR	107	u32 status_fifo_lo;
05db5055	108	} __attribute__((packed));
1da177e4	109
424a9642 SR	110	#define RESPONSE_GET_MAX_LOGINS(v) ((v) & 0xffff)
424a9642 SR	111	#define RESPONSE_GET_ACTIVE_LOGINS(v) ((RESPONSE_GET_LENGTH((v)) - 4) / 12)
1da177e4 LT	112
	113	struct sbp2_query_logins_response {
	114	u32 length_max_logins;
	115	u32 misc_IDs;
	116	u32 initiator_misc_hi;
	117	u32 initiator_misc_lo;
05db5055	118	} __attribute__((packed));
1da177e4 LT	119
	120	struct sbp2_reconnect_orb {
	121	u32 reserved1;
	122	u32 reserved2;
a237f35f SR	123	u32 reserved3;
a237f35f SR	124	u32 reserved4;
1da177e4 LT	125	u32 login_ID_misc;
1da177e4 LT	126	u32 reserved5;
35bdddb8 SR	127	u32 status_fifo_hi;
35bdddb8 SR	128	u32 status_fifo_lo;
05db5055	129	} __attribute__((packed));
1da177e4 LT	130
	131	struct sbp2_logout_orb {
	132	u32 reserved1;
	133	u32 reserved2;
a237f35f SR	134	u32 reserved3;
a237f35f SR	135	u32 reserved4;
1da177e4 LT	136	u32 login_ID_misc;
1da177e4 LT	137	u32 reserved5;
35bdddb8 SR	138	u32 status_fifo_hi;
35bdddb8 SR	139	u32 status_fifo_lo;
05db5055	140	} __attribute__((packed));
1da177e4	141
1da177e4	142	struct sbp2_unrestricted_page_table {
ed6ffd08 SR	143	__be32 high;
	144	__be32 low;
	145	};
1da177e4 LT	146
	147	#define RESP_STATUS_REQUEST_COMPLETE 0x0
	148	#define RESP_STATUS_TRANSPORT_FAILURE 0x1
	149	#define RESP_STATUS_ILLEGAL_REQUEST 0x2
	150	#define RESP_STATUS_VENDOR_DEPENDENT 0x3
	151
	152	#define SBP2_STATUS_NO_ADDITIONAL_INFO 0x0
	153	#define SBP2_STATUS_REQ_TYPE_NOT_SUPPORTED 0x1
	154	#define SBP2_STATUS_SPEED_NOT_SUPPORTED 0x2
	155	#define SBP2_STATUS_PAGE_SIZE_NOT_SUPPORTED 0x3
	156	#define SBP2_STATUS_ACCESS_DENIED 0x4
	157	#define SBP2_STATUS_LU_NOT_SUPPORTED 0x5
	158	#define SBP2_STATUS_MAX_PAYLOAD_TOO_SMALL 0x6
	159	#define SBP2_STATUS_RESOURCES_UNAVAILABLE 0x8
	160	#define SBP2_STATUS_FUNCTION_REJECTED 0x9
	161	#define SBP2_STATUS_LOGIN_ID_NOT_RECOGNIZED 0xa
	162	#define SBP2_STATUS_DUMMY_ORB_COMPLETED 0xb
	163	#define SBP2_STATUS_REQUEST_ABORTED 0xc
	164	#define SBP2_STATUS_UNSPECIFIED_ERROR 0xff
	165
	166	#define SFMT_CURRENT_ERROR 0x0
	167	#define SFMT_DEFERRED_ERROR 0x1
	168	#define SFMT_VENDOR_DEPENDENT_STATUS 0x3
	169
424a9642 SR	170	#define STATUS_GET_SRC(v) (((v) >> 30) & 0x3)
	171	#define STATUS_GET_RESP(v) (((v) >> 28) & 0x3)
	172	#define STATUS_GET_LEN(v) (((v) >> 24) & 0x7)
	173	#define STATUS_GET_SBP_STATUS(v) (((v) >> 16) & 0xff)
	174	#define STATUS_GET_ORB_OFFSET_HI(v) ((v) & 0x0000ffff)
	175	#define STATUS_TEST_DEAD(v) ((v) & 0x08000000)
6065772d	176	/* test 'resp' \| 'dead' \| 'sbp2_status' */
424a9642	177	#define STATUS_TEST_RDS(v) ((v) & 0x38ff0000)
1da177e4 LT	178
	179	struct sbp2_status_block {
	180	u32 ORB_offset_hi_misc;
	181	u32 ORB_offset_lo;
a237f35f	182	u8 command_set_dependent[24];
05db5055	183	} __attribute__((packed));
1da177e4	184
e8ca5668	185
1da177e4	186	/*
e8ca5668	187	* SBP2 related configuration ROM definitions
1da177e4 LT	188	*/
1da177e4 LT	189
424a9642 SR	190	#define SBP2_UNIT_DIRECTORY_OFFSET_KEY 0xd1
	191	#define SBP2_CSR_OFFSET_KEY 0x54
	192	#define SBP2_UNIT_SPEC_ID_KEY 0x12
	193	#define SBP2_UNIT_SW_VERSION_KEY 0x13
	194	#define SBP2_COMMAND_SET_SPEC_ID_KEY 0x38
	195	#define SBP2_COMMAND_SET_KEY 0x39
	196	#define SBP2_UNIT_CHARACTERISTICS_KEY 0x3a
	197	#define SBP2_DEVICE_TYPE_AND_LUN_KEY 0x14
	198	#define SBP2_FIRMWARE_REVISION_KEY 0x3c
1da177e4	199
424a9642 SR	200	#define SBP2_AGENT_STATE_OFFSET 0x00ULL
	201	#define SBP2_AGENT_RESET_OFFSET 0x04ULL
	202	#define SBP2_ORB_POINTER_OFFSET 0x08ULL
	203	#define SBP2_DOORBELL_OFFSET 0x10ULL
	204	#define SBP2_UNSOLICITED_STATUS_ENABLE_OFFSET 0x14ULL
	205	#define SBP2_UNSOLICITED_STATUS_VALUE 0xf
1da177e4	206
424a9642	207	#define SBP2_BUSY_TIMEOUT_ADDRESS 0xfffff0000210ULL
e8ca5668	208	/* biggest possible value for Single Phase Retry count is 0xf */
424a9642	209	#define SBP2_BUSY_TIMEOUT_VALUE 0xf
1da177e4	210
424a9642	211	#define SBP2_AGENT_RESET_DATA 0xf
1da177e4	212
424a9642 SR	213	#define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e
424a9642 SR	214	#define SBP2_SW_VERSION_ENTRY 0x00010483
1da177e4	215
1da177e4	216	/*
ed6ffd08 SR	217	* The default maximum s/g segment size of a FireWire controller is
	218	* usually 0x10000, but SBP-2 only allows 0xffff. Since buffers have to
	219	* be quadlet-aligned, we set the length limit to 0xffff & ~3.
1da177e4	220	*/
ed6ffd08	221	#define SBP2_MAX_SEG_SIZE 0xfffc
1da177e4	222
ed6ffd08 SR	223	/*
ed6ffd08 SR	224	* There is no real limitation of the queue depth (i.e. length of the linked
424a9642	225	* list of command ORBs) at the target. The chosen depth is merely an
ed6ffd08 SR	226	* implementation detail of the sbp2 driver.
ed6ffd08 SR	227	*/
424a9642	228	#define SBP2_MAX_CMDS 8
1da177e4	229
424a9642 SR	230	#define SBP2_SCSI_STATUS_GOOD 0x0
	231	#define SBP2_SCSI_STATUS_CHECK_CONDITION 0x2
	232	#define SBP2_SCSI_STATUS_CONDITION_MET 0x4
	233	#define SBP2_SCSI_STATUS_BUSY 0x8
	234	#define SBP2_SCSI_STATUS_RESERVATION_CONFLICT 0x18
	235	#define SBP2_SCSI_STATUS_COMMAND_TERMINATED 0x22
	236	#define SBP2_SCSI_STATUS_SELECTION_TIMEOUT 0xff
24d3bf88	237
e8ca5668 SR	238
	239	/*
	240	* Representations of commands and devices
	241	*/
	242
e8ca5668	243	/* Per SCSI command */
1da177e4	244	struct sbp2_command_info {
1da177e4	245	struct list_head list;
f412bf44 SR	246	struct sbp2_command_orb command_orb;
f412bf44 SR	247	dma_addr_t command_orb_dma;
1da177e4 LT	248	struct scsi_cmnd *Current_SCpnt;
	249	void (Current_done)(struct scsi_cmnd );
	250
	251	/* Also need s/g structure for each sbp2 command */
138c8af8	252	struct sbp2_unrestricted_page_table
f412bf44 SR	253	scatter_gather_element[SG_ALL] __attribute__((aligned(8)));
f412bf44 SR	254	dma_addr_t sge_dma;
1da177e4 LT	255	};
1da177e4 LT	256
e8ca5668	257	/* Per FireWire host */
ca0c7453	258	struct sbp2_fwhost_info {
e8ca5668	259	struct hpsb_host *host;
138c8af8	260	struct list_head logical_units;
e8ca5668	261	};
1da177e4	262
e8ca5668	263	/* Per logical unit */
138c8af8	264	struct sbp2_lu {
e8ca5668	265	/* Operation request blocks */
1da177e4 LT	266	struct sbp2_command_orb *last_orb;
	267	dma_addr_t last_orb_dma;
	268	struct sbp2_login_orb *login_orb;
	269	dma_addr_t login_orb_dma;
	270	struct sbp2_login_response *login_response;
	271	dma_addr_t login_response_dma;
	272	struct sbp2_query_logins_orb *query_logins_orb;
	273	dma_addr_t query_logins_orb_dma;
	274	struct sbp2_query_logins_response *query_logins_response;
	275	dma_addr_t query_logins_response_dma;
	276	struct sbp2_reconnect_orb *reconnect_orb;
	277	dma_addr_t reconnect_orb_dma;
	278	struct sbp2_logout_orb *logout_orb;
	279	dma_addr_t logout_orb_dma;
	280	struct sbp2_status_block status_block;
	281
e8ca5668	282	/* How to talk to the unit */
ca0c7453 SR	283	u64 management_agent_addr;
ca0c7453 SR	284	u64 command_block_agent_addr;
1da177e4 LT	285	u32 speed_code;
1da177e4 LT	286	u32 max_payload_size;
ca0c7453	287	u16 lun;
1da177e4	288
e8ca5668	289	/* Address for the unit to write status blocks to */
35bdddb8 SR	290	u64 status_fifo_addr;
35bdddb8 SR	291
e8ca5668	292	/* Waitqueue flag for logins, reconnects, logouts, query logins */
ff6a4cd2	293	unsigned int access_complete:1;
1da177e4	294
e8ca5668	295	/* Pool of command ORBs for this logical unit */
ca0c7453 SR	296	spinlock_t cmd_orb_lock;
	297	struct list_head cmd_orb_inuse;
	298	struct list_head cmd_orb_completed;
1da177e4	299
e8ca5668	300	/* Backlink to FireWire host; list of units attached to the host */
ca0c7453	301	struct sbp2_fwhost_info *hi;
138c8af8	302	struct list_head lu_list;
1da177e4	303
e8ca5668	304	/* IEEE 1394 core's device representations */
1da177e4 LT	305	struct node_entry *ne;
	306	struct unit_directory *ud;
	307
e8ca5668	308	/* SCSI core's device representations */
1da177e4	309	struct scsi_device *sdev;
138c8af8	310	struct Scsi_Host *shost;
1da177e4 LT	311
1da177e4 LT	312	/* Device specific workarounds/brokeness */
24d3bf88	313	unsigned workarounds;
09ee67ab	314
e8ca5668	315	/* Connection state */
2cccbb55	316	atomic_t state;
e8ca5668 SR	317
e8ca5668 SR	318	/* For deferred requests to the fetch agent */
d19c7764	319	struct work_struct protocol_work;
1da177e4 LT	320	};
1da177e4 LT	321
138c8af8	322	/* For use in sbp2_lu.state */
2cccbb55 SR	323	enum sbp2lu_state_types {
	324	SBP2LU_STATE_RUNNING, /* all normal */
	325	SBP2LU_STATE_IN_RESET, /* between bus reset and reconnect */
	326	SBP2LU_STATE_IN_SHUTDOWN /* when sbp2_remove was called */
	327	};
	328
138c8af8	329	/* For use in sbp2_lu.workarounds and in the corresponding
e8ca5668	330	* module load parameter */
424a9642 SR	331	#define SBP2_WORKAROUND_128K_MAX_TRANS 0x1
	332	#define SBP2_WORKAROUND_INQUIRY_36 0x2
	333	#define SBP2_WORKAROUND_MODE_SENSE_8 0x4
	334	#define SBP2_WORKAROUND_FIX_CAPACITY 0x8
d94a9835 SR	335	#define SBP2_WORKAROUND_DELAY_INQUIRY 0x10
d94a9835 SR	336	#define SBP2_INQUIRY_DELAY 12
3719122a	337	#define SBP2_WORKAROUND_POWER_CONDITION 0x20
424a9642 SR	338	#define SBP2_WORKAROUND_OVERRIDE 0x100
424a9642 SR	339
1da177e4	340	#endif /* SBP2_H */