xref: /netbsd/sys/dev/pci/amrvar.h (revision bf9ec67e)
1 /*	$NetBSD: amrvar.h,v 1.1 2002/01/30 14:35:45 ad Exp $	*/
2 
3 /*-
4  * Copyright (c) 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_AMRVAR_H_
40 #define	_PCI_AMRVAR_H_
41 
42 #include "locators.h"
43 
44 #define	AMR_MAX_UNITS	16
45 
46 /*
47  * Logical drive information.
48  */
49 struct amr_logdrive {
50 	u_int		al_size;
51 	u_short		al_state;
52 	u_short		al_properties;
53 };
54 
55 /*
56  * Per-controller state.
57  */
58 struct amr_softc {
59 	/* Generic device data. */
60 	struct device		amr_dv;
61 	bus_space_tag_t		amr_iot;
62 	bus_space_handle_t	amr_ioh;
63 	bus_dma_tag_t		amr_dmat;
64 	bus_dmamap_t		amr_dmamap;
65 	void			*amr_ih;
66 
67 	/* Command mailbox. */
68 	struct amr_mailbox	*amr_mbox;
69 	bus_addr_t		amr_mbox_paddr;
70 
71 	/* Scatter-gather lists. */
72 	struct amr_sgentry	*amr_sgls;
73 	bus_addr_t		amr_sgls_paddr;
74 
75 	/* Command management. */
76 	struct amr_ccb		*amr_ccbs;
77 	SLIST_HEAD(, amr_ccb)	amr_ccb_freelist;
78 	SIMPLEQ_HEAD(, amr_ccb)	amr_ccb_queue;
79 	int			amr_maxqueuecnt;
80 
81 	/* Hardware-specific linkage. */
82 	int	(*amr_get_work)(struct amr_softc *, struct amr_mailbox *);
83 	int	(*amr_submit)(struct amr_softc *sc, struct amr_ccb *);
84 
85 	/* Logical drive information. */
86 	int			amr_numdrives;
87 	struct amr_logdrive	amr_drive[AMR_MAX_UNITS];
88 };
89 
90 /*
91  * Command control block.
92  */
93 struct amr_ccb {
94 	union {
95 		SIMPLEQ_ENTRY(amr_ccb) simpleq;
96 		SLIST_ENTRY(amr_ccb) slist;
97 	} ac_chain;
98 
99 	u_int		ac_flags;
100 	u_int		ac_status;
101 	u_int		ac_ident;
102 
103 	u_int		ac_xfer_size;
104 	bus_dmamap_t	ac_xfer_map;
105 
106 	struct amr_mailbox ac_mbox;
107 
108 	void		(*ac_handler)(struct amr_ccb *);
109 	void 		*ac_context;
110 	struct device	*ac_dv;
111 };
112 #define	AC_XFER_IN	0x01	/* Map describes inbound xfer */
113 #define	AC_XFER_OUT	0x02	/* Map describes outbound xfer */
114 #define	AC_COMPLETE	0x04	/* Command completed */
115 #define	AC_ACTIVE	0x08	/* Command active */
116 #define	AC_NOSGL	0x10	/* No scatter/gather list */
117 
118 struct amr_attach_args {
119 	int		amra_unit;
120 };
121 
122 #define	amracf_unit	cf_loc[AMRCF_UNIT]
123 
124 int	amr_ccb_alloc(struct amr_softc *, struct amr_ccb **);
125 void	amr_ccb_enqueue(struct amr_softc *, struct amr_ccb *);
126 void	amr_ccb_free(struct amr_softc *, struct amr_ccb *);
127 int	amr_ccb_map(struct amr_softc *, struct amr_ccb *, void *, int, int);
128 int	amr_ccb_poll(struct amr_softc *, struct amr_ccb *, int);
129 void	amr_ccb_unmap(struct amr_softc *, struct amr_ccb *);
130 
131 #endif	/* !_PCI_AMRVAR_H_ */
132