Added platform/toolchain.h toolchain abstraction layer via macros. (#107)

* Added platform/toolchain.h toolchain abstraction layer via macros: OT_TOOL_PACKED_BEGIN OT_TOOL_PACKED_END OT_TOOL_DEPRECATED(symbol) * Make pretty. Rekick travis-ci. * Added doxygen. Resolved review comments. * Fixed doxygen sample for OT_TOOL_PACKED to include type name. * Renamed OT_TOOL_PACKED_FIELD to simplify code searches for usage. Fixed all nested instances to use new naming. * Fixed OT_TOOL_PACKED_FIELD renaming in doxygen. * Make pretty. * Documentation clarifications. * Moved example into overview section. * Fixed sdcc comment. * Revised sdcc comment. * Fix code style in toolchain packed doxygen example. * Fixed example. Moved toolchain test to better match code style. * Added test for OT_TOOL_PACKED_FIELD. * Added support for clang. Just routes to gcc __attributes__. Verified by running unit test through clang on macos.
2026-08-20 01:19:51 +00:00 · 2016-06-11 21:35:52 -07:00
parent d80adac415
commit 3576322262
17 changed files with 369 additions and 55 deletions
@@ -0,0 +1,98 @@
+/*
+ *  Copyright (c) 2016, Nest Labs, Inc.
+ *  All rights reserved.
+ *
+ *  Redistribution and use in source and binary forms, with or without
+ *  modification, are permitted provided that the following conditions are met:
+ *  1. Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ *  2. Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in the
+ *     documentation and/or other materials provided with the distribution.
+ *  3. Neither the name of the copyright holder nor the
+ *     names of its contributors may be used to endorse or promote products
+ *     derived from this software without specific prior written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ *  POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <stdio.h>
+#include <stdint.h>
+#include <platform/toolchain.h>
+#include "test_util.h"
+
+void test_packed1()
+{
+    typedef OT_TOOL_PACKED_BEGIN struct
+    {
+        uint8_t  mByte;
+        uint32_t mWord;
+        uint16_t mShort;
+    } OT_TOOL_PACKED_END packed_t;
+
+    VerifyOrQuit(sizeof(packed_t) == 7, "Toolchain::OT_TOOL_PACKED failed 1\n");
+}
+
+void test_packed2()
+{
+    typedef OT_TOOL_PACKED_BEGIN struct
+    {
+        uint8_t mBytes[3];
+        uint8_t mByte;
+    } OT_TOOL_PACKED_END packed_t;
+
+    VerifyOrQuit(sizeof(packed_t) == 4, "Toolchain::OT_TOOL_PACKED failed 2\n");
+}
+
+void test_packed_union()
+{
+    typedef struct
+    {
+        uint16_t mField;
+    } nested_t;
+
+    typedef OT_TOOL_PACKED_BEGIN struct
+    {
+        uint8_t mBytes[3];
+        union
+        {
+            nested_t mNestedStruct;
+            uint8_t  mByte;
+        } OT_TOOL_PACKED_FIELD;
+    } OT_TOOL_PACKED_END packed_t;
+
+    VerifyOrQuit(sizeof(packed_t) == 5, "Toolchain::OT_TOOL_PACKED failed 3\n");
+}
+
+int test_deprecated() OT_TOOL_DEPRECATED(test_deprecated);
+
+int test_deprecated()
+{
+    return 0;
+}
+
+void TestToolchain(void)
+{
+    test_packed1();
+    test_packed2();
+    test_packed_union();
+
+    SuccessOrQuit(test_deprecated(), "Toolchain::OT_TOOL_DEPRECATED failed\n");
+}
+
+int main(void)
+{
+    TestToolchain();
+    printf("All tests passed\n");
+    return 0;
+}