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

   1 /******************************************************************************
   2 *
   3 * Copyright (C) 2010 - 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 *
  35 * @file xil_types.h
  36 *
  37 * @addtogroup common_types Basic Data types for Xilinx&reg; Software IP
  38 *
  39 * The xil_types.h file contains basic types for Xilinx software IP. These data types
  40 * are applicable for all processors supported by Xilinx.
  41 * @{
  42 * <pre>
  43 * MODIFICATION HISTORY:
  44 *
  45 * Ver   Who    Date   Changes
  46 * ----- ---- -------- -------------------------------------------------------
  47 * 1.00a hbm  07/14/09 First release
  48 * 3.03a sdm  05/30/11 Added Xuint64 typedef and XUINT64_MSW/XUINT64_LSW macros
  49 * 5.00  pkp  05/29/14 Made changes for 64 bit architecture
  50 *       srt  07/14/14 Use standard definitions from stdint.h and stddef.h
  51 *                     Define LONG and ULONG datatypes and mask values
  52 * </pre>
  53 *
  54 ******************************************************************************/
  55
  56 #ifndef XIL_TYPES_H     /* prevent circular inclusions */
  57 #define XIL_TYPES_H     /* by using protection macros */
  58
  59 #include <stdint.h>
  60 #include <stddef.h>
  61
  62 /************************** Constant Definitions *****************************/
  63
  64 #ifndef TRUE
  65 #  define TRUE          1U
  66 #endif
  67
  68 #ifndef FALSE
  69 #  define FALSE         0U
  70 #endif
  71
  72 #ifndef NULL
  73 #define NULL            0U
  74 #endif
  75
  76 #define XIL_COMPONENT_IS_READY     0x11111111U  /**< In device drivers, This macro will be
  77                                                  assigend to "IsReady" member of driver
  78                                                                                                  instance to indicate that driver
  79                                                                                                  instance is initialized and ready to use. */
  80 #define XIL_COMPONENT_IS_STARTED   0x22222222U  /**< In device drivers, This macro will be assigend to
  81                                                  "IsStarted" member of driver instance
  82                                                                                                  to indicate that driver instance is
  83                                                                                                  started and it can be enabled. */
  84
  85 /* @name New types
  86  * New simple types.
  87  * @{
  88  */
  89 #ifndef __KERNEL__
  90 #ifndef XBASIC_TYPES_H
  91 /*
  92  * guarded against xbasic_types.h.
  93  */
  94 typedef uint8_t u8;
  95 typedef uint16_t u16;
  96 typedef uint32_t u32;
  97 /** @}*/
  98 #define __XUINT64__
  99 typedef struct
 100 {
 101         u32 Upper;
 102         u32 Lower;
 103 } Xuint64;
 104
 105
 106 /*****************************************************************************/
 107 /**
 108 * @brief    Return the most significant half of the 64 bit data type.
 109 *
 110 * @param    x is the 64 bit word.
 111 *
 112 * @return   The upper 32 bits of the 64 bit word.
 113 *
 114 ******************************************************************************/
 115 #define XUINT64_MSW(x) ((x).Upper)
 116
 117 /*****************************************************************************/
 118 /**
 119 * @brief    Return the least significant half of the 64 bit data type.
 120 *
 121 * @param    x is the 64 bit word.
 122 *
 123 * @return   The lower 32 bits of the 64 bit word.
 124 *
 125 ******************************************************************************/
 126 #define XUINT64_LSW(x) ((x).Lower)
 127
 128 #endif /* XBASIC_TYPES_H */
 129
 130 /*
 131  * xbasic_types.h does not typedef s* or u64
 132  */
 133 /** @{ */
 134 typedef char char8;
 135 typedef int8_t s8;
 136 typedef int16_t s16;
 137 typedef int32_t s32;
 138 typedef int64_t s64;
 139 typedef uint64_t u64;
 140 typedef int sint32;
 141
 142 typedef intptr_t INTPTR;
 143 typedef uintptr_t UINTPTR;
 144 typedef ptrdiff_t PTRDIFF;
 145 /** @}*/
 146 #if !defined(LONG) || !defined(ULONG)
 147 typedef long LONG;
 148 typedef unsigned long ULONG;
 149 #endif
 150
 151 #define ULONG64_HI_MASK 0xFFFFFFFF00000000U
 152 #define ULONG64_LO_MASK ~ULONG64_HI_MASK
 153
 154 #else
 155 #include <linux/types.h>
 156 #endif
 157
 158 /** @{ */
 159 /**
 160  * This data type defines an interrupt handler for a device.
 161  * The argument points to the instance of the component
 162  */
 163 typedef void (*XInterruptHandler) (void *InstancePtr);
 164
 165 /**
 166  * This data type defines an exception handler for a processor.
 167  * The argument points to the instance of the component
 168  */
 169 typedef void (*XExceptionHandler) (void *InstancePtr);
 170
 171 /**
 172  * @brief  Returns 32-63 bits of a number.
 173  * @param  n : Number being accessed.
 174  * @return Bits 32-63 of number.
 175  *
 176  * @note    A basic shift-right of a 64- or 32-bit quantity.
 177  *          Use this to suppress the "right shift count >= width of type"
 178  *          warning when that quantity is 32-bits.
 179  */
 180 #define UPPER_32_BITS(n) ((u32)(((n) >> 16) >> 16))
 181
 182 /**
 183  * @brief  Returns 0-31 bits of a number
 184  * @param  n : Number being accessed.
 185  * @return Bits 0-31 of number
 186  */
 187 #define LOWER_32_BITS(n) ((u32)(n))
 188
 189
 190
 191
 192 /************************** Constant Definitions *****************************/
 193
 194 #ifndef TRUE
 195 #define TRUE            1U
 196 #endif
 197
 198 #ifndef FALSE
 199 #define FALSE           0U
 200 #endif
 201
 202 #ifndef NULL
 203 #define NULL            0U
 204 #endif
 205
 206 #endif  /* end of protection macro */
 207 /**
 208 * @} End of "addtogroup common_types".
 209 */