Commit Graph

64 Commits

Author SHA1 Message Date
Karl Palsson 4e70d06d63 stm32g4: Add basic support
* memorymap
* vectors
* rcc
* gpios
* makefiles
* devices for linker script generation
* doc structure
2020-04-09 23:29:00 +00:00
Karl Palsson 4f2d6c2988 doc: enable samd and sam4l family documentation
Was lost in some re-org, turn it back on.
2020-01-28 23:04:00 +00:00
Brian Viele 53302439df stm32h7: Initial introduction into libopencm3.
Updates to a base set of includes to map to the h7 include files which are
mainly based on the f7 versions for simple devices (e.g. SPI, USART, GPIO).

Custom files that have been implemented from the datasheet/ref manual include
the memory map, RCC, PWR definitions, and irq.json file for generation of
nvic files for interrupt mapping.

Additional functionality, especially PLL and tweaks for non-F7 compatible
implementations coming in future commits.

Added documentation tree configuration.

Reviewed-by: Karl Palsson <karlp@tweak.net.au>
Changed dmaX_streamX to dmaX_strX in a few places for consistency
2019-11-28 22:15:24 +00:00
Brian Viele dd18b9fdbc Qorvo pac55xx: initial support
Qorvo (Nee Active Semi) PAC55xx "Intelligent Motor Control" parts,
cortex-m4 SoCs
2019-11-26 23:28:02 +00:00
Karl Palsson b9c437331f efm32wg: include in documentation build 2019-06-22 00:40:16 +00:00
Karl Palsson a3291b375e efm32: ezr32wg: include in docs build
Was completely missing.
2019-06-22 00:40:09 +00:00
Karl Palsson 9e42251d6f doc: properly define ARM_ARCH_xxx
Requires a little stub file per target, so we can neatly define the
architecture.  This properly includes all the cortex m core
documentation finally.
2019-06-10 10:33:34 +00:00
Guillaume Revaillot b7fc86c72d doc: oops, no need to call sed -s, unbreak make doc on os x
Not sure how/why i pushed thqt, absolutely no need to call sed with -s
parameter. Fix build on os x / systems running non gnu sed.
2019-06-08 11:36:56 +00:00
Karl Palsson 8183d4efa3 swm050: add back into doc generation?
Not sure where this went.  I was building docs for it to make the
doxygen work, but then, it's not here?!

Anyway, here now :)
2019-06-08 11:36:22 +00:00
Guillaume Revaillot ee376eafdb stm32g0: make doc. 2019-05-21 00:05:22 +00:00
Karl Palsson 72a7284355 doc: hook up gd32f1x0 documentation
Super easy now thanks to the earlier changes.
2019-04-15 13:06:48 +00:00
Guillaume Revaillot bdc38eed16 doc: attempt to get rid of doxygenlayouts and doxyfiles.
Generate doc root doxygenlayout file, as well as devices stuff, based on main
Makefile $(TARGETS) and template files. Avoids painfull sync/merge of 20 files+
when adding a new device.
bonus : allow to build only one device doc easily (make TARGETS=stm32f0 doc)

regression: we currently loose device "fancy" naming as device name is
guessed (toUpper()..) from folder name.
2019-04-15 12:41:21 +00:00
Guillaume Revaillot b725a793bf doc: align doc, add missing entries in layouts. 2019-01-17 16:35:50 +01:00
Karl Palsson 056602b12a doc: msp432/e4: hook up doxygen generation
Just hooks up the target, no changes to the submitted documentation.
2018-08-27 13:34:34 +00:00
Karl Palsson 5609749411 doc: drop unused tex files
Remove tex header templates only used in latex document generation.
Clarify the HACKING document to reflect no pdf/latex

Fixes: 9443856b doc: drop latex support
2018-04-14 18:40:54 +00:00
Sebastian Holzapfel 7bd04bffc8 doxygen: efm32hg: update doxygen templates to include efm32hg 2018-03-02 22:42:04 +00:00
Sebastian Holzapfel a86948ec6e efm32hg: add basic makefile, interrupts, device information 2018-03-02 22:42:04 +00:00
Karl Palsson a2c202f944 stm32l4: doc: use autogenerate doxygen lists
Fixes d002d9552 doc: dynamically generate correct file lists
(which didn't convert the l4 as well)
2018-02-13 23:57:21 +00:00
Karl Palsson a46777a2bf doc: enable @deprecated generation
Not very useful having it turned off if we want to use it!
2018-02-13 23:57:21 +00:00
Karl Palsson 0f39bc6e80 doc: remove duplicate l4 generation
Doesn't fix l4 docs, but pointless regeneration anyway
2018-02-13 23:05:21 +00:00
Karl Palsson 6511b89b27 doc: mk: remove generated files on clean 2018-02-05 21:00:43 +00:00
Karl Palsson 9443856b68 doc: drop latex support
HTML output is good enough for anyone, and is less maintennance.
2017-10-18 20:05:14 +00:00
Karl Palsson 9022e69d5d doc: drop the standalone cm3/usb documents
They are now included in the projects, so each .a file has a standalone
complete package of all documentation.
2017-10-18 20:05:14 +00:00
Karl Palsson d002d9552f doc: dynamically generate correct file lists
Instead of the fragile and error prone attempts to specifically
include/exclude files from doxygen by name and pattern, simply use the
already generated .d files to provide accurate and up to date lists of
all source files used.

Pros:
* Nothing left to worry about
* Much more encouraging to actually _work_ on the documentation now that
you can be sure the right docs will be generated instead of a confusing
mix.

Downsides/Upsides:
* Automatically includes all CM3/USB in each device's page _as well_ now

Downsides:
* lpc43xx still manually listed.  However, completely contained in it's
own dir, so no problems
* No attempt to carry this in latex.  easy, but more tempted to drop
latex support outright. (I don't think the generation there has even
worked for a while now)
* Due to the mismatch between lib directories and document roots, the
sourcelist can't be magically created per directory.  There has to be
some sort of mapping between the two, so as this is doc generation only,
a static list seems sane for maintennance.  (Especially compared to the
old method)
* Source list generation probably doesn't work on windows.
2017-10-18 20:05:14 +00:00
Karl Palsson f592e6d54e doc: cm3: include source, not just headers
Now with added systick/nvic functions
2017-10-18 20:05:14 +00:00
Karl Palsson ba0c97bf42 stm32f7: pwr: add more doxygen
Seeing as Matthew went to the effort of all the descriptions, it seemed
only reasonable to get them to show up in the generated docs too.
2017-06-08 23:01:45 +00:00
Karl Palsson c09ebbc956 doc: stm32f3: exclude unused common files 2016-08-18 23:51:49 +00:00
Karl Palsson 3cc6ecd203 doc: stm32l1: exclude unshared common code
Fixes Github issue #458
Fixes Github issue #300
2016-08-18 23:51:32 +00:00
Karl Palsson f14c678ccb stm32l4: add gpio support
Just the basic core common functionality gained for free by being a common
peripheral.  Enough for a miniblink.

Fixes some errors in the GPIO memory map.  ST's naming of AHB2 vs AHB3 is
confusing.
2015-11-13 02:13:31 +00:00
Karl Palsson 8afc983f3e stm32l4: Add RCC definitions
Bring in the core common code, and now that it's used, pull in the common
memorymap
2015-11-13 01:15:17 +00:00
Karl Palsson 7233d1112c stm32l4: Add to documentation build
Don't include any of the common files yet, we're only getting a stub framework
up for further work.

This is mostly noise adding links from the other families to make the l4
"exist"
2015-11-11 00:51:08 +00:00
Frantisek Burian 3ef2c38120 [stm32f7] Add initial support of the family, GPIO support.
Most changes are noise from doxygen.
Readme udpated to explain newer FP_FLAGS for m7
stm32f7 library is skipped if the toolchain doesn't support it yet.
2015-10-15 10:34:28 +00:00
Karl Palsson 33a2d057f4 doc: exclude CRS from f1, f2, f3, f4, l1 2015-10-15 00:13:33 +00:00
Frantisek Burian 9fce73a014 [Doxygen] Strip out architectures from Makefile dependencies
This commit shrinks the Makefile of the doxygen and makes easy error-prone addition of the new supported platforms.
The user should modify only one line at start of file to add new supported family to the build process.

The calling format is preserved and is compatible with old version of the makefile.
2014-10-15 19:50:08 +02:00
Frantisek Burian eee5a45019 [stm32l0] Integrate the L0 architecture to the doxygen documentation
Conflicts:
	doc/Makefile
2014-10-15 19:33:20 +02:00
Stefan Agner c83e16926e vf6xx: doc: initial commit
Add documentation Makefile and DoxygenLayout for Freescale Vybrid
VF6xx support.
2014-10-15 19:31:02 +02:00
Karl Palsson 88c20212ed docs: fix link from stm32f3 to stm32f0
Incorrectly pointed to f1.
2014-08-12 10:33:59 +00:00
Felix Held 5248bee639 [sam3] show the sam3 subfamilies in the doxygen-generated documentation 2014-02-24 18:35:22 +00:00
Karl Palsson eb44e7c617 docs: note dependencies for PDF generation
Probably lots of dependencies missing, these are what I needed _after_
getting regular html docs working.
2014-02-12 15:21:09 +00:00
Ken Sarkies 0af6d06eda Deduplication of flash code for STM32F0 and F1.
Extension of code for STM32F1 to allow for dual bank series XL.
Small changes to documentation for F2, F4 and L1 to add a parameter reference.

Tested with STM32F103RBT6
(note: tests show that the PG bit must be cleared after programming, otherwise
a subsequent erase attempt fails. This has been added to flash_program_half_word
for F0 and F1 only. A fix for the other families is not included in this PR.)
2014-02-06 00:52:42 +01:00
Ken Sarkies 3c6e9fd56d Fix a number of top level doxygen issues.
So that the navigation pane works correctly in browsers.
Some additional doc fixes put in where found (but many more still to go).
Added some dummy .c and .h files to bring the associated docs into line.
makefile changed to allow 'make html' as well as 'make doc' (the latter only does html anyway).
2014-01-15 22:19:52 +01:00
BuFran f2febb1b85 [DOXYGEN] EFM32 link typo bugfix 2013-08-24 16:43:03 +02:00
BuFran 7d43b86daf [DOXYGEN] Add links to the HTML pages for easy debugging of pages 2013-08-24 14:20:13 +02:00
BuFran 55ee4f6de5 [DOXYGEN] Add STM32F3 to the headers of documentation pages 2013-08-24 14:20:13 +02:00
BuFran eb9797214f [DOXYGEN] Correct generating docs for STM32F0 and STM32F3 2013-08-24 14:20:13 +02:00
BuFran d63bf5ac64 [STM32F3:doc] Add doxygen documentation page to output 2013-08-22 23:08:52 -07:00
BuFran 81982916e2 [Doxygen] Add complete documentation page to STM32F0 2013-08-22 17:18:42 -07:00
BuFran 8f3ebd11c7 Strip the BEGIN_DECLS definition from the first function in a module documentation. 2013-07-07 16:12:03 -07:00
Ken Sarkies f5c9bdfe61 Changes to doxygen markup to solve a few problems that upset
doxygen, and to correct minor errors.
2013-06-02 18:17:49 -07:00
Ken Sarkies 84fe022609 Add usb to main index 2013-04-19 10:26:01 +09:30