sb1250_smbus.h revision 1.2.2.2 1 1.2.2.2 nathanw /* *********************************************************************
2 1.2.2.2 nathanw * SB1250 Board Support Package
3 1.2.2.2 nathanw *
4 1.2.2.2 nathanw * SMBUS Constants File: sb1250_smbus.h
5 1.2.2.2 nathanw *
6 1.2.2.2 nathanw * This module contains constants and macros useful for
7 1.2.2.2 nathanw * manipulating the SB1250's SMbus devices.
8 1.2.2.2 nathanw *
9 1.2.2.2 nathanw * SB1250 specification level: 01/02/2002
10 1.2.2.2 nathanw *
11 1.2.2.2 nathanw * Author: Mitch Lichtenberg (mpl (at) broadcom.com)
12 1.2.2.2 nathanw *
13 1.2.2.2 nathanw *********************************************************************
14 1.2.2.2 nathanw *
15 1.2.2.2 nathanw * Copyright 2000,2001
16 1.2.2.2 nathanw * Broadcom Corporation. All rights reserved.
17 1.2.2.2 nathanw *
18 1.2.2.2 nathanw * This software is furnished under license and may be used and
19 1.2.2.2 nathanw * copied only in accordance with the following terms and
20 1.2.2.2 nathanw * conditions. Subject to these conditions, you may download,
21 1.2.2.2 nathanw * copy, install, use, modify and distribute modified or unmodified
22 1.2.2.2 nathanw * copies of this software in source and/or binary form. No title
23 1.2.2.2 nathanw * or ownership is transferred hereby.
24 1.2.2.2 nathanw *
25 1.2.2.2 nathanw * 1) Any source code used, modified or distributed must reproduce
26 1.2.2.2 nathanw * and retain this copyright notice and list of conditions as
27 1.2.2.2 nathanw * they appear in the source file.
28 1.2.2.2 nathanw *
29 1.2.2.2 nathanw * 2) No right is granted to use any trade name, trademark, or
30 1.2.2.2 nathanw * logo of Broadcom Corporation. Neither the "Broadcom
31 1.2.2.2 nathanw * Corporation" name nor any trademark or logo of Broadcom
32 1.2.2.2 nathanw * Corporation may be used to endorse or promote products
33 1.2.2.2 nathanw * derived from this software without the prior written
34 1.2.2.2 nathanw * permission of Broadcom Corporation.
35 1.2.2.2 nathanw *
36 1.2.2.2 nathanw * 3) THIS SOFTWARE IS PROVIDED "AS-IS" AND ANY EXPRESS OR
37 1.2.2.2 nathanw * IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO, ANY IMPLIED
38 1.2.2.2 nathanw * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
39 1.2.2.2 nathanw * PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT
40 1.2.2.2 nathanw * SHALL BROADCOM BE LIABLE FOR ANY DAMAGES WHATSOEVER, AND IN
41 1.2.2.2 nathanw * PARTICULAR, BROADCOM SHALL NOT BE LIABLE FOR DIRECT, INDIRECT,
42 1.2.2.2 nathanw * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
43 1.2.2.2 nathanw * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
44 1.2.2.2 nathanw * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
45 1.2.2.2 nathanw * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
46 1.2.2.2 nathanw * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
47 1.2.2.2 nathanw * TORT (INCLUDING NEGLIGENCE OR OTHERWISE), EVEN IF ADVISED OF
48 1.2.2.2 nathanw * THE POSSIBILITY OF SUCH DAMAGE.
49 1.2.2.2 nathanw ********************************************************************* */
50 1.2.2.2 nathanw
51 1.2.2.2 nathanw
52 1.2.2.2 nathanw #ifndef _SB1250_SMBUS_H
53 1.2.2.2 nathanw #define _SB1250_SMBUS_H
54 1.2.2.2 nathanw
55 1.2.2.2 nathanw #include "sb1250_defs.h"
56 1.2.2.2 nathanw
57 1.2.2.2 nathanw /*
58 1.2.2.2 nathanw * SMBus Clock Frequency Register (Table 14-2)
59 1.2.2.2 nathanw */
60 1.2.2.2 nathanw
61 1.2.2.2 nathanw #define S_SMB_FREQ_DIV 0
62 1.2.2.2 nathanw #define M_SMB_FREQ_DIV _SB_MAKEMASK(13,S_SMB_FREQ_DIV)
63 1.2.2.2 nathanw #define V_SMB_FREQ_DIV(x) _SB_MAKEVALUE(x,S_SMB_FREQ_DIV)
64 1.2.2.2 nathanw
65 1.2.2.2 nathanw #define K_SMB_FREQ_400KHZ 0x1F
66 1.2.2.2 nathanw #define K_SMB_FREQ_100KHZ 0x7D
67 1.2.2.2 nathanw
68 1.2.2.2 nathanw #define S_SMB_CMD 0
69 1.2.2.2 nathanw #define M_SMB_CMD _SB_MAKEMASK(8,S_SMB_CMD)
70 1.2.2.2 nathanw #define V_SMB_CMD(x) _SB_MAKEVALUE(x,S_SMB_CMD)
71 1.2.2.2 nathanw
72 1.2.2.2 nathanw /*
73 1.2.2.2 nathanw * SMBus control register (Table 14-4)
74 1.2.2.2 nathanw */
75 1.2.2.2 nathanw
76 1.2.2.2 nathanw #define M_SMB_ERR_INTR _SB_MAKEMASK1(0)
77 1.2.2.2 nathanw #define M_SMB_FINISH_INTR _SB_MAKEMASK1(1)
78 1.2.2.2 nathanw #define M_SMB_DATA_OUT _SB_MAKEMASK1(4)
79 1.2.2.2 nathanw #define M_SMB_DATA_DIR _SB_MAKEMASK1(5)
80 1.2.2.2 nathanw #define M_SMB_DATA_DIR_OUTPUT M_SMB_DATA_DIR
81 1.2.2.2 nathanw #define M_SMB_CLK_OUT _SB_MAKEMASK1(6)
82 1.2.2.2 nathanw #define M_SMB_DIRECT_ENABLE _SB_MAKEMASK1(7)
83 1.2.2.2 nathanw
84 1.2.2.2 nathanw /*
85 1.2.2.2 nathanw * SMBus status registers (Table 14-5)
86 1.2.2.2 nathanw */
87 1.2.2.2 nathanw
88 1.2.2.2 nathanw #define M_SMB_BUSY _SB_MAKEMASK1(0)
89 1.2.2.2 nathanw #define M_SMB_ERROR _SB_MAKEMASK1(1)
90 1.2.2.2 nathanw #define M_SMB_ERROR_TYPE _SB_MAKEMASK1(2)
91 1.2.2.2 nathanw #define M_SMB_REF _SB_MAKEMASK1(6)
92 1.2.2.2 nathanw #define M_SMB_DATA_IN _SB_MAKEMASK1(7)
93 1.2.2.2 nathanw
94 1.2.2.2 nathanw /*
95 1.2.2.2 nathanw * SMBus Start/Command registers (Table 14-9)
96 1.2.2.2 nathanw */
97 1.2.2.2 nathanw
98 1.2.2.2 nathanw #define S_SMB_ADDR 0
99 1.2.2.2 nathanw #define M_SMB_ADDR _SB_MAKEMASK(7,S_SMB_ADDR)
100 1.2.2.2 nathanw #define V_SMB_ADDR(x) _SB_MAKEVALUE(x,S_SMB_ADDR)
101 1.2.2.2 nathanw #define G_SMB_ADDR(x) _SB_GETVALUE(x,S_SMB_ADDR,M_SMB_ADDR)
102 1.2.2.2 nathanw
103 1.2.2.2 nathanw #define M_SMB_QDATA _SB_MAKEMASK1(7)
104 1.2.2.2 nathanw
105 1.2.2.2 nathanw #define S_SMB_TT 8
106 1.2.2.2 nathanw #define M_SMB_TT _SB_MAKEMASK(3,S_SMB_TT)
107 1.2.2.2 nathanw #define V_SMB_TT(x) _SB_MAKEVALUE(x,S_SMB_TT)
108 1.2.2.2 nathanw #define G_SMB_TT(x) _SB_GETVALUE(x,S_SMB_TT,M_SMB_TT)
109 1.2.2.2 nathanw
110 1.2.2.2 nathanw #define K_SMB_TT_WR1BYTE 0
111 1.2.2.2 nathanw #define K_SMB_TT_WR2BYTE 1
112 1.2.2.2 nathanw #define K_SMB_TT_WR3BYTE 2
113 1.2.2.2 nathanw #define K_SMB_TT_CMD_RD1BYTE 3
114 1.2.2.2 nathanw #define K_SMB_TT_CMD_RD2BYTE 4
115 1.2.2.2 nathanw #define K_SMB_TT_RD1BYTE 5
116 1.2.2.2 nathanw #define K_SMB_TT_QUICKCMD 6
117 1.2.2.2 nathanw #define K_SMB_TT_EEPROMREAD 7
118 1.2.2.2 nathanw
119 1.2.2.2 nathanw #define V_SMB_TT_WR1BYTE V_SMB_TT(K_SMB_TT_WR1BYTE)
120 1.2.2.2 nathanw #define V_SMB_TT_WR2BYTE V_SMB_TT(K_SMB_TT_WR2BYTE)
121 1.2.2.2 nathanw #define V_SMB_TT_WR3BYTE V_SMB_TT(K_SMB_TT_WR3BYTE)
122 1.2.2.2 nathanw #define V_SMB_TT_CMD_RD1BYTE V_SMB_TT(K_SMB_TT_CMD_RD1BYTE)
123 1.2.2.2 nathanw #define V_SMB_TT_CMD_RD2BYTE V_SMB_TT(K_SMB_TT_CMD_RD2BYTE)
124 1.2.2.2 nathanw #define V_SMB_TT_RD1BYTE V_SMB_TT(K_SMB_TT_RD1BYTE)
125 1.2.2.2 nathanw #define V_SMB_TT_QUICKCMD V_SMB_TT(K_SMB_TT_QUICKCMD)
126 1.2.2.2 nathanw #define V_SMB_TT_EEPROMREAD V_SMB_TT(K_SMB_TT_EEPROMREAD)
127 1.2.2.2 nathanw
128 1.2.2.2 nathanw #define M_SMB_PEC _SB_MAKEMASK1(15)
129 1.2.2.2 nathanw
130 1.2.2.2 nathanw /*
131 1.2.2.2 nathanw * SMBus Data Register (Table 14-6) and SMBus Extra Register (Table 14-7)
132 1.2.2.2 nathanw */
133 1.2.2.2 nathanw
134 1.2.2.2 nathanw #define S_SMB_LB 0
135 1.2.2.2 nathanw #define M_SMB_LB _SB_MAKEMASK(8,S_SMB_LB)
136 1.2.2.2 nathanw #define V_SMB_LB(x) _SB_MAKEVALUE(x,S_SMB_LB)
137 1.2.2.2 nathanw
138 1.2.2.2 nathanw #define S_SMB_MB 8
139 1.2.2.2 nathanw #define M_SMB_MB _SB_MAKEMASK(8,S_SMB_MB)
140 1.2.2.2 nathanw #define V_SMB_MB(x) _SB_MAKEVALUE(x,S_SMB_MB)
141 1.2.2.2 nathanw
142 1.2.2.2 nathanw
143 1.2.2.2 nathanw /*
144 1.2.2.2 nathanw * SMBus Packet Error Check register (Table 14-8)
145 1.2.2.2 nathanw */
146 1.2.2.2 nathanw
147 1.2.2.2 nathanw #define S_SPEC_PEC 0
148 1.2.2.2 nathanw #define M_SPEC_PEC _SB_MAKEMASK(8,S_SPEC_PEC)
149 1.2.2.2 nathanw #define V_SPEC_MB(x) _SB_MAKEVALUE(x,S_SPEC_PEC)
150 1.2.2.2 nathanw
151 1.2.2.2 nathanw
152 1.2.2.2 nathanw #if SIBYTE_HDR_FEATURE(1250, PASS2) || SIBYTE_HDR_FEATURE(112x, PASS1)
153 1.2.2.2 nathanw
154 1.2.2.2 nathanw #define S_SMB_CMDH 8
155 1.2.2.2 nathanw #define M_SMB_CMDH _SB_MAKEMASK(8,S_SMBH_CMD)
156 1.2.2.2 nathanw #define V_SMB_CMDH(x) _SB_MAKEVALUE(x,S_SMBH_CMD)
157 1.2.2.2 nathanw
158 1.2.2.2 nathanw #define M_SMB_EXTEND _SB_MAKEMASK1(14)
159 1.2.2.2 nathanw
160 1.2.2.2 nathanw #define M_SMB_DIR _SB_MAKEMASK1(13)
161 1.2.2.2 nathanw
162 1.2.2.2 nathanw #define S_SMB_DFMT 8
163 1.2.2.2 nathanw #define M_SMB_DFMT _SB_MAKEMASK(3,S_SMB_DFMT)
164 1.2.2.2 nathanw #define V_SMB_DFMT(x) _SB_MAKEVALUE(x,S_SMB_DFMT)
165 1.2.2.2 nathanw #define G_SMB_DFMT(x) _SB_GETVALUE(x,S_SMB_DFMT,M_SMB_DFMT)
166 1.2.2.2 nathanw
167 1.2.2.2 nathanw #define K_SMB_DFMT_1BYTE 0
168 1.2.2.2 nathanw #define K_SMB_DFMT_2BYTE 1
169 1.2.2.2 nathanw #define K_SMB_DFMT_3BYTE 2
170 1.2.2.2 nathanw #define K_SMB_DFMT_4BYTE 3
171 1.2.2.2 nathanw #define K_SMB_DFMT_NODATA 4
172 1.2.2.2 nathanw #define K_SMB_DFMT_CMD4BYTE 5
173 1.2.2.2 nathanw #define K_SMB_DFMT_CMD5BYTE 6
174 1.2.2.2 nathanw #define K_SMB_DFMT_RESERVED 7
175 1.2.2.2 nathanw
176 1.2.2.2 nathanw #define V_SMB_DFMT_1BYTE V_SMB_DFMT(K_SMB_DFMT_1BYTE)
177 1.2.2.2 nathanw #define V_SMB_DFMT_2BYTE V_SMB_DFMT(K_SMB_DFMT_2BYTE)
178 1.2.2.2 nathanw #define V_SMB_DFMT_3BYTE V_SMB_DFMT(K_SMB_DFMT_3BYTE)
179 1.2.2.2 nathanw #define V_SMB_DFMT_4BYTE V_SMB_DFMT(K_SMB_DFMT_4BYTE)
180 1.2.2.2 nathanw #define V_SMB_DFMT_NODATA V_SMB_DFMT(K_SMB_DFMT_NODATA)
181 1.2.2.2 nathanw #define V_SMB_DFMT_CMD4BYTE V_SMB_DFMT(K_SMB_DFMT_CMD4BYTE)
182 1.2.2.2 nathanw #define V_SMB_DFMT_CMD5BYTE V_SMB_DFMT(K_SMB_DFMT_CMD5BYTE)
183 1.2.2.2 nathanw #define V_SMB_DFMT_RESERVED V_SMB_DFMT(K_SMB_DFMT_RESERVED)
184 1.2.2.2 nathanw
185 1.2.2.2 nathanw #endif /* 1250 PASS2 || 112x PASS1 */
186 1.2.2.2 nathanw
187 1.2.2.2 nathanw #endif
188