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