From owner-svn-src-all@FreeBSD.ORG Tue Apr 29 07:45:22 2014 Return-Path: Delivered-To: svn-src-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id 9D89145E; Tue, 29 Apr 2014 07:45:22 +0000 (UTC) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 700141DC2; Tue, 29 Apr 2014 07:45:22 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.8/8.14.8) with ESMTP id s3T7jM1D007129; Tue, 29 Apr 2014 07:45:22 GMT (envelope-from brueffer@svn.freebsd.org) Received: (from brueffer@localhost) by svn.freebsd.org (8.14.8/8.14.8/Submit) id s3T7jMNG007128; Tue, 29 Apr 2014 07:45:22 GMT (envelope-from brueffer@svn.freebsd.org) Message-Id: <201404290745.s3T7jMNG007128@svn.freebsd.org> From: Christian Brueffer Date: Tue, 29 Apr 2014 07:45:22 +0000 (UTC) To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r265088 - head/share/man/man4 X-SVN-Group: head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-src-all@freebsd.org X-Mailman-Version: 2.1.17 Precedence: list List-Id: "SVN commit messages for the entire src tree \(except for " user" and " projects" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 29 Apr 2014 07:45:22 -0000 Author: brueffer Date: Tue Apr 29 07:45:21 2014 New Revision: 265088 URL: http://svnweb.freebsd.org/changeset/base/265088 Log: Add standard SYNOPSIS wording, fix typos, contractions and new sentence -> new line. Modified: head/share/man/man4/proto.4 Modified: head/share/man/man4/proto.4 ============================================================================== --- head/share/man/man4/proto.4 Tue Apr 29 07:29:13 2014 (r265087) +++ head/share/man/man4/proto.4 Tue Apr 29 07:45:21 2014 (r265088) @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd April 21, 2014 +.Dd April 29, 2014 .Dt PROTO 4 .Os .\" @@ -34,7 +34,19 @@ .Nd Driver for prototyping and H/W diagnostics .\" .Sh SYNOPSIS +To compile this driver into the kernel, +place the following line in your +kernel configuration file: +.Bd -ragged -offset indent .Cd "device proto" +.Ed +.Pp +Alternatively, to load the driver as a +module at boot time, place the following line in +.Xr loader.conf 5 : +.Bd -literal -offset indent +proto_load="YES" +.Ed .\" .Sh DESCRIPTION The @@ -43,7 +55,7 @@ device driver attaches to PCI devices wh present and creates device special files for all resources associated with the device. The driver itself has no knowledge of the device it attaches to. -Programs can open these device special files and peform register-level +Programs can open these device special files and perform register-level reads and writes. As such, the .Nm @@ -51,7 +63,7 @@ device driver is nothing but a conduit o programs and the hardware device. .Pp Examples for why this is useful include hardware diagnostics and prototyping. -In both these use cases, it's far more convenient to develop and run the +In both these use cases, it is far more convenient to develop and run the logic in user space. Especially hardware diagnostics requires a somewhat user-friendly interface and adequate reporting. @@ -108,8 +120,9 @@ Since interrupts cannot be handled by th into signals and delivered to the program that has registered for interrupts. .Pp In order to test the transmission or reception of data, some means of doing -direct memory access (DMA) by the device must be possible. This too much be -under the control of the program. The details of how a program can setup and +direct memory access (DMA) by the device must be possible. +This too must be under the control of the program. +The details of how a program can set up and initiate DMA still need to be fleshed out. .Pp Support for non-PCI devices has not been implemented yet.