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 * Author: Mitch Lichtenberg 13 * 14 ********************************************************************* 15 * 16 * Copyright 2000,2001,2002,2003 17 * Broadcom Corporation. All rights reserved. 18 * 19 * This software is furnished under license and may be used and 20 * copied only in accordance with the following terms and 21 * conditions. Subject to these conditions, you may download, 22 * copy, install, use, modify and distribute modified or unmodified 23 * copies of this software in source and/or binary form. No title 24 * or ownership is transferred hereby. 25 * 26 * 1) Any source code used, modified or distributed must reproduce 27 * and retain this copyright notice and list of conditions 28 * as they appear in the source file. 29 * 30 * 2) No right is granted to use any trade name, trademark, or 31 * logo of Broadcom Corporation. The "Broadcom Corporation" 32 * name may not be used to endorse or promote products derived 33 * from this software without the prior written permission of 34 * 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 #define K_SMB_FREQ_10KHZ 1250 68 69 #define S_SMB_CMD 0 70 #define M_SMB_CMD _SB_MAKEMASK(8,S_SMB_CMD) 71 #define V_SMB_CMD(x) _SB_MAKEVALUE(x,S_SMB_CMD) 72 73 /* 74 * SMBus control register (Table 14-4) 75 */ 76 77 #define M_SMB_ERR_INTR _SB_MAKEMASK1(0) 78 #define M_SMB_FINISH_INTR _SB_MAKEMASK1(1) 79 80 #define S_SMB_DATA_OUT 4 81 #define M_SMB_DATA_OUT _SB_MAKEMASK1(S_SMB_DATA_OUT) 82 #define V_SMB_DATA_OUT(x) _SB_MAKEVALUE(x,S_SMB_DATA_OUT) 83 84 #define M_SMB_DATA_DIR _SB_MAKEMASK1(5) 85 #define M_SMB_DATA_DIR_OUTPUT M_SMB_DATA_DIR 86 #define M_SMB_CLK_OUT _SB_MAKEMASK1(6) 87 #define M_SMB_DIRECT_ENABLE _SB_MAKEMASK1(7) 88 89 /* 90 * SMBus status registers (Table 14-5) 91 */ 92 93 #define M_SMB_BUSY _SB_MAKEMASK1(0) 94 #define M_SMB_ERROR _SB_MAKEMASK1(1) 95 #define M_SMB_ERROR_TYPE _SB_MAKEMASK1(2) 96 97 #if SIBYTE_HDR_FEATURE_CHIP(1280) || SIBYTE_HDR_FEATURE(1250, PASS3) || SIBYTE_HDR_FEATURE(112x, PASS1) 98 #define S_SMB_SCL_IN 5 99 #define M_SMB_SCL_IN _SB_MAKEMASK1(S_SMB_SCL_IN) 100 #define V_SMB_SCL_IN(x) _SB_MAKEVALUE(x,S_SMB_SCL_IN) 101 #define G_SMB_SCL_IN(x) _SB_GETVALUE(x,S_SMB_SCL_IN,M_SMB_SCL_IN) 102 #endif /* 1280 || 1250 PASS3 || 112x PASS1 */ 103 104 #define S_SMB_REF 6 105 #define M_SMB_REF _SB_MAKEMASK1(S_SMB_REF) 106 #define V_SMB_REF(x) _SB_MAKEVALUE(x,S_SMB_REF) 107 #define G_SMB_REF(x) _SB_GETVALUE(x,S_SMB_REF,M_SMB_REF) 108 109 #define S_SMB_DATA_IN 7 110 #define M_SMB_DATA_IN _SB_MAKEMASK1(S_SMB_DATA_IN) 111 #define V_SMB_DATA_IN(x) _SB_MAKEVALUE(x,S_SMB_DATA_IN) 112 #define G_SMB_DATA_IN(x) _SB_GETVALUE(x,S_SMB_DATA_IN,M_SMB_DATA_IN) 113 114 /* 115 * SMBus Start/Command registers (Table 14-9) 116 */ 117 118 #define S_SMB_ADDR 0 119 #define M_SMB_ADDR _SB_MAKEMASK(7,S_SMB_ADDR) 120 #define V_SMB_ADDR(x) _SB_MAKEVALUE(x,S_SMB_ADDR) 121 #define G_SMB_ADDR(x) _SB_GETVALUE(x,S_SMB_ADDR,M_SMB_ADDR) 122 123 #define M_SMB_QDATA _SB_MAKEMASK1(7) 124 125 #define S_SMB_TT 8 126 #define M_SMB_TT _SB_MAKEMASK(3,S_SMB_TT) 127 #define V_SMB_TT(x) _SB_MAKEVALUE(x,S_SMB_TT) 128 #define G_SMB_TT(x) _SB_GETVALUE(x,S_SMB_TT,M_SMB_TT) 129 130 #define K_SMB_TT_WR1BYTE 0 131 #define K_SMB_TT_WR2BYTE 1 132 #define K_SMB_TT_WR3BYTE 2 133 #define K_SMB_TT_CMD_RD1BYTE 3 134 #define K_SMB_TT_CMD_RD2BYTE 4 135 #define K_SMB_TT_RD1BYTE 5 136 #define K_SMB_TT_QUICKCMD 6 137 #define K_SMB_TT_EEPROMREAD 7 138 139 #define V_SMB_TT_WR1BYTE V_SMB_TT(K_SMB_TT_WR1BYTE) 140 #define V_SMB_TT_WR2BYTE V_SMB_TT(K_SMB_TT_WR2BYTE) 141 #define V_SMB_TT_WR3BYTE V_SMB_TT(K_SMB_TT_WR3BYTE) 142 #define V_SMB_TT_CMD_RD1BYTE V_SMB_TT(K_SMB_TT_CMD_RD1BYTE) 143 #define V_SMB_TT_CMD_RD2BYTE V_SMB_TT(K_SMB_TT_CMD_RD2BYTE) 144 #define V_SMB_TT_RD1BYTE V_SMB_TT(K_SMB_TT_RD1BYTE) 145 #define V_SMB_TT_QUICKCMD V_SMB_TT(K_SMB_TT_QUICKCMD) 146 #define V_SMB_TT_EEPROMREAD V_SMB_TT(K_SMB_TT_EEPROMREAD) 147 148 #define M_SMB_PEC _SB_MAKEMASK1(15) 149 150 /* 151 * SMBus Data Register (Table 14-6) and SMBus Extra Register (Table 14-7) 152 */ 153 154 #define S_SMB_LB 0 155 #define M_SMB_LB _SB_MAKEMASK(8,S_SMB_LB) 156 #define V_SMB_LB(x) _SB_MAKEVALUE(x,S_SMB_LB) 157 158 #define S_SMB_MB 8 159 #define M_SMB_MB _SB_MAKEMASK(8,S_SMB_MB) 160 #define V_SMB_MB(x) _SB_MAKEVALUE(x,S_SMB_MB) 161 162 163 /* 164 * SMBus Packet Error Check register (Table 14-8) 165 */ 166 167 #define S_SPEC_PEC 0 168 #define M_SPEC_PEC _SB_MAKEMASK(8,S_SPEC_PEC) 169 #define V_SPEC_MB(x) _SB_MAKEVALUE(x,S_SPEC_PEC) 170 171 172 #if SIBYTE_HDR_FEATURE_CHIP(1280) || SIBYTE_HDR_FEATURE(1250, PASS2) || SIBYTE_HDR_FEATURE(112x, PASS1) 173 174 #define S_SMB_CMDH 8 175 #define M_SMB_CMDH _SB_MAKEMASK(8,S_SMBH_CMD) 176 #define V_SMB_CMDH(x) _SB_MAKEVALUE(x,S_SMBH_CMD) 177 178 #define M_SMB_EXTEND _SB_MAKEMASK1(14) 179 180 #define S_SMB_DFMT 8 181 #define M_SMB_DFMT _SB_MAKEMASK(3,S_SMB_DFMT) 182 #define V_SMB_DFMT(x) _SB_MAKEVALUE(x,S_SMB_DFMT) 183 #define G_SMB_DFMT(x) _SB_GETVALUE(x,S_SMB_DFMT,M_SMB_DFMT) 184 185 #define K_SMB_DFMT_1BYTE 0 186 #define K_SMB_DFMT_2BYTE 1 187 #define K_SMB_DFMT_3BYTE 2 188 #define K_SMB_DFMT_4BYTE 3 189 #define K_SMB_DFMT_NODATA 4 190 #define K_SMB_DFMT_CMD4BYTE 5 191 #define K_SMB_DFMT_CMD5BYTE 6 192 #define K_SMB_DFMT_RESERVED 7 193 194 #define V_SMB_DFMT_1BYTE V_SMB_DFMT(K_SMB_DFMT_1BYTE) 195 #define V_SMB_DFMT_2BYTE V_SMB_DFMT(K_SMB_DFMT_2BYTE) 196 #define V_SMB_DFMT_3BYTE V_SMB_DFMT(K_SMB_DFMT_3BYTE) 197 #define V_SMB_DFMT_4BYTE V_SMB_DFMT(K_SMB_DFMT_4BYTE) 198 #define V_SMB_DFMT_NODATA V_SMB_DFMT(K_SMB_DFMT_NODATA) 199 #define V_SMB_DFMT_CMD4BYTE V_SMB_DFMT(K_SMB_DFMT_CMD4BYTE) 200 #define V_SMB_DFMT_CMD5BYTE V_SMB_DFMT(K_SMB_DFMT_CMD5BYTE) 201 #define V_SMB_DFMT_RESERVED V_SMB_DFMT(K_SMB_DFMT_RESERVED) 202 203 #define S_SMB_AFMT 11 204 #define M_SMB_AFMT _SB_MAKEMASK(2,S_SMB_AFMT) 205 #define V_SMB_AFMT(x) _SB_MAKEVALUE(x,S_SMB_AFMT) 206 #define G_SMB_AFMT(x) _SB_GETVALUE(x,S_SMB_AFMT,M_SMB_AFMT) 207 208 #define K_SMB_AFMT_NONE 0 209 #define K_SMB_AFMT_ADDR 1 210 #define K_SMB_AFMT_ADDR_CMD1BYTE 2 211 #define K_SMB_AFMT_ADDR_CMD2BYTE 3 212 213 #define V_SMB_AFMT_NONE V_SMB_AFMT(K_SMB_AFMT_NONE) 214 #define V_SMB_AFMT_ADDR V_SMB_AFMT(K_SMB_AFMT_ADDR) 215 #define V_SMB_AFMT_ADDR_1BYTE V_SMB_AFMT(K_SMB_AFMT_ADDR_1BYTE) 216 #define V_SMB_AFMT_ADDR_2BYTE V_SMB_AFMT(K_SMB_AFMT_ADDR_2BYTE) 217 218 #define M_SMB_DIR _SB_MAKEMASK1(13) 219 220 #endif /* 1280 || 1250 PASS2 || 112x PASS1 */ 221 222 #endif 223