git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_A9_Zynq_ZC702/RTOSDemo_bsp/ps7_cortexa9_0/libsrc/gpiops_v2_1/src/xgpiops_hw.h

   1 /******************************************************************************
   2 *
   3 * Copyright (C) 2010 - 2014 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 xgpiops_hw.h
  36 * @addtogroup gpiops_v2_1
  37 * @{
  38 *
  39 * This header file contains the identifiers and basic driver functions (or
  40 * macros) that can be used to access the device. Other driver functions
  41 * are defined in xgpiops.h.
  42 *
  43 * <pre>
  44 * MODIFICATION HISTORY:
  45 *
  46 * Ver   Who  Date     Changes
  47 * ----- ---- -------- -------------------------------------------------
  48 * 1.00a sv   01/15/10 First Release
  49 * 1.02a hk   08/22/13 Added low level reset API function prototype and
  50 *                     related constant definitions
  51 * </pre>
  52 *
  53 ******************************************************************************/
  54 #ifndef XGPIOPS_HW_H            /* prevent circular inclusions */
  55 #define XGPIOPS_HW_H            /* by using protection macros */
  56
  57 #ifdef __cplusplus
  58 extern "C" {
  59 #endif /* __cplusplus */
  60
  61 /***************************** Include Files *********************************/
  62
  63 #include "xil_types.h"
  64 #include "xil_assert.h"
  65 #include "xil_io.h"
  66
  67 /************************** Constant Definitions *****************************/
  68
  69 /** @name Register offsets for the GPIO. Each register is 32 bits.
  70  *  @{
  71  */
  72 #define XGPIOPS_DATA_LSW_OFFSET  0x000  /* Mask and Data Register LSW, WO */
  73 #define XGPIOPS_DATA_MSW_OFFSET  0x004  /* Mask and Data Register MSW, WO */
  74 #define XGPIOPS_DATA_OFFSET      0x040  /* Data Register, RW */
  75 #define XGPIOPS_DATA_RO_OFFSET   0x060  /* Data Register - Input, RO */
  76 #define XGPIOPS_DIRM_OFFSET      0x204  /* Direction Mode Register, RW */
  77 #define XGPIOPS_OUTEN_OFFSET     0x208  /* Output Enable Register, RW */
  78 #define XGPIOPS_INTMASK_OFFSET   0x20C  /* Interrupt Mask Register, RO */
  79 #define XGPIOPS_INTEN_OFFSET     0x210  /* Interrupt Enable Register, WO */
  80 #define XGPIOPS_INTDIS_OFFSET    0x214  /* Interrupt Disable Register, WO*/
  81 #define XGPIOPS_INTSTS_OFFSET    0x218  /* Interrupt Status Register, RO */
  82 #define XGPIOPS_INTTYPE_OFFSET   0x21C  /* Interrupt Type Register, RW */
  83 #define XGPIOPS_INTPOL_OFFSET    0x220  /* Interrupt Polarity Register, RW */
  84 #define XGPIOPS_INTANY_OFFSET    0x224  /* Interrupt On Any Register, RW */
  85 /* @} */
  86
  87 /** @name Register offsets for each Bank.
  88  *  @{
  89  */
  90 #define XGPIOPS_DATA_MASK_OFFSET 0x8  /* Data/Mask Registers offset */
  91 #define XGPIOPS_DATA_BANK_OFFSET 0x4  /* Data Registers offset */
  92 #define XGPIOPS_REG_MASK_OFFSET 0x40  /* Registers offset */
  93 /* @} */
  94
  95 /* For backwards compatibility */
  96 #define XGPIOPS_BYPM_MASK_OFFSET        XGPIOPS_REG_MASK_OFFSET
  97
  98 /** @name Interrupt type reset values for each bank
  99  *  @{
 100  */
 101 #define XGPIOPS_INTTYPE_BANK0_RESET  0xFFFFFFFF
 102 #define XGPIOPS_INTTYPE_BANK1_RESET  0x3FFFFFFF
 103 #define XGPIOPS_INTTYPE_BANK2_RESET  0xFFFFFFFF
 104 #define XGPIOPS_INTTYPE_BANK3_RESET  0xFFFFFFFF
 105 /* @} */
 106
 107 /**************************** Type Definitions *******************************/
 108
 109 /***************** Macros (Inline Functions) Definitions *********************/
 110
 111 /****************************************************************************/
 112 /**
 113 *
 114 * This macro reads the given register.
 115 *
 116 * @param        BaseAddr is the base address of the device.
 117 * @param        RegOffset is the register offset to be read.
 118 *
 119 * @return       The 32-bit value of the register
 120 *
 121 * @note         None.
 122 *
 123 *****************************************************************************/
 124 #define XGpioPs_ReadReg(BaseAddr, RegOffset)            \
 125                 Xil_In32((BaseAddr) + (RegOffset))
 126
 127 /****************************************************************************/
 128 /**
 129 *
 130 * This macro writes to the given register.
 131 *
 132 * @param        BaseAddr is the base address of the device.
 133 * @param        RegOffset is the offset of the register to be written.
 134 * @param        Data is the 32-bit value to write to the register.
 135 *
 136 * @return       None.
 137 *
 138 * @note         None.
 139 *
 140 *****************************************************************************/
 141 #define XGpioPs_WriteReg(BaseAddr, RegOffset, Data)     \
 142                 Xil_Out32((BaseAddr) + (RegOffset), (Data))
 143
 144 /************************** Function Prototypes ******************************/
 145
 146 void XGpioPs_ResetHw(u32 BaseAddress);
 147
 148 #ifdef __cplusplus
 149 }
 150 #endif /* __cplusplus */
 151
 152 #endif /* XGPIOPS_HW_H */
 153 /** @} */