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:  10/21/02
10    *  BCM1280 specification level:  11/24/03
11    *
12    *********************************************************************
13    *
14    *  Copyright 2000,2001,2002,2003
15    *  Broadcom Corporation. All rights reserved.
16    *
17    *  This program is free software; you can redistribute it and/or
18    *  modify it under the terms of the GNU General Public License as
19    *  published by the Free Software Foundation; either version 2 of
20    *  the License, or (at your option) any later version.
21    *
22    *  This program is distributed in the hope that it will be useful,
23    *  but WITHOUT ANY WARRANTY; without even the implied warranty of
24    *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25    *  GNU General Public License for more details.
26    *
27    *  You should have received a copy of the GNU General Public License
28    *  along with this program; if not, write to the Free Software
29    *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
30    *  MA 02111-1307 USA
31    ********************************************************************* */
32
33
34#ifndef _SB1250_SMBUS_H
35#define _SB1250_SMBUS_H
36
37#include "sb1250_defs.h"
38
39/*
40 * SMBus Clock Frequency Register (Table 14-2)
41 */
42
43#define S_SMB_FREQ_DIV              0
44#define M_SMB_FREQ_DIV              _SB_MAKEMASK(13,S_SMB_FREQ_DIV)
45#define V_SMB_FREQ_DIV(x)           _SB_MAKEVALUE(x,S_SMB_FREQ_DIV)
46
47#define K_SMB_FREQ_400KHZ	    0x1F
48#define K_SMB_FREQ_100KHZ	    0x7D
49#define K_SMB_FREQ_10KHZ	    1250
50
51#define S_SMB_CMD                   0
52#define M_SMB_CMD                   _SB_MAKEMASK(8,S_SMB_CMD)
53#define V_SMB_CMD(x)                _SB_MAKEVALUE(x,S_SMB_CMD)
54
55/*
56 * SMBus control register (Table 14-4)
57 */
58
59#define M_SMB_ERR_INTR              _SB_MAKEMASK1(0)
60#define M_SMB_FINISH_INTR           _SB_MAKEMASK1(1)
61
62#define S_SMB_DATA_OUT              4
63#define M_SMB_DATA_OUT              _SB_MAKEMASK1(S_SMB_DATA_OUT)
64#define V_SMB_DATA_OUT(x)           _SB_MAKEVALUE(x,S_SMB_DATA_OUT)
65
66#define M_SMB_DATA_DIR              _SB_MAKEMASK1(5)
67#define M_SMB_DATA_DIR_OUTPUT       M_SMB_DATA_DIR
68#define M_SMB_CLK_OUT               _SB_MAKEMASK1(6)
69#define M_SMB_DIRECT_ENABLE         _SB_MAKEMASK1(7)
70
71/*
72 * SMBus status registers (Table 14-5)
73 */
74
75#define M_SMB_BUSY                  _SB_MAKEMASK1(0)
76#define M_SMB_ERROR                 _SB_MAKEMASK1(1)
77#define M_SMB_ERROR_TYPE            _SB_MAKEMASK1(2)
78
79#if SIBYTE_HDR_FEATURE(1250, PASS3) || SIBYTE_HDR_FEATURE(112x, PASS1) || \
80	SIBYTE_HDR_FEATURE_CHIP(1480)
81#define S_SMB_SCL_IN                5
82#define M_SMB_SCL_IN                _SB_MAKEMASK1(S_SMB_SCL_IN)
83#define V_SMB_SCL_IN(x)             _SB_MAKEVALUE(x,S_SMB_SCL_IN)
84#define G_SMB_SCL_IN(x)             _SB_GETVALUE(x,S_SMB_SCL_IN,M_SMB_SCL_IN)
85#endif /* 1250 PASS3 || 112x PASS1 || 1480 */
86
87#define S_SMB_REF                   6
88#define M_SMB_REF                   _SB_MAKEMASK1(S_SMB_REF)
89#define V_SMB_REF(x)                _SB_MAKEVALUE(x,S_SMB_REF)
90#define G_SMB_REF(x)                _SB_GETVALUE(x,S_SMB_REF,M_SMB_REF)
91
92#define S_SMB_DATA_IN               7
93#define M_SMB_DATA_IN               _SB_MAKEMASK1(S_SMB_DATA_IN)
94#define V_SMB_DATA_IN(x)            _SB_MAKEVALUE(x,S_SMB_DATA_IN)
95#define G_SMB_DATA_IN(x)            _SB_GETVALUE(x,S_SMB_DATA_IN,M_SMB_DATA_IN)
96
97/*
98 * SMBus Start/Command registers (Table 14-9)
99 */
100
101#define S_SMB_ADDR                  0
102#define M_SMB_ADDR                  _SB_MAKEMASK(7,S_SMB_ADDR)
103#define V_SMB_ADDR(x)               _SB_MAKEVALUE(x,S_SMB_ADDR)
104#define G_SMB_ADDR(x)               _SB_GETVALUE(x,S_SMB_ADDR,M_SMB_ADDR)
105
106#define M_SMB_QDATA                 _SB_MAKEMASK1(7)
107
108#define S_SMB_TT                    8
109#define M_SMB_TT                    _SB_MAKEMASK(3,S_SMB_TT)
110#define V_SMB_TT(x)                 _SB_MAKEVALUE(x,S_SMB_TT)
111#define G_SMB_TT(x)                 _SB_GETVALUE(x,S_SMB_TT,M_SMB_TT)
112
113#define K_SMB_TT_WR1BYTE            0
114#define K_SMB_TT_WR2BYTE            1
115#define K_SMB_TT_WR3BYTE            2
116#define K_SMB_TT_CMD_RD1BYTE        3
117#define K_SMB_TT_CMD_RD2BYTE        4
118#define K_SMB_TT_RD1BYTE            5
119#define K_SMB_TT_QUICKCMD           6
120#define K_SMB_TT_EEPROMREAD         7
121
122#define V_SMB_TT_WR1BYTE	    V_SMB_TT(K_SMB_TT_WR1BYTE)
123#define V_SMB_TT_WR2BYTE	    V_SMB_TT(K_SMB_TT_WR2BYTE)
124#define V_SMB_TT_WR3BYTE	    V_SMB_TT(K_SMB_TT_WR3BYTE)
125#define V_SMB_TT_CMD_RD1BYTE	    V_SMB_TT(K_SMB_TT_CMD_RD1BYTE)
126#define V_SMB_TT_CMD_RD2BYTE	    V_SMB_TT(K_SMB_TT_CMD_RD2BYTE)
127#define V_SMB_TT_RD1BYTE	    V_SMB_TT(K_SMB_TT_RD1BYTE)
128#define V_SMB_TT_QUICKCMD	    V_SMB_TT(K_SMB_TT_QUICKCMD)
129#define V_SMB_TT_EEPROMREAD	    V_SMB_TT(K_SMB_TT_EEPROMREAD)
130
131#define M_SMB_PEC                   _SB_MAKEMASK1(15)
132
133/*
134 * SMBus Data Register (Table 14-6) and SMBus Extra Register (Table 14-7)
135 */
136
137#define S_SMB_LB                    0
138#define M_SMB_LB                    _SB_MAKEMASK(8,S_SMB_LB)
139#define V_SMB_LB(x)                 _SB_MAKEVALUE(x,S_SMB_LB)
140
141#define S_SMB_MB                    8
142#define M_SMB_MB                    _SB_MAKEMASK(8,S_SMB_MB)
143#define V_SMB_MB(x)                 _SB_MAKEVALUE(x,S_SMB_MB)
144
145
146/*
147 * SMBus Packet Error Check register (Table 14-8)
148 */
149
150#define S_SPEC_PEC                  0
151#define M_SPEC_PEC                  _SB_MAKEMASK(8,S_SPEC_PEC)
152#define V_SPEC_MB(x)                _SB_MAKEVALUE(x,S_SPEC_PEC)
153
154
155#if SIBYTE_HDR_FEATURE(1250, PASS2) || SIBYTE_HDR_FEATURE(112x, PASS1) || \
156	SIBYTE_HDR_FEATURE_CHIP(1480)
157
158#define S_SMB_CMDH                  8
159#define M_SMB_CMDH                  _SB_MAKEMASK(8,S_SMB_CMDH)
160#define V_SMB_CMDH(x)               _SB_MAKEVALUE(x,S_SMB_CMDH)
161
162#define M_SMB_EXTEND		    _SB_MAKEMASK1(14)
163
164#define S_SMB_DFMT                  8
165#define M_SMB_DFMT                  _SB_MAKEMASK(3,S_SMB_DFMT)
166#define V_SMB_DFMT(x)               _SB_MAKEVALUE(x,S_SMB_DFMT)
167#define G_SMB_DFMT(x)               _SB_GETVALUE(x,S_SMB_DFMT,M_SMB_DFMT)
168
169#define K_SMB_DFMT_1BYTE            0
170#define K_SMB_DFMT_2BYTE            1
171#define K_SMB_DFMT_3BYTE            2
172#define K_SMB_DFMT_4BYTE            3
173#define K_SMB_DFMT_NODATA           4
174#define K_SMB_DFMT_CMD4BYTE         5
175#define K_SMB_DFMT_CMD5BYTE         6
176#define K_SMB_DFMT_RESERVED         7
177
178#define V_SMB_DFMT_1BYTE	    V_SMB_DFMT(K_SMB_DFMT_1BYTE)
179#define V_SMB_DFMT_2BYTE	    V_SMB_DFMT(K_SMB_DFMT_2BYTE)
180#define V_SMB_DFMT_3BYTE	    V_SMB_DFMT(K_SMB_DFMT_3BYTE)
181#define V_SMB_DFMT_4BYTE	    V_SMB_DFMT(K_SMB_DFMT_4BYTE)
182#define V_SMB_DFMT_NODATA	    V_SMB_DFMT(K_SMB_DFMT_NODATA)
183#define V_SMB_DFMT_CMD4BYTE	    V_SMB_DFMT(K_SMB_DFMT_CMD4BYTE)
184#define V_SMB_DFMT_CMD5BYTE	    V_SMB_DFMT(K_SMB_DFMT_CMD5BYTE)
185#define V_SMB_DFMT_RESERVED	    V_SMB_DFMT(K_SMB_DFMT_RESERVED)
186
187#define S_SMB_AFMT                  11
188#define M_SMB_AFMT                  _SB_MAKEMASK(2,S_SMB_AFMT)
189#define V_SMB_AFMT(x)               _SB_MAKEVALUE(x,S_SMB_AFMT)
190#define G_SMB_AFMT(x)               _SB_GETVALUE(x,S_SMB_AFMT,M_SMB_AFMT)
191
192#define K_SMB_AFMT_NONE             0
193#define K_SMB_AFMT_ADDR             1
194#define K_SMB_AFMT_ADDR_CMD1BYTE    2
195#define K_SMB_AFMT_ADDR_CMD2BYTE    3
196
197#define V_SMB_AFMT_NONE		    V_SMB_AFMT(K_SMB_AFMT_NONE)
198#define V_SMB_AFMT_ADDR		    V_SMB_AFMT(K_SMB_AFMT_ADDR)
199#define V_SMB_AFMT_ADDR_CMD1BYTE    V_SMB_AFMT(K_SMB_AFMT_ADDR_CMD1BYTE)
200#define V_SMB_AFMT_ADDR_CMD2BYTE    V_SMB_AFMT(K_SMB_AFMT_ADDR_CMD2BYTE)
201
202#define M_SMB_DIR		    _SB_MAKEMASK1(13)
203
204#endif /* 1250 PASS2 || 112x PASS1 || 1480 */
205
206#endif
207