/*!
	@file   lib_iqueue.h
	@brief  <brief description here>
	@t.odo	-
	---------------------------------------------------------------------------

	MIT License
	Copyright (c) 2018 Io. D (Devcoons)

	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.
*/
/******************************************************************************
* Preprocessor Definitions & Macros
******************************************************************************/

#ifndef LIBRARIES_INC_LIB_IQUEUE_H_
#define LIBRARIES_INC_LIB_IQUEUE_H_

/******************************************************************************
* Includes
******************************************************************************/

#include <inttypes.h>
#include <string.h>

/******************************************************************************
* Enumerations, structures & Variables
******************************************************************************/

#if !defined(ENUM_I_STATUS)
#define ENUM_I_STATUS
typedef enum
{
	I_OK 				= 0x00,
	I_INVALID 			= 0x01,
	I_EXISTS 			= 0x02,
	I_NOTEXISTS 		= 0x03,
	I_FAILED 			= 0x04,
	I_EXPIRED 			= 0x05,
	I_UNKNOWN 			= 0x06,
	I_INPROGRESS 		= 0x07,
	I_IDLE				= 0x08,
	I_FULL				= 0x09,
	I_EMPTY				= 0x0A,
	I_YES				= 0x0B,
	I_NO				= 0x0C,
	I_SKIP				= 0x0D,
	I_DEBUG_01 			= 0xE0,
	I_DEBUG_02 			= 0xE1,
	I_DEBUG_03 			= 0xE2,
	I_DEBUG_04 			= 0xE3,
	I_DEBUG_05 			= 0xE4,
	I_DEBUG_06 			= 0xE5,
	I_DEBUG_07 			= 0xE6,
	I_DEBUG_08 			= 0xE7,
	I_DEBUG_09 			= 0xE8,
	I_DEBUG_10 			= 0xE9,
	I_DEBUG_11 			= 0xEA,
	I_DEBUG_12 			= 0xEB,
	I_DEBUG_13 			= 0xEC,
	I_DEBUG_14 			= 0xED,
	I_DEBUG_15 			= 0xEE,
	I_DEBUG_16 			= 0xEF,
	I_MEMUNALIGNED 		= 0xFD,
	I_NOTIMPLEMENTED 	= 0xFE,
	I_ERROR 			= 0xFF
	}i_status;
#endif


typedef struct
{
	volatile void * storage;
	volatile uintptr_t first;
	volatile uintptr_t next;
	volatile size_t element_size;
	volatile uint32_t max_elements;
}
iqueue_t;

/******************************************************************************
* Declaration | Public Functions
******************************************************************************/

i_status iqueue_init   (iqueue_t * _queue, int _max_elements, size_t _element_size, void * _storage);
i_status iqueue_enqueue(iqueue_t * _queue, void * _element);
i_status iqueue_dequeue(iqueue_t * _queue, void * _element);
i_status iqueue_size   (iqueue_t * _queue, uint32_t * _size);
i_status iqueue_advance_next(iqueue_t * _queue);
volatile uintptr_t iqueue_get_next_enqueue(iqueue_t * _queue);
void* iqueue_dequeue_fast(iqueue_t * _queue);

/******************************************************************************
* EOF - NO CODE AFTER THIS LINE
******************************************************************************/
#endif