]> git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/MicroBlaze_Kintex7_EthernetLite/BSP/microblaze_0/libsrc/emaclite_v4_0/src/xemaclite_sinit.c
4c3df772e561f7d505e5602b4fbf1901145e3c90
[freertos] / FreeRTOS / Demo / MicroBlaze_Kintex7_EthernetLite / BSP / microblaze_0 / libsrc / emaclite_v4_0 / src / xemaclite_sinit.c
1 /******************************************************************************
2 *
3 * Copyright (C) 2007 - 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 xemaclite_sinit.c
36 *
37 * This file contains the implementation of the XEmacLite driver's static
38 * initialization functionality.
39 *
40 * @note         None.
41 *
42 * <pre>
43 *
44 * MODIFICATION HISTORY:
45 *
46 * Ver   Who  Date     Changes
47 * ----- ---- -------- -----------------------------------------------
48 * 1.12a sv   11/28/07 First release
49 *
50 * </pre>
51 *
52 ******************************************************************************/
53
54 /***************************** Include Files *********************************/
55
56 #include "xparameters.h"
57 #include "xemaclite.h"
58
59 /************************** Constant Definitions *****************************/
60
61 /**************************** Type Definitions *******************************/
62
63 /***************** Macros (Inline Functions) Definitions *********************/
64
65 /************************** Function Prototypes ******************************/
66
67 /************************** Variable Definitions *****************************/
68 extern XEmacLite_Config XEmacLite_ConfigTable[];
69
70 /*****************************************************************************/
71 /**
72 *
73 * Lookup the device configuration based on the unique device ID.  The table
74 * XEmacLite_ConfigTable contains the configuration info for each device in the
75 * system.
76 *
77 * @param        DeviceId is the unique device ID of the device being looked up.
78 *
79 * @return       A pointer to the configuration table entry corresponding to the
80 *               given device ID, or NULL if no match is found.
81 *
82 * @note         None.
83 *
84 ******************************************************************************/
85 XEmacLite_Config *XEmacLite_LookupConfig(u16 DeviceId)
86 {
87         XEmacLite_Config *CfgPtr = NULL;
88         u32 Index;
89
90         for (Index = 0; Index < XPAR_XEMACLITE_NUM_INSTANCES; Index++) {
91                 if (XEmacLite_ConfigTable[Index].DeviceId == DeviceId) {
92                         CfgPtr = &XEmacLite_ConfigTable[Index];
93                         break;
94                 }
95         }
96
97         return CfgPtr;
98 }
99
100
101 /*****************************************************************************/
102 /**
103 *
104 * Initialize a specific XEmacLite instance/driver.  The initialization entails:
105 * - Initialize fields of the XEmacLite instance structure.
106 *
107 * The driver defaults to polled mode operation.
108 *
109 * @param        InstancePtr is a pointer to the XEmacLite instance.
110 * @param        DeviceId is the unique id of the device controlled by this
111 *               XEmacLite instance.  Passing in a device id associates the
112 *               generic XEmacLite instance to a specific device, as chosen by
113 *               the caller or application developer.
114 *
115 * @return
116 *               - XST_SUCCESS if initialization was successful.
117 *               - XST_DEVICE_NOT_FOUND/XST_FAILURE if device configuration
118 *               information was not found for a device with the supplied
119 *               device ID.
120 *
121 * @note         None
122 *
123 ******************************************************************************/
124 int XEmacLite_Initialize(XEmacLite *InstancePtr, u16 DeviceId)
125 {
126         int Status;
127         XEmacLite_Config *EmacLiteConfigPtr;/* Pointer to Configuration data. */
128
129         /*
130          * Verify that each of the inputs are valid.
131          */
132         Xil_AssertNonvoid(InstancePtr != NULL);
133
134         /*
135          * Lookup the device configuration in the configuration table. Use this
136          * configuration info down below when initializing this driver.
137          */
138         EmacLiteConfigPtr = XEmacLite_LookupConfig(DeviceId);
139         if (EmacLiteConfigPtr == NULL) {
140                 return XST_DEVICE_NOT_FOUND;
141         }
142
143         Status = XEmacLite_CfgInitialize(InstancePtr,
144                                          EmacLiteConfigPtr,
145                                          EmacLiteConfigPtr->BaseAddress);
146         if (Status != XST_SUCCESS) {
147                 return XST_FAILURE;
148         }
149
150         return XST_SUCCESS;
151 }
152
153