]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/dev/ofw/ofw_pci.h
patch(1): Fix a few mandoc related issues
[FreeBSD/FreeBSD.git] / sys / dev / ofw / ofw_pci.h
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-NetBSD
3  *
4  * Copyright (c) 1999 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9  * NASA Ames Research Center.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  *
32  *      from: NetBSD: ofw_pci.h,v 1.5 2003/10/22 09:04:39 mjl Exp
33  *
34  * $FreeBSD$
35  */
36
37 #ifndef _DEV_OFW_OFW_PCI_H_
38 #define _DEV_OFW_OFW_PCI_H_
39
40 /*
41  * PCI Bus Binding to:
42  *
43  * IEEE Std 1275-1994
44  * Standard for Boot (Initialization Configuration) Firmware
45  *
46  * Revision 2.1
47  */
48
49 /*
50  * Section 2.2.1. Physical Address Formats
51  *
52  * A PCI physical address is represented by 3 address cells:
53  *
54  *      phys.hi cell:   npt000ss bbbbbbbb dddddfff rrrrrrrr
55  *      phys.mid cell:  hhhhhhhh hhhhhhhh hhhhhhhh hhhhhhhh
56  *      phys.lo cell:   llllllll llllllll llllllll llllllll
57  *
58  *      n       nonrelocatable
59  *      p       prefetchable
60  *      t       aliased below 1MB (memory) or 64k (i/o)
61  *      ss      space code
62  *      b       bus number
63  *      d       device number
64  *      f       function number
65  *      r       register number
66  *      h       high 32-bits of PCI address
67  *      l       low 32-bits of PCI address
68  */
69
70 #define OFW_PCI_PHYS_HI_NONRELOCATABLE  0x80000000
71 #define OFW_PCI_PHYS_HI_PREFETCHABLE    0x40000000
72 #define OFW_PCI_PHYS_HI_ALIASED         0x20000000
73 #define OFW_PCI_PHYS_HI_SPACEMASK       0x03000000
74 #define OFW_PCI_PHYS_HI_BUSMASK         0x00ff0000
75 #define OFW_PCI_PHYS_HI_BUSSHIFT        16
76 #define OFW_PCI_PHYS_HI_DEVICEMASK      0x0000f800
77 #define OFW_PCI_PHYS_HI_DEVICESHIFT     11
78 #define OFW_PCI_PHYS_HI_FUNCTIONMASK    0x00000700
79 #define OFW_PCI_PHYS_HI_FUNCTIONSHIFT   8
80 #define OFW_PCI_PHYS_HI_REGISTERMASK    0x000000ff
81
82 #define OFW_PCI_PHYS_HI_SPACE_CONFIG    0x00000000
83 #define OFW_PCI_PHYS_HI_SPACE_IO        0x01000000
84 #define OFW_PCI_PHYS_HI_SPACE_MEM32     0x02000000
85 #define OFW_PCI_PHYS_HI_SPACE_MEM64     0x03000000
86
87 #define OFW_PCI_PHYS_HI_BUS(hi) \
88         (((hi) & OFW_PCI_PHYS_HI_BUSMASK) >> OFW_PCI_PHYS_HI_BUSSHIFT)
89 #define OFW_PCI_PHYS_HI_DEVICE(hi) \
90         (((hi) & OFW_PCI_PHYS_HI_DEVICEMASK) >> OFW_PCI_PHYS_HI_DEVICESHIFT)
91 #define OFW_PCI_PHYS_HI_FUNCTION(hi) \
92         (((hi) & OFW_PCI_PHYS_HI_FUNCTIONMASK) >> OFW_PCI_PHYS_HI_FUNCTIONSHIFT)
93
94 /*
95  * This has the 3 32bit cell values, plus 2 more to make up a 64-bit size.
96  */
97 struct ofw_pci_register {
98         u_int32_t       phys_hi;
99         u_int32_t       phys_mid;
100         u_int32_t       phys_lo;
101         u_int32_t       size_hi;
102         u_int32_t       size_lo;
103 };
104
105 #endif /* _DEV_OFW_OFW_PCI_H_ */