-/*!
+/**
* \file
* <!--
* Copyright 2004 Develer S.r.l. (http://www.develer.com/)
* Copyright 1999,2000,2001 Bernardo Innocenti <bernie@develer.com>
- * This file is part of DevLib - See devlib/README for information.
+ * This file is part of DevLib - See README.devlib for information.
* -->
*
* \brief Heap subsystem (public interface).
*
*/
-/*
- * $Log$
- * Revision 1.2 2004/08/04 15:54:18 rasky
- * Merge da SC: prima versione veramente funzionante
- *
- * Revision 1.1 2004/07/31 16:33:58 rasky
- * Spostato lo heap da kern/ a mware/
- *
- * Revision 1.2 2004/06/03 11:27:09 bernie
- * Add dual-license information.
- *
- * Revision 1.1 2004/05/23 17:27:00 bernie
- * Import kern/ subdirectory.
- *
- */
+/*#*
+ *#* $Log$
+ *#* Revision 1.7 2006/07/19 12:56:27 bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.6 2005/11/27 23:36:19 bernie
+ *#* Use appconfig.h instead of cfg/config.h.
+ *#*
+ *#* Revision 1.5 2005/11/04 16:20:02 bernie
+ *#* Fix reference to README.devlib in header.
+ *#*
+ *#* Revision 1.4 2005/04/11 19:10:28 bernie
+ *#* Include top-level headers from cfg/ subdir.
+ *#*
+ *#* Revision 1.3 2004/08/25 14:12:09 rasky
+ *#* Aggiornato il comment block dei log RCS
+ *#*
+ *#* Revision 1.2 2004/08/04 15:54:18 rasky
+ *#* Merge da SC: prima versione veramente funzionante
+ *#*
+ *#* Revision 1.1 2004/07/31 16:33:58 rasky
+ *#* Spostato lo heap da kern/ a mware/
+ *#*
+ *#* Revision 1.2 2004/06/03 11:27:09 bernie
+ *#* Add dual-license information.
+ *#*
+ *#* Revision 1.1 2004/05/23 17:27:00 bernie
+ *#* Import kern/ subdirectory.
+ *#*
+ *#*/
#ifndef MWARE_HEAP_H
#define MWARE_HEAP_H
-#include <compiler.h>
-#include <config.h>
+#include <cfg/compiler.h>
+#include <appconfig.h>
struct _MemChunk;
-//! A heap
+/// A heap
struct Heap
{
- struct _MemChunk *FreeList; //!< Head of the free list
+ struct _MemChunk *FreeList; ///< Head of the free list
};
-//! Initialize \a heap within the buffer pointed by \a memory which is of \a size bytes
+/// Initialize \a heap within the buffer pointed by \a memory which is of \a size bytes
void heap_init(struct Heap* heap, void* memory, size_t size);
-//! Allocate a chunk of memory of \a size bytes from the heap
+/// Allocate a chunk of memory of \a size bytes from the heap
void *heap_allocmem(struct Heap* heap, size_t size);
-//! Free a chunk of memory of \a size bytes from the heap
+/// Free a chunk of memory of \a size bytes from the heap
void heap_freemem(struct Heap* heap, void *mem, size_t size);