Better wording in benchmarks' description.
[bertos.git] / boards / stm32-p103 / benchmark / kernel_footprint / main.c
index 7ecafb863d7eac8259d22ea2e9ded962151e61c0..78920ff58dd88e3b0d966460a4ff5e529256e57b 100644 (file)
@@ -1,20 +1,56 @@
-// Emtpy main.c file generated by the wizard
-#include <cpu/irq.h>
+/**
+ * \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 2010 Develer S.r.l. (http://www.develer.com/)
+ *
+ * -->
+ *
+ * \author Daniele Basile <asterix@develer.com>
+ *
+ * \brief Kernel footprint benchmark.
+ *
+ * This benchmark measures the memory footprint[1] of the BeRTOS kernel with a
+ * simple minimalist user application.
+ *
+ * The purpose of this test is to give a measure of the required space in a
+ * generic flash memory to store a full-featured BeRTOS kernel.
+ *
+ * [1] http://en.wikipedia.org/wiki/Memory_footprint
+ */
 
-static void init(void)
-{
-       IRQ_ENABLE;
-       // insert initialization calls here
-}
+#include <benchmark/kernel_footprint.h>
 
 int main(void)
 {
-       init();
+       kernel_footprint();
        while (1)
        {
-               // your code goes here
        }
 
        return 0;
 }
-