xref: /freebsd/sys/dev/dpaa2/dpaa2_con.h (revision ec965063070e5753c166cf592c9336444b74720a)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright © 2021-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_CON_H
29 #define	_DPAA2_CON_H
30 
31 #include <sys/rman.h>
32 #include <sys/bus.h>
33 #include <sys/queue.h>
34 
35 #include "dpaa2_types.h"
36 #include "dpaa2_mcp.h"
37 
38 /* Maximum resources per DPCON: 1 DPMCP. */
39 #define DPAA2_CON_MAX_RESOURCES	1
40 
41 /**
42  * @brief Attributes of the DPCON object.
43  *
44  * id:		DPCON object ID.
45  * chan_id:	QBMan channel ID to be used for dequeue operations.
46  * prior_num:	Number of priorities for the DPCON channel (1-8).
47  */
48 struct dpaa2_con_attr {
49 	uint32_t		 id;
50 	uint16_t		 chan_id;
51 	uint8_t			 prior_num;
52 };
53 
54 /**
55  * @brief Software context for the DPAA2 Concentrator driver.
56  */
57 struct dpaa2_con_softc {
58 	device_t		 dev;
59 	struct resource 	*res[DPAA2_CON_MAX_RESOURCES];
60 	struct dpaa2_con_attr	 attr;
61 
62 	/* Help to send commands to MC. */
63 	struct dpaa2_cmd	*cmd;
64 	uint16_t		 rc_token;
65 	uint16_t		 con_token;
66 };
67 
68 extern struct resource_spec dpaa2_con_spec[];
69 
70 #endif /* _DPAA2_CON_H */
71