sys/bus/ppbus/ppb_msq.h

   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  *
  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
 113 #define MS_RFETCH(reg,mask,ptr) { MS_OP_RFETCH, {{ reg }, { mask }, { ptr }}}
 114
 115 /* trigger the port with array[char, delay,...] */
 116 #define MS_TRIG(reg,len,array)  { MS_OP_TRIG, {{ reg }, { len }, { array }}}
 117
 118 /* assert/fetch from/to ptr */
 119 #define MS_RASSERT_P(n,reg)       { MS_OP_RASSERT_P, {{ n }, { reg }}}
 120 #define MS_RFETCH_P(n,reg,mask)   { MS_OP_RFETCH_P, {{ n }, { reg }, { mask }}}
 121
 122 /* ptr manipulation */
 123 #define MS_PTR(ptr)     { MS_OP_PTR, {{ ptr }}}
 124
 125 #define MS_DASS(byte) MS_RASSERT(MS_REG_DTR,byte)
 126 #define MS_SASS(byte) MS_RASSERT(MS_REG_STR,byte)
 127 #define MS_CASS(byte) MS_RASSERT(MS_REG_CTR,byte)
 128
 129 #define MS_SET(accum)           { MS_OP_SET, {{ accum }}}
 130 #define MS_BRSET(mask,offset)   { MS_OP_BRSET, {{ mask }, { offset }}}
 131 #define MS_DBRA(offset)         { MS_OP_DBRA, {{ offset }}}
 132 #define MS_BRCLEAR(mask,offset) { MS_OP_BRCLEAR, {{ mask }, { offset }}}
 133 #define MS_BRSTAT(mask_set,mask_clr,offset) \
 134                 { MS_OP_BRSTAT, {{ mask_set }, { mask_clr }, { offset }}}
 135
 136 /* C function or submicrosequence call */
 137 #define MS_C_CALL(function,parameter) \
 138                 { MS_OP_C_CALL, {{ function }, { parameter }}}
 139 #define MS_CALL(microseq) { MS_OP_CALL, {{ microseq }}}
 140
 141 /* mode dependent read/write operations
 142  * ppb_MS_xxx_init() call required otherwise default is
 143  * IEEE1284 operating mode */
 144 #define MS_PUT(ptr,len) { MS_OP_PUT, {{ ptr }, { len }}}
 145 #define MS_GET(ptr,len) { MS_OP_GET, {{ ptr }, { len }}}
 146
 147 /* delay in microseconds */
 148 #define MS_DELAY(udelay) { MS_OP_DELAY, {{ udelay }}}
 149
 150 /* asynchroneous delay in ms */
 151 #define MS_ADELAY(mdelay) { MS_OP_ADELAY, {{ mdelay }}}
 152
 153 /* return from submicrosequence execution or microseqence execution */
 154 #define MS_SUBRET(code) { MS_OP_SUBRET, {{ code }}}
 155 #define MS_RET(code)    { MS_OP_RET, {{ code }}}
 156
 157 /*
 158  * Function abstraction level
 159  */
 160
 161 #define ppb_MS_GET_init(bus,dev,body) ppb_MS_init(bus, dev, body, MS_OP_GET)
 162
 163 #define ppb_MS_PUT_init(bus,dev,body) ppb_MS_init(bus, dev, body, MS_OP_PUT)
 164
 165 extern int ppb_MS_init(
 166                 device_t,                       /* ppbus bus */
 167                 device_t,                       /* ppbus device */
 168                 struct ppb_microseq *,          /* loop msq to assign */
 169                 int opcode                      /* MS_OP_GET, MS_OP_PUT */
 170                 );
 171
 172 extern int ppb_MS_init_msq(
 173                 struct ppb_microseq *,
 174                 int,                            /* number of parameters */
 175                 ...                             /* descriptor, value, ... */
 176                 );
 177
 178 extern int ppb_MS_exec(
 179                 device_t,                       /* ppbus bus */
 180                 device_t,                       /* ppbus device */
 181                 int,                            /* microseq opcode */
 182                 union ppb_insarg,               /* param1 */
 183                 union ppb_insarg,               /* param2 */
 184                 union ppb_insarg,               /* param3 */
 185                 int *                           /* returned value */
 186                 );
 187
 188 extern int ppb_MS_loop(
 189                 device_t,                       /* ppbus bus */
 190                 device_t,                       /* ppbus device */
 191                 struct ppb_microseq *,          /* prologue msq of loop */
 192                 struct ppb_microseq *,          /* body msq of loop */
 193                 struct ppb_microseq *,          /* epilogue msq of loop */
 194                 int,                            /* number of iter */
 195                 int *                           /* returned value */
 196                 );
 197
 198 extern int ppb_MS_microseq(
 199                 device_t,                       /* ppbus bus */
 200                 device_t,                       /* ppbus device */
 201                 struct ppb_microseq *,          /* msq to execute */
 202                 int *                           /* returned value */
 203                 );
 204
 205 #endif