Home | History | Annotate | Line # | Download | only in ppbus
      1 /* $NetBSD: ppbus_msq.h,v 1.7 2008/04/15 15:02:29 cegger Exp $ */
      2 
      3 /*-
      4  * Copyright (c) 1998 Nicolas Souchu
      5  * All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  *
     16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     26  * SUCH DAMAGE.
     27  *
     28  * FreeBSD: src/sys/dev/ppbus/ppb_msq.h,v 1.8 2000/01/14 00:17:55 nsouch Exp
     29  *
     30  */
     31 #ifndef __PPBUS_MSQ_H
     32 #define __PPBUS_MSQ_H
     33 
     34 
     35 /*
     36  * Basic definitions
     37  */
     38 
     39 /* Microsequence stuff. */
     40 #define PPBUS_MS_MAXLEN 64              /* XXX according to MS_INS_MASK */
     41 #define PPBUS_MS_MAXARGS        3               /* according to MS_ARG_MASK */
     42 
     43 /* Maximum number of mode dependent submicrosequences for in/out operations. */
     44 #define PPBUS_MAX_XFER  6
     45 
     46 /* Argument in microsequence structure */
     47 union ppbus_insarg {
     48         int i;
     49 	void *p;
     50 	char *c;
     51 	int (* f)(void *, char *);
     52 };
     53 
     54 /* Microsequence structure */
     55 struct ppbus_microseq {
     56         int opcode;                 /* microins. opcode */
     57 	union ppbus_insarg arg[PPBUS_MS_MAXARGS];  /* arguments */
     58 };
     59 
     60 /* Microseqences used for GET/PUT operations */
     61 struct ppbus_xfer {
     62 	struct ppbus_microseq *loop;            /* the loop microsequence */
     63 };
     64 
     65 /* microsequence parameter descriptor */
     66 #define MS_INS_MASK	0x00ff	/* mask to retrieve the instruction position < 256	XXX */
     67 #define MS_ARG_MASK	0x0f00	/* mask to retrieve the argument number */
     68 #define MS_TYP_MASK	0xf000	/* mask to retrieve the type of the param */
     69 
     70 /* offset of each mask (see above) */
     71 #define MS_INS_OFFSET	0
     72 #define MS_ARG_OFFSET	8
     73 #define MS_TYP_OFFSET	12
     74 
     75 /* list of parameter types */
     76 #define MS_TYP_INT	0x0	/* integer */
     77 #define MS_TYP_CHA	0x1	/* character */
     78 #define MS_TYP_PTR	0x2	/* void pointer */
     79 #define MS_TYP_FUN	0x3	/* function pointer */
     80 
     81 #define MS_PARAM(ins,arg,typ) \
     82 	(((ins<<MS_INS_OFFSET) & MS_INS_MASK) | \
     83 	 ((arg<<MS_ARG_OFFSET) & MS_ARG_MASK) | \
     84 	 ((typ<<MS_TYP_OFFSET) & MS_TYP_MASK))
     85 
     86 #define MS_INS(param) ((param & MS_INS_MASK) >> MS_INS_OFFSET)
     87 #define MS_ARG(param) ((param & MS_ARG_MASK) >> MS_ARG_OFFSET)
     88 #define MS_TYP(param) ((param & MS_TYP_MASK) >> MS_TYP_OFFSET)
     89 
     90 /* microsequence opcodes - do not change! */
     91 #define MS_OP_GET       0	/* get <ptr>, <len>			*/
     92 #define MS_OP_PUT       1	/* put <ptr>, <len>			*/
     93 
     94 #define MS_OP_RFETCH	2	/* rfetch <reg>, <mask>, <ptr>		*/
     95 #define MS_OP_RSET	3	/* rset <reg>, <mask>, <mask>		*/
     96 #define MS_OP_RASSERT	4	/* rassert <reg>, <mask>		*/
     97 #define MS_OP_DELAY     5	/* delay <val>				*/
     98 #define MS_OP_SET       6	/* set <val>				*/
     99 #define MS_OP_DBRA      7	/* dbra <offset>			*/
    100 #define MS_OP_BRSET     8	/* brset <mask>, <offset>		*/
    101 #define MS_OP_BRCLEAR   9	/* brclear <mask>, <offset>		*/
    102 #define MS_OP_RET       10	/* ret <retcode>			*/
    103 #define MS_OP_C_CALL	11	/* c_call <function>, <parameter>	*/
    104 #define MS_OP_PTR	12	/* ptr <pointer>			*/
    105 #define MS_OP_ADELAY	13	/* adelay <val>				*/
    106 #define MS_OP_BRSTAT	14	/* brstat <mask>, <mask>, <offset>	*/
    107 #define MS_OP_SUBRET	15	/* subret <code>			*/
    108 #define MS_OP_CALL	16	/* call <microsequence>			*/
    109 #define MS_OP_RASSERT_P	17	/* rassert_p <iter>, <reg>		*/
    110 #define MS_OP_RFETCH_P	18	/* rfetch_p <iter>, <reg>, <mask>	*/
    111 #define MS_OP_TRIG	19	/* trigger <reg>, <len>, <array>	*/
    112 
    113 /* common masks */
    114 #define MS_CLEAR_ALL	0x0
    115 #define MS_ASSERT_NONE	0x0
    116 #define MS_ASSERT_ALL	0xff
    117 #define MS_FETCH_ALL	0xff
    118 
    119 /* undefined parameter value */
    120 #define MS_NULL		0
    121 #define MS_UNKNOWN	MS_NULL
    122 
    123 /* predifined parameters */
    124 #define MS_ACCUM	-1	/* use accum previously set by MS_OP_SET */
    125 
    126 /* these are register numbers according to our PC-like parallel port model */
    127 #define MS_REG_DTR	0x0
    128 #define MS_REG_STR	0x1
    129 #define MS_REG_CTR	0x2
    130 #define MS_REG_EPP_A	0x3
    131 #define MS_REG_EPP_D	0x4
    132 
    133 /*
    134  * Microsequence macro abstraction level
    135  */
    136 
    137 /* register operations */
    138 #define MS_RSET(reg,assert,clear) { MS_OP_RSET, {{ reg }, { assert }, { clear }}}
    139 #define MS_RASSERT(reg,byte)	  { MS_OP_RASSERT, { { reg }, { byte }}}
    140 #define MS_RCLR(reg,clear)	  { MS_OP_RSET, {{ reg }, { MS_ASSERT_NONE }, { clear }}}
    141 
    142 #define MS_RFETCH(reg,mask,ptr) { MS_OP_RFETCH, {{ reg }, { mask }, { ptr }}}
    143 
    144 /* trigger the port with array[char, delay,...] */
    145 #define MS_TRIG(reg,len,array)	{ MS_OP_TRIG, {{ reg }, { len }, { array }}}
    146 
    147 /* assert/fetch from/to ptr */
    148 #define MS_RASSERT_P(n,reg)	  { MS_OP_RASSERT_P, {{ n }, { reg }}}
    149 #define MS_RFETCH_P(n,reg,mask)	  { MS_OP_RFETCH_P, {{ n }, { reg }, { mask }}}
    150 
    151 /* ptr manipulation */
    152 #define MS_PTR(ptr)	{ MS_OP_PTR, {{ ptr }}}
    153 
    154 #define MS_DASS(byte) MS_RASSERT(MS_REG_DTR,byte)
    155 #define MS_SASS(byte) MS_RASSERT(MS_REG_STR,byte)
    156 #define MS_CASS(byte) MS_RASSERT(MS_REG_CTR,byte)
    157 
    158 #define MS_SET(accum)		{ MS_OP_SET, {{ accum }}}
    159 #define MS_BRSET(mask,offset)	{ MS_OP_BRSET, {{ mask }, { offset }}}
    160 #define MS_DBRA(offset)		{ MS_OP_DBRA, {{ offset }}}
    161 #define MS_BRCLEAR(mask,offset)	{ MS_OP_BRCLEAR, {{ mask }, { offset }}}
    162 #define MS_BRSTAT(mask_set,mask_clr,offset) \
    163 		{ MS_OP_BRSTAT, {{ mask_set }, { mask_clr }, { offset }}}
    164 
    165 /* C function or submicrosequence call */
    166 #define MS_C_CALL(function,parameter) \
    167 		{ MS_OP_C_CALL, {{ function }, { parameter }}}
    168 #define MS_CALL(microseq) { MS_OP_CALL, {{ microseq }}}
    169 
    170 /* mode dependent read/write operations
    171  * ppb_MS_xxx_init() call required otherwise default is
    172  * IEEE1284 operating mode */
    173 #define MS_PUT(ptr,len) { MS_OP_PUT, {{ ptr }, { len }}}
    174 #define MS_GET(ptr,len) { MS_OP_GET, {{ ptr }, { len }}}
    175 
    176 /* delay in microseconds */
    177 #define MS_DELAY(udelay) { MS_OP_DELAY, {{ udelay }}}
    178 
    179 /* asynchroneous delay in ms */
    180 #define MS_ADELAY(mdelay) { MS_OP_ADELAY, {{ mdelay }}}
    181 
    182 /* return from submicrosequence execution or microseqence execution */
    183 #define MS_SUBRET(code)	{ MS_OP_SUBRET,	{{ code }}}
    184 #define MS_RET(code)	{ MS_OP_RET, {{ code }}}
    185 
    186 /*
    187  * Function abstraction level
    188  */
    189 
    190 #define ppbus_MS_GET_init(bus,dev,body) ppbus_MS_init(bus, dev, body, MS_OP_GET)
    191 
    192 #define ppbus_MS_PUT_init(bus,dev,body) ppbus_MS_init(bus, dev, body, MS_OP_PUT)
    193 
    194 /* Function prototypes */
    195 int ppbus_MS_init(
    196 		device_t,		/* ppbus bus */
    197 		device_t,	/* ppbus device */
    198 		struct ppbus_microseq *,	/* loop msq to assign */
    199 		int opcode			/* MS_OP_GET, MS_OP_PUT */
    200 		);
    201 
    202 int ppbus_MS_init_msq(
    203 		struct ppbus_microseq *,
    204 		int,				/* number of parameters */
    205 		...				/* descriptor, value, ... */
    206 		);
    207 
    208 int ppbus_MS_exec(
    209 		device_t,		/* ppbus bus */
    210 		device_t,	/* ppbus device */
    211 		int,				/* microseq opcode */
    212 		union ppbus_insarg,		/* param1 */
    213 		union ppbus_insarg,		/* param2 */
    214 		union ppbus_insarg,		/* param3 */
    215 		int *				/* returned value */
    216 		);
    217 
    218 int ppbus_MS_loop(
    219 		device_t,		/* ppbus bus */
    220 		device_t,	/* ppbus device */
    221 		struct ppbus_microseq *,	/* prologue msq of loop */
    222 		struct ppbus_microseq *,	/* body msq of loop */
    223 		struct ppbus_microseq *,	/* epilogue msq of loop */
    224 		int,				/* number of iter */
    225 		int *				/* returned value */
    226 		);
    227 
    228 int ppbus_MS_microseq(
    229 		device_t,		/* ppbus bus */
    230 		device_t,	/* ppbus device */
    231 		struct ppbus_microseq *,	/* msq to execute */
    232 		int *				/* returned value */
    233 		);
    234 
    235 #endif /* __PPBUS_MSQ_H */
    236