diff options
| author | Brian Norris <computersforpeace@gmail.com> | 2011-08-30 21:45:44 -0400 |
|---|---|---|
| committer | Artem Bityutskiy <artem.bityutskiy@intel.com> | 2011-09-11 08:57:44 -0400 |
| commit | 4180f24a7bff3aa7978e3785d0edd5dcc4af9049 (patch) | |
| tree | c5b59491f451abf150149e9aeb2ce4f591d8e8a7 /include/linux | |
| parent | e99d8b089a6c6fd72f022168e3bf8f22d4e5e137 (diff) | |
mtd: document ABI
We're missing a lot of important documentation in include/mtd/mtd-abi.h:
* add a simple description of each ioctl (feel free to expand!)
* give full explanations of recently added and modified operations
* explain the usage of "RAW" that appear in different modes and types of
operations
* fix some comment style along the way
Signed-off-by: Brian Norris <computersforpeace@gmail.com>
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>
Diffstat (limited to 'include/linux')
| -rw-r--r-- | include/linux/mtd/mtd.h | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/include/linux/mtd/mtd.h b/include/linux/mtd/mtd.h index c2047b85691..37d082793f6 100644 --- a/include/linux/mtd/mtd.h +++ b/include/linux/mtd/mtd.h | |||
| @@ -79,7 +79,7 @@ struct mtd_erase_region_info { | |||
| 79 | * @ooblen: number of oob bytes to write/read | 79 | * @ooblen: number of oob bytes to write/read |
| 80 | * @oobretlen: number of oob bytes written/read | 80 | * @oobretlen: number of oob bytes written/read |
| 81 | * @ooboffs: offset of oob data in the oob area (only relevant when | 81 | * @ooboffs: offset of oob data in the oob area (only relevant when |
| 82 | * mode = MTD_OPS_PLACE_OOB) | 82 | * mode = MTD_OPS_PLACE_OOB or MTD_OPS_RAW) |
| 83 | * @datbuf: data buffer - if NULL only oob data are read/written | 83 | * @datbuf: data buffer - if NULL only oob data are read/written |
| 84 | * @oobbuf: oob data buffer | 84 | * @oobbuf: oob data buffer |
| 85 | * | 85 | * |