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