diff options
| author | Gregory Nutt <gnutt@nuttx.org> | 2014-04-23 13:02:00 -0600 |
|---|---|---|
| committer | Gregory Nutt <gnutt@nuttx.org> | 2014-04-23 13:02:00 -0600 |
| commit | 3ee12ef1f2fd265e8fa23d2e45437c9450bf82d1 (patch) | |
| tree | fa15b7b80e27dda6f342ac6aee03e49da69302de /nuttx/include | |
| parent | 9d19c8b57f2b2fa03ef8270c5738a2424b6dbc1f (diff) | |
| download | nuttx-3ee12ef1f2fd265e8fa23d2e45437c9450bf82d1.tar.gz nuttx-3ee12ef1f2fd265e8fa23d2e45437c9450bf82d1.tar.bz2 nuttx-3ee12ef1f2fd265e8fa23d2e45437c9450bf82d1.zip | |
Update TODO list and comments
Diffstat (limited to 'nuttx/include')
| -rw-r--r-- | nuttx/include/nuttx/mtd/mtd.h | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/nuttx/include/nuttx/mtd/mtd.h b/nuttx/include/nuttx/mtd/mtd.h index ad1842074..a3ac52ff0 100644 --- a/nuttx/include/nuttx/mtd/mtd.h +++ b/nuttx/include/nuttx/mtd/mtd.h @@ -188,7 +188,7 @@ extern "C" * Description: * Given an instance of an MTD driver, create a flash partition, ie., * another MTD driver instance that only operates with a sub-region of - * FLASH media. That sub-region is defined by a sector offsetset and a + * FLASH media. That sub-region is defined by a sector offset and a * sector count (where the size of a sector is provided the by parent MTD * driver). * @@ -198,6 +198,15 @@ extern "C" * partitions, that mutual exclusion would be provided by the file system * above the FLASH driver. * + * Input parameters: + * mtd - The MTD device to be partitioned + * firstblock - The offset in bytes to the first block + * nblocks - The number of blocks in the partition + * + * Returned Value: + * On success, another MTD device representing the partition is returned. + * A NULL value is returned on a failure. + * ****************************************************************************/ FAR struct mtd_dev_s *mtd_partition(FAR struct mtd_dev_s *mtd, |