PacketFifo.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 _PACKETFIFO_H_
00034 #define _PACKETFIFO_H_
00035 
00036 #include "mbed.h"
00037 
00038 /**
00039 * this will create a packet and insert it into an outbound fifo to be streamed out or saved in flash
00040 * @param packetId number id to assign to this packet
00041 * @param buffer a 32-bit buffer that contains data that will be used in the packet
00042 * @param numberInBuffer the number of 32-bit elements to be copied from the buffer
00043 */
00044 void PacketFifo_InsertPacket(uint32_t packetId, uint32_t *buffer, uint32_t numberInBuffer);
00045 
00046 /**
00047 * clears the packet outbound fifo
00048 */
00049 void PacketFifo_Clear(void);
00050 
00051 /**
00052 * returns one if outbound fifo is empty, zero if not empty
00053 */
00054 uint32_t PacketFifo_Empty(void);
00055 
00056 /** 
00057 * returns a uint32 from the fifo, this uint32 is destined to be streamed out USB or saved in flash
00058 */
00059 uint32_t PacketFifo_GetUint32(void);
00060 
00061 #endif /* _PACKETFIFO_H_ */