From 1cc0e6fbcaaf190a3a7193d4e1325b23345da429 Mon Sep 17 00:00:00 2001 From: Christophe Favergeon Date: Thu, 13 Jan 2022 14:27:12 +0100 Subject: [PATCH] CMSIS-DSP: Added some files to more easily generate a pack for SDF. --- SDFTools/LICENSE.txt | 201 ++++++++++++++++++++++++++++++++++++++++++ SDFTools/gen_pack.sh | 204 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 405 insertions(+) create mode 100755 SDFTools/LICENSE.txt create mode 100755 SDFTools/gen_pack.sh diff --git a/SDFTools/LICENSE.txt b/SDFTools/LICENSE.txt new file mode 100755 index 00000000..8dada3ed --- /dev/null +++ b/SDFTools/LICENSE.txt @@ -0,0 +1,201 @@ + 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: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) 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 + + (d) 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 + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/SDFTools/gen_pack.sh b/SDFTools/gen_pack.sh new file mode 100755 index 00000000..2e09c5bd --- /dev/null +++ b/SDFTools/gen_pack.sh @@ -0,0 +1,204 @@ +#!/bin/bash +# Version: 1.1 +# Date: 2020-04-29 +# This bash script generates a CMSIS Software Pack: +# +# Pre-requisites: +# - bash shell (for Windows: install git for Windows) +# - 7z in path (zip archiving utility) +# e.g. Ubuntu: sudo apt-get install p7zip-full p7zip-rar) +# - PackChk in path with execute permission +# (see CMSIS-Pack: CMSIS/Utilities//PackChk) +# - xmllint in path (XML schema validation) +# e.g. Ubuntu: sudo apt-get install libxml2-utils +# Windows: download from https://www.zlatkovic.com/pub/libxml/ + +############### EDIT BELOW ############### +# Extend Path environment variable locally +# +if [ `uname -s` = "Linux" ] + then + #CMSIS_PACK_PATH="/home/$USER/.arm/Packs/ARM/CMSIS/5.7.0/" + PATH_TO_ADD="$CMSIS_PACK_PATH/CMSIS/Utilities/Linux64/" +else + #CMSIS_PACK_PATH="$LOCALAPPDATA/Arm/Packs/ARM/CMSIS/5.7.0" + PATH_TO_ADD="/C/Program Files/7-Zip/:$CMSIS_PACK_PATH/CMSIS/Utilities/Win32/:/C/xmllint/" +fi +[[ ":$PATH:" != *":$PATH_TO_ADD}:"* ]] && PATH="${PATH}:${PATH_TO_ADD}" +echo $PATH_TO_ADD appended to PATH +echo " " + +# Pack warehouse directory - destination +PACK_WAREHOUSE=output/ + +# Temporary pack build directory +PACK_BUILD=build/ + +# Specify directories included in pack relative to base directory +# All directories: +PACK_DIRS="sdf/" +# Do not include the build directory if it is local +PACK_DIRS=${PACK_DIRS//$PACK_BUILD/} +PACK_DIRS=${PACK_DIRS//$PACK_WAREHOUSE/} + +# alternative: specify directory names to be added to pack base directory +# PACK_DIRS=" +# Source +# Include +#" + +# Specify file names to be added to pack base directory +PACK_BASE_FILES=" + License.txt + README.md +" + +############ DO NOT EDIT BELOW ########### +echo Starting CMSIS-Pack Generation: `date` +# Zip utility check +ZIP=7z +type -a $ZIP +errorlevel=$? +if [ $errorlevel -gt 0 ] + then + echo "Error: No 7zip Utility found" + echo "Action: Add 7zip to your path" + echo " " + exit +fi + +# Pack checking utility check +PACKCHK=PackChk +type -a $PACKCHK +errorlevel=$? +if [ $errorlevel != 0 ] + then + echo "Error: No PackChk Utility found" + echo "Action: Add PackChk to your path" + echo "Hint: Included in CMSIS Pack:" + echo "/ARM/CMSIS//CMSIS/Utilities//" + echo " " + exit +fi +echo " " + +# XML syntax checking utility check +XMLLINT=xmllint +type -a $XMLLINT +errorlevel=$? +if [ $errorlevel != 0 ] + then + echo "Error: No xmllint found" + echo "Action: Add xmllint to your path" + echo " " + exit +fi +echo " " + +# Locate Package Description file +# check whether there is more than one pdsc file +NUM_PDSCS=`ls -1 *.pdsc | wc -l` +PACK_DESCRIPTION_FILE=`ls *.pdsc` +if [ $NUM_PDSCS -lt 1 ] + then + echo "Error: No *.pdsc file found in current directory" + echo " " +elif [ $NUM_PDSCS -gt 1 ] + then + echo "Error: Only one PDSC file allowed in directory structure:" + echo "Found:" + echo "$PACK_DESCRIPTION_FILE" + echo "Action: Delete unused pdsc files" + echo " " + exit +fi + +SAVEIFS=$IFS +IFS=. +set $PACK_DESCRIPTION_FILE +# Pack Vendor +PACK_VENDOR=$1 +# Pack Name +PACK_NAME=$2 +echo Generating Pack Version: for $PACK_VENDOR.$PACK_NAME +echo " " +IFS=$SAVEIFS + +#if $PACK_BUILD directory does not exist, create it. +if [ ! -d $PACK_BUILD ]; then + mkdir -p $PACK_BUILD +fi + +# Copy files into build base directory: $PACK_BUILD +# pdsc file is mandatory in base directory: +cp -f ./$PACK_VENDOR.$PACK_NAME.pdsc ${PACK_BUILD} + +# directories +echo Adding directories to pack: +echo $PACK_DIRS +echo " " +for d in ${PACK_DIRS} +do + cp -r "$d" ${PACK_BUILD} +done + +# files for base directory +echo Adding files to pack: +echo $PACK_BASE_FILES +echo " " +for f in $PACK_BASE_FILES +do + cp -f "$f" $PACK_BUILD/ +done + +# Run Schema Check (for Linux only): +# sudo apt-get install libxml2-utils + +echo Running schema check for $PACK_VENDOR.$PACK_NAME.pdsc +$XMLLINT --noout --schema ${CMSIS_PACK_PATH}/CMSIS/Utilities/PACK.xsd $PACK_BUILD/$PACK_VENDOR.$PACK_NAME.pdsc +errorlevel=$? +if [ $errorlevel -ne 0 ]; then + echo "build aborted: Schema check of $PACK_VENDOR.$PACK_NAME.pdsc against PACK.xsd failed" + echo " " + exit +fi + +# Run Pack Check and generate PackName file with version +$PACKCHK $PACK_BUILD/$PACK_VENDOR.$PACK_NAME.pdsc -n PackName.txt -x M362 +errorlevel=$? +if [ $errorlevel -ne 0 ]; then + echo "build aborted: pack check failed" + echo " " + exit +fi + +PACKNAME=`cat PackName.txt` +rm -rf PackName.txt + +# Archiving +# $ZIP a $PACKNAME +echo creating pack file $PACKNAME +#if $PACK_WAREHOUSE directory does not exist create it +if [ ! -d $PACK_WAREHOUSE ]; then + mkdir -p $PACK_WAREHOUSE +fi +pushd $PACK_WAREHOUSE +PACK_WAREHOUSE=`pwd` +popd +pushd $PACK_BUILD +"$ZIP" a $PACK_WAREHOUSE/$PACKNAME -tzip +popd +errorlevel=$? +if [ $errorlevel -ne 0 ]; then + echo "build aborted: archiving failed" + exit +fi + +echo "build of pack succeeded" +# Clean up +echo "cleaning up ..." + +rm -rf $PACK_BUILD +echo " " + +echo Completed CMSIS-Pack Generation: `date`