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