xref: /netbsd-src/sys/dev/pci/twevar.h (revision 7cc2f76925f078d01ddc9e640a98f4ccfc9f8c3b)
1 /*	$NetBSD: twevar.h,v 1.4 2000/11/14 18:42:59 thorpej Exp $	*/
2 
3 /*-
4  * Copyright (c) 2000 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 /*-
40  * Copyright (c) 2000 Michael Smith
41  * Copyright (c) 2000 BSDi
42  * All rights reserved.
43  *
44  * Redistribution and use in source and binary forms, with or without
45  * modification, are permitted provided that the following conditions
46  * are met:
47  * 1. Redistributions of source code must retain the above copyright
48  *    notice, this list of conditions and the following disclaimer.
49  * 2. Redistributions in binary form must reproduce the above copyright
50  *    notice, this list of conditions and the following disclaimer in the
51  *    documentation and/or other materials provided with the distribution.
52  *
53  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
54  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
55  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
56  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
57  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
58  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
59  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
60  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
61  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
62  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
63  * SUCH DAMAGE.
64  *
65  * from FreeBSD: twevar.h,v 1.1 2000/05/24 23:35:23 msmith Exp
66  */
67 
68 #ifndef _PCI_TWEVAR_H_
69 #define	_PCI_TWEVAR_H_
70 
71 #include "locators.h"
72 
73 #define	TWE_MIN_QUEUECNT	9	/* One per unit + one for AENs */
74 
75 #ifndef TWE_MAX_QUEUECNT
76 #define	TWE_MAX_QUEUECNT	128	/* Maximum per-adapter queue count */
77 #elif TWE_MAX_QUEUECNT > TWE_MAX_CMDS
78 #error TWE_MAX_QUEUECNT > TWE_MAX_CMDS
79 #elif TWE_MAX_QUEUECNT < TWE_MIN_QUEUECNT
80 #error TWE_MAX_QUEUECNT < TWE_MIN_QUEUECNT
81 #endif
82 
83 #ifndef TWE_MAX_PU_QUEUECNT
84 #define	TWE_MAX_PU_QUEUECNT	32	/* Maximum per-unit queue count */
85 #endif
86 
87 /* XXX NBPG */
88 #if TWE_SG_SIZE > (((MAXPHYS + NBPG - 1) / NBPG) + 1)
89 #define	TWE_MAX_SEGS	(((MAXPHYS + NBPG - 1) / NBPG) + 1)
90 #else
91 #define	TWE_MAX_SEGS	TWE_SG_SIZE
92 #endif
93 
94 /* Per-controller state. */
95 struct twe_softc {
96 	struct device		sc_dv;
97 	bus_space_tag_t		sc_iot;
98 	bus_space_handle_t	sc_ioh;
99 	bus_dma_tag_t		sc_dmat;
100 	bus_dmamap_t		sc_dmamap;
101 	void			*sc_ih;
102 	caddr_t			sc_cmds;
103 	bus_addr_t		sc_cmds_paddr;
104 	int			sc_nccbs;
105 	struct twe_ccb		*sc_ccbs;
106 	SIMPLEQ_HEAD(, twe_ccb)	sc_ccb_queue;
107 	SLIST_HEAD(, twe_ccb)	sc_ccb_freelist;
108 	int			sc_nunits;
109 	u_int			sc_dsize[TWE_MAX_UNITS];
110 };
111 
112 /* Optional per-command context. */
113 struct twe_context {
114 	void	(*tx_handler)(struct twe_ccb *, int);
115 	void 	*tx_context;
116 	struct	device	*tx_dv;
117 };
118 
119 /* Command control block. */
120 struct twe_ccb {
121 	union {
122 		SIMPLEQ_ENTRY(twe_ccb) simpleq;
123 		SLIST_ENTRY(twe_ccb) slist;
124 	} ccb_chain;
125 	struct twe_cmd	*ccb_cmd;
126 	int		ccb_cmdid;
127 	int		ccb_flags;
128 	void		*ccb_data;
129 	int		ccb_datasize;
130 	vaddr_t		ccb_abuf;
131 	bus_dmamap_t	ccb_dmamap_xfer;
132 	struct twe_context ccb_tx;
133 };
134 #define	TWE_CCB_DATA_IN		0x01	/* Map describes inbound xfer */
135 #define	TWE_CCB_DATA_OUT	0x02	/* Map describes outbound xfer */
136 #define	TWE_CCB_COMPLETE	0x04	/* Command completed */
137 #define	TWE_CCB_ACTIVE		0x08	/* Command active */
138 #define	TWE_CCB_PARAM		0x10	/* For parameter retrieval */
139 #define	TWE_CCB_ALLOCED		0x20	/* CCB allocated */
140 
141 struct twe_attach_args {
142 	int		twea_unit;
143 };
144 
145 #define	tweacf_unit	cf_loc[TWECF_UNIT]
146 
147 int	twe_ccb_alloc(struct twe_softc *, struct twe_ccb **, int);
148 void	twe_ccb_enqueue(struct twe_softc *sc, struct twe_ccb *ccb);
149 void	twe_ccb_free(struct twe_softc *sc, struct twe_ccb *);
150 int	twe_ccb_map(struct twe_softc *, struct twe_ccb *);
151 int	twe_ccb_poll(struct twe_softc *, struct twe_ccb *, int);
152 int	twe_ccb_submit(struct twe_softc *, struct twe_ccb *);
153 void	twe_ccb_unmap(struct twe_softc *, struct twe_ccb *);
154 
155 #endif	/* !_PCI_TWEVAR_H_ */
156