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