iopvar.h revision 1.12 1 /* $NetBSD: iopvar.h,v 1.12 2002/11/15 13:51:30 ad 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 _I2O_IOPVAR_H_
40 #define _I2O_IOPVAR_H_
41
42 #include "locators.h"
43
44 /*
45 * Transfer descriptor.
46 */
47 struct iop_xfer {
48 bus_dmamap_t ix_map;
49 u_int ix_size;
50 u_int ix_flags;
51 };
52 #define IX_IN 0x0001 /* Data transfer from IOP */
53 #define IX_OUT 0x0002 /* Data transfer to IOP */
54
55 /*
56 * Message wrapper.
57 */
58 struct iop_msg {
59 SLIST_ENTRY(iop_msg) im_chain; /* Next free message */
60 u_int im_flags; /* Control flags */
61 u_int im_tctx; /* Transaction context */
62 void *im_dvcontext; /* Un*x device context */
63 struct i2o_reply *im_rb; /* Reply buffer */
64 u_int im_reqstatus; /* Status from reply */
65 struct iop_xfer im_xfer[IOP_MAX_MSG_XFERS];
66 };
67 #define IM_SYSMASK 0x00ff
68 #define IM_REPLIED 0x0001 /* Message has been replied to */
69 #define IM_ALLOCED 0x0002 /* This message wrapper is allocated */
70 #define IM_SGLOFFADJ 0x0004 /* S/G list offset adjusted */
71 #define IM_FAIL 0x0008 /* Transaction error returned */
72
73 #define IM_USERMASK 0xff00
74 #define IM_WAIT 0x0100 /* Wait (sleep) for completion */
75 #define IM_POLL 0x0200 /* Wait (poll) for completion */
76 #define IM_NOSTATUS 0x0400 /* Don't check status if waiting */
77 #define IM_POLL_INTR 0x0800 /* Do send interrupt when polling */
78
79 struct iop_initiator {
80 LIST_ENTRY(iop_initiator) ii_list;
81 LIST_ENTRY(iop_initiator) ii_hash;
82
83 void (*ii_intr)(struct device *, struct iop_msg *, void *);
84 int (*ii_reconfig)(struct device *);
85 void (*ii_adjqparam)(struct device *, int);
86
87 struct device *ii_dv;
88 int ii_flags;
89 int ii_ictx; /* Initiator context */
90 int ii_tid;
91 };
92 #define II_NOTCTX 0x0001 /* No transaction context */
93 #define II_CONFIGURED 0x0002 /* Already configured */
94 #define II_UTILITY 0x0004 /* Utility initiator (not a real device) */
95
96 #define IOP_ICTX 0
97 #define IOP_INIT_CODE 0x80
98
99 /*
100 * Parameter group op (for async parameter retrievals).
101 */
102 struct iop_pgop {
103 struct i2o_param_op_list_header olh;
104 struct i2o_param_op_all_template oat;
105 } __attribute__ ((__packed__));
106
107 /*
108 * Per-IOP context.
109 */
110 struct iop_softc {
111 struct device sc_dv; /* Generic device data */
112 bus_space_handle_t sc_ioh; /* Bus space handle */
113 bus_space_tag_t sc_iot; /* Bus space tag */
114 bus_dma_tag_t sc_dmat; /* Bus DMA tag */
115 bus_space_handle_t sc_msg_ioh; /* Message queue bus space handle */
116 bus_space_tag_t sc_msg_iot; /* Message queue bus space tag */
117 void *sc_ih; /* Interrupt handler cookie */
118
119 struct iop_msg *sc_ims; /* Message wrappers */
120 SLIST_HEAD(, iop_msg) sc_im_freelist; /* Free wrapper list */
121
122 bus_dmamap_t sc_rep_dmamap; /* Reply frames DMA map */
123 int sc_rep_size; /* Reply frames size */
124 bus_addr_t sc_rep_phys; /* Reply frames PA */
125 caddr_t sc_rep; /* Reply frames VA */
126
127 int sc_maxib; /* Max inbound (-> IOP) queue depth */
128 int sc_maxob; /* Max outbound (<- IOP) queue depth */
129 int sc_curib; /* Current inbound queue depth */
130 int sc_framesize; /* Max msg frame size in bytes */
131
132 struct i2o_hrt *sc_hrt; /* Hardware resource table */
133 struct iop_tidmap *sc_tidmap; /* TID map (per-LCT-entry flags) */
134 struct i2o_lct *sc_lct; /* Logical configuration table */
135 int sc_nlctent; /* Number of LCT entries */
136 int sc_flags; /* IOP-wide flags */
137 u_int32_t sc_chgind; /* Configuration change indicator */
138 struct lock sc_conflock; /* Configuration lock */
139 struct proc *sc_reconf_proc;/* Auto reconfiguration process */
140 LIST_HEAD(, iop_initiator) sc_iilist;/* Initiator list */
141 int sc_nii; /* Total number of initiators */
142 int sc_nuii; /* Number of utility initiators */
143
144 struct iop_initiator sc_eventii;/* IOP event handler */
145 bus_dmamap_t sc_scr_dmamap; /* Scratch DMA map */
146 bus_dma_segment_t sc_scr_seg[1];/* Scratch DMA segment */
147 caddr_t sc_scr; /* Scratch memory VA */
148
149 bus_space_tag_t sc_bus_memt; /* Parent bus memory tag */
150 bus_space_tag_t sc_bus_iot; /* Parent but I/O tag */
151 bus_addr_t sc_memaddr; /* Register window address */
152 bus_size_t sc_memsize; /* Register window size */
153 int sc_pcibus; /* PCI bus number */
154 int sc_pcidev; /* PCI device number */
155
156 struct i2o_status sc_status; /* Last retrieved status record */
157 };
158 #define IOP_OPEN 0x01 /* Device interface open */
159 #define IOP_HAVESTATUS 0x02 /* Successfully retrieved status */
160 #define IOP_ONLINE 0x04 /* Can use ioctl interface */
161
162 struct iop_attach_args {
163 int ia_class; /* device class */
164 int ia_tid; /* target ID */
165 };
166 #define iopcf_tid cf_loc[IOPCF_TID] /* TID */
167
168 void iop_init(struct iop_softc *, const char *);
169 int iop_intr(void *);
170 int iop_lct_get(struct iop_softc *);
171 int iop_print_ident(struct iop_softc *, int);
172 int iop_post(struct iop_softc *, u_int32_t *);
173 int iop_reconfigure(struct iop_softc *, u_int);
174 int iop_status_get(struct iop_softc *, int);
175 int iop_simple_cmd(struct iop_softc *, int, int, int, int, int);
176 void iop_strvis(struct iop_softc *, const char *, int, char *, int);
177
178 void iop_initiator_register(struct iop_softc *, struct iop_initiator *);
179 void iop_initiator_unregister(struct iop_softc *, struct iop_initiator *);
180
181 struct iop_msg *iop_msg_alloc(struct iop_softc *, int);
182 void iop_msg_free(struct iop_softc *, struct iop_msg *);
183 int iop_msg_map(struct iop_softc *, struct iop_msg *, u_int32_t *, void *,
184 int, int, struct proc *);
185 int iop_msg_map_bio(struct iop_softc *, struct iop_msg *, u_int32_t *,
186 void *, int, int);
187 int iop_msg_post(struct iop_softc *, struct iop_msg *, void *, int);
188 void iop_msg_unmap(struct iop_softc *, struct iop_msg *);
189
190 int iop_field_get_all(struct iop_softc *, int, int, void *, int,
191 struct iop_initiator *);
192 int iop_field_set(struct iop_softc *, int, int, void *, int, int);
193 int iop_table_add_row(struct iop_softc *, int, int, void *, int, int);
194 int iop_table_clear(struct iop_softc *, int, int);
195 int iop_table_del_row(struct iop_softc *, int, int, int);
196 int iop_table_get_row(struct iop_softc *, int, int, void *, int, int);
197
198 int iop_util_abort(struct iop_softc *, struct iop_initiator *, int, int,
199 int);
200 int iop_util_claim(struct iop_softc *, struct iop_initiator *, int, int);
201 int iop_util_eventreg(struct iop_softc *, struct iop_initiator *, int);
202
203 #endif /* !_I2O_IOPVAR_H_ */
204