Skip to content

Commit c2bddd4

Browse files
MarianSavchukMarianSavchuk
authored
Merge pull request #7 from ARMmbed/master
merge from master
2 parents fdbe2a1 + 00213db commit c2bddd4

File tree

95 files changed

+2831
-613
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

95 files changed

+2831
-613
lines changed

‎.editorconfig‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# top-most EditorConfig file
2+
root = true
3+
4+
# Common file settings.
5+
[*]
6+
charset = utf-8
7+
indent_style = space
8+
indent_size = 4
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true

‎CONTRIBUTING.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
Contributing
2+
============
3+
4+
We appreciate your contributions! Because this is an open source project, we want to keep it as easy
5+
as possible to contribute changes. However, we need contributors to follow a few guidelines.
6+
7+
8+
## Requirements
9+
10+
There are a few architectural requirements that must be followed by contributed changes.
11+
12+
- Target-specific code is not allowed in common source files. Specifically, this means that you
13+
may not introduce `#ifdefs` for the target or HIC into common code.
14+
- If you need to implement a target-specific feature that would require changes to common code, you
15+
must first add a hook mechanism to the common code that allows your target-specific feature to
16+
be implemented outside the common code (in a family or board source file).
17+
- DAPLink makes extensive use of weak function and variable definitions as hooks to allow
18+
target-specific builds to change behaviour. This is the preferred hook mechanism.
19+
- Another option is to use a macro defined in the board yaml to override a default. In such a
20+
design, there must be a reasonable default if the macro is not set.
21+
22+
23+
## Coding style
24+
25+
Contributed source code must match the existing style of the DAPLink code base.
26+
27+
The key requirements are:
28+
- 4 space indents, no tabs are allowed.
29+
- No trailing whitespace.
30+
- All source files must end with a newline (an empty line at the end).
31+
- Lines should generally not be longer than 120 characters, though this is not a hard rule.
32+
- Braces generally follow the K&R style.
33+
- Single-statement blocks for **if**, **else**, **do**, **while**, and **for** statements must be
34+
enclosed in braces.
35+
- Spaces are required between keywords and parentheses, and around operators.
36+
- All functions require prototypes.
37+
- Macros must be all uppercase.
38+
- Functions should be all lowercase with underscores between words (sometimes called snake case).
39+
- Types must be all lowercase, underscores between words, and have a `_t` suffix.
40+
- Enumerations must start with `k` and use camel case, e.g. `kHardwareReset`.
41+
- Code must be well commented and use Doxygen-style documentation comments for all declarations.
42+
43+
For other style questions, please look to the existing code for answers.
44+
45+
46+
## License
47+
48+
By creating a pull request on GitHub, you are granting license your contributions under the same
49+
Apache 2.0 license as the original code. However, you still own the copyright to your contributions.
50+
You may add your copyright below the Arm copyright in the license header at the top of the source
51+
file. If a file is newly added by you, it must contain the standard license header, but it does not
52+
require an Arm copyright. Please note that we do not list changes in each source file by copyright
53+
owner, as this becomes a burden to maintain.
54+
55+
56+
## Process
57+
58+
Please create a pull request in GitHub with your contribution. Before creating the pull request,
59+
please ensure that your code meets the requirements listed above and all tests pass. We also run the
60+
tests on a wide range of boards for every pull request using our CI setup. Changes must pass on all
61+
tested boards before the the pull request can be merged.
62+
63+
The [developers' guide](docs/DEVELOPERS-GUIDE.md) describes how to create your development
64+
environment. The [automated tests guide](docs/AUTOMATED_TESTS.md) provides information about the
65+
available types of tests and describes how to run the tests.
66+
67+
68+
## More
69+
70+
For more information about contributing, see the Mbed OS [contributor
71+
documentation](http://os.mbed.com/contributing). Although this documentation is written primarily
72+
with Mbed OS in mind, much of it applies directly to DAPLink, as well.

‎LICENSE‎

Lines changed: 167 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,167 @@
1-
Unless specifically indicated otherwise in a file, files are licensed
2-
under the Apache 2.0 license, as can be found in: apache-2.0.txt
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction, and
10+
distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by the copyright
13+
owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all other entities
16+
that control, are controlled by, or are under common control with that entity.
17+
For the purposes of this definition, "control" means (i) the power, direct or
18+
indirect, to cause the direction or management of such entity, whether by
19+
contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
20+
outstanding shares, or (iii) beneficial ownership of such entity.
21+
22+
"You" (or "Your") shall mean an individual or Legal Entity exercising
23+
permissions granted by this License.
24+
25+
"Source" form shall mean the preferred form for making modifications, including
26+
but not limited to software source code, documentation source, and configuration
27+
files.
28+
29+
"Object" form shall mean any form resulting from mechanical transformation or
30+
translation of a Source form, including but not limited to compiled object code,
31+
generated documentation, and conversions to other media types.
32+
33+
"Work" shall mean the work of authorship, whether in Source or Object form, made
34+
available under the License, as indicated by a copyright notice that is included
35+
in or attached to the work (an example is provided in the Appendix below).
36+
37+
"Derivative Works" shall mean any work, whether in Source or Object form, that
38+
is based on (or derived from) the Work and for which the editorial revisions,
39+
annotations, elaborations, or other modifications represent, as a whole, an
40+
original work of authorship. For the purposes of this License, Derivative Works
41+
shall not include works that remain separable from, or merely link (or bind by
42+
name) to the interfaces of, the Work and Derivative Works thereof.
43+
44+
"Contribution" shall mean any work of authorship, including the original version
45+
of the Work and any modifications or additions to that Work or Derivative Works
46+
thereof, that is intentionally submitted to Licensor for inclusion in the Work
47+
by the copyright owner or by an individual or Legal Entity authorized to submit
48+
on behalf of the copyright owner. For the purposes of this definition,
49+
"submitted" means any form of electronic, verbal, or written communication sent
50+
to the Licensor or its representatives, including but not limited to
51+
communication on electronic mailing lists, source code control systems, and
52+
issue tracking systems that are managed by, or on behalf of, the Licensor for
53+
the purpose of discussing and improving the Work, but excluding communication
54+
that is conspicuously marked or otherwise designated in writing by the copyright
55+
owner as "Not a Contribution."
56+
57+
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
58+
of whom a Contribution has been received by Licensor and subsequently
59+
incorporated within the Work.
60+
61+
2. Grant of Copyright License.
62+
63+
Subject to the terms and conditions of this License, each Contributor hereby
64+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
65+
irrevocable copyright license to reproduce, prepare Derivative Works of,
66+
publicly display, publicly perform, sublicense, and distribute the Work and such
67+
Derivative Works in Source or Object form.
68+
69+
3. Grant of Patent License.
70+
71+
Subject to the terms and conditions of this License, each Contributor hereby
72+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
73+
irrevocable (except as stated in this section) patent license to make, have
74+
made, use, offer to sell, sell, import, and otherwise transfer the Work, where
75+
such license applies only to those patent claims licensable by such Contributor
76+
that are necessarily infringed by their Contribution(s) alone or by combination
77+
of their Contribution(s) with the Work to which such Contribution(s) was
78+
submitted. If You institute patent litigation against any entity (including a
79+
cross-claim or counterclaim in a lawsuit) alleging that the Work or a
80+
Contribution incorporated within the Work constitutes direct or contributory
81+
patent infringement, then any patent licenses granted to You under this License
82+
for that Work shall terminate as of the date such litigation is filed.
83+
84+
4. Redistribution.
85+
86+
You may reproduce and distribute copies of the Work or Derivative Works thereof
87+
in any medium, with or without modifications, and in Source or Object form,
88+
provided that You meet the following conditions:
89+
90+
You must give any other recipients of the Work or Derivative Works a copy of
91+
this License; and
92+
You must cause any modified files to carry prominent notices stating that You
93+
changed the files; and
94+
You must retain, in the Source form of any Derivative Works that You distribute,
95+
all copyright, patent, trademark, and attribution notices from the Source form
96+
of the Work, excluding those notices that do not pertain to any part of the
97+
Derivative Works; and
98+
If the Work includes a "NOTICE" text file as part of its distribution, then any
99+
Derivative Works that You distribute must include a readable copy of the
100+
attribution notices contained within such NOTICE file, excluding those notices
101+
that do not pertain to any part of the Derivative Works, in at least one of the
102+
following places: within a NOTICE text file distributed as part of the
103+
Derivative Works; within the Source form or documentation, if provided along
104+
with the Derivative Works; or, within a display generated by the Derivative
105+
Works, if and wherever such third-party notices normally appear. The contents of
106+
the NOTICE file are for informational purposes only and do not modify the
107+
License. You may add Your own attribution notices within Derivative Works that
108+
You distribute, alongside or as an addendum to the NOTICE text from the Work,
109+
provided that such additional attribution notices cannot be construed as
110+
modifying the License.
111+
You may add Your own copyright statement to Your modifications and may provide
112+
additional or different license terms and conditions for use, reproduction, or
113+
distribution of Your modifications, or for any such Derivative Works as a whole,
114+
provided Your use, reproduction, and distribution of the Work otherwise complies
115+
with the conditions stated in this License.
116+
117+
5. Submission of Contributions.
118+
119+
Unless You explicitly state otherwise, any Contribution intentionally submitted
120+
for inclusion in the Work by You to the Licensor shall be under the terms and
121+
conditions of this License, without any additional terms or conditions.
122+
Notwithstanding the above, nothing herein shall supersede or modify the terms of
123+
any separate license agreement you may have executed with Licensor regarding
124+
such Contributions.
125+
126+
6. Trademarks.
127+
128+
This License does not grant permission to use the trade names, trademarks,
129+
service marks, or product names of the Licensor, except as required for
130+
reasonable and customary use in describing the origin of the Work and
131+
reproducing the content of the NOTICE file.
132+
133+
7. Disclaimer of Warranty.
134+
135+
Unless required by applicable law or agreed to in writing, Licensor provides the
136+
Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
137+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
138+
including, without limitation, any warranties or conditions of TITLE,
139+
NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
140+
solely responsible for determining the appropriateness of using or
141+
redistributing the Work and assume any risks associated with Your exercise of
142+
permissions under this License.
143+
144+
8. Limitation of Liability.
145+
146+
In no event and under no legal theory, whether in tort (including negligence),
147+
contract, or otherwise, unless required by applicable law (such as deliberate
148+
and grossly negligent acts) or agreed to in writing, shall any Contributor be
149+
liable to You for damages, including any direct, indirect, special, incidental,
150+
or consequential damages of any character arising as a result of this License or
151+
out of the use or inability to use the Work (including but not limited to
152+
damages for loss of goodwill, work stoppage, computer failure or malfunction, or
153+
any and all other commercial damages or losses), even if such Contributor has
154+
been advised of the possibility of such damages.
155+
156+
9. Accepting Warranty or Additional Liability.
157+
158+
While redistributing the Work or Derivative Works thereof, You may choose to
159+
offer, and charge a fee for, acceptance of support, warranty, indemnity, or
160+
other liability obligations and/or rights consistent with this License. However,
161+
in accepting such obligations, You may act only on Your own behalf and on Your
162+
sole responsibility, not on behalf of any other Contributor, and only if You
163+
agree to indemnify, defend, and hold each Contributor harmless for any liability
164+
incurred by, or claims asserted against, such Contributor by reason of your
165+
accepting any such warranty or additional liability.
166+
167+
END OF TERMS AND CONDITIONS

‎README.md‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,22 @@ There are many ARM microcontroller-based Hardware Interface Circuits (HICs) that
2020
There are many board builds (board = HIC + target combination) created from this repository. Quarterly releases will contain new features and bugfixes. Standalone bugfixes are released once reported, verified and fixed. Both quarterly and bugfix releases will result in the build number being incremented. Many development kits and products ship with DAPLink interface firmware or are capable of running DAPLink firmware. **[The current release builds and instructions for updating DAPLink interface firmware is hosted on the DAPLink release site.](https://armmbed.github.io/DAPLink/)** Release notes and previous release builds can be found under GitHub releases.
2121

2222
## Contribute
23-
Look for an interesting feature or defect [under issues](https://github.com/ARMmbed/DAPLink/issues) or start a new thread to engage with the developers and maintainers. You must sign the [contributor agreement](https://os.mbed.com/contributor_agreement/) before any contributions can be accepted.
23+
24+
We welcome contributions to DAPLink in any area. Look for an interesting feature or defect [under
25+
issues](https://github.com/ARMmbed/DAPLink/issues), or start a new thread to engage with the
26+
developers and maintainers.
27+
28+
Please see the [contribution guidelines](CONTRIBUTING.md) for detailed requirements for
29+
contributions.
30+
31+
To report bugs, please [create an issue](https://github.com/ARMmbed/DAPLink/issues/new) in the
32+
GitHub project.
2433

2534
## Develop
2635
Information for setting up a development environment, running the tests or creating a release build [can be found in the developers guide.](docs/DEVELOPERS-GUIDE.md)
36+
37+
## License
38+
DAPLink is licensed with the permissive Apache 2.0 license. See the [LICENSE](LICENSE) file for the
39+
full text of the license.
40+
41+
Copyright © 2006-2019 Arm Ltd

0 commit comments

Comments
 (0)