release/src-rt-6.x.4708/cfe/cfe/arch/mips/cpu/sb1250/include/sb1250_smbus.h

   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,2002,2003
  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
  27     *     as 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.  The "Broadcom Corporation"
  31     *     name may not be used to endorse or promote products derived
  32     *     from this software without the prior written permission of
  33     *     Broadcom Corporation.
  34     *
  35     *  3) THIS SOFTWARE IS PROVIDED "AS-IS" AND ANY EXPRESS OR
  36     *     IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO, ANY IMPLIED
  37     *     WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  38     *     PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT
  39     *     SHALL BROADCOM BE LIABLE FOR ANY DAMAGES WHATSOEVER, AND IN
  40     *     PARTICULAR, BROADCOM SHALL NOT BE LIABLE FOR DIRECT, INDIRECT,
  41     *     INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  42     *     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  43     *     GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  44     *     BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  45     *     OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  46     *     TORT (INCLUDING NEGLIGENCE OR OTHERWISE), EVEN IF ADVISED OF
  47     *     THE POSSIBILITY OF SUCH DAMAGE.
  48     ********************************************************************* */
  49
  50
  51 #ifndef _SB1250_SMBUS_H
  52 #define _SB1250_SMBUS_H
  53
  54 #include "sb1250_defs.h"
  55
  56 /*
  57  * SMBus Clock Frequency Register (Table 14-2)
  58  */
  59
  60 #define S_SMB_FREQ_DIV              0
  61 #define M_SMB_FREQ_DIV              _SB_MAKEMASK(13,S_SMB_FREQ_DIV)
  62 #define V_SMB_FREQ_DIV(x)           _SB_MAKEVALUE(x,S_SMB_FREQ_DIV)
  63
  64 #define K_SMB_FREQ_400KHZ           0x1F
  65 #define K_SMB_FREQ_100KHZ           0x7D
  66
  67 #define S_SMB_CMD                   0
  68 #define M_SMB_CMD                   _SB_MAKEMASK(8,S_SMB_CMD)
  69 #define V_SMB_CMD(x)                _SB_MAKEVALUE(x,S_SMB_CMD)
  70
  71 /*
  72  * SMBus control register (Table 14-4)
  73  */
  74
  75 #define M_SMB_ERR_INTR              _SB_MAKEMASK1(0)
  76 #define M_SMB_FINISH_INTR           _SB_MAKEMASK1(1)
  77 #define M_SMB_DATA_OUT              _SB_MAKEMASK1(4)
  78 #define M_SMB_DATA_DIR              _SB_MAKEMASK1(5)
  79 #define M_SMB_DATA_DIR_OUTPUT       M_SMB_DATA_DIR
  80 #define M_SMB_CLK_OUT               _SB_MAKEMASK1(6)
  81 #define M_SMB_DIRECT_ENABLE         _SB_MAKEMASK1(7)
  82
  83 /*
  84  * SMBus status registers (Table 14-5)
  85  */
  86
  87 #define M_SMB_BUSY                  _SB_MAKEMASK1(0)
  88 #define M_SMB_ERROR                 _SB_MAKEMASK1(1)
  89 #define M_SMB_ERROR_TYPE            _SB_MAKEMASK1(2)
  90 #define M_SMB_REF                   _SB_MAKEMASK1(6)
  91 #define M_SMB_DATA_IN               _SB_MAKEMASK1(7)
  92
  93 /*
  94  * SMBus Start/Command registers (Table 14-9)
  95  */
  96
  97 #define S_SMB_ADDR                  0
  98 #define M_SMB_ADDR                  _SB_MAKEMASK(7,S_SMB_ADDR)
  99 #define V_SMB_ADDR(x)               _SB_MAKEVALUE(x,S_SMB_ADDR)
 100 #define G_SMB_ADDR(x)               _SB_GETVALUE(x,S_SMB_ADDR,M_SMB_ADDR)
 101
 102 #define M_SMB_QDATA                 _SB_MAKEMASK1(7)
 103
 104 #define S_SMB_TT                    8
 105 #define M_SMB_TT                    _SB_MAKEMASK(3,S_SMB_TT)
 106 #define V_SMB_TT(x)                 _SB_MAKEVALUE(x,S_SMB_TT)
 107 #define G_SMB_TT(x)                 _SB_GETVALUE(x,S_SMB_TT,M_SMB_TT)
 108
 109 #define K_SMB_TT_WR1BYTE            0
 110 #define K_SMB_TT_WR2BYTE            1
 111 #define K_SMB_TT_WR3BYTE            2
 112 #define K_SMB_TT_CMD_RD1BYTE        3
 113 #define K_SMB_TT_CMD_RD2BYTE        4
 114 #define K_SMB_TT_RD1BYTE            5
 115 #define K_SMB_TT_QUICKCMD           6
 116 #define K_SMB_TT_EEPROMREAD         7
 117
 118 #define V_SMB_TT_WR1BYTE            V_SMB_TT(K_SMB_TT_WR1BYTE)
 119 #define V_SMB_TT_WR2BYTE            V_SMB_TT(K_SMB_TT_WR2BYTE)
 120 #define V_SMB_TT_WR3BYTE            V_SMB_TT(K_SMB_TT_WR3BYTE)
 121 #define V_SMB_TT_CMD_RD1BYTE        V_SMB_TT(K_SMB_TT_CMD_RD1BYTE)
 122 #define V_SMB_TT_CMD_RD2BYTE        V_SMB_TT(K_SMB_TT_CMD_RD2BYTE)
 123 #define V_SMB_TT_RD1BYTE            V_SMB_TT(K_SMB_TT_RD1BYTE)
 124 #define V_SMB_TT_QUICKCMD           V_SMB_TT(K_SMB_TT_QUICKCMD)
 125 #define V_SMB_TT_EEPROMREAD         V_SMB_TT(K_SMB_TT_EEPROMREAD)
 126
 127 #define M_SMB_PEC                   _SB_MAKEMASK1(15)
 128
 129 /*
 130  * SMBus Data Register (Table 14-6) and SMBus Extra Register (Table 14-7)
 131  */
 132
 133 #define S_SMB_LB                    0
 134 #define M_SMB_LB                    _SB_MAKEMASK(8,S_SMB_LB)
 135 #define V_SMB_LB(x)                 _SB_MAKEVALUE(x,S_SMB_LB)
 136
 137 #define S_SMB_MB                    8
 138 #define M_SMB_MB                    _SB_MAKEMASK(8,S_SMB_MB)
 139 #define V_SMB_MB(x)                 _SB_MAKEVALUE(x,S_SMB_MB)
 140
 141
 142 /*
 143  * SMBus Packet Error Check register (Table 14-8)
 144  */
 145
 146 #define S_SPEC_PEC                  0
 147 #define M_SPEC_PEC                  _SB_MAKEMASK(8,S_SPEC_PEC)
 148 #define V_SPEC_MB(x)                _SB_MAKEVALUE(x,S_SPEC_PEC)
 149
 150
 151 #if SIBYTE_HDR_FEATURE(1250, PASS2) || SIBYTE_HDR_FEATURE(112x, PASS1)
 152
 153 #define S_SMB_CMDH                  8
 154 #define M_SMB_CMDH                  _SB_MAKEMASK(8,S_SMBH_CMD)
 155 #define V_SMB_CMDH(x)               _SB_MAKEVALUE(x,S_SMBH_CMD)
 156
 157 #define M_SMB_EXTEND                _SB_MAKEMASK1(14)
 158
 159 #define M_SMB_DIR                   _SB_MAKEMASK1(13)
 160
 161 #define S_SMB_DFMT                  8
 162 #define M_SMB_DFMT                  _SB_MAKEMASK(3,S_SMB_DFMT)
 163 #define V_SMB_DFMT(x)               _SB_MAKEVALUE(x,S_SMB_DFMT)
 164 #define G_SMB_DFMT(x)               _SB_GETVALUE(x,S_SMB_DFMT,M_SMB_DFMT)
 165
 166 #define K_SMB_DFMT_1BYTE            0
 167 #define K_SMB_DFMT_2BYTE            1
 168 #define K_SMB_DFMT_3BYTE            2
 169 #define K_SMB_DFMT_4BYTE            3
 170 #define K_SMB_DFMT_NODATA           4
 171 #define K_SMB_DFMT_CMD4BYTE         5
 172 #define K_SMB_DFMT_CMD5BYTE         6
 173 #define K_SMB_DFMT_RESERVED         7
 174
 175 #define V_SMB_DFMT_1BYTE            V_SMB_DFMT(K_SMB_DFMT_1BYTE)
 176 #define V_SMB_DFMT_2BYTE            V_SMB_DFMT(K_SMB_DFMT_2BYTE)
 177 #define V_SMB_DFMT_3BYTE            V_SMB_DFMT(K_SMB_DFMT_3BYTE)
 178 #define V_SMB_DFMT_4BYTE            V_SMB_DFMT(K_SMB_DFMT_4BYTE)
 179 #define V_SMB_DFMT_NODATA           V_SMB_DFMT(K_SMB_DFMT_NODATA)
 180 #define V_SMB_DFMT_CMD4BYTE         V_SMB_DFMT(K_SMB_DFMT_CMD4BYTE)
 181 #define V_SMB_DFMT_CMD5BYTE         V_SMB_DFMT(K_SMB_DFMT_CMD5BYTE)
 182 #define V_SMB_DFMT_RESERVED         V_SMB_DFMT(K_SMB_DFMT_RESERVED)
 183
 184 #endif /* 1250 PASS2 || 112x PASS1 */
 185
 186 #endif