Daniel Kline / Mbed OS MAX30001-MAX32630FTHR-ECG-EVKIT

Compile SD library

Dependencies:   SDFileSystem USBDevice max32630fthr

Fork of MAX30001-MAX32630FTHR-ECG-EVKIT by Maxim Integrated

HSP/RpcServer/StringInOut.h@0:8e4630a71eb1, 2018-04-05 (annotated)

Committer:
Emre.Eken@IST-LT-35101.maxim-ic.internal
Date:
Thu Apr 05 10:53:26 2018 +0300
Revision:
0:8e4630a71eb1
mbed os 5.8.1 compatible

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 1 /*******************************************************************************
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 3 *
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 4 * Permission is hereby granted, free of charge, to any person obtaining a
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 5 * copy of this software and associated documentation files (the "Software"),
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 6 * to deal in the Software without restriction, including without limitation
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 8 * and/or sell copies of the Software, and to permit persons to whom the
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 9 * Software is furnished to do so, subject to the following conditions:
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 10 *
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 11 * The above copyright notice and this permission notice shall be included
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 12 * in all copies or substantial portions of the Software.
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 13 *
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 20 * OTHER DEALINGS IN THE SOFTWARE.
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 21 *
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 22 * Except as contained in this notice, the name of Maxim Integrated
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 24 * Products, Inc. Branding Policy.
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 25 *
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 26 * The mere transfer of this software does not imply any licenses
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 27 * of trade secrets, proprietary technology, copyrights, patents,
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 28 * trademarks, maskwork rights, or any other form of intellectual
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 30 * ownership rights.
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 31 *******************************************************************************
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 32 */
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 33 #ifndef _STRINGINOUT_H_
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 34 #define _STRINGINOUT_H_
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 35
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 36 #include "mbed.h"
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 37 #include "USBSerial.h"
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 38
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 39 /// indicates that a string up to a CRLF is being accumulated
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 40 #define GETLINE_WAITING 1
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 41 /// indicates that a string is being processes
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 42 #define GETLINE_PROCESSING 2
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 43 /// indicates that a CRLF string has been buffered and can be processed
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 44 #define GETLINE_DONE 3
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 45
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 46 /**
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 47 * @brief Clear the incoming USB read fifo
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 48 */
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 49 void clearOutReadFifo(void);
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 50 /**
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 51 * @brief Block until a character can be read from the USB
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 52 * @return the character read
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 53 */
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 54 char getch(void);
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 55 /**
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 56 * @brief Place incoming USB characters into a fifo
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 57 * @param lineBuffer buffer to place the incoming characters
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 58 * @param bufferLength length of buffer
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 59 * @return GETLINE_WAITING if still waiting for a CRLF, GETLINE_DONE
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 60 */
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 61 int getLine(char *lineBuffer, int bufferLength);
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 62 /**
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 63 * @brief Block until a fixed number of characters has been accumulated from the
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 64 * incoming USB
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 65 * @param lineBuffer buffer to place the incoming characters
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 66 * @param maxLength length of buffer
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 67 */
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 68 void getStringFixedLength(uint8_t *lineBuffer, int maxLength);
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 69 /**
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 70 * @brief Output a string out the USB serial port
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 71 * @param str output this str the USB channel
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 72 */
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 73 int putStr(const char *str);
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 74 /**
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 75 * @brief Place incoming USB characters into a fifo
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 76 * @param data_IN buffer of characters
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 77 * @param len length of data
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 78 */
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 79 int fifoIncomingChars(uint8_t data_IN[], unsigned int len);
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 80 /**
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 81 * @brief Outut an array of bytes out the USB serial port
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 82 * @param data buffer to output
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 83 * @param length length of buffer
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 84 */
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 85 int putBytes(uint8_t *data, uint32_t length);
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 86 /**
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 87 * @brief Outut 256 byte blocks out the USB serial using writeBlock bulk
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 88 * transfers
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 89 * @param data buffer of blocks to output
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 90 * @param length length of 256-byte blocks
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 91 */
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 92 int putBytes256Block(uint8_t *data, int numberBlocks);
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 93
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 94 #endif // _STRINGINOUT_H_
Emre.Eken@IST-LT-35101.maxim-ic.internal 0:8e4630a71eb1 95