code.delx.au - refind/blob - filesystems/fsw_base.h

   1 /* $Id: fsw_base.h 29125 2010-05-06 09:43:05Z vboxsync $ */
   2 /** @file
   3  * fsw_base.h - Base definitions switch.
   4  */
   5
   6 /*
   7  * Copyright (C) 2010 Oracle Corporation
   8  *
   9  * This file is part of VirtualBox Open Source Edition (OSE), as
  10  * available from http://www.virtualbox.org. This file is free software;
  11  * you can redistribute it and/or modify it under the terms of the GNU
  12  * General Public License (GPL) as published by the Free Software
  13  * Foundation, in version 2 as it comes in the "COPYING" file of the
  14  * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
  15  * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
  16  */
  17
  18 /*-
  19  * This code is based on:
  20  *
  21  * Copyright (c) 2006 Christoph Pfisterer
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions are
  25  * met:
  26  *
  27  *  * Redistributions of source code must retain the above copyright
  28  *    notice, this list of conditions and the following disclaimer.
  29  *
  30  *  * Redistributions in binary form must reproduce the above copyright
  31  *    notice, this list of conditions and the following disclaimer in the
  32  *    documentation and/or other materials provided with the
  33  *    distribution.
  34  *
  35  *  * Neither the name of Christoph Pfisterer nor the names of the
  36  *    contributors may be used to endorse or promote products derived
  37  *    from this software without specific prior written permission.
  38  *
  39  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  40  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  41  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  42  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  43  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  45  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  46  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  47  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  48  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  49  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  50  */
  51
  52 #ifndef _FSW_BASE_H_
  53 #define _FSW_BASE_H_
  54
  55 #ifdef HOST_EFI_EDK2
  56 #define HOST_EFI
  57 #endif
  58
  59 #ifdef HOST_EFI
  60 #include "fsw_efi_base.h"
  61 #endif
  62
  63 #ifdef HOST_POSIX
  64 #include "test/fsw_posix_base.h"
  65 #endif
  66
  67 #ifndef FSW_DEBUG_LEVEL
  68 /**
  69  * Global debugging level. Can be set locally for the scope of a single
  70  * file by defining the macro before fsw_base.h is included.
  71  */
  72 #define FSW_DEBUG_LEVEL 1
  73 #endif
  74
  75 // message printing
  76
  77 #if FSW_DEBUG_LEVEL >= 1
  78 #define FSW_MSG_ASSERT(params) FSW_MSGFUNC params
  79 #else
  80 #define FSW_MSG_ASSERT(params)
  81 #endif
  82
  83 #if FSW_DEBUG_LEVEL >= 2
  84 #define FSW_MSG_DEBUG(params) FSW_MSGFUNC params
  85 #else
  86 #define FSW_MSG_DEBUG(params)
  87 #endif
  88
  89 #if FSW_DEBUG_LEVEL >= 3
  90 #define FSW_MSG_DEBUGV(params) FSW_MSGFUNC params
  91 #else
  92 #define FSW_MSG_DEBUGV(params)
  93 #endif
  94
  95
  96 // Documentation for system-dependent defines
  97
  98 /**
  99  * \typedef fsw_s8
 100  * Signed 8-bit integer.
 101  */
 102
 103 /**
 104  * \typedef fsw_u8
 105  * Unsigned 8-bit integer.
 106  */
 107
 108 /**
 109  * \typedef fsw_s16
 110  * Signed 16-bit integer.
 111  */
 112
 113 /**
 114  * \typedef fsw_u16
 115  * Unsigned 16-bit integer.
 116  */
 117
 118 /**
 119  * \typedef fsw_s32
 120  * Signed 32-bit integer.
 121  */
 122
 123 /**
 124  * \typedef fsw_u32
 125  * Unsigned 32-bit integer.
 126  */
 127
 128 /**
 129  * \typedef fsw_s64
 130  * Signed 64-bit integer.
 131  */
 132
 133 /**
 134  * \typedef fsw_u64
 135  * Unsigned 64-bit integer.
 136  */
 137
 138
 139 /**
 140  * \def fsw_alloc(size,ptrptr)
 141  * Allocate memory on the heap. This function or macro allocates \a size
 142  * bytes of memory using host-specific methods. The address of the
 143  * allocated memory block is stored into the pointer variable pointed
 144  * to by \a ptrptr. A status code is returned; FSW_SUCCESS if the block
 145  * was allocated or FSW_OUT_OF_MEMORY if there is not enough memory
 146  * to allocated the requested block.
 147  */
 148
 149 /**
 150  * \def fsw_free(ptr)
 151  * Release allocated memory. This function or macro returns an allocated
 152  * memory block to the heap for reuse. Does not return a status.
 153  */
 154
 155 /**
 156  * \def fsw_memcpy(dest,src,size)
 157  * Copies a block of memory from \a src to \a dest. The two memory blocks
 158  * must not overlap, or the result of the operation will be undefined.
 159  * Does not return a status.
 160  */
 161
 162 /**
 163  * \def fsw_memeq(dest,src,size)
 164  * Compares two blocks of memory for equality. Returns boolean true if the
 165  * memory blocks are equal, boolean false if they are different.
 166  */
 167
 168 /**
 169  * \def fsw_memzero(dest,size)
 170  * Initializes a block of memory with zeros. Does not return a status.
 171  */
 172
 173
 174 #endif