target/linux/generic/files/crypto/ocf/kirkwood/mvHal/mv_hal/spi/mvSpiCmnd.c

   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 #include "spi/mvSpi.h"
  66 #include "spi/mvSpiSpec.h"
  67
  68 /*#define MV_DEBUG*/
  69 #ifdef MV_DEBUG
  70 #define DB(x) x
  71 #else
  72 #define DB(x)
  73 #endif
  74
  75
  76 /*******************************************************************************
  77 * mvSpiReadAndWrite - Read and Write a buffer simultanuousely
  78 *
  79 * DESCRIPTION:
  80 *       Transmit and receive a buffer over the SPI in 16bit chunks. If the
  81 *               buffer size is odd, then the last chunk will be 8bits.
  82 *
  83 * INPUT:
  84 *       pRxBuff: Pointer to the buffer to write the RX info in
  85 *               pTxBuff: Pointer to the buffer holding the TX info
  86 *               buffSize: length of both the pTxBuff and pRxBuff
  87 *
  88 * OUTPUT:
  89 *       pRxBuff: Pointer of the buffer holding the RX data
  90 *
  91 * RETURN:
  92 *       Success or Error code.
  93 *
  94 *
  95 *******************************************************************************/
  96 MV_STATUS mvSpiReadAndWrite(MV_U8* pRxBuff, MV_U8* pTxBuff, MV_U32 buffSize)
  97 {
  98     MV_STATUS ret;
  99
 100     /* check for null parameters */
 101     if ((pRxBuff == NULL) || (pTxBuff == NULL) || (buffSize == 0))
 102     {
 103         mvOsPrintf("%s ERROR: Null pointer parameter!\n", __FUNCTION__);
 104         return MV_BAD_PARAM;
 105     }
 106
 107         /* First assert the chip select */
 108         mvSpiCsAssert();
 109
 110     ret = mvSpiReadWrite(pRxBuff, pTxBuff, buffSize);
 111
 112         /* Finally deassert the chip select */
 113         mvSpiCsDeassert();
 114
 115         return ret;
 116 }
 117
 118 /*******************************************************************************
 119 * mvSpiWriteThenWrite - Serialize a command followed by the data over the TX line
 120 *
 121 * DESCRIPTION:
 122 *       Assert the chip select line. Transmit the command buffer followed by
 123 *       the data buffer. Then deassert the CS line.
 124 *
 125 * INPUT:
 126 *       pCmndBuff: Pointer to the command buffer to transmit
 127 *       cmndSize: length of the command size
 128 *               pTxDataBuff: Pointer to the data buffer to transmit
 129 *               txDataSize: length of the data buffer
 130 *
 131 * OUTPUT:
 132 *       None.
 133 *
 134 * RETURN:
 135 *       Success or Error code.
 136 *
 137 *
 138 *******************************************************************************/
 139 MV_STATUS       mvSpiWriteThenWrite (MV_U8* pCmndBuff, MV_U32 cmndSize, MV_U8* pTxDataBuff,
 140                                  MV_U32 txDataSize)
 141 {
 142     MV_STATUS ret = MV_OK, tempRet;
 143
 144     /* check for null parameters */
 145 #ifndef CONFIG_MARVELL
 146     if(NULL == pTxDataBuff)
 147     {
 148         mvOsPrintf("%s ERROR: Null pointer parameter!\n", __FUNCTION__);
 149         return MV_BAD_PARAM;
 150     }
 151 #endif
 152
 153     if (pCmndBuff == NULL)
 154     {
 155         mvOsPrintf("%s ERROR: Null pointer parameter!\n", __FUNCTION__);
 156         return MV_BAD_PARAM;
 157     }
 158
 159         /* First assert the chip select */
 160         mvSpiCsAssert();
 161
 162     /* first write the command */
 163     if ((cmndSize) && (pCmndBuff != NULL))
 164     {
 165         if ((tempRet = mvSpiWrite(pCmndBuff, cmndSize)) != MV_OK)
 166             ret = tempRet;
 167     }
 168
 169     /* Then write the data buffer */
 170 #ifndef CONFIG_MARVELL
 171     if (txDataSize)
 172 #else
 173     if ((txDataSize) && (pTxDataBuff != NULL))
 174 #endif
 175     {
 176         if ((tempRet = mvSpiWrite(pTxDataBuff, txDataSize)) != MV_OK)
 177             ret = tempRet;
 178     }
 179
 180         /* Finally deassert the chip select */
 181         mvSpiCsDeassert();
 182
 183         return ret;
 184 }
 185
 186 /*******************************************************************************
 187 * mvSpiWriteThenRead - Serialize a command then read a data buffer
 188 *
 189 * DESCRIPTION:
 190 *       Assert the chip select line. Transmit the command buffer then read
 191 *       the data buffer. Then deassert the CS line.
 192 *
 193 * INPUT:
 194 *       pCmndBuff: Pointer to the command buffer to transmit
 195 *       cmndSize: length of the command size
 196 *               pRxDataBuff: Pointer to the buffer to read the data in
 197 *               txDataSize: length of the data buffer
 198 *
 199 * OUTPUT:
 200 *               pRxDataBuff: Pointer to the buffer holding the data
 201 *
 202 * RETURN:
 203 *       Success or Error code.
 204 *
 205 *
 206 *******************************************************************************/
 207 MV_STATUS mvSpiWriteThenRead (MV_U8* pCmndBuff, MV_U32 cmndSize, MV_U8* pRxDataBuff,
 208                               MV_U32 rxDataSize,MV_U32 dummyBytesToRead)
 209 {
 210     MV_STATUS ret = MV_OK, tempRet;
 211     MV_U8   dummyByte;
 212
 213     /* check for null parameters */
 214     if ((pCmndBuff == NULL) && (pRxDataBuff == NULL))
 215     {
 216         mvOsPrintf("%s ERROR: Null pointer parameter!\n", __FUNCTION__);
 217         return MV_BAD_PARAM;
 218     }
 219
 220         /* First assert the chip select */
 221         mvSpiCsAssert();
 222
 223     /* first write the command */
 224     if ((cmndSize) && (pCmndBuff != NULL))
 225     {
 226         if ((tempRet = mvSpiWrite(pCmndBuff, cmndSize)) != MV_OK)
 227             ret = tempRet;
 228     }
 229
 230     /* Read dummy bytes before real data.   */
 231     while(dummyBytesToRead)
 232     {
 233         mvSpiRead(&dummyByte,1);
 234         dummyBytesToRead--;
 235     }
 236
 237     /* Then write the data buffer */
 238     if ((rxDataSize) && (pRxDataBuff != NULL))
 239     {
 240         if ((tempRet = mvSpiRead(pRxDataBuff, rxDataSize)) != MV_OK)
 241             ret = tempRet;
 242     }
 243
 244         /* Finally deassert the chip select */
 245         mvSpiCsDeassert();
 246
 247         return ret;
 248 }
 249