xref: /freebsd/sys/dev/ofw/ofw_subr.h (revision 3416500aef140042c64bc149cb1ec6620483bc44)
1 /*-
2  * Copyright (c) 2015 Ian Lepore <ian@freebsd.org>
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	_DEV_OFW_OFW_SUBR_H_
30 #define	_DEV_OFW_OFW_SUBR_H_
31 
32 /*
33  * Translate an address from the Nth tuple of a device node's reg properties to
34  * a physical memory address, by applying the range mappings from all ancestors.
35  * This assumes that all ancestor ranges are simple numerical offsets for which
36  * addition and subtraction operations will perform the required mapping (the
37  * bit-options in the high word of standard PCI properties are also handled).
38  * After the call, *pci_hi (if non-NULL) contains the phys.hi cell of the
39  * device's parent PCI bus, or OFW_PADDR_NOT_PCI if no PCI bus is involved.
40  *
41  * This is intended to be a helper function called by the platform-specific
42  * implementation of OF_decode_addr(), and not for direct use by device drivers.
43  */
44 #define	OFW_PADDR_NOT_PCI	(~0)
45 
46 int ofw_reg_to_paddr(phandle_t _dev, int _regno, bus_addr_t *_paddr,
47     bus_size_t *_size, pcell_t *_pci_hi);
48 
49 int ofw_parse_bootargs(void);
50 
51 #endif
52