xref: /netbsd-src/sys/dev/pci/amrvar.h (revision d710132b4b8ce7f7cccaaf660cb16aa16b4077a0)
1 /*	$NetBSD: amrvar.h,v 1.3 2003/05/14 11:22:55 ad 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 #include "locators.h"
43 
44 #define	AMR_MAX_UNITS		16
45 #define	AMR_WDOG_TICKS		(hz * 5)
46 #define	AMR_NCCB_RESV		2
47 #define	AMR_ENQUIRY_BUFSIZE	2048
48 #define	AMR_SGL_SIZE		(sizeof(struct amr_sgentry) * AMR_MAX_SEGS)
49 #define	AMR_TIMEOUT		30
50 
51 /*
52  * Logical drive information.
53  */
54 struct amr_logdrive {
55 	u_int		al_size;
56 	u_short		al_state;
57 	u_short		al_properties;
58 	struct device	*al_dv;
59 };
60 
61 /*
62  * Per-controller state.
63  */
64 struct amr_softc {
65 	struct device		amr_dv;
66 	bus_space_tag_t		amr_iot;
67 	bus_space_handle_t	amr_ioh;
68 	bus_size_t		amr_ios;
69 	bus_dma_tag_t		amr_dmat;
70 	pci_chipset_tag_t	amr_pc;
71 	void			*amr_ih;
72 	struct proc		*amr_thread;
73 	int			amr_flags;
74 
75 	struct amr_mailbox	*amr_mbox;
76 	bus_addr_t		amr_mbox_paddr;
77 	bus_dmamap_t		amr_dmamap;
78         bus_dma_segment_t	amr_dmaseg;
79         int			amr_dmasize;
80         void			*amr_enqbuf;
81 
82 	struct amr_sgentry	*amr_sgls;
83 	bus_addr_t		amr_sgls_paddr;
84 
85 	struct amr_ccb		*amr_ccbs;
86 	SLIST_HEAD(, amr_ccb)	amr_ccb_freelist;
87 	SIMPLEQ_HEAD(, amr_ccb)	amr_ccb_queue;
88 	TAILQ_HEAD(, amr_ccb)	amr_ccb_active;
89 	int			amr_maxqueuecnt;
90 
91 	int	(*amr_get_work)(struct amr_softc *, struct amr_mailbox_resp *);
92 	int	(*amr_submit)(struct amr_softc *sc, struct amr_ccb *);
93 
94 	int			amr_numdrives;
95 	struct amr_logdrive	amr_drive[AMR_MAX_UNITS];
96 };
97 
98 /* What resources are allocated? */
99 #define	AMRF_INTR		0x00000001
100 #define	AMRF_DMA_LOAD		0x00000002
101 #define	AMRF_DMA_MAP		0x00000004
102 #define	AMRF_DMA_ALLOC		0x00000008
103 #define	AMRF_DMA_CREATE		0x00000010
104 #define	AMRF_PCI_INTR		0x00000020
105 #define	AMRF_PCI_REGS		0x00000040
106 #define	AMRF_CCBS		0x00000080
107 #define	AMRF_ENQBUF		0x00000100
108 #define	AMRF_THREAD		0x00000200
109 
110 /* General flags. */
111 #define	AMRF_THREAD_EXIT	0x00010000
112 
113 /*
114  * Command control block.
115  */
116 struct amr_ccb {
117 	union {
118 		SIMPLEQ_ENTRY(amr_ccb) simpleq;
119 		SLIST_ENTRY(amr_ccb) slist;
120 		TAILQ_ENTRY(amr_ccb) tailq;
121 	} ac_chain;
122 
123 	u_int		ac_flags;
124 	u_int		ac_status;
125 	u_int		ac_ident;
126 	u_int		ac_xfer_size;
127 	time_t		ac_start_time;
128 	bus_dmamap_t	ac_xfer_map;
129 	void		(*ac_handler)(struct amr_ccb *);
130 	void 		*ac_context;
131 	struct device	*ac_dv;
132 	struct amr_mailbox_cmd	ac_cmd;
133 };
134 #define	AC_XFER_IN	0x01	/* Map describes inbound xfer */
135 #define	AC_XFER_OUT	0x02	/* Map describes outbound xfer */
136 #define	AC_COMPLETE	0x04	/* Command completed */
137 #define	AC_ACTIVE	0x08	/* Command active */
138 #define	AC_NOSGL	0x10	/* No scatter/gather list */
139 #define AC_MOAN		0x20	/* We have already moaned */
140 
141 struct amr_attach_args {
142 	int		amra_unit;
143 };
144 
145 #define	amracf_unit	cf_loc[AMRCF_UNIT]
146 
147 int	amr_ccb_alloc(struct amr_softc *, struct amr_ccb **);
148 void	amr_ccb_enqueue(struct amr_softc *, struct amr_ccb *);
149 void	amr_ccb_free(struct amr_softc *, struct amr_ccb *);
150 int	amr_ccb_map(struct amr_softc *, struct amr_ccb *, void *, int, int);
151 int	amr_ccb_poll(struct amr_softc *, struct amr_ccb *, int);
152 void	amr_ccb_unmap(struct amr_softc *, struct amr_ccb *);
153 int	amr_ccb_wait(struct amr_softc *, struct amr_ccb *);
154 const char	*amr_drive_state(int, int *);
155 
156 extern int	amr_max_xfer;
157 
158 #endif	/* !_PCI_AMRVAR_H_ */
159