* Copyright 2005 Develer S.r.l. (http://www.develer.com/)
* -->
*
+* \defgroup drv_emb_flash Embedded flash driver
+* \ingroup drivers
+* \{
*
* \brief Embedded flash for cpu.
*
+* This module allows to access in reading and writing to the internal
+* flash memory of the micro. It is a block device, so it must be
+* accessed using the KBlock interface functions (see kblock.h).
+*
+* Once you have opened the flash for writing, you may want to use
+* kblock_trim() to avoid overwriting data on other flash banks.
+*
+* Example usage:
+* \code
+* Flash fls;
+* flash_init(&fls, 0);
+* // enable access only on desired blocks
+* // start block = 50, num blocks = 20
+* kblock_trim(&fls.blk, 50, 20);
+* // ...
+* // now write to the flash
+* // block number is automatically converted
+* kblock_write(&fls.blk, 0, buf, 0, 128);
+* \endcode
+*
* \author Francesco Sacchi <batt@develer.com>
* \author Daniele Basile <asterix@develer.com>
*
#if COMPILER_C99
#define flash_init(...) PP_CAT(flash_init_, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
#else
+ /**
+ * Init function for flash driver.
+ *
+ * This macro cannot fail, so no error conditions are reported.
+ *
+ * This macro expands to
+ * - flash_init_2(Flash *fls, flags), the new KBlock API
+ * - flash_init_1(Flash *fls), old API, provided for compatibility
+ *
+ * Do NOT use the above functions directly, use flash_init() instead.
+ * Disable old API if you are not upgrading an existing project.
+ */
#define flash_init(args...) PP_CAT(flash_init_, COUNT_PARMS(args)) (args)
#endif
-/*
- * Embedded flash error flags
+/**
+ * \name Embedded flash error values
+ * \{
*/
#define FLASH_WR_OK 0 ///< Write ok.
#define FLASH_NOT_ERASED BV(1) ///< Flash memory was not erased before to write it.
#define FLASH_WR_PROTECT BV(2) ///< Write not allowed the flash memory was protected.
#define FLASH_WR_TIMEOUT BV(3) ///< Timeout while writing
#define FLASH_WR_ERR BV(4) ///< Invalid command and/or a bad keywords
+/** \} */
struct FlashHardware;
/**
- * EmbFlash KFile context structure.
+ * EmbFlash KBlock context structure.
*/
typedef struct Flash
{
- KBlock blk;
+ KBlock blk; ///< KBlock context
struct FlashHardware *hw;
#if !CONFIG_FLASH_DISABLE_OLD_API
union {
#endif /* !CONFIG_FLASH_DISABLE_OLD_API */
} Flash;
-/**
+/*
* ID for FLASH
*/
#define KBT_FLASH MAKE_ID('F', 'L', 'A', 'S')
#include CPU_HEADER(flash)
+/**
+ * \name Flash init flags
+ * \{
+ */
#define FLASH_WRITE_ONCE BV(0) ///< Allow only one write per block.
-#define FLASH_BUFFERED BV(1) ///< Open flash memory using page caching, allowing the modification and partial write.
+#define FLASH_UNBUFFERED BV(1) ///< Open flash memory disabling page caching, no modification and partial write are allowed.
+/** \} */
-#define flash_init_2(fls, flags) (flags & FLASH_BUFFERED) ? \
+/**
+ * Initialize \a fls Flash context structure.
+ * \param fls Flash context structure
+ * \param flags A combination of flash init flags
+ */
+#define flash_init_2(fls, flags) (flags & FLASH_UNBUFFERED) ? \
flash_hw_initUnbuffered(fls, flags) : flash_hw_init(fls, flags)
#if !CONFIG_FLASH_DISABLE_OLD_API
}
#endif /* !CONFIG_FLASH_DISABLE_OLD_API */
+/** \} */
+
#endif /* DRV_FLASH_H */