xref: /dragonfly/sys/bus/ppbus/ppb_msq.h (revision 86d7f5d3)
1 /*-
2  * Copyright (c) 1998 Nicolas Souchu
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
13  *
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
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD: src/sys/dev/ppbus/ppb_msq.h,v 1.8 2000/01/14 00:17:55 nsouch Exp $
27  * $DragonFly: src/sys/bus/ppbus/ppb_msq.h,v 1.2 2003/06/17 04:28:29 dillon Exp $
28  *
29  */
30 #ifndef __PPB_MSQ_H
31 #define __PPB_MSQ_H
32 
33 /*
34  * Basic definitions
35  */
36 
37 /* microsequence parameter descriptor */
38 #define MS_INS_MASK	0x00ff	/* mask to retrieve the instruction position < 256	XXX */
39 #define MS_ARG_MASK	0x0f00	/* mask to retrieve the argument number */
40 #define MS_TYP_MASK	0xf000	/* mask to retrieve the type of the param */
41 
42 /* offset of each mask (see above) */
43 #define MS_INS_OFFSET	0
44 #define MS_ARG_OFFSET	8
45 #define MS_TYP_OFFSET	12
46 
47 /* list of parameter types */
48 #define MS_TYP_INT	0x0	/* integer */
49 #define MS_TYP_CHA	0x1	/* character */
50 #define MS_TYP_PTR	0x2	/* void pointer */
51 #define MS_TYP_FUN	0x3	/* function pointer */
52 
53 #define MS_PARAM(ins,arg,typ) \
54 	(((ins<<MS_INS_OFFSET) & MS_INS_MASK) | \
55 	 ((arg<<MS_ARG_OFFSET) & MS_ARG_MASK) | \
56 	 ((typ<<MS_TYP_OFFSET) & MS_TYP_MASK))
57 
58 #define MS_INS(param) ((param & MS_INS_MASK) >> MS_INS_OFFSET)
59 #define MS_ARG(param) ((param & MS_ARG_MASK) >> MS_ARG_OFFSET)
60 #define MS_TYP(param) ((param & MS_TYP_MASK) >> MS_TYP_OFFSET)
61 
62 /* microsequence opcodes - do not change! */
63 #define MS_OP_GET       0	/* get <ptr>, <len>			*/
64 #define MS_OP_PUT       1	/* put <ptr>, <len>			*/
65 
66 #define MS_OP_RFETCH	2	/* rfetch <reg>, <mask>, <ptr>		*/
67 #define MS_OP_RSET	3	/* rset <reg>, <mask>, <mask>		*/
68 #define MS_OP_RASSERT	4	/* rassert <reg>, <mask>		*/
69 #define MS_OP_DELAY     5	/* delay <val>				*/
70 #define MS_OP_SET       6	/* set <val>				*/
71 #define MS_OP_DBRA      7	/* dbra <offset>			*/
72 #define MS_OP_BRSET     8	/* brset <mask>, <offset>		*/
73 #define MS_OP_BRCLEAR   9	/* brclear <mask>, <offset>		*/
74 #define MS_OP_RET       10	/* ret <retcode>			*/
75 #define MS_OP_C_CALL	11	/* c_call <function>, <parameter>	*/
76 #define MS_OP_PTR	12	/* ptr <pointer>			*/
77 #define MS_OP_ADELAY	13	/* adelay <val>				*/
78 #define MS_OP_BRSTAT	14	/* brstat <mask>, <mask>, <offset>	*/
79 #define MS_OP_SUBRET	15	/* subret <code>			*/
80 #define MS_OP_CALL	16	/* call <microsequence>			*/
81 #define MS_OP_RASSERT_P	17	/* rassert_p <iter>, <reg>		*/
82 #define MS_OP_RFETCH_P	18	/* rfetch_p <iter>, <reg>, <mask>	*/
83 #define MS_OP_TRIG	19	/* trigger <reg>, <len>, <array>	*/
84 
85 /* common masks */
86 #define MS_CLEAR_ALL	0x0
87 #define MS_ASSERT_NONE	0x0
88 #define MS_ASSERT_ALL	0xff
89 #define MS_FETCH_ALL	0xff
90 
91 /* undefined parameter value */
92 #define MS_NULL		0
93 #define MS_UNKNOWN	MS_NULL
94 
95 /* predifined parameters */
96 #define MS_ACCUM	-1	/* use accum previously set by MS_OP_SET */
97 
98 /* these are register numbers according to our PC-like parallel port model */
99 #define MS_REG_DTR	0x0
100 #define MS_REG_STR	0x1
101 #define MS_REG_CTR	0x2
102 #define MS_REG_EPP_A	0x3
103 #define MS_REG_EPP_D	0x4
104 
105 /*
106  * Microsequence macro abstraction level
107  */
108 
109 /* register operations */
110 #define MS_RSET(reg,assert,clear) { MS_OP_RSET, {{ reg }, { assert }, { clear }}}
111 #define MS_RASSERT(reg,byte)	  { MS_OP_RASSERT, { { reg }, { byte }}}
112 #define MS_RCLR(reg,clear)	  { MS_OP_RSET, {{ reg }, { MS_ASSERT_NONE }, { clear }}}
113 
114 #define MS_RFETCH(reg,mask,ptr) { MS_OP_RFETCH, {{ reg }, { mask }, { ptr }}}
115 
116 /* trigger the port with array[char, delay,...] */
117 #define MS_TRIG(reg,len,array)	{ MS_OP_TRIG, {{ reg }, { len }, { array }}}
118 
119 /* assert/fetch from/to ptr */
120 #define MS_RASSERT_P(n,reg)	  { MS_OP_RASSERT_P, {{ n }, { reg }}}
121 #define MS_RFETCH_P(n,reg,mask)	  { MS_OP_RFETCH_P, {{ n }, { reg }, { mask }}}
122 
123 /* ptr manipulation */
124 #define MS_PTR(ptr)	{ MS_OP_PTR, {{ ptr }}}
125 
126 #define MS_DASS(byte) MS_RASSERT(MS_REG_DTR,byte)
127 #define MS_SASS(byte) MS_RASSERT(MS_REG_STR,byte)
128 #define MS_CASS(byte) MS_RASSERT(MS_REG_CTR,byte)
129 
130 #define MS_SET(accum)		{ MS_OP_SET, {{ accum }}}
131 #define MS_BRSET(mask,offset)	{ MS_OP_BRSET, {{ mask }, { offset }}}
132 #define MS_DBRA(offset)		{ MS_OP_DBRA, {{ offset }}}
133 #define MS_BRCLEAR(mask,offset)	{ MS_OP_BRCLEAR, {{ mask }, { offset }}}
134 #define MS_BRSTAT(mask_set,mask_clr,offset) \
135 		{ MS_OP_BRSTAT, {{ mask_set }, { mask_clr }, { offset }}}
136 
137 /* C function or submicrosequence call */
138 #define MS_C_CALL(function,parameter) \
139 		{ MS_OP_C_CALL, {{ function }, { parameter }}}
140 #define MS_CALL(microseq) { MS_OP_CALL, {{ microseq }}}
141 
142 /* mode dependent read/write operations
143  * ppb_MS_xxx_init() call required otherwise default is
144  * IEEE1284 operating mode */
145 #define MS_PUT(ptr,len) { MS_OP_PUT, {{ ptr }, { len }}}
146 #define MS_GET(ptr,len) { MS_OP_GET, {{ ptr }, { len }}}
147 
148 /* delay in microseconds */
149 #define MS_DELAY(udelay) { MS_OP_DELAY, {{ udelay }}}
150 
151 /* asynchroneous delay in ms */
152 #define MS_ADELAY(mdelay) { MS_OP_ADELAY, {{ mdelay }}}
153 
154 /* return from submicrosequence execution or microseqence execution */
155 #define MS_SUBRET(code)	{ MS_OP_SUBRET,	{{ code }}}
156 #define MS_RET(code)	{ MS_OP_RET, {{ code }}}
157 
158 /*
159  * Function abstraction level
160  */
161 
162 #define ppb_MS_GET_init(bus,dev,body) ppb_MS_init(bus, dev, body, MS_OP_GET)
163 
164 #define ppb_MS_PUT_init(bus,dev,body) ppb_MS_init(bus, dev, body, MS_OP_PUT)
165 
166 extern int ppb_MS_init(
167 		device_t,			/* ppbus bus */
168 		device_t,			/* ppbus device */
169 		struct ppb_microseq *,		/* loop msq to assign */
170 		int opcode			/* MS_OP_GET, MS_OP_PUT */
171 		);
172 
173 extern int ppb_MS_init_msq(
174 		struct ppb_microseq *,
175 		int,				/* number of parameters */
176 		...				/* descriptor, value, ... */
177 		);
178 
179 extern int ppb_MS_exec(
180 		device_t,			/* ppbus bus */
181 		device_t,			/* ppbus device */
182 		int,				/* microseq opcode */
183 		union ppb_insarg,		/* param1 */
184 		union ppb_insarg,		/* param2 */
185 		union ppb_insarg,		/* param3 */
186 		int *				/* returned value */
187 		);
188 
189 extern int ppb_MS_loop(
190 		device_t,			/* ppbus bus */
191 		device_t,			/* ppbus device */
192 		struct ppb_microseq *,		/* prologue msq of loop */
193 		struct ppb_microseq *,		/* body msq of loop */
194 		struct ppb_microseq *,		/* epilogue msq of loop */
195 		int,				/* number of iter */
196 		int *				/* returned value */
197 		);
198 
199 extern int ppb_MS_microseq(
200 		device_t,			/* ppbus bus */
201 		device_t,			/* ppbus device */
202 		struct ppb_microseq *,		/* msq to execute */
203 		int *				/* returned value */
204 		);
205 
206 #endif
207