Merge pull request #7 from ARMmbed/master

merge from master

.editorconfig

@@ -0,0 +1,10 @@
+# top-most EditorConfig file
+root = true
+
+# Common file settings.
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true

CONTRIBUTING.md

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

LICENSE

@@ -1,2 +1,167 @@
-Unless specifically indicated otherwise in a file, files are licensed
-under the Apache 2.0 license, as can be found in: apache-2.0.txt
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

README.md

@@ -20,7 +20,22 @@ There are many ARM microcontroller-based Hardware Interface Circuits (HICs) that
 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.
 
 ## Contribute
-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.
+
+We welcome contributions to DAPLink in any area. 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.
+
+Please see the [contribution guidelines](CONTRIBUTING.md) for detailed requirements for
+contributions.
+
+To report bugs, please [create an issue](https://github.com/ARMmbed/DAPLink/issues/new) in the
+GitHub project.
 
 ## Develop
 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)
+
+## License
+DAPLink is licensed with the permissive Apache 2.0 license. See the [LICENSE](LICENSE) file for the
+full text of the license.
+
+Copyright © 2006-2019 Arm Ltd