sim/ppc/sim-endian.h

   1 /*  This file is part of the program psim.
   2
   3     Copyright (C) 1994-1995, Andrew Cagney <cagney@highland.com.au>
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 3 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, see <http://www.gnu.org/licenses/>.
  17
  18     */
  19
  20
  21 #ifndef _SIM_ENDIAN_H_
  22 #define _SIM_ENDIAN_H_
  23
  24
  25 /* C byte conversion functions */
  26
  27 INLINE_PSIM_ENDIAN(unsigned_1) endian_h2t_1(unsigned_1 x);
  28 INLINE_PSIM_ENDIAN(unsigned_2) endian_h2t_2(unsigned_2 x);
  29 INLINE_PSIM_ENDIAN(unsigned_4) endian_h2t_4(unsigned_4 x);
  30 INLINE_PSIM_ENDIAN(unsigned_8) endian_h2t_8(unsigned_8 x);
  31
  32 INLINE_PSIM_ENDIAN(unsigned_1) endian_t2h_1(unsigned_1 x);
  33 INLINE_PSIM_ENDIAN(unsigned_2) endian_t2h_2(unsigned_2 x);
  34 INLINE_PSIM_ENDIAN(unsigned_4) endian_t2h_4(unsigned_4 x);
  35 INLINE_PSIM_ENDIAN(unsigned_8) endian_t2h_8(unsigned_8 x);
  36
  37 INLINE_PSIM_ENDIAN(unsigned_1) swap_1(unsigned_1 x);
  38 INLINE_PSIM_ENDIAN(unsigned_2) swap_2(unsigned_2 x);
  39 INLINE_PSIM_ENDIAN(unsigned_4) swap_4(unsigned_4 x);
  40 INLINE_PSIM_ENDIAN(unsigned_8) swap_8(unsigned_8 x);
  41
  42 INLINE_PSIM_ENDIAN(unsigned_1) endian_h2be_1(unsigned_1 x);
  43 INLINE_PSIM_ENDIAN(unsigned_2) endian_h2be_2(unsigned_2 x);
  44 INLINE_PSIM_ENDIAN(unsigned_4) endian_h2be_4(unsigned_4 x);
  45 INLINE_PSIM_ENDIAN(unsigned_8) endian_h2be_8(unsigned_8 x);
  46
  47 INLINE_PSIM_ENDIAN(unsigned_1) endian_be2h_1(unsigned_1 x);
  48 INLINE_PSIM_ENDIAN(unsigned_2) endian_be2h_2(unsigned_2 x);
  49 INLINE_PSIM_ENDIAN(unsigned_4) endian_be2h_4(unsigned_4 x);
  50 INLINE_PSIM_ENDIAN(unsigned_8) endian_be2h_8(unsigned_8 x);
  51
  52 INLINE_PSIM_ENDIAN(unsigned_1) endian_h2le_1(unsigned_1 x);
  53 INLINE_PSIM_ENDIAN(unsigned_2) endian_h2le_2(unsigned_2 x);
  54 INLINE_PSIM_ENDIAN(unsigned_4) endian_h2le_4(unsigned_4 x);
  55 INLINE_PSIM_ENDIAN(unsigned_8) endian_h2le_8(unsigned_8 x);
  56
  57 INLINE_PSIM_ENDIAN(unsigned_1) endian_le2h_1(unsigned_1 x);
  58 INLINE_PSIM_ENDIAN(unsigned_2) endian_le2h_2(unsigned_2 x);
  59 INLINE_PSIM_ENDIAN(unsigned_4) endian_le2h_4(unsigned_4 x);
  60 INLINE_PSIM_ENDIAN(unsigned_8) endian_le2h_8(unsigned_8 x);
  61
  62
  63 /* Host dependant:
  64
  65    The CPP below defines information about the compilation host.  In
  66    particular it defines the macro's:
  67
  68         WITH_HOST_BYTE_ORDER    The byte order of the host. Could
  69                                 be any of LITTLE_ENDIAN, BIG_ENDIAN
  70                                 or 0 (unknown).  Those macro's also
  71                                 need to be defined.
  72
  73  */
  74
  75
  76 /* NetBSD:
  77
  78    NetBSD is easy, everything you could ever want is in a header file
  79    (well almost :-) */
  80
  81 #if defined(__NetBSD__)
  82 # include <machine/endian.h>
  83 # if (WITH_HOST_BYTE_ORDER == 0)
  84 #  undef WITH_HOST_BYTE_ORDER
  85 #  define WITH_HOST_BYTE_ORDER BYTE_ORDER
  86 # endif
  87 # if (BYTE_ORDER != WITH_HOST_BYTE_ORDER)
  88 #  error "host endian incorrectly configured, check config.h"
  89 # endif
  90 #endif
  91
  92 /* Linux is similarly easy.  */
  93
  94 #if defined(__linux__)
  95 # include <endian.h>
  96 # if defined(__LITTLE_ENDIAN) && !defined(LITTLE_ENDIAN)
  97 #  define LITTLE_ENDIAN __LITTLE_ENDIAN
  98 # endif
  99 # if defined(__BIG_ENDIAN) && !defined(BIG_ENDIAN)
 100 #  define BIG_ENDIAN __BIG_ENDIAN
 101 # endif
 102 # if defined(__BYTE_ORDER) && !defined(BYTE_ORDER)
 103 #  define BYTE_ORDER __BYTE_ORDER
 104 # endif
 105 # if (WITH_HOST_BYTE_ORDER == 0)
 106 #  undef WITH_HOST_BYTE_ORDER
 107 #  define WITH_HOST_BYTE_ORDER BYTE_ORDER
 108 # endif
 109 # if (BYTE_ORDER != WITH_HOST_BYTE_ORDER)
 110 #  error "host endian incorrectly configured, check config.h"
 111 # endif
 112 #endif
 113
 114 /* INSERT HERE - hosts that have available LITTLE_ENDIAN and
 115    BIG_ENDIAN macro's */
 116
 117
 118 /* Some hosts don't define LITTLE_ENDIAN or BIG_ENDIAN, help them out */
 119
 120 #ifndef LITTLE_ENDIAN
 121 #define LITTLE_ENDIAN 1234
 122 #endif
 123 #ifndef BIG_ENDIAN
 124 #define BIG_ENDIAN 4321
 125 #endif
 126
 127
 128 /* SunOS on SPARC:
 129
 130    Big endian last time I looked */
 131
 132 #if defined(sparc) || defined(__sparc__)
 133 # if (WITH_HOST_BYTE_ORDER == 0)
 134 #  undef WITH_HOST_BYTE_ORDER
 135 #  define WITH_HOST_BYTE_ORDER BIG_ENDIAN
 136 # endif
 137 # if (WITH_HOST_BYTE_ORDER != BIG_ENDIAN)
 138 #  error "sun was big endian last time I looked ..."
 139 # endif
 140 #endif
 141
 142
 143 /* Random x86
 144
 145    Little endian last time I looked */
 146
 147 #if defined(i386) || defined(i486) || defined(i586) || defined (i686) || defined(__i386__) || defined(__i486__) || defined(__i586__) || defined (__i686__)
 148 # if (WITH_HOST_BYTE_ORDER == 0)
 149 #  undef WITH_HOST_BYTE_ORDER
 150 #  define WITH_HOST_BYTE_ORDER LITTLE_ENDIAN
 151 # endif
 152 # if (WITH_HOST_BYTE_ORDER != LITTLE_ENDIAN)
 153 #  error "x86 was little endian last time I looked ..."
 154 # endif
 155 #endif
 156
 157 /* Power or PowerPC running AIX  */
 158 #if defined(_POWER) && defined(_AIX)
 159 # if (WITH_HOST_BYTE_ORDER == 0)
 160 #  undef WITH_HOST_BYTE_ORDER
 161 #  define WITH_HOST_BYTE_ORDER BIG_ENDIAN
 162 # endif
 163 # if (WITH_HOST_BYTE_ORDER != BIG_ENDIAN)
 164 #  error "Power/PowerPC AIX was big endian last time I looked ..."
 165 # endif
 166 #endif
 167
 168 /* Solaris running PowerPC */
 169 #if defined(__PPC) && defined(__sun__)
 170 # if (WITH_HOST_BYTE_ORDER == 0)
 171 #  undef WITH_HOST_BYTE_ORDER
 172 #  define WITH_HOST_BYTE_ORDER LITTLE_ENDIAN
 173 # endif
 174 # if (WITH_HOST_BYTE_ORDER != LITTLE_ENDIAN)
 175 #  error "Solaris on PowerPCs was little endian last time I looked ..."
 176 # endif
 177 #endif
 178
 179 /* HP/PA */
 180 #if defined(__hppa__)
 181 # if (WITH_HOST_BYTE_ORDER == 0)
 182 #  undef WITH_HOST_BYTE_ORDER
 183 #  define WITH_HOST_BYTE_ORDER BIG_ENDIAN
 184 # endif
 185 # if (WITH_HOST_BYTE_ORDER != BIG_ENDIAN)
 186 #  error "HP/PA was big endian last time I looked ..."
 187 # endif
 188 #endif
 189
 190 /* Big endian MIPS */
 191 #if defined(__MIPSEB__)
 192 # if (WITH_HOST_BYTE_ORDER == 0)
 193 #  undef WITH_HOST_BYTE_ORDER
 194 #  define WITH_HOST_BYTE_ORDER BIG_ENDIAN
 195 # endif
 196 # if (WITH_HOST_BYTE_ORDER != BIG_ENDIAN)
 197 #  error "MIPSEB was big endian last time I looked ..."
 198 # endif
 199 #endif
 200
 201 /* Little endian MIPS */
 202 #if defined(__MIPSEL__)
 203 # if (WITH_HOST_BYTE_ORDER == 0)
 204 #  undef WITH_HOST_BYTE_ORDER
 205 #  define WITH_HOST_BYTE_ORDER LITTLE_ENDIAN
 206 # endif
 207 # if (WITH_HOST_BYTE_ORDER != LITTLE_ENDIAN)
 208 #  error "MIPSEL was little endian last time I looked ..."
 209 # endif
 210 #endif
 211
 212 /* Windows NT */
 213 #if defined(__WIN32__)
 214 # if (WITH_HOST_BYTE_ORDER == 0)
 215 #  undef WITH_HOST_BYTE_ORDER
 216 #  define WITH_HOST_BYTE_ORDER LITTLE_ENDIAN
 217 # endif
 218 # if (WITH_HOST_BYTE_ORDER != LITTLE_ENDIAN)
 219 #  error "Windows NT was little endian last time I looked ..."
 220 # endif
 221 #endif
 222
 223 /* Alpha running DEC unix */
 224 #if defined(__osf__) && defined(__alpha__)
 225 # if (WITH_HOST_BYTE_ORDER == 0)
 226 #  undef WITH_HOST_BYTE_ORDER
 227 #  define WITH_HOST_BYTE_ORDER LITTLE_ENDIAN
 228 # endif
 229 # if (WITH_HOST_BYTE_ORDER != LITTLE_ENDIAN)
 230 #  error "AXP running DEC unix was little endian last time I looked ..."
 231 # endif
 232 #endif
 233
 234
 235 /* INSERT HERE - additional hosts that do not have LITTLE_ENDIAN and
 236    BIG_ENDIAN definitions available.  */
 237
 238 /* SWAP */
 239
 240 #define SWAP_1 swap_1
 241 #define SWAP_2 swap_2
 242 #define SWAP_4 swap_4
 243 #define SWAP_8 swap_8
 244
 245
 246 /* HOST to BE */
 247
 248 #define H2BE_1 endian_h2be_1
 249 #define H2BE_2 endian_h2be_2
 250 #define H2BE_4 endian_h2be_4
 251 #define H2BE_8 endian_h2be_8
 252 #define BE2H_1 endian_be2h_1
 253 #define BE2H_2 endian_be2h_2
 254 #define BE2H_4 endian_be2h_4
 255 #define BE2H_8 endian_be2h_8
 256
 257
 258 /* HOST to LE */
 259
 260 #define H2LE_1 endian_h2le_1
 261 #define H2LE_2 endian_h2le_2
 262 #define H2LE_4 endian_h2le_4
 263 #define H2LE_8 endian_h2le_8
 264 #define LE2H_1 endian_le2h_1
 265 #define LE2H_2 endian_le2h_2
 266 #define LE2H_4 endian_le2h_4
 267 #define LE2H_8 endian_le2h_8
 268
 269
 270 /* HOST to TARGET */
 271
 272 #define H2T_1 endian_h2t_1
 273 #define H2T_2 endian_h2t_2
 274 #define H2T_4 endian_h2t_4
 275 #define H2T_8 endian_h2t_8
 276 #define T2H_1 endian_t2h_1
 277 #define T2H_2 endian_t2h_2
 278 #define T2H_4 endian_t2h_4
 279 #define T2H_8 endian_t2h_8
 280
 281
 282 /* CONVERT IN PLACE
 283
 284    These macros, given an argument of unknown size, swap its value in
 285    place if a host/target conversion is required. */
 286
 287 #define H2T(VARIABLE) \
 288 do { \
 289   switch (sizeof(VARIABLE)) { \
 290   case 1: VARIABLE = H2T_1(VARIABLE); break; \
 291   case 2: VARIABLE = H2T_2(VARIABLE); break; \
 292   case 4: VARIABLE = H2T_4(VARIABLE); break; \
 293   case 8: VARIABLE = H2T_8(VARIABLE); break; \
 294   } \
 295 } while (0)
 296
 297 #define T2H(VARIABLE) \
 298 do { \
 299   switch (sizeof(VARIABLE)) { \
 300   case 1: VARIABLE = T2H_1(VARIABLE); break; \
 301   case 2: VARIABLE = T2H_2(VARIABLE); break; \
 302   case 4: VARIABLE = T2H_4(VARIABLE); break; \
 303   case 8: VARIABLE = T2H_8(VARIABLE); break; \
 304   } \
 305 } while (0)
 306
 307 #define SWAP(VARIABLE) \
 308 do { \
 309   switch (sizeof(VARIABLE)) { \
 310   case 1: VARIABLE = SWAP_1(VARIABLE); break; \
 311   case 2: VARIABLE = SWAP_2(VARIABLE); break; \
 312   case 4: VARIABLE = SWAP_4(VARIABLE); break; \
 313   case 8: VARIABLE = SWAP_8(VARIABLE); break; \
 314   } \
 315 } while (0)
 316
 317 #define H2BE(VARIABLE) \
 318 do { \
 319   switch (sizeof(VARIABLE)) { \
 320   case 1: VARIABLE = H2BE_1(VARIABLE); break; \
 321   case 2: VARIABLE = H2BE_2(VARIABLE); break; \
 322   case 4: VARIABLE = H2BE_4(VARIABLE); break; \
 323   case 8: VARIABLE = H2BE_8(VARIABLE); break; \
 324   } \
 325 } while (0)
 326
 327 #define BE2H(VARIABLE) \
 328 do { \
 329   switch (sizeof(VARIABLE)) { \
 330   case 1: VARIABLE = BE2H_1(VARIABLE); break; \
 331   case 2: VARIABLE = BE2H_2(VARIABLE); break; \
 332   case 4: VARIABLE = BE2H_4(VARIABLE); break; \
 333   case 8: VARIABLE = BE2H_8(VARIABLE); break; \
 334   } \
 335 } while (0)
 336
 337 #define H2LE(VARIABLE) \
 338 do { \
 339   switch (sizeof(VARIABLE)) { \
 340   case 1: VARIABLE = H2LE_1(VARIABLE); break; \
 341   case 2: VARIABLE = H2LE_2(VARIABLE); break; \
 342   case 4: VARIABLE = H2LE_4(VARIABLE); break; \
 343   case 8: VARIABLE = H2LE_8(VARIABLE); break; \
 344   } \
 345 } while (0)
 346
 347 #define LE2H(VARIABLE) \
 348 do { \
 349   switch (sizeof(VARIABLE)) { \
 350   case 1: VARIABLE = LE2H_1(VARIABLE); break; \
 351   case 2: VARIABLE = LE2H_2(VARIABLE); break; \
 352   case 4: VARIABLE = LE2H_4(VARIABLE); break; \
 353   case 8: VARIABLE = LE2H_8(VARIABLE); break; \
 354   } \
 355 } while (0)
 356
 357
 358
 359 /* TARGET WORD:
 360
 361    Byte swap a quantity the size of the targets word */
 362
 363 #if (WITH_TARGET_WORD_BITSIZE == 64)
 364 #define H2T_word H2T_8
 365 #define T2H_word T2H_8
 366 #define H2BE_word H2BE_8
 367 #define BE2H_word BE2H_8
 368 #define H2LE_word H2LE_8
 369 #define LE2H_word LE2H_8
 370 #define SWAP_word SWAP_8
 371 #endif
 372 #if (WITH_TARGET_WORD_BITSIZE == 32)
 373 #define H2T_word H2T_4
 374 #define T2H_word T2H_4
 375 #define H2BE_word H2BE_4
 376 #define BE2H_word BE2H_4
 377 #define H2LE_word H2LE_4
 378 #define LE2H_word LE2H_4
 379 #define SWAP_word SWAP_4
 380 #endif
 381
 382
 383 /* TARGET CELL:
 384
 385    Byte swap a quantity the size of the targets IEEE 1275 memory cell */
 386
 387 #define H2T_cell H2T_4
 388 #define T2H_cell T2H_4
 389 #define H2BE_cell H2BE_4
 390 #define BE2H_cell BE2H_4
 391 #define H2LE_cell H2LE_4
 392 #define LE2H_cell LE2H_4
 393 #define SWAP_cell SWAP_4
 394
 395
 396 #if (SIM_ENDIAN_INLINE & INCLUDE_MODULE)
 397 # include "sim-endian.c"
 398 #endif
 399
 400 #endif /* _SIM_ENDIAN_H_ */