[MTD] [NAND] S3C2410: Added a kerneldoc for s3c2410_nand_set
[safe/jmp/linux-2.6] / arch / arm / plat-s3c / include / plat / nand.h
1 /* arch/arm/mach-s3c2410/include/mach/nand.h
2  *
3  * Copyright (c) 2004 Simtec Electronics
4  *      Ben Dooks <ben@simtec.co.uk>
5  *
6  * S3C2410 - NAND device controller platfrom_device info
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 as
10  * published by the Free Software Foundation.
11 */
12
13 /**
14  * struct s3c2410_nand_set - define a set of one or more nand chips
15  * @disable_ecc:        Entirely disable ECC - Dangerous
16  * @nr_chips:           Number of chips in this set
17  * @nr_partitions:      Number of partitions pointed to by @partitions
18  * @name:               Name of set (optional)
19  * @nr_map:             Map for low-layer logical to physical chip numbers (option)
20  * @partitions:         The mtd partition list
21  *
22  * define a set of one or more nand chips registered with an unique mtd. Also
23  * allows to pass flag to the underlying NAND layer. 'disable_ecc' will trigger
24  * a warning at boot time.
25  */
26 struct s3c2410_nand_set {
27         unsigned int            disable_ecc:1;
28
29         int                     nr_chips;
30         int                     nr_partitions;
31         char                    *name;
32         int                     *nr_map;
33         struct mtd_partition    *partitions;
34         struct nand_ecclayout   *ecc_layout;
35 };
36
37 struct s3c2410_platform_nand {
38         /* timing information for controller, all times in nanoseconds */
39
40         int     tacls;  /* time for active CLE/ALE to nWE/nOE */
41         int     twrph0; /* active time for nWE/nOE */
42         int     twrph1; /* time for release CLE/ALE from nWE/nOE inactive */
43
44         unsigned int    ignore_unset_ecc:1;
45
46         int                     nr_sets;
47         struct s3c2410_nand_set *sets;
48
49         void                    (*select_chip)(struct s3c2410_nand_set *,
50                                                int chip);
51 };
52