git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/IA32_flat_GCC_Galileo_Gen_2/Support_Files/galileo_gen_defs.h

   1 /*--------------------------------------------------------------------\r
   2  Copyright(c) 2015 Intel Corporation. All rights reserved.\r
   3 \r
   4  Redistribution and use in source and binary forms, with or without\r
   5  modification, are permitted provided that the following conditions\r
   6  are met:\r
   7 \r
   8  * Redistributions of source code must retain the above copyright\r
   9  notice, this list of conditions and the following disclaimer.\r
  10  * Redistributions in binary form must reproduce the above copyright\r
  11  notice, this list of conditions and the following disclaimer in\r
  12  the documentation and/or other materials provided with the\r
  13  distribution.\r
  14  * Neither the name of Intel Corporation nor the names of its\r
  15  contributors may be used to endorse or promote products derived\r
  16  from this software without specific prior written permission.\r
  17 \r
  18  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\r
  19  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\r
  20  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\r
  21  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\r
  22  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\r
  23  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\r
  24  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\r
  25  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\r
  26  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
  27  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\r
  28  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  29  --------------------------------------------------------------------*/\r
  30 \r
  31 #ifndef __GALILEO_GEN_DEFS_H__\r
  32 #define __GALILEO_GEN_DEFS_H__\r
  33 \r
  34 #ifdef __cplusplus\r
  35         extern "C" {\r
  36 #endif\r
  37 \r
  38 /*-----------------------------------------------------------------------\r
  39  * Any required includes\r
  40  *------------------------------------------------------------------------\r
  41  */\r
  42 #include <stdarg.h>\r
  43 #include "stdint.h"\r
  44 \r
  45 //---------------------------------------------------------------------\r
  46 // Printf prototype\r
  47 //---------------------------------------------------------------------\r
  48 extern int printf( const char *format, ... );\r
  49 extern int print( char **out, const char *format, va_list args );\r
  50 extern int sprintf(char *out, const char *format, ...);\r
  51 \r
  52 //---------------------------------------------------------------------\r
  53 // Prototypes (assembly language functions in startup.S)\r
  54 //---------------------------------------------------------------------\r
  55 extern void halt( void );\r
  56 extern int32_t inb( int32_t );\r
  57 extern int32_t inw( int32_t );\r
  58 extern int32_t inl( int32_t );\r
  59 extern int32_t outb( int32_t, int32_t );\r
  60 extern int32_t outw( int32_t, int32_t );\r
  61 extern int32_t outl( int32_t, int32_t) ;\r
  62 \r
  63 //---------------------------------------------------------------------\r
  64 // GP definitions\r
  65 //---------------------------------------------------------------------\r
  66 #ifndef TRUE\r
  67         #define TRUE ( 1 )\r
  68 #endif\r
  69 \r
  70 #ifndef FALSE\r
  71         #define FALSE ( 0 )\r
  72 #endif\r
  73 \r
  74 #ifndef true\r
  75         #define true  TRUE\r
  76 #endif\r
  77 \r
  78 #ifndef false\r
  79         #define false FALSE\r
  80 #endif\r
  81 \r
  82 #ifndef OK\r
  83         #define OK TRUE\r
  84 #endif\r
  85 \r
  86 //---------------------------------------------------------------------\r
  87 // General bit pattern definitions\r
  88 //---------------------------------------------------------------------\r
  89 #define BIT0  0x00000001U\r
  90 #define BIT1  0x00000002U\r
  91 #define BIT2  0x00000004U\r
  92 #define BIT3  0x00000008U\r
  93 #define BIT4  0x00000010U\r
  94 #define BIT5  0x00000020U\r
  95 #define BIT6  0x00000040U\r
  96 #define BIT7  0x00000080U\r
  97 #define BIT8  0x00000100U\r
  98 #define BIT9  0x00000200U\r
  99 \r
 100 //---------------------------------------------------------------------\r
 101 // MMIO support definitions\r
 102 //---------------------------------------------------------------------\r
 103 #define EC_BASE                 0xE0000000      /* Base of MMConfig space */\r
 104 #define MMCONFIG_BASE   EC_BASE\r
 105 #define MMIO_PCI_ADDRESS(bus,dev,fn,reg) ( \\r
 106         (EC_BASE) + \\r
 107                 ((bus) << 20) + \\r
 108                 ((dev) << 15) + \\r
 109                 ((fn)  << 12) + \\r
 110                 (reg))\r
 111 \r
 112 //---------------------------------------------------------------------\r
 113 // MMIO read/write/set/clear/modify macros\r
 114 //---------------------------------------------------------------------\r
 115 #define mem_read(base, offset, size) ({ \\r
 116         volatile uint32_t a = (base) + (offset); \\r
 117         volatile uint64_t v; \\r
 118     switch (size) { \\r
 119     case 1: \\r
 120         v = (uint8_t)(*((uint8_t *)a)); \\r
 121         break; \\r
 122     case 2: \\r
 123         v = (uint16_t)(*((uint16_t *)a)); \\r
 124         break; \\r
 125     case 4: \\r
 126         v = (uint32_t)(*((uint32_t *)a)); \\r
 127         break; \\r
 128     case 8: \\r
 129         v = (uint64_t)(*((uint64_t *)a)); \\r
 130         break; \\r
 131     default: \\r
 132         halt(); \\r
 133     } \\r
 134     v; \\r
 135 })\r
 136 \r
 137 // No cache bypass necessary -- MTRRs should handle this\r
 138 #define mem_write(base, offset, size, value) { \\r
 139         volatile uint32_t a = (base) + (offset); \\r
 140     switch (size) { \\r
 141     case 1: \\r
 142         *((uint8_t *)a) = (uint8_t)(value); \\r
 143         break; \\r
 144     case 2: \\r
 145         *((uint16_t *)a) = (uint16_t)(value); \\r
 146         break; \\r
 147     case 4: \\r
 148         *((uint32_t *)a) = (uint32_t)(value); \\r
 149         break; \\r
 150     case 8: \\r
 151         *((uint64_t *)a) = (uint64_t)(value); \\r
 152         break; \\r
 153     default: \\r
 154         halt(); \\r
 155     } \\r
 156 }\r
 157 \r
 158 #define mem_set(base, offset, size, smask) { \\r
 159         volatile uint32_t a = (base) + (offset); \\r
 160     switch (size) { \\r
 161     case 1: \\r
 162         *((uint8_t *)a) = (uint8_t)((*((uint8_t *)a)) | (smask)); \\r
 163         break; \\r
 164     case 2: \\r
 165         *((uint16_t *)a) = (uint16_t)((*((uint16_t *)a)) | (smask)); \\r
 166         break; \\r
 167     case 4: \\r
 168         *((uint32_t *)a) = (uint32_t)((*((uint32_t *)a)) | (smask)); \\r
 169         break; \\r
 170     case 8: \\r
 171         *((uint64_t *)a) = (uint64_t)((*((uint64_t *)a)) | (smask)); \\r
 172         break; \\r
 173     } \\r
 174 }\r
 175 \r
 176 #define mem_clear(base, offset, size, cmask) { \\r
 177         volatile uint32_t a = (base) + (offset); \\r
 178     switch (size) { \\r
 179     case 1: \\r
 180         *((uint8_t *)a) = (uint8_t)((*((uint8_t *)a) & ~(cmask))); \\r
 181         break; \\r
 182     case 2: \\r
 183         *((uint16_t *)a) = (uint16_t)((*((uint16_t *)a) & ~(cmask))); \\r
 184         break; \\r
 185     case 4: \\r
 186         *((uint32_t *)a) = (uint32_t)((*((uint32_t *)a) & ~(cmask))); \\r
 187         break; \\r
 188     case 8: \\r
 189         *((uint64_t *)a) = (uint64_t)((*((uint64_t *)a) & ~(cmask))); \\r
 190         break; \\r
 191     } \\r
 192 }\r
 193 \r
 194 #define mem_modify(base, offset, size, cmask, smask) { \\r
 195         volatile uint32_t a = (base) + (offset); \\r
 196     switch (size) { \\r
 197     case 1: \\r
 198         *((uint8_t *)a) = (uint8_t)((*((uint8_t *)a) & ~(cmask)) | (smask)); \\r
 199         break; \\r
 200     case 2: \\r
 201         *((uint16_t *)a) = (uint16_t)((*((uint16_t *)a) & ~(cmask)) | (smask)); \\r
 202         break; \\r
 203     case 4: \\r
 204         *((uint32_t *)a) = (uint32_t)((*((uint32_t *)a) & ~(cmask)) | (smask)); \\r
 205         break; \\r
 206     case 8: \\r
 207         *((uint64_t *)a) = (uint64_t)((*((uint64_t *)a) & ~(cmask)) | (smask)); \\r
 208         break; \\r
 209     } \\r
 210 \r
 211 #ifdef __cplusplus\r
 212         } /* extern C */\r
 213 #endif\r
 214 \r
 215 #endif /* GALILEO_GEN_DEFS */\r
 216 \r