xref: /freebsd/share/man/man4/fdtbus.4 (revision d37eb51047221dc3322b34db1038ff3aa533883f)
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.Dd July 12, 2010
29.Dt FDTBUS 4
30.Os
31.Sh NAME
32.Nm fdtbus
33.Nd Flattened Device Tree bus driver
34.Sh SYNOPSIS
35.Cd "options FDT"
36.Sh DESCRIPTION
37The
38.Nm
39abstract bus driver is the primary connection and translation layer between
40.Xr fdt 4
41hardware resources description and
42.Fx
43native newbus device drivers framework.
44For an embedded system
45.Nm
46represents peripherals typically found on a highly integrated chip
47(system-on-chip).
48.Pp
49The
50.Nm
51driver provides generic, common infrastructure for all
52.Xr fdt 4
53oriented device drivers, and its main responsibilities are the
54following:
55.Bl -bullet
56.It
57Creating newbus children that reflect
58.Xr fdt 4
59nodes in the flattened device tree.
60.It
61Managing SYS_RES_IRQ resources.
62.It
63Managing SYS_RES_MEMORY, SYS_RES_IOPORT resources.
64.El
65.Sh SEE ALSO
66.Xr fdt 4 ,
67.Xr openfirm 4 ,
68.Xr simplebus 4
69.Sh STANDARDS
70IEEE Std 1275: IEEE Standard for Boot (Initialization Configuration) Firmware:
71Core Requirements and Practices
72.Pq Vt Open Firmware .
73.Pp
74Power.org Standard for Embedded Power Architecture Platform Requirements
75.Pq Vt ePAPR .
76.Sh HISTORY
77The
78.Nm
79support first appeared in
80.Fx 9.0 .
81.Sh AUTHORS
82The
83.Nm
84support was developed by Semihalf under sponsorship from the FreeBSD
85Foundation.
86This manual page was written by
87.An Rafal Jaworowski .
88