Darien Figueroa / Mbed 2 deprecated repo3

repo time

Dependencies:   mbed MAX14720 MAX30205 USBDevice

e4a10ed6eb92/HSP/RpcServer/StringInOut.cpp@20:6d2af70c92ab, 2021-04-06 (annotated)

Committer:
darienf
Date:
Tue Apr 06 06:41:40 2021 +0000
Revision:
20:6d2af70c92ab
another repo

Who changed what in which revision?

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