123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212 |
- #ifndef COMPILER_H
- #define COMPILER_H
-
- /*
- * Doxygen can't cope with some of the more esoteric areas of C, so we
- * make its life simpler.
- *
- */
- #ifdef DOXYGEN
- #define __attribute__(x)
- #endif
-
- /** @file
- *
- * Global compiler definitions.
- *
- * This file is implicitly included by every @c .c file in Etherboot.
- * It defines global macros such as DBG() and ASSERT().
- *
- * We arrange for each object to export the symbol @c obj_OBJECT
- * (where @c OBJECT is the object name, e.g. @c rtl8139) as a global
- * symbol, so that the linker can drag in selected object files from
- * the library using <tt> -u obj_OBJECT </tt>.
- *
- */
-
- /* Not quite sure why cpp requires two levels of macro call in order
- * to actually expand OBJECT...
- */
- #undef _H1
- #define _H1( x, y ) x ## y
- #undef _H2
- #define _H2( x, y ) _H1 ( x, y )
- #define PREFIX_OBJECT(prefix) _H2 ( prefix, OBJECT )
- #define OBJECT_SYMBOL PREFIX_OBJECT(obj_)
- #undef _STR
- #define _STR(s) #s
- #undef _XSTR
- #define _XSTR(s) _STR(s)
- #define OBJECT_SYMBOL_STR _XSTR ( OBJECT_SYMBOL )
-
- #ifdef ASSEMBLY
-
- .globl OBJECT_SYMBOL
- .equ OBJECT_SYMBOL, 0
-
- #else /* ASSEMBLY */
-
- __asm__ ( ".globl\t" OBJECT_SYMBOL_STR );
- __asm__ ( ".equ\t" OBJECT_SYMBOL_STR ", 0" );
-
- /**
- * Drag in an object by object name.
- *
- * Macro to allow objects to explicitly drag in other objects by
- * object name. Used by config.c.
- *
- */
- #define REQUIRE_OBJECT(object) \
- __asm__ ( ".equ\tneed_" #object ", obj_" #object );
-
- /** @def DBG
- *
- * Print a debugging message.
- *
- * The debug level is set at build time by specifying the @c DEBUG=
- * parameter on the @c make command line. For example, to enable
- * debugging for the PCI bus functions (in pci.c) in a @c .dsk image
- * for the @c rtl8139 card, you could use the command line
- *
- * @code
- *
- * make bin/rtl8139.dsk DEBUG=pci
- *
- * @endcode
- *
- * This will enable the debugging statements (DBG()) in pci.c. If
- * debugging is not enabled, DBG() statements will be ignored.
- *
- * You can enable debugging in several objects simultaneously by
- * separating them with commas, as in
- *
- * @code
- *
- * make bin/rtl8139.dsk DEBUG=pci,buffer,heap
- *
- * @endcode
- *
- * You can increase the debugging level for an object by specifying it
- * with @c :N, where @c N is the level, as in
- *
- * @code
- *
- * make bin/rtl8139.dsk DEBUG=pci,buffer:2,heap
- *
- * @endcode
- *
- * which would enable debugging for the PCI, buffer-handling and
- * heap-allocation code, with the buffer-handling code at level 2.
- *
- */
-
- /** @def DBG2
- *
- * Print a level 2 debugging message.
- *
- * As for DBG(). DBG2() takes effect only when the debugging level is
- * 2 or greater.
- *
- */
-
- /*
- * If debug_OBJECT is set to a true value, the macro DBG(...) will
- * expand to printf(...) when compiling OBJECT, and the symbol
- * DEBUG_LEVEL will be inserted into the object file.
- *
- */
- #define DEBUG_SYMBOL PREFIX_OBJECT(debug_)
-
- #if DEBUG_SYMBOL
- #include "console.h"
- #define DEBUG_SYMBOL_STR _XSTR ( DEBUG_SYMBOL )
- __asm__ ( ".equ\tDEBUG_LEVEL, " DEBUG_SYMBOL_STR );
- #endif
-
- #define DBG_PRINT(...) printf ( __VA_ARGS__ )
- #define DBG_DISCARD(...)
- #define DBG DBG_DISCARD
- #define DBG2 DBG_DISCARD
-
- #if DEBUG_SYMBOL >= 1
- #undef DBG
- #define DBG DBG_PRINT
- #endif
-
- #if DEBUG_SYMBOL >= 2
- #undef DBG2
- #define DBG2 DBG_PRINT
- #endif
-
- /**
- * Assert a condition.
- *
- * If the condition is not true, a debug message will be printed.
- * Assertions only take effect if the debug level is non-zero (see
- * DBG()).
- *
- */
- #define ASSERT(x)
-
- #if DEBUG_SYMBOL >= 1
- #undef ASSERT
- #define ASSERT(x) \
- do { \
- if ( ! (x) ) { \
- DBG ( "ASSERT(%s) failed at %s line %d [%s]\n", #x, \
- __FILE__, __LINE__, __FUNCTION__ ); \
- } \
- } while (0)
- #endif
-
- /** Declare a data structure as packed. */
- #define PACKED __attribute__ (( packed ))
-
- /**
- * Declare a variable or data structure as unused.
- *
- * Note that using @c __unused on a static global variable (such as a
- * table structure as mentioned in tables.h) is necessary in order to
- * inhibit compiler warnings.
- *
- */
- #define __unused __attribute__ (( unused ))
-
- /**
- * Declare a function as used.
- *
- * Necessary only if the function is called only from assembler code.
- * You cannot use this attribute for static global variables; use @c
- * __unused instead.
- *
- */
- #define __used __attribute__ (( used ))
-
- /** Declare a data structure to be aligned with 16-byte alignment */
- #define __aligned __attribute__ (( aligned ( 16 ) ))
-
- /**
- * Shared data.
- *
- * To save space in the binary when multiple-driver images are
- * compiled, uninitialised data areas can be shared between drivers.
- * This will typically be used to share statically-allocated receive
- * and transmit buffers between drivers.
- *
- * Use as e.g.
- *
- * @code
- *
- * struct {
- * char rx_buf[NUM_RX_BUF][RX_BUF_SIZE];
- * char tx_buf[TX_BUF_SIZE];
- * } my_static_data __shared;
- *
- * @endcode
- *
- */
- #define __shared __asm__ ( "_shared_bss" )
-
- #endif /* ASSEMBLY */
-
- #endif /* COMPILER_H */
|