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