NetBSD Problem Report #21268

Received: (qmail 22594 invoked by uid 605); 22 Apr 2003 22:02:49 -0000
Message-Id: <200304222202.h3MM2mL04988@digital.clock.org>
Date: Tue, 22 Apr 2003 15:02:48 -0700 (PDT)
From: fair@netbsd.org
Sender: gnats-bugs-owner@netbsd.org
Reply-To: fair@netbsd.org
To: gnats-bugs@gnats.netbsd.org
Subject: this port has no intro(4) man page
X-Send-Pr-Version: 3.95

>Number:         21268
>Category:       port-evbarm
>Synopsis:       this port has no intro(4) man page
>Confidential:   no
>Severity:       serious
>Priority:       medium
>Responsible:    port-evbarm-maintainer
>State:          closed
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Tue Apr 22 22:03:01 +0000 2003
>Closed-Date:    Tue Jan 20 15:23:19 +0000 2004
>Last-Modified:  Tue Jan 20 15:23:19 +0000 2004
>Originator:     Erik E. Fair
>Release:        NetBSD 1.6.1
>Organization:
NetBSD Project Picayune Nitpickers
>Environment:
>Description:

	Each port (platform) should have an intro(4) man page that describes
	the hardware that NetBSD supports and lists the devices found
	thereon, and the associated device driver man pages.

	The port should not release without this.

>How-To-Repeat:
	manual inspection of /usr/src/share/man/man4/man4.*/
>Fix:
	The portmaster or his designee should write one, and commit it.
>Release-Note:
>Audit-Trail:

From: Richard Earnshaw <rearnsha@arm.com>
To: gnats-bugs@netbsd.org, port-arm@netbsd.org
Cc: Richard.Earnshaw@arm.com
Subject: Re: port-evbarm/21268: this port has no intro(4) man page
Date: Sun, 07 Sep 2003 17:15:13 +0100

 This is a multipart MIME message.

 --==_Exmh_-13110780140
 Content-Type: text/plain; charset=us-ascii

 Here's a first stab for comments.  Based heavily on the contents of the 
 evbarm web page.

 R.



 --==_Exmh_-13110780140
 Content-Type: text/plain ; name="intro.4"; charset=us-ascii
 Content-Description: intro.4
 Content-Disposition: attachment; filename="intro.4"

 .\" $NetBSD: intro.4,v 1.1 2003/04/17 10:16:13 wiz Exp $
 .\"
 .\" Copyright (c) 2003 ARM Ltd
 .\" All rights reserved.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\" are met:
 .\" 1. Redistributions of source code must retain the above copyright
 .\"    notice, this list of conditions and the following disclaimer.
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
 .\" 3. The name of the company may not be used to endorse or promote
 .\"    products derived from this software without specific prior written
 .\"    permission.
 .\"
 .\" THIS SOFTWARE IS PROVIDED BY ARM LTD ``AS IS'' AND
 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL ARM LTD
 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
 .Dd September 7, 2003
 .Dt INTRO 4 evbarm
 .Os
 .Sh NAME
 .Nm intro
 .Nd introduction to evbarm special files and hardware support
 .Sh DESCRIPTION
 The evbarm port is really a collection of ports of 
 .Nx
 to a range of development and evaluation boards based on the ARM Architecture.
 .Pp
 This section describes the supported boards, the special files,
 related driver functions, and networking support available in each system.
 In this part of the manual, the
 .Tn SYNOPSIS
 section of
 each configurable device gives a sample specification
 for use in constructing a system description for the
 .Xr config 8
 program.
 The
 .Tn DIAGNOSTICS
 section lists messages which may appear on the console
 and/or in the system error log
 .Pa /var/log/messages
 due to errors in device operation;
 see
 .Xr syslogd 8
 for more information.
 .Pp
 This section contains both devices
 which may be configured into the system
 and network related information.
 The networking support is introduced in
 .Xr netintro 4 .
 .Sh SUPPORTED BOARDS
 Each supported board requires a custom kernel for that board.
 .Pp
 The following boards are currently supported by the evbarm configuration:
 .Pp
 .Bl -tag -width Integrator -offset indent -compact
 .It Integrator
 The Integrator/AP development system from ARM Ltd.  Supported processor boards
 include the CM1020E, CM1022E, CM920T.
 .It IQ80310
 The reference platform for the XScale-based IOP310 I/O processor from Intel.
 .It IQ80321
 The reference platform for the XScale-based IOP321 I/O processor from Intel.
 .It Npwr
 The Npwr board, from Team ASA, is based on the IOP310 processor from Intel and
 targetted at the network-attached storage space.
 .It IXM1200
 The reference platform for the XScale-based IXP1200 Network processor from 
 Intel.
 .It SMDK2410
 The reference platform for the ARM920T-based S3C2410 processor from Samsung.
 .It SMDK2800
 The reference platform for the ARM920T-based S3C2800 processor from Samsung.
 .It BRH
 The BRH (Big Red Head) is an evaluation and development platform from ADI
 Engineering, based on the XScale-based I80200 processor
 .It NTNP425B
 An evaluation and development platform from NOVATEC, using the XScale-based
 IXP425 processor.
 .It DBPXA250
 An evaluation and development platfrom from Intel, using the XScale-based
 PXA250 processor.
 .El
 .Sh DEVICE SUPPORT
 This section describes some of the hardware supported on the various boards.
 Software support for these devices comes in two forms.  A hardware
 device may be supported with a character or block
 .Em device driver ,
 or it may be used within the networking subsystem and have a
 .Em network interface driver .
 Block and character devices are accessed through files in the file
 system of a special type; see
 .Xr mknod 8 .
 Network interfaces are indirectly accessed through the interprocess
 communication facilities provided by the system; see
 .Xr socket 2 .
 .Pp
 A hardware device is identified to the system at configuration time
 and the appropriate device or network interface driver is then compiled
 into the system.  When the resultant system is booted, the
 autoconfiguration facilities in the system probe for the device
 and, if found, enable the software support for it.
 If a device does not respond at autoconfiguration
 time it is not accessible at any time afterwards.
 To enable a device which did not autoconfigure,
 the system must be rebooted.
 .Pp
 The autoconfiguration system is described in
 .Xr autoconf 4 .
 A list of the supported devices is given below.
 .Sh LIST OF DEVICES
 The devices listed below are supported in this incarnation of
 the system.  Devices are indicated by their functional interface.
 Not all supported devices are listed.
 .Pp
 On the Integrator:
 .Pp
 .Bl -tag -width speaker -offset indent -compact
 .It plcom
 The PrimeCell PL010 UART.
 .It plrtc
 The PrimeCell PL030 Real-time Clock
 .It fxp
 Intel i82559 Ethernet PCI card.
 .It ahc
 Adaptec aic7880 SCSI controller.
 .El
 Other PCI based cards may also work, but have not been tested.
 .Pp
 On the IQ80310:
 .Pp
 .Bl -tag -width speaker -offset indent -compact
 .It fxp
 On-board Intel i82559 Ethernet
 .It com
 On-board NS16550-compatible serial ports
 .El
 Other PCI devices in the PCI expansion slots.
 On the IQ80321:
 .Pp
 .Bl -tag -width speaker -offset indent -compact
 .It wm
 On-board Intel i82544EI Gigabit Ethernet
 .It com
 On-board NS16550-compatible serial port
 .It iopaau
 On-chip Application Accelerator Unit
 .It iopwdog
 On-chip watchdog timer.
 .El
 Other devices in the PCI expansion slots.
 .Pp
 On Npwr:
 .Pp
 .Bl -tag -width speaker -offset indent -compact
 .It wm
 On-board Intel i82544EI Gigabit Ethernet
 .It siop
 On-board LSI Logic 53c1010 Ultra160 SCSI
 .It com
 On-board NS16550-compatible serial port
 .El
 .Pp
 On the IXM1200:
 .Pp
 .Bl -tag -width speaker -offset indent -compact
 .It fxp
 On-board Intel i82559 Ethernet
 .It nppb
 On-board Intel i21555 Non-Transparent PCI-PCI Bridge
 .It ixpcom
 On-chip serial port
 .El
 .Pp
 On the SMDK2410:
 .Pp
 .Bl -tag -width speaker -offset indent -compact
 .It sscom
 On-chip serial ports
 .It ohci
 On-chip USB host controller
 .El
 .Pp
 On the SMDK2800:
 .Pp
 .Bl -tag -width speaker -offset indent -compact
 .It sscom
 On-chip serial ports
 .It sspci
 On-chip Host-PCI bridge
 .El
 Other devices in the PCI expansion slots.
 .Pp
 On the BRH:
 .Pp
 .Bl -tag -width speaker -offset indent -compact
 .It com
 On-board NS16550-compatible serial ports
 .It fxp
 On-board i82559 Ethernet controller
 .El
 Other devices in the PCI expansion slots.
 .Pp
 On the NtNP425B:
 .Pp
 .Bl -tag -width speaker -offset indent -compact
 .It ixpcom
 On-chip serial ports
 .It ixpwdog
 On-chip watchdog timer
 .El
 Other devices in the PCI/mPCI slot.
 .Pp
 On the DBPXA250:
 .Pp
 .Bl -tag -width speaker -offset indent -compact
 .It com
 On-board NS16550-compatible serial port
 .It sm
 On-board SMC91C96 Ethernet controller
 .It sacc
 On-board SA-1111 StrongARM companion chip
 .It pckbd
 PS/2 keyboard
 .It lcd
 640x480 LCD
 .El
 Other devices in the PCMCIA and CF card slots.
 .Sh SEE ALSO
 .Xr autoconf 4 ,
 .Xr config 8
 .Sh HISTORY
 The
 .Tn evbarm
 .Nm intro
 appeared in
 .Nx 2.0 .

 --==_Exmh_-13110780140--



From: Klaus Klein <kleink@reziprozitaet.de>
To: gnats-bugs@gnats.netbsd.org, rearnsha@netbsd.org
Cc:  
Subject: Re: port-evbarm/21268
Date: Tue, 20 Jan 2004 12:09:39 +0100

 On Tuesday 20 January 2004 11:06, you wrote:

 > [Responding to PR port-evbarm/24157]
 > [...]
 > This is a duplicate of PR 21268.
 > NOte that I wrote a sample intro(4) in response to that PR, but nobody
 > cared to take any notice of it or comment on it. See the original PR for
 > the page.

 Thank you!  I don't see anything that's obviously wrong with your
 intro(4), so please commit it.  (Thomas Klausner probably will, but
 this is almost inevitable :-).


 - Klaus

State-Changed-From-To: open->closed 
State-Changed-By: rearnsha 
State-Changed-When: Tue Jan 20 15:22:46 UTC 2004 
State-Changed-Why:  
Manual page added. 
>Unformatted:

Home	PR Database Search