1 /*  *********************************************************************
2     *  SB1250 Board Support Package
3     *
4     *  SMBUS Constants                          File: sb1250_smbus.h
5     *
6     *  This module contains constants and macros useful for
7     *  manipulating the SB1250's SMbus devices.
8     *
9     *  SB1250 specification level:  01/02/2002
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_SMBUS_H
53 #define _SB1250_SMBUS_H
54 
55 #include "sb1250_defs.h"
56 
57 /*
58  * SMBus Clock Frequency Register (Table 14-2)
59  */
60 
61 #define S_SMB_FREQ_DIV              0
62 #define M_SMB_FREQ_DIV              _SB_MAKEMASK(13,S_SMB_FREQ_DIV)
63 #define V_SMB_FREQ_DIV(x)           _SB_MAKEVALUE(x,S_SMB_FREQ_DIV)
64 
65 #define K_SMB_FREQ_400KHZ	    0x1F
66 #define K_SMB_FREQ_100KHZ	    0x7D
67 
68 #define S_SMB_CMD                   0
69 #define M_SMB_CMD                   _SB_MAKEMASK(8,S_SMB_CMD)
70 #define V_SMB_CMD(x)                _SB_MAKEVALUE(x,S_SMB_CMD)
71 
72 /*
73  * SMBus control register (Table 14-4)
74  */
75 
76 #define M_SMB_ERR_INTR              _SB_MAKEMASK1(0)
77 #define M_SMB_FINISH_INTR           _SB_MAKEMASK1(1)
78 #define M_SMB_DATA_OUT              _SB_MAKEMASK1(4)
79 #define M_SMB_DATA_DIR              _SB_MAKEMASK1(5)
80 #define M_SMB_DATA_DIR_OUTPUT       M_SMB_DATA_DIR
81 #define M_SMB_CLK_OUT               _SB_MAKEMASK1(6)
82 #define M_SMB_DIRECT_ENABLE         _SB_MAKEMASK1(7)
83 
84 /*
85  * SMBus status registers (Table 14-5)
86  */
87 
88 #define M_SMB_BUSY                  _SB_MAKEMASK1(0)
89 #define M_SMB_ERROR                 _SB_MAKEMASK1(1)
90 #define M_SMB_ERROR_TYPE            _SB_MAKEMASK1(2)
91 #define M_SMB_REF                   _SB_MAKEMASK1(6)
92 #define M_SMB_DATA_IN               _SB_MAKEMASK1(7)
93 
94 /*
95  * SMBus Start/Command registers (Table 14-9)
96  */
97 
98 #define S_SMB_ADDR                  0
99 #define M_SMB_ADDR                  _SB_MAKEMASK(7,S_SMB_ADDR)
100 #define V_SMB_ADDR(x)               _SB_MAKEVALUE(x,S_SMB_ADDR)
101 #define G_SMB_ADDR(x)               _SB_GETVALUE(x,S_SMB_ADDR,M_SMB_ADDR)
102 
103 #define M_SMB_QDATA                 _SB_MAKEMASK1(7)
104 
105 #define S_SMB_TT                    8
106 #define M_SMB_TT                    _SB_MAKEMASK(3,S_SMB_TT)
107 #define V_SMB_TT(x)                 _SB_MAKEVALUE(x,S_SMB_TT)
108 #define G_SMB_TT(x)                 _SB_GETVALUE(x,S_SMB_TT,M_SMB_TT)
109 
110 #define K_SMB_TT_WR1BYTE            0
111 #define K_SMB_TT_WR2BYTE            1
112 #define K_SMB_TT_WR3BYTE            2
113 #define K_SMB_TT_CMD_RD1BYTE        3
114 #define K_SMB_TT_CMD_RD2BYTE        4
115 #define K_SMB_TT_RD1BYTE            5
116 #define K_SMB_TT_QUICKCMD           6
117 #define K_SMB_TT_EEPROMREAD         7
118 
119 #define V_SMB_TT_WR1BYTE	    V_SMB_TT(K_SMB_TT_WR1BYTE)
120 #define V_SMB_TT_WR2BYTE	    V_SMB_TT(K_SMB_TT_WR2BYTE)
121 #define V_SMB_TT_WR3BYTE	    V_SMB_TT(K_SMB_TT_WR3BYTE)
122 #define V_SMB_TT_CMD_RD1BYTE	    V_SMB_TT(K_SMB_TT_CMD_RD1BYTE)
123 #define V_SMB_TT_CMD_RD2BYTE	    V_SMB_TT(K_SMB_TT_CMD_RD2BYTE)
124 #define V_SMB_TT_RD1BYTE	    V_SMB_TT(K_SMB_TT_RD1BYTE)
125 #define V_SMB_TT_QUICKCMD	    V_SMB_TT(K_SMB_TT_QUICKCMD)
126 #define V_SMB_TT_EEPROMREAD	    V_SMB_TT(K_SMB_TT_EEPROMREAD)
127 
128 #define M_SMB_PEC                   _SB_MAKEMASK1(15)
129 
130 /*
131  * SMBus Data Register (Table 14-6) and SMBus Extra Register (Table 14-7)
132  */
133 
134 #define S_SMB_LB                    0
135 #define M_SMB_LB                    _SB_MAKEMASK(8,S_SMB_LB)
136 #define V_SMB_LB(x)                 _SB_MAKEVALUE(x,S_SMB_LB)
137 
138 #define S_SMB_MB                    8
139 #define M_SMB_MB                    _SB_MAKEMASK(8,S_SMB_MB)
140 #define V_SMB_MB(x)                 _SB_MAKEVALUE(x,S_SMB_MB)
141 
142 
143 /*
144  * SMBus Packet Error Check register (Table 14-8)
145  */
146 
147 #define S_SPEC_PEC                  0
148 #define M_SPEC_PEC                  _SB_MAKEMASK(8,S_SPEC_PEC)
149 #define V_SPEC_MB(x)                _SB_MAKEVALUE(x,S_SPEC_PEC)
150 
151 
152 #if SIBYTE_HDR_FEATURE(1250, PASS2) || SIBYTE_HDR_FEATURE(112x, PASS1)
153 
154 #define S_SMB_CMDH                  8
155 #define M_SMB_CMDH                  _SB_MAKEMASK(8,S_SMBH_CMD)
156 #define V_SMB_CMDH(x)               _SB_MAKEVALUE(x,S_SMBH_CMD)
157 
158 #define M_SMB_EXTEND		    _SB_MAKEMASK1(14)
159 
160 #define M_SMB_DIR		    _SB_MAKEMASK1(13)
161 
162 #define S_SMB_DFMT                  8
163 #define M_SMB_DFMT                  _SB_MAKEMASK(3,S_SMB_DFMT)
164 #define V_SMB_DFMT(x)               _SB_MAKEVALUE(x,S_SMB_DFMT)
165 #define G_SMB_DFMT(x)               _SB_GETVALUE(x,S_SMB_DFMT,M_SMB_DFMT)
166 
167 #define K_SMB_DFMT_1BYTE            0
168 #define K_SMB_DFMT_2BYTE            1
169 #define K_SMB_DFMT_3BYTE            2
170 #define K_SMB_DFMT_4BYTE            3
171 #define K_SMB_DFMT_NODATA           4
172 #define K_SMB_DFMT_CMD4BYTE         5
173 #define K_SMB_DFMT_CMD5BYTE         6
174 #define K_SMB_DFMT_RESERVED         7
175 
176 #define V_SMB_DFMT_1BYTE	    V_SMB_DFMT(K_SMB_DFMT_1BYTE)
177 #define V_SMB_DFMT_2BYTE	    V_SMB_DFMT(K_SMB_DFMT_2BYTE)
178 #define V_SMB_DFMT_3BYTE	    V_SMB_DFMT(K_SMB_DFMT_3BYTE)
179 #define V_SMB_DFMT_4BYTE	    V_SMB_DFMT(K_SMB_DFMT_4BYTE)
180 #define V_SMB_DFMT_NODATA	    V_SMB_DFMT(K_SMB_DFMT_NODATA)
181 #define V_SMB_DFMT_CMD4BYTE	    V_SMB_DFMT(K_SMB_DFMT_CMD4BYTE)
182 #define V_SMB_DFMT_CMD5BYTE	    V_SMB_DFMT(K_SMB_DFMT_CMD5BYTE)
183 #define V_SMB_DFMT_RESERVED	    V_SMB_DFMT(K_SMB_DFMT_RESERVED)
184 
185 #endif /* 1250 PASS2 || 112x PASS1 */
186 
187 #endif
188