/* SPDX-License-Identifier: BSD-3-Clause */
/*  Copyright (c) 2021, 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 _IAVF_ALLOC_H_
#define _IAVF_ALLOC_H_

struct iavf_hw;

/* Memory allocation types */
enum iavf_memory_type {
        iavf_mem_arq_buf = 0,           /* ARQ indirect command buffer */
        iavf_mem_asq_buf = 1,
        iavf_mem_atq_buf = 2,           /* ATQ indirect command buffer */
        iavf_mem_arq_ring = 3,          /* ARQ descriptor ring */
        iavf_mem_atq_ring = 4,          /* ATQ descriptor ring */
        iavf_mem_pd = 5,                /* Page Descriptor */
        iavf_mem_bp = 6,                /* Backing Page - 4KB */
        iavf_mem_bp_jumbo = 7,          /* Backing Page - > 4KB */
        iavf_mem_reserved
};

/* prototype for functions used for dynamic memory allocation */
enum iavf_status iavf_allocate_dma_mem(struct iavf_hw *hw,
                                       struct iavf_dma_mem *mem,
                                       enum iavf_memory_type type,
                                       u64 size, u32 alignment);
enum iavf_status iavf_free_dma_mem(struct iavf_hw *hw,
                                   struct iavf_dma_mem *mem);
enum iavf_status iavf_allocate_virt_mem(struct iavf_hw *hw,
                                        struct iavf_virt_mem *mem,
                                        u32 size);
enum iavf_status iavf_free_virt_mem(struct iavf_hw *hw,
                                    struct iavf_virt_mem *mem);

#endif /* _IAVF_ALLOC_H_ */