From 6f2c65b0d5fb40cb95ba07980cd3ea98e3ec496c Mon Sep 17 00:00:00 2001
From: Jon Trulson <jtrulson@ics.com>
Date: Thu, 22 Sep 2016 16:40:01 -0600
Subject: [PATCH] upm_utilities: remove unused upm_malloc/free, add comments

Signed-off-by: Jon Trulson <jtrulson@ics.com>
---
 src/utilities/upm_utilities.c | 57 +++++++++++++++--------------------
 src/utilities/upm_utilities.h | 26 ++++++++++++----
 2 files changed, 45 insertions(+), 38 deletions(-)

diff --git a/src/utilities/upm_utilities.c b/src/utilities/upm_utilities.c
index fe04388e..a428df15 100644
--- a/src/utilities/upm_utilities.c
+++ b/src/utilities/upm_utilities.c
@@ -1,37 +1,30 @@
+/*
+ * Authors:
+ *          Jon Trulson <jtrulson@ics.com>
+ * Copyright (c) 2016 Intel Corporation.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
 #include <upm_utilities.h>
 
-void* upm_malloc(int mem_map, int size){
-    void *mem;
-#if defined(linux)
-    mem = malloc(size);
-    if(mem == NULL){
-        printf("unable to allocate memory");
-    }
-    else{
-        printf("memory allocated successfully\n");
-    }
-#elif defined(CONFIG_BOARD_ARDUINO_101) || defined(CONFIG_BOARD_ARDUINO_101_SSS) || defined(CONFIG_BOARD_QUARK_D2000_CRB)
-    kmemory_map_t map_name = (kmemory_map_t) mem_map;
-    if(task_mem_map_alloc(map_name, &mem, TICKS_UNLIMITED) == RC_OK){
-        printf("memory allocated successfully\n");
-    }
-    else{
-        printf("unable to allocate memory");
-        mem = NULL;
-    }
-#endif
-    return mem;
-}
-
-void upm_free(int mem_map, void* ptr){
-#if defined(linux)
-    free(ptr);
-#elif defined(CONFIG_BOARD_ARDUINO_101) || defined(CONFIG_BOARD_ARDUINO_101_SSS) || defined(CONFIG_BOARD_QUARK_D2000_CRB)
-    kmemory_map_t map_name = (kmemory_map_t) mem_map;
-    task_mem_map_free(map_name, &ptr);
-#endif
-}
-
 void upm_delay(int time){
 #if defined(linux)
     sleep(time);
diff --git a/src/utilities/upm_utilities.h b/src/utilities/upm_utilities.h
index 8046b1f0..cd9d2b88 100644
--- a/src/utilities/upm_utilities.h
+++ b/src/utilities/upm_utilities.h
@@ -1,5 +1,6 @@
 /*
  * Authors:
+ *          Jon Trulson <jtrulson@ics.com>
  * Copyright (c) 2016 Intel Corporation.
  *
  * Permission is hereby granted, free of charge, to any person obtaining
@@ -32,7 +33,7 @@ extern "C" {
 #include <stdio.h>
 #include <stdlib.h>
 #include <unistd.h>
-#endif
+#endif /* linux */
 
 #if defined(CONFIG_BOARD_ARDUINO_101) || defined(CONFIG_BOARD_ARDUINO_101_SSS) || defined(CONFIG_BOARD_QUARK_D2000_CRB)
 #include <zephyr.h>
@@ -46,21 +47,34 @@ extern "C" {
 #include <misc/printk.h>
 #define PRINT           printk
 #endif
-#endif
+
+#endif /* CONFIG_BOARD_ARDUINO_101 || CONFIG_BOARD_ARDUINO_101_SSS ||
+          CONFIG_BOARD_QUARK_D2000_CRB */
 
 /* Get filename w/o path */
 #define __FILENAME__ (strrchr(__FILE__, '/') ? strrchr(__FILE__, '/') + 1 : __FILE__)
 
+/**
+ * Delay for a number of seconds
+ *
+ * @param time The number of seconds to delay for
+ */
 void upm_delay(int time);
 
+/**
+ * Delay for a number of milliseconds
+ *
+ * @param time The number of milliseconds to delay for
+ */
 void upm_delay_ms(int time);
 
+/**
+ * Delay for a number of microseconds
+ *
+ * @param time The number of microsenconds to delay for
+ */
 void upm_delay_us(int time);
 
-void* upm_malloc(int mem_map, int size);
-
-void upm_free(int mem_map, void* ptr);
-
 #ifdef __cplusplus
 }
 #endif