[dragonfly.git] / sys / dev / raid / ciss / cissvar.h

/*-
 * Copyright (c) 2001 Michael Smith
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	$FreeBSD: src/sys/dev/ciss/cissvar.h,v 1.17 2010/03/03 17:58:41 mav Exp $
 */

/*
 * CISS adapter driver datastructures
 */

typedef STAILQ_HEAD(, ciss_request)	cr_qhead_t;

/************************************************************************
 * Tunable parameters
 */

/*
 * There is no guaranteed upper bound on the number of concurrent
 * commands an adapter may claim to support.  Cap it at a reasonable
 * value.
 */
#define CISS_MAX_REQUESTS	1024

/*
 * Maximum number of logical drives we support.
 */
#define CISS_MAX_LOGICAL	15

/*
 * Maximum number of physical devices we support.
 */
#define CISS_MAX_PHYSICAL	1024

/*
 * Interrupt reduction can be controlled by tuning the interrupt
 * coalesce delay and count paramters.  The delay (in microseconds)
 * defers delivery of interrupts to increase the chance of there being
 * more than one completed command ready when the interrupt is
 * delivered.  The count expedites the delivery of the interrupt when
 * the given number of commands are ready.
 *
 * If the delay is set to 0, interrupts are delivered immediately.
 */
#define CISS_INTERRUPT_COALESCE_DELAY	0
#define CISS_INTERRUPT_COALESCE_COUNT	16

/*
 * Heartbeat routine timeout in seconds.  Note that since event
 * handling is performed on a callback basis, we don't need this to
 * run very often.
 */
#define CISS_HEARTBEAT_RATE		10

/************************************************************************
 * Driver version.  Only really significant to the ACU interface.
 */
#define CISS_DRIVER_VERSION	20011201

/************************************************************************
 * Driver data structures
 */

/*
 * Each command issued to the adapter is managed by a request
 * structure.
 */
struct ciss_request
{
    STAILQ_ENTRY(ciss_request)	cr_link;
    int				cr_onq;		/* which queue we are on */

    struct ciss_softc		*cr_sc;		/* controller softc */
    void			*cr_data;	/* data buffer */
    u_int32_t			cr_length;	/* data length */
    bus_dmamap_t		cr_datamap;	/* DMA map for data */
    struct ciss_command		*cr_cc;
    uint32_t			cr_ccphys;
    int				cr_tag;
    int				cr_flags;
#define CISS_REQ_MAPPED		(1<<0)		/* data mapped */
#define CISS_REQ_SLEEP		(1<<1)		/* submitter sleeping */
#define CISS_REQ_POLL		(1<<2)		/* submitter polling */
#define CISS_REQ_DATAOUT	(1<<3)		/* data host->adapter */
#define CISS_REQ_DATAIN		(1<<4)		/* data adapter->host */
#define CISS_REQ_BUSY		(1<<5)		/* controller has req */

    void			(* cr_complete)(struct ciss_request *);
    void			*cr_private;
    int				cr_sg_tag;
#define CISS_SG_MAX		((CISS_SG_FETCH_MAX << 1) | 0x1)
#define CISS_SG_1		((CISS_SG_FETCH_1 << 1) | 0x01)
#define CISS_SG_2		((CISS_SG_FETCH_2 << 1) | 0x01)
#define CISS_SG_4		((CISS_SG_FETCH_4 << 1) | 0x01)
#define CISS_SG_8		((CISS_SG_FETCH_8 << 1) | 0x01)
#define CISS_SG_16		((CISS_SG_FETCH_16 << 1) | 0x01)
#define CISS_SG_32		((CISS_SG_FETCH_32 << 1) | 0x01)
#define CISS_SG_NONE		((CISS_SG_FETCH_NONE << 1) | 0x01)
};

/*
 * The adapter command structure is defined with a zero-length
 * scatter/gather list size.  In practise, we want space for a
 * scatter-gather list, and we also want to avoid having commands
 * cross page boundaries.
 *
 * The size of the ciss_command is 52 bytes.  65 s/g elements are reserved
 * to allow a max i/o size of 256k.  This gives a total command size of
 * 1120 bytes, including the 32 byte alignment padding.  Modern controllers
 * seem to saturate nicely at this value.
 */

#define CISS_MAX_SG_ELEMENTS	65
#define CISS_COMMAND_ALIGN	32
#define CISS_COMMAND_SG_LENGTH	(sizeof(struct ciss_sg_entry) * CISS_MAX_SG_ELEMENTS)
#define CISS_COMMAND_ALLOC_SIZE		(roundup2(sizeof(struct ciss_command) + CISS_COMMAND_SG_LENGTH, CISS_COMMAND_ALIGN))

/*
 * Per-logical-drive data.
 */
struct ciss_ldrive
{
    union ciss_device_address	cl_address;
    union ciss_device_address	*cl_controller;
    int				cl_status;
#define CISS_LD_NONEXISTENT	0
#define CISS_LD_ONLINE		1
#define CISS_LD_OFFLINE		2

    int				cl_update;

    struct ciss_bmic_id_ldrive	*cl_ldrive;
    struct ciss_bmic_id_lstatus	*cl_lstatus;
    struct ciss_ldrive_geometry	cl_geometry;

    char			cl_name[16];		/* device name */
};

/*
 * Per-physical-drive data
 */
struct ciss_pdrive
{
    union ciss_device_address	cp_address;
    int				cp_online;
};

#define CISS_PHYSICAL_SHIFT	5
#define CISS_PHYSICAL_BASE	(1 << CISS_PHYSICAL_SHIFT)
#define CISS_MAX_PHYSTGT	256

#define CISS_IS_PHYSICAL(bus)	(bus >= CISS_PHYSICAL_BASE)
#define CISS_CAM_TO_PBUS(bus)	(bus - CISS_PHYSICAL_BASE)

/*
 * Per-adapter data
 */
struct ciss_softc
{
    /* bus connections */
    device_t			ciss_dev;		/* bus attachment */
    struct cdev *ciss_dev_t;		/* control device */

    struct resource		*ciss_regs_resource;	/* register interface window */
    int				ciss_regs_rid;		/* resource ID */
    bus_space_handle_t		ciss_regs_bhandle;	/* bus space handle */
    bus_space_tag_t		ciss_regs_btag;		/* bus space tag */

    struct resource		*ciss_cfg_resource;	/* config struct interface window */
    int				ciss_cfg_rid;		/* resource ID */
    struct ciss_config_table	*ciss_cfg;		/* config table in adapter memory */
    struct ciss_perf_config	*ciss_perf;		/* config table for the performant */
    struct ciss_bmic_id_table	*ciss_id;		/* ID table in host memory */
    u_int32_t			ciss_heartbeat;		/* last heartbeat value */
    int				ciss_heart_attack;	/* number of times we have seen this value */

    int				ciss_msi;
    struct resource		*ciss_irq_resource;	/* interrupt */
    int				ciss_irq_rid[CISS_MSI_COUNT];		/* resource ID */
    void			*ciss_intr;		/* interrupt handle */
    int				ciss_irq_type;

    bus_dma_tag_t		ciss_parent_dmat;	/* parent DMA tag */
    bus_dma_tag_t		ciss_buffer_dmat;	/* data buffer/command DMA tag */

    u_int32_t			ciss_interrupt_mask;	/* controller interrupt mask bits */

    uint64_t			*ciss_reply;
    int				ciss_cycle;
    int				ciss_rqidx;
    bus_dma_tag_t		ciss_reply_dmat;
    bus_dmamap_t		ciss_reply_map;
    uint32_t			ciss_reply_phys;

    int				ciss_max_requests;
    struct ciss_request		ciss_request[CISS_MAX_REQUESTS];	/* requests */
    void			*ciss_command;		/* command structures */
    bus_dma_tag_t		ciss_command_dmat;	/* command DMA tag */
    bus_dmamap_t		ciss_command_map;	/* command DMA map */
    u_int32_t			ciss_command_phys;	/* command array base address */
    cr_qhead_t			ciss_free;		/* requests available for reuse */
    cr_qhead_t			ciss_notify;		/* requests which are defered for processing */
    struct thread		*ciss_notify_thread;

    struct callout		ciss_periodic;		/* periodic event handling */
    struct ciss_request		*ciss_periodic_notify;	/* notify callback request */

    struct lock			ciss_lock;
    struct ciss_ldrive		**ciss_logical;
    struct ciss_pdrive		**ciss_physical;
    union ciss_device_address	*ciss_controllers;	/* controller address */
    int				ciss_max_bus_number;	/* maximum bus number */
    int				ciss_max_logical_bus;
    int				ciss_max_physical_bus;

    struct cam_devq		*ciss_cam_devq;
    struct cam_sim		**ciss_cam_sim;

    int				ciss_soft_reset;

    struct sysctl_ctx_list	ciss_sysctl_ctx;
    struct sysctl_oid		*ciss_sysctl_tree;

    int				ciss_flags;
#define CISS_FLAG_NOTIFY_OK	(1<<0)		/* notify command running OK */
#define CISS_FLAG_CONTROL_OPEN	(1<<1)		/* control device is open */
#define CISS_FLAG_ABORTING	(1<<2)		/* driver is going away */
#define CISS_FLAG_RUNNING	(1<<3)		/* driver is running (interrupts usable) */
#define CISS_FLAG_BUSY		(1<<4)		/* no free commands */

#define CISS_FLAG_FAKE_SYNCH	(1<<16)		/* needs SYNCHRONISE_CACHE faked */
#define CISS_FLAG_BMIC_ABORT	(1<<17)		/* use BMIC command to abort Notify on Event */
#define CISS_FLAG_THREAD_SHUT	(1<<20)		/* shutdown the kthread */

    struct ciss_qstat		ciss_qstat[CISSQ_COUNT];	/* queue statistics */
};

/************************************************************************
 * Debugging/diagnostic output.
 */

/*
 * Debugging levels:
 *  0 - quiet, only emit warnings
 *  1 - talkative, log major events, but nothing on the I/O path
 *  2 - noisy, log events on the I/O path
 *  3 - extremely noisy, log items in loops
 */
#ifdef CISS_DEBUG
# define debug(level, fmt, args...)							\
	do {										\
	    if (level <= CISS_DEBUG) printf("%s: " fmt "\n", __func__ , ##args);	\
	} while(0)
# define debug_called(level)						\
	do {								\
	    if (level <= CISS_DEBUG) printf("%s: called\n", __func__);	\
	} while(0)
# define debug_struct(s)		printf("  SIZE %s: %zu\n", #s, sizeof(struct s))
# define debug_union(s)			printf("  SIZE %s: %zu\n", #s, sizeof(union s))
# define debug_type(s)			printf("  SIZE %s: %zu\n", #s, sizeof(s))
# define debug_field(s, f)		printf("  OFFSET %s.%s: %d\n", #s, #f, ((int)&(((struct s *)0)->f)))
# define debug_const(c)			printf("  CONST %s %jd/0x%jx\n", #c, (intmax_t)c, (intmax_t)c);
#else
# define debug(level, fmt, args...)
# define debug_called(level)
# define debug_struct(s)
# define debug_union(s)
# define debug_type(s)
# define debug_field(s, f)
# define debug_const(c)
#endif

#define ciss_printf(sc, fmt, args...)	device_printf(sc->ciss_dev, fmt , ##args)

/************************************************************************
 * Queue primitives
 */

#define CISSQ_ADD(sc, qname)					\
	do {							\
	    struct ciss_qstat *qs = &(sc)->ciss_qstat[qname];	\
								\
	    qs->q_length++;					\
	    if (qs->q_length > qs->q_max)			\
		qs->q_max = qs->q_length;			\
	} while(0)

#define CISSQ_REMOVE(sc, qname)    (sc)->ciss_qstat[qname].q_length--
#define CISSQ_INIT(sc, qname)			\
	do {					\
	    sc->ciss_qstat[qname].q_length = 0;	\
	    sc->ciss_qstat[qname].q_max = 0;	\
	} while(0)


#define CISSQ_REQUEST_QUEUE(name, index)				\
static __inline void							\
ciss_initq_ ## name (struct ciss_softc *sc)				\
{									\
    STAILQ_INIT(&sc->ciss_ ## name);					\
    CISSQ_INIT(sc, index);						\
}									\
static __inline void							\
ciss_enqueue_ ## name (struct ciss_request *cr)				\
{									\
									\
    STAILQ_INSERT_TAIL(&cr->cr_sc->ciss_ ## name, cr, cr_link);		\
    CISSQ_ADD(cr->cr_sc, index);					\
    cr->cr_onq = index;							\
}									\
static __inline void							\
ciss_requeue_ ## name (struct ciss_request *cr)				\
{									\
									\
    STAILQ_INSERT_HEAD(&cr->cr_sc->ciss_ ## name, cr, cr_link);		\
    CISSQ_ADD(cr->cr_sc, index);					\
    cr->cr_onq = index;							\
}									\
static __inline struct ciss_request *					\
ciss_dequeue_ ## name (struct ciss_softc *sc)				\
{									\
    struct ciss_request	*cr;						\
									\
    if ((cr = STAILQ_FIRST(&sc->ciss_ ## name)) != NULL) {		\
	STAILQ_REMOVE_HEAD(&sc->ciss_ ## name, cr_link);		\
	CISSQ_REMOVE(sc, index);					\
	cr->cr_onq = -1;						\
    }									\
    return(cr);								\
}									\
struct hack

CISSQ_REQUEST_QUEUE(free, CISSQ_FREE);
CISSQ_REQUEST_QUEUE(notify, CISSQ_NOTIFY);

static __inline void
ciss_enqueue_complete(struct ciss_request *ac, cr_qhead_t *head)
{

    STAILQ_INSERT_TAIL(head, ac, cr_link);
}

static __inline struct ciss_request *
ciss_dequeue_complete(struct ciss_softc *sc, cr_qhead_t *head)
{
    struct ciss_request  *ac;

    if ((ac = STAILQ_FIRST(head)) != NULL)
        STAILQ_REMOVE_HEAD(head, cr_link);
    return(ac);
}

/********************************************************************************
 * space-fill a character string
 */
static __inline void
padstr(char *targ, const char *src, int len)
{
    while (len-- > 0) {
	if (*src != 0) {
	    *targ++ = *src++;
	} else {
	    *targ++ = ' ';
	}
    }
}

#define ciss_report_request(a, b, c)	\
	_ciss_report_request(a, b, c, __FUNCTION__)
Commit	Line	Data
984263bc MD	1	/*-
	2	* Copyright (c) 2001 Michael Smith
	3	* All rights reserved.
	4	*
	5	* Redistribution and use in source and binary forms, with or without
	6	* modification, are permitted provided that the following conditions
	7	* are met:
	8	* 1. Redistributions of source code must retain the above copyright
	9	* notice, this list of conditions and the following disclaimer.
	10	* 2. Redistributions in binary form must reproduce the above copyright
	11	* notice, this list of conditions and the following disclaimer in the
	12	* documentation and/or other materials provided with the distribution.
	13	*
	14	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
	15	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	16	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	17	* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
	18	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	19	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	20	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	21	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	22	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	23	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	24	* SUCH DAMAGE.
	25	*
a8416dcf	26	* $FreeBSD: src/sys/dev/ciss/cissvar.h,v 1.17 2010/03/03 17:58:41 mav Exp $
984263bc MD	27	*/
	28
	29	/*
	30	* CISS adapter driver datastructures
	31	*/
	32
a8416dcf SW	33	typedef STAILQ_HEAD(, ciss_request) cr_qhead_t;
a8416dcf SW	34
984263bc MD	35	/************************************************************************
	36	* Tunable parameters
	37	*/
	38
	39	/*
	40	* There is no guaranteed upper bound on the number of concurrent
	41	* commands an adapter may claim to support. Cap it at a reasonable
	42	* value.
	43	*/
a8416dcf	44	#define CISS_MAX_REQUESTS 1024
984263bc MD	45
	46	/*
	47	* Maximum number of logical drives we support.
	48	*/
	49	#define CISS_MAX_LOGICAL 15
	50
	51	/*
9cf9a798 SW	52	* Maximum number of physical devices we support.
	53	*/
	54	#define CISS_MAX_PHYSICAL 1024
	55
	56	/*
984263bc MD	57	* Interrupt reduction can be controlled by tuning the interrupt
	58	* coalesce delay and count paramters. The delay (in microseconds)
	59	* defers delivery of interrupts to increase the chance of there being
	60	* more than one completed command ready when the interrupt is
	61	* delivered. The count expedites the delivery of the interrupt when
	62	* the given number of commands are ready.
	63	*
	64	* If the delay is set to 0, interrupts are delivered immediately.
	65	*/
a8416dcf	66	#define CISS_INTERRUPT_COALESCE_DELAY 0
984263bc MD	67	#define CISS_INTERRUPT_COALESCE_COUNT 16
	68
	69	/*
	70	* Heartbeat routine timeout in seconds. Note that since event
	71	* handling is performed on a callback basis, we don't need this to
	72	* run very often.
	73	*/
	74	#define CISS_HEARTBEAT_RATE 10
	75
984263bc	76	/************************************************************************
984263bc MD	77	* Driver version. Only really significant to the ACU interface.
	78	*/
	79	#define CISS_DRIVER_VERSION 20011201
	80
	81	/************************************************************************
	82	* Driver data structures
	83	*/
	84
	85	/*
	86	* Each command issued to the adapter is managed by a request
	87	* structure.
	88	*/
	89	struct ciss_request
	90	{
a8416dcf	91	STAILQ_ENTRY(ciss_request) cr_link;
984263bc MD	92	int cr_onq; /* which queue we are on */
	93
	94	struct ciss_softc cr_sc; / controller softc */
	95	void cr_data; / data buffer */
	96	u_int32_t cr_length; /* data length */
	97	bus_dmamap_t cr_datamap; /* DMA map for data */
a8416dcf SW	98	struct ciss_command *cr_cc;
a8416dcf SW	99	uint32_t cr_ccphys;
984263bc MD	100	int cr_tag;
	101	int cr_flags;
	102	#define CISS_REQ_MAPPED (1<<0) /* data mapped */
	103	#define CISS_REQ_SLEEP (1<<1) /* submitter sleeping */
	104	#define CISS_REQ_POLL (1<<2) /* submitter polling */
	105	#define CISS_REQ_DATAOUT (1<<3) /* data host->adapter */
	106	#define CISS_REQ_DATAIN (1<<4) /* data adapter->host */
a8416dcf	107	#define CISS_REQ_BUSY (1<<5) /* controller has req */
9cf9a798	108
984263bc MD	109	void (* cr_complete)(struct ciss_request *);
984263bc MD	110	void *cr_private;
a8416dcf SW	111	int cr_sg_tag;
	112	#define CISS_SG_MAX ((CISS_SG_FETCH_MAX << 1) \| 0x1)
	113	#define CISS_SG_1 ((CISS_SG_FETCH_1 << 1) \| 0x01)
	114	#define CISS_SG_2 ((CISS_SG_FETCH_2 << 1) \| 0x01)
	115	#define CISS_SG_4 ((CISS_SG_FETCH_4 << 1) \| 0x01)
	116	#define CISS_SG_8 ((CISS_SG_FETCH_8 << 1) \| 0x01)
	117	#define CISS_SG_16 ((CISS_SG_FETCH_16 << 1) \| 0x01)
	118	#define CISS_SG_32 ((CISS_SG_FETCH_32 << 1) \| 0x01)
	119	#define CISS_SG_NONE ((CISS_SG_FETCH_NONE << 1) \| 0x01)
984263bc MD	120	};
	121
	122	/*
	123	* The adapter command structure is defined with a zero-length
	124	* scatter/gather list size. In practise, we want space for a
	125	* scatter-gather list, and we also want to avoid having commands
	126	* cross page boundaries.
	127	*
a8416dcf SW	128	* The size of the ciss_command is 52 bytes. 65 s/g elements are reserved
	129	* to allow a max i/o size of 256k. This gives a total command size of
	130	* 1120 bytes, including the 32 byte alignment padding. Modern controllers
	131	* seem to saturate nicely at this value.
984263bc MD	132	*/
984263bc MD	133
a8416dcf SW	134	#define CISS_MAX_SG_ELEMENTS 65
	135	#define CISS_COMMAND_ALIGN 32
	136	#define CISS_COMMAND_SG_LENGTH (sizeof(struct ciss_sg_entry) * CISS_MAX_SG_ELEMENTS)
	137	#define CISS_COMMAND_ALLOC_SIZE (roundup2(sizeof(struct ciss_command) + CISS_COMMAND_SG_LENGTH, CISS_COMMAND_ALIGN))
984263bc MD	138
	139	/*
	140	* Per-logical-drive data.
	141	*/
9cf9a798	142	struct ciss_ldrive
984263bc MD	143	{
984263bc MD	144	union ciss_device_address cl_address;
9cf9a798	145	union ciss_device_address *cl_controller;
984263bc MD	146	int cl_status;
	147	#define CISS_LD_NONEXISTENT 0
	148	#define CISS_LD_ONLINE 1
	149	#define CISS_LD_OFFLINE 2
	150
9cf9a798 SW	151	int cl_update;
9cf9a798 SW	152
984263bc MD	153	struct ciss_bmic_id_ldrive *cl_ldrive;
	154	struct ciss_bmic_id_lstatus *cl_lstatus;
	155	struct ciss_ldrive_geometry cl_geometry;
	156
	157	char cl_name[16]; /* device name */
	158	};
	159
	160	/*
9cf9a798 SW	161	* Per-physical-drive data
	162	*/
	163	struct ciss_pdrive
	164	{
	165	union ciss_device_address cp_address;
	166	int cp_online;
	167	};
	168
	169	#define CISS_PHYSICAL_SHIFT 5
	170	#define CISS_PHYSICAL_BASE (1 << CISS_PHYSICAL_SHIFT)
a8416dcf	171	#define CISS_MAX_PHYSTGT 256
9cf9a798 SW	172
	173	#define CISS_IS_PHYSICAL(bus) (bus >= CISS_PHYSICAL_BASE)
	174	#define CISS_CAM_TO_PBUS(bus) (bus - CISS_PHYSICAL_BASE)
	175
	176	/*
984263bc MD	177	* Per-adapter data
984263bc MD	178	*/
9cf9a798	179	struct ciss_softc
984263bc MD	180	{
	181	/* bus connections */
	182	device_t ciss_dev; /* bus attachment */
a8416dcf	183	struct cdev ciss_dev_t; / control device */
984263bc MD	184
	185	struct resource ciss_regs_resource; / register interface window */
	186	int ciss_regs_rid; /* resource ID */
	187	bus_space_handle_t ciss_regs_bhandle; /* bus space handle */
	188	bus_space_tag_t ciss_regs_btag; /* bus space tag */
	189
	190	struct resource ciss_cfg_resource; / config struct interface window */
	191	int ciss_cfg_rid; /* resource ID */
	192	struct ciss_config_table ciss_cfg; / config table in adapter memory */
a8416dcf	193	struct ciss_perf_config ciss_perf; / config table for the performant */
984263bc MD	194	struct ciss_bmic_id_table ciss_id; / ID table in host memory */
	195	u_int32_t ciss_heartbeat; /* last heartbeat value */
	196	int ciss_heart_attack; /* number of times we have seen this value */
	197
a8416dcf	198	int ciss_msi;
984263bc	199	struct resource ciss_irq_resource; / interrupt */
a8416dcf	200	int ciss_irq_rid[CISS_MSI_COUNT]; /* resource ID */
984263bc	201	void ciss_intr; / interrupt handle */
a8416dcf	202	int ciss_irq_type;
984263bc MD	203
	204	bus_dma_tag_t ciss_parent_dmat; /* parent DMA tag */
	205	bus_dma_tag_t ciss_buffer_dmat; /* data buffer/command DMA tag */
	206
	207	u_int32_t ciss_interrupt_mask; /* controller interrupt mask bits */
	208
a8416dcf SW	209	uint64_t *ciss_reply;
	210	int ciss_cycle;
	211	int ciss_rqidx;
	212	bus_dma_tag_t ciss_reply_dmat;
	213	bus_dmamap_t ciss_reply_map;
	214	uint32_t ciss_reply_phys;
	215
984263bc MD	216	int ciss_max_requests;
	217	struct ciss_request ciss_request[CISS_MAX_REQUESTS]; /* requests */
	218	void ciss_command; / command structures */
	219	bus_dma_tag_t ciss_command_dmat; /* command DMA tag */
	220	bus_dmamap_t ciss_command_map; /* command DMA map */
	221	u_int32_t ciss_command_phys; /* command array base address */
a8416dcf SW	222	cr_qhead_t ciss_free; /* requests available for reuse */
a8416dcf SW	223	cr_qhead_t ciss_notify; /* requests which are defered for processing */
9cf9a798	224	struct thread *ciss_notify_thread;
984263bc	225
3fb01875	226	struct callout ciss_periodic; /* periodic event handling */
984263bc MD	227	struct ciss_request ciss_periodic_notify; / notify callback request */
984263bc MD	228
a8416dcf	229	struct lock ciss_lock;
9cf9a798 SW	230	struct ciss_ldrive **ciss_logical;
	231	struct ciss_pdrive **ciss_physical;
	232	union ciss_device_address ciss_controllers; / controller address */
	233	int ciss_max_bus_number; /* maximum bus number */
	234	int ciss_max_logical_bus;
	235	int ciss_max_physical_bus;
984263bc MD	236
984263bc MD	237	struct cam_devq *ciss_cam_devq;
9cf9a798	238	struct cam_sim **ciss_cam_sim;
984263bc	239
a8416dcf SW	240	int ciss_soft_reset;
	241
	242	struct sysctl_ctx_list ciss_sysctl_ctx;
	243	struct sysctl_oid *ciss_sysctl_tree;
	244
984263bc MD	245	int ciss_flags;
	246	#define CISS_FLAG_NOTIFY_OK (1<<0) /* notify command running OK */
	247	#define CISS_FLAG_CONTROL_OPEN (1<<1) /* control device is open */
	248	#define CISS_FLAG_ABORTING (1<<2) /* driver is going away */
	249	#define CISS_FLAG_RUNNING (1<<3) /* driver is running (interrupts usable) */
a8416dcf	250	#define CISS_FLAG_BUSY (1<<4) /* no free commands */
984263bc MD	251
	252	#define CISS_FLAG_FAKE_SYNCH (1<<16) /* needs SYNCHRONISE_CACHE faked */
	253	#define CISS_FLAG_BMIC_ABORT (1<<17) /* use BMIC command to abort Notify on Event */
9cf9a798	254	#define CISS_FLAG_THREAD_SHUT (1<<20) /* shutdown the kthread */
984263bc MD	255
	256	struct ciss_qstat ciss_qstat[CISSQ_COUNT]; /* queue statistics */
	257	};
	258
984263bc MD	259	/************************************************************************
	260	* Debugging/diagnostic output.
	261	*/
	262
	263	/*
	264	* Debugging levels:
	265	* 0 - quiet, only emit warnings
	266	* 1 - talkative, log major events, but nothing on the I/O path
	267	* 2 - noisy, log events on the I/O path
	268	* 3 - extremely noisy, log items in loops
	269	*/
	270	#ifdef CISS_DEBUG
	271	# define debug(level, fmt, args...) \
	272	do { \
a8416dcf	273	if (level <= CISS_DEBUG) printf("%s: " fmt "\n", __func__ , ##args); \
984263bc MD	274	} while(0)
	275	# define debug_called(level) \
	276	do { \
a8416dcf	277	if (level <= CISS_DEBUG) printf("%s: called\n", __func__); \
984263bc	278	} while(0)
a8416dcf SW	279	# define debug_struct(s) printf(" SIZE %s: %zu\n", #s, sizeof(struct s))
	280	# define debug_union(s) printf(" SIZE %s: %zu\n", #s, sizeof(union s))
	281	# define debug_type(s) printf(" SIZE %s: %zu\n", #s, sizeof(s))
	282	# define debug_field(s, f) printf(" OFFSET %s.%s: %d\n", #s, #f, ((int)&(((struct s *)0)->f)))
	283	# define debug_const(c) printf(" CONST %s %jd/0x%jx\n", #c, (intmax_t)c, (intmax_t)c);
984263bc MD	284	#else
	285	# define debug(level, fmt, args...)
	286	# define debug_called(level)
	287	# define debug_struct(s)
	288	# define debug_union(s)
	289	# define debug_type(s)
	290	# define debug_field(s, f)
	291	# define debug_const(c)
	292	#endif
	293
	294	#define ciss_printf(sc, fmt, args...) device_printf(sc->ciss_dev, fmt , ##args)
	295
	296	/************************************************************************
	297	* Queue primitives
	298	*/
	299
	300	#define CISSQ_ADD(sc, qname) \
	301	do { \
	302	struct ciss_qstat *qs = &(sc)->ciss_qstat[qname]; \
	303	\
	304	qs->q_length++; \
	305	if (qs->q_length > qs->q_max) \
	306	qs->q_max = qs->q_length; \
	307	} while(0)
	308
	309	#define CISSQ_REMOVE(sc, qname) (sc)->ciss_qstat[qname].q_length--
	310	#define CISSQ_INIT(sc, qname) \
	311	do { \
	312	sc->ciss_qstat[qname].q_length = 0; \
	313	sc->ciss_qstat[qname].q_max = 0; \
	314	} while(0)
	315
	316
	317	#define CISSQ_REQUEST_QUEUE(name, index) \
	318	static __inline void \
	319	ciss_initq_ ## name (struct ciss_softc *sc) \
	320	{ \
a8416dcf	321	STAILQ_INIT(&sc->ciss_ ## name); \
984263bc MD	322	CISSQ_INIT(sc, index); \
	323	} \
	324	static __inline void \
	325	ciss_enqueue_ ## name (struct ciss_request *cr) \
	326	{ \
a8416dcf SW	327	\
a8416dcf SW	328	STAILQ_INSERT_TAIL(&cr->cr_sc->ciss_ ## name, cr, cr_link); \
984263bc MD	329	CISSQ_ADD(cr->cr_sc, index); \
984263bc MD	330	cr->cr_onq = index; \
984263bc MD	331	} \
	332	static __inline void \
	333	ciss_requeue_ ## name (struct ciss_request *cr) \
	334	{ \
a8416dcf SW	335	\
a8416dcf SW	336	STAILQ_INSERT_HEAD(&cr->cr_sc->ciss_ ## name, cr, cr_link); \
984263bc MD	337	CISSQ_ADD(cr->cr_sc, index); \
984263bc MD	338	cr->cr_onq = index; \
984263bc MD	339	} \
	340	static __inline struct ciss_request * \
	341	ciss_dequeue_ ## name (struct ciss_softc *sc) \
	342	{ \
	343	struct ciss_request *cr; \
984263bc	344	\
a8416dcf SW	345	if ((cr = STAILQ_FIRST(&sc->ciss_ ## name)) != NULL) { \
a8416dcf SW	346	STAILQ_REMOVE_HEAD(&sc->ciss_ ## name, cr_link); \
984263bc MD	347	CISSQ_REMOVE(sc, index); \
	348	cr->cr_onq = -1; \
	349	} \
984263bc MD	350	return(cr); \
984263bc MD	351	} \
984263bc MD	352	struct hack
	353
	354	CISSQ_REQUEST_QUEUE(free, CISSQ_FREE);
9cf9a798	355	CISSQ_REQUEST_QUEUE(notify, CISSQ_NOTIFY);
984263bc	356
a8416dcf SW	357	static __inline void
	358	ciss_enqueue_complete(struct ciss_request ac, cr_qhead_t head)
	359	{
	360
	361	STAILQ_INSERT_TAIL(head, ac, cr_link);
	362	}
	363
	364	static __inline struct ciss_request *
	365	ciss_dequeue_complete(struct ciss_softc sc, cr_qhead_t head)
	366	{
	367	struct ciss_request *ac;
	368
	369	if ((ac = STAILQ_FIRST(head)) != NULL)
	370	STAILQ_REMOVE_HEAD(head, cr_link);
	371	return(ac);
	372	}
	373
984263bc MD	374	/********************************************************************************
	375	* space-fill a character string
	376	*/
	377	static __inline void
	378	padstr(char targ, const char src, int len)
	379	{
	380	while (len-- > 0) {
	381	if (*src != 0) {
	382	targ++ = src++;
	383	} else {
	384	*targ++ = ' ';
	385	}
	386	}
	387	}
a8416dcf SW	388
	389	#define ciss_report_request(a, b, c) \
	390	_ciss_report_request(a, b, c, __FUNCTION__)