diff options
| author | Dean Glazeski <dnglaze@gmail.com> | 2009-11-16 12:43:39 -0600 |
|---|---|---|
| committer | David Brownell <dbrownell@users.sourceforge.net> | 2009-11-26 23:56:58 -0800 |
| commit | 8f3c728273e9b89070259d6120117f6a190dd773 (patch) | |
| tree | fa6efaec64ca48c739bf49ce193cfdfdd4578e4a /src | |
| parent | 05a5f682c6cff5bba3b54ec7d8bd0ad6b7a72054 (diff) | |
| download | riscv-openocd-8f3c728273e9b89070259d6120117f6a190dd773.zip riscv-openocd-8f3c728273e9b89070259d6120117f6a190dd773.tar.gz riscv-openocd-8f3c728273e9b89070259d6120117f6a190dd773.tar.bz2 | |
ARM NAND I/O documentation update.
This updates the functions in the file to all have doxygen comments
describing what they do.
Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
Diffstat (limited to 'src')
| -rw-r--r-- | src/flash/arm_nandio.c | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/src/flash/arm_nandio.c b/src/flash/arm_nandio.c index 990d3a0..f774b61 100644 --- a/src/flash/arm_nandio.c +++ b/src/flash/arm_nandio.c @@ -68,7 +68,7 @@ int arm_code_to_working_area(struct target *target, const uint32_t *code, unsign return retval; } -/* +/** * ARM-specific bulk write from buffer to address of 8-bit wide NAND. * For now this only supports ARMv4 and ARMv5 cores. * @@ -78,6 +78,11 @@ int arm_code_to_working_area(struct target *target, const uint32_t *code, unsign * Different code fragments could handle: * - Thumb2 cores like Cortex-M (needs different byteswapping) * - 16-bit wide data (needs different setup too) + * + * @param nand Pointer to the arm_nand_data struct that defines the I/O + * @param data Pointer to the data to be copied to flash + * @param size Size of the data being copied + * @return Success or failure of the operation */ int arm_nandwrite(struct arm_nand_data *nand, uint8_t *data, int size) { @@ -159,6 +164,7 @@ int arm_nandwrite(struct arm_nand_data *nand, uint8_t *data, int size) * @param nand Pointer to the arm_nand_data struct that defines the I/O * @param data Pointer to the data buffer to store the read data * @param size Amount of data to be stored to the buffer. + * @return Success or failure of the operation */ int arm_nandread(struct arm_nand_data *nand, uint8_t *data, uint32_t size) { |