iopvar.h revision 1.2.2.2 1 1.2.2.2 bouyer /* $NetBSD: iopvar.h,v 1.2.2.2 2000/11/22 17:34:20 bouyer Exp $ */
2 1.2.2.2 bouyer
3 1.2.2.2 bouyer /*-
4 1.2.2.2 bouyer * Copyright (c) 2000 The NetBSD Foundation, Inc.
5 1.2.2.2 bouyer * All rights reserved.
6 1.2.2.2 bouyer *
7 1.2.2.2 bouyer * This code is derived from software contributed to The NetBSD Foundation
8 1.2.2.2 bouyer * by Andrew Doran.
9 1.2.2.2 bouyer *
10 1.2.2.2 bouyer * Redistribution and use in source and binary forms, with or without
11 1.2.2.2 bouyer * modification, are permitted provided that the following conditions
12 1.2.2.2 bouyer * are met:
13 1.2.2.2 bouyer * 1. Redistributions of source code must retain the above copyright
14 1.2.2.2 bouyer * notice, this list of conditions and the following disclaimer.
15 1.2.2.2 bouyer * 2. Redistributions in binary form must reproduce the above copyright
16 1.2.2.2 bouyer * notice, this list of conditions and the following disclaimer in the
17 1.2.2.2 bouyer * documentation and/or other materials provided with the distribution.
18 1.2.2.2 bouyer * 3. All advertising materials mentioning features or use of this software
19 1.2.2.2 bouyer * must display the following acknowledgement:
20 1.2.2.2 bouyer * This product includes software developed by the NetBSD
21 1.2.2.2 bouyer * Foundation, Inc. and its contributors.
22 1.2.2.2 bouyer * 4. Neither the name of The NetBSD Foundation nor the names of its
23 1.2.2.2 bouyer * contributors may be used to endorse or promote products derived
24 1.2.2.2 bouyer * from this software without specific prior written permission.
25 1.2.2.2 bouyer *
26 1.2.2.2 bouyer * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 1.2.2.2 bouyer * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 1.2.2.2 bouyer * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 1.2.2.2 bouyer * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 1.2.2.2 bouyer * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 1.2.2.2 bouyer * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 1.2.2.2 bouyer * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 1.2.2.2 bouyer * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 1.2.2.2 bouyer * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 1.2.2.2 bouyer * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 1.2.2.2 bouyer * POSSIBILITY OF SUCH DAMAGE.
37 1.2.2.2 bouyer */
38 1.2.2.2 bouyer
39 1.2.2.2 bouyer #ifndef _I2O_IOPVAR_H_
40 1.2.2.2 bouyer #define _I2O_IOPVAR_H_
41 1.2.2.2 bouyer
42 1.2.2.2 bouyer /* Per-IOP statistics; not particularly useful at the moment. */
43 1.2.2.2 bouyer struct iop_stat {
44 1.2.2.2 bouyer int is_cur_swqueue;
45 1.2.2.2 bouyer int is_peak_swqueue;
46 1.2.2.2 bouyer int is_cur_hwqueue;
47 1.2.2.2 bouyer int is_peak_hwqueue;
48 1.2.2.2 bouyer int64_t is_requests;
49 1.2.2.2 bouyer int64_t is_bytes;
50 1.2.2.2 bouyer };
51 1.2.2.2 bouyer
52 1.2.2.2 bouyer #ifdef _KERNEL
53 1.2.2.2 bouyer
54 1.2.2.2 bouyer #include "locators.h"
55 1.2.2.2 bouyer
56 1.2.2.2 bouyer /* XXX. Tunables. */
57 1.2.2.2 bouyer #define IOP_MAX_INITIATORS 32
58 1.2.2.2 bouyer #define IOP_MAX_PI_QUEUECNT 128
59 1.2.2.2 bouyer #define IOP_MAX_HW_QUEUECNT 256
60 1.2.2.2 bouyer #define IOP_MAX_HW_REPLYCNT 128
61 1.2.2.2 bouyer
62 1.2.2.2 bouyer /*
63 1.2.2.2 bouyer * XXX The following should be adjusted if and when:
64 1.2.2.2 bouyer *
65 1.2.2.2 bouyer * o MAXPHYS exceeds 64kB.
66 1.2.2.2 bouyer * o A new message or reply is defined in i2o.h.
67 1.2.2.2 bouyer *
68 1.2.2.2 bouyer * As it stands, these make for a message frame of 200 bytes.
69 1.2.2.2 bouyer */
70 1.2.2.2 bouyer #define IOP_MAX_SGL_SIZE 132 /* Maximum S/G list size */
71 1.2.2.2 bouyer #define IOP_MAX_BASE_MSG_SIZE 68 /* Maximum base message size */
72 1.2.2.2 bouyer #define IOP_MAX_XFER 65536 /* Maximum transfer size */
73 1.2.2.2 bouyer #define IOP_MAX_MSG_XFERS 3 /* Maximum transfer count per msg */
74 1.2.2.2 bouyer
75 1.2.2.2 bouyer #define IOP_MAX_SGL_ENTRIES (IOP_MAX_SGL_SIZE / 8)
76 1.2.2.2 bouyer #define IOP_MAX_MSG_SIZE (IOP_MAX_BASE_MSG_SIZE + IOP_MAX_SGL_SIZE)
77 1.2.2.2 bouyer
78 1.2.2.2 bouyer /*
79 1.2.2.2 bouyer * Transfer descriptor.
80 1.2.2.2 bouyer */
81 1.2.2.2 bouyer struct iop_xfer {
82 1.2.2.2 bouyer bus_dmamap_t ix_map;
83 1.2.2.2 bouyer u_int ix_size;
84 1.2.2.2 bouyer u_int ix_flags;
85 1.2.2.2 bouyer };
86 1.2.2.2 bouyer #define IX_IN 0x0001 /* Data transfer from IOP */
87 1.2.2.2 bouyer #define IX_OUT 0x0002 /* Data transfer to IOP */
88 1.2.2.2 bouyer
89 1.2.2.2 bouyer /*
90 1.2.2.2 bouyer * Message wrapper.
91 1.2.2.2 bouyer */
92 1.2.2.2 bouyer struct iop_msg {
93 1.2.2.2 bouyer SIMPLEQ_ENTRY(iop_msg) im_queue; /* Next queued message */
94 1.2.2.2 bouyer TAILQ_ENTRY(iop_msg) im_hash; /* Hash chain */
95 1.2.2.2 bouyer u_int im_flags; /* Control flags */
96 1.2.2.2 bouyer u_int im_tctx; /* Transaction context */
97 1.2.2.2 bouyer u_int im_tid; /* TID we're addressing */
98 1.2.2.2 bouyer void *im_dvcontext; /* Un*x device context */
99 1.2.2.2 bouyer u_int32_t im_msg[IOP_MAX_MSG_SIZE / sizeof(u_int32_t)];
100 1.2.2.2 bouyer struct iop_xfer im_xfer[IOP_MAX_MSG_XFERS];
101 1.2.2.2 bouyer };
102 1.2.2.2 bouyer
103 1.2.2.2 bouyer #define IM_SYSMASK 0x00ff
104 1.2.2.2 bouyer #define IM_REPLIED 0x0001 /* Message has been replied to */
105 1.2.2.2 bouyer #define IM_ALLOCED 0x0002 /* This message wrapper is allocated */
106 1.2.2.2 bouyer #define IM_WAITING 0x0004 /* Somebody is waiting for reply */
107 1.2.2.2 bouyer #define IM_SGLOFFADJ 0x0008 /* S/G list offset adjusted */
108 1.2.2.2 bouyer #define IM_DISCARD 0x0010 /* Discard message wrapper once sent */
109 1.2.2.2 bouyer
110 1.2.2.2 bouyer #define IM_USERMASK 0xff00
111 1.2.2.2 bouyer #define IM_NOWAIT 0x0100 /* Don't sleep when processing */
112 1.2.2.2 bouyer #define IM_NOICTX 0x0200 /* No initiator context field */
113 1.2.2.2 bouyer #define IM_NOINTR 0x0400 /* Don't interrupt when complete */
114 1.2.2.2 bouyer
115 1.2.2.2 bouyer struct iop_initiator {
116 1.2.2.2 bouyer struct device *ii_dv;
117 1.2.2.2 bouyer void (*ii_intr)(struct device *, struct iop_msg *, void *);
118 1.2.2.2 bouyer int ii_flags;
119 1.2.2.2 bouyer int ii_ictx;
120 1.2.2.2 bouyer };
121 1.2.2.2 bouyer #define II_DISCARD 0x0001 /* Don't track state; discard msg wrappers */
122 1.2.2.2 bouyer
123 1.2.2.2 bouyer #define IOP_ICTX 0
124 1.2.2.2 bouyer
125 1.2.2.2 bouyer /*
126 1.2.2.2 bouyer * Per-IOP context.
127 1.2.2.2 bouyer */
128 1.2.2.2 bouyer struct iop_softc {
129 1.2.2.2 bouyer struct device sc_dv; /* generic device data */
130 1.2.2.2 bouyer bus_space_handle_t sc_ioh; /* bus space handle */
131 1.2.2.2 bouyer bus_space_tag_t sc_iot; /* bus space tag */
132 1.2.2.2 bouyer bus_dma_tag_t sc_dmat; /* bus DMA tag */
133 1.2.2.2 bouyer void *sc_ih; /* interrupt handler cookie */
134 1.2.2.2 bouyer
135 1.2.2.2 bouyer struct i2o_hrt *sc_hrt; /* hardware resource table */
136 1.2.2.2 bouyer struct i2o_lct *sc_lct; /* logical configuration table */
137 1.2.2.2 bouyer int sc_nlctent; /* number of LCT entries */
138 1.2.2.2 bouyer u_int8_t *sc_lctmap; /* lct map (per-entry flags) */
139 1.2.2.2 bouyer struct i2o_status sc_status; /* status */
140 1.2.2.2 bouyer struct iop_stat sc_stat; /* counters */
141 1.2.2.2 bouyer int sc_flags; /* IOP-wide flags */
142 1.2.2.2 bouyer int sc_maxreplycnt; /* reply queue size */
143 1.2.2.2 bouyer
144 1.2.2.2 bouyer SIMPLEQ_HEAD(,iop_msg) sc_queue;/* software queue */
145 1.2.2.2 bouyer int sc_maxqueuecnt; /* maximum # of msgs on h/w queue */
146 1.2.2.2 bouyer
147 1.2.2.2 bouyer /*
148 1.2.2.2 bouyer * Reply queue.
149 1.2.2.2 bouyer */
150 1.2.2.2 bouyer bus_dmamap_t sc_rep_dmamap;
151 1.2.2.2 bouyer int sc_rep_size;
152 1.2.2.2 bouyer bus_addr_t sc_rep_phys;
153 1.2.2.2 bouyer caddr_t sc_rep;
154 1.2.2.2 bouyer
155 1.2.2.2 bouyer /*
156 1.2.2.2 bouyer * Initiator table.
157 1.2.2.2 bouyer */
158 1.2.2.2 bouyer struct iop_initiator *sc_itab[IOP_MAX_INITIATORS];
159 1.2.2.2 bouyer
160 1.2.2.2 bouyer /*
161 1.2.2.2 bouyer * The following are used only when posting the system table to
162 1.2.2.2 bouyer * the IOP. They describe PCI memory and I/O port regions.
163 1.2.2.2 bouyer */
164 1.2.2.2 bouyer bus_addr_t sc_memaddr;
165 1.2.2.2 bouyer int sc_memsize;
166 1.2.2.2 bouyer int sc_ioaddr;
167 1.2.2.2 bouyer int sc_iosize;
168 1.2.2.2 bouyer };
169 1.2.2.2 bouyer
170 1.2.2.2 bouyer #define IOP_OPEN 0x01 /* Device interface open */
171 1.2.2.2 bouyer #define IOP_LCTLKHELD 0x02 /* sc_lct lock held */
172 1.2.2.2 bouyer #define IOP_LCTLKWANTED 0x04 /* sc_lct lock wanted */
173 1.2.2.2 bouyer #define IOP_DRAIN 0x08 /* Draining IOP */
174 1.2.2.2 bouyer
175 1.2.2.2 bouyer #define IOP_LCTMAP_INUSE 0x01 /* target is in use */
176 1.2.2.2 bouyer
177 1.2.2.2 bouyer struct iop_attach_args {
178 1.2.2.2 bouyer int ia_class; /* device class */
179 1.2.2.2 bouyer int ia_tid; /* target ID */
180 1.2.2.2 bouyer };
181 1.2.2.2 bouyer #define iopcf_tid cf_loc[IOPCF_TID] /* TID */
182 1.2.2.2 bouyer
183 1.2.2.2 bouyer int iop_init(struct iop_softc *, const char *);
184 1.2.2.2 bouyer int iop_intr(void *);
185 1.2.2.2 bouyer int iop_params_get(struct iop_softc *, int, int, void *, int);
186 1.2.2.2 bouyer int iop_simple_cmd(struct iop_softc *, int, int, int);
187 1.2.2.2 bouyer void iop_strvis(const char *, int, char *, int);
188 1.2.2.2 bouyer
189 1.2.2.2 bouyer int iop_initiator_register(struct iop_softc *, struct iop_initiator *);
190 1.2.2.2 bouyer void iop_initiator_unregister(struct iop_softc *, struct iop_initiator *);
191 1.2.2.2 bouyer
192 1.2.2.2 bouyer int iop_lct_get(struct iop_softc *);
193 1.2.2.2 bouyer int iop_lct_lock(struct iop_softc *);
194 1.2.2.2 bouyer void iop_lct_unlock(struct iop_softc *);
195 1.2.2.2 bouyer
196 1.2.2.2 bouyer int iop_msg_alloc(struct iop_softc *, struct iop_initiator *,
197 1.2.2.2 bouyer struct iop_msg **, int);
198 1.2.2.2 bouyer int iop_msg_enqueue(struct iop_softc *, struct iop_msg *);
199 1.2.2.2 bouyer void iop_msg_free(struct iop_softc *, struct iop_initiator *,
200 1.2.2.2 bouyer struct iop_msg *);
201 1.2.2.2 bouyer int iop_msg_map(struct iop_softc *, struct iop_msg *, void *, int, int);
202 1.2.2.2 bouyer int iop_msg_send(struct iop_softc *, struct iop_msg *, int);
203 1.2.2.2 bouyer void iop_msg_unmap(struct iop_softc *, struct iop_msg *);
204 1.2.2.2 bouyer int iop_msg_wait(struct iop_softc *, struct iop_msg *, int);
205 1.2.2.2 bouyer
206 1.2.2.2 bouyer int iop_tid_claim(struct iop_softc *, int, int, int);
207 1.2.2.2 bouyer int iop_tid_inuse(struct iop_softc *, int);
208 1.2.2.2 bouyer int iop_tid_lct_index(struct iop_softc *, int);
209 1.2.2.2 bouyer void iop_tid_markallused(struct iop_softc *, int);
210 1.2.2.2 bouyer
211 1.2.2.2 bouyer #endif /* _KERNEL */
212 1.2.2.2 bouyer
213 1.2.2.2 bouyer #endif /* !_I2O_IOPVAR_H_ */
214