/*******************************************************************************

Copyright (c) 2013 - 2015, Intel Corporation
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

 1. Redistributions of source code must retain the above copyright notice,
    this list of conditions and the following disclaimer.

 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.

 3. Neither the name of the Intel Corporation nor the names of its
    contributors may be used to endorse or promote products derived from
    this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

***************************************************************************/

#ifndef _AVF_ALLOC_H_
#define _AVF_ALLOC_H_

struct avf_hw;

/* Memory allocation types */
enum avf_memory_type {
	avf_mem_arq_buf = 0,		/* ARQ indirect command buffer */
	avf_mem_asq_buf = 1,
	avf_mem_atq_buf = 2,		/* ATQ indirect command buffer */
	avf_mem_arq_ring = 3,		/* ARQ descriptor ring */
	avf_mem_atq_ring = 4,		/* ATQ descriptor ring */
	avf_mem_pd = 5,		/* Page Descriptor */
	avf_mem_bp = 6,		/* Backing Page - 4KB */
	avf_mem_bp_jumbo = 7,		/* Backing Page - > 4KB */
	avf_mem_reserved
};

/* prototype for functions used for dynamic memory allocation */
enum avf_status_code avf_allocate_dma_mem(struct avf_hw *hw,
					    struct avf_dma_mem *mem,
					    enum avf_memory_type type,
					    u64 size, u32 alignment);
enum avf_status_code avf_free_dma_mem(struct avf_hw *hw,
					struct avf_dma_mem *mem);
enum avf_status_code avf_allocate_virt_mem(struct avf_hw *hw,
					     struct avf_virt_mem *mem,
					     u32 size);
enum avf_status_code avf_free_virt_mem(struct avf_hw *hw,
					 struct avf_virt_mem *mem);

#endif /* _AVF_ALLOC_H_ */