Jurica Resetar / aconno_flash

aconno flash API for nrf52832. (Modified mbed flash API)

Files at this revision

API Documentation at this revision

Revision 3:2852a2090e7b, committed 2018-12-14

Comitter:
Dominik Bartolovic
Date:
Fri Dec 14 16:24:41 2018 +0100
Parent:
2:e5390f8eab8c
Commit message:
Added readme

Changed in this revision

readme.me Show annotated file Show diff for this revision Revisions of this file 
diff -r e5390f8eab8c -r 2852a2090e7b readme.me
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/readme.me	Fri Dec 14 16:24:41 2018 +0100
@@ -0,0 +1,24 @@
+#Introduction
+
+Aconno library for flash read/write.
+
+#Usage
+
+To initialize this flash library call:
+
+int32_t aconno_flash_init(flash_t *obj)
+
+To read from flash:
+
+int32_t aconno_flash_read(flash_t *obj, uint32_t address, uint8_t *data, uint32_t size)
+
+To erase memory section(more than 4 bytes!!!):
+
+int32_t aconno_flash_erase_sector(flash_t *obj, uint32_t address)
+
+To write to flash use:
+
+int32_t aconno_flash_program_page(flash_t *obj, uint32_t address, const uint8_t *data, uint32_t size)
+
+NOTE: data pointer has to be 4 aligned
+      pages should not cross multiple sectors