Sync usage with man page.
[netbsd-mini2440.git] / share / man / man4 / man4.evbarm / intro.4
blobe793b702155b7fc25366632beb882f6b86b5c092
1 .\" $NetBSD: intro.4,v 1.4 2009/02/27 03:13:55 kenh Exp $
2 .\"
3 .\" Copyright (c) 2003 ARM Ltd
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 .\" 3. The name of the company may not be used to endorse or promote
15 .\"    products derived from this software without specific prior written
16 .\"    permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY ARM LTD ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL ARM LTD
22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGE.
29 .\"
30 .Dd February 27, 2009
31 .Dt INTRO 4 evbarm
32 .Os
33 .Sh NAME
34 .Nm intro
35 .Nd introduction to evbarm special files and hardware support
36 .Sh DESCRIPTION
37 The evbarm port is really a collection of ports of
38 .Nx
39 to a range of development and evaluation boards based on the ARM Architecture.
40 .Pp
41 This section describes the supported boards, the special files,
42 related driver functions, and networking support available in each system.
43 In this part of the manual, the
44 .Tn SYNOPSIS
45 section of
46 each configurable device gives a sample specification
47 for use in constructing a system description for the
48 .Xr config 1
49 program.
50 The
51 .Tn DIAGNOSTICS
52 section lists messages which may appear on the console
53 and/or in the system error log
54 .Pa /var/log/messages
55 due to errors in device operation;
56 see
57 .Xr syslogd 8
58 for more information.
59 .Pp
60 This section contains both devices
61 which may be configured into the system
62 and network related information.
63 The networking support is introduced in
64 .Xr netintro 4 .
65 .Sh SUPPORTED BOARDS
66 Each supported board requires a custom kernel for that board.
67 .Pp
68 The following boards are currently supported by the evbarm configuration:
69 .Pp
70 .Bl -tag -width Integrator -offset indent -compact
71 .It Integrator
72 The Integrator/AP development system from ARM Ltd.
73 Supported processor boards
74 include the CM10200E and CM920T.
75 .It IQ80310
76 The reference platform for the XScale-based IOP310 I/O processor from Intel.
77 .It IQ80321
78 The reference platform for the XScale-based IOP321 I/O processor from Intel.
79 .It Npwr
80 The Npwr board, from Team ASA, is based on the IOP310 processor from Intel and
81 targetted at the network-attached storage space.
82 .It IXM1200
83 The reference platform for the XScale-based IXP1200 Network processor from
84 Intel.
85 .It SMDK2410
86 The reference platform for the ARM920T-based S3C2410 processor from Samsung.
87 .It SMDK2800
88 The reference platform for the ARM920T-based S3C2800 processor from Samsung.
89 .It BRH
90 The BRH (Big Red Head) is an evaluation and development platform from ADI
91 Engineering, based on the XScale-based I80200 processor
92 .It NTNP425B
93 An evaluation and development platform from NOVATEC, using the XScale-based
94 IXP425 processor.
95 .It DBPXA250
96 An evaluation and development platfrom from Intel, using the XScale-based
97 PXA250 processor.
98 .It TS7200
99 The TS-7200 is a single-board computer from Technologic Systems,
100 and is based on the Cirrus Logic EP9302.
102 .Sh DEVICE SUPPORT
103 This section describes some of the hardware supported on the various boards.
104 Software support for these devices comes in two forms.
105 A hardware
106 device may be supported with a character or block
107 .Em device driver ,
108 or it may be used within the networking subsystem and have a
109 .Em network interface driver .
110 Block and character devices are accessed through files in the file
111 system of a special type; see
112 .Xr mknod 8 .
113 Network interfaces are indirectly accessed through the interprocess
114 communication facilities provided by the system; see
115 .Xr socket 2 .
117 A hardware device is identified to the system at configuration time
118 and the appropriate device or network interface driver is then compiled
119 into the system.
120 When the resultant system is booted, the
121 autoconfiguration facilities in the system probe for the device
122 and, if found, enable the software support for it.
123 If a device does not respond at autoconfiguration
124 time it is not accessible at any time afterwards.
125 To enable a device which did not autoconfigure,
126 the system must be rebooted.
128 The autoconfiguration system is described in
129 .Xr autoconf 4 .
130 A list of the supported devices is given below.
131 .Sh LIST OF DEVICES
132 The devices listed below are supported in this incarnation of
133 the system.
134 Devices are indicated by their functional interface.
135 Not all supported devices are listed.
137 On the Integrator:
139 .Bl -tag -width speaker -offset indent -compact
140 .It plcom
141 The PrimeCell PL010 UART.
142 .It plrtc
143 The PrimeCell PL030 Real-time Clock
144 .It fxp
145 Intel i82559 Ethernet PCI card.
146 .It ahc
147 Adaptec aic7880 SCSI controller.
149 Other PCI based cards may also work, but have not been tested.
151 On the IQ80310:
153 .Bl -tag -width speaker -offset indent -compact
154 .It fxp
155 On-board Intel i82559 Ethernet
156 .It com
157 On-board NS16550-compatible serial ports
159 Other PCI devices in the PCI expansion slots.
160 On the IQ80321:
162 .Bl -tag -width speaker -offset indent -compact
163 .It wm
164 On-board Intel i82544EI Gigabit Ethernet
165 .It com
166 On-board NS16550-compatible serial port
167 .It iopaau
168 On-chip Application Accelerator Unit
169 .It iopwdog
170 On-chip watchdog timer.
172 Other devices in the PCI expansion slots.
174 On Npwr:
176 .Bl -tag -width speaker -offset indent -compact
177 .It wm
178 On-board Intel i82544EI Gigabit Ethernet
179 .It siop
180 On-board LSI Logic 53c1010 Ultra160 SCSI
181 .It com
182 On-board NS16550-compatible serial port
185 On the IXM1200:
187 .Bl -tag -width speaker -offset indent -compact
188 .It fxp
189 On-board Intel i82559 Ethernet
190 .It nppb
191 On-board Intel i21555 Non-Transparent PCI-PCI Bridge
192 .It ixpcom
193 On-chip serial port
196 On the SMDK2410:
198 .Bl -tag -width speaker -offset indent -compact
199 .It sscom
200 On-chip serial ports
201 .It ohci
202 On-chip USB host controller
205 On the SMDK2800:
207 .Bl -tag -width speaker -offset indent -compact
208 .It sscom
209 On-chip serial ports
210 .It sspci
211 On-chip Host-PCI bridge
213 Other devices in the PCI expansion slots.
215 On the BRH:
217 .Bl -tag -width speaker -offset indent -compact
218 .It com
219 On-board NS16550-compatible serial ports
220 .It fxp
221 On-board i82559 Ethernet controller
223 Other devices in the PCI expansion slots.
225 On the NtNP425B:
227 .Bl -tag -width speaker -offset indent -compact
228 .It ixpcom
229 On-chip serial ports
230 .It ixpwdog
231 On-chip watchdog timer
233 Other devices in the PCI/mPCI slot.
235 On the DBPXA250:
237 .Bl -tag -width speaker -offset indent -compact
238 .It com
239 On-board NS16550-compatible serial port
240 .It sm
241 On-board SMC91C96 Ethernet controller
242 .It sacc
243 On-board SA-1111 StrongARM companion chip
244 .It pckbd
245 PS/2 keyboard
246 .It lcd
247 640x480 LCD
249 Other devices in the PCMCIA and CF card slots.
250 .Sh SEE ALSO
251 .Xr config 1 ,
252 .Xr autoconf 4
253 .Sh HISTORY
255 .Tn evbarm
256 .Nm intro
257 appeared in
258 .Nx 2.0 .