target/linux/generic-2.6/files/crypto/ocf/kirkwood/mvHal/mv_hal/pex/mvPex.h

   1 /*******************************************************************************
   2 Copyright (C) Marvell International Ltd. and its affiliates
   3
   4 This software file (the "File") is owned and distributed by Marvell
   5 International Ltd. and/or its affiliates ("Marvell") under the following
   6 alternative licensing terms.  Once you have made an election to distribute the
   7 File under one of the following license alternatives, please (i) delete this
   8 introductory statement regarding license alternatives, (ii) delete the two
   9 license alternatives that you have not elected to use and (iii) preserve the
  10 Marvell copyright notice above.
  11
  12 ********************************************************************************
  13 Marvell Commercial License Option
  14
  15 If you received this File from Marvell and you have entered into a commercial
  16 license agreement (a "Commercial License") with Marvell, the File is licensed
  17 to you under the terms of the applicable Commercial License.
  18
  19 ********************************************************************************
  20 Marvell GPL License Option
  21
  22 If you received this File from Marvell, you may opt to use, redistribute and/or
  23 modify this File in accordance with the terms and conditions of the General
  24 Public License Version 2, June 1991 (the "GPL License"), a copy of which is
  25 available along with the File in the license.txt file or by writing to the Free
  26 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 or
  27 on the worldwide web at http://www.gnu.org/licenses/gpl.txt.
  28
  29 THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE IMPLIED
  30 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE ARE EXPRESSLY
  31 DISCLAIMED.  The GPL License provides additional details about this warranty
  32 disclaimer.
  33 ********************************************************************************
  34 Marvell BSD License Option
  35
  36 If you received this File from Marvell, you may opt to use, redistribute and/or
  37 modify this File under the following licensing terms.
  38 Redistribution and use in source and binary forms, with or without modification,
  39 are permitted provided that the following conditions are met:
  40
  41     *   Redistributions of source code must retain the above copyright notice,
  42             this list of conditions and the following disclaimer.
  43
  44     *   Redistributions in binary form must reproduce the above copyright
  45         notice, this list of conditions and the following disclaimer in the
  46         documentation and/or other materials provided with the distribution.
  47
  48     *   Neither the name of Marvell nor the names of its contributors may be
  49         used to endorse or promote products derived from this software without
  50         specific prior written permission.
  51
  52 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  53 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  54 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  55 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
  56 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  57 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  58 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  59 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  60 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  61 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  62
  63 *******************************************************************************/
  64
  65 #ifndef __INCPEXH
  66 #define __INCPEXH
  67
  68 #include "mvCommon.h"
  69 #include "mvOs.h"
  70 #include "pex/mvPexRegs.h"
  71 #include "ctrlEnv/mvCtrlEnvSpec.h"
  72
  73
  74
  75 /* NOTE not supported in this driver:*/
  76
  77
  78 /* defines */
  79 /* The number of supported PEX interfaces depend on Marvell controller          */
  80 /* device number. This device number ID is located on the PEX unit                      */
  81 /* configuration header. This creates a loop where calling PEX                          */
  82 /* configuration read/write     routine results a call to get PEX configuration */
  83 /* information etc. This macro defines a default PEX interface. This PEX        */
  84 /* interface is sure to exist.                                                                                          */
  85 #define PEX_DEFAULT_IF  0
  86
  87
  88 /* typedefs */
  89 /* The Marvell controller supports both root complex and end point devices */
  90 /* This enumeration describes the PEX type.                                 */
  91 typedef enum _mvPexType
  92 {
  93     MV_PEX_ROOT_COMPLEX,        /* root complex device */
  94     MV_PEX_END_POINT        /* end point device */
  95 }MV_PEX_TYPE;
  96
  97 typedef enum _mvPexWidth
  98 {
  99     MV_PEX_WITDH_X1 = 1,
 100     MV_PEX_WITDH_X2,
 101     MV_PEX_WITDH_X3,
 102     MV_PEX_WITDH_X4,
 103     MV_PEX_WITDH_INVALID
 104 }MV_PEX_WIDTH;
 105
 106 /* PEX Bar attributes */
 107 typedef struct _mvPexMode
 108 {
 109         MV_PEX_TYPE     pexType;
 110         MV_PEX_WIDTH    pexWidth;
 111         MV_BOOL         pexLinkUp;
 112 }MV_PEX_MODE;
 113
 114
 115
 116 /* Global Functions prototypes */
 117 /* mvPexInit - Initialize PEX interfaces*/
 118 MV_STATUS mvPexHalInit(MV_U32 pexIf, MV_PEX_TYPE pexType);
 119
 120 /* mvPexModeGet - Get Pex If mode */
 121 MV_U32 mvPexModeGet(MV_U32 pexIf,MV_PEX_MODE *pexMode);
 122
 123 /* mvPexConfigRead - Read from configuration space */
 124 MV_U32 mvPexConfigRead (MV_U32 pexIf, MV_U32 bus, MV_U32 dev,
 125                                                 MV_U32 func,MV_U32 regOff);
 126
 127 /* mvPexConfigWrite - Write to configuration space */
 128 MV_STATUS mvPexConfigWrite(MV_U32 pexIf, MV_U32 bus, MV_U32 dev,
 129                            MV_U32 func, MV_U32 regOff, MV_U32 data);
 130
 131 /* mvPexMasterEnable - Enable/disale PEX interface master transactions.*/
 132 MV_STATUS mvPexMasterEnable(MV_U32 pexIf, MV_BOOL enable);
 133
 134 /* mvPexSlaveEnable - Enable/disale PEX interface slave transactions.*/
 135 MV_STATUS mvPexSlaveEnable(MV_U32 pexIf, MV_U32 bus,MV_U32 dev, MV_BOOL enable);
 136
 137 /* mvPexLocalBusNumSet - Set PEX interface local bus number.*/
 138 MV_STATUS mvPexLocalBusNumSet(MV_U32 pexIf, MV_U32 busNum);
 139
 140 /* mvPexLocalBusNumGet - Get PEX interface local bus number.*/
 141 MV_U32 mvPexLocalBusNumGet(MV_U32 pexIf);
 142
 143 /* mvPexLocalDevNumSet - Set PEX interface local device number.*/
 144 MV_STATUS mvPexLocalDevNumSet(MV_U32 pexIf, MV_U32 devNum);
 145
 146 /* mvPexLocalDevNumGet - Get PEX interface local device number.*/
 147 MV_U32 mvPexLocalDevNumGet(MV_U32 pexIf);
 148 /* mvPexForceX1 - Force PEX interface to X1 mode. */
 149 MV_U32 mvPexForceX1(MV_U32 pexIf);
 150
 151 /* mvPexIsPowerUp - Is PEX interface Power up? */
 152 MV_BOOL mvPexIsPowerUp(MV_U32 pexIf);
 153
 154 /* mvPexPowerDown - Power Down */
 155 MV_VOID mvPexPowerDown(MV_U32 pexIf);
 156
 157 /* mvPexPowerUp - Power Up */
 158 MV_VOID mvPexPowerUp(MV_U32 pexIf);
 159
 160 /* mvPexPhyRegRead - Pex phy read */
 161 MV_VOID mvPexPhyRegRead(MV_U32 pexIf, MV_U32 regOffset, MV_U16 *value);
 162
 163 /* mvPexPhyRegWrite - Pex phy write */
 164 MV_VOID mvPexPhyRegWrite(MV_U32 pexIf, MV_U32 regOffset, MV_U16 value);
 165
 166 MV_STATUS mvPexActiveStateLinkPMEnable(MV_U32 pexIf, MV_BOOL enable);
 167
 168 #endif /* #ifndef __INCPEXH */