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

WiconnectSerial.cpp@29:b6af04b77a56, 2014-10-27 (annotated)

Committer:
dan_ackme
Date:
Mon Oct 27 13:42:26 2014 -0700
Revision:
29:b6af04b77a56
Child:
33:9b690d76eedf
Child:
36:a30cbf4bdb13
refactored library layout

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
dan_ackme 29:b6af04b77a56 30 #include "Wiconnect.h"
dan_ackme 29:b6af04b77a56 31 #include "internal/common.h"
dan_ackme 29:b6af04b77a56 32
dan_ackme 29:b6af04b77a56 33 #ifndef WICONNECT_SERIAL_RX_BUFFER
dan_ackme 29:b6af04b77a56 34 #error WICONNECT_SERIAL_RX_BUFFER NOT defined NOT currently supported
dan_ackme 29:b6af04b77a56 35 #endif
dan_ackme 29:b6af04b77a56 36
dan_ackme 29:b6af04b77a56 37
dan_ackme 29:b6af04b77a56 38
dan_ackme 29:b6af04b77a56 39
dan_ackme 29:b6af04b77a56 40 typedef struct
dan_ackme 29:b6af04b77a56 41 {
dan_ackme 29:b6af04b77a56 42 uint16_t size;
dan_ackme 29:b6af04b77a56 43 volatile uint16_t count;
dan_ackme 29:b6af04b77a56 44 uint8_t *start, *end;
dan_ackme 29:b6af04b77a56 45 volatile uint8_t *head;
dan_ackme 29:b6af04b77a56 46 volatile uint8_t *tail;
dan_ackme 29:b6af04b77a56 47 } SerialRxBuffer;
dan_ackme 29:b6af04b77a56 48
dan_ackme 29:b6af04b77a56 49
dan_ackme 29:b6af04b77a56 50 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 51 WiconnectSerial::WiconnectSerial(const SerialConfig &config, Wiconnect *wiconnect) : RawSerial(config.tx, config.rx)
dan_ackme 29:b6af04b77a56 52 {
dan_ackme 29:b6af04b77a56 53 ct_assert(sizeof(ringBuffer) >= sizeof(SerialRxBuffer));
dan_ackme 29:b6af04b77a56 54
dan_ackme 29:b6af04b77a56 55 baud(config.baud);
dan_ackme 29:b6af04b77a56 56
dan_ackme 29:b6af04b77a56 57 SerialRxBuffer *rxBuffer = (SerialRxBuffer*)ringBuffer;
dan_ackme 29:b6af04b77a56 58 memset(rxBuffer, 0, sizeof(SerialRxBuffer));
dan_ackme 29:b6af04b77a56 59 bufferAlloc = false;
dan_ackme 29:b6af04b77a56 60 if(config.serialRxBufferSize > 0)
dan_ackme 29:b6af04b77a56 61 {
dan_ackme 29:b6af04b77a56 62 if(config.serialRxBuffer != NULL)
dan_ackme 29:b6af04b77a56 63 {
dan_ackme 29:b6af04b77a56 64 rxBuffer->start = (uint8_t*)config.serialRxBuffer;
dan_ackme 29:b6af04b77a56 65 }
dan_ackme 29:b6af04b77a56 66 #ifdef WICONNECT_ENABLE_MALLOC
dan_ackme 29:b6af04b77a56 67 else
dan_ackme 29:b6af04b77a56 68 {
dan_ackme 29:b6af04b77a56 69 wiconnect_assert(wiconnect, "WiconnectSerial(), malloc not defined", wiconnect->_malloc != NULL);
dan_ackme 29:b6af04b77a56 70 rxBuffer->start = (uint8_t*)wiconnect->_malloc(config.serialRxBufferSize);
dan_ackme 29:b6af04b77a56 71 wiconnect_assert(wiconnect, "WiconnectSerial(), malloc failed", rxBuffer->start != NULL);
dan_ackme 29:b6af04b77a56 72 bufferAlloc = true;
dan_ackme 29:b6af04b77a56 73 }
dan_ackme 29:b6af04b77a56 74 #endif
dan_ackme 29:b6af04b77a56 75 rxBuffer->head = rxBuffer->tail = (volatile uint8_t*)rxBuffer->start;
dan_ackme 29:b6af04b77a56 76 rxBuffer->end = (uint8_t*)rxBuffer->head + config.serialRxBufferSize;
dan_ackme 29:b6af04b77a56 77 rxBuffer->size = config.serialRxBufferSize;
dan_ackme 29:b6af04b77a56 78 attach(this, &WiconnectSerial::rxIrqHandler, SerialBase::RxIrq);
dan_ackme 29:b6af04b77a56 79 }
dan_ackme 29:b6af04b77a56 80 }
dan_ackme 29:b6af04b77a56 81
dan_ackme 29:b6af04b77a56 82 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 83 WiconnectSerial::~WiconnectSerial()
dan_ackme 29:b6af04b77a56 84 {
dan_ackme 29:b6af04b77a56 85 #ifdef WICONNECT_ENABLE_MALLOC
dan_ackme 29:b6af04b77a56 86 if(bufferAlloc)
dan_ackme 29:b6af04b77a56 87 {
dan_ackme 29:b6af04b77a56 88 SerialRxBuffer *rxBuffer = (SerialRxBuffer*)ringBuffer;
dan_ackme 29:b6af04b77a56 89 Wiconnect::getInstance()->_free(rxBuffer->start);
dan_ackme 29:b6af04b77a56 90 }
dan_ackme 29:b6af04b77a56 91 #endif
dan_ackme 29:b6af04b77a56 92 }
dan_ackme 29:b6af04b77a56 93
dan_ackme 29:b6af04b77a56 94 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 95 void WiconnectSerial::initialize(void)
dan_ackme 29:b6af04b77a56 96 {
dan_ackme 29:b6af04b77a56 97 }
dan_ackme 29:b6af04b77a56 98
dan_ackme 29:b6af04b77a56 99 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 100 void WiconnectSerial::flush(void)
dan_ackme 29:b6af04b77a56 101 {
dan_ackme 29:b6af04b77a56 102 while (readable())
dan_ackme 29:b6af04b77a56 103 {
dan_ackme 29:b6af04b77a56 104 int c = getc();
dan_ackme 29:b6af04b77a56 105 }
dan_ackme 29:b6af04b77a56 106
dan_ackme 29:b6af04b77a56 107 SerialRxBuffer *rxBuffer = (SerialRxBuffer*)ringBuffer;
dan_ackme 29:b6af04b77a56 108 rxBuffer->tail = rxBuffer->head = rxBuffer->start;
dan_ackme 29:b6af04b77a56 109 rxBuffer->count = 0;
dan_ackme 29:b6af04b77a56 110 }
dan_ackme 29:b6af04b77a56 111
dan_ackme 29:b6af04b77a56 112 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 113 int WiconnectSerial::write(const void *data, int bytesToWrite, TimerTimeout timeoutMs)
dan_ackme 29:b6af04b77a56 114 {
dan_ackme 29:b6af04b77a56 115 uint8_t *ptr = (uint8_t*)data;
dan_ackme 29:b6af04b77a56 116 int remaining = bytesToWrite;
dan_ackme 29:b6af04b77a56 117
dan_ackme 29:b6af04b77a56 118 while(remaining > 0)
dan_ackme 29:b6af04b77a56 119 {
dan_ackme 29:b6af04b77a56 120 if(!writeable())
dan_ackme 29:b6af04b77a56 121 {
dan_ackme 29:b6af04b77a56 122 timeoutTimer.reset();
dan_ackme 29:b6af04b77a56 123 while(!writeable())
dan_ackme 29:b6af04b77a56 124 {
dan_ackme 29:b6af04b77a56 125 if(timeoutMs == 0)
dan_ackme 29:b6af04b77a56 126 {
dan_ackme 29:b6af04b77a56 127 if(timeoutTimer.readMs() > 0)
dan_ackme 29:b6af04b77a56 128 {
dan_ackme 29:b6af04b77a56 129 goto exit;
dan_ackme 29:b6af04b77a56 130 }
dan_ackme 29:b6af04b77a56 131 }
dan_ackme 29:b6af04b77a56 132 else
dan_ackme 29:b6af04b77a56 133 {
dan_ackme 29:b6af04b77a56 134 if(timeoutTimer.readMs() >= timeoutMs)
dan_ackme 29:b6af04b77a56 135 {
dan_ackme 29:b6af04b77a56 136 goto exit;
dan_ackme 29:b6af04b77a56 137 }
dan_ackme 29:b6af04b77a56 138 }
dan_ackme 29:b6af04b77a56 139 }
dan_ackme 29:b6af04b77a56 140 }
dan_ackme 29:b6af04b77a56 141
dan_ackme 29:b6af04b77a56 142 putc(*ptr);
dan_ackme 29:b6af04b77a56 143 ++ptr;
dan_ackme 29:b6af04b77a56 144 --remaining;
dan_ackme 29:b6af04b77a56 145 }
dan_ackme 29:b6af04b77a56 146
dan_ackme 29:b6af04b77a56 147 exit:
dan_ackme 29:b6af04b77a56 148 return bytesToWrite - remaining;
dan_ackme 29:b6af04b77a56 149 }
dan_ackme 29:b6af04b77a56 150
dan_ackme 29:b6af04b77a56 151 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 152 int WiconnectSerial::read(void *data, int bytesToRead, TimerTimeout timeoutMs)
dan_ackme 29:b6af04b77a56 153 {
dan_ackme 29:b6af04b77a56 154 SerialRxBuffer *rxBuffer = (SerialRxBuffer*)ringBuffer;
dan_ackme 29:b6af04b77a56 155 uint8_t *ptr = (uint8_t*)data;
dan_ackme 29:b6af04b77a56 156 int remaining = bytesToRead;
dan_ackme 29:b6af04b77a56 157
dan_ackme 29:b6af04b77a56 158 while(remaining > 0)
dan_ackme 29:b6af04b77a56 159 {
dan_ackme 29:b6af04b77a56 160 if(rxBuffer->count == 0)
dan_ackme 29:b6af04b77a56 161 {
dan_ackme 29:b6af04b77a56 162 if(timeoutMs == 0)
dan_ackme 29:b6af04b77a56 163 {
dan_ackme 29:b6af04b77a56 164 break;
dan_ackme 29:b6af04b77a56 165 }
dan_ackme 29:b6af04b77a56 166 else
dan_ackme 29:b6af04b77a56 167 {
dan_ackme 29:b6af04b77a56 168 timeoutTimer.reset();
dan_ackme 29:b6af04b77a56 169 while(rxBuffer->count == 0)
dan_ackme 29:b6af04b77a56 170 {
dan_ackme 29:b6af04b77a56 171 if(timeoutTimer.readMs() >= timeoutMs)
dan_ackme 29:b6af04b77a56 172 {
dan_ackme 29:b6af04b77a56 173 goto exit;
dan_ackme 29:b6af04b77a56 174 }
dan_ackme 29:b6af04b77a56 175 }
dan_ackme 29:b6af04b77a56 176 }
dan_ackme 29:b6af04b77a56 177 }
dan_ackme 29:b6af04b77a56 178
dan_ackme 29:b6af04b77a56 179 *ptr++ = *rxBuffer->tail++;
dan_ackme 29:b6af04b77a56 180 --remaining;
dan_ackme 29:b6af04b77a56 181 --rxBuffer->count;
dan_ackme 29:b6af04b77a56 182 if(rxBuffer->tail >= rxBuffer->end)
dan_ackme 29:b6af04b77a56 183 rxBuffer->tail = rxBuffer->start;
dan_ackme 29:b6af04b77a56 184 }
dan_ackme 29:b6af04b77a56 185
dan_ackme 29:b6af04b77a56 186 exit:
dan_ackme 29:b6af04b77a56 187 return bytesToRead - remaining;
dan_ackme 29:b6af04b77a56 188 }
dan_ackme 29:b6af04b77a56 189
dan_ackme 29:b6af04b77a56 190 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 191 void WiconnectSerial::rxIrqHandler(void)
dan_ackme 29:b6af04b77a56 192 {
dan_ackme 29:b6af04b77a56 193 SerialRxBuffer *rxBuffer = (SerialRxBuffer*)ringBuffer;
dan_ackme 29:b6af04b77a56 194
dan_ackme 29:b6af04b77a56 195 while (readable() && rxBuffer->count < rxBuffer->size)
dan_ackme 29:b6af04b77a56 196 {
dan_ackme 29:b6af04b77a56 197 *rxBuffer->head++ = (uint8_t)getc();
dan_ackme 29:b6af04b77a56 198 ++rxBuffer->count;
dan_ackme 29:b6af04b77a56 199 if(rxBuffer->head >= rxBuffer->end)
dan_ackme 29:b6af04b77a56 200 rxBuffer->head = rxBuffer->start;
dan_ackme 29:b6af04b77a56 201 }
dan_ackme 29:b6af04b77a56 202 }