git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/MicroBlaze_Kintex7_EthernetLite/BSP/microblaze_0/libsrc/gpio_v4_1/src/xgpio_extra.c

   1 /******************************************************************************
   2 *
   3 * Copyright (C) 2002 - 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 * @file xgpio_extra.c
  35 * @addtogroup gpio_v4_1
  36 * @{
  37 *
  38 * The implementation of the XGpio driver's advanced discrete functions.
  39 * See xgpio.h for more information about the driver.
  40 *
  41 * @note
  42 *
  43 * These APIs can only be used if the GPIO_IO ports in the IP are used for
  44 * connecting to the external output ports.
  45 *
  46 *
  47 * <pre>
  48 * MODIFICATION HISTORY:
  49 *
  50 * Ver   Who  Date     Changes
  51 * ----- ---- -------- -----------------------------------------------
  52 * 1.00a rmm  02/04/02 First release
  53 * 2.00a jhl  12/16/02 Update for dual channel and interrupt support
  54 * 2.11a mta  03/21/07 Updated to new coding style
  55 * 3.00a sv   11/21/09 Updated to use HAL Processor APIs. Renamed the macros
  56 *                     XGpio_mWriteReg to XGpio_WriteReg, and XGpio_mReadReg
  57 *                     to XGpio_ReadReg.
  58 * </pre>
  59 *
  60 *****************************************************************************/
  61
  62 /***************************** Include Files ********************************/
  63
  64 #include "xgpio.h"
  65 #include "xgpio_i.h"
  66
  67 /************************** Constant Definitions ****************************/
  68
  69 /**************************** Type Definitions ******************************/
  70
  71 /***************** Macros (Inline Functions) Definitions ********************/
  72
  73 /************************** Variable Definitions ****************************/
  74
  75 /************************** Function Prototypes *****************************/
  76
  77
  78 /****************************************************************************/
  79 /**
  80 * Set output discrete(s) to logic 1 for the specified GPIO channel.
  81 *
  82 * @param        InstancePtr is a pointer to an XGpio instance to be worked on.
  83 * @param        Channel contains the channel of the GPIO (1 or 2) to operate on.
  84 * @param        Mask is the set of bits that will be set to 1 in the discrete
  85 *               data register. All other bits in the data register are
  86 *               unaffected.
  87 *
  88 * @return       None.
  89 *
  90 * @note
  91 *
  92 * The hardware must be built for dual channels if this function is used
  93 * with any channel other than 1.  If it is not, this function will assert.
  94 *
  95 * This API can only be used if the GPIO_IO ports in the IP are used for
  96 * connecting to the external output ports.
  97 *
  98 *****************************************************************************/
  99 void XGpio_DiscreteSet(XGpio * InstancePtr, unsigned Channel, u32 Mask)
 100 {
 101         u32 Current;
 102         unsigned DataOffset;
 103
 104         Xil_AssertVoid(InstancePtr != NULL);
 105         Xil_AssertVoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
 106         Xil_AssertVoid((Channel == 1) ||
 107                      ((Channel == 2) && (InstancePtr->IsDual == TRUE)));
 108
 109         /* Calculate the offset to the data register of the GPIO  */
 110         DataOffset = ((Channel - 1) * XGPIO_CHAN_OFFSET) + XGPIO_DATA_OFFSET;
 111
 112         /*
 113          * Read the contents of the data register, merge in Mask and write
 114          * back results
 115          */
 116         Current = XGpio_ReadReg(InstancePtr->BaseAddress, DataOffset);
 117         Current |= Mask;
 118         XGpio_WriteReg(InstancePtr->BaseAddress, DataOffset, Current);
 119 }
 120
 121
 122 /****************************************************************************/
 123 /**
 124 * Set output discrete(s) to logic 0 for the specified GPIO channel.
 125 *
 126 * @param        InstancePtr is a pointer to an XGpio instance to be worked on.
 127 * @param        Channel contains the channel of the GPIO (1 or 2) to operate on.
 128 * @param        Mask is the set of bits that will be set to 0 in the discrete
 129 *               data register. All other bits in the data register are
 130 *               unaffected.
 131 *
 132 * @return       None.
 133 *
 134 * @note
 135 *
 136 * The hardware must be built for dual channels if this function is used
 137 * with any channel other than 1.  If it is not, this function will assert.
 138 *
 139 * This API can only be used if the GPIO_IO ports in the IP are used for
 140 * connecting to the external output ports.
 141 *
 142 *****************************************************************************/
 143 void XGpio_DiscreteClear(XGpio * InstancePtr, unsigned Channel, u32 Mask)
 144 {
 145         u32 Current;
 146         unsigned DataOffset;
 147
 148         Xil_AssertVoid(InstancePtr != NULL);
 149         Xil_AssertVoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
 150         Xil_AssertVoid((Channel == 1) ||
 151                      ((Channel == 2) && (InstancePtr->IsDual == TRUE)));
 152
 153         /* Calculate the offset to the data register of the GPIO  */
 154         DataOffset = ((Channel - 1) * XGPIO_CHAN_OFFSET) + XGPIO_DATA_OFFSET;
 155
 156         /*
 157          * Read the contents of the data register, merge in Mask and write
 158          * back results
 159          */
 160         Current = XGpio_ReadReg(InstancePtr->BaseAddress, DataOffset);
 161         Current &= ~Mask;
 162         XGpio_WriteReg(InstancePtr->BaseAddress, DataOffset, Current);
 163 }
 164 /** @} */