aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorRob Landley <rob@landley.net>2008-02-07 03:13:30 -0500
committerLinus Torvalds <torvalds@woody.linux-foundation.org>2008-02-07 11:42:16 -0500
commit70d6d9db78c6c8078526298cdf13e6851696b790 (patch)
treedc9828a5ebd3a47f3a88b604681930ae3977d191 /Documentation
parent90ad38b7570fdbf209b8d0422eeac076838b94dc (diff)
Add section IDs to mtdnand.tmpl
Add section IDs to mtdnand.tmpl Signed-off-by: Rob Landley <rob@landley.net> Cc: "Randy.Dunlap" <rdunlap@xenotime.net> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/DocBook/mtdnand.tmpl58
1 files changed, 29 insertions, 29 deletions
diff --git a/Documentation/DocBook/mtdnand.tmpl b/Documentation/DocBook/mtdnand.tmpl
index 957cf5c26831..8e145857fc9d 100644
--- a/Documentation/DocBook/mtdnand.tmpl
+++ b/Documentation/DocBook/mtdnand.tmpl
@@ -80,7 +80,7 @@
80 struct member has a short description which is marked with an [XXX] identifier. 80 struct member has a short description which is marked with an [XXX] identifier.
81 The following chapters explain the meaning of those identifiers. 81 The following chapters explain the meaning of those identifiers.
82 </para> 82 </para>
83 <sect1> 83 <sect1 id="Function_identifiers_XXX">
84 <title>Function identifiers [XXX]</title> 84 <title>Function identifiers [XXX]</title>
85 <para> 85 <para>
86 The functions are marked with [XXX] identifiers in the short 86 The functions are marked with [XXX] identifiers in the short
@@ -115,7 +115,7 @@
115 </para></listitem> 115 </para></listitem>
116 </itemizedlist> 116 </itemizedlist>
117 </sect1> 117 </sect1>
118 <sect1> 118 <sect1 id="Struct_member_identifiers_XXX">
119 <title>Struct member identifiers [XXX]</title> 119 <title>Struct member identifiers [XXX]</title>
120 <para> 120 <para>
121 The struct members are marked with [XXX] identifiers in the 121 The struct members are marked with [XXX] identifiers in the
@@ -159,7 +159,7 @@
159 basic functions and fill out some really board dependent 159 basic functions and fill out some really board dependent
160 members in the nand chip description structure. 160 members in the nand chip description structure.
161 </para> 161 </para>
162 <sect1> 162 <sect1 id="Basic_defines">
163 <title>Basic defines</title> 163 <title>Basic defines</title>
164 <para> 164 <para>
165 At least you have to provide a mtd structure and 165 At least you have to provide a mtd structure and
@@ -185,7 +185,7 @@ static struct nand_chip board_chip;
185static unsigned long baseaddr; 185static unsigned long baseaddr;
186 </programlisting> 186 </programlisting>
187 </sect1> 187 </sect1>
188 <sect1> 188 <sect1 id="Partition_defines">
189 <title>Partition defines</title> 189 <title>Partition defines</title>
190 <para> 190 <para>
191 If you want to divide your device into partitions, then 191 If you want to divide your device into partitions, then
@@ -204,7 +204,7 @@ static struct mtd_partition partition_info[] = {
204}; 204};
205 </programlisting> 205 </programlisting>
206 </sect1> 206 </sect1>
207 <sect1> 207 <sect1 id="Hardware_control_functions">
208 <title>Hardware control function</title> 208 <title>Hardware control function</title>
209 <para> 209 <para>
210 The hardware control function provides access to the 210 The hardware control function provides access to the
@@ -246,7 +246,7 @@ static void board_hwcontrol(struct mtd_info *mtd, int cmd)
246} 246}
247 </programlisting> 247 </programlisting>
248 </sect1> 248 </sect1>
249 <sect1> 249 <sect1 id="Device_ready_function">
250 <title>Device ready function</title> 250 <title>Device ready function</title>
251 <para> 251 <para>
252 If the hardware interface has the ready busy pin of the NAND chip connected to a 252 If the hardware interface has the ready busy pin of the NAND chip connected to a
@@ -257,7 +257,7 @@ static void board_hwcontrol(struct mtd_info *mtd, int cmd)
257 the function must not be defined and the function pointer this->dev_ready is set to NULL. 257 the function must not be defined and the function pointer this->dev_ready is set to NULL.
258 </para> 258 </para>
259 </sect1> 259 </sect1>
260 <sect1> 260 <sect1 id="Init_function">
261 <title>Init function</title> 261 <title>Init function</title>
262 <para> 262 <para>
263 The init function allocates memory and sets up all the board 263 The init function allocates memory and sets up all the board
@@ -325,7 +325,7 @@ out:
325module_init(board_init); 325module_init(board_init);
326 </programlisting> 326 </programlisting>
327 </sect1> 327 </sect1>
328 <sect1> 328 <sect1 id="Exit_function">
329 <title>Exit function</title> 329 <title>Exit function</title>
330 <para> 330 <para>
331 The exit function is only neccecary if the driver is 331 The exit function is only neccecary if the driver is
@@ -359,7 +359,7 @@ module_exit(board_cleanup);
359 driver. For a list of functions which can be overridden by the board 359 driver. For a list of functions which can be overridden by the board
360 driver see the documentation of the nand_chip structure. 360 driver see the documentation of the nand_chip structure.
361 </para> 361 </para>
362 <sect1> 362 <sect1 id="Multiple_chip_control">
363 <title>Multiple chip control</title> 363 <title>Multiple chip control</title>
364 <para> 364 <para>
365 The nand driver can control chip arrays. Therefor the 365 The nand driver can control chip arrays. Therefor the
@@ -419,9 +419,9 @@ static void board_select_chip (struct mtd_info *mtd, int chip)
419} 419}
420 </programlisting> 420 </programlisting>
421 </sect1> 421 </sect1>
422 <sect1> 422 <sect1 id="Hardware_ECC_support">
423 <title>Hardware ECC support</title> 423 <title>Hardware ECC support</title>
424 <sect2> 424 <sect2 id="Functions_and_constants">
425 <title>Functions and constants</title> 425 <title>Functions and constants</title>
426 <para> 426 <para>
427 The nand driver supports three different types of 427 The nand driver supports three different types of
@@ -475,7 +475,7 @@ static void board_select_chip (struct mtd_info *mtd, int chip)
475 </itemizedlist> 475 </itemizedlist>
476 </para> 476 </para>
477 </sect2> 477 </sect2>
478 <sect2> 478 <sect2 id="Hardware_ECC_with_syndrome_calculation">
479 <title>Hardware ECC with syndrome calculation</title> 479 <title>Hardware ECC with syndrome calculation</title>
480 <para> 480 <para>
481 Many hardware ECC implementations provide Reed-Solomon 481 Many hardware ECC implementations provide Reed-Solomon
@@ -500,7 +500,7 @@ static void board_select_chip (struct mtd_info *mtd, int chip)
500 </para> 500 </para>
501 </sect2> 501 </sect2>
502 </sect1> 502 </sect1>
503 <sect1> 503 <sect1 id="Bad_Block_table_support">
504 <title>Bad block table support</title> 504 <title>Bad block table support</title>
505 <para> 505 <para>
506 Most NAND chips mark the bad blocks at a defined 506 Most NAND chips mark the bad blocks at a defined
@@ -552,7 +552,7 @@ static void board_select_chip (struct mtd_info *mtd, int chip)
552 allows faster access than always checking the 552 allows faster access than always checking the
553 bad block information on the flash chip itself. 553 bad block information on the flash chip itself.
554 </para> 554 </para>
555 <sect2> 555 <sect2 id="Flash_based_tables">
556 <title>Flash based tables</title> 556 <title>Flash based tables</title>
557 <para> 557 <para>
558 It may be desired or neccecary to keep a bad block table in FLASH. 558 It may be desired or neccecary to keep a bad block table in FLASH.
@@ -587,7 +587,7 @@ static void board_select_chip (struct mtd_info *mtd, int chip)
587 </itemizedlist> 587 </itemizedlist>
588 </para> 588 </para>
589 </sect2> 589 </sect2>
590 <sect2> 590 <sect2 id="User_defined_tables">
591 <title>User defined tables</title> 591 <title>User defined tables</title>
592 <para> 592 <para>
593 User defined tables are created by filling out a 593 User defined tables are created by filling out a
@@ -676,7 +676,7 @@ static void board_select_chip (struct mtd_info *mtd, int chip)
676 </para> 676 </para>
677 </sect2> 677 </sect2>
678 </sect1> 678 </sect1>
679 <sect1> 679 <sect1 id="Spare_area_placement">
680 <title>Spare area (auto)placement</title> 680 <title>Spare area (auto)placement</title>
681 <para> 681 <para>
682 The nand driver implements different possibilities for 682 The nand driver implements different possibilities for
@@ -730,7 +730,7 @@ struct nand_oobinfo {
730 </para></listitem> 730 </para></listitem>
731 </itemizedlist> 731 </itemizedlist>
732 </para> 732 </para>
733 <sect2> 733 <sect2 id="Placement_defined_by_fs_driver">
734 <title>Placement defined by fs driver</title> 734 <title>Placement defined by fs driver</title>
735 <para> 735 <para>
736 The calling function provides a pointer to a nand_oobinfo 736 The calling function provides a pointer to a nand_oobinfo
@@ -760,7 +760,7 @@ struct nand_oobinfo {
760 done according to the given scheme in the nand_oobinfo structure. 760 done according to the given scheme in the nand_oobinfo structure.
761 </para> 761 </para>
762 </sect2> 762 </sect2>
763 <sect2> 763 <sect2 id="Automatic_placement">
764 <title>Automatic placement</title> 764 <title>Automatic placement</title>
765 <para> 765 <para>
766 Automatic placement uses the built in defaults to place the 766 Automatic placement uses the built in defaults to place the
@@ -774,7 +774,7 @@ struct nand_oobinfo {
774 done according to the default builtin scheme. 774 done according to the default builtin scheme.
775 </para> 775 </para>
776 </sect2> 776 </sect2>
777 <sect2> 777 <sect2 id="User_space_placement_selection">
778 <title>User space placement selection</title> 778 <title>User space placement selection</title>
779 <para> 779 <para>
780 All non ecc functions like mtd->read and mtd->write use an internal 780 All non ecc functions like mtd->read and mtd->write use an internal
@@ -789,9 +789,9 @@ struct nand_oobinfo {
789 </para> 789 </para>
790 </sect2> 790 </sect2>
791 </sect1> 791 </sect1>
792 <sect1> 792 <sect1 id="Spare_area_autoplacement_default">
793 <title>Spare area autoplacement default schemes</title> 793 <title>Spare area autoplacement default schemes</title>
794 <sect2> 794 <sect2 id="pagesize_256">
795 <title>256 byte pagesize</title> 795 <title>256 byte pagesize</title>
796<informaltable><tgroup cols="3"><tbody> 796<informaltable><tgroup cols="3"><tbody>
797<row> 797<row>
@@ -843,7 +843,7 @@ pages this byte is reserved</entry>
843</row> 843</row>
844</tbody></tgroup></informaltable> 844</tbody></tgroup></informaltable>
845 </sect2> 845 </sect2>
846 <sect2> 846 <sect2 id="pagesize_512">
847 <title>512 byte pagesize</title> 847 <title>512 byte pagesize</title>
848<informaltable><tgroup cols="3"><tbody> 848<informaltable><tgroup cols="3"><tbody>
849<row> 849<row>
@@ -906,7 +906,7 @@ in this page</entry>
906</row> 906</row>
907</tbody></tgroup></informaltable> 907</tbody></tgroup></informaltable>
908 </sect2> 908 </sect2>
909 <sect2> 909 <sect2 id="pagesize_2048">
910 <title>2048 byte pagesize</title> 910 <title>2048 byte pagesize</title>
911<informaltable><tgroup cols="3"><tbody> 911<informaltable><tgroup cols="3"><tbody>
912<row> 912<row>
@@ -1126,9 +1126,9 @@ in this page</entry>
1126 <para> 1126 <para>
1127 This chapter describes the constants which might be relevant for a driver developer. 1127 This chapter describes the constants which might be relevant for a driver developer.
1128 </para> 1128 </para>
1129 <sect1> 1129 <sect1 id="Chip_option_constants">
1130 <title>Chip option constants</title> 1130 <title>Chip option constants</title>
1131 <sect2> 1131 <sect2 id="Constants_for_chip_id_table">
1132 <title>Constants for chip id table</title> 1132 <title>Constants for chip id table</title>
1133 <para> 1133 <para>
1134 These constants are defined in nand.h. They are ored together to describe 1134 These constants are defined in nand.h. They are ored together to describe
@@ -1153,7 +1153,7 @@ in this page</entry>
1153 </programlisting> 1153 </programlisting>
1154 </para> 1154 </para>
1155 </sect2> 1155 </sect2>
1156 <sect2> 1156 <sect2 id="Constants_for_runtime_options">
1157 <title>Constants for runtime options</title> 1157 <title>Constants for runtime options</title>
1158 <para> 1158 <para>
1159 These constants are defined in nand.h. They are ored together to describe 1159 These constants are defined in nand.h. They are ored together to describe
@@ -1171,7 +1171,7 @@ in this page</entry>
1171 </sect2> 1171 </sect2>
1172 </sect1> 1172 </sect1>
1173 1173
1174 <sect1> 1174 <sect1 id="EEC_selection_constants">
1175 <title>ECC selection constants</title> 1175 <title>ECC selection constants</title>
1176 <para> 1176 <para>
1177 Use these constants to select the ECC algorithm. 1177 Use these constants to select the ECC algorithm.
@@ -1192,7 +1192,7 @@ in this page</entry>
1192 </para> 1192 </para>
1193 </sect1> 1193 </sect1>
1194 1194
1195 <sect1> 1195 <sect1 id="Hardware_control_related_constants">
1196 <title>Hardware control related constants</title> 1196 <title>Hardware control related constants</title>
1197 <para> 1197 <para>
1198 These constants describe the requested hardware access function when 1198 These constants describe the requested hardware access function when
@@ -1218,7 +1218,7 @@ in this page</entry>
1218 </para> 1218 </para>
1219 </sect1> 1219 </sect1>
1220 1220
1221 <sect1> 1221 <sect1 id="Bad_block_table_constants">
1222 <title>Bad block table related constants</title> 1222 <title>Bad block table related constants</title>
1223 <para> 1223 <para>
1224 These constants describe the options used for bad block 1224 These constants describe the options used for bad block