git.sur5r.net Git - freertos/blob

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