xref: /freebsd/share/man/man4/simplebus.4 (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
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 SIMPLEBUS 4
32.Os
33.Sh NAME
34.Nm simplebus
35.Nd ePAPR simple-bus driver
36.Sh SYNOPSIS
37.Cd "options FDT"
38.Sh DESCRIPTION
39This bus driver is dedicated for the
40.Pa simple-bus
41node of a flattened device tree compliant with the
42.Pa ePAPR
43specification.
44.Pp
45The
46.Nm
47entity does not represent any physical element by itself, it is rather an
48umbrella node grouping integrated on-chip peripherals like interrupt
49controller, connectivity controllers, accelerating engines and so on.
50.Pp
51The driver is generic and common for all flattened device tree nodes claiming
52.Pa simple-bus
53compatibility.
54It iterates over direct descendants of the
55.Pa simple-bus
56node, instantiates newbus children and assigns resources to them, based on the
57configuration data retrieved from the nodes properties in
58.Xr fdt 4 .
59.Pp
60Note the
61.Nm
62does not manage device resources and passes through any requests to the
63.Xr fdtbus 4
64layer.
65.Sh SEE ALSO
66.Xr fdt 4 ,
67.Xr fdtbus 4 ,
68.Xr openfirm 4
69.Sh STANDARDS
70Power.org Standard for Embedded Power Architecture Platform Requirements
71.Pq Vt ePAPR .
72.Sh HISTORY
73The
74.Nm
75support first appeared in
76.Fx 9.0 .
77.Sh AUTHORS
78The
79.Nm
80support was developed by Semihalf under sponsorship from the FreeBSD
81Foundation.
82This manual page was written by
83.An Rafal Jaworowski .
84