Doc fixes.

[bertos.git] / mware / heap.c

diff --git a/mware/heap.c b/mware/heap.c
old mode 100755 (executable)
new mode 100644 (file)
index 70c73c1..bced107
--- a/mware/heap.c
+++ b/mware/heap.c
@@ -1,9 +1,34 @@
-/*!
+/**
  * \file
  * <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
  * 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.
+ *
  * -->
  *
  * \brief Heap subsystem (public interface).
@@ -15,14 +40,20 @@
 
 /*#*
  *#* $Log$
- *#* Revision 1.4  2004/08/25 14:12:09  rasky
- *#* Aggiornato il comment block dei log RCS
+ *#* 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.3  2004/08/14 19:37:57  rasky
- *#* Merge da SC: macros.h, pool.h, BIT_CHANGE, nome dei processi, etc.
+ *#* Revision 1.6  2004/10/26 09:02:13  bernie
+ *#* heap_free(): Handle NULL pointers like free(), write documentation.
  *#*
- *#* Revision 1.2  2004/08/04 15:54:18  rasky
- *#* Merge da SC: prima versione veramente funzionante
+ *#* Revision 1.5  2004/10/03 20:43:22  bernie
+ *#* Import changes from sc/firmware.
  *#*
  *#* Revision 1.1  2004/07/31 16:33:58  rasky
  *#* Spostato lo heap da kern/ a mware/
@@ -37,8 +68,8 @@
 
 #include "heap.h"
 #include <string.h>           // memset()
-#include <macros.h>           // IS_POW2()
-#include <drv/kdebug.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
@@ -207,11 +238,28 @@ void *heap_calloc(struct Heap* h, size_t size)
        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 */