git.sur5r.net Git - freertos/blob

   1 /******************************************************************************
   2 *
   3 * Copyright (C) 2013 - 2015 Xilinx, Inc.  All rights reserved.
   4 *
   5 * Permission is hereby granted, free of charge, to any person obtaining a copy
   6 * of this software and associated documentation files (the "Software"), to deal
   7 * in the Software without restriction, including without limitation the rights
   8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 * copies of the Software, and to permit persons to whom the Software is
  10 * furnished to do so, subject to the following conditions:
  11 *
  12 * The above copyright notice and this permission notice shall be included in
  13 * all copies or substantial portions of the Software.
  14 *
  15 * Use of the Software is limited solely to applications:
  16 * (a) running on a Xilinx device, or
  17 * (b) that interact with a Xilinx device through a bus or interconnect.
  18 *
  19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  22 * XILINX  BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  23 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
  24 * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25 * SOFTWARE.
  26 *
  27 * Except as contained in this notice, the name of the Xilinx shall not be used
  28 * in advertising or otherwise to promote the sale, use or other dealings in
  29 * this Software without prior written authorization from Xilinx.
  30 *
  31 ******************************************************************************/
  32 /*****************************************************************************/
  33 /**
  34 *
  35 * @file xiicps_hw.c
  36 * @addtogroup iicps_v3_0
  37 * @{
  38 *
  39 * Contains implementation of required functions for providing the reset sequence
  40 * to the i2c interface
  41 *
  42 * <pre> MODIFICATION HISTORY:
  43 *
  44 * Ver   Who     Date     Changes
  45 * ----- ------  -------- --------------------------------------------
  46 * 1.04a kpc     11/07/13 First release
  47 * 3.0   sk              11/03/14 Modified TimeOut Register value to 0xFF
  48 *                               01/31/15 Modified the code according to MISRAC 2012 Compliant.
  49 *
  50 * </pre>
  51 *
  52 ******************************************************************************/
  53
  54 /***************************** Include Files *********************************/
  55
  56 #include "xiicps_hw.h"
  57
  58 /************************** Constant Definitions *****************************/
  59
  60 /**************************** Type Definitions *******************************/
  61
  62 /***************** Macros (Inline Functions) Definitions *********************/
  63
  64 /************************** Function Prototypes ******************************/
  65
  66 /************************** Variable Definitions *****************************/
  67 /*****************************************************************************/
  68 /**
  69 * This function perform the reset sequence to the given I2c interface by
  70 * configuring the appropriate control bits in the I2c specifc registers
  71 * the i2cps reset squence involves the following steps
  72 *       Disable all the interuupts
  73 *       Clear the status
  74 *       Clear FIFO's and disable hold bit
  75 *       Clear the line status
  76 *       Update relevant config registers with reset values
  77 *
  78 * @param   BaseAddress of the interface
  79 *
  80 * @return N/A
  81 *
  82 * @note
  83 * This function will not modify the slcr registers that are relavant for
  84 * I2c controller
  85 ******************************************************************************/
  86 void XIicPs_ResetHw(u32 BaseAddress)
  87 {
  88         u32 RegVal;
  89
  90         /* Disable all the interrupts */
  91         XIicPs_WriteReg(BaseAddress, XIICPS_IDR_OFFSET, XIICPS_IXR_ALL_INTR_MASK);
  92         /* Clear the interrupt status */
  93         RegVal = XIicPs_ReadReg(BaseAddress,XIICPS_ISR_OFFSET);
  94         XIicPs_WriteReg(BaseAddress, XIICPS_ISR_OFFSET, RegVal);
  95         /* Clear the hold bit,master enable bit and ack bit */
  96         RegVal = XIicPs_ReadReg(BaseAddress,XIICPS_CR_OFFSET);
  97         RegVal &= ~(XIICPS_CR_HOLD_MASK|XIICPS_CR_MS_MASK|XIICPS_CR_ACKEN_MASK);
  98         /* Clear the fifos */
  99         RegVal |= XIICPS_CR_CLR_FIFO_MASK;
 100         XIicPs_WriteReg(BaseAddress, XIICPS_CR_OFFSET, RegVal);
 101         /* Clear the timeout register */
 102         XIicPs_WriteReg(BaseAddress, XIICPS_TIME_OUT_OFFSET, XIICPS_TO_RESET_VALUE);
 103         /* Clear the transfer size register */
 104         XIicPs_WriteReg(BaseAddress, XIICPS_TRANS_SIZE_OFFSET, 0x0U);
 105         /* Clear the status register */
 106         RegVal = XIicPs_ReadReg(BaseAddress,XIICPS_SR_OFFSET);
 107         XIicPs_WriteReg(BaseAddress, XIICPS_SR_OFFSET, RegVal);
 108         /* Update the configuraqtion register with reset value */
 109         XIicPs_WriteReg(BaseAddress, XIICPS_CR_OFFSET, 0x0U);
 110 }
 111 /** @} */