Jerry Bradshaw / Mbed OS HSP_Release

This is a mbed 5.2 Release

Dependencies:   USBDevice

Fork of mbed-os-test by Jerry Bradshaw

HSP/RpcServer/RpcFifo.h@0:e4a10ed6eb92, 2016-10-25 (annotated)

Committer:
jbradshaw
Date:
Tue Oct 25 15:22:11 2016 +0000
Revision:
0:e4a10ed6eb92
tewt

Who changed what in which revision?

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