Sync usage with man page.
[netbsd-mini2440.git] / share / man / man4 / man4.evbarm / iopaau.4
blobc338fcfcae7b590b3fe091d1b6ae812b7a1e34ad
1 .\"     $NetBSD: iopaau.4,v 1.3 2002/11/23 17:36:28 thorpej Exp $
2 .\"
3 .\" Copyright (c) 2002 Wasabi Systems, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" Written by Jason R. Thorpe for Wasabi Systems, Inc.
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 .\" 3. All advertising materials mentioning features or use of this software
17 .\"    must display the following acknowledgement:
18 .\"     This product includes software developed for the NetBSD Project by
19 .\"     Wasabi Systems, Inc.
20 .\" 4. The name of Wasabi Systems, Inc. may not be used to endorse
21 .\"    or promote products derived from this software without specific prior
22 .\"    written permission.
23 .\"
24 .\" THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
26 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
27 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
28 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 .\" POSSIBILITY OF SUCH DAMAGE.
35 .\"
36 .Dd August 2, 2002
37 .Dt IOPAAU 4 evbarm
38 .Os
39 .Sh NAME
40 .Nm iopaau
41 .Nd Intel I/O Processor Application Accelerator Unit
42 .Sh SYNOPSIS
43 .Cd iopxs* at mainbus?
44 .Cd iopaau* at iopxs?
45 .Sh DESCRIPTION
46 The Application Accelerator Unit, or AAU, provides hardware-assisted
47 support for performing block fills on a region of memory, XOR of
48 multiple regions of memory
49 .Pq parity computation ,
50 and parity verification.
51 .Pp
52 The
53 .Nm
54 driver supports the Application Accelerator Units on the following
55 Intel I/O Processors:
56 .Bl -bullet
57 .\" .It
58 .\" Intel i80312 Companion I/O
59 .\" .Pq IOP310
60 .It
61 Intel i80321 I/O Processor
62 .El
63 .Pp
64 The
65 .Nm
66 driver provides a back-end to the
67 .Xr dmover 9
68 interface, and supports the following
69 .Xr dmover 9
70 functions:
71 .Bl -tag -width "fill8XX"
72 .It zero
73 Zero a region of memory
74 .It fill8
75 Fill a region of memory with an 8-bit value
76 .It copy
77 Copy a region of memory
78 .It xor2
79 Perform an XOR of 2 input streams
80 .It xor3
81 Perform an XOR of 3 input streams
82 .It xor4
83 Perform an XOR of 4 input streams
84 .It xor5
85 Perform an XOR of 5 input streams
86 .It xor6
87 Perform an XOR of 6 input streams
88 .It xor7
89 Perform an XOR of 7 input streams
90 .It xor8
91 Perform an XOR of 8 input streams
92 .El
93 .Sh SEE ALSO
94 .Xr dmover 9
95 .Sh HISTORY
96 The
97 .Nm
98 device first appeared in
99 .Nx 2.0 .
100 .Sh AUTHORS
103 driver was written by
104 .An Jason R. Thorpe Aq thorpej@wasabisystems.com
105 and contributed by Wasabi Systems, Inc.
106 .Sh BUGS
107 Due to limitations in how scatter-gather is done by the AAU hardware,
108 a given DMA segment must be the same length for the output stream and
109 each input stream.  The easiest way to achieve this is to ensure that
110 all streams used in an AAU operation begin at the same offset into a
111 page.