xref: /netbsd-src/share/man/man4/man4.emips/ebus.4 (revision 633f3639db593aa92599e0f49563a30ce60059e2)
1.\"	$NetBSD: ebus.4,v 1.4 2017/02/17 22:24:46 christos Exp $
2.\"
3.\" Copyright (c) 2010 NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This file is derived from work contributed by Microsoft Corporation.
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 ``AS IS'' AND ANY EXPRESS OR
18.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27.\"
28.Dd February 17, 2017
29.Dt EBUS 4 emips
30.Os
31.Sh NAME
32.Nm ebus
33.Nd eMIPS Extensible I/O BUS driver
34.Sh SYNOPSIS
35.Cd "ebus0 at mainbus0"
36.Sh DESCRIPTION
37.Nm
38is a virtual device for the Extensible I/O BUS realized with eMIPS
39on FPGA boards such as the BEE3, Xilinx XUP, and Xilinx ML40x systems.
40.Pp
41Devices on the BUS can generally be relocated and can be found by
42scanning the Peripheral Mapping Table at the top of the BUS physical space.
43The driver is responsible for identifying devices that are currently available,
44and to map them into the kernel virtual space during the kernel startup procedure.
45.Pp
46The
47.Nm
48driver manages the Extensible I/O BUS on eMIPS and provides
49.Pp
50.Bl -bullet -offset indent
51.It
52Address range management to avoid conflicts.
53.It
54Interrupt vector management.
55.It
56Other utility functions.
57.El
58.Pp
59.Nm
60is always required to run the
61.Nx
62kernel.
63.Sh SEE ALSO
64.Xr emips/ace 4 ,
65.Xr emips/dz 4 ,
66.Xr emips/eclock 4 ,
67.Xr emips/enic 4 ,
68.Xr emips/intro 4
69