xref: /freebsd/sys/arm64/cavium/thunder_pcie_common.h (revision 1f4bcc459a76b7aa664f3fd557684cd0ba6da352)
1 /*-
2  * Copyright (c) 2015 The FreeBSD Foundation
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
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef _CAVIUM_THUNDER_PCIE_COMMON_H_
30 #define	_CAVIUM_THUNDER_PCIE_COMMON_H_
31 
32 #define	RANGES_TUPLES_MAX	6
33 #define	RANGES_TUPLES_INVALID (RANGES_TUPLES_MAX + 1)
34 
35 DECLARE_CLASS(thunder_pcie_driver);
36 
37 MALLOC_DECLARE(M_THUNDER_PCIE);
38 
39 struct pcie_range {
40 	uint64_t	pci_base;
41 	uint64_t	phys_base;
42 	uint64_t	size;
43 	uint64_t	flags;
44 };
45 
46 struct thunder_pcie_softc {
47 	struct pcie_range	ranges[RANGES_TUPLES_MAX];
48 	struct rman		mem_rman;
49 	struct resource		*res;
50 	int			ecam;
51 	device_t		dev;
52 };
53 
54 uint32_t range_addr_is_pci(struct pcie_range *, uint64_t, uint64_t);
55 uint32_t range_addr_is_phys(struct pcie_range *, uint64_t, uint64_t);
56 uint64_t range_addr_pci_to_phys(struct pcie_range *, uint64_t);
57 int thunder_common_alloc_msi(device_t, device_t, int, int, int *);
58 int thunder_common_alloc_msix(device_t, device_t, int *);
59 int thunder_common_map_msi(device_t, device_t, int, uint64_t *, uint32_t *);
60 int thunder_common_release_msi(device_t, device_t, int, int *);
61 int thunder_common_release_msix(device_t, device_t, int);
62 
63 struct resource *thunder_pcie_alloc_resource(device_t,
64     device_t, int, int *, rman_res_t, rman_res_t, rman_res_t, u_int);
65 int thunder_pcie_release_resource(device_t, device_t, int, int,
66     struct resource *);
67 
68 int thunder_pcie_attach(device_t);
69 
70 #endif /* _CAVIUM_THUNDER_PCIE_COMMON_H_ */
71