/share/man/man4/simplebus.4

 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 SIMPLEBUS 4
33.Os
34.Sh NAME
35.Nm simplebus
36.Nd ePAPR simple-bus driver
37.Sh SYNOPSIS
38.Cd "options FDT"
39.Sh DESCRIPTION
40This bus driver is dedicated for the
41.Pa simple-bus
42node of a flattened device tree compliant with the
43.Pa ePAPR
44specification.
45.Pp
46The
47.Nm
48entity does not represent any physical element by itself, it is rather an
49umbrella node grouping integrated on-chip peripherals like interrupt
50controller, connectivity controllers, accelerating engines and so on.
51.Pp
52The driver is generic and common for all flattened device tree nodes claiming
53.Pa simple-bus
54compatibility. It 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. This manual page was written by
82.An Rafal Jaworowski .