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