No empty .Rs/.Re
[netbsd-mini2440.git] / share / man / man4 / njata.4
blob3fb442616ed8c629ae0800f4a1aa55bcacae5e84
1 .\"     $NetBSD: njata.4,v 1.5 2007/03/08 13:05:51 itohy Exp $
2 .\"
3 .\" Copyright (c) 2006 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by ITOH Yasufumi.
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\"    notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in the
16 .\"    documentation and/or other materials provided with the distribution.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19 .\" ``AS IS'' AND 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 THE FOUNDATION OR CONTRIBUTORS
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 September 7, 2006
31 .Dt NJATA 4
32 .Os
33 .Sh NAME
34 .Nm njata
35 .Nd Workbit NinjaATA-32 CardBus IDE controller driver
36 .Sh SYNOPSIS
37 .Cd "njata* at cardbus? function ?"
38 .Cd "njata* at cardbus? function ? flags 0x01   # with wait 0x01"
39 .Sh DESCRIPTION
40 The
41 .Nm
42 driver provides support for the following
43 Workbit Bus-Master CardBus IDE controller chips:
44 .Pp
45 .Bl -tag -width "NinjaATA-32Bi" -offset indent
46 .It NinjaATA-32Bi
47 CardBus / PCMCIA dual mode IDE controller
48 .Pq Dq DuoATA .
49 This controller is mainly used for portable drives.
50 This driver supports the CardBus mode.
51 .It NPATA-32
52 CardBus IDE controller.
53 This controller is widely used for CardBus CompactFlash adapters.
54 .El
55 .Pp
56 These controllers are capable of bus-mastering
57 for ATA PIO transfer.
58 The
59 .Nm
60 driver uses the bus-mastering PIO transfer
61 unless transfer buffer is unaligned,
62 and significantly reduces CPU usage for PIO-only ATA devices
63 compared with usual PIO transfer.
64 .Sh CONFIGURATION
65 The optional flags parameter is the
66 .Dq wait
67 value for ATA transfers.
68 Some combinations of host and device may fail without flags parameter or
69 .Tn flags 0x00 .
70 In this case try adding wait values like
71 .Tn flags 0x01
73 .Tn flags 0x11
74 (the wait parameter is composed of two 4bit values).
75 Smaller wait values should be faster.
76 Too long waits may cause transfer errors.
77 .Sh SEE ALSO
78 .Xr ata 4 ,
79 .Xr atapi 4 ,
80 .Xr cardbus 4 ,
81 .Xr intro 4 ,
82 .Xr wd 4 ,
83 .Xr wdc 4
84 .Sh HISTORY
85 The
86 .Nm
87 device driver first appeared in
88 .Nx 4.0 .
89 .Sh AUTHORS
90 .An ITOH Yasufumi Aq itohy@NetBSD.org