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