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@42:8ffb253b09e7, 2015-09-28 (annotated)

Committer:
aymangrais
Date:
Mon Sep 28 03:38:43 2015 +0000
Revision:
42:8ffb253b09e7
Parent:
29:b6af04b77a56 
increase ota timeout to be 5 seconds (instead of 1.5 sec)

Who changed what in which revision?

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