Fix mdoc(7)/man(7) mix up.
[netbsd-mini2440.git] / lib / libarch / arm / arm_drain_writebuf.2
blob097366820d3fd8c909074813b7dcd6292ce6db74
1 .\"     $NetBSD: arm_drain_writebuf.2,v 1.2 2003/04/16 13:34:34 wiz Exp $
2 .\"
3 .\" Copyright (c) 1997 Mark Brinicombe
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. All advertising materials mentioning features or use of this software
15 .\"    must display the following acknowledgement:
16 .\"     This product includes software developed by Mark Brinicombe
17 .\" 4. Neither the name of the University nor the names of its contributors
18 .\"    may be used to endorse or promote products derived from this software
19 .\"    without specific prior written permission.
20 .\"
21 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .\" SUCH DAMAGE.
32 .\"
33 .Dd March 29, 2002
34 .Dt ARM_DRAIN_WRITEBUF 2 arm
35 .Os
36 .Sh NAME
37 .Nm arm_drain_writebuf
38 .Nd drains the CPU write buffer
39 .Sh LIBRARY
40 .Lb libarm
41 .Sh SYNOPSIS
42 .In machine/sysarch.h
43 .Ft int
44 .Fn arm_drain_writebuf
45 .Sh DESCRIPTION
46 .Fn arm_drain_writebuf
47 will make sure that all the entries in the processor write buffer are
48 written out to memory.
49 .Pp
50 Not all processors support this operation (currently only the SA110).
51 Those processes that do not treat this function as a null-op.
52 .Sh ERRORS
53 .Fn arm_drain_writebuf
54 will never fail so will always return 0.
55 .Sh REFERENCES
56 StrongARM Data Sheet