xref: /netbsd/share/man/man4/man4.emips/intro.4 (revision 6550d01e)
1.\"
2.\" Copyright (c) 2010 Microsoft Corp.
3.\" Copyright (c) 2010 NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.\"	$NetBSD: intro.4,v 1.1 2011/01/26 01:18:48 pooka Exp $
27.\"
28.Dd July 17, 2010
29.Dt INTRO 4 emips
30.Os
31.Sh NAME
32.Nm intro
33.Nd introduction to emips special files and hardware support
34.Sh DESCRIPTION
35This section describes the special files, related driver functions,
36and networking support available in the system.
37In this part of the manual, the
38.Tn SYNOPSIS
39section of each configurable device gives a sample specification
40for use in constructing a system description for the
41.Xr config 1
42program.
43The
44.Tn DIAGNOSTICS
45section lists messages which may appear on the console
46and/or in the system error log
47.Pa /var/log/messages
48due to errors in device operation; see
49.Xr syslogd 8
50for more information.
51.Pp
52This section contains both devices which may be configured into
53the system and network related information.
54The networking support is introduced in
55.Xr netintro 4 .
56.Sh DEVICE SUPPORT
57This section describes the hardware supported on eMIPS
58(Microsoft Extensible MIPS processor)-based platforms.
59Software support for these devices comes in two forms.
60A hardware device may be supported with a character or block
61.Em device driver ,
62or it may be used within the networking subsystem and have a
63.Em network interface driver .
64Block and character devices are accessed through files in the file
65system of a special type; see
66.Xr mknod 8 .
67Network interfaces are indirectly accessed through the interprocess
68communication facilities provided by the system; see
69.Xr socket 2 .
70.Pp
71A hardware device is identified to the system at configuration time
72and the appropriate device or network interface driver is then compiled
73into the system.
74When the resultant system is booted, the autoconfiguration facilities
75in the system probe for the device and, if found, enable the software
76support for it.
77If a device does not respond at autoconfiguration
78time it is not accessible at any time afterwards.
79To enable a device which did not autoconfigure,
80the system must be rebooted.
81.Pp
82The autoconfiguration system is described in
83.Xr autoconf 4 .
84A list of the supported devices is given below.
85.Sh SEE ALSO
86.Xr config 1 ,
87.Xr autoconf 4
88.Sh SUPPORTED SYSTEMS
89The following systems are supported:
90.Pp
91.Bl -tag -width speaker -offset indent -compact
92.It BeSquare BErkeley Emulation System-3 FPGA development board
93known as the "BEE3". This is a quad-chip FPGA system where eMIPS can run on each FPGA separately,
94on multiple FPGAs in concert, and in multi-processor configurations.
95.It Xilinx University Program board
96known as "XUP". This is the Xilinx reference board for the Virtex-5 series chips.
97It can use the same XL110T FPGA chip present on the BEE3.
98.It Xilinx ML402
99Xilinx reference board for the Virtex-4 series chip, including the SX35.
100.It Xilinx ML401
101Same as the above, but with the smaller LX25 chip.
102.El
103.Sh LIST OF DEVICES
104The devices listed below are supported in this incarnation of the system.
105Devices are indicated by their functional interface.
106Not all supported devices are listed.
107.Pp
108.Bl -tag -width speaker -offset indent -compact
109.It ace
110Xilinx SystemACE interface for Compact-FLASH cards, bears similarities to the IDE interface.
111Present on XUP and ML40x boards. Not present on BEE3.
112.It dz
113serial driver for the eMIPS console serial device. Present on all systems.
114.It enic
115Ethernet driver for the eNIC device. Present on XUP and BEE3 systems. Not present on ML40x systems.
116.It eclock
117System clock, must be configured on all systems.
118.It ebus
119Extensible BUS, present on all systems.
120.El
121.Sh HISTORY
122This
123.Tn eMIPS
124.Nm intro
125appeared in
126.Nx 6.0 .
127