mraa: rename from maa to mraa

[contrib/mraa.git] / api / mraa / types.h

diff --git a/api/maa/types.h b/api/mraa/types.h
similarity index 50%
rename from api/maa/types.h
rename to api/mraa/types.h
index 7d36af5..9dba83c 100644 (file)
--- a/api/maa/types.h
+++ b/api/mraa/types.h
@@ -25,7 +25,7 @@
 
 /** @file
  *
- * This file defines the basic shared types for libmaa
+ * This file defines the basic shared types for libmraa
  * this file is different to common.h in that swig takes this as an input
  */
 
@@ -34,38 +34,38 @@ extern "C" {
 #endif
 
 /**
- * MAA supported platform types
+ * MRAA supported platform types
  */
 typedef enum {
-    MAA_INTEL_GALILEO_GEN1 = 0, /**< The Generation 1 Galileo platform (RevD) */
-    MAA_INTEL_GALILEO_GEN2 = 1, /**< The Generation 2 Galileo platform (RevG/H) */
+    MRAA_INTEL_GALILEO_GEN1 = 0, /**< The Generation 1 Galileo platform (RevD) */
+    MRAA_INTEL_GALILEO_GEN2 = 1, /**< The Generation 2 Galileo platform (RevG/H) */
 
-    MAA_UNKNOWN_PLATFORM = 99 /**< An unknown platform type, typically will load INTEL_GALILEO_GEN1 */
-} maa_platform_t;
+    MRAA_UNKNOWN_PLATFORM = 99 /**< An unknown platform type, typically will load INTEL_GALILEO_GEN1 */
+} mraa_platform_t;
 
 /**
- * MAA return codes
+ * MRAA return codes
  */
 typedef enum {
-    MAA_SUCCESS                              =  0, /**< Expected response */
-    MAA_ERROR_FEATURE_NOT_IMPLEMENTED        =  1, /**< Feature TODO */
-    MAA_ERROR_FEATURE_NOT_SUPPORTED          =  2, /**< Feature not supported by HW */
-    MAA_ERROR_INVALID_VERBOSITY_LEVEL        =  3, /**< Verbosity level wrong */
-    MAA_ERROR_INVALID_PARAMETER              =  4, /**< Parameter invalid */
-    MAA_ERROR_INVALID_HANDLE                 =  5, /**< Handle invalid */
-    MAA_ERROR_NO_RESOURCES                   =  6, /**< No resource of that type avail */
-    MAA_ERROR_INVALID_RESOURCE               =  7, /**< Resource invalid */
-    MAA_ERROR_INVALID_QUEUE_TYPE             =  8, /**< Queue type incorrect */
-    MAA_ERROR_NO_DATA_AVAILABLE              =  9, /**< No data available */
-    MAA_ERROR_INVALID_PLATFORM               = 10, /**< Platform not recognised */
-    MAA_ERROR_PLATFORM_NOT_INITIALISED       = 11, /**< Board information not initialised */
-    MAA_ERROR_PLATFORM_ALREADY_INITIALISED   = 12, /**< Board is already initialised */
+    MRAA_SUCCESS                              =  0, /**< Expected response */
+    MRAA_ERROR_FEATURE_NOT_IMPLEMENTED        =  1, /**< Feature TODO */
+    MRAA_ERROR_FEATURE_NOT_SUPPORTED          =  2, /**< Feature not supported by HW */
+    MRAA_ERROR_INVALID_VERBOSITY_LEVEL        =  3, /**< Verbosity level wrong */
+    MRAA_ERROR_INVALID_PARAMETER              =  4, /**< Parameter invalid */
+    MRAA_ERROR_INVALID_HANDLE                 =  5, /**< Handle invalid */
+    MRAA_ERROR_NO_RESOURCES                   =  6, /**< No resource of that type avail */
+    MRAA_ERROR_INVALID_RESOURCE               =  7, /**< Resource invalid */
+    MRAA_ERROR_INVALID_QUEUE_TYPE             =  8, /**< Queue type incorrect */
+    MRAA_ERROR_NO_DATA_AVAILABLE              =  9, /**< No data available */
+    MRAA_ERROR_INVALID_PLATFORM               = 10, /**< Platform not recognised */
+    MRAA_ERROR_PLATFORM_NOT_INITIALISED       = 11, /**< Board information not initialised */
+    MRAA_ERROR_PLATFORM_ALREADY_INITIALISED   = 12, /**< Board is already initialised */
 
-    MAA_ERROR_UNSPECIFIED                    = 99 /**< Unknown Error */
-} maa_result_t;
+    MRAA_ERROR_UNSPECIFIED                    = 99 /**< Unknown Error */
+} mraa_result_t;
 
 /**
- * This function attempts to set the maa process to a given priority and the
+ * This function attempts to set the mraa process to a given priority and the
  * scheduler to SCHED_RR. Highest * priority is typically 99 and minimum is 0.
  * This function * will set to MAX if * priority is > MAX. Function will return
  * -1 on failure.
@@ -73,30 +73,30 @@ typedef enum {
  * @param priority Value from typically 0 to 99
  * @return The priority value set
  */
-int maa_set_priority(const unsigned int priority);
+int mraa_set_priority(const unsigned int priority);
 
-/** Get the version string of maa autogenerated from git tag
+/** Get the version string of mraa autogenerated from git tag
  *
  * The version returned may not be what is expected however it is a reliable
  * number associated with the git tag closest to that version at build time
  *
  * @return version string from version.h
  */
-const char* maa_get_version();
+const char* mraa_get_version();
 
 /**
- * Print a textual representation of the maa_result_t
+ * Print a textual representation of the mraa_result_t
  *
  * @param result the result to print
  */
-void maa_result_print(maa_result_t result);
+void mraa_result_print(mraa_result_t result);
 
 /**
  * Get platform type, board must be initialised.
  *
- * @return maa_platform_t Platform type enum
+ * @return mraa_platform_t Platform type enum
  */
-maa_platform_t maa_get_platform_type();
+mraa_platform_t mraa_get_platform_type();
 
 #ifdef __cplusplus
 }