Merge pull request #17 from disk91/devel

Addition of the Sigfox Stack on Murata ABZ module

Author: disk91

Doc/drivers/sx1276_sigfox.md

@@ -0,0 +1,29 @@
+# SX1276 / MURATA used as Sigfox
+
+## Pre-requisites
+
+### Hardware configuration (routing): 
+* TCXO powered is controled by a GPIO => This allows to keept it activ as we want
+* PH0-OSC connected to TCXO-OUT => This allows to use TCXO as a HSE clock source. The purpose is to have a synchro between the MCU clock and the generated signal during signal transmission over DMA
+* DIO4 connected to a GPIO => DIO4 is an interrupt channel for Sigfox mode it needs to be connected 
+
+### Cube Mx configuration
+* The SPI pins need to be set including PA15 GPIO_SPEED_FREQ_VERY_HIGH => 32MHz
+* PA15
+  * SPI_NSS pin should be configured PULL_UP with Set as initial state
+  * Speed is VERY_HIGH
+* TIM2 is enable with Inetrnal Clock source / nothing specific it will be setup by the driver code
+* SPI1 is enable with
+  * Soft NSS
+  * SPI_BAUDRATEPRESCALER_32 (it will be reconfigured by the driver code) 
+  * Data Size 8b (it will be reconfigured by the driver code)
+  * DMA Settings : Enable SPI_TX DMA Request on default channel (it will be reconfigured by the driver code)
+  * Enable DMA1 channel2 & 3 interrupt
+  * Disable SPI1 global interrupt
+  * Set GPIO as Very High Speed
+  
+
+### CubeMx specific configuration :
+__SPI1_TX DMA Channel__ needs to be enable in Cube MX. Go to SPI1, Add a DMA entry, Select SPI1_TX in the DMA windows.
+This will generate the necessary IRQ Handler for SPI/DMA transmission.
+

Doc/nvm.md

@@ -12,6 +12,8 @@ The EEPROM is splet into 3 different zone, these zone will exists or not dependi
           +----------------------------------+
           +            ERROR LOG             +
           +----------------------------------+
+          +          SIGFOX NVM AREA         +
+          +----------------------------------+
           +          CONFIGURATION           +
           +----------------------------------+
           +            USER FREE             +
@@ -26,6 +28,11 @@ The Secure Store allows to store critical informations like credentials. See *se
 
 The Error Log allows to store error code persistantly and access them later to debug you firmware.
 
+### SIGFOX NVM AREA
+
+Used by sigfox lib to store internal information like sequence number
+Only activated when sigfox is enable
+
 ### Configuration
 
 The configuration is composed into different parts:

Examples/README.md

@@ -3,5 +3,6 @@ The different examples are located in different GitHub projects. This way you ca
 
 ## STM32 platform
 * Make a led blinking - https://github.com/disk91/stm32-s2lp-sigfox/releases/tag/STEP1
-* Communicate over Sigfox Network - https://github.com/disk91/stm32-s2lp-sigfox
+* Communicate over Sigfox Network with S2LP - https://github.com/disk91/stm32-s2lp-sigfox
+* Communicate over Sigfox Network with SX1276 - https://github.com/disk91/itsdk-example-sigfox-sx1276
 * Communicate over LoRaWan Network - https://github.com/disk91/itsdk-example-murata-lora

Inc/drivers/sigfox/License Sigfox library to ST Customers _ legal.txt

@@ -0,0 +1,37 @@
+By downloading, or attempting to download, the SIGFOX protocol library "SgfxCoreV231_CM0_GCC.a" and/or 
+"SgfxCoreV231_CM0_IAR.a" and/or "SgfxCoreV231_CM0_Keil" and/or "SgfxAddonV020_CM0_GCC.a" and/or 
+"SgfxAddonV020_CM0_IAR.a" and/or "SgfxAddonV020_CM0_Keil.lib", you are hereby informed and you acknowledge 
+and agree that any use of the licensed materials is subject to all terms and conditions required by SIGFOX 
+and listed below:
+� You shall 
+  o respect the Partner Certification Process, described in the SIGFOX developer platform at  
+    http://build.SIGFOX.com to embed applicable authentication keys; 
+  o be in compliance with all applicable laws, regulations (including any applicable 
+    export control law or regulation) and industry standards in connection with the manufacture, sale 
+    and/or distribution of certified products;
+� You shall not:
+ o modify or create without SIGFOX written prior agreement any derivative work of any part of the 
+   SIGFOX protocol library 
+ o market, sell, license, distribute, publish, display, reproduce, rent, lease, loan, assign or otherwise 
+   transfer to a third party the SIGFOX protocol library or any copy thereof, in whole or in part; 
+ o install or otherwise incorporate the SIGFOX protocol library into a product except as set 
+   forth in and in accordance with this document; 
+ o use the SIGFOX protocol library in any way that would not be in compliance with applicable laws; 
+ o except to the extent permitted by law, permit the disassembly, decompilation or reverse engineering
+   of the SIGFOX protocol library or otherwise attempt to gain access to the source code to the SIGFOX 
+   protocol library (or the underlying ideas, algorithms, structure or organization of the object code 
+   in the SIGFOX protocol library)
+ o incorporate any open source software into any product, including with respect to certified products 
+   sold or distributed, that creates or purports to create any obligation to disclose to a third party 
+   any source code relating to the SIGFOX protocol library or grants or purports to grant to any third 
+   party any intellectual property of SIGFOX; 
+ o develop, sell or distribute any product that undermines SIGFOX network security and integrity and/or 
+   introduces in any SIGFOX network any viruses, worms, Trojan horses or similar harmful or malicious 
+   code, or otherwise harms any SIGFOX network; 
+ o remove or attempt to remove any SIGFOX authentication keys,
+ o incorporate the SIGFOX protocol library in any product for connection on another network than SIGFOX 
+   network. You shall inform any of your third party that such infringement to the obligations below 
+   would cause significant harm to SIGFOX.
+
+You shall have no rights to any source code for the SIGFOX protocol library. You agree that only SIGFOX 
+shall have the right to maintain, enhance or otherwise modify the SIGFOX protocol library.