tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
docs: mips: add to the documentation body as ReST
Manually convert the AU1xxx_IDE.README file to ReST and add
to a MIPS book as part of the main documentation body.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Acked-by: Paul Burton <paul.burton@mips.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
authored by
Mauro Carvalho Chehab
and committed by
Jonathan Corbet
80b15058
ff497db2
+70
-37
+1
Documentation/index.rst
+1
Documentation/index.rst
+52
-37
Documentation/mips/AU1xxx_IDE.README
Documentation/mips/au1xxx_ide.rst
+52
-37
Documentation/mips/AU1xxx_IDE.README
Documentation/mips/au1xxx_ide.rst
···
1
-
README for MIPS AU1XXX IDE driver - Released 2005-07-15
1
+
.. include:: <isonum.txt>
2
2
3
-
ABOUT
4
-
-----
3
+
======================
4
+
MIPS AU1XXX IDE driver
5
+
======================
6
+
7
+
Released 2005-07-15
8
+
9
+
About
10
+
=====
11
+
5
12
This file describes the 'drivers/ide/au1xxx-ide.c', related files and the
6
13
services they provide.
7
14
···
17
10
section.
18
11
19
12
20
-
LICENSE
21
-
-------
13
+
License
14
+
=======
22
15
23
-
Copyright (c) 2003-2005 AMD, Personal Connectivity Solutions
16
+
:Copyright: |copy| 2003-2005 AMD, Personal Connectivity Solutions
24
17
25
18
This program is free software; you can redistribute it and/or modify it under
26
19
the terms of the GNU General Public License as published by the Free Software
27
20
Foundation; either version 2 of the License, or (at your option) any later
28
21
version.
29
22
30
-
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
23
+
THIS SOFTWARE IS PROVIDED ``AS IS`` AND ANY EXPRESS OR IMPLIED WARRANTIES,
31
24
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
32
25
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR
33
26
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
···
42
35
this program; if not, write to the Free Software Foundation, Inc.,
43
36
675 Mass Ave, Cambridge, MA 02139, USA.
44
37
45
-
Note: for more information, please refer "AMD Alchemy Au1200/Au1550 IDE
38
+
Note:
39
+
for more information, please refer "AMD Alchemy Au1200/Au1550 IDE
46
40
Interface and Linux Device Driver" Application Note.
47
41
48
42
49
-
FILES, CONFIGS AND COMPATIBILITY
50
-
--------------------------------
43
+
Files, Configs and Compatibility
44
+
================================
51
45
52
46
Two files are introduced:
53
47
54
48
a) 'arch/mips/include/asm/mach-au1x00/au1xxx_ide.h'
55
49
contains : struct _auide_hwif
56
-
timing parameters for PIO mode 0/1/2/3/4
57
-
timing parameters for MWDMA 0/1/2
50
+
51
+
- timing parameters for PIO mode 0/1/2/3/4
52
+
- timing parameters for MWDMA 0/1/2
58
53
59
54
b) 'drivers/ide/mips/au1xxx-ide.c'
60
55
contains the functionality of the AU1XXX IDE driver
61
56
62
57
Following extra configs variables are introduced:
63
58
64
-
CONFIG_BLK_DEV_IDE_AU1XXX_PIO_DBDMA - enable the PIO+DBDMA mode
65
-
CONFIG_BLK_DEV_IDE_AU1XXX_MDMA2_DBDMA - enable the MWDMA mode
59
+
CONFIG_BLK_DEV_IDE_AU1XXX_PIO_DBDMA
60
+
- enable the PIO+DBDMA mode
61
+
CONFIG_BLK_DEV_IDE_AU1XXX_MDMA2_DBDMA
62
+
- enable the MWDMA mode
66
63
67
64
68
-
SUPPORTED IDE MODES
69
-
-------------------
65
+
Supported IDE Modes
66
+
===================
70
67
71
68
The AU1XXX IDE driver supported all PIO modes - PIO mode 0/1/2/3/4 - and all
72
69
MWDMA modes - MWDMA 0/1/2 -. There is no support for SWDMA and UDMA mode.
···
80
69
-X, e.g. 'hdparm -X32 [device]' for MWDMA mode 0.
81
70
82
71
83
-
PERFORMANCE CONFIGURATIONS
84
-
--------------------------
72
+
Performance Configurations
73
+
==========================
85
74
86
-
If the used system doesn't need USB support enable the following kernel configs:
75
+
If the used system doesn't need USB support enable the following kernel
76
+
configs::
87
77
88
-
CONFIG_IDE=y
89
-
CONFIG_BLK_DEV_IDE=y
90
-
CONFIG_IDE_GENERIC=y
91
-
CONFIG_BLK_DEV_IDEPCI=y
92
-
CONFIG_BLK_DEV_GENERIC=y
93
-
CONFIG_BLK_DEV_IDEDMA_PCI=y
94
-
CONFIG_BLK_DEV_IDE_AU1XXX=y
95
-
CONFIG_BLK_DEV_IDE_AU1XXX_MDMA2_DBDMA=y
96
-
CONFIG_BLK_DEV_IDEDMA=y
78
+
CONFIG_IDE=y
79
+
CONFIG_BLK_DEV_IDE=y
80
+
CONFIG_IDE_GENERIC=y
81
+
CONFIG_BLK_DEV_IDEPCI=y
82
+
CONFIG_BLK_DEV_GENERIC=y
83
+
CONFIG_BLK_DEV_IDEDMA_PCI=y
84
+
CONFIG_BLK_DEV_IDE_AU1XXX=y
85
+
CONFIG_BLK_DEV_IDE_AU1XXX_MDMA2_DBDMA=y
86
+
CONFIG_BLK_DEV_IDEDMA=y
97
87
98
88
Also define 'IDE_AU1XXX_BURSTMODE' in 'drivers/ide/mips/au1xxx-ide.c' to enable
99
89
the burst support on DBDMA controller.
···
102
90
If the used system need the USB support enable the following kernel configs for
103
91
high IDE to USB throughput.
104
92
105
-
CONFIG_IDE_GENERIC=y
106
-
CONFIG_BLK_DEV_IDEPCI=y
107
-
CONFIG_BLK_DEV_GENERIC=y
108
-
CONFIG_BLK_DEV_IDEDMA_PCI=y
109
-
CONFIG_BLK_DEV_IDE_AU1XXX=y
110
-
CONFIG_BLK_DEV_IDE_AU1XXX_MDMA2_DBDMA=y
111
-
CONFIG_BLK_DEV_IDEDMA=y
93
+
::
94
+
95
+
CONFIG_IDE_GENERIC=y
96
+
CONFIG_BLK_DEV_IDEPCI=y
97
+
CONFIG_BLK_DEV_GENERIC=y
98
+
CONFIG_BLK_DEV_IDEDMA_PCI=y
99
+
CONFIG_BLK_DEV_IDE_AU1XXX=y
100
+
CONFIG_BLK_DEV_IDE_AU1XXX_MDMA2_DBDMA=y
101
+
CONFIG_BLK_DEV_IDEDMA=y
112
102
113
103
Also undefine 'IDE_AU1XXX_BURSTMODE' in 'drivers/ide/mips/au1xxx-ide.c' to
114
104
disable the burst support on DBDMA controller.
115
105
116
106
117
-
ACKNOWLEDGMENTS
118
-
---------------
107
+
Acknowledgments
108
+
===============
119
109
120
110
These drivers wouldn't have been done without the base of kernel 2.4.x AU1XXX
121
111
IDE driver from AMD.
···
126
112
Matthias Lenk <matthias.lenk@amd.com>
127
113
128
114
Happy hacking!
115
+
129
116
Enrico Walther <enrico.walther@amd.com>
+17
Documentation/mips/index.rst
+17
Documentation/mips/index.rst