/**
 ******************************************************************************
 * @file    RingBufferUtils.h
 * @author  William Xu
 * @version V1.0.0
 * @date    05-May-2014
 * @brief   This header contains function prototypes called by ring buffer
 *          operation
 ******************************************************************************
 *
 *  The MIT License
 *  Copyright (c) 2014 MXCHIP Inc.
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is furnished
 *  to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in
 *  all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 *  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
 *  IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ******************************************************************************
 */

#ifndef __RingBufferUtils_h__
#define __RingBufferUtils_h__

#include "common.h"

/** @addtogroup MICO_Middleware_Interface
  * @{
  */

/** @defgroup MICO_RingBuffer MiCO Ring Buffer
  * @brief Provide APIs for Ring Buffer
  * @{
  */

typedef struct
{
  uint8_t*  buffer;
  uint32_t  size;
  volatile uint32_t  head; /* Read from */
  volatile uint32_t  tail; /* Write to */
} ring_buffer_t;

#ifndef MIN
#define MIN(x,y)  ((x) < (y) ? (x) : (y))
#endif /* ifndef MIN */

/**
 * @brief ?
 *
 * @param ring_buffer:   ?
 * @param      buffer:   ?
 * @param        size:   ?
 *
 * @return   kNoErr        : on success.
 * @return   kGeneralErr   : if an error occurred
 */
OSStatus ring_buffer_init( ring_buffer_t* ring_buffer, uint8_t* buffer, uint32_t size );


/**
 * @brief ?
 *
 * @param ring_buffer:   ?
 *
 * @return   kNoErr        : on success.
 * @return   kGeneralErr   : if an error occurred
 */
OSStatus ring_buffer_deinit( ring_buffer_t* ring_buffer );


/**
 * @brief ?
 *
 * @param ring_buffer:   ?
 *
 * @return   
 */
uint32_t ring_buffer_free_space( ring_buffer_t* ring_buffer );


/**
 * @brief ?
 *
 * @param ring_buffer:   ?
 *
 * @return   
 */
uint32_t ring_buffer_used_space( ring_buffer_t* ring_buffer );


/**
 * @brief ?
 *
 * @param ring_buffer:   ?
 * @param data:   ?
 * @param contiguous_bytes: ?
 *
 * @return   
 */
OSStatus ring_buffer_get_data( ring_buffer_t* ring_buffer, uint8_t** data, uint32_t* contiguous_bytes );


/**
 * @brief ?
 *
 * @param ring_buffer:      ?
 * @param bytes_consumed:   ?
 *
 * @return   
 */
OSStatus ring_buffer_consume( ring_buffer_t* ring_buffer, uint32_t bytes_consumed );



/**
 * @brief ?
 *
 * @param ring_buffer:   ?
 * @param data:   ?
 * @param data_length: ?
 *
 * @return   
 */
uint32_t ring_buffer_write( ring_buffer_t* ring_buffer, const uint8_t* data, uint32_t data_length );

uint8_t ring_buffer_is_full(ring_buffer_t *ring_buffer);

OSStatus ring_buffer_read( ring_buffer_t* ring_buffer, uint8_t* data, uint32_t data_length, uint32_t* number_of_bytes_read );
/**
  * @}
  */

/**
  * @}
  */


#endif // __RingBufferUtils_h__