git subrepo clone https://github.com/libopencm3/libopencm3.git
subrepo: subdir: "libopencm3" merged: "88e91c9a7cce" upstream: origin: "https://github.com/libopencm3/libopencm3.git" branch: "master" commit: "88e91c9a7cce" git-subrepo: version: "0.4.3" origin: "???" commit: "???"
This commit is contained in:
parent
f01f2a30fa
commit
054740c5de
69
libopencm3/.gitignore
vendored
Normal file
69
libopencm3/.gitignore
vendored
Normal file
@ -0,0 +1,69 @@
|
||||
*.d
|
||||
*.o
|
||||
*.bin
|
||||
*.hex
|
||||
*.list
|
||||
*.srec
|
||||
*.a
|
||||
*.elf
|
||||
lib/*.ld
|
||||
# (except this one!)
|
||||
!lib/cortex-m-generic.ld
|
||||
*.stylecheck
|
||||
*.swp
|
||||
\#*
|
||||
.\#*
|
||||
*~
|
||||
*.map
|
||||
*.log
|
||||
*.pyc
|
||||
html/
|
||||
latex/
|
||||
*.pdf
|
||||
*.tag
|
||||
.DS_Store
|
||||
# These are generated
|
||||
include/libopencm3/**/nvic.h
|
||||
include/libopencm3/**/**/nvic.h
|
||||
# (not these three though...)
|
||||
!include/libopencm3/cm3/nvic.h
|
||||
!include/libopencm3/dispatch/nvic.h
|
||||
!include/libopencm3/lm4f/nvic.h
|
||||
lib/**/vector_nvic.c
|
||||
lib/**/**/vector_nvic.c
|
||||
# (not this one either)
|
||||
!lib/dispatch/vector_nvic.c
|
||||
DoxygenLayout.xml
|
||||
doc/*/Doxyfile
|
||||
doc/*/DoxygenLayout_*.xml
|
||||
# (annnd, not these two templates either)
|
||||
!doc/templates/DoxygenLayout_Device.xml
|
||||
!doc/templates/DoxygenLayout_Root.xml
|
||||
doc/*/doxy.sourcelist
|
||||
include/libopencmsis/efm32/
|
||||
include/libopencmsis/gd32/
|
||||
include/libopencmsis/lm3s/
|
||||
include/libopencmsis/lpc13xx/
|
||||
include/libopencmsis/lpc17xx/
|
||||
include/libopencmsis/lpc43xx/
|
||||
include/libopencmsis/msp432/
|
||||
include/libopencmsis/nrf/
|
||||
include/libopencmsis/pac55xx/
|
||||
include/libopencmsis/sam/
|
||||
include/libopencmsis/stm32/
|
||||
include/libopencmsis/swm050/
|
||||
include/libopencmsis/vf6xx/
|
||||
|
||||
# Editor/IDE config files
|
||||
nbproject/
|
||||
.idea/
|
||||
.project
|
||||
locm3.sublime-workspace
|
||||
.cproject
|
||||
.settings
|
||||
|
||||
# cscope databases
|
||||
cscope.out
|
||||
|
||||
# build droppings
|
||||
.stamp_failure*
|
12
libopencm3/.gitrepo
Normal file
12
libopencm3/.gitrepo
Normal file
@ -0,0 +1,12 @@
|
||||
; DO NOT EDIT (unless you know what you are doing)
|
||||
;
|
||||
; This subdirectory is a git "subrepo", and this file is maintained by the
|
||||
; git-subrepo command. See https://github.com/git-commands/git-subrepo#readme
|
||||
;
|
||||
[subrepo]
|
||||
remote = https://github.com/libopencm3/libopencm3.git
|
||||
branch = master
|
||||
commit = 88e91c9a7cced8096c53fb942dcff1d7bdf6c91b
|
||||
parent = f01f2a30fabf04acd1cdaa64356985859a2a6cd8
|
||||
method = merge
|
||||
cmdver = 0.4.3
|
17
libopencm3/.travis.yml
Normal file
17
libopencm3/.travis.yml
Normal file
@ -0,0 +1,17 @@
|
||||
language: c
|
||||
script:
|
||||
- make
|
||||
- make -C tests/gadget-zero
|
||||
|
||||
addons:
|
||||
apt:
|
||||
sources:
|
||||
- sourceline: 'ppa:team-gcc-arm-embedded/ppa'
|
||||
packages:
|
||||
- gcc-arm-embedded
|
||||
|
||||
notifications:
|
||||
irc:
|
||||
channels:
|
||||
- "irc.libera.chat#libopencm3"
|
||||
use_notice: true
|
676
libopencm3/COPYING.GPL3
Normal file
676
libopencm3/COPYING.GPL3
Normal file
@ -0,0 +1,676 @@
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program 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 General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
|
165
libopencm3/COPYING.LGPL3
Normal file
165
libopencm3/COPYING.LGPL3
Normal file
@ -0,0 +1,165 @@
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
|
||||
This version of the GNU Lesser General Public License incorporates
|
||||
the terms and conditions of version 3 of the GNU General Public
|
||||
License, supplemented by the additional permissions listed below.
|
||||
|
||||
0. Additional Definitions.
|
||||
|
||||
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
||||
General Public License.
|
||||
|
||||
"The Library" refers to a covered work governed by this License,
|
||||
other than an Application or a Combined Work as defined below.
|
||||
|
||||
An "Application" is any work that makes use of an interface provided
|
||||
by the Library, but which is not otherwise based on the Library.
|
||||
Defining a subclass of a class defined by the Library is deemed a mode
|
||||
of using an interface provided by the Library.
|
||||
|
||||
A "Combined Work" is a work produced by combining or linking an
|
||||
Application with the Library. The particular version of the Library
|
||||
with which the Combined Work was made is also called the "Linked
|
||||
Version".
|
||||
|
||||
The "Minimal Corresponding Source" for a Combined Work means the
|
||||
Corresponding Source for the Combined Work, excluding any source code
|
||||
for portions of the Combined Work that, considered in isolation, are
|
||||
based on the Application, and not on the Linked Version.
|
||||
|
||||
The "Corresponding Application Code" for a Combined Work means the
|
||||
object code and/or source code for the Application, including any data
|
||||
and utility programs needed for reproducing the Combined Work from the
|
||||
Application, but excluding the System Libraries of the Combined Work.
|
||||
|
||||
1. Exception to Section 3 of the GNU GPL.
|
||||
|
||||
You may convey a covered work under sections 3 and 4 of this License
|
||||
without being bound by section 3 of the GNU GPL.
|
||||
|
||||
2. Conveying Modified Versions.
|
||||
|
||||
If you modify a copy of the Library, and, in your modifications, a
|
||||
facility refers to a function or data to be supplied by an Application
|
||||
that uses the facility (other than as an argument passed when the
|
||||
facility is invoked), then you may convey a copy of the modified
|
||||
version:
|
||||
|
||||
a) under this License, provided that you make a good faith effort to
|
||||
ensure that, in the event an Application does not supply the
|
||||
function or data, the facility still operates, and performs
|
||||
whatever part of its purpose remains meaningful, or
|
||||
|
||||
b) under the GNU GPL, with none of the additional permissions of
|
||||
this License applicable to that copy.
|
||||
|
||||
3. Object Code Incorporating Material from Library Header Files.
|
||||
|
||||
The object code form of an Application may incorporate material from
|
||||
a header file that is part of the Library. You may convey such object
|
||||
code under terms of your choice, provided that, if the incorporated
|
||||
material is not limited to numerical parameters, data structure
|
||||
layouts and accessors, or small macros, inline functions and templates
|
||||
(ten or fewer lines in length), you do both of the following:
|
||||
|
||||
a) Give prominent notice with each copy of the object code that the
|
||||
Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
|
||||
b) Accompany the object code with a copy of the GNU GPL and this license
|
||||
document.
|
||||
|
||||
4. Combined Works.
|
||||
|
||||
You may convey a Combined Work under terms of your choice that,
|
||||
taken together, effectively do not restrict modification of the
|
||||
portions of the Library contained in the Combined Work and reverse
|
||||
engineering for debugging such modifications, if you also do each of
|
||||
the following:
|
||||
|
||||
a) Give prominent notice with each copy of the Combined Work that
|
||||
the Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
|
||||
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||
document.
|
||||
|
||||
c) For a Combined Work that displays copyright notices during
|
||||
execution, include the copyright notice for the Library among
|
||||
these notices, as well as a reference directing the user to the
|
||||
copies of the GNU GPL and this license document.
|
||||
|
||||
d) Do one of the following:
|
||||
|
||||
0) Convey the Minimal Corresponding Source under the terms of this
|
||||
License, and the Corresponding Application Code in a form
|
||||
suitable for, and under terms that permit, the user to
|
||||
recombine or relink the Application with a modified version of
|
||||
the Linked Version to produce a modified Combined Work, in the
|
||||
manner specified by section 6 of the GNU GPL for conveying
|
||||
Corresponding Source.
|
||||
|
||||
1) Use a suitable shared library mechanism for linking with the
|
||||
Library. A suitable mechanism is one that (a) uses at run time
|
||||
a copy of the Library already present on the user's computer
|
||||
system, and (b) will operate properly with a modified version
|
||||
of the Library that is interface-compatible with the Linked
|
||||
Version.
|
||||
|
||||
e) Provide Installation Information, but only if you would otherwise
|
||||
be required to provide such information under section 6 of the
|
||||
GNU GPL, and only to the extent that such information is
|
||||
necessary to install and execute a modified version of the
|
||||
Combined Work produced by recombining or relinking the
|
||||
Application with a modified version of the Linked Version. (If
|
||||
you use option 4d0, the Installation Information must accompany
|
||||
the Minimal Corresponding Source and Corresponding Application
|
||||
Code. If you use option 4d1, you must provide the Installation
|
||||
Information in the manner specified by section 6 of the GNU GPL
|
||||
for conveying Corresponding Source.)
|
||||
|
||||
5. Combined Libraries.
|
||||
|
||||
You may place library facilities that are a work based on the
|
||||
Library side by side in a single library together with other library
|
||||
facilities that are not Applications and are not covered by this
|
||||
License, and convey such a combined library under terms of your
|
||||
choice, if you do both of the following:
|
||||
|
||||
a) Accompany the combined library with a copy of the same work based
|
||||
on the Library, uncombined with any other library facilities,
|
||||
conveyed under the terms of this License.
|
||||
|
||||
b) Give prominent notice with the combined library that part of it
|
||||
is a work based on the Library, and explaining where to find the
|
||||
accompanying uncombined form of the same work.
|
||||
|
||||
6. Revised Versions of the GNU Lesser General Public License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions
|
||||
of the GNU Lesser General Public License from time to time. Such new
|
||||
versions will be similar in spirit to the present version, but may
|
||||
differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Library as you received it specifies that a certain numbered version
|
||||
of the GNU Lesser General Public License "or any later version"
|
||||
applies to it, you have the option of following the terms and
|
||||
conditions either of that published version or of any later version
|
||||
published by the Free Software Foundation. If the Library as you
|
||||
received it does not specify a version number of the GNU Lesser
|
||||
General Public License, you may choose any version of the GNU Lesser
|
||||
General Public License ever published by the Free Software Foundation.
|
||||
|
||||
If the Library as you received it specifies that a proxy can decide
|
||||
whether future versions of the GNU Lesser General Public License shall
|
||||
apply, that proxy's public statement of acceptance of any version is
|
||||
permanent authorization for you to choose that version for the
|
||||
Library.
|
85
libopencm3/HACKING
Normal file
85
libopencm3/HACKING
Normal file
@ -0,0 +1,85 @@
|
||||
------------------------------------------------------------------------------
|
||||
HACKING
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
Coding style
|
||||
------------
|
||||
|
||||
The whole library is programmed using the Linux kernel coding style, see
|
||||
https://www.kernel.org/doc/html/latest/process/coding-style.html for details.
|
||||
|
||||
Please use the same style for any code contributions, thanks!
|
||||
|
||||
Amendments to the Linux kernel coding style
|
||||
-------------------------------------------
|
||||
|
||||
1) We use the stdint types. The linux kernel accepts the abbreviated types (u8,
|
||||
s8, u16 and so on) for legacy reasons. We should in general not introduce
|
||||
things like types ourselves as long as they are not necessary to make our
|
||||
job possible of refining the hardware and make it easier to be used. stdint
|
||||
is a standard and it is not in the scope of our project to introduce a new
|
||||
type standard.
|
||||
|
||||
2) Based on the same logic as in (1) we do not use __packed and __aligned
|
||||
definitions, it is not our job to add compiler extensions. If we need to
|
||||
deal with compiler incompatibility we will do that the same way we are
|
||||
dealing with the deprecated attribute by introducing a normal macro that is
|
||||
not in the compiler reserved keyword space.
|
||||
|
||||
3) We accept to write an empty body busy waiting while loop like this:
|
||||
while (1);
|
||||
there is no need to put the colon on the next line as per linux kernel
|
||||
style.
|
||||
|
||||
4) We always add brackets around bodies of if, while and for statements, even
|
||||
if the body contains only one expression. It is dangerous to not have them
|
||||
as it easily happens that one adds a second expression and is hunting for
|
||||
hours why the code is not working just because of a missing bracket pair.
|
||||
|
||||
Development guidelines
|
||||
----------------------
|
||||
|
||||
- Every new file added must have the usual license header, see the
|
||||
existing files for examples.
|
||||
|
||||
- In general, please try to keep the register and bit naming as close
|
||||
as possible to the official vendor datasheets. Among other reasons, this
|
||||
makes it easier for users to find what they're looking for in the
|
||||
datasheets, programming manuals, and application notes.
|
||||
|
||||
- All register definitions should follow the following naming conventions:
|
||||
|
||||
- The #define names should be all-caps, parts are separated by
|
||||
an underscore.
|
||||
|
||||
- The name should be of the form SUBSYSTEM_REGISTER_BIT, e.g.
|
||||
ADC_CR2_DMA, where ADC is the subsystem name, CR2 is the register NAME,
|
||||
and DMA is the name of the bit in the register that is defined.
|
||||
|
||||
- All subsystem-specific function names should be prefixed with the
|
||||
subsystem name. For example, gpio_set_mode() or rcc_osc_on().
|
||||
|
||||
- Please consistently use the stdint types.
|
||||
|
||||
- Variables that are used to store register values read from registers or
|
||||
to be stored in a register should be named reg8, reg16, reg32 etc.
|
||||
|
||||
- For examples on using libopencm3 see the libopencm3-examples repository.
|
||||
|
||||
- Doxygen is used to generate API docs, please follow that style for function
|
||||
and definition commentary where possible.
|
||||
|
||||
Tips and tricks
|
||||
---------------
|
||||
|
||||
SublimeText users:
|
||||
|
||||
- The project contains a sublime project description file with some basic
|
||||
settings provided to make hacking on libopencm3 easier.
|
||||
|
||||
- Recommended SublimeText plugins when hacking on libopencm3:
|
||||
|
||||
- TrailingSpaces: Show and trim trailing line spaces.
|
||||
|
||||
- SublimeLinter: Run checkpatch.pl in the background while you write your
|
||||
code and indicate possible coding style issues on the fly.
|
76
libopencm3/HACKING_COMMON_DOC
Normal file
76
libopencm3/HACKING_COMMON_DOC
Normal file
@ -0,0 +1,76 @@
|
||||
Files for each peripheral (examples given for STM32 GPIO)
|
||||
---------------------------------------------------------
|
||||
|
||||
In include/libopencm3/stm32.
|
||||
A "dispatch" header to point to the subfamily header (gpio.h)
|
||||
|
||||
In include/libopencm3/stm32/f*
|
||||
A file with defines that are specific to the subfamily, and an include of
|
||||
needed common header files (gpio.h).
|
||||
|
||||
In include/libopencm3/stm32/common
|
||||
A file with defines common to all subfamilies. Includes the cm3 common header
|
||||
(gpio_common_all.h).
|
||||
|
||||
In include/libopencm3/stm32/common
|
||||
May be one other file with defines common to a subgroup of devices.
|
||||
This includes the file common to all (gpio_common_f24.h).
|
||||
|
||||
In lib/stm32/f*
|
||||
A file with functions specific to the subfamily. Includes the "dispatch" header
|
||||
and any common headers needed (gpio.c).
|
||||
|
||||
In lib/stm32/common
|
||||
Has functions common to all subfamilies. Includes the "dispatch" header
|
||||
(gpio_common_all.c).
|
||||
|
||||
In lib/stm32/common
|
||||
May be one other file with functions common to a group of subfamilies. Includes
|
||||
the "dispatch" header and the file common to all (gpio_common_f24.h).
|
||||
|
||||
Makefiles in lib/stm32/f? have the common object files added and the
|
||||
common directory added to VPATH.
|
||||
|
||||
NOTE: The common source files MUST have the "dispatch" header so that
|
||||
compilation will use the specific defines for the subfamily being compiled.
|
||||
These can differ between subfamilies.
|
||||
|
||||
NOTE: The common source files must have a line of the form
|
||||
|
||||
#ifdef LIBOPENCM3_xxx_H
|
||||
|
||||
where xxx is the associated peripheral name. This prevents the common files
|
||||
from being included accidentally into a user's application. This however
|
||||
causes doxygen to skip processing of the remainder of the file. Thus a
|
||||
|
||||
@cond ... @endcond
|
||||
|
||||
directive must be placed around the statement to prevent doxygen from
|
||||
processing it. This works only for doxygen 1.8.4 or later. At the present
|
||||
time most distros have an earlier buggy version.
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
In include/libopencm3/stm32/f*
|
||||
A file doc-stm32f*.h contains a definition of the particular family grouping.
|
||||
This grouping will appear in the main index of the resulting document with all
|
||||
documentation under it.
|
||||
|
||||
All header files for a peripheral (common or otherwise) will subgroup under a
|
||||
name which is the same in all families (such as gpio_defines). The peripheral
|
||||
header file in include/libopencm3/stm32/f* will then include this group as a
|
||||
subgroup under the specific family group. Doxygen is run separately for each
|
||||
family so there is no danger of accidentally including the wrong stuff.
|
||||
|
||||
Similarly for the source files for a peripheral which will subgroup under a
|
||||
same name (such as gpio_files). The peripheral source file in lib/stm32/f*
|
||||
will include this as a subgroup under the specific family group.
|
||||
|
||||
DOXYFILE for a particular family will list the family specific and common files
|
||||
(headers and source) that are to be included. The result (in the long run) will
|
||||
be that all peripherals will appear under the same family grouping in the
|
||||
documentation, even if they are identical over a number of families. That is
|
||||
probably most useful to end users who only need to see the documentation for
|
||||
one family.
|
||||
|
131
libopencm3/Makefile
Normal file
131
libopencm3/Makefile
Normal file
@ -0,0 +1,131 @@
|
||||
##
|
||||
## This file is part of the libopencm3 project.
|
||||
##
|
||||
## Copyright (C) 2009 Uwe Hermann <uwe@hermann-uwe.de>
|
||||
##
|
||||
## 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/>.
|
||||
##
|
||||
|
||||
PREFIX ?= arm-none-eabi-
|
||||
|
||||
STYLECHECK := scripts/checkpatch.pl
|
||||
STYLECHECKFLAGS := --no-tree -f --terse --mailback
|
||||
|
||||
TARGETS ?= stm32/f0 stm32/f1 stm32/f2 stm32/f3 stm32/f4 stm32/f7 \
|
||||
stm32/l0 stm32/l1 stm32/l4 \
|
||||
stm32/g0 stm32/g4 \
|
||||
stm32/h7 \
|
||||
gd32/f1x0 \
|
||||
lpc13xx lpc17xx lpc43xx/m4 lpc43xx/m0 \
|
||||
lm3s lm4f msp432/e4 \
|
||||
efm32/tg efm32/g efm32/lg efm32/gg efm32/hg efm32/wg \
|
||||
efm32/ezr32wg \
|
||||
nrf/51 nrf/52 \
|
||||
sam/3a sam/3n sam/3s sam/3u sam/3x sam/4l \
|
||||
sam/d \
|
||||
vf6xx \
|
||||
swm050 \
|
||||
pac55xx
|
||||
|
||||
# Be silent per default, but 'make V=1' will show all compiler calls.
|
||||
ifneq ($(V),1)
|
||||
Q := @
|
||||
# Do not print "Entering directory ...".
|
||||
MAKEFLAGS += --no-print-directory
|
||||
endif
|
||||
|
||||
# Avoid the use of shell find, for windows compatibility
|
||||
IRQ_DEFN_FILES := $(foreach TARGET,$(TARGETS),$(wildcard include/libopencm3/$(TARGET)/irq.json))
|
||||
NVIC_H := $(IRQ_DEFN_FILES:%/irq.json=%/nvic.h)
|
||||
VECTOR_NVIC_C := $(IRQ_DEFN_FILES:./include/libopencm3/%/irq.json=./lib/%/vector_nvic.c)
|
||||
IRQHANDLERS_H := $(IRQ_DEFN_FILES:./include/libopencm3/%/irq.json=./include/libopencmsis/%/irqhandlers.h)
|
||||
IRQ_GENERATED_FILES = $(NVIC_H) $(VECTOR_NVIC_C) $(IRQHANDLERS_H)
|
||||
STYLECHECKFILES := $(wildcard include/*/*.h include/*/*/*.h include/*/*/*/*.h)
|
||||
STYLECHECKFILES += $(wildcard lib/*/*.h lib/*/*/*.h lib/*/*/*/*.h)
|
||||
STYLECHECKFILES += $(wildcard lib/*/*.c lib/*/*/*.c lib/*/*/*/*.c)
|
||||
|
||||
all: build
|
||||
|
||||
build: lib
|
||||
|
||||
include/libopencm3/%/nvic.h lib/%/vector_nvic.c include/libopencmsis/%/irqhandlers.h: include/libopencm3/%/irq.json ./scripts/irq2nvic_h
|
||||
@printf " GENHDR $*\n";
|
||||
$(Q)./scripts/irq2nvic_h ./$<;
|
||||
|
||||
%.cleanhdr:
|
||||
@printf " CLNHDR $*\n";
|
||||
$(Q)./scripts/irq2nvic_h --remove ./$*
|
||||
|
||||
LIB_DIRS:=$(wildcard $(addprefix lib/,$(TARGETS)))
|
||||
$(LIB_DIRS): $(IRQ_GENERATED_FILES)
|
||||
$(Q)$(RM) .stamp_failure_$(subst /,_,$@)
|
||||
@printf " BUILD $@\n";
|
||||
$(Q)$(MAKE) --directory=$@ PREFIX="$(PREFIX)" || \
|
||||
echo "Failure building: $@: code: $$?" > .stamp_failure_$(subst /,_,$@)
|
||||
|
||||
lib: $(LIB_DIRS)
|
||||
$(Q)$(RM) .stamp_failure_tld
|
||||
$(Q)for failure in .stamp_failure_*; do \
|
||||
[ -f $$failure ] && cat $$failure >> .stamp_failure_tld || true; \
|
||||
done;
|
||||
$(Q)[ -f .stamp_failure_tld ] && cat .stamp_failure_tld && exit 1 || true;
|
||||
|
||||
html doc:
|
||||
$(Q)$(MAKE) -C doc html TARGETS="$(TARGETS)"
|
||||
|
||||
clean: $(IRQ_DEFN_FILES:=.cleanhdr) $(LIB_DIRS:=.clean) $(EXAMPLE_DIRS:=.clean) doc.clean styleclean genlinktests.clean
|
||||
|
||||
%.clean:
|
||||
$(Q)if [ -d $* ]; then \
|
||||
printf " CLEAN $*\n"; \
|
||||
$(MAKE) -C $* clean || exit $?; \
|
||||
fi;
|
||||
$(Q)$(RM) .stamp_failure_*;
|
||||
|
||||
|
||||
stylecheck: $(STYLECHECKFILES:=.stylecheck)
|
||||
styleclean: $(STYLECHECKFILES:=.styleclean)
|
||||
|
||||
# the cat is due to multithreaded nature - we like to have consistent chunks of text on the output
|
||||
%.stylecheck: %
|
||||
$(Q)if ! grep -q "* It was generated by the irq2nvic_h script." $* ; then \
|
||||
$(STYLECHECK) $(STYLECHECKFLAGS) $* > $*.stylecheck; \
|
||||
if [ -s $*.stylecheck ]; then \
|
||||
cat $*.stylecheck; \
|
||||
else \
|
||||
rm -f $*.stylecheck; \
|
||||
fi; \
|
||||
fi;
|
||||
|
||||
%.styleclean:
|
||||
$(Q)rm -f $*.stylecheck;
|
||||
|
||||
|
||||
LDTESTS :=$(wildcard ld/tests/*.data)
|
||||
|
||||
genlinktests: $(LDTESTS:.data=.ldtest)
|
||||
genlinktests.clean:
|
||||
$(Q)rm -f $(LDTESTS:.data=.out)
|
||||
|
||||
%.ldtest:
|
||||
@if ./scripts/genlinktest.sh $* >/dev/null; then\
|
||||
printf " TEST OK : $*\n"; \
|
||||
else \
|
||||
printf " TEST FAIL : $*\n"; \
|
||||
fi;
|
||||
|
||||
list-targets:
|
||||
@echo $(TARGETS)
|
||||
|
||||
.PHONY: build lib $(LIB_DIRS) doc clean generatedheaders cleanheaders stylecheck genlinktests genlinktests.clean list-targets
|
219
libopencm3/README.md
Normal file
219
libopencm3/README.md
Normal file
@ -0,0 +1,219 @@
|
||||
README
|
||||
======
|
||||
[![Build Status](https://travis-ci.org/libopencm3/libopencm3.svg?branch=master)](https://travis-ci.org/libopencm3/libopencm3)
|
||||
|
||||
[![Gitter channel](https://badges.gitter.im/libopencm3/discuss.svg)](https://gitter.im/libopencm3/discuss)
|
||||
|
||||
The libopencm3 project aims to create an open-source firmware library for
|
||||
various ARM Cortex-M microcontrollers.
|
||||
|
||||
Currently (at least partly) supported microcontrollers:
|
||||
|
||||
- ST STM32 F0xx/F1xx/F2xx/F30x/F37x/F4xx/F7xx/H7xx series
|
||||
- ST STM32 G0xx G4xx L0xx L1xx L4xx series
|
||||
- Atmel SAM3A/3N/3S/3U/3X series, as well as SAMDxx and friends
|
||||
- NXP LPC1311/13/17/42/43
|
||||
- Stellaris LM3S series (discontinued, without replacement)
|
||||
- TI (Tiva) LM4F series (continuing as TM4F, pin and peripheral compatible)
|
||||
- EFM32 Gecko series (only core support)
|
||||
- Freescale Vybrid VF6xx
|
||||
- Qorvo (formerly ActiveSemi) PAC55XX
|
||||
- Synwit SWM050
|
||||
- Nordic NRF51x and NRF52x
|
||||
|
||||
The library is written completely from scratch based on the vendor datasheets,
|
||||
programming manuals, and application notes. The code is meant to be used
|
||||
with a GCC toolchain for ARM (arm-elf or arm-none-eabi), flashing of the
|
||||
code to a microcontroller can be done using the OpenOCD ARM JTAG software.
|
||||
|
||||
|
||||
Status and API
|
||||
--------------
|
||||
|
||||
The libopencm3 project is (and presumably, always will be) a work in progress.
|
||||
Not all subsystems of all microcontrollers are supported, yet, though some parts
|
||||
have more complete support than others.
|
||||
|
||||
Prior to version 0.8.0, the api was largely in flux. Attempts were made to provide
|
||||
backwards compatibility, but this was not always considered critical.
|
||||
|
||||
From 0.8.0 to 1.0, we'll atempt to follow semver, but **EXPECT CHANGES**, as we
|
||||
attempt to clear up old APIs and remove deprecated functions. The 0.8.0 tag was
|
||||
placed to provide the "old stable" point before all the new code started landing.
|
||||
|
||||
_preview_ code often lands in the "wildwest-N" branches that appear and disappear
|
||||
in the repository. Pull requests marked as "merged-dev" will be in this branch,
|
||||
and will be closed when they merge to master. This is useful for bigger
|
||||
interdependent patch sets, and also allows review of merge conflicts in public.
|
||||
|
||||
From 1.0, expect to follow semver, with functions (and defines!) being deprecated for
|
||||
a release before being removed.
|
||||
|
||||
_TIP_: Include this repository as a Git submodule in your project to make sure
|
||||
your users get the right version of the library to compile your project.
|
||||
For how that can be done refer to the
|
||||
[libopencm3-template](https://github.com/libopencm3/libopencm3-template) repository.
|
||||
|
||||
Prerequisites
|
||||
-------------
|
||||
|
||||
Building requires Python (some code is generated).
|
||||
|
||||
**For Ubuntu/Fedora:**
|
||||
|
||||
- An arm-none-eabi/arm-elf toolchain.
|
||||
|
||||
**For Windows:**
|
||||
|
||||
Download and install:
|
||||
|
||||
- msys - http://sourceforge.net/projects/mingw/files/MSYS/Base/msys-core/msys-1.0.11/MSYS-1.0.11.exe
|
||||
- Python - https://www.python.org/downloads/windows/ (any release)
|
||||
- arm-none-eabi/arm-elf toolchain (for example this one https://launchpad.net/gcc-arm-embedded)
|
||||
|
||||
Run msys shell and set the path without standard Windows paths (adjusting to your version of Python), so Windows programs such as 'find' won't interfere:
|
||||
|
||||
export PATH="/c//Program Files/Python 3.9:/c/ARMToolchain/bin:/usr/local/bin:/usr/bin:/bin"
|
||||
|
||||
After that you can navigate to the folder where you've extracted libopencm3 and build it.
|
||||
|
||||
Toolchain
|
||||
---------
|
||||
|
||||
The most heavily tested toolchain is "gcc-arm-embedded"
|
||||
https://launchpad.net/gcc-arm-embedded
|
||||
|
||||
Other toolchains _should_ work, but they have not been nearly as well tested.
|
||||
Toolchains targeting Linux, such as "gcc-arm-linux-gnu" or the like are
|
||||
_not_ appropriate.
|
||||
|
||||
_NOTE_: We recommend that you use gcc-arm-embedded version 4.8 2014q3 or newer
|
||||
to build all platforms covered by libopencm3 successfully.
|
||||
|
||||
Building
|
||||
--------
|
||||
|
||||
$ make
|
||||
|
||||
If you have an arm-elf toolchain (uncommon) you may want to override the
|
||||
toolchain prefix (arm-none-eabi is the default)
|
||||
|
||||
$ PREFIX=arm-elf make
|
||||
|
||||
For a more verbose build you can use
|
||||
|
||||
$ make V=1
|
||||
|
||||
You can reduce the build time by specifying a particular MCU series
|
||||
|
||||
$ make TARGETS='stm32/f1 stm32/f4'
|
||||
|
||||
Supported targets can be listed using:
|
||||
|
||||
$ make list-targets
|
||||
|
||||
Fine-tuning the build
|
||||
---------------------
|
||||
|
||||
The build may be fine-tuned with a limited number of parameters, by specifying
|
||||
them as environment variables, for example:
|
||||
|
||||
$ VARIABLE=value make
|
||||
|
||||
* `FP_FLAGS` - Control the floating-point ABI
|
||||
|
||||
If the Cortex-M core supports a hard float ABI, it will be compiled with
|
||||
the best floating-point support by default. In cases where this is not desired, the
|
||||
behavior can be specified by setting `FP_FLAGS`.
|
||||
|
||||
Currently, M4F cores default to `-mfloat-abi=hard -mfpu=fpv4-sp-d16`, and
|
||||
M7 cores defaults to double precision `-mfloat-abi=hard -mfpu=fpv5-d16` if available,
|
||||
and single precision `-mfloat-abi=hard -mfpu=fpv5-sp-d16` otherwise.
|
||||
Other architectures use no FP flags, in otherwords, traditional softfp.
|
||||
|
||||
You may find which FP_FLAGS you can use in a particular architecture in the readme.txt
|
||||
file shipped with the gcc-arm-embedded package.
|
||||
|
||||
Examples:
|
||||
|
||||
$ FP_FLAGS="-mfloat-abi=soft" make # No hardfloat
|
||||
$ FP_FLAGS="-mfloat-abi=hard -mfpu=magic" make # New FPU we don't know of
|
||||
|
||||
* `CFLAGS` - Add to or supersede compiler flags
|
||||
|
||||
If the library needs to be compiled with additional flags, they can be
|
||||
passed to the build system via the environment variable `CFLAGS`. The
|
||||
contents of `CFLAGS` will be placed after all flags defined by the build
|
||||
system, giving the user a way to override any default if necessary.
|
||||
|
||||
Examples:
|
||||
|
||||
$ CFLAGS="-fshort-wchar" make # Compile lib with 2 byte wide wchar_t
|
||||
|
||||
Example projects
|
||||
----------------
|
||||
|
||||
The libopencm3 community has written and is maintaining a huge collection of
|
||||
examples, displaying the capabilities and uses of the library. You can find all
|
||||
of them in the libopencm3-examples repository:
|
||||
|
||||
https://github.com/libopencm3/libopencm3-examples
|
||||
|
||||
If you just wish to test your toolchain and build environment, a collection of
|
||||
mini blink projects is available too. This covers _many_ more boards, but, as
|
||||
the name suggests, only demonstrates blinking LEDs.
|
||||
|
||||
|
||||
https://github.com/libopencm3/libopencm3-miniblink
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
Simply pass -I and -L flags to your own project. See the
|
||||
[libopencm3-template](https://github.com/libopencm3/libopencm3-template)
|
||||
repository for a template repository using this library as a Git submodule,
|
||||
the most popular method of use. The libopencm3-examples is another
|
||||
example of this.
|
||||
|
||||
It is strongly advised that you do not attempt to install this library to any
|
||||
path inside your toolchain itself. While this means you don't have to include
|
||||
any `-I` or `-L` flags in your projects, it is _very_ easy to confuse a multi-library
|
||||
linker from picking the right versions of libraries. Common symptoms are
|
||||
hardfaults caused by branches into ARM code. You can use `arm-none-eabi-objdump`
|
||||
to check for this in your final ELF file. You have been warned.
|
||||
|
||||
Coding style and development guidelines
|
||||
---------------------------------------
|
||||
|
||||
See HACKING.
|
||||
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
The libopencm3 code is released under the terms of the GNU Lesser General
|
||||
Public License (LGPL), version 3 or later.
|
||||
|
||||
See COPYING.GPL3 and COPYING.LGPL3 for details.
|
||||
|
||||
Community
|
||||
---------
|
||||
|
||||
* Our [![Gitter channel](https://badges.gitter.im/libopencm3/discuss.svg)](https://gitter.im/libopencm3/discuss)
|
||||
* Our IRC channel on the libera.chat IRC network is called #libopencm3
|
||||
|
||||
Mailing lists
|
||||
-------------
|
||||
|
||||
* Developer mailing list (for patches and discussions):
|
||||
https://lists.sourceforge.net/lists/listinfo/libopencm3-devel
|
||||
|
||||
* Commits mailing list (receives one mail per `git push`):
|
||||
https://lists.sourceforge.net/lists/listinfo/libopencm3-commits
|
||||
|
||||
|
||||
Website
|
||||
-------
|
||||
|
||||
* http://libopencm3.org - contains daily autogenerated API documentation
|
||||
|
21
libopencm3/doc/Doxyfile
Normal file
21
libopencm3/doc/Doxyfile
Normal file
@ -0,0 +1,21 @@
|
||||
# Doxygen include file to generate top level entry document
|
||||
|
||||
# 14 September 2012
|
||||
# (C) Ken Sarkies <ksarkies@internode.on.net>
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Common Include File
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
@INCLUDE = ./Doxyfile_common
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Local settings
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
INPUT = ../include/libopencm3/docmain.dox
|
||||
|
||||
LAYOUT_FILE = DoxygenLayout.xml
|
||||
|
||||
GENERATE_LATEX = NO
|
||||
|
1809
libopencm3/doc/Doxyfile_common
Normal file
1809
libopencm3/doc/Doxyfile_common
Normal file
File diff suppressed because it is too large
Load Diff
106
libopencm3/doc/HACKING
Normal file
106
libopencm3/doc/HACKING
Normal file
@ -0,0 +1,106 @@
|
||||
libopencm3 Documentation
|
||||
12 October 2012 (C) K Sarkies
|
||||
-----------------------------
|
||||
|
||||
Each family and subfamily of devices has a separate directory and configuration
|
||||
files. Doxygen is run independently on each of these and the result is
|
||||
integrated under a single HTML page.
|
||||
Due to relative referencing used in the files, the directory
|
||||
structure is important and should be maintained.
|
||||
The Makefile will automatically generate the list of input files based on the
|
||||
current library makefiles, so you _must_ have run built the library itself first.
|
||||
|
||||
Each of the subdirectories has a configuration file, a layout file and
|
||||
subdirectories for the documentation. Doxygen is intended to be run inside
|
||||
these subdirectories. The Makefile will handle this in the appropriate
|
||||
order.
|
||||
|
||||
Markup
|
||||
------
|
||||
|
||||
Each family has been given a group name that will allow subgrouping of API
|
||||
functions and defines in the documentation.
|
||||
|
||||
The header and source files for each peripheral in each family must have a
|
||||
heading section in which an @defgroup defines the group name for the particular
|
||||
peripheral. This group name will be the same across all families as each one
|
||||
is documented separately. Thus for a peripheral xxx the header will have a
|
||||
group name xxx_defines and the source file will have xxx_file. This will allow
|
||||
the group to appear separately. An @ingroup must be provided to place the group
|
||||
as a subgroup of the appropriate family grouping. Note that @file is not used.
|
||||
|
||||
The heading section must include the version number and date and authors names
|
||||
plus a license reference. Any documentation specific to the family can be
|
||||
included here. If there are common files included then their documentation will
|
||||
appear in a separate section.
|
||||
|
||||
Common header and source files that are included into a number of families must
|
||||
have an @addgroup to include its documentation into the appropriate peripheral
|
||||
group. These headings may include authors and any specific descriptions but the
|
||||
date and version number must be omitted as it will be included from the family
|
||||
files. There must not be any reference to family groupings as these common files
|
||||
will be incorporated into multiple family groups.
|
||||
|
||||
The common files should not be included in an application explicitly. Also the
|
||||
doxygen preprocessor must be enabled to ensure that all macros and defines are
|
||||
included. This means that common header files need to have a section at the top
|
||||
of the file of the type (eg for gpio_common_f24.h):
|
||||
|
||||
/** @cond */
|
||||
#ifdef LIBOPENCM3_GPIO_H
|
||||
/** @endcond */
|
||||
|
||||
and at the end of the file:
|
||||
|
||||
/** @cond */
|
||||
#else
|
||||
#warning "gpio_common_f24.h should not be included explicitly, only via gpio.h"
|
||||
#endif
|
||||
/** @endcond */
|
||||
|
||||
This will stop the compiler preprocessor from including the common header file
|
||||
unless the device family header file has also been included. The doxygen
|
||||
conditional clauses are needed to stop the doxygen preprocessor seeing this
|
||||
statement and so excluding processing of the common file contents.
|
||||
|
||||
/** @cond */
|
||||
#if defined(LIBOPENCM3_GPIO_H) || defined(LIBOPENCM3_GPIO_COMMON_F24_H)
|
||||
/** @endcond */
|
||||
|
||||
Each helper function must have a header with an @brief, and where appropriate
|
||||
additional description, @parameter and @return elements. These latter must
|
||||
describe the allowable parameter ranges preferably with reference to a suitable
|
||||
define in the corresponding header file.
|
||||
|
||||
The Doxyfile for a family must include input files from the header and source
|
||||
subdirectories, as well as all needed common files. The common files can be
|
||||
added separately or as an entire directory with exclusions of inappropriate
|
||||
files.
|
||||
|
||||
Doxyfiles
|
||||
---------
|
||||
|
||||
Doxyfile_common holds global settings.
|
||||
|
||||
OUTPUT_DIRECTORY blank so that the output is placed in the current directory.
|
||||
RECURSIVE = NO
|
||||
EXTERNAL_GROUPS = NO
|
||||
|
||||
Each Doxyfile_include for a processor family has:
|
||||
|
||||
@INCLUDE = ../Doxyfile_common
|
||||
INPUT = specific directories needed, including /include/libopencm3/cm3
|
||||
in top directory to set the top level page and GNU license.
|
||||
LAYOUT_FILE = DoxygenLayout_$processor.xml
|
||||
WARN_LOGFILE = doxygen_$processor.log
|
||||
TAGFILES = ../cm3/cm3.tag=../../cm3/html
|
||||
GENERATE_TAGFILE = $processor.tag
|
||||
PREDEFINED = list of macro definitions
|
||||
|
||||
For the top level Doxyfile
|
||||
|
||||
INPUT = ../include/libopencm3/docmain.dox to add in the main page text
|
||||
LAYOUT_FILE = DoxygenLayout.xml
|
||||
WARN_LOGFILE = doxygen.log
|
||||
TAGFILES = cm3/cm3.tag=../cm3/html plus all families to be included.
|
||||
|
65
libopencm3/doc/Makefile
Normal file
65
libopencm3/doc/Makefile
Normal file
@ -0,0 +1,65 @@
|
||||
# Makefile to build libopencm3 documentation
|
||||
|
||||
# 14 September 2012
|
||||
# (C) Ken Sarkies <ksarkies@internode.on.net>
|
||||
|
||||
# setup TARGETS if not set for legacy and ease of debug.
|
||||
TARGETS ?= stm32/f0 stm32/f1 stm32/f2 stm32/f3 stm32/f4 stm32/f7 stm32/h7 \
|
||||
stm32/l0 stm32/l1 stm32/l4 \
|
||||
stm32/g0 stm32/g4 \
|
||||
gd32/f1x0 \
|
||||
efm32/g efm32/gg efm32/hg efm32/lg efm32/tg \
|
||||
efm32/wg efm32/ezr32wg \
|
||||
lm3s lm4f \
|
||||
msp432/e4 \
|
||||
nrf/51 nrf/52 \
|
||||
lpc13xx lpc17xx lpc43xx \
|
||||
sam/3a sam/3n sam/3s sam/3u sam/3x \
|
||||
sam/d sam/4l \
|
||||
vf6xx \
|
||||
swm050 \
|
||||
pac55xx
|
||||
|
||||
|
||||
TARGETS_DIRS = $(subst /,,$(TARGETS))
|
||||
|
||||
doc: html
|
||||
|
||||
|
||||
DoxygenLayout.xml: templates/DoxygenLayout_Root.xml
|
||||
../scripts/gendoxylayout.py --template $< --out $@ $(TARGETS_DIRS)
|
||||
|
||||
define gen_DOC_TARGET
|
||||
DOC_TARGETS += doc_$(1)
|
||||
CLEAN_TARGETS += clean_$(1)
|
||||
|
||||
$(1)/:
|
||||
@mkdir -p $$@
|
||||
|
||||
$(1)/doxy.sourcelist: $(1)/
|
||||
@../scripts/gendoxylist ../lib/$(TARGET_SRC_DIR) $(1)
|
||||
|
||||
$(1)/Doxyfile: templates/Doxyfile_Device | $(1)/
|
||||
@cat $$< | sed s/#device#/$(1)/g > $$@
|
||||
|
||||
$(1)/DoxygenLayout_$(1).xml: templates/DoxygenLayout_Device.xml | $(1)/
|
||||
@../scripts/gendoxylayout.py --template $$< --out $$@ --target $(1) $$(TARGETS_DIRS)
|
||||
|
||||
doc_$(1): $(1)/doxy.sourcelist $(1)/Doxyfile $(1)/DoxygenLayout_$(1).xml
|
||||
@(cd $(1); doxygen)
|
||||
|
||||
clean_$(1):
|
||||
@$(RM) -rf $(1)/doxy.sourcelist $(1)/Doxyfile $(1)/DoxygenLayout_$1.xml $(1)/doxygen_$(1).log $(1)/html $(1)/$(1).tag
|
||||
|
||||
endef
|
||||
|
||||
$(foreach TARGET_SRC_DIR, $(TARGETS), $(eval $(call gen_DOC_TARGET,$(subst /,,$(TARGET_SRC_DIR)))))
|
||||
|
||||
html: $(DOC_TARGETS) DoxygenLayout.xml
|
||||
doxygen
|
||||
|
||||
clean: $(CLEAN_TARGETS)
|
||||
@rm -rf html/ DoxygenLayout.xml doxygen.log
|
||||
|
||||
.PHONY: doc html $(DOC_TARGETS) $(CLEAN_TARGETS)
|
||||
|
34
libopencm3/doc/README
Normal file
34
libopencm3/doc/README
Normal file
@ -0,0 +1,34 @@
|
||||
libopencm3 Documentation
|
||||
14 September 2012 (C) K Sarkies
|
||||
-------------------------------
|
||||
|
||||
To generate all documentation run 'make doc' in the doc directory, or
|
||||
for html documentation only run 'make html' (much faster). This runs doxygen
|
||||
for each of the processor families then integrates the whole.
|
||||
|
||||
Alternatively run 'make doc' in the top directory to make html documentation.
|
||||
LaTeX and pdf documentation is currently very large in size.
|
||||
|
||||
This requires doxygen v 1.8.2 or later.
|
||||
|
||||
HTML, LaTeX, and pdf output can be produced.
|
||||
|
||||
Generation of HTML
|
||||
------------------
|
||||
|
||||
To view HTML, point a browser to libopencm3/doc/html/index.html.
|
||||
|
||||
Generation of PDF
|
||||
-----------------
|
||||
|
||||
The pdf is generated via LaTeX. The pdf files are placed in the
|
||||
doc directory. Each file contains all documentation for the core and common
|
||||
features. The resulting files are huge.
|
||||
|
||||
|
||||
Requirements
|
||||
------------
|
||||
On Fedora 19, the following packages (at least!) are needed to build the pdf
|
||||
output
|
||||
|
||||
texlive texlive-sectsty texlive-tocloft texlive-xtab texlive-multirow
|
1
libopencm3/doc/efm32ezr32wg/doxy.custom
Normal file
1
libopencm3/doc/efm32ezr32wg/doxy.custom
Normal file
@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7EM__
|
1
libopencm3/doc/efm32g/doxy.custom
Normal file
1
libopencm3/doc/efm32g/doxy.custom
Normal file
@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7M__
|
1
libopencm3/doc/efm32gg/doxy.custom
Normal file
1
libopencm3/doc/efm32gg/doxy.custom
Normal file
@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7M__
|