ACKme / WiConnect

Host library for controlling a WiConnect enabled Wi-Fi module.

Dependents:   wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more

internal/common.h@27:b63f5a9cdefa, 2014-10-23 (annotated)

Committer:
dan_ackme
Date:
Thu Oct 23 15:21:50 2014 -0700
Revision:
27:b63f5a9cdefa
Parent:
26:8067e3d463d3
Parent:
24:e27e23297f02 
Merge

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 24:e27e23297f02 1 /**
dan_ackme 24:e27e23297f02 2 * ACKme WiConnect Host Library is licensed under the BSD licence:
dan_ackme 24:e27e23297f02 3 *
dan_ackme 24:e27e23297f02 4 * Copyright (c)2014 ACKme Networks.
dan_ackme 24:e27e23297f02 5 * All rights reserved.
dan_ackme 24:e27e23297f02 6 *
dan_ackme 24:e27e23297f02 7 * Redistribution and use in source and binary forms, with or without modification,
dan_ackme 24:e27e23297f02 8 * are permitted provided that the following conditions are met:
dan_ackme 24:e27e23297f02 9 *
dan_ackme 24:e27e23297f02 10 * 1. Redistributions of source code must retain the above copyright notice,
dan_ackme 24:e27e23297f02 11 * this list of conditions and the following disclaimer.
dan_ackme 24:e27e23297f02 12 * 2. Redistributions in binary form must reproduce the above copyright notice,
dan_ackme 24:e27e23297f02 13 * this list of conditions and the following disclaimer in the documentation
dan_ackme 24:e27e23297f02 14 * and/or other materials provided with the distribution.
dan_ackme 24:e27e23297f02 15 * 3. The name of the author may not be used to endorse or promote products
dan_ackme 24:e27e23297f02 16 * derived from this software without specific prior written permission.
dan_ackme 24:e27e23297f02 17 *
dan_ackme 24:e27e23297f02 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS AND ANY EXPRESS OR IMPLIED
dan_ackme 24:e27e23297f02 19 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
dan_ackme 24:e27e23297f02 20 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
dan_ackme 24:e27e23297f02 21 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
dan_ackme 24:e27e23297f02 22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
dan_ackme 24:e27e23297f02 23 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
dan_ackme 24:e27e23297f02 24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
dan_ackme 24:e27e23297f02 25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
dan_ackme 24:e27e23297f02 26 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
dan_ackme 24:e27e23297f02 27 * OF SUCH DAMAGE.
dan_ackme 0:ea85c4bb5e1f 28 */
dan_ackme 24:e27e23297f02 29 #ifndef _COMMON_H_
dan_ackme 17:7268f365676b 30 #define _COMMON_H_
dan_ackme 0:ea85c4bb5e1f 31
dan_ackme 0:ea85c4bb5e1f 32
dan_ackme 24:e27e23297f02 33 #include "WiconnectCommands.h"
dan_ackme 24:e27e23297f02 34
dan_ackme 17:7268f365676b 35
dan_ackme 0:ea85c4bb5e1f 36
dan_ackme 0:ea85c4bb5e1f 37 /* Note we need the 2 concats below because arguments to ##
dan_ackme 0:ea85c4bb5e1f 38 * are not expanded, so we need to expand __LINE__ with one indirection
dan_ackme 0:ea85c4bb5e1f 39 * before doing the actual concatenation. */
dan_ackme 17:7268f365676b 40 #define ASSERT_CONCAT_(a, b) a ## b
dan_ackme 0:ea85c4bb5e1f 41 #define ASSERT_CONCAT(a, b) ASSERT_CONCAT_(a, b)
dan_ackme 0:ea85c4bb5e1f 42 #define ct_assert(e) enum { ASSERT_CONCAT(assert_line_, __LINE__) = 1/(!!(e)) }
dan_ackme 0:ea85c4bb5e1f 43
dan_ackme 6:8a87a59d0d21 44 #define wiconnect_assert(_wiconnect, msg, expr) if(!(expr)){_wiconnect->assertLogger.call(msg); for(;;); }
dan_ackme 6:8a87a59d0d21 45
dan_ackme 6:8a87a59d0d21 46
dan_ackme 0:ea85c4bb5e1f 47
dan_ackme 0:ea85c4bb5e1f 48 #ifndef WICONNECT_ASYNC_TIMER_ENABLED
dan_ackme 0:ea85c4bb5e1f 49 #define CHECK_CALLBACK_AVAILABLE(cb) if(cb.isValid()) return WICONNECT_UNSUPPORTED
dan_ackme 0:ea85c4bb5e1f 50 #else
dan_ackme 0:ea85c4bb5e1f 51 #define CHECK_CALLBACK_AVAILABLE(cb)
dan_ackme 0:ea85c4bb5e1f 52 #endif
dan_ackme 0:ea85c4bb5e1f 53
dan_ackme 2:05e20e184e7e 54 #define UNUSED(expr) do { (void)(expr); } while (0)
dan_ackme 2:05e20e184e7e 55
dan_ackme 0:ea85c4bb5e1f 56 #define CHECK_CLEANUP_COMMAND() \
dan_ackme 0:ea85c4bb5e1f 57 if(result != WICONNECT_PROCESSING) \
dan_ackme 0:ea85c4bb5e1f 58 { \
dan_ackme 0:ea85c4bb5e1f 59 wiconnect->internalProcessingState = 0; \
dan_ackme 0:ea85c4bb5e1f 60 wiconnect->currentCommandId = NULL; \
dan_ackme 0:ea85c4bb5e1f 61 }
dan_ackme 0:ea85c4bb5e1f 62
dan_ackme 0:ea85c4bb5e1f 63 #define CHECK_OTHER_COMMAND_EXECUTING() \
dan_ackme 0:ea85c4bb5e1f 64 { \
dan_ackme 0:ea85c4bb5e1f 65 static const volatile uint8_t __funcId = 0; \
dan_ackme 0:ea85c4bb5e1f 66 if(wiconnect->currentCommandId == NULL) \
dan_ackme 0:ea85c4bb5e1f 67 { \
dan_ackme 0:ea85c4bb5e1f 68 wiconnect->currentCommandId = (void*)&__funcId; \
dan_ackme 0:ea85c4bb5e1f 69 } \
dan_ackme 0:ea85c4bb5e1f 70 else if(wiconnect->currentCommandId != (void*)&__funcId) \
dan_ackme 0:ea85c4bb5e1f 71 { \
dan_ackme 0:ea85c4bb5e1f 72 return WICONNECT_ANOTHER_CMD_EXECUTING; \
dan_ackme 0:ea85c4bb5e1f 73 } \
dan_ackme 0:ea85c4bb5e1f 74 }
dan_ackme 26:8067e3d463d3 75
dan_ackme 26:8067e3d463d3 76 #define _CHECK_CLEANUP_COMMAND() \
dan_ackme 26:8067e3d463d3 77 if(result != WICONNECT_PROCESSING) \
dan_ackme 26:8067e3d463d3 78 { \
dan_ackme 26:8067e3d463d3 79 internalProcessingState = 0; \
dan_ackme 26:8067e3d463d3 80 currentCommandId = NULL; \
dan_ackme 26:8067e3d463d3 81 }
dan_ackme 26:8067e3d463d3 82
dan_ackme 26:8067e3d463d3 83 #define _CHECK_OTHER_COMMAND_EXECUTING() \
dan_ackme 26:8067e3d463d3 84 { \
dan_ackme 26:8067e3d463d3 85 static const volatile uint8_t __funcId = 0; \
dan_ackme 26:8067e3d463d3 86 if(currentCommandId == NULL) \
dan_ackme 26:8067e3d463d3 87 { \
dan_ackme 26:8067e3d463d3 88 currentCommandId = (void*)&__funcId; \
dan_ackme 26:8067e3d463d3 89 } \
dan_ackme 26:8067e3d463d3 90 else if(currentCommandId != (void*)&__funcId) \
dan_ackme 26:8067e3d463d3 91 { \
dan_ackme 26:8067e3d463d3 92 return WICONNECT_ANOTHER_CMD_EXECUTING; \
dan_ackme 26:8067e3d463d3 93 } \
dan_ackme 26:8067e3d463d3 94 }
dan_ackme 0:ea85c4bb5e1f 95
dan_ackme 0:ea85c4bb5e1f 96 #define WICONNECT_IS_IDLE() (wiconnect->currentCommandId == NULL)
dan_ackme 26:8067e3d463d3 97 #define _WICONNECT_IS_IDLE() (currentCommandId == NULL)
dan_ackme 0:ea85c4bb5e1f 98
dan_ackme 0:ea85c4bb5e1f 99
dan_ackme 0:ea85c4bb5e1f 100
dan_ackme 0:ea85c4bb5e1f 101 #ifdef WICONNECT_USE_DEFAULT_STRING_BUFFERS
dan_ackme 0:ea85c4bb5e1f 102 #define SET_STR_BUFFER(_buffer, size) \
dan_ackme 3:2dc2592bae5e 103 char *ptr; \
dan_ackme 0:ea85c4bb5e1f 104 static char defaultBuffer[size]; \
dan_ackme 3:2dc2592bae5e 105 ptr = (_buffer == NULL) ? defaultBuffer : _buffer;
dan_ackme 0:ea85c4bb5e1f 106 #else
dan_ackme 0:ea85c4bb5e1f 107 #define SET_STR_BUFFER(_buffer, size) \
dan_ackme 3:2dc2592bae5e 108 char *ptr; \
dan_ackme 0:ea85c4bb5e1f 109 if(_buffer == NULL) \
dan_ackme 0:ea85c4bb5e1f 110 { \
dan_ackme 0:ea85c4bb5e1f 111 return "<null>"; \
dan_ackme 0:ea85c4bb5e1f 112 } \
dan_ackme 3:2dc2592bae5e 113 ptr = _buffer;
dan_ackme 0:ea85c4bb5e1f 114 #endif
dan_ackme 24:e27e23297f02 115
dan_ackme 24:e27e23297f02 116
dan_ackme 24:e27e23297f02 117 #endif