Home | History | Annotate | Line # | Download | only in include
sb1250_syncser.h revision 1.2 
      1 /*  *********************************************************************
      2     *  SB1250 Board Support Package
      3     *
      4     *  Synchronous Serial Constants              File: sb1250_syncser.h
      5     *
      6     *  This module contains constants and macros useful for
      7     *  manipulating the SB1250's Synchronous Serial
      8     *
      9     *  SB1250 specification level:  User's manual 1/02/02
     10     *
     11     *  Author:  Mitch Lichtenberg (mpl (at) broadcom.com)
     12     *
     13     *********************************************************************
     14     *
     15     *  Copyright 2000,2001,2002,2003
     16     *  Broadcom Corporation. All rights reserved.
     17     *
     18     *  This software is furnished under license and may be used and
     19     *  copied only in accordance with the following terms and
     20     *  conditions.  Subject to these conditions, you may download,
     21     *  copy, install, use, modify and distribute modified or unmodified
     22     *  copies of this software in source and/or binary form.  No title
     23     *  or ownership is transferred hereby.
     24     *
     25     *  1) Any source code used, modified or distributed must reproduce
     26     *     and retain this copyright notice and list of conditions
     27     *     as they appear in the source file.
     28     *
     29     *  2) No right is granted to use any trade name, trademark, or
     30     *     logo of Broadcom Corporation.  The "Broadcom Corporation"
     31     *     name may not be used to endorse or promote products derived
     32     *     from this software without the prior written permission of
     33     *     Broadcom Corporation.
     34     *
     35     *  3) THIS SOFTWARE IS PROVIDED "AS-IS" AND ANY EXPRESS OR
     36     *     IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO, ANY IMPLIED
     37     *     WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
     38     *     PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT
     39     *     SHALL BROADCOM BE LIABLE FOR ANY DAMAGES WHATSOEVER, AND IN
     40     *     PARTICULAR, BROADCOM SHALL NOT BE LIABLE FOR DIRECT, INDIRECT,
     41     *     INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     42     *     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
     43     *     GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
     44     *     BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
     45     *     OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
     46     *     TORT (INCLUDING NEGLIGENCE OR OTHERWISE), EVEN IF ADVISED OF
     47     *     THE POSSIBILITY OF SUCH DAMAGE.
     48     ********************************************************************* */
     49 
     50 
     51 #ifndef _SB1250_SYNCSER_H
     52 #define _SB1250_SYNCSER_H
     53 
     54 #include "sb1250_defs.h"
     55 
     56 /*
     57  * Serial Mode Configuration Register
     58  */
     59 
     60 #define M_SYNCSER_CRC_MODE                 _SB_MAKEMASK1(0)
     61 #define M_SYNCSER_MSB_FIRST                _SB_MAKEMASK1(1)
     62 
     63 #define S_SYNCSER_FLAG_NUM                 2
     64 #define M_SYNCSER_FLAG_NUM                 _SB_MAKEMASK(4,S_SYNCSER_FLAG_NUM)
     65 #define V_SYNCSER_FLAG_NUM                 _SB_MAKEVALUE(x,S_SYNCSER_FLAG_NUM)
     66 
     67 #define M_SYNCSER_FLAG_EN                  _SB_MAKEMASK1(6)
     68 #define M_SYNCSER_HDLC_EN                  _SB_MAKEMASK1(7)
     69 #define M_SYNCSER_LOOP_MODE                _SB_MAKEMASK1(8)
     70 #define M_SYNCSER_LOOPBACK                 _SB_MAKEMASK1(9)
     71 
     72 /*
     73  * Serial Clock Source and Line Interface Mode Register
     74  */
     75 
     76 #define M_SYNCSER_RXCLK_INV                _SB_MAKEMASK1(0)
     77 #define M_SYNCSER_RXCLK_EXT                _SB_MAKEMASK1(1)
     78 
     79 #define S_SYNCSER_RXSYNC_DLY               2
     80 #define M_SYNCSER_RXSYNC_DLY               _SB_MAKEMASK(2,S_SYNCSER_RXSYNC_DLY)
     81 #define V_SYNCSER_RXSYNC_DLY(x)            _SB_MAKEVALUE(x,S_SYNCSER_RXSYNC_DLY)
     82 
     83 #define M_SYNCSER_RXSYNC_LOW               _SB_MAKEMASK1(4)
     84 #define M_SYNCSER_RXSTRB_LOW               _SB_MAKEMASK1(5)
     85 
     86 #define M_SYNCSER_RXSYNC_EDGE              _SB_MAKEMASK1(6)
     87 #define M_SYNCSER_RXSYNC_INT               _SB_MAKEMASK1(7)
     88 
     89 #define M_SYNCSER_TXCLK_INV                _SB_MAKEMASK1(8)
     90 #define M_SYNCSER_TXCLK_EXT                _SB_MAKEMASK1(9)
     91 
     92 #define S_SYNCSER_TXSYNC_DLY               10
     93 #define M_SYNCSER_TXSYNC_DLY               _SB_MAKEMASK(2,S_SYNCSER_TXSYNC_DLY)
     94 #define V_SYNCSER_TXSYNC_DLY(x)            _SB_MAKEVALUE(x,S_SYNCSER_TXSYNC_DLY)
     95 
     96 #define M_SYNCSER_TXSYNC_LOW               _SB_MAKEMASK1(12)
     97 #define M_SYNCSER_TXSTRB_LOW               _SB_MAKEMASK1(13)
     98 
     99 #define M_SYNCSER_TXSYNC_EDGE              _SB_MAKEMASK1(14)
    100 #define M_SYNCSER_TXSYNC_INT               _SB_MAKEMASK1(15)
    101 
    102 /*
    103  * Serial Command Register
    104  */
    105 
    106 #define M_SYNCSER_CMD_RX_EN                _SB_MAKEMASK1(0)
    107 #define M_SYNCSER_CMD_TX_EN                _SB_MAKEMASK1(1)
    108 #define M_SYNCSER_CMD_RX_RESET             _SB_MAKEMASK1(2)
    109 #define M_SYNCSER_CMD_TX_RESET             _SB_MAKEMASK1(3)
    110 #define M_SYNCSER_CMD_TX_PAUSE             _SB_MAKEMASK1(5)
    111 
    112 /*
    113  * Serial DMA Enable Register
    114  */
    115 
    116 #define M_SYNCSER_DMA_RX_EN                _SB_MAKEMASK1(0)
    117 #define M_SYNCSER_DMA_TX_EN                _SB_MAKEMASK1(4)
    118 
    119 /*
    120  * Serial Status Register
    121  */
    122 
    123 #define M_SYNCSER_RX_CRCERR                _SB_MAKEMASK1(0)
    124 #define M_SYNCSER_RX_ABORT                 _SB_MAKEMASK1(1)
    125 #define M_SYNCSER_RX_OCTET                 _SB_MAKEMASK1(2)
    126 #define M_SYNCSER_RX_LONGFRM               _SB_MAKEMASK1(3)
    127 #define M_SYNCSER_RX_SHORTFRM              _SB_MAKEMASK1(4)
    128 #define M_SYNCSER_RX_OVERRUN               _SB_MAKEMASK1(5)
    129 #define M_SYNCSER_RX_SYNC_ERR              _SB_MAKEMASK1(6)
    130 #define M_SYNCSER_TX_CRCERR                _SB_MAKEMASK1(8)
    131 #define M_SYNCSER_TX_UNDERRUN              _SB_MAKEMASK1(9)
    132 #define M_SYNCSER_TX_SYNC_ERR              _SB_MAKEMASK1(10)
    133 #define M_SYNCSER_TX_PAUSE_COMPLETE        _SB_MAKEMASK1(11)
    134 #define M_SYNCSER_RX_EOP_COUNT             _SB_MAKEMASK1(16)
    135 #define M_SYNCSER_RX_EOP_TIMER             _SB_MAKEMASK1(17)
    136 #define M_SYNCSER_RX_EOP_SEEN              _SB_MAKEMASK1(18)
    137 #define M_SYNCSER_RX_HWM                   _SB_MAKEMASK1(19)
    138 #define M_SYNCSER_RX_LWM                   _SB_MAKEMASK1(20)
    139 #define M_SYNCSER_RX_DSCR                  _SB_MAKEMASK1(21)
    140 #define M_SYNCSER_RX_DERR                  _SB_MAKEMASK1(22)
    141 #define M_SYNCSER_TX_EOP_COUNT             _SB_MAKEMASK1(24)
    142 #define M_SYNCSER_TX_EOP_TIMER             _SB_MAKEMASK1(25)
    143 #define M_SYNCSER_TX_EOP_SEEN              _SB_MAKEMASK1(26)
    144 #define M_SYNCSER_TX_HWM                   _SB_MAKEMASK1(27)
    145 #define M_SYNCSER_TX_LWM                   _SB_MAKEMASK1(28)
    146 #define M_SYNCSER_TX_DSCR                  _SB_MAKEMASK1(29)
    147 #define M_SYNCSER_TX_DERR                  _SB_MAKEMASK1(30)
    148 #define M_SYNCSER_TX_DZERO                 _SB_MAKEMASK1(31)
    149 
    150 /*
    151  * Sequencer Table Entry format
    152  */
    153 
    154 #define M_SYNCSER_SEQ_LAST                 _SB_MAKEMASK1(0)
    155 #define M_SYNCSER_SEQ_BYTE                 _SB_MAKEMASK1(1)
    156 
    157 #define S_SYNCSER_SEQ_COUNT                2
    158 #define M_SYNCSER_SEQ_COUNT                _SB_MAKEMASK(4,S_SYNCSER_SEQ_COUNT)
    159 #define V_SYNCSER_SEQ_COUNT(x)             _SB_MAKEVALUE(x,S_SYNCSER_SEQ_COUNT)
    160 
    161 #define M_SYNCSER_SEQ_ENABLE               _SB_MAKEMASK1(6)
    162 #define M_SYNCSER_SEQ_STROBE               _SB_MAKEMASK1(7)
    163 
    164 #endif
    165