]> err.no Git - linux-2.6/blobdiff - Documentation/DocBook/mtdnand.tmpl
Merge git://git.kernel.org/pub/scm/linux/kernel/git/wim/linux-2.6-watchdog
[linux-2.6] / Documentation / DocBook / mtdnand.tmpl
index 999afe1ca8cbf33151e8504f753848c052b3539b..957cf5c26831a31df5b8adca8ecc3eb2feabad67 100644 (file)
                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 dependend functions before calling nand_scan().
+               should be replaced by board dependent 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>
                [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 dependend functions before calling nand_scan().
+               should be replaced by board dependent 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>
        <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 dependend
+               basic functions and fill out some really board dependent
                members in the nand chip description structure.
-               See drivers/mtd/nand/skeleton for reference.
        </para>
        <sect1>
                <title>Basic defines</title>
@@ -276,17 +275,14 @@ int __init board_init (void)
        int err = 0;
 
        /* Allocate memory for MTD device structure and private data */
-       board_mtd = kmalloc (sizeof(struct mtd_info) + sizeof (struct nand_chip), GFP_KERNEL);
+       board_mtd = kzalloc(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;
        }
 
-       /* 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");
@@ -310,7 +306,7 @@ int __init board_init (void)
        this->dev_ready = board_dev_ready;
        this->eccmode = NAND_ECC_SOFT;
 
-       /* Scan to find existance of the device */
+       /* Scan to find existence of the device */
        if (nand_scan (board_mtd, 1)) {
                err = -ENXIO;
                goto out_ior;
@@ -344,7 +340,7 @@ static void __exit board_cleanup (void)
        /* Release resources, unregister device */
        nand_release (board_mtd);
 
-       /* unmap physical adress */
+       /* unmap physical address */
        iounmap((void *)baseaddr);
        
        /* Free the MTD device structure */
@@ -1295,7 +1291,9 @@ in this page</entry>
      </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">