Darien Figueroa / Mbed 2 deprecated repo3

repo time

Dependencies:   mbed MAX14720 MAX30205 USBDevice

e4a10ed6eb92/HSP/RpcServer/RpcFifo.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 */
darienf 20:6d2af70c92ab 34 #ifndef _RPCFIFO_H_
darienf 20:6d2af70c92ab 35 #define _RPCFIFO_H_
darienf 20:6d2af70c92ab 36
darienf 20:6d2af70c92ab 37 #include <stdint.h>
darienf 20:6d2af70c92ab 38
darienf 20:6d2af70c92ab 39 /// Structure used for FIFO management
darienf 20:6d2af70c92ab 40 typedef struct {
darienf 20:6d2af70c92ab 41 unsigned int length; ///< FIFO size (number of elements)
darienf 20:6d2af70c92ab 42 void *data; ///< pointer to the FIFO buffer
darienf 20:6d2af70c92ab 43 unsigned int rindex; ///< current FIFO read index
darienf 20:6d2af70c92ab 44 unsigned int windex; ///< current FIFO write index
darienf 20:6d2af70c92ab 45 } fifo_t;
darienf 20:6d2af70c92ab 46
darienf 20:6d2af70c92ab 47 /**
darienf 20:6d2af70c92ab 48 * @param fifo FIFO on which to perform the operation
darienf 20:6d2af70c92ab 49 * @param mem memory buffer to use for FIFO element storage
darienf 20:6d2af70c92ab 50 * @param length number of elements that the memory buffer can contain
darienf 20:6d2af70c92ab 51 * @returns 0 if successful, -1 upon failure
darienf 20:6d2af70c92ab 52 */
darienf 20:6d2af70c92ab 53 void fifo_init(fifo_t *fifo, void *mem, unsigned int length);
darienf 20:6d2af70c92ab 54
darienf 20:6d2af70c92ab 55 /**
darienf 20:6d2af70c92ab 56 * @brief Adds and 8-bit element to the FIFO
darienf 20:6d2af70c92ab 57 * @param fifo FIFO on which to perform the operation
darienf 20:6d2af70c92ab 58 * @param element element to add to the FIFO
darienf 20:6d2af70c92ab 59 * @returns 0 if successful, -1 upon failure
darienf 20:6d2af70c92ab 60 */
darienf 20:6d2af70c92ab 61 int fifo_put8(fifo_t *fifo, uint8_t element);
darienf 20:6d2af70c92ab 62
darienf 20:6d2af70c92ab 63 /**
darienf 20:6d2af70c92ab 64 * @brief Gets the next 8-bit element to the FIFO
darienf 20:6d2af70c92ab 65 * @param fifo FIFO on which to perform the operation
darienf 20:6d2af70c92ab 66 * @param element pointer to where to store the element from the FIFO
darienf 20:6d2af70c92ab 67 * @returns 0 if successful, -1 upon failure
darienf 20:6d2af70c92ab 68 */
darienf 20:6d2af70c92ab 69 int fifo_get8(fifo_t *fifo, uint8_t *element);
darienf 20:6d2af70c92ab 70
darienf 20:6d2af70c92ab 71 /**
darienf 20:6d2af70c92ab 72 * @brief Adds the next 16-bit element to the FIFO
darienf 20:6d2af70c92ab 73 * @param fifo FIFO on which to perform the operation
darienf 20:6d2af70c92ab 74 * @param element element to add to the FIFO
darienf 20:6d2af70c92ab 75 * @returns 0 if successful, -1 upon failure
darienf 20:6d2af70c92ab 76 */
darienf 20:6d2af70c92ab 77 int fifo_put16(fifo_t *fifo, uint16_t element);
darienf 20:6d2af70c92ab 78
darienf 20:6d2af70c92ab 79 /**
darienf 20:6d2af70c92ab 80 * @brief Gets the next 16-bit element to the FIFO
darienf 20:6d2af70c92ab 81 * @param fifo FIFO on which to perform the operation
darienf 20:6d2af70c92ab 82 * @param element pointer to where to store the element from the FIFO
darienf 20:6d2af70c92ab 83 * @returns 0 if successful, -1 upon failure
darienf 20:6d2af70c92ab 84 */
darienf 20:6d2af70c92ab 85 int fifo_get16(fifo_t *fifo, uint16_t *element);
darienf 20:6d2af70c92ab 86
darienf 20:6d2af70c92ab 87 /**
darienf 20:6d2af70c92ab 88 * @brief Adds the next 16-bit element to the FIFO
darienf 20:6d2af70c92ab 89 * @param fifo FIFO on which to perform the operation
darienf 20:6d2af70c92ab 90 * @param element element to add to the FIFO
darienf 20:6d2af70c92ab 91 * @returns 0 if successful, -1 upon failure
darienf 20:6d2af70c92ab 92 */
darienf 20:6d2af70c92ab 93 int fifo_put32(fifo_t *fifo, uint32_t element);
darienf 20:6d2af70c92ab 94
darienf 20:6d2af70c92ab 95 /**
darienf 20:6d2af70c92ab 96 * @brief Gets the next 16-bit element to the FIFO
darienf 20:6d2af70c92ab 97 * @param fifo FIFO on which to perform the operation
darienf 20:6d2af70c92ab 98 * @param element pointer to where to store the element from the FIFO
darienf 20:6d2af70c92ab 99 * @returns 0 if successful, -1 upon failure
darienf 20:6d2af70c92ab 100 */
darienf 20:6d2af70c92ab 101 int fifo_get32(fifo_t *fifo, uint32_t *element);
darienf 20:6d2af70c92ab 102
darienf 20:6d2af70c92ab 103 /**
darienf 20:6d2af70c92ab 104 * @brief Immediately resets the FIFO to the empty state
darienf 20:6d2af70c92ab 105 * @param fifo FIFO on which to perform the operation
darienf 20:6d2af70c92ab 106 */
darienf 20:6d2af70c92ab 107 void fifo_clear(fifo_t *fifo);
darienf 20:6d2af70c92ab 108
darienf 20:6d2af70c92ab 109 /**
darienf 20:6d2af70c92ab 110 * @brief Determines if the FIFO is empty
darienf 20:6d2af70c92ab 111 * @param fifo FIFO on which to perform the operation
darienf 20:6d2af70c92ab 112 * @returns #TRUE if FIFO is empty, #FALSE otherwise
darienf 20:6d2af70c92ab 113 */
darienf 20:6d2af70c92ab 114 int fifo_empty(fifo_t *fifo);
darienf 20:6d2af70c92ab 115
darienf 20:6d2af70c92ab 116 /**
darienf 20:6d2af70c92ab 117 * @brief FIFO status function
darienf 20:6d2af70c92ab 118 * @param fifo FIFO on which to perform the operation
darienf 20:6d2af70c92ab 119 * @returns #TRUE if FIFO is full, #FALSE otherwise
darienf 20:6d2af70c92ab 120 */
darienf 20:6d2af70c92ab 121 int fifo_full(fifo_t *fifo);
darienf 20:6d2af70c92ab 122
darienf 20:6d2af70c92ab 123 /**
darienf 20:6d2af70c92ab 124 * @brief FIFO status function
darienf 20:6d2af70c92ab 125 * @param fifo FIFO on which to perform the operation
darienf 20:6d2af70c92ab 126 * @returns the number of elements currently in the FIFO
darienf 20:6d2af70c92ab 127 */
darienf 20:6d2af70c92ab 128 unsigned int fifo_level(fifo_t *fifo);
darienf 20:6d2af70c92ab 129
darienf 20:6d2af70c92ab 130 /**
darienf 20:6d2af70c92ab 131 * @brief FIFO status function
darienf 20:6d2af70c92ab 132 * @param fifo FIFO on which to perform the operation
darienf 20:6d2af70c92ab 133 * @returns the remaining elements that can be added to the FIFO
darienf 20:6d2af70c92ab 134 */
darienf 20:6d2af70c92ab 135 unsigned int fifo_remaining(fifo_t *fifo);
darienf 20:6d2af70c92ab 136
darienf 20:6d2af70c92ab 137 #endif // _RPCFIFO_H_