2 * Copyright (c) 1998, 1999 Nicolas Souchu
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * $FreeBSD: src/sys/dev/ppbus/ppb_msq.c,v 1.9.2.1 2000/05/24 00:20:57 n_hibma Exp $
27 * $DragonFly: src/sys/bus/ppbus/ppb_msq.c,v 1.9 2006/12/22 23:12:17 swildner Exp $
30 #include <machine/stdarg.h>
32 #include <sys/param.h>
33 #include <sys/systm.h>
41 /* msq index (see PPB_MAX_XFER)
42 * These are device modes
44 #define COMPAT_MSQ 0x0
45 #define NIBBLE_MSQ 0x1
52 * Device mode to submsq conversion
54 static struct ppb_xfer
*
55 mode2xfer(device_t bus
, struct ppb_device
*ppbdev
, int opcode
)
58 struct ppb_xfer
*table
;
62 table
= ppbdev
->get_xfer
;
66 table
= ppbdev
->put_xfer
;
70 panic("%s: unknown opcode (%d)", __func__
, opcode
);
73 /* retrieve the device operating mode */
74 switch (ppb_get_mode(bus
)) {
85 switch ((epp
= ppb_get_epp_protocol(bus
))) {
93 panic("%s: unknown EPP protocol (0x%x)!", __func__
,
101 panic("%s: unknown mode (%d)", __func__
, ppbdev
->mode
);
104 return (&table
[index
]);
110 * Initialize device dependent submicrosequence of the current mode
114 ppb_MS_init(device_t bus
, device_t dev
, struct ppb_microseq
*loop
, int opcode
)
116 struct ppb_device
*ppbdev
= (struct ppb_device
*)device_get_ivars(dev
);
117 struct ppb_xfer
*xfer
= mode2xfer(bus
, ppbdev
, opcode
);
127 * Execute any microsequence opcode - expensive
131 ppb_MS_exec(device_t bus
, device_t dev
, int opcode
, union ppb_insarg param1
,
132 union ppb_insarg param2
, union ppb_insarg param3
, int *ret
)
134 struct ppb_microseq msq
[] = {
135 { MS_UNKNOWN
, { { MS_UNKNOWN
}, { MS_UNKNOWN
}, { MS_UNKNOWN
} } },
139 /* initialize the corresponding microseq */
140 msq
[0].opcode
= opcode
;
141 msq
[0].arg
[0] = param1
;
142 msq
[0].arg
[1] = param2
;
143 msq
[0].arg
[2] = param3
;
145 /* execute the microseq */
146 return (ppb_MS_microseq(bus
, dev
, msq
, ret
));
152 * Execute a microseq loop
156 ppb_MS_loop(device_t bus
, device_t dev
, struct ppb_microseq
*prolog
,
157 struct ppb_microseq
*body
, struct ppb_microseq
*epilog
,
160 struct ppb_microseq loop_microseq
[] = {
161 MS_CALL(0), /* execute prolog */
163 MS_SET(MS_UNKNOWN
), /* set size of transfer */
165 MS_CALL(0), /* execute body */
166 MS_DBRA(-1 /* loop: */),
168 MS_CALL(0), /* execute epilog */
172 /* initialize the structure */
173 loop_microseq
[0].arg
[0].p
= (void *)prolog
;
174 loop_microseq
[1].arg
[0].i
= iter
;
175 loop_microseq
[2].arg
[0].p
= (void *)body
;
176 loop_microseq
[4].arg
[0].p
= (void *)epilog
;
178 /* execute the loop */
179 return (ppb_MS_microseq(bus
, dev
, loop_microseq
, ret
));
185 * Initialize a microsequence - see macros in ppb_msq.h
189 ppb_MS_init_msq(struct ppb_microseq
*msq
, int nbparam
, ...)
192 int param
, ins
, arg
, type
;
195 __va_start(p_list
, nbparam
);
197 for (i
=0; i
<nbparam
; i
++) {
198 /* retrieve the parameter descriptor */
199 param
= __va_arg(p_list
, int);
203 type
= MS_TYP(param
);
205 /* check the instruction position */
206 if (arg
>= PPB_MS_MAXARGS
)
207 panic("%s: parameter out of range (0x%x)!",
211 kprintf("%s: param = %d, ins = %d, arg = %d, type = %d\n",
212 __func__
, param
, ins
, arg
, type
);
215 /* properly cast the parameter */
218 msq
[ins
].arg
[arg
].i
= __va_arg(p_list
, int);
222 msq
[ins
].arg
[arg
].i
= (int)__va_arg(p_list
, int);
226 msq
[ins
].arg
[arg
].p
= __va_arg(p_list
, void *);
230 msq
[ins
].arg
[arg
].f
= __va_arg(p_list
, void *);
234 panic("%s: unknown parameter (0x%x)!", __func__
,
245 * Interprete a microsequence. Some microinstructions are executed at adapter
246 * level to avoid function call overhead between ppbus and the adapter
249 ppb_MS_microseq(device_t bus
, device_t dev
, struct ppb_microseq
*msq
, int *ret
)
251 struct ppb_data
*ppb
= (struct ppb_data
*)device_get_softc(bus
);
252 struct ppb_device
*ppbdev
= (struct ppb_device
*)device_get_ivars(dev
);
254 struct ppb_microseq
*mi
; /* current microinstruction */
257 struct ppb_xfer
*xfer
;
259 /* microsequence executed to initialize the transfer */
260 struct ppb_microseq initxfer
[] = {
261 MS_PTR(MS_UNKNOWN
), /* set ptr to buffer */
262 MS_SET(MS_UNKNOWN
), /* set transfer size */
266 if (ppb
->ppb_owner
!= dev
)
269 #define INCR_PC (mi ++)
273 switch (mi
->opcode
) {
277 /* attempt to choose the best mode for the device */
278 xfer
= mode2xfer(bus
, ppbdev
, mi
->opcode
);
280 /* figure out if we should use ieee1284 code */
282 if (mi
->opcode
== MS_OP_PUT
) {
283 if ((error
= PPBUS_WRITE(
284 device_get_parent(bus
),
285 (char *)mi
->arg
[0].p
,
292 panic("%s: IEEE1284 read not supported", __func__
);
296 /* XXX should use ppb_MS_init_msq() */
297 initxfer
[0].arg
[0].p
= mi
->arg
[0].p
;
298 initxfer
[1].arg
[0].i
= mi
->arg
[1].i
;
300 /* initialize transfer */
301 ppb_MS_microseq(bus
, dev
, initxfer
, &error
);
306 /* the xfer microsequence should not contain any
307 * MS_OP_PUT or MS_OP_GET!
309 ppb_MS_microseq(bus
, dev
, xfer
->loop
, &error
);
319 *ret
= mi
->arg
[0].i
; /* return code */
324 /* executing microinstructions at ppc level is
325 * faster. This is the default if the microinstr
328 if ((error
= PPBUS_EXEC_MICROSEQ(
329 device_get_parent(bus
), &mi
)))