aurelio carella / Mbed OS mbed-os-example-ble-GattServer_ECG

20200716 read Status Register each second

Dependencies:   SDFileSystem mbed-os-example-ble-GattServer max32630fthr

HSP/RpcServer/RpcFifo.h@21:51e162c130a9, 2020-07-16 (annotated)

Committer:
aureliocarella
Date:
Thu Jul 16 14:59:04 2020 +0000
Revision:
21:51e162c130a9
20200716

Who changed what in which revision?

UserRevisionLine numberNew contents of line
aureliocarella 21:51e162c130a9 1 /*******************************************************************************
aureliocarella 21:51e162c130a9 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
aureliocarella 21:51e162c130a9 3 *
aureliocarella 21:51e162c130a9 4 * Permission is hereby granted, free of charge, to any person obtaining a
aureliocarella 21:51e162c130a9 5 * copy of this software and associated documentation files (the "Software"),
aureliocarella 21:51e162c130a9 6 * to deal in the Software without restriction, including without limitation
aureliocarella 21:51e162c130a9 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
aureliocarella 21:51e162c130a9 8 * and/or sell copies of the Software, and to permit persons to whom the
aureliocarella 21:51e162c130a9 9 * Software is furnished to do so, subject to the following conditions:
aureliocarella 21:51e162c130a9 10 *
aureliocarella 21:51e162c130a9 11 * The above copyright notice and this permission notice shall be included
aureliocarella 21:51e162c130a9 12 * in all copies or substantial portions of the Software.
aureliocarella 21:51e162c130a9 13 *
aureliocarella 21:51e162c130a9 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
aureliocarella 21:51e162c130a9 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
aureliocarella 21:51e162c130a9 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
aureliocarella 21:51e162c130a9 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
aureliocarella 21:51e162c130a9 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
aureliocarella 21:51e162c130a9 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
aureliocarella 21:51e162c130a9 20 * OTHER DEALINGS IN THE SOFTWARE.
aureliocarella 21:51e162c130a9 21 *
aureliocarella 21:51e162c130a9 22 * Except as contained in this notice, the name of Maxim Integrated
aureliocarella 21:51e162c130a9 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
aureliocarella 21:51e162c130a9 24 * Products, Inc. Branding Policy.
aureliocarella 21:51e162c130a9 25 *
aureliocarella 21:51e162c130a9 26 * The mere transfer of this software does not imply any licenses
aureliocarella 21:51e162c130a9 27 * of trade secrets, proprietary technology, copyrights, patents,
aureliocarella 21:51e162c130a9 28 * trademarks, maskwork rights, or any other form of intellectual
aureliocarella 21:51e162c130a9 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
aureliocarella 21:51e162c130a9 30 * ownership rights.
aureliocarella 21:51e162c130a9 31 *
aureliocarella 21:51e162c130a9 32 ********************************************************************************
aureliocarella 21:51e162c130a9 33 */
aureliocarella 21:51e162c130a9 34 #ifndef _RPCFIFO_H_
aureliocarella 21:51e162c130a9 35 #define _RPCFIFO_H_
aureliocarella 21:51e162c130a9 36
aureliocarella 21:51e162c130a9 37 #include <stdint.h>
aureliocarella 21:51e162c130a9 38
aureliocarella 21:51e162c130a9 39 /// Structure used for FIFO management
aureliocarella 21:51e162c130a9 40 typedef struct {
aureliocarella 21:51e162c130a9 41 unsigned int length; ///< FIFO size (number of elements)
aureliocarella 21:51e162c130a9 42 void *data; ///< pointer to the FIFO buffer
aureliocarella 21:51e162c130a9 43 unsigned int rindex; ///< current FIFO read index
aureliocarella 21:51e162c130a9 44 unsigned int windex; ///< current FIFO write index
aureliocarella 21:51e162c130a9 45 } fifo_t;
aureliocarella 21:51e162c130a9 46
aureliocarella 21:51e162c130a9 47 /**
aureliocarella 21:51e162c130a9 48 * @param fifo FIFO on which to perform the operation
aureliocarella 21:51e162c130a9 49 * @param mem memory buffer to use for FIFO element storage
aureliocarella 21:51e162c130a9 50 * @param length number of elements that the memory buffer can contain
aureliocarella 21:51e162c130a9 51 * @returns 0 if successful, -1 upon failure
aureliocarella 21:51e162c130a9 52 */
aureliocarella 21:51e162c130a9 53 void fifo_init(fifo_t *fifo, void *mem, unsigned int length);
aureliocarella 21:51e162c130a9 54
aureliocarella 21:51e162c130a9 55 /**
aureliocarella 21:51e162c130a9 56 * @brief Adds and 8-bit element to the FIFO
aureliocarella 21:51e162c130a9 57 * @param fifo FIFO on which to perform the operation
aureliocarella 21:51e162c130a9 58 * @param element element to add to the FIFO
aureliocarella 21:51e162c130a9 59 * @returns 0 if successful, -1 upon failure
aureliocarella 21:51e162c130a9 60 */
aureliocarella 21:51e162c130a9 61 int fifo_put8(fifo_t *fifo, uint8_t element);
aureliocarella 21:51e162c130a9 62
aureliocarella 21:51e162c130a9 63 /**
aureliocarella 21:51e162c130a9 64 * @brief Gets the next 8-bit element to the FIFO
aureliocarella 21:51e162c130a9 65 * @param fifo FIFO on which to perform the operation
aureliocarella 21:51e162c130a9 66 * @param element pointer to where to store the element from the FIFO
aureliocarella 21:51e162c130a9 67 * @returns 0 if successful, -1 upon failure
aureliocarella 21:51e162c130a9 68 */
aureliocarella 21:51e162c130a9 69 int fifo_get8(fifo_t *fifo, uint8_t *element);
aureliocarella 21:51e162c130a9 70
aureliocarella 21:51e162c130a9 71 /**
aureliocarella 21:51e162c130a9 72 * @brief Adds the next 16-bit element to the FIFO
aureliocarella 21:51e162c130a9 73 * @param fifo FIFO on which to perform the operation
aureliocarella 21:51e162c130a9 74 * @param element element to add to the FIFO
aureliocarella 21:51e162c130a9 75 * @returns 0 if successful, -1 upon failure
aureliocarella 21:51e162c130a9 76 */
aureliocarella 21:51e162c130a9 77 int fifo_put16(fifo_t *fifo, uint16_t element);
aureliocarella 21:51e162c130a9 78
aureliocarella 21:51e162c130a9 79 /**
aureliocarella 21:51e162c130a9 80 * @brief Gets the next 16-bit element to the FIFO
aureliocarella 21:51e162c130a9 81 * @param fifo FIFO on which to perform the operation
aureliocarella 21:51e162c130a9 82 * @param element pointer to where to store the element from the FIFO
aureliocarella 21:51e162c130a9 83 * @returns 0 if successful, -1 upon failure
aureliocarella 21:51e162c130a9 84 */
aureliocarella 21:51e162c130a9 85 int fifo_get16(fifo_t *fifo, uint16_t *element);
aureliocarella 21:51e162c130a9 86
aureliocarella 21:51e162c130a9 87 /**
aureliocarella 21:51e162c130a9 88 * @brief Adds the next 16-bit element to the FIFO
aureliocarella 21:51e162c130a9 89 * @param fifo FIFO on which to perform the operation
aureliocarella 21:51e162c130a9 90 * @param element element to add to the FIFO
aureliocarella 21:51e162c130a9 91 * @returns 0 if successful, -1 upon failure
aureliocarella 21:51e162c130a9 92 */
aureliocarella 21:51e162c130a9 93 int fifo_put32(fifo_t *fifo, uint32_t element);
aureliocarella 21:51e162c130a9 94
aureliocarella 21:51e162c130a9 95 /**
aureliocarella 21:51e162c130a9 96 * @brief Gets the next 16-bit element to the FIFO
aureliocarella 21:51e162c130a9 97 * @param fifo FIFO on which to perform the operation
aureliocarella 21:51e162c130a9 98 * @param element pointer to where to store the element from the FIFO
aureliocarella 21:51e162c130a9 99 * @returns 0 if successful, -1 upon failure
aureliocarella 21:51e162c130a9 100 */
aureliocarella 21:51e162c130a9 101 int fifo_get32(fifo_t *fifo, uint32_t *element);
aureliocarella 21:51e162c130a9 102
aureliocarella 21:51e162c130a9 103 /**
aureliocarella 21:51e162c130a9 104 * @brief Immediately resets the FIFO to the empty state
aureliocarella 21:51e162c130a9 105 * @param fifo FIFO on which to perform the operation
aureliocarella 21:51e162c130a9 106 */
aureliocarella 21:51e162c130a9 107 void fifo_clear(fifo_t *fifo);
aureliocarella 21:51e162c130a9 108
aureliocarella 21:51e162c130a9 109 /**
aureliocarella 21:51e162c130a9 110 * @brief Determines if the FIFO is empty
aureliocarella 21:51e162c130a9 111 * @param fifo FIFO on which to perform the operation
aureliocarella 21:51e162c130a9 112 * @returns #TRUE if FIFO is empty, #FALSE otherwise
aureliocarella 21:51e162c130a9 113 */
aureliocarella 21:51e162c130a9 114 int fifo_empty(fifo_t *fifo);
aureliocarella 21:51e162c130a9 115
aureliocarella 21:51e162c130a9 116 /**
aureliocarella 21:51e162c130a9 117 * @brief FIFO status function
aureliocarella 21:51e162c130a9 118 * @param fifo FIFO on which to perform the operation
aureliocarella 21:51e162c130a9 119 * @returns #TRUE if FIFO is full, #FALSE otherwise
aureliocarella 21:51e162c130a9 120 */
aureliocarella 21:51e162c130a9 121 int fifo_full(fifo_t *fifo);
aureliocarella 21:51e162c130a9 122
aureliocarella 21:51e162c130a9 123 /**
aureliocarella 21:51e162c130a9 124 * @brief FIFO status function
aureliocarella 21:51e162c130a9 125 * @param fifo FIFO on which to perform the operation
aureliocarella 21:51e162c130a9 126 * @returns the number of elements currently in the FIFO
aureliocarella 21:51e162c130a9 127 */
aureliocarella 21:51e162c130a9 128 unsigned int fifo_level(fifo_t *fifo);
aureliocarella 21:51e162c130a9 129
aureliocarella 21:51e162c130a9 130 /**
aureliocarella 21:51e162c130a9 131 * @brief FIFO status function
aureliocarella 21:51e162c130a9 132 * @param fifo FIFO on which to perform the operation
aureliocarella 21:51e162c130a9 133 * @returns the remaining elements that can be added to the FIFO
aureliocarella 21:51e162c130a9 134 */
aureliocarella 21:51e162c130a9 135 unsigned int fifo_remaining(fifo_t *fifo);
aureliocarella 21:51e162c130a9 136
aureliocarella 21:51e162c130a9 137 #endif // _RPCFIFO_H_
aureliocarella 21:51e162c130a9 138