Merge pull request #7 in MCU16CE/dspic33ck-power-pwm-phase-shift from…

… develop to master * commit '7305e2fd652c70a5c5764f46de07533976c00b9b': (26 commits) use XC16 v1.5 building the code change the compiler version from 1.6 to 1.5, rename the driver folder to common, update main.c code descriptopm Updated changes in data structure declarations in SFR abstraction driver into PWM object handlers in main() Incorporated change in data structure declarations in SFR abstraction driver into PWM initialization example Changed PWM configuration code example enumeration once more. Now Code example enumerations are called 'Lab 1', 'Lab 2'. 'Lab 3', etc. REplaced PWM SFR abstraction driver with latest version. major change was simplification of data structure to make the driver compliant with other SFR abstraction drivers and make usage more intuitive Fixed software version labels to start with MPLABX(R) Changed roman enumeration of code example to arabic numbers try another readme edit try another readme edit edit readme.md file another edit for README.md fie edited changelog.md and README.md file moved the device_setup.mc3 file to MPLABX root folder deleted changelog.txt file use main.jason based on MCU16CE project change ma330048_R30_pinmap.h to ma330048_r30_pinmap.h in hal.h file update the .citd with the original file from MCU16 CE update configuration.xml, and project xml ovewrite the previous Jenkinsfilek8s ...
microchip-pic-avr-examples · Oct 30, 2020 · 35df845 · 35df845
2 parents 8863fb7 + 7305e2f
commit 35df845
Show file tree

Hide file tree

Showing 45 changed files with 27,243 additions and 26 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,45 @@
+# .gitignore file
+#
+# Set up for Microchip/MPLAB X development
+# 
+# Default gitignore files for code examples, only removing/ignoring usual MPLAB X clutter
+
+# Object files
+*.o
+*.ko
+*.obj
+*.elf
+
+# Executables
+*.exe
+
+# Netbeans specific
+~*.*
+nbproject/build/
+nbproject/dist/
+nbproject/private/
+nbproject/disassembly/
+build/
+dist/
+private/
+disassembly/
+*.zip
+*.mk
+*.bash
+Makefile-genesis.properties
+
+# MPLAB X Trace specific
+*.log
+*.inx
+
+# KDE specific
+.directory
+
+# Misc
+.svn
+*.bak
+*.doc
+*.docx
+
+
+
diff --git a/.main-meta/main.json b/.main-meta/main.json
@@ -4,10 +4,10 @@
    "content":{
       "metaDataVersion":"1.0.0",
       "name":"com.microchip.mplabx.project.dspic33ck-power-pwm-phase-shift",
-      "version":"x.x.x",
-      "displayName":"xxxxxxxxxxxxxxx",
+      "version":"1.0.0",
+      "displayName":"dsPIC33CK/CH-MP PWM Configuration: Phase Shifted PWM Output",
       "projectName":"dspic33ck-power-pwm-phase-shift",
-      "shortDescription":"xxxxxxxxxxxxxxx",
+      "shortDescription":"Phase Shifted PWM Output Configuration Example for dsPIC33CK-MP devices",
       "ide":{
          "name":"MPLABX",
          "semverRange":">=5.40.0"
@@ -17,8 +17,8 @@
          "semverRange":"^1.50.0"
       },
       "dfp":{
-         "name":"xxxxxxxxxxxxxxx",
-         "semverRange":">=x.x.x"
+         "name":"dsPIC33CK-MP_DFP",
+         "semverRange":"^1.4.102"
       },
 	  "configurator": {
          "name": "MCC",
@@ -30,17 +30,22 @@
          "content":{
             "metaDataVersion":"1.0.0",
             "category":"com.microchip.device",
-            "name":"xxxxxxxxxxxxxxx",
+            "name":"dsPIC33CK",
             "versionRange":"*"
          }
       },
       "peripherals":[
          "GPIO",
-         "UART"
+		 "PWM",
+         "Timer"
       ],
       "keywords":[
-         "GPIO",
-         "UART"
+         "dsc",
+         "dspic",
+		 "power",
+		 "power-conversion",
+		 "power-supply",
+		 "smps"
       ]
    }
 }
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,9 +1,25 @@
-© [2020] Microchip Technology Inc. and its subsidiaries
-
-Subject to your compliance with these terms, you may use this Microchip software and any derivatives exclusively with Microchip products. You are responsible 
-for complying with third party license terms applicable to your use of third party software (including open source software) that may accompany this Microchip 
-software. SOFTWARE IS “AS IS.” NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT, 
-MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, INCIDENTAL OR CONSEQUENTIAL LOSS, 
-DAMAGE, COST OR EXPENSE OF ANY KIND WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE 
-FORESEEABLE. TO THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP’S TOTAL LIABILITY ON ALL CLAIMS RELATED TO THE SOFTWARE WILL NOT EXCEED AMOUNT OF FEES, IF ANY, YOU 
-PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
+(c) 2020 Microchip Technology Inc. and its subsidiaries. You may use this 
+software and any derivatives exclusively with Microchip products.
+
+
+THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
+EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED
+WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A
+PARTICULAR PURPOSE, OR ITS INTERACTION WITH MICROCHIP PRODUCTS, COMBINATION
+WITH ANY OTHER PRODUCTS, OR USE IN ANY APPLICATION.
+
+
+
+IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
+INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
+WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS
+BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE
+FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN
+ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
+THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
+
+
+
+MICROCHIP PROVIDES THIS SOFTWARE CONDITIONALLY UPON YOUR ACCEPTANCE OF THESE
+TERMS.
+
diff --git a/README.md b/README.md
@@ -1,25 +1,100 @@
-![image](images/microchip.jpg) 
+<div id="readme" class="Box-body readme blob js-code-block-container">
+ <article class="markdown-body entry-content p-3 p-md-6" itemprop="This needs to be locked down and 'never' changed">
+ <p><a target="_blank" href="https://www.microchip.com" rel="nofollow"><img src="images/microchip.png" alt="MCHP" width="200";"></a></p>
 
-## DSPIC33CK POWER PWM PHASE SHIFT
+# dsPIC33C High-Resolution PWM Configuration: Lab 4
+**Phase-Shifted PWM Waveform Generation**
 
-Board Image if any.
+<p><center><a href="https://www.microchip.com/MA330048" rel="nofollow">
+<img src="images/ma330048.jpg" alt="dsPIC33CK Digital Power Plug-In Module" width="300"></a></center></p>
+
+- - -
 
 ## Summary
+Learning how to use the High Resolution PWM Module of dsPIC33C MP devices, Lab 4:
+Code example for dsPIC33CK and dsPIC33CH devices showing a basic configuration of the high-resolution PWM module using two PWM generator channels generating a Phase-Shifted PWM waveforms
 
+- - -
 
 ## Related Documentation
+- [dsPIC33CK256MP508 Family Data Sheet](https://ww1.microchip.com/downloads/en/DeviceDoc/dsPIC33CK256MP508-Family-Data-Sheet-DS70005349G.pdf)
+- [dsPIC33CK256MP508 Family Silicon Errata and Data Sheet Clarification](https://ww1.microchip.com/downloads/en/DeviceDoc/dsPIC33CK256MP508-Family-Silicon-Errata-and-Data-Sheet-Clarification-DS80000796G.pdf)
+- [dsPIC33CH512MP508 Family Data Sheet](http://ww1.microchip.com/downloads/en/DeviceDoc/dsPIC33CH512MP508-Family-Data-Sheet-DS70005371D.pdf)
+- [dsPIC33CH512MP508 Family Silicon Errata and Data Sheet Clarification](http://ww1.microchip.com/downloads/en/DeviceDoc/dsPIC33CH512MP508-Family-Silicon-Errata-and-Data-Sheet-Clarification-DS80000805F.pdf)
 
+**Please always check for the latest data sheets on the respective product websites:**
+- [dsPIC33CK256MP508 Family](https://www.microchip.com/dsPIC33CK256MP508)
+- [dsPIC33CH512MP508 Family](https://www.microchip.com/dsPIC33CH512MP508)
 
 ## Software Used 
-
+- [MPLAB® X IDE v5.40](https://www.microchip.com/mplabx-ide-windows-installer)
+- [MPLAB® XC16 Compiler v1.50](https://www.microchip.com/mplabxc16windows)
+- [MPLAB® Code Configurator v4.01](https://www.microchip.com/mplab/mplab-code-configurator)
 
 ## Hardware Used
+- Digital Power Development Board, Part-No. [DM330029](https://www.microchip.com/DM330029)
+- dsPIC33CK Digital Power Plug-In Module (DP PIM), Part-No. [MA330048](https://www.microchip.com/MA330048)
+- Alternatively: dsPIC33CH Digital Power Plug-In Module (DP PIM), Part-No. [MA330049](https://www.microchip.com/MA330049)
+
+## Supported Target Devices
+- [dsPIC33CK256MP506](https://www.microchip.com/dsPIC33CK256MP506)
+- [dsPIC33CH512MP506](https://www.microchip.com/dsPIC33CH512MP506)
+- Code compatible with all Single and Dual Core dsPIC33C MP families of devices
 
+- - -
 
 ## Setup
+- Plug-In the dsPIC33CK or dsPIC33CH Digital Power Plug In Module into the Digital Power Development Board PIM socket J1
+- Open and compile the firmware and program the DSC
 
+<br><center><img src="images/dm330029.jpg" width="400"></center><br>
 
 ## Operation
+After the device has been programmed and the MCU starts up, a 90 degrees phase shift between the two synchronized PWM Generators is generated see below screen capture. Both PWM Generator #1 and #3 are configured in complementary mode with 200 kHz frequency and 50% duty cycle waveform outputs.  PWM Generator 1 output is available at PWM1H/L pins while PWM Generator 3 output is available at PWM3H/L pins. 
+
+<br><center><img src="images/pwm90phaseshift.png" width="400"></center><br>
+<br><center>*CH1(blue):PWM1H  CH2(green):PWM1L  CH3(red):PWM3H  CH4(purple):PWM3L*</center><br>
+
+By pressing the on-board push button *USER* on the Digital Power Development Board, the phase shift  is toggled between the initial 90 degrees and 180 degrees see below screen capture.
+
+<br><center><img src="images/pwm180phaseshift.png" width="400"></center><br>
+<br><center>*CH1(blue):PWM1H  CH2(green):PWM1L  CH3(red):PWM3H  CH4(purple):PWM3L*</center><br>
+
+
+Please refer to section *FIRMWARE QUICK-START GUIDE* below for more information on the initialization process and code structure.
+
+<br><center><img src="images/dm330029-pinmap.png" width="600"></center><br>
+
+- - -
+
+## FIRMWARE QUICK-START GUIDE
+
+This code example builds on previous code examples showing how to use Microchip Code Configurator (MCC) to set up device clock domains. 
+Although MCC also supports configuration tools for the High Resolution PWM module, PWM configuration in this example builds on generic peripheral drivers to help users better understand the peripheral architecture and key aspects of specific configurations and operating modes. 
+In each PWM example code project the PWM configuration procedure is located in the user file pwm.c, where each register bit required to achieve/enable the specific function or mode of interest is set and its function described with comments.
+Once users are familiar with the architecture, features and capabilities, both configuration options (generic peripheral library or MCC) may be used.
+
+#### a) Project Directory Structure <br/>
+The project contains four sub-directories
+1. config: location of all hardware abstraction header files
+2. common: location of generic peripheral drivers 
+3. MCC Generated Files: all device configuration files auto-generated by MCC
+4. root: application user code
+
+On the hard drive, main.c/h are located in the MPLAB X project directory. 
+All other user files, incl. peripheral drivers, are located in the sub-directory *sources*. 
+Files generated by MCC are always located in their own sub-directory *mcc_generated-files* 
+
+#### b) Using the generic PWM peripheral driver <br/>  
+The PWM peripheral driver files p33c_pwm.c/h provide data structures representing the Special Function Register (SFR) sets of PWM generators and the PWM base module. These 'virtual' PWM objects are used to load, read and modify PWM generator configurations without the need for hard-coded instructions, which would make the code hard to migrate from one peripheral to another or even across devices.To simplify PWM configurations, in these examples, each register is reset to a known default state before the user configuration of interest is set. Thus, only the register setting which really matters for a certain features/function are shown.
+
+To learn more about the generic PWM driver, its supported features and intended use cases, please read the comments inside p33c_pwm.c.
+
+#### c) Executing the Code Example <br/> 
+This code has been written to automatically start up and perform the function of interest. Please read the demo instructions on top of file main.c to learn more about the code example, test points, expected signals and demo mode operation.
+
 
 
+- - - 
 
+© 2020, Microchip Technology Inc.
diff --git a/changelog.md b/changelog.md
@@ -1,9 +1,11 @@
-# Project Name or repo name release version
-### Release Highlights
-
+# dspic33ck-power-pwm-phase-shift, release v1.0.0
 
+### Release Highlights
+This is the initial release demonstrating the basic configuration of a high-resolution PWM generator of the dsPIC33C family of devices.
+This example is part of a series of code examples highlighting specific operating modes and features.
 
 ### Features Added\Updated
-
+In this intial version the on-board LED of the dsPIC33CK Digital Power Plug-In Module is toggled with a interval üperiod of 300 ms, when the controller is running at maximum speed of 100 MIPS.
+After startup, 90 degrees phase shift will be generated between pwm generator #1 and pwm generator #3. By pressing the on-board push button *USER* on the Digital Power Develpoment Board, the phase shift is toggled between the initial 90 degrees and 180 degrees.
 
 
diff --git a/dspic33ck-power-pwm-phase-shift.X/Makefile b/dspic33ck-power-pwm-phase-shift.X/Makefile
@@ -0,0 +1,113 @@
+#
+#  There exist several targets which are by default empty and which can be 
+#  used for execution of your targets. These targets are usually executed 
+#  before and after some main targets. They are: 
+#
+#     .build-pre:              called before 'build' target
+#     .build-post:             called after 'build' target
+#     .clean-pre:              called before 'clean' target
+#     .clean-post:             called after 'clean' target
+#     .clobber-pre:            called before 'clobber' target
+#     .clobber-post:           called after 'clobber' target
+#     .all-pre:                called before 'all' target
+#     .all-post:               called after 'all' target
+#     .help-pre:               called before 'help' target
+#     .help-post:              called after 'help' target
+#
+#  Targets beginning with '.' are not intended to be called on their own.
+#
+#  Main targets can be executed directly, and they are:
+#  
+#     build                    build a specific configuration
+#     clean                    remove built files from a configuration
+#     clobber                  remove all built files
+#     all                      build all configurations
+#     help                     print help mesage
+#  
+#  Targets .build-impl, .clean-impl, .clobber-impl, .all-impl, and
+#  .help-impl are implemented in nbproject/makefile-impl.mk.
+#
+#  Available make variables:
+#
+#     CND_BASEDIR                base directory for relative paths
+#     CND_DISTDIR                default top distribution directory (build artifacts)
+#     CND_BUILDDIR               default top build directory (object files, ...)
+#     CONF                       name of current configuration
+#     CND_ARTIFACT_DIR_${CONF}   directory of build artifact (current configuration)
+#     CND_ARTIFACT_NAME_${CONF}  name of build artifact (current configuration)
+#     CND_ARTIFACT_PATH_${CONF}  path to build artifact (current configuration)
+#     CND_PACKAGE_DIR_${CONF}    directory of package (current configuration)
+#     CND_PACKAGE_NAME_${CONF}   name of package (current configuration)
+#     CND_PACKAGE_PATH_${CONF}   path to package (current configuration)
+#
+# NOCDDL
+
+
+# Environment 
+MKDIR=mkdir
+CP=cp
+CCADMIN=CCadmin
+RANLIB=ranlib
+
+
+# build
+build: .build-post
+
+.build-pre:
+# Add your pre 'build' code here...
+
+.build-post: .build-impl
+# Add your post 'build' code here...
+
+
+# clean
+clean: .clean-post
+
+.clean-pre:
+# Add your pre 'clean' code here...
+# WARNING: the IDE does not call this target since it takes a long time to
+# simply run make. Instead, the IDE removes the configuration directories
+# under build and dist directly without calling make.
+# This target is left here so people can do a clean when running a clean
+# outside the IDE.
+
+.clean-post: .clean-impl
+# Add your post 'clean' code here...
+
+
+# clobber
+clobber: .clobber-post
+
+.clobber-pre:
+# Add your pre 'clobber' code here...
+
+.clobber-post: .clobber-impl
+# Add your post 'clobber' code here...
+
+
+# all
+all: .all-post
+
+.all-pre:
+# Add your pre 'all' code here...
+
+.all-post: .all-impl
+# Add your post 'all' code here...
+
+
+# help
+help: .help-post
+
+.help-pre:
+# Add your pre 'help' code here...
+
+.help-post: .help-impl
+# Add your post 'help' code here...
+
+
+
+# include project implementation makefile
+include nbproject/Makefile-impl.mk
+
+# include project make variables
+include nbproject/Makefile-variables.mk