StringInOut.h

00001 /*******************************************************************************
00002  * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a
00005  * copy of this software and associated documentation files (the "Software"),
00006  * to deal in the Software without restriction, including without limitation
00007  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008  * and/or sell copies of the Software, and to permit persons to whom the
00009  * Software is furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included
00012  * in all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017  * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018  * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020  * OTHER DEALINGS IN THE SOFTWARE.
00021  *
00022  * Except as contained in this notice, the name of Maxim Integrated
00023  * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024  * Products, Inc. Branding Policy.
00025  *
00026  * The mere transfer of this software does not imply any licenses
00027  * of trade secrets, proprietary technology, copyrights, patents,
00028  * trademarks, maskwork rights, or any other form of intellectual
00029  * property whatsoever. Maxim Integrated Products, Inc. retains all
00030  * ownership rights.
00031  *******************************************************************************
00032  */
00033 #ifndef _STRINGINOUT_H_
00034 #define _STRINGINOUT_H_
00035 
00036 #include "mbed.h"
00037 #include "USBSerial.h"
00038 
00039 /// indicates that a string up to a CRLF is being accumulated
00040 #define GETLINE_WAITING 1
00041 /// indicates that a string is being processes
00042 #define GETLINE_PROCESSING 2
00043 /// indicates that a CRLF string has been buffered and can be processed
00044 #define GETLINE_DONE 3
00045 
00046 /**
00047 * @brief Clear the incoming USB read fifo
00048 */
00049 void clearOutReadFifo(void);
00050 /**
00051 * @brief Block until a character can be read from the USB
00052 * @return the character read
00053 */
00054 char getch(void);
00055 /**
00056 * @brief Place incoming USB characters into a fifo
00057 * @param lineBuffer buffer to place the incoming characters
00058 * @param bufferLength length of buffer
00059 * @return GETLINE_WAITING if still waiting for a CRLF, GETLINE_DONE
00060 */
00061 int getLine(char *lineBuffer, int bufferLength);
00062 /**
00063 * @brief Block until a fixed number of characters has been accumulated from the
00064 * incoming USB
00065 * @param lineBuffer buffer to place the incoming characters
00066 * @param maxLength length of buffer
00067 */
00068 void getStringFixedLength(uint8_t *lineBuffer, int maxLength);
00069 /**
00070 * @brief Output a string out the USB serial port
00071 * @param str output this str the USB channel
00072 */
00073 int putStr(const char *str);
00074 /**
00075 * @brief Place incoming USB characters into a fifo
00076 * @param data_IN buffer of characters
00077 * @param len length of data
00078 */
00079 int fifoIncomingChars(uint8_t data_IN[], unsigned int len);
00080 /**
00081 * @brief Outut an array of bytes out the USB serial port
00082 * @param data buffer to output
00083 * @param length length of buffer
00084 */
00085 int putBytes(uint8_t *data, uint32_t length);
00086 /**
00087 * @brief Outut 256 byte blocks out the USB serial using writeBlock bulk
00088 * transfers
00089 * @param data buffer of blocks to output
00090 * @param length length of 256-byte blocks
00091 */
00092 int putBytes256Block(uint8_t *data, int numberBlocks);
00093 
00094 #endif // _STRINGINOUT_H_
00095