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