Darien Figueroa / Mbed 2 deprecated repo3

repo time

Dependencies:   mbed MAX14720 MAX30205 USBDevice

e4a10ed6eb92/HSP/RpcServer/StringInOut.h@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 #ifndef _STRINGINOUT_H_
darienf 20:6d2af70c92ab 34 #define _STRINGINOUT_H_
darienf 20:6d2af70c92ab 35
darienf 20:6d2af70c92ab 36 #include "mbed.h"
darienf 20:6d2af70c92ab 37 #include "USBSerial.h"
darienf 20:6d2af70c92ab 38
darienf 20:6d2af70c92ab 39 /// indicates that a string up to a CRLF is being accumulated
darienf 20:6d2af70c92ab 40 #define GETLINE_WAITING 1
darienf 20:6d2af70c92ab 41 /// indicates that a string is being processes
darienf 20:6d2af70c92ab 42 #define GETLINE_PROCESSING 2
darienf 20:6d2af70c92ab 43 /// indicates that a CRLF string has been buffered and can be processed
darienf 20:6d2af70c92ab 44 #define GETLINE_DONE 3
darienf 20:6d2af70c92ab 45
darienf 20:6d2af70c92ab 46 /**
darienf 20:6d2af70c92ab 47 * @brief Clear the incoming USB read fifo
darienf 20:6d2af70c92ab 48 */
darienf 20:6d2af70c92ab 49 void clearOutReadFifo(void);
darienf 20:6d2af70c92ab 50 /**
darienf 20:6d2af70c92ab 51 * @brief Block until a character can be read from the USB
darienf 20:6d2af70c92ab 52 * @return the character read
darienf 20:6d2af70c92ab 53 */
darienf 20:6d2af70c92ab 54 char getch(void);
darienf 20:6d2af70c92ab 55 /**
darienf 20:6d2af70c92ab 56 * @brief Place incoming USB characters into a fifo
darienf 20:6d2af70c92ab 57 * @param lineBuffer buffer to place the incoming characters
darienf 20:6d2af70c92ab 58 * @param bufferLength length of buffer
darienf 20:6d2af70c92ab 59 * @return GETLINE_WAITING if still waiting for a CRLF, GETLINE_DONE
darienf 20:6d2af70c92ab 60 */
darienf 20:6d2af70c92ab 61 int getLine(char *lineBuffer, int bufferLength);
darienf 20:6d2af70c92ab 62 /**
darienf 20:6d2af70c92ab 63 * @brief Block until a fixed number of characters has been accumulated from the
darienf 20:6d2af70c92ab 64 * incoming USB
darienf 20:6d2af70c92ab 65 * @param lineBuffer buffer to place the incoming characters
darienf 20:6d2af70c92ab 66 * @param maxLength length of buffer
darienf 20:6d2af70c92ab 67 */
darienf 20:6d2af70c92ab 68 void getStringFixedLength(uint8_t *lineBuffer, int maxLength);
darienf 20:6d2af70c92ab 69 /**
darienf 20:6d2af70c92ab 70 * @brief Output a string out the USB serial port
darienf 20:6d2af70c92ab 71 * @param str output this str the USB channel
darienf 20:6d2af70c92ab 72 */
darienf 20:6d2af70c92ab 73 int putStr(const char *str);
darienf 20:6d2af70c92ab 74 /**
darienf 20:6d2af70c92ab 75 * @brief Place incoming USB characters into a fifo
darienf 20:6d2af70c92ab 76 * @param data_IN buffer of characters
darienf 20:6d2af70c92ab 77 * @param len length of data
darienf 20:6d2af70c92ab 78 */
darienf 20:6d2af70c92ab 79 int fifoIncomingChars(uint8_t data_IN[], unsigned int len);
darienf 20:6d2af70c92ab 80 /**
darienf 20:6d2af70c92ab 81 * @brief Outut an array of bytes out the USB serial port
darienf 20:6d2af70c92ab 82 * @param data buffer to output
darienf 20:6d2af70c92ab 83 * @param length length of buffer
darienf 20:6d2af70c92ab 84 */
darienf 20:6d2af70c92ab 85 int putBytes(uint8_t *data, uint32_t length);
darienf 20:6d2af70c92ab 86 /**
darienf 20:6d2af70c92ab 87 * @brief Outut 256 byte blocks out the USB serial using writeBlock bulk
darienf 20:6d2af70c92ab 88 * transfers
darienf 20:6d2af70c92ab 89 * @param data buffer of blocks to output
darienf 20:6d2af70c92ab 90 * @param length length of 256-byte blocks
darienf 20:6d2af70c92ab 91 */
darienf 20:6d2af70c92ab 92 int putBytes256Block(uint8_t *data, int numberBlocks);
darienf 20:6d2af70c92ab 93
darienf 20:6d2af70c92ab 94 #endif // _STRINGINOUT_H_