X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=src%2Fflash%2Farm_nandio.h;h=27b3ad35139427f31756e28ff5fdaf017386d9dc;hb=822c06d9e3983b37cd1830c594210973cb560991;hp=a1bed326d97b063af850c500a9534d6672174183;hpb=0f1163e823c6ca3c2a81fa296157f5dde0635fea;p=openocd.git

diff --git a/src/flash/arm_nandio.h b/src/flash/arm_nandio.h
index a1bed326d9..27b3ad3513 100644
--- a/src/flash/arm_nandio.h
+++ b/src/flash/arm_nandio.h
@@ -1,25 +1,30 @@
 #ifndef __ARM_NANDIO_H
-#define  __ARM_NANDIO_H
+#define __ARM_NANDIO_H
 
-#include "nand.h"
-#include "binarybuffer.h"
+#include <flash/nand.h>
+#include <helper/binarybuffer.h>
 
+/**
+ * The arm_nand_data struct is used for defining NAND I/O operations on an ARM
+ * core.
+ */
 struct arm_nand_data {
-	/* target is proxy for some ARM core */
+	/** target is proxy for some ARM core */
 	struct target		*target;
 
-	/* copy_area holds write-to-NAND loop and data to write */
+	/** copy_area holds write-to-NAND loop and data to write */
 	struct working_area	*copy_area;
 
-	/* chunk_size == page or ECC unit */
+	/** chunk_size == page or ECC unit */
 	unsigned		chunk_size;
 
-	/* data == where to write the data */
+	/** data == where to write the data */
 	uint32_t		data;
 
 	/* currently implicit:  data width == 8 bits (not 16) */
 };
 
 int arm_nandwrite(struct arm_nand_data *nand, uint8_t *data, int size);
+int arm_nandread(struct arm_nand_data *nand, uint8_t *data, uint32_t size);
 
-#endif  /* __ARM_NANDIO_H */
+#endif /* __ARM_NANDIO_H */