xref: /freebsd/share/man/man4/fdtbus.4 (revision 6ae1554a5d9b318f8ad53ccc39fa5a961403da73)
1.\"
2.\" Copyright (c) 2010 The FreeBSD Foundation
3.\" All rights reserved.
4.\"
5.\" This software was developed by Semihalf under sponsorship from
6.\" the FreeBSD Foundation.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE.
28.\"
29.\" $FreeBSD$
30.\"
31.Dd July 12, 2010
32.Dt FDTBUS 4
33.Os
34.Sh NAME
35.Nm fdtbus
36.Nd Flattened Device Tree bus driver
37.Sh SYNOPSIS
38.Cd "options FDT"
39.Sh DESCRIPTION
40The
41.Nm
42abstract bus driver is the primary connection and translation layer between
43.Xr fdt 4
44hardware resources description and
45.Fx
46native newbus device drivers framework. For an embedded system
47.Nm
48represents peripherals typically found on a highly integrated chip
49(system-on-chip).
50.Pp
51The
52.Nm
53driver provides generic, common infrastructure for all
54.Xr fdt 4
55oriented device drivers, and its main responsibilities are the
56following:
57.Bl -bullet
58.It
59Creating newbus children that reflect
60.Xr fdt 4
61nodes in the flattened device tree.
62.It
63Managing SYS_RES_IRQ resources.
64.It
65Managing SYS_RES_MEMORY, SYS_RES_IOPORT resources.
66.El
67.Sh SEE ALSO
68.Xr fdt 4 ,
69.Xr openfirm 4 ,
70.Xr simplebus 4
71.Sh STANDARDS
72IEEE Std 1275: IEEE Standard for Boot (Initialization Configuration) Firmware:
73Core Requirements and Practices
74.Pq Vt Open Firmware .
75.Pp
76Power.org Standard for Embedded Power Architecture Platform Requirements
77.Pq Vt ePAPR .
78.Sh HISTORY
79The
80.Nm
81support first appeared in
82.Fx 9.0 .
83.Sh AUTHORS
84The
85.Nm
86support was developed by Semihalf under sponsorship from the FreeBSD
87Foundation. This manual page was written by
88.An Rafal Jaworowski .
89