projects
/
cascardo
/
linux.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Merge branch 'link_removal' of git://www.jni.nu/cris
[cascardo/linux.git]
/
Documentation
/
DocBook
/
mtdnand.tmpl
diff --git
a/Documentation/DocBook/mtdnand.tmpl
b/Documentation/DocBook/mtdnand.tmpl
index
999afe1
..
8e14585
100644
(file)
--- a/
Documentation/DocBook/mtdnand.tmpl
+++ b/
Documentation/DocBook/mtdnand.tmpl
@@
-80,7
+80,7
@@
struct member has a short description which is marked with an [XXX] identifier.
The following chapters explain the meaning of those identifiers.
</para>
struct member has a short description which is marked with an [XXX] identifier.
The following chapters explain the meaning of those identifiers.
</para>
- <sect1
>
+ <sect1
id="Function_identifiers_XXX">
<title>Function identifiers [XXX]</title>
<para>
The functions are marked with [XXX] identifiers in the short
<title>Function identifiers [XXX]</title>
<para>
The functions are marked with [XXX] identifiers in the short
@@
-109,13
+109,13
@@
for most of the implementations. These functions can be replaced by the
board driver if neccecary. Those functions are called via pointers in the
NAND chip description structure. The board driver can set the functions which
for most of the implementations. These functions can be replaced by the
board driver if neccecary. Those functions are called via pointers in the
NAND chip description structure. The board driver can set the functions which
- should be replaced by board dependen
d
functions before calling nand_scan().
+ should be replaced by board dependen
t
functions before calling nand_scan().
If the function pointer is NULL on entry to nand_scan() then the pointer
is set to the default function which is suitable for the detected chip type.
</para></listitem>
</itemizedlist>
</sect1>
If the function pointer is NULL on entry to nand_scan() then the pointer
is set to the default function which is suitable for the detected chip type.
</para></listitem>
</itemizedlist>
</sect1>
- <sect1
>
+ <sect1
id="Struct_member_identifiers_XXX">
<title>Struct member identifiers [XXX]</title>
<para>
The struct members are marked with [XXX] identifiers in the
<title>Struct member identifiers [XXX]</title>
<para>
The struct members are marked with [XXX] identifiers in the
@@
-133,7
+133,7
@@
[REPLACEABLE]</para><para>
Replaceable members hold hardware related functions which can be
provided by the board driver. The board driver can set the functions which
[REPLACEABLE]</para><para>
Replaceable members hold hardware related functions which can be
provided by the board driver. The board driver can set the functions which
- should be replaced by board dependen
d
functions before calling nand_scan().
+ should be replaced by board dependen
t
functions before calling nand_scan().
If the function pointer is NULL on entry to nand_scan() then the pointer
is set to the default function which is suitable for the detected chip type.
</para></listitem>
If the function pointer is NULL on entry to nand_scan() then the pointer
is set to the default function which is suitable for the detected chip type.
</para></listitem>
@@
-156,11
+156,10
@@
<title>Basic board driver</title>
<para>
For most boards it will be sufficient to provide just the
<title>Basic board driver</title>
<para>
For most boards it will be sufficient to provide just the
- basic functions and fill out some really board dependen
d
+ basic functions and fill out some really board dependen
t
members in the nand chip description structure.
members in the nand chip description structure.
- See drivers/mtd/nand/skeleton for reference.
</para>
</para>
- <sect1>
+ <sect1
id="Basic_defines"
>
<title>Basic defines</title>
<para>
At least you have to provide a mtd structure and
<title>Basic defines</title>
<para>
At least you have to provide a mtd structure and
@@
-186,7
+185,7
@@
static struct nand_chip board_chip;
static unsigned long baseaddr;
</programlisting>
</sect1>
static unsigned long baseaddr;
</programlisting>
</sect1>
- <sect1>
+ <sect1
id="Partition_defines"
>
<title>Partition defines</title>
<para>
If you want to divide your device into partitions, then
<title>Partition defines</title>
<para>
If you want to divide your device into partitions, then
@@
-205,7
+204,7
@@
static struct mtd_partition partition_info[] = {
};
</programlisting>
</sect1>
};
</programlisting>
</sect1>
- <sect1>
+ <sect1
id="Hardware_control_functions"
>
<title>Hardware control function</title>
<para>
The hardware control function provides access to the
<title>Hardware control function</title>
<para>
The hardware control function provides access to the
@@
-247,7
+246,7
@@
static void board_hwcontrol(struct mtd_info *mtd, int cmd)
}
</programlisting>
</sect1>
}
</programlisting>
</sect1>
- <sect1>
+ <sect1
id="Device_ready_function"
>
<title>Device ready function</title>
<para>
If the hardware interface has the ready busy pin of the NAND chip connected to a
<title>Device ready function</title>
<para>
If the hardware interface has the ready busy pin of the NAND chip connected to a
@@
-258,7
+257,7
@@
static void board_hwcontrol(struct mtd_info *mtd, int cmd)
the function must not be defined and the function pointer this->dev_ready is set to NULL.
</para>
</sect1>
the function must not be defined and the function pointer this->dev_ready is set to NULL.
</para>
</sect1>
- <sect1>
+ <sect1
id="Init_function"
>
<title>Init function</title>
<para>
The init function allocates memory and sets up all the board
<title>Init function</title>
<para>
The init function allocates memory and sets up all the board
@@
-276,17
+275,14
@@
int __init board_init (void)
int err = 0;
/* Allocate memory for MTD device structure and private data */
int err = 0;
/* Allocate memory for MTD device structure and private data */
- board_mtd = k
malloc (sizeof(struct mtd_info) + sizeof
(struct nand_chip), GFP_KERNEL);
+ board_mtd = k
zalloc(sizeof(struct mtd_info) + sizeof
(struct nand_chip), GFP_KERNEL);
if (!board_mtd) {
printk ("Unable to allocate NAND MTD device structure.\n");
err = -ENOMEM;
goto out;
}
if (!board_mtd) {
printk ("Unable to allocate NAND MTD device structure.\n");
err = -ENOMEM;
goto out;
}
- /* Initialize structures */
- memset ((char *) board_mtd, 0, sizeof(struct mtd_info) + sizeof(struct nand_chip));
-
- /* map physical adress */
+ /* map physical address */
baseaddr = (unsigned long)ioremap(CHIP_PHYSICAL_ADDRESS, 1024);
if(!baseaddr){
printk("Ioremap to access NAND chip failed\n");
baseaddr = (unsigned long)ioremap(CHIP_PHYSICAL_ADDRESS, 1024);
if(!baseaddr){
printk("Ioremap to access NAND chip failed\n");
@@
-310,7
+306,7
@@
int __init board_init (void)
this->dev_ready = board_dev_ready;
this->eccmode = NAND_ECC_SOFT;
this->dev_ready = board_dev_ready;
this->eccmode = NAND_ECC_SOFT;
- /* Scan to find exist
a
nce of the device */
+ /* Scan to find exist
e
nce of the device */
if (nand_scan (board_mtd, 1)) {
err = -ENXIO;
goto out_ior;
if (nand_scan (board_mtd, 1)) {
err = -ENXIO;
goto out_ior;
@@
-329,7
+325,7
@@
out:
module_init(board_init);
</programlisting>
</sect1>
module_init(board_init);
</programlisting>
</sect1>
- <sect1>
+ <sect1
id="Exit_function"
>
<title>Exit function</title>
<para>
The exit function is only neccecary if the driver is
<title>Exit function</title>
<para>
The exit function is only neccecary if the driver is
@@
-344,7
+340,7
@@
static void __exit board_cleanup (void)
/* Release resources, unregister device */
nand_release (board_mtd);
/* Release resources, unregister device */
nand_release (board_mtd);
- /* unmap physical adress */
+ /* unmap physical ad
d
ress */
iounmap((void *)baseaddr);
/* Free the MTD device structure */
iounmap((void *)baseaddr);
/* Free the MTD device structure */
@@
-363,7
+359,7
@@
module_exit(board_cleanup);
driver. For a list of functions which can be overridden by the board
driver see the documentation of the nand_chip structure.
</para>
driver. For a list of functions which can be overridden by the board
driver see the documentation of the nand_chip structure.
</para>
- <sect1>
+ <sect1
id="Multiple_chip_control"
>
<title>Multiple chip control</title>
<para>
The nand driver can control chip arrays. Therefor the
<title>Multiple chip control</title>
<para>
The nand driver can control chip arrays. Therefor the
@@
-423,9
+419,9
@@
static void board_select_chip (struct mtd_info *mtd, int chip)
}
</programlisting>
</sect1>
}
</programlisting>
</sect1>
- <sect1>
+ <sect1
id="Hardware_ECC_support"
>
<title>Hardware ECC support</title>
<title>Hardware ECC support</title>
- <sect2>
+ <sect2
id="Functions_and_constants"
>
<title>Functions and constants</title>
<para>
The nand driver supports three different types of
<title>Functions and constants</title>
<para>
The nand driver supports three different types of
@@
-479,7
+475,7
@@
static void board_select_chip (struct mtd_info *mtd, int chip)
</itemizedlist>
</para>
</sect2>
</itemizedlist>
</para>
</sect2>
- <sect2>
+ <sect2
id="Hardware_ECC_with_syndrome_calculation"
>
<title>Hardware ECC with syndrome calculation</title>
<para>
Many hardware ECC implementations provide Reed-Solomon
<title>Hardware ECC with syndrome calculation</title>
<para>
Many hardware ECC implementations provide Reed-Solomon
@@
-504,7
+500,7
@@
static void board_select_chip (struct mtd_info *mtd, int chip)
</para>
</sect2>
</sect1>
</para>
</sect2>
</sect1>
- <sect1>
+ <sect1
id="Bad_Block_table_support"
>
<title>Bad block table support</title>
<para>
Most NAND chips mark the bad blocks at a defined
<title>Bad block table support</title>
<para>
Most NAND chips mark the bad blocks at a defined
@@
-556,7
+552,7
@@
static void board_select_chip (struct mtd_info *mtd, int chip)
allows faster access than always checking the
bad block information on the flash chip itself.
</para>
allows faster access than always checking the
bad block information on the flash chip itself.
</para>
- <sect2>
+ <sect2
id="Flash_based_tables"
>
<title>Flash based tables</title>
<para>
It may be desired or neccecary to keep a bad block table in FLASH.
<title>Flash based tables</title>
<para>
It may be desired or neccecary to keep a bad block table in FLASH.
@@
-591,7
+587,7
@@
static void board_select_chip (struct mtd_info *mtd, int chip)
</itemizedlist>
</para>
</sect2>
</itemizedlist>
</para>
</sect2>
- <sect2>
+ <sect2
id="User_defined_tables"
>
<title>User defined tables</title>
<para>
User defined tables are created by filling out a
<title>User defined tables</title>
<para>
User defined tables are created by filling out a
@@
-680,7
+676,7
@@
static void board_select_chip (struct mtd_info *mtd, int chip)
</para>
</sect2>
</sect1>
</para>
</sect2>
</sect1>
- <sect1>
+ <sect1
id="Spare_area_placement"
>
<title>Spare area (auto)placement</title>
<para>
The nand driver implements different possibilities for
<title>Spare area (auto)placement</title>
<para>
The nand driver implements different possibilities for
@@
-734,7
+730,7
@@
struct nand_oobinfo {
</para></listitem>
</itemizedlist>
</para>
</para></listitem>
</itemizedlist>
</para>
- <sect2>
+ <sect2
id="Placement_defined_by_fs_driver"
>
<title>Placement defined by fs driver</title>
<para>
The calling function provides a pointer to a nand_oobinfo
<title>Placement defined by fs driver</title>
<para>
The calling function provides a pointer to a nand_oobinfo
@@
-764,7
+760,7
@@
struct nand_oobinfo {
done according to the given scheme in the nand_oobinfo structure.
</para>
</sect2>
done according to the given scheme in the nand_oobinfo structure.
</para>
</sect2>
- <sect2>
+ <sect2
id="Automatic_placement"
>
<title>Automatic placement</title>
<para>
Automatic placement uses the built in defaults to place the
<title>Automatic placement</title>
<para>
Automatic placement uses the built in defaults to place the
@@
-778,7
+774,7
@@
struct nand_oobinfo {
done according to the default builtin scheme.
</para>
</sect2>
done according to the default builtin scheme.
</para>
</sect2>
- <sect2>
+ <sect2
id="User_space_placement_selection"
>
<title>User space placement selection</title>
<para>
All non ecc functions like mtd->read and mtd->write use an internal
<title>User space placement selection</title>
<para>
All non ecc functions like mtd->read and mtd->write use an internal
@@
-793,9
+789,9
@@
struct nand_oobinfo {
</para>
</sect2>
</sect1>
</para>
</sect2>
</sect1>
- <sect1>
+ <sect1
id="Spare_area_autoplacement_default"
>
<title>Spare area autoplacement default schemes</title>
<title>Spare area autoplacement default schemes</title>
- <sect2>
+ <sect2
id="pagesize_256"
>
<title>256 byte pagesize</title>
<informaltable><tgroup cols="3"><tbody>
<row>
<title>256 byte pagesize</title>
<informaltable><tgroup cols="3"><tbody>
<row>
@@
-847,7
+843,7
@@
pages this byte is reserved</entry>
</row>
</tbody></tgroup></informaltable>
</sect2>
</row>
</tbody></tgroup></informaltable>
</sect2>
- <sect2>
+ <sect2
id="pagesize_512"
>
<title>512 byte pagesize</title>
<informaltable><tgroup cols="3"><tbody>
<row>
<title>512 byte pagesize</title>
<informaltable><tgroup cols="3"><tbody>
<row>
@@
-910,7
+906,7
@@
in this page</entry>
</row>
</tbody></tgroup></informaltable>
</sect2>
</row>
</tbody></tgroup></informaltable>
</sect2>
- <sect2>
+ <sect2
id="pagesize_2048"
>
<title>2048 byte pagesize</title>
<informaltable><tgroup cols="3"><tbody>
<row>
<title>2048 byte pagesize</title>
<informaltable><tgroup cols="3"><tbody>
<row>
@@
-1130,9
+1126,9
@@
in this page</entry>
<para>
This chapter describes the constants which might be relevant for a driver developer.
</para>
<para>
This chapter describes the constants which might be relevant for a driver developer.
</para>
- <sect1
>
+ <sect1
id="Chip_option_constants">
<title>Chip option constants</title>
<title>Chip option constants</title>
- <sect2
>
+ <sect2
id="Constants_for_chip_id_table">
<title>Constants for chip id table</title>
<para>
These constants are defined in nand.h. They are ored together to describe
<title>Constants for chip id table</title>
<para>
These constants are defined in nand.h. They are ored together to describe
@@
-1157,7
+1153,7
@@
in this page</entry>
</programlisting>
</para>
</sect2>
</programlisting>
</para>
</sect2>
- <sect2
>
+ <sect2
id="Constants_for_runtime_options">
<title>Constants for runtime options</title>
<para>
These constants are defined in nand.h. They are ored together to describe
<title>Constants for runtime options</title>
<para>
These constants are defined in nand.h. They are ored together to describe
@@
-1175,7
+1171,7
@@
in this page</entry>
</sect2>
</sect1>
</sect2>
</sect1>
- <sect1
>
+ <sect1
id="EEC_selection_constants">
<title>ECC selection constants</title>
<para>
Use these constants to select the ECC algorithm.
<title>ECC selection constants</title>
<para>
Use these constants to select the ECC algorithm.
@@
-1196,7
+1192,7
@@
in this page</entry>
</para>
</sect1>
</para>
</sect1>
- <sect1
>
+ <sect1
id="Hardware_control_related_constants">
<title>Hardware control related constants</title>
<para>
These constants describe the requested hardware access function when
<title>Hardware control related constants</title>
<para>
These constants describe the requested hardware access function when
@@
-1222,7
+1218,7
@@
in this page</entry>
</para>
</sect1>
</para>
</sect1>
- <sect1
>
+ <sect1
id="Bad_block_table_constants">
<title>Bad block table related constants</title>
<para>
These constants describe the options used for bad block
<title>Bad block table related constants</title>
<para>
These constants describe the options used for bad block
@@
-1295,7
+1291,9
@@
in this page</entry>
</para>
!Idrivers/mtd/nand/nand_base.c
!Idrivers/mtd/nand/nand_bbt.c
</para>
!Idrivers/mtd/nand/nand_base.c
!Idrivers/mtd/nand/nand_bbt.c
-!Idrivers/mtd/nand/nand_ecc.c
+<!-- No internal functions for kernel-doc:
+X!Idrivers/mtd/nand/nand_ecc.c
+-->
</chapter>
<chapter id="credits">
</chapter>
<chapter id="credits">