xref: /freebsd/share/man/man4/fdtbus.4 (revision 38a52bd3)
1.\"
2.\" Copyright (c) 2010 The FreeBSD Foundation
3.\"
4.\" This software was developed by Semihalf under sponsorship from
5.\" the FreeBSD Foundation.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\" $FreeBSD$
29.\"
30.Dd July 12, 2010
31.Dt FDTBUS 4
32.Os
33.Sh NAME
34.Nm fdtbus
35.Nd Flattened Device Tree bus driver
36.Sh SYNOPSIS
37.Cd "options FDT"
38.Sh DESCRIPTION
39The
40.Nm
41abstract bus driver is the primary connection and translation layer between
42.Xr fdt 4
43hardware resources description and
44.Fx
45native newbus device drivers framework.
46For 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.
88This manual page was written by
89.An Rafal Jaworowski .
90