Darien Figueroa / Mbed 2 deprecated repo3

repo time

Dependencies:   mbed MAX14720 MAX30205 USBDevice

e4a10ed6eb92/HSP/RpcServer/StringHelper.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 _STRINGHELPER_H_
darienf 20:6d2af70c92ab 34 #define _STRINGHELPER_H_
darienf 20:6d2af70c92ab 35
darienf 20:6d2af70c92ab 36 #include "mbed.h"
darienf 20:6d2af70c92ab 37
darienf 20:6d2af70c92ab 38 /**
darienf 20:6d2af70c92ab 39 * @brief Process an array of hex alpha numeric strings representing arguments of
darienf 20:6d2af70c92ab 40 * type uint8
darienf 20:6d2af70c92ab 41 * @param args Array of strings to process
darienf 20:6d2af70c92ab 42 * @param argsUintPtr Pointer of uint8 to save converted arguments
darienf 20:6d2af70c92ab 43 * @param numberOf Number of strings to convert
darienf 20:6d2af70c92ab 44 */
darienf 20:6d2af70c92ab 45 void ProcessArgs(char args[32][32], uint8_t *argsUintPtr, int numberOf);
darienf 20:6d2af70c92ab 46 /**
darienf 20:6d2af70c92ab 47 * @brief Format a binary 8-bit array into a string
darienf 20:6d2af70c92ab 48 * @param uint8Ptr byte buffer to process
darienf 20:6d2af70c92ab 49 * @param numberOf number of bytes in the buffer
darienf 20:6d2af70c92ab 50 * @param reply an array of strings to place the converted array values into
darienf 20:6d2af70c92ab 51 */
darienf 20:6d2af70c92ab 52 void FormatReply(uint8_t *uint8Ptr, int numberOf, char reply[32][32]);
darienf 20:6d2af70c92ab 53 /**
darienf 20:6d2af70c92ab 54 * @brief Process an array of hex alpha numeric strings representing arguments of
darienf 20:6d2af70c92ab 55 * type uint32
darienf 20:6d2af70c92ab 56 * @param args Array of strings to process
darienf 20:6d2af70c92ab 57 * @param argsUintPtr Pointer of uint32 to save converted arguments
darienf 20:6d2af70c92ab 58 * @param numberOf Number of strings to convert
darienf 20:6d2af70c92ab 59 */
darienf 20:6d2af70c92ab 60 void ProcessArgs32(char args[32][32], uint32_t *argsUintPtr, int numberOf);
darienf 20:6d2af70c92ab 61 /**
darienf 20:6d2af70c92ab 62 * @brief Process an array of decimal numeric strings representing arguments of
darienf 20:6d2af70c92ab 63 * type uint32
darienf 20:6d2af70c92ab 64 * @param args Array of strings to process
darienf 20:6d2af70c92ab 65 * @param argsUintPtr Pointer of uint32 to save converted arguments
darienf 20:6d2af70c92ab 66 * @param numberOf Number of strings to convert
darienf 20:6d2af70c92ab 67 */
darienf 20:6d2af70c92ab 68 void ProcessArgs32Dec(char args[32][32], uint32_t *argsUintPtr, int numberOf);
darienf 20:6d2af70c92ab 69 /**
darienf 20:6d2af70c92ab 70 * @brief Format a binary 32-bit array into a string
darienf 20:6d2af70c92ab 71 * @param uint32Ptr 32-bit value buffer to process
darienf 20:6d2af70c92ab 72 * @param numberOf number of values in the buffer
darienf 20:6d2af70c92ab 73 * @param reply an array of strings to place the converted array values into
darienf 20:6d2af70c92ab 74 */
darienf 20:6d2af70c92ab 75 void FormatReply32(uint32_t *uint32Ptr, int numberOf, char reply[32][32]);
darienf 20:6d2af70c92ab 76 /**
darienf 20:6d2af70c92ab 77 * @brief Parse an incoming string hex value into an 8-bit value
darienf 20:6d2af70c92ab 78 * @param str string to process
darienf 20:6d2af70c92ab 79 * @returns 8-bit byte that is parsed from the string
darienf 20:6d2af70c92ab 80 */
darienf 20:6d2af70c92ab 81 uint8_t StringToByte(char str[32]);
darienf 20:6d2af70c92ab 82 /**
darienf 20:6d2af70c92ab 83 * @brief Parse an incoming string hex value into 32-bit value
darienf 20:6d2af70c92ab 84 * @param str string to process
darienf 20:6d2af70c92ab 85 * @returns 32-bit value that is parsed from the string
darienf 20:6d2af70c92ab 86 */
darienf 20:6d2af70c92ab 87 uint32_t StringToInt(char str[32]);
darienf 20:6d2af70c92ab 88 /**
darienf 20:6d2af70c92ab 89 * @brief Parse a single string in decimal format to a uint32 number
darienf 20:6d2af70c92ab 90 * @param str String to process
darienf 20:6d2af70c92ab 91 * @returns Returns the converted number of type uint32
darienf 20:6d2af70c92ab 92 */
darienf 20:6d2af70c92ab 93 uint32_t ParseAsciiDecU32(char *str);
darienf 20:6d2af70c92ab 94 /**
darienf 20:6d2af70c92ab 95 * @brief Parse a single string in hex format to a uint32 number
darienf 20:6d2af70c92ab 96 * @param str String to process
darienf 20:6d2af70c92ab 97 * @returns Returns the converted number of type uint32
darienf 20:6d2af70c92ab 98 */
darienf 20:6d2af70c92ab 99 uint32_t ParseAsciiHexU32(char *str);
darienf 20:6d2af70c92ab 100 /**
darienf 20:6d2af70c92ab 101 * @brief Format a binary 8-bit array into a string
darienf 20:6d2af70c92ab 102 * @param data 8-bit value buffer to process
darienf 20:6d2af70c92ab 103 * @param length number of values in the buffer
darienf 20:6d2af70c92ab 104 * @param str output string buffer
darienf 20:6d2af70c92ab 105 * @return output string
darienf 20:6d2af70c92ab 106 */
darienf 20:6d2af70c92ab 107 char *BytesToHexStr(uint8_t *data, uint32_t length, char *str);
darienf 20:6d2af70c92ab 108 /**
darienf 20:6d2af70c92ab 109 * @brief Parse an incoming string until a CRLF is encountered, dst will contain
darienf 20:6d2af70c92ab 110 * the parsed string
darienf 20:6d2af70c92ab 111 * @param src source string to process
darienf 20:6d2af70c92ab 112 * @param dst destination string to contain the parsed incoming string
darienf 20:6d2af70c92ab 113 * @param length length of incoming src string
darienf 20:6d2af70c92ab 114 * @returns updated pointer in src string
darienf 20:6d2af70c92ab 115 */
darienf 20:6d2af70c92ab 116 char *ParseUntilCRLF(char *src, char *dst, int length);
darienf 20:6d2af70c92ab 117
darienf 20:6d2af70c92ab 118 #endif // _STRINGHELPER_H_