aboutsummaryrefslogtreecommitdiffstats
path: root/source/libmaple/api/flash.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-08-22 23:37:16 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-08-22 23:37:16 -0400
commitc6ba836ad1fbda247d9622b2f372a0c9c0cdbfd9 (patch)
tree7fe0def72ce810256d903557909fc9462b8ac9fb /source/libmaple/api/flash.rst
parent6a6a7c31c3b1a920a73dbc1f11dc502de7e776cd (diff)
downloadlibrambutan-c6ba836ad1fbda247d9622b2f372a0c9c0cdbfd9.tar.gz
librambutan-c6ba836ad1fbda247d9622b2f372a0c9c0cdbfd9.zip
Better document libmaple proper APIs.
Instead of using doxygenfile, add finely-grained documentation for each libmaple proper header that we guarantee an API for. These new files are in keeping with the template provided in /tmpl/libmaple-proper-page.rst.tmpl. Breathe still has to be taught how to do doxygenunion to get some of this right, but I'm committing this now in anticipation of that happening.
Diffstat (limited to 'source/libmaple/api/flash.rst')
-rw-r--r--source/libmaple/api/flash.rst93
1 files changed, 89 insertions, 4 deletions
diff --git a/source/libmaple/api/flash.rst b/source/libmaple/api/flash.rst
index 6f2f9d3..8a7e79b 100644
--- a/source/libmaple/api/flash.rst
+++ b/source/libmaple/api/flash.rst
@@ -4,9 +4,94 @@
``flash.h``
===========
-[Stub] support.
+Flash support.
-Library Documentation
----------------------
+.. contents:: Contents
+ :local:
-.. doxygenfile:: flash.h
+Types
+-----
+
+.. doxygenstruct:: flash_reg_map
+
+Functions
+---------
+
+.. doxygenfunction:: flash_enable_prefetch
+.. doxygenfunction:: flash_set_latency
+
+Register Map Base Pointers
+--------------------------
+
+.. doxygendefine:: FLASH_BASE
+
+Register Bit Definitions
+------------------------
+
+Access control register
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. doxygendefine:: FLASH_ACR_PRFTBS_BIT
+.. doxygendefine:: FLASH_ACR_PRFTBE_BIT
+.. doxygendefine:: FLASH_ACR_HLFCYA_BIT
+
+.. doxygendefine:: FLASH_ACR_PRFTBS
+.. doxygendefine:: FLASH_ACR_PRFTBE
+.. doxygendefine:: FLASH_ACR_HLFCYA
+.. doxygendefine:: FLASH_ACR_LATENCY
+
+Status register
+~~~~~~~~~~~~~~~
+
+.. doxygendefine:: FLASH_SR_EOP_BIT
+.. doxygendefine:: FLASH_SR_WRPRTERR_BIT
+.. doxygendefine:: FLASH_SR_PGERR_BIT
+.. doxygendefine:: FLASH_SR_BSY_BIT
+
+.. doxygendefine:: FLASH_SR_EOP
+.. doxygendefine:: FLASH_SR_WRPRTERR
+.. doxygendefine:: FLASH_SR_PGERR
+.. doxygendefine:: FLASH_SR_BSY
+
+Control register
+~~~~~~~~~~~~~~~~
+
+.. doxygendefine:: FLASH_CR_EOPIE_BIT
+.. doxygendefine:: FLASH_CR_ERRIE_BIT
+.. doxygendefine:: FLASH_CR_OPTWRE_BIT
+.. doxygendefine:: FLASH_CR_LOCK_BIT
+.. doxygendefine:: FLASH_CR_STRT_BIT
+.. doxygendefine:: FLASH_CR_OPTER_BIT
+.. doxygendefine:: FLASH_CR_OPTPG_BIT
+.. doxygendefine:: FLASH_CR_MER_BIT
+.. doxygendefine:: FLASH_CR_PER_BIT
+.. doxygendefine:: FLASH_CR_PG_BIT
+
+.. doxygendefine:: FLASH_CR_EOPIE
+.. doxygendefine:: FLASH_CR_ERRIE
+.. doxygendefine:: FLASH_CR_OPTWRE
+.. doxygendefine:: FLASH_CR_LOCK
+.. doxygendefine:: FLASH_CR_STRT
+.. doxygendefine:: FLASH_CR_OPTER
+.. doxygendefine:: FLASH_CR_OPTPG
+.. doxygendefine:: FLASH_CR_MER
+.. doxygendefine:: FLASH_CR_PER
+.. doxygendefine:: FLASH_CR_PG
+
+Option byte register
+~~~~~~~~~~~~~~~~~~~~
+
+.. doxygendefine:: FLASH_OBR_nRST_STDBY_BIT
+.. doxygendefine:: FLASH_OBR_nRST_STOP_BIT
+.. doxygendefine:: FLASH_OBR_WDG_SW_BIT
+.. doxygendefine:: FLASH_OBR_RDPRT_BIT
+.. doxygendefine:: FLASH_OBR_OPTERR_BIT
+
+.. doxygendefine:: FLASH_OBR_DATA1
+.. doxygendefine:: FLASH_OBR_DATA0
+.. doxygendefine:: FLASH_OBR_USER
+.. doxygendefine:: FLASH_OBR_nRST_STDBY
+.. doxygendefine:: FLASH_OBR_nRST_STOP
+.. doxygendefine:: FLASH_OBR_WDG_SW
+.. doxygendefine:: FLASH_OBR_RDPRT
+.. doxygendefine:: FLASH_OBR_OPTERR