Wilson Tang / Mbed OS HSP_RPC_GUI

Fork of the offical HSP_RPC_GUI firmware

Dependencies:   USBDevice

Fork of MAXREFDES100 firmware for MAX32620HSP

HSP/RpcServer/StringInOut.cpp@0:e4a10ed6eb92, 2016-10-25 (annotated)

Committer:
jbradshaw
Date:
Tue Oct 25 15:22:11 2016 +0000
Revision:
0:e4a10ed6eb92
Child:
1:9490836294ea
tewt

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jbradshaw 0:e4a10ed6eb92 1 /*******************************************************************************
jbradshaw 0:e4a10ed6eb92 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
jbradshaw 0:e4a10ed6eb92 3 *
jbradshaw 0:e4a10ed6eb92 4 * Permission is hereby granted, free of charge, to any person obtaining a
jbradshaw 0:e4a10ed6eb92 5 * copy of this software and associated documentation files (the "Software"),
jbradshaw 0:e4a10ed6eb92 6 * to deal in the Software without restriction, including without limitation
jbradshaw 0:e4a10ed6eb92 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
jbradshaw 0:e4a10ed6eb92 8 * and/or sell copies of the Software, and to permit persons to whom the
jbradshaw 0:e4a10ed6eb92 9 * Software is furnished to do so, subject to the following conditions:
jbradshaw 0:e4a10ed6eb92 10 *
jbradshaw 0:e4a10ed6eb92 11 * The above copyright notice and this permission notice shall be included
jbradshaw 0:e4a10ed6eb92 12 * in all copies or substantial portions of the Software.
jbradshaw 0:e4a10ed6eb92 13 *
jbradshaw 0:e4a10ed6eb92 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
jbradshaw 0:e4a10ed6eb92 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
jbradshaw 0:e4a10ed6eb92 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
jbradshaw 0:e4a10ed6eb92 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
jbradshaw 0:e4a10ed6eb92 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
jbradshaw 0:e4a10ed6eb92 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
jbradshaw 0:e4a10ed6eb92 20 * OTHER DEALINGS IN THE SOFTWARE.
jbradshaw 0:e4a10ed6eb92 21 *
jbradshaw 0:e4a10ed6eb92 22 * Except as contained in this notice, the name of Maxim Integrated
jbradshaw 0:e4a10ed6eb92 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
jbradshaw 0:e4a10ed6eb92 24 * Products, Inc. Branding Policy.
jbradshaw 0:e4a10ed6eb92 25 *
jbradshaw 0:e4a10ed6eb92 26 * The mere transfer of this software does not imply any licenses
jbradshaw 0:e4a10ed6eb92 27 * of trade secrets, proprietary technology, copyrights, patents,
jbradshaw 0:e4a10ed6eb92 28 * trademarks, maskwork rights, or any other form of intellectual
jbradshaw 0:e4a10ed6eb92 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
jbradshaw 0:e4a10ed6eb92 30 * ownership rights.
jbradshaw 0:e4a10ed6eb92 31 *******************************************************************************
jbradshaw 0:e4a10ed6eb92 32 */
jbradshaw 0:e4a10ed6eb92 33 #include "mbed.h"
jbradshaw 0:e4a10ed6eb92 34 #include "USBSerial.h"
jbradshaw 0:e4a10ed6eb92 35 #include "RpcFifo.h"
jbradshaw 0:e4a10ed6eb92 36 #include "RpcServer.h"
jbradshaw 0:e4a10ed6eb92 37 #include "StringInOut.h"
jbradshaw 0:e4a10ed6eb92 38 #include "Peripherals.h"
jbradshaw 0:e4a10ed6eb92 39
jbradshaw 0:e4a10ed6eb92 40 /// a running index that keeps track of where an incoming string has been
jbradshaw 0:e4a10ed6eb92 41 /// buffered to
jbradshaw 0:e4a10ed6eb92 42 static int lineBuffer_index = 0;
jbradshaw 0:e4a10ed6eb92 43 /// a flag that keeps track of the state of accumulating a string
jbradshaw 0:e4a10ed6eb92 44 static int getLine_State = GETLINE_WAITING;
jbradshaw 0:e4a10ed6eb92 45
jbradshaw 0:e4a10ed6eb92 46 /**
jbradshaw 0:e4a10ed6eb92 47 * @brief Place incoming USB characters into a fifo
jbradshaw 0:e4a10ed6eb92 48 * @param data_IN buffer of characters
jbradshaw 0:e4a10ed6eb92 49 * @param len length of data
jbradshaw 0:e4a10ed6eb92 50 */
jbradshaw 0:e4a10ed6eb92 51 int fifoIncomingChars(uint8_t data_IN[], unsigned int len) {
jbradshaw 0:e4a10ed6eb92 52 int i;
jbradshaw 0:e4a10ed6eb92 53 for (i = 0; i < len; i++) {
jbradshaw 0:e4a10ed6eb92 54 fifo_put8(GetUSBIncomingFifo(), data_IN[i]);
jbradshaw 0:e4a10ed6eb92 55 }
jbradshaw 0:e4a10ed6eb92 56 return 0;
jbradshaw 0:e4a10ed6eb92 57 }
jbradshaw 0:e4a10ed6eb92 58
jbradshaw 0:e4a10ed6eb92 59 /**
jbradshaw 0:e4a10ed6eb92 60 * @brief Check the USB incoming fifo to see if there is data to be read
jbradshaw 0:e4a10ed6eb92 61 * @return 1 if there is data to be read, 0 if data is not available
jbradshaw 0:e4a10ed6eb92 62 */
jbradshaw 0:e4a10ed6eb92 63 int isReadReady(void) {
jbradshaw 0:e4a10ed6eb92 64 if (fifo_empty(GetUSBIncomingFifo()) == 0)
jbradshaw 0:e4a10ed6eb92 65 return 1;
jbradshaw 0:e4a10ed6eb92 66 return 0;
jbradshaw 0:e4a10ed6eb92 67 }
jbradshaw 0:e4a10ed6eb92 68
jbradshaw 0:e4a10ed6eb92 69 /**
jbradshaw 0:e4a10ed6eb92 70 * @brief Clear the incoming USB read fifo
jbradshaw 0:e4a10ed6eb92 71 */
jbradshaw 0:e4a10ed6eb92 72 void clearOutReadFifo(void) { fifo_clear(GetUSBIncomingFifo()); }
jbradshaw 0:e4a10ed6eb92 73
jbradshaw 0:e4a10ed6eb92 74 /**
jbradshaw 0:e4a10ed6eb92 75 * @brief Block until a character can be read from the USB
jbradshaw 0:e4a10ed6eb92 76 * @return the character read
jbradshaw 0:e4a10ed6eb92 77 */
jbradshaw 0:e4a10ed6eb92 78 char getch(void) {
jbradshaw 0:e4a10ed6eb92 79 uint8_t ch;
jbradshaw 0:e4a10ed6eb92 80 // block until char is ready
jbradshaw 0:e4a10ed6eb92 81 while (isReadReady() == 0) {
jbradshaw 0:e4a10ed6eb92 82 }
jbradshaw 0:e4a10ed6eb92 83 // read a char from buffer
jbradshaw 0:e4a10ed6eb92 84 fifo_get8(GetUSBIncomingFifo(), &ch);
jbradshaw 0:e4a10ed6eb92 85 return ch;
jbradshaw 0:e4a10ed6eb92 86 }
jbradshaw 0:e4a10ed6eb92 87
jbradshaw 0:e4a10ed6eb92 88 /**
jbradshaw 0:e4a10ed6eb92 89 * @brief Place incoming USB characters into a fifo
jbradshaw 0:e4a10ed6eb92 90 * @param lineBuffer buffer to place the incoming characters
jbradshaw 0:e4a10ed6eb92 91 * @param bufferLength length of buffer
jbradshaw 0:e4a10ed6eb92 92 * @return GETLINE_WAITING if still waiting for a CRLF, GETLINE_DONE
jbradshaw 0:e4a10ed6eb92 93 */
jbradshaw 0:e4a10ed6eb92 94 int getLine(char *lineBuffer, int bufferLength) {
jbradshaw 0:e4a10ed6eb92 95 uint8_t ch;
jbradshaw 0:e4a10ed6eb92 96
jbradshaw 0:e4a10ed6eb92 97 USBSerial *serial = Peripherals::usbSerial();
jbradshaw 0:e4a10ed6eb92 98 if (getLine_State == GETLINE_DONE) {
jbradshaw 0:e4a10ed6eb92 99 getLine_State = GETLINE_WAITING;
jbradshaw 0:e4a10ed6eb92 100 }
jbradshaw 0:e4a10ed6eb92 101 if (serial->available() != 0) {
jbradshaw 0:e4a10ed6eb92 102 ch = serial->_getc();
jbradshaw 0:e4a10ed6eb92 103 if (ch != 0x0A && ch != 0x0D) {
jbradshaw 0:e4a10ed6eb92 104 lineBuffer[lineBuffer_index++] = ch;
jbradshaw 0:e4a10ed6eb92 105 }
jbradshaw 0:e4a10ed6eb92 106 if (ch == 0x0D) {
jbradshaw 0:e4a10ed6eb92 107 lineBuffer[lineBuffer_index++] = 0;
jbradshaw 0:e4a10ed6eb92 108 lineBuffer_index = 0;
jbradshaw 0:e4a10ed6eb92 109 getLine_State = GETLINE_DONE;
jbradshaw 0:e4a10ed6eb92 110 }
jbradshaw 0:e4a10ed6eb92 111 if (lineBuffer_index > bufferLength) {
jbradshaw 0:e4a10ed6eb92 112 lineBuffer[bufferLength - 1] = 0;
jbradshaw 0:e4a10ed6eb92 113 getLine_State = GETLINE_DONE;
jbradshaw 0:e4a10ed6eb92 114 }
jbradshaw 0:e4a10ed6eb92 115 }
jbradshaw 0:e4a10ed6eb92 116 return getLine_State;
jbradshaw 0:e4a10ed6eb92 117 }
jbradshaw 0:e4a10ed6eb92 118
jbradshaw 0:e4a10ed6eb92 119 /**
jbradshaw 0:e4a10ed6eb92 120 * @brief Block until a fixed number of characters has been accumulated from the
jbradshaw 0:e4a10ed6eb92 121 * incoming USB
jbradshaw 0:e4a10ed6eb92 122 * @param lineBuffer buffer to place the incoming characters
jbradshaw 0:e4a10ed6eb92 123 * @param maxLength length of buffer
jbradshaw 0:e4a10ed6eb92 124 */
jbradshaw 0:e4a10ed6eb92 125 void getStringFixedLength(uint8_t *lineBuffer, int maxLength) {
jbradshaw 0:e4a10ed6eb92 126 uint8_t ch;
jbradshaw 0:e4a10ed6eb92 127 int index = 0;
jbradshaw 0:e4a10ed6eb92 128 // block until maxLength is captured
jbradshaw 0:e4a10ed6eb92 129 while (1) {
jbradshaw 0:e4a10ed6eb92 130 ch = getch();
jbradshaw 0:e4a10ed6eb92 131 lineBuffer[index++] = ch;
jbradshaw 0:e4a10ed6eb92 132 if (index == maxLength)
jbradshaw 0:e4a10ed6eb92 133 return;
jbradshaw 0:e4a10ed6eb92 134 }
jbradshaw 0:e4a10ed6eb92 135 }
jbradshaw 0:e4a10ed6eb92 136
jbradshaw 0:e4a10ed6eb92 137 /**
jbradshaw 0:e4a10ed6eb92 138 * @brief Output a string out the USB serial port
jbradshaw 0:e4a10ed6eb92 139 * @param str output this str the USB channel
jbradshaw 0:e4a10ed6eb92 140 */
jbradshaw 0:e4a10ed6eb92 141 int putStr(const char *str) {
jbradshaw 0:e4a10ed6eb92 142 Peripherals::usbSerial()->printf("%s", str); // fflush(stdout);
jbradshaw 0:e4a10ed6eb92 143 // uint8_t *ptr;
jbradshaw 0:e4a10ed6eb92 144 // uint8_t buffer[256];
jbradshaw 0:e4a10ed6eb92 145 // int index = 0;
jbradshaw 0:e4a10ed6eb92 146 /* int length;
jbradshaw 0:e4a10ed6eb92 147 ptr = (uint8_t *)str;
jbradshaw 0:e4a10ed6eb92 148 length = strlen(str);
jbradshaw 0:e4a10ed6eb92 149
jbradshaw 0:e4a10ed6eb92 150 Peripherals::usbSerial()->writeBlock(ptr,length); */
jbradshaw 0:e4a10ed6eb92 151 return 0;
jbradshaw 0:e4a10ed6eb92 152 }
jbradshaw 0:e4a10ed6eb92 153
jbradshaw 0:e4a10ed6eb92 154 /**
jbradshaw 0:e4a10ed6eb92 155 * @brief Outut an array of bytes out the USB serial port
jbradshaw 0:e4a10ed6eb92 156 * @param data buffer to output
jbradshaw 0:e4a10ed6eb92 157 * @param length length of buffer
jbradshaw 0:e4a10ed6eb92 158 */
jbradshaw 0:e4a10ed6eb92 159 int putBytes(uint8_t *data, uint32_t length) {
jbradshaw 0:e4a10ed6eb92 160 int sendThis = 64;
jbradshaw 0:e4a10ed6eb92 161 int sent = 0;
jbradshaw 0:e4a10ed6eb92 162 int thisLeft;
jbradshaw 0:e4a10ed6eb92 163 uint8_t *ptr = data;
jbradshaw 0:e4a10ed6eb92 164 if (length < 64)
jbradshaw 0:e4a10ed6eb92 165 sendThis = length;
jbradshaw 0:e4a10ed6eb92 166 do {
jbradshaw 0:e4a10ed6eb92 167 Peripherals::usbSerial()->writeBlock(ptr, sendThis);
jbradshaw 0:e4a10ed6eb92 168 sent += sendThis;
jbradshaw 0:e4a10ed6eb92 169 ptr += sendThis;
jbradshaw 0:e4a10ed6eb92 170 thisLeft = length - sent;
jbradshaw 0:e4a10ed6eb92 171 sendThis = 64;
jbradshaw 0:e4a10ed6eb92 172 if (thisLeft < 64)
jbradshaw 0:e4a10ed6eb92 173 sendThis = thisLeft;
jbradshaw 0:e4a10ed6eb92 174 } while (sent != length);
jbradshaw 0:e4a10ed6eb92 175 return 0;
jbradshaw 0:e4a10ed6eb92 176 }
jbradshaw 0:e4a10ed6eb92 177
jbradshaw 0:e4a10ed6eb92 178 /**
jbradshaw 0:e4a10ed6eb92 179 * @brief Outut 256 byte blocks out the USB serial using writeBlock bulk
jbradshaw 0:e4a10ed6eb92 180 * transfers
jbradshaw 0:e4a10ed6eb92 181 * @param data buffer of blocks to output
jbradshaw 0:e4a10ed6eb92 182 * @param length length of 256-byte blocks
jbradshaw 0:e4a10ed6eb92 183 */
jbradshaw 0:e4a10ed6eb92 184 int putBytes256Block(uint8_t *data, int numberBlocks) {
jbradshaw 0:e4a10ed6eb92 185 int i;
jbradshaw 0:e4a10ed6eb92 186 uint8_t *ptr;
jbradshaw 0:e4a10ed6eb92 187 ptr = data;
jbradshaw 0:e4a10ed6eb92 188 const int BLOCK_SIZE = 32;
jbradshaw 0:e4a10ed6eb92 189 const int FLASH_PAGE_SIZE = 256;
jbradshaw 0:e4a10ed6eb92 190 for (i = 0; i < numberBlocks * (FLASH_PAGE_SIZE / BLOCK_SIZE); i++) {
jbradshaw 0:e4a10ed6eb92 191 Peripherals::usbSerial()->writeBlock(ptr, BLOCK_SIZE);
jbradshaw 0:e4a10ed6eb92 192 ptr += BLOCK_SIZE;
jbradshaw 0:e4a10ed6eb92 193 }
jbradshaw 0:e4a10ed6eb92 194 return 0;
jbradshaw 0:e4a10ed6eb92 195 }