Browse Source

[Doxygen] Add complete documentation page to STM32F0

pull/177/merge
BuFran 11 years ago
committed by Piotr Esden-Tempski
parent
commit
81982916e2
  1. 1
      doc/DoxygenLayout.xml
  2. 10
      doc/Makefile
  3. 1
      doc/cm3/DoxygenLayout_cm3.xml
  4. 1
      doc/efm32g/DoxygenLayout_efm32g.xml
  5. 1
      doc/efm32gg/DoxygenLayout_efm32gg.xml
  6. 1
      doc/efm32lg/DoxygenLayout_efm32lg.xml
  7. 1
      doc/efm32tg/DoxygenLayout_efm32tg.xml
  8. 1
      doc/lm3s/DoxygenLayout_lm3s.xml
  9. 1
      doc/lm4f/DoxygenLayout_lm4f.xml
  10. 1
      doc/lpc13xx/DoxygenLayout_lpc13xx.xml
  11. 1
      doc/lpc17xx/DoxygenLayout_lpc17xx.xml
  12. 1
      doc/lpc43xx/DoxygenLayout_lpc43xx.xml
  13. 38
      doc/stm32f0/Doxyfile
  14. 40
      doc/stm32f0/Doxyfile_latex
  15. 200
      doc/stm32f0/DoxygenLayout_stm32f0.xml
  16. 61
      doc/stm32f0/header_stm32f0.tex
  17. 1
      doc/stm32f1/DoxygenLayout_stm32f1.xml
  18. 1
      doc/stm32f2/DoxygenLayout_stm32f2.xml
  19. 1
      doc/stm32f4/DoxygenLayout_stm32f4.xml
  20. 1
      doc/stm32l1/DoxygenLayout_stm32l1.xml
  21. 13
      include/libopencm3/stm32/f0/adc.h
  22. 12
      include/libopencm3/stm32/f0/cec.h
  23. 13
      include/libopencm3/stm32/f0/dac.h
  24. 4
      include/libopencm3/stm32/f0/dma.h
  25. 32
      include/libopencm3/stm32/f0/doc-stm32f0.h
  26. 13
      include/libopencm3/stm32/f0/exti.h
  27. 12
      include/libopencm3/stm32/f0/flash.h
  28. 12
      include/libopencm3/stm32/f0/i2c.h
  29. 4
      include/libopencm3/stm32/f0/pwr.h
  30. 2
      include/libopencm3/stm32/f0/rcc.h
  31. 12
      include/libopencm3/stm32/f0/syscfg.h
  32. 32
      include/libopencm3/stm32/f0/timer.h
  33. 12
      include/libopencm3/stm32/f0/tsc.h
  34. 5
      include/libopencm3/stm32/timer.h
  35. 3
      lib/stm32/f0/Makefile
  36. 33
      lib/stm32/f0/crc.c
  37. 33
      lib/stm32/f0/dac.c
  38. 31
      lib/stm32/f0/gpio.c
  39. 32
      lib/stm32/f0/i2c.c
  40. 33
      lib/stm32/f0/iwdg.c
  41. 38
      lib/stm32/f0/pwr.c
  42. 2
      lib/stm32/f0/rcc.c
  43. 12
      lib/stm32/f0/spi.c
  44. 31
      lib/stm32/f0/syscfg.c
  45. 34
      lib/stm32/f0/timer.c

1
doc/DoxygenLayout.xml

@ -6,6 +6,7 @@
<tab type="user" visible="yes" url="../html/index.html" title="Top Level" intro=""/>
<tab type="user" visible="yes" url="../cm3/html/modules.html" title="CM3 Core" intro=""/>
<tab type="user" visible="yes" url="../usb/html/modules.html" title="Generic USB" intro=""/>
<tab type="user" visible="yes" url="../stm32f0/html/modules.html" title="STM32F0" intro=""/>
<tab type="user" visible="yes" url="../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../stm32f4/html/modules.html" title="STM32F4" intro=""/>

10
doc/Makefile

@ -5,7 +5,7 @@
doc: html latex
html: cm3 usb stm32l1 stm32f1 stm32f2 stm32f4 efm32g efm32gg efm32lg efm32tg lm3s lm4f lpc13 lpc17 lpc43 top
html: cm3 usb stm32l1 stm32f0 stm32f1 stm32f2 stm32f4 efm32g efm32gg efm32lg efm32tg lm3s lm4f lpc13 lpc17 lpc43 top
cm3:
cd cm3/; doxygen
@ -40,6 +40,9 @@ lpc17:
lpc43:
cd lpc43xx/; doxygen
stm32f0:
cd stm32f0/; doxygen
stm32f1:
cd stm32f1/; doxygen
@ -55,11 +58,14 @@ stm32l1:
top:
doxygen
latex: stm32l1.pdf stm32f1.pdf stm32f2.pdf stm32f4.pdf lm3s.pdf lm4f.pdf lpc13.pdf lpc17.pdf lpc43.pdf efm32g.pdf efm32gg.pdf efm32lg.pdf efm32tg.pdf
latex: stm32l1.pdf stm32f0.pdf stm32f1.pdf stm32f2.pdf stm32f4.pdf lm3s.pdf lm4f.pdf lpc13.pdf lpc17.pdf lpc43.pdf efm32g.pdf efm32gg.pdf efm32lg.pdf efm32tg.pdf
stm32l1.pdf:
cd stm32l1/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../stm32l1.pdf
stm32f0.pdf:
cd stm32f0/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../stm32f0.pdf
stm32f1.pdf:
cd stm32f1/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../stm32f1.pdf

1
doc/cm3/DoxygenLayout_cm3.xml

@ -4,6 +4,7 @@
<tab type="mainpage" visible="yes" title="libopencm3"/>
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="modules" visible="yes" title="CM3 Core" intro=""/>
<tab type="user" visible="yes" url="../../stm32f0/html/modules.html" title="STM32F0" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>

1
doc/efm32g/DoxygenLayout_efm32g.xml

@ -6,6 +6,7 @@
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
<tab type="user" visible="yes" url="../../usb/html/modules.html" title="Generic USB" intro=""/>
<tab type="user" visible="yes" url="../../stm32f0/html/modules.html" title="STM32F0" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>

1
doc/efm32gg/DoxygenLayout_efm32gg.xml

@ -6,6 +6,7 @@
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
<tab type="user" visible="yes" url="../../usb/html/modules.html" title="Generic USB" intro=""/>
<tab type="user" visible="yes" url="../../stm32f0/html/modules.html" title="STM32F0" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>

1
doc/efm32lg/DoxygenLayout_efm32lg.xml

@ -6,6 +6,7 @@
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
<tab type="user" visible="yes" url="../../usb/html/modules.html" title="Generic USB" intro=""/>
<tab type="user" visible="yes" url="../../stm32f0/html/modules.html" title="STM32F0" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>

1
doc/efm32tg/DoxygenLayout_efm32tg.xml

@ -6,6 +6,7 @@
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
<tab type="user" visible="yes" url="../../usb/html/modules.html" title="Generic USB" intro=""/>
<tab type="user" visible="yes" url="../../stm32f0/html/modules.html" title="STM32F0" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>

1
doc/lm3s/DoxygenLayout_lm3s.xml

@ -6,6 +6,7 @@
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
<tab type="user" visible="yes" url="../../usb/html/modules.html" title="Generic USB" intro=""/>
<tab type="user" visible="yes" url="../../stm32f0/html/modules.html" title="STM32F0" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>

1
doc/lm4f/DoxygenLayout_lm4f.xml

@ -6,6 +6,7 @@
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
<tab type="user" visible="yes" url="../../usb/html/modules.html" title="Generic USB" intro=""/>
<tab type="user" visible="yes" url="../../stm32f0/html/modules.html" title="STM32F0" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>

1
doc/lpc13xx/DoxygenLayout_lpc13xx.xml

@ -6,6 +6,7 @@
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
<tab type="user" visible="yes" url="../../usb/html/modules.html" title="Generic USB" intro=""/>
<tab type="user" visible="yes" url="../../stm32f0/html/modules.html" title="STM32F0" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>

1
doc/lpc17xx/DoxygenLayout_lpc17xx.xml

@ -6,6 +6,7 @@
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
<tab type="user" visible="yes" url="../../usb/html/modules.html" title="Generic USB" intro=""/>
<tab type="user" visible="yes" url="../../stm32f0/html/modules.html" title="STM32F0" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>

1
doc/lpc43xx/DoxygenLayout_lpc43xx.xml

@ -6,6 +6,7 @@
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
<tab type="user" visible="yes" url="../../usb/html/modules.html" title="Generic USB" intro=""/>
<tab type="user" visible="yes" url="../../stm32f0/html/modules.html" title="STM32F0" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>

38
doc/stm32f0/Doxyfile

@ -0,0 +1,38 @@
# HTML Documentation for STM32F1 code level
# 14 September 2012
# (C) Ken Sarkies <ksarkies@internode.on.net>
#---------------------------------------------------------------------------
# Common Include File
#---------------------------------------------------------------------------
@INCLUDE = ../Doxyfile_common
#---------------------------------------------------------------------------
# Local settings
#---------------------------------------------------------------------------
WARN_LOGFILE = doxygen_stm32f0.log
INPUT = ../../include/libopencm3/license.dox \
../../include/libopencm3/stm32/f0 \
../../include/libopencm3/stm32/common
INPUT += ../../lib/stm32/f0 \
../../lib/stm32/common
EXCLUDE = ../../include/libopencm3/stm32/f0/usb.h \
../../include/libopencm3/stm32/f0/usb_desc.h
EXCLUDE_PATTERNS = *_common_f24.h *_common_f24.c
LAYOUT_FILE = DoxygenLayout_stm32f0.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html
GENERATE_TAGFILE = stm32f0.tag
ENABLE_PREPROCESSING = YES

40
doc/stm32f0/Doxyfile_latex

@ -0,0 +1,40 @@
# LaTeX Documentation for STM32F1 code level
# 14 September 2012
# (C) Ken Sarkies <ksarkies@internode.on.net>
#---------------------------------------------------------------------------
# Common Include File
#---------------------------------------------------------------------------
@INCLUDE = ../Doxyfile_common
#---------------------------------------------------------------------------
# Local settings
#---------------------------------------------------------------------------
WARN_LOGFILE = doxygen_stm32f0_latex.log
INPUT = ../../include/libopencm3/docmain.dox \
../../include/libopencm3/license.dox \
../../include/libopencm3/stm32/f0 \
../../include/libopencm3/stm32/common
INPUT += ../../lib/stm32/f0 \
../../lib/stm32/common
EXCLUDE = ../../include/libopencm3/stm32/f0/doc-stm32f0.h \
../../include/libopencm3/stm32/f0/usb.h \
../../include/libopencm3/stm32/f0/usb_desc.h \
../../include/libopencm3/stm32/f0/nvic_f0.h
EXCLUDE_PATTERNS = *_common_f24.h *_common_f24.c
LAYOUT_FILE = DoxygenLayout_stm32f0.xml
GENERATE_HTML = NO
GENERATE_LATEX = YES
LATEX_HEADER = header_stm32f0.tex

200
doc/stm32f0/DoxygenLayout_stm32f0.xml

@ -0,0 +1,200 @@
<doxygenlayout version="1.0">
<!-- Navigation index tabs for HTML output -->
<navindex>
<tab type="mainpage" visible="yes" title="libopencm3"/>
<tab type="pages" visible="yes" title="General Information" intro=""/>
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
<tab type="user" visible="yes" url="../../usb/html/modules.html" title="Generic USB" intro=""/>
<tab type="modules" visible="yes" title="STM32F0" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>
<tab type="user" visible="yes" url="../../lpc13xx/html/modules.html" title="LPC13" intro=""/>
<tab type="user" visible="yes" url="../../lpc17xx/html/modules.html" title="LPC17" intro=""/>
<tab type="user" visible="yes" url="../../lpc43xx/html/modules.html" title="LPC43" intro=""/>
<tab type="user" visible="yes" url="../../emf32g/html/modules.html" title="EMF32 Gecko" intro=""/>
<tab type="user" visible="yes" url="../../emf32gg/html/modules.html" title="EMF32 Giant Gecko" intro=""/>
<tab type="user" visible="yes" url="../../emf32lg/html/modules.html" title="EMF32 Leopard Gecko" intro=""/>
<tab type="user" visible="yes" url="../../emf32tg/html/modules.html" title="EMF32 Tiny Gecko" intro=""/>
<tab type="namespaces" visible="yes" title="">
<tab type="namespaces" visible="yes" title="" intro=""/>
<tab type="namespacemembers" visible="yes" title="" intro=""/>
</tab>
<tab type="classes" visible="yes" title="">
<tab type="classes" visible="yes" title="" intro=""/>
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="hierarchy" visible="yes" title="" intro=""/>
<tab type="classmembers" visible="yes" title="" intro=""/>
</tab>
<tab type="files" visible="yes" title="">
<tab type="files" visible="yes" title="" intro=""/>
<tab type="globals" visible="yes" title="" intro=""/>
</tab>
<tab type="examples" visible="yes" title="" intro=""/>
</navindex>
<!-- Layout definition for a class page -->
<class>
<briefdescription visible="yes"/>
<includes visible="$SHOW_INCLUDE_FILES"/>
<inheritancegraph visible="$CLASS_GRAPH"/>
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
<allmemberslink visible="yes"/>
<memberdecl>
<nestedclasses visible="yes" title=""/>
<publictypes title=""/>
<publicslots title=""/>
<signals title=""/>
<publicmethods title=""/>
<publicstaticmethods title=""/>
<publicattributes title=""/>
<publicstaticattributes title=""/>
<protectedtypes title=""/>
<protectedslots title=""/>
<protectedmethods title=""/>
<protectedstaticmethods title=""/>
<protectedattributes title=""/>
<protectedstaticattributes title=""/>
<packagetypes title=""/>
<packagemethods title=""/>
<packagestaticmethods title=""/>
<packageattributes title=""/>
<packagestaticattributes title=""/>
<properties title=""/>
<events title=""/>
<privatetypes title=""/>
<privateslots title=""/>
<privatemethods title=""/>
<privatestaticmethods title=""/>
<privateattributes title=""/>
<privatestaticattributes title=""/>
<friends title=""/>
<related title="" subtitle=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<typedefs title=""/>
<enums title=""/>
<constructors title=""/>
<functions title=""/>
<related title=""/>
<variables title=""/>
<properties title=""/>
<events title=""/>
</memberdef>
<usedfiles visible="$SHOW_USED_FILES"/>
<authorsection visible="yes"/>
</class>
<!-- Layout definition for a namespace page -->
<namespace>
<briefdescription visible="yes"/>
<memberdecl>
<nestednamespaces visible="yes" title=""/>
<classes visible="yes" title=""/>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
</memberdef>
<authorsection visible="yes"/>
</namespace>
<!-- Layout definition for a file page -->
<file>
<briefdescription visible="yes"/>
<includes visible="$SHOW_INCLUDE_FILES"/>
<includegraph visible="$INCLUDE_GRAPH"/>
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
<sourcelink visible="yes"/>
<memberdecl>
<classes visible="yes" title=""/>
<namespaces visible="yes" title=""/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
</memberdef>
<authorsection/>
</file>
<!-- Layout definition for a group page -->
<group>
<briefdescription visible="yes"/>
<groupgraph visible="$GROUP_GRAPHS"/>
<memberdecl>
<classes visible="yes" title=""/>
<namespaces visible="yes" title=""/>
<dirs visible="yes" title=""/>
<nestedgroups visible="yes" title=""/>
<files visible="yes" title=""/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>
<variables title=""/>
<signals title=""/>
<publicslots title=""/>
<protectedslots title=""/>
<privateslots title=""/>
<events title=""/>
<properties title=""/>
<friends title=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<pagedocs/>
<inlineclasses title=""/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>
<variables title=""/>
<signals title=""/>
<publicslots title=""/>
<protectedslots title=""/>
<privateslots title=""/>
<events title=""/>
<properties title=""/>
<friends title=""/>
</memberdef>
<authorsection visible="yes"/>
</group>
<!-- Layout definition for a directory page -->
<directory>
<briefdescription visible="yes"/>
<directorygraph visible="yes"/>
<memberdecl>
<dirs visible="yes"/>
<files visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
</directory>
</doxygenlayout>

61
doc/stm32f0/header_stm32f0.tex

@ -0,0 +1,61 @@
\documentclass{book}
\usepackage[a4paper,top=2.5cm,bottom=2.5cm,left=2.5cm,right=2.5cm]{geometry}
\usepackage{makeidx}
\usepackage{natbib}
\usepackage{graphicx}
\usepackage{multicol}
\usepackage{float}
\usepackage{listings}
\usepackage{color}
\usepackage{ifthen}
\usepackage[table]{xcolor}
\usepackage{textcomp}
\usepackage{alltt}
\usepackage{ifpdf}
\ifpdf
\usepackage[pdftex,
pagebackref=true,
colorlinks=true,
linkcolor=blue,
unicode
]{hyperref}
\else
\usepackage[ps2pdf,
pagebackref=true,
colorlinks=true,
linkcolor=blue,
unicode
]{hyperref}
\usepackage{pspicture}
\fi
\usepackage[utf8]{inputenc}
\usepackage{mathptmx}
\usepackage[scaled=.90]{helvet}
\usepackage{courier}
\usepackage{sectsty}
\usepackage{amssymb}
\usepackage[titles]{tocloft}
\usepackage{doxygen}
\lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=4,numbers=left }
\makeindex
\setcounter{tocdepth}{3}
\renewcommand{\footrulewidth}{0.4pt}
\renewcommand{\familydefault}{\sfdefault}
\hfuzz=15pt
\setlength{\emergencystretch}{15pt}
\hbadness=750
\tolerance=750
\begin{document}
\hypersetup{pageanchor=false,citecolor=blue}
\begin{titlepage}
\vspace*{7cm}
\begin{center}
{\Huge libopencm3: API Reference\\ STM STM32F0 ARM Cortex M0 Series}\\
\vspace*{1cm}
{\large Generated by Doxygen 1.8.2}\\
\vspace*{0.5cm}
{\small Thu Sep 13 2012 23:26:45}\\
\end{center}
\end{titlepage}
\pagenumbering{arabic}
\hypersetup{pageanchor=true,citecolor=blue}

1
doc/stm32f1/DoxygenLayout_stm32f1.xml

@ -6,6 +6,7 @@
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
<tab type="user" visible="yes" url="../../usb/html/modules.html" title="Generic USB" intro=""/>
<tab type="user" visible="yes" url="../../stm32f0/html/modules.html" title="STM32F0" intro=""/>
<tab type="modules" visible="yes" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>

1
doc/stm32f2/DoxygenLayout_stm32f2.xml

@ -6,6 +6,7 @@
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
<tab type="user" visible="yes" url="../../usb/html/modules.html" title="Generic USB" intro=""/>
<tab type="user" visible="yes" url="../../stm32f0/html/modules.html" title="STM32F0" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="modules" visible="yes" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>

1
doc/stm32f4/DoxygenLayout_stm32f4.xml

@ -6,6 +6,7 @@
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
<tab type="user" visible="yes" url="../../usb/html/modules.html" title="Generic USB" intro=""/>
<tab type="user" visible="yes" url="../../stm32f0/html/modules.html" title="STM32F0" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="modules" visible="yes" title="STM32F4" intro=""/>

1
doc/stm32l1/DoxygenLayout_stm32l1.xml

@ -6,6 +6,7 @@
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
<tab type="user" visible="yes" url="../../usb/html/modules.html" title="Generic USB" intro=""/>
<tab type="user" visible="yes" url="../../stm32f0/html/modules.html" title="STM32F0" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>

13
include/libopencm3/stm32/f0/adc.h

@ -1,3 +1,16 @@
/** @defgroup adc_defines ADC Defines
*
* @brief <b>Defined Constants and Types for the STM32F0xx Analog to Digital
* Converter</b>
*
* @ingroup STM32F0xx_defines
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

12
include/libopencm3/stm32/f0/cec.h

@ -1,3 +1,15 @@
/** @defgroup CEC_defines CEC Defines
*
* @brief <b>Defined Constants and Types for the STM32F0xx HDMI-CEC</b>
*
* @ingroup STM32F0xx_defines
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

13
include/libopencm3/stm32/f0/dac.h

@ -1,3 +1,16 @@
/** @defgroup dac_defines DAC Defines
*
* @brief <b>Defined Constants and Types for the STM32F0xx Digital to Analog
* Converter</b>
*
* @ingroup STM32F0xx_defines
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

4
include/libopencm3/stm32/f0/dma.h

@ -1,8 +1,8 @@
/** @defgroup dma_defines DMA Defines
*
* @ingroup STM32F1xx_defines
* @ingroup STM32F0xx_defines
*
* @brief Defined Constants and Types for the STM32F1xx DMA Controller
* @brief Defined Constants and Types for the STM32F0xx DMA Controller
*
* @version 1.0.0
*

32
include/libopencm3/stm32/f0/doc-stm32f0.h

@ -0,0 +1,32 @@
/** @mainpage libopencm3 STM32F0
*
* @version 1.0.0
*
* @date 11 July 2013
*
* API documentation for ST Microelectronics STM32F0 Cortex M0 series.
*
* LGPL License Terms @ref lgpl_license
*/
/** @defgroup STM32F0xx STM32F0xx
* Libraries for ST Microelectronics STM32F0xx series.
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/** @defgroup STM32F0xx_defines STM32F0xx Defines
*
* @brief Defined Constants and Types for the STM32F0xx series
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/

13
include/libopencm3/stm32/f0/exti.h

@ -1,3 +1,16 @@
/** @defgroup exti_defines EXTI Defines
*
* @brief <b>Defined Constants and Types for the STM32F0xx External Interrupts
* </b>
*
* @ingroup STM32F0xx_defines
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

12
include/libopencm3/stm32/f0/flash.h

@ -1,3 +1,15 @@
/** @defgroup flash_defines FLASH Defines
*
* @brief <b>Defined Constants and Types for the STM32F0xx Flash memory</b>
*
* @ingroup STM32F0xx_defines
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

12
include/libopencm3/stm32/f0/i2c.h

@ -1,3 +1,15 @@
/** @defgroup i2c_defines I2C Defines
*
* @brief <b>Defined Constants and Types for the STM32F0xx I2C</b>
*
* @ingroup STM32F0xx_defines
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

4
include/libopencm3/stm32/f0/pwr.h

@ -1,8 +1,8 @@
/** @defgroup pwr_defines PWR Defines
*
* @brief <b>Defined Constants and Types for the STM32F1xx PWR Control</b>
* @brief <b>Defined Constants and Types for the STM32F0xx PWR Control</b>
*
* @ingroup STM32F1xx_defines
* @ingroup STM32F0xx_defines
*
* @version 1.0.0
*

2
include/libopencm3/stm32/f0/rcc.h

@ -1,4 +1,4 @@
/** @defgroup STM32F0xx_rcc_defines RCC Defines
/** @defgroup rcc_defines RCC Defines
*
* @brief <b>libopencm3 STM32F0xx Reset and Clock Control</b>
*

12
include/libopencm3/stm32/f0/syscfg.h

@ -1,3 +1,15 @@
/** @defgroup syscfg_defines SYSCFG Defines
*
* @brief <b>Defined Constants and Types for the STM32F0xx System Config</b>
*
* @ingroup STM32F0xx_defines
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

32
include/libopencm3/stm32/f0/timer.h

@ -0,0 +1,32 @@
/** @defgroup timer_defines Timers Defines
*
* @brief <b>Defined Constants and Types for the STM32F0xx Timers</b>
*
* @ingroup STM32F0xx_defines
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* Copyright (C) 2013 Frantisek Burian <BuFran@seznam.cz>
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/

12
include/libopencm3/stm32/f0/tsc.h

@ -1,3 +1,15 @@
/** @defgroup tsc_defines TSC Defines
*
* @brief <b>Defined Constants and Types for the STM32F0xx Touch Sensor</b>
*
* @ingroup STM32F0xx_defines
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

5
include/libopencm3/stm32/timer.h

@ -18,8 +18,9 @@
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#if defined(STM32F1)
#if defined(STM32F0)
# include <libopencm3/stm32/f0/timer.h>
#elif defined(STM32F1)
# include <libopencm3/stm32/f1/timer.h>
#elif defined(STM32F2)
# include <libopencm3/stm32/f2/timer.h>

3
lib/stm32/f0/Makefile

@ -33,7 +33,8 @@ CFLAGS = -Os -g \
ARFLAGS = rcs
OBJS = flash.o rcc.o usart.o dma.o rtc.o comparator.o spi.o
OBJS = flash.o rcc.o usart.o dma.o rtc.o comparator.o spi.o crc.o \
dac.o i2c.o iwdg.o pwr.o gpio.o timer.o
OBJS += gpio_common_all.o gpio_common_f0234.o crc_common_all.o \
pwr_common_all.o iwdg_common_all.o rtc_common_l1f024.o \

33
lib/stm32/f0/crc.c

@ -0,0 +1,33 @@
/** @defgroup crc_file CRC
*
* @ingroup STM32F0xx
*
* @brief <b>libopencm3 STM32F0xx CRC</b>
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <libopencm3/stm32/crc.h>
#include <libopencm3/stm32/common/crc_common_all.h>

33
lib/stm32/f0/dac.c

@ -0,0 +1,33 @@
/** @defgroup dac_file DAC
*
* @ingroup STM32F0xx
*
* @brief <b>libopencm3 STM32F0xx DAC</b>
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <libopencm3/stm32/dac.h>
#include <libopencm3/stm32/common/dac_common_all.h>

31
lib/stm32/f0/gpio.c

@ -0,0 +1,31 @@
/** @defgroup gpio_file GPIO
*
* @ingroup STM32F0xx
*
* @brief <b>libopencm3 STM32F0xx General Purpose I/O</b>
*
* @version 1.0.0
*
* @date 18 August 2012
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <libopencm3/stm32/gpio.h>

32
lib/stm32/f0/i2c.c

@ -0,0 +1,32 @@
/** @defgroup i2c_file I2C
*
* @ingroup STM32F0xx
*
* @brief <b>libopencm3 STM32F0xx I2C</b>
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <libopencm3/stm32/i2c.h>

33
lib/stm32/f0/iwdg.c

@ -0,0 +1,33 @@
/** @defgroup iwdg_file IWDG
*
* @ingroup STM32F0xx
*
* @brief <b>libopencm3 STM32F0xx Independent Watchdog Timer</b>
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <libopencm3/stm32/iwdg.h>
#include <libopencm3/stm32/common/iwdg_common_all.h>

38
lib/stm32/f0/pwr.c

@ -0,0 +1,38 @@
/** @defgroup pwr-file PWR
*
* @ingroup STM32F0xx
*
* @brief <b>libopencm3 STM32F0xx Power Control</b>
*
* @version 1.0.0
*
* @date 11 July 2013
*
* This library supports the power control system for the
* STM32F0 series of ARM Cortex Microcontrollers by ST Microelectronics.
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#include <libopencm3/stm32/pwr.h>
/**@}*/

2
lib/stm32/f0/rcc.c

@ -1,6 +1,6 @@
/** @defgroup STM32F0xx-rcc-file RCC
*
* @ingroup STM32F1xx
* @ingroup STM32F0xx
*
* @brief <b>libopencm3 STM32F0xx Reset and Clock Control</b>
*

12
lib/stm32/f0/spi.c

@ -1,3 +1,15 @@
/** @defgroup spi_file SPI
*
* @ingroup STM32F0xx
*
* @brief <b>libopencm3 STM32F0xx Serial Peripheral Interface</b>
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

31
lib/stm32/f0/syscfg.c

@ -0,0 +1,31 @@
/** @defgroup syscfg_file SYSCFG
*
* @ingroup STM32F0xx
*
* @brief <b>libopencm3 STM32F0xx SYSCFG</b>
*
* @version 1.0.0
*
* @date 10 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <libopencm3/stm32/syscfg.h>

34
lib/stm32/f0/timer.c

@ -0,0 +1,34 @@
/** @defgroup timer_file Timers
*
* @ingroup STM32F0xx
*
* @brief <b>libopencm3 STM32F0xx Timers</b>
*
* @version 1.0.0
*
* @date 11 July 2013
*
*/
/*
* This file is part of the libopencm3 project.
*
* Copyright (C) 2010 Edward Cheeseman <evbuilder@users.sourceforge.org>
* Copyright (C) 2011 Stephen Caudle <scaudle@doceme.com>
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <libopencm3/stm32/timer.h>
Loading…
Cancel
Save