xref: /freebsd/sys/dev/dpaa2/dpaa2_bp.h (revision af23369a6deaaeb612ab266eb88b8bb8d560c322)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright © 2022 Dmitry Salychev
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
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  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #ifndef	_DPAA2_BP_H
29 #define	_DPAA2_BP_H
30 
31 #include <sys/bus.h>
32 
33 /* Maximum resources per DPBP: 1 DPMCP. */
34 #define DPAA2_BP_MAX_RESOURCES	1
35 
36 /**
37  * @brief Attributes of the DPBP object.
38  *
39  * id:		 DPBP object ID.
40  * bpid:	 Hardware buffer pool ID; should be used as an argument in
41  *		 acquire/release operations on buffers.
42  */
43 struct dpaa2_bp_attr {
44 	uint32_t		 id;
45 	uint16_t		 bpid;
46 };
47 
48 /**
49  * @brief Configuration/state of the buffer pool.
50  */
51 struct dpaa2_bp_conf {
52 	uint8_t			 bdi;
53 	uint8_t			 state; /* bitmask */
54 	uint32_t		 free_bufn;
55 };
56 
57 /**
58  * @brief Software context for the DPAA2 Buffer Pool driver.
59  */
60 struct dpaa2_bp_softc {
61 	device_t		 dev;
62 	struct dpaa2_bp_attr	 attr;
63 
64 	/* Help to send commands to MC. */
65 	struct dpaa2_cmd	*cmd;
66 	uint16_t		 rc_token;
67 	uint16_t		 bp_token;
68 
69 	struct resource 	*res[DPAA2_BP_MAX_RESOURCES];
70 };
71 
72 extern struct resource_spec dpaa2_bp_spec[];
73 
74 #endif /* _DPAA2_BP_H */
75