Moving PDM to separate library

Author: Nathan Seidle

cores/arduino/ard_sup/Arduino.h

@@ -78,7 +78,6 @@ extern "C"
 #include "ap3_analog.h"
 #include "ap3_clock_sources.h"
 #include "ap3_shift.h"
-#include "ap3_pdm.h"
 #include "WMath.h"
 #include "WCharacter.h"
 

libraries/PDM/keywords.txt

@@ -0,0 +1,23 @@
+#######################################
+# Syntax Coloring Map
+#######################################
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+EEPROM	KEYWORD1
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+read	KEYWORD2
+write	KEYWORD2
+get	KEYWORD2
+put	KEYWORD2
+update	KEYWORD2
+erase	KEYWORD2
+
+#######################################
+# Constants (LITERAL1)
+#######################################

libraries/PDM/library.properties

@@ -0,0 +1,9 @@
+name=EEPROM
+version=1.0
+author=SparkFun Electronics
+maintainer=SparkFun Electronics <sparkfun.com>
+sentence=Flash based Pseudo EEPROM for Artemis
+paragraph=Enables the writing of variables to a protected section of flash. These bytes will not be overwritten when new sketches are loaded and are useful when needing to record settings like calibration data or GPS waypoints that should not change between sketch updates.
+category=Communication
+url=http://www.arduino.cc/en/Reference/EEPROM
+architectures=apollo3

cores/arduino/ard_sup/pdm/ap3_pdm.cpp renamed to libraries/PDM/src/PDM.cpp

@@ -19,7 +19,7 @@ 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.
 */
-#include "ap3_pdm.h"
+#include "PDM.h"
 
 AP3_PDM *ap3_pdm_handle = 0;
 
@@ -116,6 +116,96 @@ ap3_err_t AP3_PDM::_begin(void)
     return retval;
 }
 
+bool AP3_PDM::setClockSpeed(am_hal_pdm_clkspd_e clockSpeed)
+{
+    _PDMconfig.ePDMClkSpeed = clockSpeed;
+
+    return (updateConfig(_PDMconfig));
+}
+
+am_hal_pdm_clkspd_e AP3_PDM::getClockSpeed()
+{
+    return (_PDMconfig.ePDMClkSpeed);
+}
+
+bool AP3_PDM::setClockDivider(am_hal_pdm_mclkdiv_e clockDivider)
+{
+    _PDMconfig.eClkDivider = clockDivider;
+
+    return (updateConfig(_PDMconfig));
+}
+
+am_hal_pdm_mclkdiv_e AP3_PDM::getClockDivider()
+{
+    return (_PDMconfig.eClkDivider);
+}
+
+bool AP3_PDM::setLeftGain(am_hal_pdm_gain_e gain)
+{
+    _PDMconfig.eLeftGain = gain;
+
+    return (updateConfig(_PDMconfig));
+}
+
+bool AP3_PDM::setRightGain(am_hal_pdm_gain_e gain)
+{
+    _PDMconfig.eRightGain = gain;
+
+    return (updateConfig(_PDMconfig));
+}
+
+bool AP3_PDM::setGain(am_hal_pdm_gain_e gain)
+{
+    _PDMconfig.eLeftGain = gain;
+    _PDMconfig.eRightGain = gain;
+
+    return (updateConfig(_PDMconfig));
+}
+
+am_hal_pdm_gain_e AP3_PDM::getLeftGain()
+{
+    return (_PDMconfig.eLeftGain);
+}
+am_hal_pdm_gain_e AP3_PDM::getRightGain()
+{
+    return (_PDMconfig.eRightGain);
+}
+
+bool AP3_PDM::setChannel(am_hal_pdm_chset_e channel)
+{
+    _PDMconfig.ePCMChannels = channel;
+
+    return (updateConfig(_PDMconfig));
+}
+
+am_hal_pdm_chset_e AP3_PDM::getChannel()
+{
+    return (_PDMconfig.ePCMChannels);
+}
+
+bool AP3_PDM::setDecimationRate(uint32_t deciRate)
+{
+    _PDMconfig.ui32DecimationRate = deciRate;
+
+    return (updateConfig(_PDMconfig));
+}
+
+uint32_t AP3_PDM::getDecimationRate()
+{
+    return (_PDMconfig.ui32DecimationRate);
+}
+
+//Send a given configuration struct to PDM
+bool AP3_PDM::updateConfig(am_hal_pdm_config_t newConfiguration)
+{
+    ap3_err_t retval = (ap3_err_t)am_hal_pdm_configure(_PDMhandle, &newConfiguration);
+    if (retval != AP3_OK)
+    {
+        return false;
+    }
+    return true;
+}
+
 ap3_err_t ap3_pdm_pad_funcsel(ap3_pdm_pad_type_e type, ap3_gpio_pad_t pad, uint8_t *funcsel)
 {
     ap3_err_t retval = AP3_ERR;
@@ -159,6 +249,32 @@ ap3_err_t ap3_pdm_pad_funcsel(ap3_pdm_pad_type_e type, ap3_gpio_pad_t pad, uint8
     return retval;
 }
 
+//*****************************************************************************
+    //
+    // Start a transaction to get some number of bytes from the PDM interface.
+    //
+    //*****************************************************************************
+    void
+    AP3_PDM::getData(uint32_t *PDMDataBuffer, uint32_t bufferSize)
+{
+    //
+    // Configure DMA and target address.
+    //
+    am_hal_pdm_transfer_t sTransfer;
+    sTransfer.ui32TargetAddr = (uint32_t)PDMDataBuffer;
+    sTransfer.ui32TotalCount = bufferSize * 2; //PDM_FFT_BYTES;
+
+    //
+    // Start the data transfer.
+    //
+    am_hal_pdm_enable(_PDMhandle);
+    am_util_delay_ms(100);
+    am_hal_pdm_fifo_flush(_PDMhandle);
+    am_hal_pdm_dma_start(_PDMhandle, &sTransfer);
+
+    myPDM._PDMdataReady = false;
+}
+
 inline void AP3_PDM::pdm_isr(void)
 {
     uint32_t ui32Status;

cores/arduino/ard_sup/ap3_pdm.h renamed to libraries/PDM/src/PDM.h

@@ -19,8 +19,8 @@ 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.
 */
-#ifndef _AP3_PDM_H_
-#define _AP3_PDM_H_
+#ifndef _PDM_H_
+#define _PDM_H_
 
 #include "Arduino.h"
 
@@ -89,6 +89,21 @@ class AP3_PDM
     bool begin(ap3_gpio_pin_t pinPDMData, ap3_gpio_pin_t pinPDMClock);
     bool available(void); //Goes true once an interrupt has occured
 
+    bool setClockSpeed(am_hal_pdm_clkspd_e clockSpeed);
+    am_hal_pdm_clkspd_e getClockSpeed();
+    bool setClockDivider(am_hal_pdm_mclkdiv_e clockSpeed);
+    am_hal_pdm_mclkdiv_e getClockDivider();
+    bool setLeftGain(am_hal_pdm_gain_e gain);
+    am_hal_pdm_gain_e getLeftGain();
+    bool setRightGain(am_hal_pdm_gain_e gain);
+    am_hal_pdm_gain_e getRightGain();
+    bool setGain(am_hal_pdm_gain_e gain);
+    bool setChannel(am_hal_pdm_chset_e channel);
+    am_hal_pdm_chset_e getChannel();
+    bool setDecimationRate(uint32_t deciRate);
+    uint32_t getDecimationRate();
+
+    bool updateConfig(am_hal_pdm_config_t newConfiguration);
     //void begin(void);
     // void begin(unsigned long baudrate, uint16_t config);
     // void begin(unsigned long baudrate, am_hal_uart_config_t config);
@@ -124,4 +139,4 @@ class AP3_PDM
     volatile bool _PDMdataReady = false;
 };
 
-#endif //_AP3_PDM_H_
+#endif //_PDM_H_