firmware/export/system.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 by Alan Korr
  11  *
  12  * All files in this archive are subject to the GNU General Public License.
  13  * See the file COPYING in the source tree root for full license agreement.
  14  *
  15  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  16  * KIND, either express or implied.
  17  *
  18  ****************************************************************************/
  19
  20 #ifndef __SYSTEM_H__
  21 #define __SYSTEM_H__
  22
  23 #include "cpu.h"
  24 #include "stdbool.h"
  25 #include "kernel.h"
  26
  27 extern void system_reboot (void);
  28 extern void system_init(void);
  29
  30 extern long cpu_frequency;
  31
  32 struct flash_header {
  33     unsigned long magic;
  34     unsigned long length;
  35     char version[32];
  36 };
  37
  38 bool detect_flashed_romimage(void);
  39 bool detect_flashed_ramimage(void);
  40 bool detect_original_firmware(void);
  41
  42 #if defined(HAVE_ADJUSTABLE_CPU_FREQ) \
  43         && defined(ROCKBOX_HAS_LOGF) && (NUM_CORES == 1)
  44 #define CPU_BOOST_LOGGING
  45 #endif
  46
  47 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
  48 #define FREQ cpu_frequency
  49 void set_cpu_frequency(long frequency);
  50 #ifdef CPU_BOOST_LOGGING
  51 char * cpu_boost_log_getlog_first(void);
  52 char * cpu_boost_log_getlog_next(void);
  53 int cpu_boost_log_getcount(void);
  54 void cpu_boost_(bool on_off, char* location, int line);
  55 #else
  56 void cpu_boost(bool on_off);
  57 #endif
  58 void cpu_idle_mode(bool on_off);
  59 int get_cpu_boost_counter(void);
  60 #else
  61 #define FREQ CPU_FREQ
  62 #define set_cpu_frequency(frequency)
  63 #define cpu_boost(on_off)
  64 #define cpu_boost_id(on_off, id)
  65 #define cpu_idle_mode(on_off)
  66 #define get_cpu_boost_counter()
  67 #define get_cpu_boost_tracker()
  68 #endif
  69
  70 #ifdef CPU_BOOST_LOGGING
  71 #define cpu_boost(on_off) cpu_boost_(on_off,__FILE__,  __LINE__)
  72 #endif
  73
  74 #define BAUDRATE 9600
  75
  76 #ifndef NULL
  77 #define NULL ((void*)0)
  78 #endif
  79
  80 #ifndef MIN
  81 #define MIN(a, b) (((a)<(b))?(a):(b))
  82 #endif
  83
  84 #ifndef MAX
  85 #define MAX(a, b) (((a)>(b))?(a):(b))
  86 #endif
  87
  88 /* return number of elements in array a */
  89 #define ARRAYLEN(a) (sizeof(a)/sizeof((a)[0]))
  90
  91 /* return p incremented by specified number of bytes */
  92 #define SKIPBYTES(p, count) ((typeof (p))((char *)(p) + (count)))
  93
  94 #define P2_M1(p2)  ((1 << (p2))-1)
  95
  96 /* align up or down to nearest 2^p2 */
  97 #define ALIGN_DOWN_P2(n, p2) ((n) & ~P2_M1(p2))
  98 #define ALIGN_UP_P2(n, p2)   ALIGN_DOWN_P2((n) + P2_M1(p2),p2)
  99
 100 /* align up or down to nearest integer multiple of a */
 101 #define ALIGN_DOWN(n, a)     ((n)/(a)*(a))
 102 #define ALIGN_UP(n, a)       ALIGN_DOWN((n)+((a)-1),a)
 103
 104 /* live endianness conversion */
 105 #ifdef ROCKBOX_LITTLE_ENDIAN
 106 #define letoh16(x) (x)
 107 #define letoh32(x) (x)
 108 #define htole16(x) (x)
 109 #define htole32(x) (x)
 110 #define betoh16(x) swap16(x)
 111 #define betoh32(x) swap32(x)
 112 #define htobe16(x) swap16(x)
 113 #define htobe32(x) swap32(x)
 114 #define swap_odd_even_be32(x) (x)
 115 #define swap_odd_even_le32(x) swap_odd_even32(x)
 116 #else
 117 #define letoh16(x) swap16(x)
 118 #define letoh32(x) swap32(x)
 119 #define htole16(x) swap16(x)
 120 #define htole32(x) swap32(x)
 121 #define betoh16(x) (x)
 122 #define betoh32(x) (x)
 123 #define htobe16(x) (x)
 124 #define htobe32(x) (x)
 125 #define swap_odd_even_be32(x) swap_odd_even32(x)
 126 #define swap_odd_even_le32(x) (x)
 127 #endif
 128
 129 /* static endianness conversion */
 130 #define SWAP_16(x) ((typeof(x))(unsigned short)(((unsigned short)(x) >> 8) | \
 131                                                 ((unsigned short)(x) << 8)))
 132
 133 #define SWAP_32(x) ((typeof(x))(unsigned long)( ((unsigned long)(x) >> 24) | \
 134                                                (((unsigned long)(x) & 0xff0000ul) >> 8) | \
 135                                                (((unsigned long)(x) & 0xff00ul) << 8) | \
 136                                                 ((unsigned long)(x) << 24)))
 137
 138 #ifdef ROCKBOX_LITTLE_ENDIAN
 139 #define LE_TO_H16(x) (x)
 140 #define LE_TO_H32(x) (x)
 141 #define H_TO_LE16(x) (x)
 142 #define H_TO_LE32(x) (x)
 143 #define BE_TO_H16(x) SWAP_16(x)
 144 #define BE_TO_H32(x) SWAP_32(x)
 145 #define H_TO_BE16(x) SWAP_16(x)
 146 #define H_TO_BE32(x) SWAP_32(x)
 147 #else
 148 #define LE_TO_H16(x) SWAP_16(x)
 149 #define LE_TO_H32(x) SWAP_32(x)
 150 #define H_TO_LE16(x) SWAP_16(x)
 151 #define H_TO_LE32(x) SWAP_32(x)
 152 #define BE_TO_H16(x) (x)
 153 #define BE_TO_H32(x) (x)
 154 #define H_TO_BE16(x) (x)
 155 #define H_TO_BE32(x) (x)
 156 #endif
 157
 158 /* gcc 3.4 changed the format of the constraints */
 159 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ > 3) || (__GNUC__ >= 4)
 160 #define I_CONSTRAINT "I08"
 161 #else
 162 #define I_CONSTRAINT "I"
 163 #endif
 164
 165 /* Utilize the user break controller to catch invalid memory accesses. */
 166 int system_memory_guard(int newmode);
 167
 168 enum {
 169     MEMGUARD_KEEP = -1,    /* don't change the mode; for reading */
 170     MEMGUARD_NONE = 0,     /* catch nothing */
 171     MEMGUARD_FLASH_WRITES, /* catch writes to area 02 (flash ROM) */
 172     MEMGUARD_ZERO_AREA,    /* catch all accesses to areas 00 and 01 */
 173     MAXMEMGUARD
 174 };
 175
 176 #ifndef SIMULATOR
 177 #include "system-target.h"
 178 #else /* SIMULATOR */
 179
 180 static inline uint16_t swap16(uint16_t value)
 181     /*
 182       result[15..8] = value[ 7..0];
 183       result[ 7..0] = value[15..8];
 184     */
 185 {
 186     return (value >> 8) | (value << 8);
 187 }
 188
 189 static inline uint32_t swap32(uint32_t value)
 190     /*
 191       result[31..24] = value[ 7.. 0];
 192       result[23..16] = value[15.. 8];
 193       result[15.. 8] = value[23..16];
 194       result[ 7.. 0] = value[31..24];
 195     */
 196 {
 197     uint32_t hi = swap16(value >> 16);
 198     uint32_t lo = swap16(value & 0xffff);
 199     return (lo << 16) | hi;
 200 }
 201
 202 static inline uint32_t swap_odd_even32(uint32_t value)
 203 {
 204     /*
 205       result[31..24],[15.. 8] = value[23..16],[ 7.. 0]
 206       result[23..16],[ 7.. 0] = value[31..24],[15.. 8]
 207     */
 208     uint32_t t = value & 0xff00ff00;
 209     return (t >> 8) | ((t ^ value) << 8);
 210 }
 211
 212 #endif /* !SIMULATOR */
 213
 214 /* Declare this as HIGHEST_IRQ_LEVEL if they don't differ */
 215 #ifndef DISABLE_INTERRUPTS
 216 #define DISABLE_INTERRUPTS  HIGHEST_IRQ_LEVEL
 217 #endif
 218
 219 /* Just define these as empty if not declared */
 220 #ifndef HAVE_INVALIDATE_ICACHE
 221 #define invalidate_icache()
 222 #endif
 223
 224 #ifndef HAVE_FLUSH_ICACHE
 225 #define flush_icache()
 226 #endif
 227
 228 #endif /* __SYSTEM_H__ */