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