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
sdk/mbed/WiconnectSerial.cpp@17:7268f365676b, 2014-08-23 (annotated)
- Committer:
- dan_ackme
- Date:
- Sat Aug 23 05:39:17 2014 -0700
- Revision:
- 17:7268f365676b
- Parent:
- 16:7f1d6d359787
Fixes and documentation updates
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
dan_ackme | 17:7268f365676b | 1 | /** |
dan_ackme | 17:7268f365676b | 2 | * ACKme WiConnect Host Library is licensed under the BSD licence: |
dan_ackme | 17:7268f365676b | 3 | * |
dan_ackme | 17:7268f365676b | 4 | * Copyright (c)2014 ACKme Networks. |
dan_ackme | 17:7268f365676b | 5 | * All rights reserved. |
dan_ackme | 17:7268f365676b | 6 | * |
dan_ackme | 17:7268f365676b | 7 | * Redistribution and use in source and binary forms, with or without modification, |
dan_ackme | 17:7268f365676b | 8 | * are permitted provided that the following conditions are met: |
dan_ackme | 17:7268f365676b | 9 | * |
dan_ackme | 17:7268f365676b | 10 | * 1. Redistributions of source code must retain the above copyright notice, |
dan_ackme | 17:7268f365676b | 11 | * this list of conditions and the following disclaimer. |
dan_ackme | 17:7268f365676b | 12 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
dan_ackme | 17:7268f365676b | 13 | * this list of conditions and the following disclaimer in the documentation |
dan_ackme | 17:7268f365676b | 14 | * and/or other materials provided with the distribution. |
dan_ackme | 17:7268f365676b | 15 | * 3. The name of the author may not be used to endorse or promote products |
dan_ackme | 17:7268f365676b | 16 | * derived from this software without specific prior written permission. |
dan_ackme | 17:7268f365676b | 17 | * |
dan_ackme | 17:7268f365676b | 18 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS AND ANY EXPRESS OR IMPLIED |
dan_ackme | 17:7268f365676b | 19 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
dan_ackme | 17:7268f365676b | 20 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT |
dan_ackme | 17:7268f365676b | 21 | * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
dan_ackme | 17:7268f365676b | 22 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT |
dan_ackme | 17:7268f365676b | 23 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
dan_ackme | 17:7268f365676b | 24 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
dan_ackme | 17:7268f365676b | 25 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
dan_ackme | 17:7268f365676b | 26 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY |
dan_ackme | 17:7268f365676b | 27 | * OF SUCH DAMAGE. |
dan_ackme | 0:ea85c4bb5e1f | 28 | */ |
dan_ackme | 0:ea85c4bb5e1f | 29 | |
dan_ackme | 0:ea85c4bb5e1f | 30 | #include "Wiconnect.h" |
dan_ackme | 0:ea85c4bb5e1f | 31 | #include "internal/common.h" |
dan_ackme | 0:ea85c4bb5e1f | 32 | |
dan_ackme | 0:ea85c4bb5e1f | 33 | #ifndef WICONNECT_SERIAL_RX_BUFFER |
dan_ackme | 0:ea85c4bb5e1f | 34 | #error WICONNECT_SERIAL_RX_BUFFER NOT defined NOT currently supported |
dan_ackme | 0:ea85c4bb5e1f | 35 | #endif |
dan_ackme | 0:ea85c4bb5e1f | 36 | |
dan_ackme | 0:ea85c4bb5e1f | 37 | |
dan_ackme | 0:ea85c4bb5e1f | 38 | |
dan_ackme | 0:ea85c4bb5e1f | 39 | |
dan_ackme | 0:ea85c4bb5e1f | 40 | typedef struct |
dan_ackme | 0:ea85c4bb5e1f | 41 | { |
dan_ackme | 0:ea85c4bb5e1f | 42 | uint16_t size; |
dan_ackme | 6:8a87a59d0d21 | 43 | volatile uint16_t count; |
dan_ackme | 0:ea85c4bb5e1f | 44 | uint8_t *start, *end; |
dan_ackme | 0:ea85c4bb5e1f | 45 | volatile uint8_t *head; |
dan_ackme | 0:ea85c4bb5e1f | 46 | volatile uint8_t *tail; |
dan_ackme | 0:ea85c4bb5e1f | 47 | } SerialRxBuffer; |
dan_ackme | 0:ea85c4bb5e1f | 48 | |
dan_ackme | 0:ea85c4bb5e1f | 49 | |
dan_ackme | 0:ea85c4bb5e1f | 50 | /*************************************************************************************************/ |
dan_ackme | 0:ea85c4bb5e1f | 51 | WiconnectSerial::WiconnectSerial(const SerialConfig &config, Wiconnect *wiconnect) : RawSerial(config.tx, config.rx) |
dan_ackme | 0:ea85c4bb5e1f | 52 | { |
dan_ackme | 0:ea85c4bb5e1f | 53 | ct_assert(sizeof(ringBuffer) >= sizeof(SerialRxBuffer)); |
dan_ackme | 0:ea85c4bb5e1f | 54 | |
dan_ackme | 0:ea85c4bb5e1f | 55 | baud(config.baud); |
dan_ackme | 0:ea85c4bb5e1f | 56 | |
dan_ackme | 0:ea85c4bb5e1f | 57 | SerialRxBuffer *rxBuffer = (SerialRxBuffer*)ringBuffer; |
dan_ackme | 0:ea85c4bb5e1f | 58 | memset(rxBuffer, 0, sizeof(SerialRxBuffer)); |
dan_ackme | 0:ea85c4bb5e1f | 59 | bufferAlloc = false; |
dan_ackme | 0:ea85c4bb5e1f | 60 | if(config.serialRxBufferSize > 0) |
dan_ackme | 0:ea85c4bb5e1f | 61 | { |
dan_ackme | 0:ea85c4bb5e1f | 62 | if(config.serialRxBuffer != NULL) |
dan_ackme | 0:ea85c4bb5e1f | 63 | { |
dan_ackme | 6:8a87a59d0d21 | 64 | rxBuffer->start = (uint8_t*)config.serialRxBuffer; |
dan_ackme | 0:ea85c4bb5e1f | 65 | } |
dan_ackme | 0:ea85c4bb5e1f | 66 | #ifdef WICONNECT_ENABLE_MALLOC |
dan_ackme | 0:ea85c4bb5e1f | 67 | else |
dan_ackme | 0:ea85c4bb5e1f | 68 | { |
dan_ackme | 6:8a87a59d0d21 | 69 | wiconnect_assert(wiconnect, "WiconnectSerial(), malloc not defined", wiconnect->_malloc != NULL); |
dan_ackme | 0:ea85c4bb5e1f | 70 | rxBuffer->start = (uint8_t*)wiconnect->_malloc(config.serialRxBufferSize); |
dan_ackme | 6:8a87a59d0d21 | 71 | wiconnect_assert(wiconnect, "WiconnectSerial(), malloc failed", rxBuffer->start != NULL); |
dan_ackme | 0:ea85c4bb5e1f | 72 | bufferAlloc = true; |
dan_ackme | 0:ea85c4bb5e1f | 73 | } |
dan_ackme | 0:ea85c4bb5e1f | 74 | #endif |
dan_ackme | 0:ea85c4bb5e1f | 75 | rxBuffer->head = rxBuffer->tail = (volatile uint8_t*)rxBuffer->start; |
dan_ackme | 0:ea85c4bb5e1f | 76 | rxBuffer->end = (uint8_t*)rxBuffer->head + config.serialRxBufferSize; |
dan_ackme | 0:ea85c4bb5e1f | 77 | rxBuffer->size = config.serialRxBufferSize; |
dan_ackme | 0:ea85c4bb5e1f | 78 | attach(this, &WiconnectSerial::rxIrqHandler, SerialBase::RxIrq); |
dan_ackme | 0:ea85c4bb5e1f | 79 | } |
dan_ackme | 0:ea85c4bb5e1f | 80 | } |
dan_ackme | 0:ea85c4bb5e1f | 81 | |
dan_ackme | 0:ea85c4bb5e1f | 82 | /*************************************************************************************************/ |
dan_ackme | 0:ea85c4bb5e1f | 83 | WiconnectSerial::~WiconnectSerial() |
dan_ackme | 0:ea85c4bb5e1f | 84 | { |
dan_ackme | 0:ea85c4bb5e1f | 85 | #ifdef WICONNECT_ENABLE_MALLOC |
dan_ackme | 0:ea85c4bb5e1f | 86 | if(bufferAlloc) |
dan_ackme | 0:ea85c4bb5e1f | 87 | { |
dan_ackme | 0:ea85c4bb5e1f | 88 | SerialRxBuffer *rxBuffer = (SerialRxBuffer*)ringBuffer; |
dan_ackme | 0:ea85c4bb5e1f | 89 | Wiconnect::getInstance()->_free(rxBuffer->start); |
dan_ackme | 0:ea85c4bb5e1f | 90 | } |
dan_ackme | 0:ea85c4bb5e1f | 91 | #endif |
dan_ackme | 0:ea85c4bb5e1f | 92 | } |
dan_ackme | 0:ea85c4bb5e1f | 93 | |
dan_ackme | 0:ea85c4bb5e1f | 94 | /*************************************************************************************************/ |
dan_ackme | 0:ea85c4bb5e1f | 95 | void WiconnectSerial::flush(void) |
dan_ackme | 0:ea85c4bb5e1f | 96 | { |
dan_ackme | 0:ea85c4bb5e1f | 97 | while (readable()) |
dan_ackme | 0:ea85c4bb5e1f | 98 | { |
dan_ackme | 0:ea85c4bb5e1f | 99 | int c = getc(); |
dan_ackme | 0:ea85c4bb5e1f | 100 | } |
dan_ackme | 0:ea85c4bb5e1f | 101 | |
dan_ackme | 0:ea85c4bb5e1f | 102 | SerialRxBuffer *rxBuffer = (SerialRxBuffer*)ringBuffer; |
dan_ackme | 0:ea85c4bb5e1f | 103 | rxBuffer->tail = rxBuffer->head = rxBuffer->start; |
dan_ackme | 0:ea85c4bb5e1f | 104 | rxBuffer->count = 0; |
dan_ackme | 0:ea85c4bb5e1f | 105 | } |
dan_ackme | 0:ea85c4bb5e1f | 106 | |
dan_ackme | 0:ea85c4bb5e1f | 107 | /*************************************************************************************************/ |
dan_ackme | 0:ea85c4bb5e1f | 108 | int WiconnectSerial::write(const void *data, int bytesToWrite, int timeoutMs) |
dan_ackme | 0:ea85c4bb5e1f | 109 | { |
dan_ackme | 0:ea85c4bb5e1f | 110 | uint8_t *ptr = (uint8_t*)data; |
dan_ackme | 0:ea85c4bb5e1f | 111 | int remaining = bytesToWrite; |
dan_ackme | 0:ea85c4bb5e1f | 112 | |
dan_ackme | 0:ea85c4bb5e1f | 113 | while(remaining > 0) |
dan_ackme | 0:ea85c4bb5e1f | 114 | { |
dan_ackme | 0:ea85c4bb5e1f | 115 | if(!writeable()) |
dan_ackme | 0:ea85c4bb5e1f | 116 | { |
dan_ackme | 0:ea85c4bb5e1f | 117 | timeoutTimer.reset(); |
dan_ackme | 0:ea85c4bb5e1f | 118 | while(!writeable()) |
dan_ackme | 0:ea85c4bb5e1f | 119 | { |
dan_ackme | 0:ea85c4bb5e1f | 120 | if(timeoutMs == 0) |
dan_ackme | 0:ea85c4bb5e1f | 121 | { |
dan_ackme | 0:ea85c4bb5e1f | 122 | if(timeoutTimer.readUs() >= 500) |
dan_ackme | 0:ea85c4bb5e1f | 123 | { |
dan_ackme | 0:ea85c4bb5e1f | 124 | goto exit; |
dan_ackme | 0:ea85c4bb5e1f | 125 | } |
dan_ackme | 0:ea85c4bb5e1f | 126 | } |
dan_ackme | 0:ea85c4bb5e1f | 127 | else |
dan_ackme | 0:ea85c4bb5e1f | 128 | { |
dan_ackme | 0:ea85c4bb5e1f | 129 | if(timeoutTimer.readUs() >= timeoutMs*1000) |
dan_ackme | 0:ea85c4bb5e1f | 130 | { |
dan_ackme | 0:ea85c4bb5e1f | 131 | goto exit; |
dan_ackme | 0:ea85c4bb5e1f | 132 | } |
dan_ackme | 0:ea85c4bb5e1f | 133 | } |
dan_ackme | 0:ea85c4bb5e1f | 134 | } |
dan_ackme | 0:ea85c4bb5e1f | 135 | } |
dan_ackme | 0:ea85c4bb5e1f | 136 | |
dan_ackme | 0:ea85c4bb5e1f | 137 | putc(*ptr); |
dan_ackme | 0:ea85c4bb5e1f | 138 | ++ptr; |
dan_ackme | 0:ea85c4bb5e1f | 139 | --remaining; |
dan_ackme | 0:ea85c4bb5e1f | 140 | } |
dan_ackme | 0:ea85c4bb5e1f | 141 | |
dan_ackme | 0:ea85c4bb5e1f | 142 | exit: |
dan_ackme | 0:ea85c4bb5e1f | 143 | return bytesToWrite - remaining; |
dan_ackme | 0:ea85c4bb5e1f | 144 | } |
dan_ackme | 0:ea85c4bb5e1f | 145 | |
dan_ackme | 0:ea85c4bb5e1f | 146 | /*************************************************************************************************/ |
dan_ackme | 0:ea85c4bb5e1f | 147 | int WiconnectSerial::read(void *data, int bytesToRead, int timeoutMs) |
dan_ackme | 0:ea85c4bb5e1f | 148 | { |
dan_ackme | 0:ea85c4bb5e1f | 149 | SerialRxBuffer *rxBuffer = (SerialRxBuffer*)ringBuffer; |
dan_ackme | 0:ea85c4bb5e1f | 150 | uint8_t *ptr = (uint8_t*)data; |
dan_ackme | 0:ea85c4bb5e1f | 151 | int remaining = bytesToRead; |
dan_ackme | 0:ea85c4bb5e1f | 152 | |
dan_ackme | 0:ea85c4bb5e1f | 153 | while(remaining > 0) |
dan_ackme | 0:ea85c4bb5e1f | 154 | { |
dan_ackme | 0:ea85c4bb5e1f | 155 | if(rxBuffer->count == 0) |
dan_ackme | 0:ea85c4bb5e1f | 156 | { |
dan_ackme | 0:ea85c4bb5e1f | 157 | if(timeoutMs == 0) |
dan_ackme | 0:ea85c4bb5e1f | 158 | { |
dan_ackme | 0:ea85c4bb5e1f | 159 | break; |
dan_ackme | 0:ea85c4bb5e1f | 160 | } |
dan_ackme | 0:ea85c4bb5e1f | 161 | else |
dan_ackme | 0:ea85c4bb5e1f | 162 | { |
dan_ackme | 0:ea85c4bb5e1f | 163 | timeoutTimer.reset(); |
dan_ackme | 0:ea85c4bb5e1f | 164 | while(rxBuffer->count == 0) |
dan_ackme | 0:ea85c4bb5e1f | 165 | { |
dan_ackme | 0:ea85c4bb5e1f | 166 | if(timeoutTimer.readUs() >= timeoutMs*1000) |
dan_ackme | 0:ea85c4bb5e1f | 167 | { |
dan_ackme | 0:ea85c4bb5e1f | 168 | goto exit; |
dan_ackme | 0:ea85c4bb5e1f | 169 | } |
dan_ackme | 0:ea85c4bb5e1f | 170 | } |
dan_ackme | 0:ea85c4bb5e1f | 171 | } |
dan_ackme | 0:ea85c4bb5e1f | 172 | } |
dan_ackme | 0:ea85c4bb5e1f | 173 | |
dan_ackme | 0:ea85c4bb5e1f | 174 | *ptr++ = *rxBuffer->tail++; |
dan_ackme | 0:ea85c4bb5e1f | 175 | --remaining; |
dan_ackme | 0:ea85c4bb5e1f | 176 | --rxBuffer->count; |
dan_ackme | 0:ea85c4bb5e1f | 177 | if(rxBuffer->tail >= rxBuffer->end) |
dan_ackme | 0:ea85c4bb5e1f | 178 | rxBuffer->tail = rxBuffer->start; |
dan_ackme | 0:ea85c4bb5e1f | 179 | } |
dan_ackme | 0:ea85c4bb5e1f | 180 | |
dan_ackme | 0:ea85c4bb5e1f | 181 | exit: |
dan_ackme | 0:ea85c4bb5e1f | 182 | return bytesToRead - remaining; |
dan_ackme | 0:ea85c4bb5e1f | 183 | } |
dan_ackme | 0:ea85c4bb5e1f | 184 | |
dan_ackme | 0:ea85c4bb5e1f | 185 | /*************************************************************************************************/ |
dan_ackme | 0:ea85c4bb5e1f | 186 | void WiconnectSerial::rxIrqHandler(void) |
dan_ackme | 0:ea85c4bb5e1f | 187 | { |
dan_ackme | 0:ea85c4bb5e1f | 188 | SerialRxBuffer *rxBuffer = (SerialRxBuffer*)ringBuffer; |
dan_ackme | 0:ea85c4bb5e1f | 189 | |
dan_ackme | 0:ea85c4bb5e1f | 190 | while (readable() && rxBuffer->count < rxBuffer->size) |
dan_ackme | 0:ea85c4bb5e1f | 191 | { |
dan_ackme | 0:ea85c4bb5e1f | 192 | *rxBuffer->head++ = (uint8_t)getc(); |
dan_ackme | 0:ea85c4bb5e1f | 193 | ++rxBuffer->count; |
dan_ackme | 0:ea85c4bb5e1f | 194 | if(rxBuffer->head >= rxBuffer->end) |
dan_ackme | 0:ea85c4bb5e1f | 195 | rxBuffer->head = rxBuffer->start; |
dan_ackme | 0:ea85c4bb5e1f | 196 | } |
dan_ackme | 0:ea85c4bb5e1f | 197 | } |