xref: /freebsd/sys/dev/iavf/iavf_alloc.h (revision 71625ec9ad2a9bc8c09784fbd23b759830e0ee5f)
1*ca853deeSEric Joyner /* SPDX-License-Identifier: BSD-3-Clause */
2*ca853deeSEric Joyner /*  Copyright (c) 2021, Intel Corporation
3*ca853deeSEric Joyner  *  All rights reserved.
4*ca853deeSEric Joyner  *
5*ca853deeSEric Joyner  *  Redistribution and use in source and binary forms, with or without
6*ca853deeSEric Joyner  *  modification, are permitted provided that the following conditions are met:
7*ca853deeSEric Joyner  *
8*ca853deeSEric Joyner  *   1. Redistributions of source code must retain the above copyright notice,
9*ca853deeSEric Joyner  *      this list of conditions and the following disclaimer.
10*ca853deeSEric Joyner  *
11*ca853deeSEric Joyner  *   2. Redistributions in binary form must reproduce the above copyright
12*ca853deeSEric Joyner  *      notice, this list of conditions and the following disclaimer in the
13*ca853deeSEric Joyner  *      documentation and/or other materials provided with the distribution.
14*ca853deeSEric Joyner  *
15*ca853deeSEric Joyner  *   3. Neither the name of the Intel Corporation nor the names of its
16*ca853deeSEric Joyner  *      contributors may be used to endorse or promote products derived from
17*ca853deeSEric Joyner  *      this software without specific prior written permission.
18*ca853deeSEric Joyner  *
19*ca853deeSEric Joyner  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20*ca853deeSEric Joyner  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21*ca853deeSEric Joyner  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22*ca853deeSEric Joyner  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23*ca853deeSEric Joyner  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24*ca853deeSEric Joyner  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25*ca853deeSEric Joyner  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26*ca853deeSEric Joyner  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27*ca853deeSEric Joyner  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28*ca853deeSEric Joyner  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29*ca853deeSEric Joyner  *  POSSIBILITY OF SUCH DAMAGE.
30*ca853deeSEric Joyner  */
31*ca853deeSEric Joyner 
32*ca853deeSEric Joyner #ifndef _IAVF_ALLOC_H_
33*ca853deeSEric Joyner #define _IAVF_ALLOC_H_
34*ca853deeSEric Joyner 
35*ca853deeSEric Joyner struct iavf_hw;
36*ca853deeSEric Joyner 
37*ca853deeSEric Joyner /* Memory allocation types */
38*ca853deeSEric Joyner enum iavf_memory_type {
39*ca853deeSEric Joyner 	iavf_mem_arq_buf = 0,		/* ARQ indirect command buffer */
40*ca853deeSEric Joyner 	iavf_mem_asq_buf = 1,
41*ca853deeSEric Joyner 	iavf_mem_atq_buf = 2,		/* ATQ indirect command buffer */
42*ca853deeSEric Joyner 	iavf_mem_arq_ring = 3,		/* ARQ descriptor ring */
43*ca853deeSEric Joyner 	iavf_mem_atq_ring = 4,		/* ATQ descriptor ring */
44*ca853deeSEric Joyner 	iavf_mem_pd = 5,		/* Page Descriptor */
45*ca853deeSEric Joyner 	iavf_mem_bp = 6,		/* Backing Page - 4KB */
46*ca853deeSEric Joyner 	iavf_mem_bp_jumbo = 7,		/* Backing Page - > 4KB */
47*ca853deeSEric Joyner 	iavf_mem_reserved
48*ca853deeSEric Joyner };
49*ca853deeSEric Joyner 
50*ca853deeSEric Joyner /* prototype for functions used for dynamic memory allocation */
51*ca853deeSEric Joyner enum iavf_status iavf_allocate_dma_mem(struct iavf_hw *hw,
52*ca853deeSEric Joyner 				       struct iavf_dma_mem *mem,
53*ca853deeSEric Joyner 				       enum iavf_memory_type type,
54*ca853deeSEric Joyner 				       u64 size, u32 alignment);
55*ca853deeSEric Joyner enum iavf_status iavf_free_dma_mem(struct iavf_hw *hw,
56*ca853deeSEric Joyner 				   struct iavf_dma_mem *mem);
57*ca853deeSEric Joyner enum iavf_status iavf_allocate_virt_mem(struct iavf_hw *hw,
58*ca853deeSEric Joyner 				        struct iavf_virt_mem *mem,
59*ca853deeSEric Joyner 					u32 size);
60*ca853deeSEric Joyner enum iavf_status iavf_free_virt_mem(struct iavf_hw *hw,
61*ca853deeSEric Joyner 				    struct iavf_virt_mem *mem);
62*ca853deeSEric Joyner 
63*ca853deeSEric Joyner #endif /* _IAVF_ALLOC_H_ */
64