target/linux/generic/files/crypto/ocf/kirkwood/mvHal/kw_family/ctrlEnv/mvCtrlEnvAddrDec.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
  66 #ifndef __INCmvCtrlEnvAddrDech
  67 #define __INCmvCtrlEnvAddrDech
  68
  69 /* includes */
  70 #include "ctrlEnv/mvCtrlEnvLib.h"
  71 #include "ctrlEnv/mvCtrlEnvRegs.h"
  72
  73
  74 /* defines  */
  75 /* DUnit attributes */
  76 #define ATMWCR_WIN_DUNIT_CS0_OFFS                       0
  77 #define ATMWCR_WIN_DUNIT_CS0_MASK                       BIT0
  78 #define ATMWCR_WIN_DUNIT_CS0_REQ                        (0 << ATMWCR_WIN_DUNIT_CS0_OFFS)
  79
  80 #define ATMWCR_WIN_DUNIT_CS1_OFFS                       1
  81 #define ATMWCR_WIN_DUNIT_CS1_MASK                       BIT1
  82 #define ATMWCR_WIN_DUNIT_CS1_REQ                        (0 << ATMWCR_WIN_DUNIT_CS1_OFFS)
  83
  84 #define ATMWCR_WIN_DUNIT_CS2_OFFS                       2
  85 #define ATMWCR_WIN_DUNIT_CS2_MASK                       BIT2
  86 #define ATMWCR_WIN_DUNIT_CS2_REQ                        (0 << ATMWCR_WIN_DUNIT_CS2_OFFS)
  87
  88 #define ATMWCR_WIN_DUNIT_CS3_OFFS                       3
  89 #define ATMWCR_WIN_DUNIT_CS3_MASK                       BIT3
  90 #define ATMWCR_WIN_DUNIT_CS3_REQ                        (0 << ATMWCR_WIN_DUNIT_CS3_OFFS)
  91
  92 /* RUnit (Device)  attributes */
  93 #define ATMWCR_WIN_RUNIT_DEVCS0_OFFS            0
  94 #define ATMWCR_WIN_RUNIT_DEVCS0_MASK            BIT0
  95 #define ATMWCR_WIN_RUNIT_DEVCS0_REQ                     (0 << ATMWCR_WIN_RUNIT_DEVCS0_OFFS)
  96
  97 #define ATMWCR_WIN_RUNIT_DEVCS1_OFFS            1
  98 #define ATMWCR_WIN_RUNIT_DEVCS1_MASK            BIT1
  99 #define ATMWCR_WIN_RUNIT_DEVCS1_REQ             (0 << ATMWCR_WIN_RUNIT_DEVCS1_OFFS)
 100
 101 #define ATMWCR_WIN_RUNIT_DEVCS2_OFFS            2
 102 #define ATMWCR_WIN_RUNIT_DEVCS2_MASK            BIT2
 103 #define ATMWCR_WIN_RUNIT_DEVCS2_REQ             (0 << ATMWCR_WIN_RUNIT_DEVCS2_OFFS)
 104
 105 #define ATMWCR_WIN_RUNIT_BOOTCS_OFFS            4
 106 #define ATMWCR_WIN_RUNIT_BOOTCS_MASK            BIT4
 107 #define ATMWCR_WIN_RUNIT_BOOTCS_REQ             (0 << ATMWCR_WIN_RUNIT_BOOTCS_OFFS)
 108
 109 /* LMaster (PCI)  attributes */
 110 #define ATMWCR_WIN_LUNIT_BYTE_SWP_OFFS          0
 111 #define ATMWCR_WIN_LUNIT_BYTE_SWP_MASK          BIT0
 112 #define ATMWCR_WIN_LUNIT_BYTE_SWP                       (0 << ATMWCR_WIN_LUNIT_BYTE_SWP_OFFS)
 113 #define ATMWCR_WIN_LUNIT_BYTE_NO_SWP            (1 << ATMWCR_WIN_LUNIT_BYTE_SWP_OFFS)
 114
 115
 116 #define ATMWCR_WIN_LUNIT_WORD_SWP_OFFS          1
 117 #define ATMWCR_WIN_LUNIT_WORD_SWP_MASK          BIT1
 118 #define ATMWCR_WIN_LUNIT_WORD_SWP                       (0 << ATMWCR_WIN_LUNIT_WORD_SWP_OFFS)
 119 #define ATMWCR_WIN_LUNIT_WORD_NO_SWP            (1 << ATMWCR_WIN_LUNIT_WORD_SWP_OFFS)
 120
 121 #define ATMWCR_WIN_LUNIT_NO_SNOOP                       BIT2
 122
 123 #define ATMWCR_WIN_LUNIT_TYPE_OFFS                      3
 124 #define ATMWCR_WIN_LUNIT_TYPE_MASK                      BIT3
 125 #define ATMWCR_WIN_LUNIT_TYPE_IO                        (0 << ATMWCR_WIN_LUNIT_TYPE_OFFS)
 126 #define ATMWCR_WIN_LUNIT_TYPE_MEM                       (1 << ATMWCR_WIN_LUNIT_TYPE_OFFS)
 127
 128 #define ATMWCR_WIN_LUNIT_FORCE64_OFFS           4
 129 #define ATMWCR_WIN_LUNIT_FORCE64_MASK           BIT4
 130 #define ATMWCR_WIN_LUNIT_FORCE64                        (0 << ATMWCR_WIN_LUNIT_FORCE64_OFFS)
 131
 132 #define ATMWCR_WIN_LUNIT_ORDERING_OFFS          6
 133 #define ATMWCR_WIN_LUNIT_ORDERING_MASK          BIT6
 134 #define ATMWCR_WIN_LUNIT_ORDERING                       (1 << ATMWCR_WIN_LUNIT_FORCE64_OFFS)
 135
 136 /* PEX Attributes */
 137 #define ATMWCR_WIN_PEX_TYPE_OFFS                        3
 138 #define ATMWCR_WIN_PEX_TYPE_MASK                        BIT3
 139 #define ATMWCR_WIN_PEX_TYPE_IO                          (0 << ATMWCR_WIN_PEX_TYPE_OFFS)
 140 #define ATMWCR_WIN_PEX_TYPE_MEM                         (1 << ATMWCR_WIN_PEX_TYPE_OFFS)
 141
 142 /* typedefs */
 143
 144 /* Unsupported attributes for address decode:                               */
 145 /* 2) PCI0/1_REQ64n control                                                 */
 146
 147 typedef struct _mvDecRegs
 148 {
 149         MV_U32 baseReg;
 150     MV_U32 baseRegHigh;
 151     MV_U32 sizeReg;
 152
 153 }MV_DEC_REGS;
 154
 155 typedef struct _mvTargetAttrib
 156 {
 157         MV_U8                   attrib;                 /* chip select attributes */
 158         MV_TARGET_ID            targetId;               /* Target Id of this MV_TARGET */
 159
 160 }MV_TARGET_ATTRIB;
 161 \r
 162 \r
 163 /* This structure describes address decode window                           */\r
 164 typedef struct _mvDecWin \r
 165 {\r
 166     MV_TARGET       target;         /* Target for addr decode window        */\r
 167     MV_ADDR_WIN     addrWin;        /* Address window of target             */\r
 168     MV_BOOL             enable;         /* Window enable/disable                */\r
 169 }MV_DEC_WIN;\r
 170 \r
 171 typedef struct _mvDecWinParams\r
 172 {\r
 173     MV_TARGET_ID    targetId;   /* Target ID field */\r
 174     MV_U8           attrib;     /* Attribute field */\r
 175     MV_U32          baseAddr;   /* Base address in register format */\r
 176     MV_U32          size;       /* Size in register format */\r
 177 }MV_DEC_WIN_PARAMS;\r
 178
 179
 180 /* mvCtrlEnvAddrDec API list */
 181
 182 MV_STATUS mvCtrlAddrDecToReg(MV_ADDR_WIN *pAddrDecWin,
 183                                                          MV_DEC_REGS *pAddrDecRegs);
 184
 185 MV_STATUS mvCtrlRegToAddrDec(MV_DEC_REGS *pAddrDecRegs,
 186                                                          MV_ADDR_WIN *pAddrDecWin);
 187
 188 MV_STATUS mvCtrlAttribGet(MV_TARGET target,
 189                                                   MV_TARGET_ATTRIB *targetAttrib);
 190
 191 MV_TARGET mvCtrlTargetGet(MV_TARGET_ATTRIB *targetAttrib);
 192
 193
 194 MV_STATUS mvCtrlAddrDecToParams(MV_DEC_WIN *pAddrDecWin, \r
 195                                 MV_DEC_WIN_PARAMS *pWinParam);\r
 196
 197 MV_STATUS mvCtrlParamsToAddrDec(MV_DEC_WIN_PARAMS *pWinParam, \r
 198                                 MV_DEC_WIN *pAddrDecWin);\r
 199
 200
 201
 202
 203 #endif /* __INCmvCtrlEnvAddrDech */