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