update commit

MicrochipTech · Mar 8, 2024 · a2299b4 · a2299b4
1 parent 328d2bc
commit a2299b4
Show file tree

Hide file tree

Showing 94 changed files with 28,836 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,92 @@
-# wireless_15_4_phy_trx
+![Microchip logo](https://raw.githubusercontent.com/wiki/Microchip-MPLAB-Harmony/Microchip-MPLAB-Harmony.github.io/images/microchip_logo.png)
+![Harmony logo small](https://raw.githubusercontent.com/wiki/Microchip-MPLAB-Harmony/Microchip-MPLAB-Harmony.github.io/images/microchip_mplab_harmony_logo_small.png)
+
+# MPLAB® Harmony 3 Standalone IEEE 802.15.4 Physical Layer
+
+MPLAB® Harmony 3 is an extension of the MPLAB® ecosystem for creating embedded firmware solutions for Microchip 32-bit SAM and PIC® microcontroller and microprocessor devices.  Refer to the following links for more information.
+
+- [Microchip 32-bit MCUs](https://www.microchip.com/design-centers/32-bit)
+- [Microchip 32-bit MPUs](https://www.microchip.com/design-centers/32-bit-mpus)
+- [Microchip MPLAB X IDE](https://www.microchip.com/mplab/mplab-x-ide)
+- [Microchip MPLAB® Harmony](https://www.microchip.com/mplab/mplab-harmony)
+- [Microchip MPLAB® Harmony Pages](https://microchip-mplab-harmony.github.io/)
+
+This repository contains the MPLAB® Harmony 3 Module for Standalone IEEE 802.15.4 Physical Layer that provide an interface to the microcontrollers (like SAML21, SAMD21) to access the transceiver functionality of radio transceivers like AT86RF233 or AT86RF212B. 
+With the help of PHY layer module user can enable various functionaities of the transceiver.
+reference information.
+
+
+- [MPLAB® Harmony License](mplab_harmony_license.md)
+
+
+# Contents Summary
+
+| Folder     | Description                                                       |
+| -----------| ------------------------------------------------------------------|
+| config     | Standalone IEEE 802.15.4 Physical Layer module |
+| docs|         [User guide](./README.md)
+| drivers    | phy layer files     |
+
+- Clone the [Standalone PHY](https://github.com/MicrochipTech/wireless_15_4_phy_trx) repo to user's local Harmony Repo.
+- Refer to the section 2.5, Creating a New MCC Harmony Project in the [PIC32CXBZ2 Application Developer's Guide](https://onlinedocs.microchip.com/g/GUID-A5330D3A-9F51-4A26-B71D-8503A493DF9C).
+- Project Graph appears with some predefined component as shown in image below:
+
+![](docs/img1.jpg)
+
+- The IEEE 802.15.4 PHY component will appear under Wireless->Drivers->IEEE 802.15.4 in the Device Resources tab as shown in image below:
+
+![](docs/img2.png)
+
+- Select MiWi (if MiWi protocol is used as higher layer) under “Wireless->Drivers” tab. Accept all Dependencies or satisfiers, by selecting "Yes". All the necessary components will be auto populated.
+- Please follow the steps in the following [link](https://github.com/MicrochipTech/MiWi/blob/main/docs/GUID-32628D58-8B41-490F-8DA4-520C34856980.md) to configure for MiWi.
+
+- Connect SERCOM5 and TC0 dependencies as shown in the image below:
+
+![](docs/img3.png)
+
+- Finally ensure that the project graph has all the components as depicted below.
+
+![](docs/img4.PNG)
+
+- Please follow the below steps for the “Configuration Options” changes to be done for Standalone PHY layer.
+- Go to Plugins>Pin Configuration. Refer below image for the Pin configurations. Provide the same “Custom Name”, “Function” and “Direction” as depicted in image below.
+
+![](docs/PinCfg1.PNG)
+
+![](docs/pinCfg2.PNG)
+
+- The “Module Pin Selections” in the “Configuration Options” gets automatically populated when the correct pin configurations are configured.
+- The Radio transceiver type can be changed by selecting the dropdown option availabel in “Select Transceiver Type”. At present only RF233 ans RF212B is supported.
+
+![](docs/phy_configuration.PNG)
+
+- Following are the EIC and Sercom5 configuration.
+
+![](docs/eic_configuration.PNG)
+
+![](docs/sercom_config.PNG)
+
+- Click on “Resource Management [MCC]” and click “Generate”.
+
+![](docs/mcc_code_gen.jpg)
+
+Note 1: After generating the code via MCC, make sure to implement the following changes. Right click on the project and go to properties. Select xc32-gcc. Under the option categories, select Preprocessing and Messages. 
+Double click on the Preprocessor macros and add the symbol, PHY_AT86RF212B/PHY_AT86RF233 depending on the preference. Remove ENABLE_NETWORK_FREEZER & Chimera_SOC symbol if MiWi is used.
+
+Note 2: To optimise the NVIC priority levels of different peripherals used such as EIC, SPI and TC, go to project source files>config>default>peripheral>plib_nvic.c, change the NVIC priority as shown in the image below:
+
+![](docs/nvic_priority.PNG)
+
+Note 3: In app.c file replace "appData.appQueue = xQueueCreate( 64, sizeof(APP_Msg_T) );" with "appData.appQueue = xQueueCreate( 5, sizeof(APP_Msg_T) );"
+
+Note 4: The following applies if MiWi protocol is used as higher layer : In the file tasks.c replace "#define TASK_MIWI_STACK_SIZE (8 *1024 / sizeof(portSTACK_TYPE))" with "#define TASK_MIWI_STACK_SIZE (2 *1024 / sizeof(portSTACK_TYPE))"
+
+Note 5: The size of lAPP_Tasks should be changed to 512 in task.c file. 
+
+[![Follow us on Youtube](https://img.shields.io/badge/Youtube-Follow%20us%20on%20Youtube-red.svg)](https://www.youtube.com/user/MicrochipTechnology)
+[![Follow us on LinkedIn](https://img.shields.io/badge/LinkedIn-Follow%20us%20on%20LinkedIn-blue.svg)](https://www.linkedin.com/company/microchip-technology)
+[![Follow us on Facebook](https://img.shields.io/badge/Facebook-Follow%20us%20on%20Facebook-blue.svg)](https://www.facebook.com/microchiptechnology/)
+[![Follow us on Twitter](https://img.shields.io/twitter/follow/MicrochipTech.svg?style=social)](https://twitter.com/MicrochipTech)
+
+
+
diff --git a/config/module.py b/config/module.py
@@ -0,0 +1,38 @@
+"""*****************************************************************************
+* Copyright (C) 2024 Microchip Technology Inc. and its subsidiaries.
+*
+* Subject to your compliance with these terms, you may use Microchip software
+* and any derivatives exclusively with Microchip products. It is your
+* responsibility to comply with third party license terms applicable to your
+* use of third party software (including open source software) that may
+* accompany Microchip software.
+*
+* 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.
+*
+* 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.
+*****************************************************************************"""
+
+
+def loadModule():
+    print('Load Module: Harmony IEEE 802.15.4 PHY Standalone Library')
+
+
+    rfHostComponent  = Module.CreateComponent('IEEE_802154_PHY', 'IEEE 802.15.4 PHY', 'Wireless/Drivers/IEEE 802.15.4','driver/config/drv_ieee802154phy_standalone.py')
+    rfHostComponent.setDisplayType('HOST<->TRANSCEIVER INTERFACE\n\n\n')
+    rfHostComponent.addDependency('TRANSCEIVER_SPI_Dependency', 'SPI','SERCOM',False, True)
+    rfHostComponent.addDependency('HarmonyCoreDependency', 'Core Service', 'Core', True, True)
+    rfHostComponent.addDependency('SysTimeDependency', 'SYS_TIME', 'SYS_TIME', True, True)
+    rfHostComponent.addDependency('FreeRtosDependency', 'RTOS', 'RTOS', True, True)
+    rfHostComponent.addCapability('ieee802154phy_Capability', 'IEEE 802.15.4 PHY', True)
+
+
+
diff --git a/docs/Capture.PNG b/docs/Capture.PNG
diff --git a/docs/PinCfg1.PNG b/docs/PinCfg1.PNG
diff --git a/docs/eic_configuration.PNG b/docs/eic_configuration.PNG
diff --git a/docs/img1.jpg b/docs/img1.jpg
diff --git a/docs/img2.png b/docs/img2.png
diff --git a/docs/img3.png b/docs/img3.png
diff --git a/docs/img4.PNG b/docs/img4.PNG
diff --git a/docs/mcc_code_gen.jpg b/docs/mcc_code_gen.jpg
diff --git a/docs/nvic_priority.PNG b/docs/nvic_priority.PNG
diff --git a/docs/phy_configuration.PNG b/docs/phy_configuration.PNG
diff --git a/docs/pinCfg2.PNG b/docs/pinCfg2.PNG
diff --git a/docs/sercom_config.PNG b/docs/sercom_config.PNG