xref: /netbsd-src/sys/dev/pci/twevar.h (revision 220b5c059a84c51ea44107ea8951a57ffaecdc8c)
1 /*	$NetBSD: twevar.h,v 1.9 2001/10/10 09:33:36 ad Exp $	*/
2 
3 /*-
4  * Copyright (c) 2000, 2001 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_TWEVAR_H_
40 #define	_PCI_TWEVAR_H_
41 
42 #include "locators.h"
43 
44 #define	TWE_MAX_QUEUECNT	129
45 
46 /* XXX NBPG */
47 #if TWE_SG_SIZE > (((MAXPHYS + NBPG - 1) / NBPG) + 1)
48 #define	TWE_MAX_SEGS	(((MAXPHYS + NBPG - 1) / NBPG) + 1)
49 #else
50 #define	TWE_MAX_SEGS	TWE_SG_SIZE
51 #endif
52 #define	TWE_MAX_XFER	((TWE_MAX_SEGS - 1) * NBPG)
53 
54 /* Per-controller state. */
55 struct twe_softc {
56 	struct device		sc_dv;
57 	bus_space_tag_t		sc_iot;
58 	bus_space_handle_t	sc_ioh;
59 	bus_dma_tag_t		sc_dmat;
60 	bus_dmamap_t		sc_dmamap;
61 	void			*sc_ih;
62 	caddr_t			sc_cmds;
63 	bus_addr_t		sc_cmds_paddr;
64 	int			sc_nccbs;
65 	struct twe_ccb		*sc_ccbs;
66 	SIMPLEQ_HEAD(, twe_ccb)	sc_ccb_queue;
67 	SLIST_HEAD(, twe_ccb)	sc_ccb_freelist;
68 	int			sc_flags;
69 	int			sc_nunits;
70 	u_int			sc_dsize[TWE_MAX_UNITS];
71 };
72 #define	TWEF_AEN	0x01	/* retrieving an AEN */
73 
74 /* Optional per-command context. */
75 struct twe_context {
76 	void	(*tx_handler)(struct twe_ccb *, int);
77 	void 	*tx_context;
78 	struct	device	*tx_dv;
79 };
80 
81 /* Command control block. */
82 struct twe_ccb {
83 	union {
84 		SIMPLEQ_ENTRY(twe_ccb) simpleq;
85 		SLIST_ENTRY(twe_ccb) slist;
86 	} ccb_chain;
87 	struct twe_cmd	*ccb_cmd;
88 	int		ccb_cmdid;
89 	int		ccb_flags;
90 	void		*ccb_data;
91 	int		ccb_datasize;
92 	vaddr_t		ccb_abuf;
93 	bus_dmamap_t	ccb_dmamap_xfer;
94 	struct twe_context ccb_tx;
95 };
96 #define	TWE_CCB_DATA_IN		0x01	/* Map describes inbound xfer */
97 #define	TWE_CCB_DATA_OUT	0x02	/* Map describes outbound xfer */
98 #define	TWE_CCB_COMPLETE	0x04	/* Command completed */
99 #define	TWE_CCB_ACTIVE		0x08	/* Command active */
100 #define	TWE_CCB_PARAM		0x10	/* For parameter retrieval */
101 #define	TWE_CCB_ALLOCED		0x20	/* CCB allocated */
102 
103 struct twe_attach_args {
104 	int		twea_unit;
105 };
106 
107 #define	tweacf_unit	cf_loc[TWECF_UNIT]
108 
109 int	twe_ccb_alloc(struct twe_softc *, struct twe_ccb **, int);
110 void	twe_ccb_enqueue(struct twe_softc *sc, struct twe_ccb *ccb);
111 void	twe_ccb_free(struct twe_softc *sc, struct twe_ccb *);
112 int	twe_ccb_map(struct twe_softc *, struct twe_ccb *);
113 int	twe_ccb_poll(struct twe_softc *, struct twe_ccb *, int);
114 int	twe_ccb_submit(struct twe_softc *, struct twe_ccb *);
115 void	twe_ccb_unmap(struct twe_softc *, struct twe_ccb *);
116 
117 #endif	/* !_PCI_TWEVAR_H_ */
118