xref: /netbsd-src/sys/dev/pci/amrvar.h (revision 23c8222edbfb0f0932d88a8351d3a0cf817dfb9e)
1 /*	$NetBSD: amrvar.h,v 1.4 2004/09/13 12:55:48 drochner Exp $	*/
2 
3 /*-
4  * Copyright (c) 2002, 2003 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Andrew Doran.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *        This product includes software developed by the NetBSD
21  *        Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 #ifndef	_PCI_AMRVAR_H_
40 #define	_PCI_AMRVAR_H_
41 
42 #define	AMR_MAX_UNITS		16
43 #define	AMR_WDOG_TICKS		(hz * 5)
44 #define	AMR_NCCB_RESV		2
45 #define	AMR_ENQUIRY_BUFSIZE	2048
46 #define	AMR_SGL_SIZE		(sizeof(struct amr_sgentry) * AMR_MAX_SEGS)
47 #define	AMR_TIMEOUT		30
48 
49 /*
50  * Logical drive information.
51  */
52 struct amr_logdrive {
53 	u_int		al_size;
54 	u_short		al_state;
55 	u_short		al_properties;
56 	struct device	*al_dv;
57 };
58 
59 /*
60  * Per-controller state.
61  */
62 struct amr_softc {
63 	struct device		amr_dv;
64 	bus_space_tag_t		amr_iot;
65 	bus_space_handle_t	amr_ioh;
66 	bus_size_t		amr_ios;
67 	bus_dma_tag_t		amr_dmat;
68 	pci_chipset_tag_t	amr_pc;
69 	void			*amr_ih;
70 	struct proc		*amr_thread;
71 	int			amr_flags;
72 
73 	struct amr_mailbox	*amr_mbox;
74 	bus_addr_t		amr_mbox_paddr;
75 	bus_dmamap_t		amr_dmamap;
76         bus_dma_segment_t	amr_dmaseg;
77         int			amr_dmasize;
78         void			*amr_enqbuf;
79 
80 	struct amr_sgentry	*amr_sgls;
81 	bus_addr_t		amr_sgls_paddr;
82 
83 	struct amr_ccb		*amr_ccbs;
84 	SLIST_HEAD(, amr_ccb)	amr_ccb_freelist;
85 	SIMPLEQ_HEAD(, amr_ccb)	amr_ccb_queue;
86 	TAILQ_HEAD(, amr_ccb)	amr_ccb_active;
87 	int			amr_maxqueuecnt;
88 
89 	int	(*amr_get_work)(struct amr_softc *, struct amr_mailbox_resp *);
90 	int	(*amr_submit)(struct amr_softc *sc, struct amr_ccb *);
91 
92 	int			amr_numdrives;
93 	struct amr_logdrive	amr_drive[AMR_MAX_UNITS];
94 };
95 
96 /* What resources are allocated? */
97 #define	AMRF_INTR		0x00000001
98 #define	AMRF_DMA_LOAD		0x00000002
99 #define	AMRF_DMA_MAP		0x00000004
100 #define	AMRF_DMA_ALLOC		0x00000008
101 #define	AMRF_DMA_CREATE		0x00000010
102 #define	AMRF_PCI_INTR		0x00000020
103 #define	AMRF_PCI_REGS		0x00000040
104 #define	AMRF_CCBS		0x00000080
105 #define	AMRF_ENQBUF		0x00000100
106 #define	AMRF_THREAD		0x00000200
107 
108 /* General flags. */
109 #define	AMRF_THREAD_EXIT	0x00010000
110 
111 /*
112  * Command control block.
113  */
114 struct amr_ccb {
115 	union {
116 		SIMPLEQ_ENTRY(amr_ccb) simpleq;
117 		SLIST_ENTRY(amr_ccb) slist;
118 		TAILQ_ENTRY(amr_ccb) tailq;
119 	} ac_chain;
120 
121 	u_int		ac_flags;
122 	u_int		ac_status;
123 	u_int		ac_ident;
124 	u_int		ac_xfer_size;
125 	time_t		ac_start_time;
126 	bus_dmamap_t	ac_xfer_map;
127 	void		(*ac_handler)(struct amr_ccb *);
128 	void 		*ac_context;
129 	struct device	*ac_dv;
130 	struct amr_mailbox_cmd	ac_cmd;
131 };
132 #define	AC_XFER_IN	0x01	/* Map describes inbound xfer */
133 #define	AC_XFER_OUT	0x02	/* Map describes outbound xfer */
134 #define	AC_COMPLETE	0x04	/* Command completed */
135 #define	AC_ACTIVE	0x08	/* Command active */
136 #define	AC_NOSGL	0x10	/* No scatter/gather list */
137 #define AC_MOAN		0x20	/* We have already moaned */
138 
139 struct amr_attach_args {
140 	int		amra_unit;
141 };
142 
143 int	amr_ccb_alloc(struct amr_softc *, struct amr_ccb **);
144 void	amr_ccb_enqueue(struct amr_softc *, struct amr_ccb *);
145 void	amr_ccb_free(struct amr_softc *, struct amr_ccb *);
146 int	amr_ccb_map(struct amr_softc *, struct amr_ccb *, void *, int, int);
147 int	amr_ccb_poll(struct amr_softc *, struct amr_ccb *, int);
148 void	amr_ccb_unmap(struct amr_softc *, struct amr_ccb *);
149 int	amr_ccb_wait(struct amr_softc *, struct amr_ccb *);
150 const char	*amr_drive_state(int, int *);
151 
152 extern int	amr_max_xfer;
153 
154 #endif	/* !_PCI_AMRVAR_H_ */
155