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@16:7f1d6d359787, 2014-08-13 (annotated)

Committer:
dan_ackme
Date:
Wed Aug 13 04:41:04 2014 -0700
Revision:
16:7f1d6d359787
Parent:
6:8a87a59d0d21
Child:
17:7268f365676b
updated documentation and copyright

Who changed what in which revision?

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