CHRE API: Document float/double requirements
We had never established our requirements and guidelines around
floats and doubles. We add that to the documentation.
Bug: 32074294
Change-Id: I1d01295286c4a0266b20171e57bed84abfdad1cb
diff --git a/inc/chre.h b/inc/chre.h
index 0f2f8ca..3cad893 100644
--- a/inc/chre.h
+++ b/inc/chre.h
@@ -114,6 +114,22 @@
*/
/**
+ * Floating point support.
+ *
+ * The C type 'float' is used in this API, and thus a CHRE implementation
+ * is required to support 'float's.
+ *
+ * Support of the C types 'double' and 'long double' is optional for a
+ * CHRE implementation. Note that if a CHRE decides to support them, unlike
+ * 'float' support, there is no requirement that this support is particularly
+ * efficient. So nanoapp authors should be aware this may be inefficient.
+ *
+ * If a CHRE implementation choses not to support 'double' or
+ * 'long double', then the build toolchain setup provided needs to set
+ * the preprocessor define CHRE_NO_DOUBLE_SUPPORT.
+ */
+
+/**
* CHRE and Nanoapp compatibility.
*
* The Android N release introduces the first version of this API.
