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

   1 /******************************************************************************
   2 *
   3 * Copyright (C) 2003 - 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 * @file xgpio_sinit.c
  35 * @addtogroup gpio_v4_1
  36 * @{
  37 *
  38 * The implementation of the XGpio driver's static initialzation
  39 * functionality.
  40 *
  41 * @note
  42 *
  43 * None
  44 *
  45 * <pre>
  46 * MODIFICATION HISTORY:
  47 *
  48 * Ver   Who  Date     Changes
  49 * ----- ---- -------- -----------------------------------------------
  50 * 2.01a jvb  10/13/05 First release
  51 * 2.11a mta  03/21/07 Updated to new coding style
  52 * 4.0   sha  07/15/15 Defined macro XPAR_XGPIO_NUM_INSTANCES if not
  53 *                     defined in xparameters.h
  54 * </pre>
  55 *
  56 *****************************************************************************/
  57
  58 /***************************** Include Files ********************************/
  59
  60 #include "xstatus.h"
  61 #include "xparameters.h"
  62 #include "xgpio_i.h"
  63
  64 /************************** Constant Definitions ****************************/
  65
  66 #ifndef XPAR_XGPIO_NUM_INSTANCES
  67 #define XPAR_XGPIO_NUM_INSTANCES                0
  68 #endif
  69
  70 /**************************** Type Definitions ******************************/
  71
  72 /***************** Macros (Inline Functions) Definitions ********************/
  73
  74 /************************** Variable Definitions ****************************/
  75
  76
  77 /************************** Function Prototypes *****************************/
  78
  79
  80 /******************************************************************************/
  81 /**
  82 * Lookup the device configuration based on the unique device ID.  The table
  83 * ConfigTable contains the configuration info for each device in the system.
  84 *
  85 * @param        DeviceId is the device identifier to lookup.
  86 *
  87 * @return
  88 *                - A pointer of data type XGpio_Config which points to the
  89 *               device configuration if DeviceID is found.
  90 *               - NULL if DeviceID is not found.
  91 *
  92 * @note         None.
  93 *
  94 ******************************************************************************/
  95 XGpio_Config *XGpio_LookupConfig(u16 DeviceId)
  96 {
  97         XGpio_Config *CfgPtr = NULL;
  98
  99         int Index;
 100
 101         for (Index = 0; Index < XPAR_XGPIO_NUM_INSTANCES; Index++) {
 102                 if (XGpio_ConfigTable[Index].DeviceId == DeviceId) {
 103                         CfgPtr = &XGpio_ConfigTable[Index];
 104                         break;
 105                 }
 106         }
 107
 108         return CfgPtr;
 109 }
 110
 111
 112 /****************************************************************************/
 113 /**
 114 * Initialize the XGpio instance provided by the caller based on the
 115 * given DeviceID.
 116 *
 117 * Nothing is done except to initialize the InstancePtr.
 118 *
 119 * @param        InstancePtr is a pointer to an XGpio instance. The memory the
 120 *               pointer references must be pre-allocated by the caller. Further
 121 *               calls to manipulate the instance/driver through the XGpio API
 122 *               must be made with this pointer.
 123 * @param        DeviceId is the unique id of the device controlled by this XGpio
 124 *               instance. Passing in a device id associates the generic XGpio
 125 *               instance to a specific device, as chosen by the caller or
 126 *               application developer.
 127 *
 128 * @return
 129 *               - XST_SUCCESS if the initialization was successfull.
 130 *               - XST_DEVICE_NOT_FOUND  if the device configuration data was not
 131 *               found for a device with the supplied device ID.
 132 *
 133 * @note         None.
 134 *
 135 *****************************************************************************/
 136 int XGpio_Initialize(XGpio * InstancePtr, u16 DeviceId)
 137 {
 138         XGpio_Config *ConfigPtr;
 139
 140         /*
 141          * Assert arguments
 142          */
 143         Xil_AssertNonvoid(InstancePtr != NULL);
 144
 145         /*
 146          * Lookup configuration data in the device configuration table.
 147          * Use this configuration info down below when initializing this
 148          * driver.
 149          */
 150         ConfigPtr = XGpio_LookupConfig(DeviceId);
 151         if (ConfigPtr == (XGpio_Config *) NULL) {
 152                 InstancePtr->IsReady = 0;
 153                 return (XST_DEVICE_NOT_FOUND);
 154         }
 155
 156         return XGpio_CfgInitialize(InstancePtr, ConfigPtr,
 157                                    ConfigPtr->BaseAddress);
 158 }
 159 /** @} */