Merge pull request #919 from Jake-Carter/release

chore(Other): Stage Feb 2024 Release

.github/labeler.yml

@@ -5,40 +5,26 @@
 #   for the workflow to apply the correct labels for each PR.
 #
 
-################################################################################
- # Copyright (C) 2023 Maxim Integrated Products, Inc., All Rights Reserved.
- # 
- # This software is protected by copyright laws of the United States and
- # of foreign countries. This material may also be protected by patent laws
- # and technology transfer regulations of the United States and of foreign
- # countries. This software is furnished under a license agreement and/or a
- # nondisclosure agreement and may only be used or reproduced in accordance
- # with the terms of those agreements. Dissemination of this information to
- # any party or parties not specified in the license agreement and/or
- # nondisclosure agreement is expressly prohibited.
+###############################################################################
  #
- # The above copyright notice and this permission notice shall be included
- # in all copies or substantial portions of the Software.
+ # Copyright (C) 2022-2023 Maxim Integrated Products, Inc. All Rights Reserved.
+ # (now owned by Analog Devices, Inc.),
+ # Copyright (C) 2023-2024 Analog Devices, Inc. All Rights Reserved. This software
+ # is proprietary to Analog Devices, Inc. and its licensors.
  #
- # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
- # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
- # IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
- # OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
- # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
- # OTHER DEALINGS IN THE SOFTWARE.
+ # 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
  #
- # Except as contained in this notice, the name of Maxim Integrated
- # Products, Inc. shall not be used except as stated in the Maxim Integrated
- # Products, Inc. Branding Policy.
+ #     http://www.apache.org/licenses/LICENSE-2.0
  #
- # The mere transfer of this software does not imply any licenses
- # of trade secrets, proprietary technology, copyrights, patents,
- # trademarks, maskwork rights, or any other form of intellectual
- # property whatsoever. Maxim Integrated Products, Inc. retains all
- # ownership rights.
+ # 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.
  #
- ###############################################################################
+ ##############################################################################
 
 'BLE':
 - '**/Examples/**/BLE*/**/*'
@@ -64,6 +50,13 @@
 - '**/Libraries/PeriphDrivers/max32570_files.mk'
 - '**/Libraries/PeriphDrivers/Include/MAX32570/**/*'
 
+'MAX32572':
+- '**/*me55*.*'
+- '**/Libraries/Boards/MAX32572/**/*'
+- '**/Libraries/CMSIS/Device/Maxim/MAX32572/**/*'
+- '**/Libraries/PeriphDrivers/max32572_files.mk'
+- '**/Libraries/PeriphDrivers/Include/MAX32572/**/*'
+
 'MAX32650':
 - '**/Examples/MAX32650/**/*'
 - '**/*me10*.*'

.github/workflows/Build_Examples.yml

@@ -23,6 +23,10 @@ jobs:
     runs-on:
       - ubuntu-latest
 
+    env:
+      SOURCE_BRANCH: ${{github.ref_name}}
+      TARGET_BRANCH: ${{github.event.pull_request.base.ref}}
+
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v3
@@ -34,8 +38,10 @@ jobs:
           repository: '${{ github.event.pull_request.head.repo.full_name }}'
 
       - name: Check watch files
-        id: check_watch 
+        id: check_watch        
         run: |
+          echo SOURCE_BRANCH = $SOURCE_BRANCH
+          echo TARGET_BRANCH = $TARGET_BRANCH
           # Determine if we need to run the test
           RUN_TEST=0
 
@@ -44,6 +50,11 @@ jobs:
             RUN_TEST=1
           fi
 
+          if [[ $SOURCE_BRANCH == "main" ]]; then
+            echo "Pushed to main, running test"
+            RUN_TEST=1
+          fi
+
           # Check for changes made to these files
           WATCH_FILES="\
             Build_Examples.yml \
@@ -57,8 +68,16 @@ jobs:
             makefile \
             Makefile"
 
-          # Get the diff from main
-          CHANGE_FILES=$(git diff --ignore-submodules --name-only remotes/origin/main)
+          if [[ -n $TARGET_BRANCH ]]; then
+            # We are in a PR.  Need to check changes against the target branch.
+            echo "Comparing PR against target branch: $TARGET_BRANCH"
+            echo "Adding remote '$GITHUB_SERVER_URL/$GITHUB_REPOSITORY' as 'upstream'"
+            git remote add upstream $GITHUB_SERVER_URL/$GITHUB_REPOSITORY
+            echo "Fetching $TARGET_BRANCH"
+            git fetch upstream $TARGET_BRANCH
+            echo "diffing files"
+            CHANGE_FILES=$(git diff --ignore-submodules --name-only remotes/upstream/$TARGET_BRANCH)
+          fi
 
           echo "Watching these locations and files"
           echo $WATCH_FILES
@@ -226,8 +245,10 @@ jobs:
           fi
 
       - name: Check watch files
-        id: check_watch 
+        id: check_watch        
         run: |
+          echo SOURCE_BRANCH = $SOURCE_BRANCH
+          echo TARGET_BRANCH = $TARGET_BRANCH
           # Determine if we need to run the test
           RUN_TEST=0
 
@@ -236,6 +257,11 @@ jobs:
             RUN_TEST=1
           fi
 
+          if [[ $SOURCE_BRANCH == "main" ]]; then
+            echo "Pushed to main, running test"
+            RUN_TEST=1
+          fi
+
           # Check for changes made to these files
           WATCH_FILES="\
             Build_Examples.yml \
@@ -249,8 +275,16 @@ jobs:
             makefile \
             Makefile"
 
-          # Get the diff from main
-          CHANGE_FILES=$(git diff --ignore-submodules --name-only remotes/origin/main)
+          if [[ -n $TARGET_BRANCH ]]; then
+            # We are in a PR.  Need to check changes against the target branch.
+            echo "Comparing PR against target branch: $TARGET_BRANCH"
+            echo "Adding remote '$GITHUB_SERVER_URL/$GITHUB_REPOSITORY' as 'upstream'"
+            git remote add upstream $GITHUB_SERVER_URL/$GITHUB_REPOSITORY
+            echo "Fetching $TARGET_BRANCH"
+            git fetch upstream $TARGET_BRANCH
+            echo "diffing files"
+            CHANGE_FILES=$(git diff --ignore-submodules --name-only remotes/upstream/$TARGET_BRANCH)
+          fi
 
           echo "Watching these locations and files"
           echo $WATCH_FILES

.github/workflows/Generate_Register_Files.yml

@@ -77,7 +77,7 @@ jobs:
             git pull
             cd ..
           else
-            git clone [email protected]:Analog-Devices-MSDK/msdk-internal.git
+            git clone --depth 1 [email protected]:Analog-Devices-MSDK/msdk-internal.git
           fi
 
       - name: Generating register files.

.github/workflows/Verify_Register_SVD.yml

@@ -82,7 +82,7 @@ jobs:
             pwd
           else
             pwd
-            git clone [email protected]:Analog-Devices-MSDK/msdk-internal.git
+            git clone --depth 1 [email protected]:Analog-Devices-MSDK/msdk-internal.git
             ls
           fi
           

.github/workflows/scripts/plot_per_results.py

@@ -1,37 +1,25 @@
 #! /usr/bin/env python3
 
-################################################################################
-# Copyright (C) 2020 Maxim Integrated Products, Inc., All Rights Reserved.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a
-# copy of this software and associated documentation files (the "Software"),
-# to deal in the Software without restriction, including without limitation
-# the rights to use, copy, modify, merge, publish, distribute, sublicense,
-# and/or sell copies of the Software, and to permit persons to whom the
-# Software is furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included
-# in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
-# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-# IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
-# OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
-# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-# OTHER DEALINGS IN THE SOFTWARE.
-#
-# Except as contained in this notice, the name of Maxim Integrated
-# Products, Inc. shall not be used except as stated in the Maxim Integrated
-# Products, Inc. Branding Policy.
-#
-# The mere transfer of this software does not imply any licenses
-# of trade secrets, proprietary technology, copyrights, patents,
-# trademarks, maskwork rights, or any other form of intellectual
-# property whatsoever. Maxim Integrated Products, Inc. retains all
-# ownership rights.
-#
 ###############################################################################
+ #
+ # Copyright (C) 2022-2023 Maxim Integrated Products, Inc. All Rights Reserved.
+ # (now owned by Analog Devices, Inc.),
+ # Copyright (C) 2023 Analog Devices, Inc. All Rights Reserved. This software
+ # is proprietary to Analog Devices, Inc. and its licensors.
+ #
+ # 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.
+ #
+ ##############################################################################
 
 # plot_per_results.py
 #

.github/workflows/scripts/test_launcher.sh

@@ -596,7 +596,7 @@ change_advertising_names
 # Temporary fix until RF Closed is merged into RF Phy
 # Build a specific RF-PHY-closed branch
 cd $MSDK_DIR/Libraries
-git clone [email protected]:Analog-Devices-MSDK/RF-PHY-closed.git
+git clone --depth 1 [email protected]:Analog-Devices-MSDK/RF-PHY-closed.git
 cd $MSDK_DIR/Libraries/RF-PHY-closed
 git checkout ME17B1-new
 cd MAX32655/build/gcc

Documentation/build.py

@@ -131,7 +131,7 @@ class CommonExampleInfo(ExampleInfo):
     print(f.name)
     if (f.name != "README.md"): shutil.copy(f, here) # Workaround for https://github.com/mkdocs/mkdocs/issues/3313
 
-(here / "Libraries" / "CLI").mkdir(exist_ok=True)
+(here / "Libraries" / "CLI").mkdir(exist_ok=True, parents=True)
 shutil.copy(Path("Libraries") / "CLI" / "README.md", here / "Libraries" / "CLI" / "README.md") # TODO: Less hard-coded way of pulling these in
 
 # String replace "##__EXAMPLES_LIST__##" with autogenerated tables

Documentation/css/extra.css

@@ -20,4 +20,50 @@ img {
 .rst-content pre code {
     border-color: black;
     border-radius: 8px;
+}
+
+.rst-content h1, .rst-content h2, .rst-content h3, .rst-content h4 {
+    margin-bottom:0px;
+    margin-top:0px;
+}
+
+h1::after {
+    display: inline-block;
+    content: "";
+    border-top: .2rem solid;
+    border-radius: 1rem;
+    flex-grow: 1; /* This property makes the pseudo-element take up the remaining space */
+    width: 100%; /* Set the width to 100% */
+    transform: translateY(-0.5rem);
+}
+
+h2::after {
+    display: inline-block;
+    content: "";
+    border-top: .1rem solid lightgray;
+    border-radius: 1rem;
+    flex-grow: 1; /* This property makes the pseudo-element take up the remaining space */
+    width: 100%; /* Set the width to 100% */
+    transform: translateY(-0.5rem);
+}
+
+h3::after
+{
+    display: inline-block;
+    content: "";
+    border-top: .1rem solid lightgray; /* Change this line to adjust the style */
+    flex-grow: 1;
+    width: 100%;
+    transform: translateY(-0.5rem);
+}
+
+h4::after
+{
+    font-style: italic;
+    display: inline-block;
+    content: "";
+    border-top: .1rem solid lightgray; /* Change this line to adjust the style */
+    flex-grow: 1;
+    width: 100%;
+    transform: translateY(-0.5rem);
 }

Examples/MAX32520/AES/.vscode/flash.gdb

@@ -1,5 +1,6 @@
 define flash_m4
     set architecture armv7e-m
+    set remotetimeout 10
     target remote | openocd -c "gdb_port pipe;log_output flash.log" -s $arg0/scripts -f interface/$arg1 -f target/$arg2 -c "init; reset halt"
     load
     compare-sections
@@ -8,8 +9,9 @@ end
 
 define flash_m4_run
     set architecture armv7e-m
+    set remotetimeout 10
     target remote | openocd -c "gdb_port pipe;log_output flash.log" -s $arg0/scripts -f interface/$arg1 -f target/$arg2 -c "init; reset halt"
     load
     compare-sections
     monitor resume
-end
+end

Examples/MAX32520/AES/.vscode/settings.json

@@ -4,13 +4,13 @@
         "MAXIM_PATH":"${config:MAXIM_PATH}"
     },
     "terminal.integrated.defaultProfile.windows": "Command Prompt",
-    
+
     "terminal.integrated.env.linux": {
-        "PATH":"${config:OCD_path}:${config:ARM_GCC_path}/bin:${config:xPack_GCC_path}/bin:${env:PATH}",
+        "PATH":"${config:OCD_path}:${config:ARM_GCC_path}/bin:${config:xPack_GCC_path}/bin:${config:Make_path}:${env:PATH}",
         "MAXIM_PATH":"${config:MAXIM_PATH}"
     },
     "terminal.integrated.env.osx": {
-        "PATH":"${config:OCD_path}/bin:${config:ARM_GCC_path}/bin:${config:xPack_GCC_path}/bin:${env:PATH}",
+        "PATH":"${config:OCD_path}/bin:${config:ARM_GCC_path}/bin:${config:xPack_GCC_path}/bin:${config:Make_path}:{env:PATH}",
         "MAXIM_PATH":"${config:MAXIM_PATH}"
     },
 

Examples/MAX32520/AES/Makefile

@@ -1,35 +1,23 @@
-################################################################################
- # Copyright (C) 2023 Maxim Integrated Products, Inc., All Rights Reserved.
- #
- # Permission is hereby granted, free of charge, to any person obtaining a
- # copy of this software and associated documentation files (the "Software"),
- # to deal in the Software without restriction, including without limitation
- # the rights to use, copy, modify, merge, publish, distribute, sublicense,
- # and/or sell copies of the Software, and to permit persons to whom the
- # Software is furnished to do so, subject to the following conditions:
+###############################################################################
  #
- # The above copyright notice and this permission notice shall be included
- # in all copies or substantial portions of the Software.
+ # Copyright (C) 2022-2023 Maxim Integrated Products, Inc. All Rights Reserved.
+ # (now owned by Analog Devices, Inc.),
+ # Copyright (C) 2023 Analog Devices, Inc. All Rights Reserved. This software
+ # is proprietary to Analog Devices, Inc. and its licensors.
  #
- # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
- # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
- # IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
- # OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
- # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
- # OTHER DEALINGS IN THE SOFTWARE.
+ # 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
  #
- # Except as contained in this notice, the name of Maxim Integrated
- # Products, Inc. shall not be used except as stated in the Maxim Integrated
- # Products, Inc. Branding Policy.
+ #     http://www.apache.org/licenses/LICENSE-2.0
  #
- # The mere transfer of this software does not imply any licenses
- # of trade secrets, proprietary technology, copyrights, patents,
- # trademarks, maskwork rights, or any other form of intellectual
- # property whatsoever. Maxim Integrated Products, Inc. retains all
- # ownership rights.
+ # 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.
  #
-###############################################################################
+ ##############################################################################
 
 # ** Readme! **
 # Don't edit this file! This is the core Makefile for a MaximSDK