-/*!
+/**
* \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.9 2006/07/19 12:56:27 bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.8 2005/11/04 16:20:02 bernie
+ *#* Fix reference to README.devlib in header.
+ *#*
+ *#* Revision 1.7 2005/04/11 19:10:28 bernie
+ *#* Include top-level headers from cfg/ subdir.
+ *#*
+ *#* Revision 1.6 2004/10/26 09:02:13 bernie
+ *#* heap_free(): Handle NULL pointers like free(), write documentation.
+ *#*
*#* Revision 1.5 2004/10/03 20:43:22 bernie
*#* Import changes from sc/firmware.
*#*
#include "heap.h"
#include <string.h> // memset()
-#include <macros.h> // IS_POW2()
-#include <debug.h> // ASSERT()
+#include <cfg/macros.h> // IS_POW2()
+#include <cfg/debug.h> // ASSERT()
/* NOTE: struct size must be a 2's power! */
typedef struct _MemChunk
return mem;
}
-void heap_free(struct Heap* h, void *mem_)
+/**
+ * Free a block of memory, determining its size automatically.
+ *
+ * \param h Heap from which the block was allocated.
+ * \param mem Pointer to a block of memory previously allocated with
+ * either heap_malloc() or heap_calloc().
+ *
+ * \note If \a mem is a NULL pointer, no operation is performed.
+ *
+ * \note Freeing the same memory block twice has undefined behavior.
+ *
+ * \note This function works like the ANSI C free().
+ */
+void heap_free(struct Heap *h, void *mem)
{
- size_t* mem = (size_t*)mem_;
- --mem;
- heap_freemem(h, mem, *mem);
+ size_t *_mem = (size_t *)mem;
+
+ if (_mem)
+ {
+ --_mem;
+ heap_freemem(h, _mem, *_mem);
+ }
}
#endif /* CONFIG_HEAP_MALLOC */