drivers: add dma based bitbanging driver

Author: bugobliterator

src/drivers/boards/px4fmu-v2/board_config.h

@@ -236,6 +236,14 @@ __BEGIN_DECLS
 #define PWMIN_TIMER_CHANNEL	2
 #define GPIO_PWM_IN		GPIO_TIM4_CH2IN_2
 
+/* Extra Purpose DMA */
+//Note: Only DMA2 has access to AHB bus meaning GPIO registers are only modifiable by DMA2, 
+//refer DMA section of stm32F4 series User manual for further details.
+#define DMAMAP_BITBANG  STM32_DMA_MAP(DMA2,DMA_STREAM1,DMA_CHAN6)
+#define TIMER_BITBANG   1
+// Refer manual for DMA Request map to select proper timer channel
+#define TIMER_BITBANG_CH 1
+#define BITBANG_GPIO_REG_BASE STM32_GPIOE_BASE
 /****************************************************************************************************
  * Public Types
  ****************************************************************************************************/

src/drivers/drv_dma_bitbang.h

@@ -0,0 +1,62 @@
+/****************************************************************************
+ *
+ *   Copyright (C) 2012 PX4 Development Team. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name PX4 nor the names of its contributors may be
+ *    used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ ****************************************************************************/
+
+/**
+ * @file px4fmu_dma_bb.c
+ *
+ * DMA based Bit Bang Support
+ * Author: Siddharth Bharat Purohit
+ *
+ */
+
+#pragma once
+#include <px4_config.h>
+#include <nuttx/arch.h>
+#include <nuttx/irq.h>
+
+#include <sys/types.h>
+#include <stdbool.h>
+#include <inttypes.h>
+
+#include <px4_time.h>
+#include <queue.h>
+
+__BEGIN_DECLS
+
+/* Initialise DMA based Bitbanging scheme*/
+__EXPORT extern void dma_bb_init(uint32_t mult, uint32_t offset);
+
+/* Send buffer containing pin states to be sent immediately */
+__EXPORT extern void dma_bb_send_buff(uint32_t* dat, uint32_t len, dma_callback_t callback, void* arg);
+
+__END_DECLS

src/drivers/stm32/CMakeLists.txt

@@ -39,6 +39,7 @@ px4_add_module(
 		drv_io_timer.c
 		drv_pwm_servo.c
 		drv_input_capture.c
+		drv_dma_bitbang.c
 	DEPENDS
 		platforms__common
 	)

src/drivers/stm32/drv_dma_bitbang.c

@@ -0,0 +1,224 @@
+/****************************************************************************
+ *
+ *   Copyright (C) 2012 PX4 Development Team. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name PX4 nor the names of its contributors may be
+ *    used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ ****************************************************************************/
+
+/**
+ * @file px4fmu_dma_bb.c
+ *
+ * DMA based Bit Bang driver
+ * Author: Siddharth Bharat Purohit
+ *
+ */
+
+/************************************************************************************
+ * Included Files
+ ************************************************************************************/
+
+#include <stdbool.h>
+#include <stdio.h>
+#include <assert.h>
+#include <debug.h>
+#include <time.h>
+#include <queue.h>
+#include <errno.h>
+#include <string.h>
+#include <math.h>
+
+#include <drivers/drv_dma_bitbang.h>
+
+#include "chip.h"
+#include "up_internal.h"
+#include "up_arch.h"
+
+#include "stm32.h"
+#include "stm32_gpio.h"
+#include "stm32_tim.h"
+
+#ifdef DMAMAP_BITBANG
+
+#if   TIMER_BITBANG == 1
+# define DMA_TIMER_BASE			STM32_TIM1_BASE
+# define DMA_TIMER_POWER_REG	STM32_RCC_APB1ENR
+# define DMA_TIMER_POWER_BIT	RCC_APB2ENR_TIM1EN
+# define DMA_TIMER_VECTOR		STM32_IRQ_TIM1CC
+# define DMA_TIMER_CLOCK		STM32_APB2_TIM1_CLKIN
+#elif TIMER_BITBANG == 8
+# define DMA_TIMER_BASE			STM32_TIM8_BASE
+# define DMA_TIMER_POWER_REG	STM32_RCC_APB2ENR
+# define DMA_TIMER_POWER_BIT	RCC_APB2ENR_TIM8EN
+# define DMA_TIMER_VECTOR		STM32_IRQ_TIM8CC
+# define DMA_TIMER_CLOCK		STM32_APB2_TIM8_CLKIN
+#else
+#  error must select Timer 1 or Timer 8 DMA2 doesnot support any other
+#endif
+
+/*
+ * Timer register accessors
+ */
+#define REG(_reg)	(*(volatile uint32_t *)(DMA_TIMER_BASE + _reg))
+
+#define rCR1     	REG(STM32_GTIM_CR1_OFFSET)
+#define rCR2     	REG(STM32_GTIM_CR2_OFFSET)
+#define rSMCR    	REG(STM32_GTIM_SMCR_OFFSET)
+#define rDIER    	REG(STM32_GTIM_DIER_OFFSET)
+#define rSR      	REG(STM32_GTIM_SR_OFFSET)
+#define rEGR     	REG(STM32_GTIM_EGR_OFFSET)
+#define rCCMR1   	REG(STM32_GTIM_CCMR1_OFFSET)
+#define rCCMR2   	REG(STM32_GTIM_CCMR2_OFFSET)
+#define rCCER    	REG(STM32_GTIM_CCER_OFFSET)
+#define rCNT     	REG(STM32_GTIM_CNT_OFFSET)
+#define rPSC     	REG(STM32_GTIM_PSC_OFFSET)
+#define rARR     	REG(STM32_GTIM_ARR_OFFSET)
+#define rCCR1    	REG(STM32_GTIM_CCR1_OFFSET)
+#define rCCR2    	REG(STM32_GTIM_CCR2_OFFSET)
+#define rCCR3    	REG(STM32_GTIM_CCR3_OFFSET)
+#define rCCR4    	REG(STM32_GTIM_CCR4_OFFSET)
+#define rDCR     	REG(STM32_GTIM_DCR_OFFSET)
+#define rDMAR    	REG(STM32_GTIM_DMAR_OFFSET)
+
+
+#if TIMER_BITBANG_CH == 1
+# define rCCR_DMA		rCCR1				/* compare register */
+# define DIER_DMA_INT	GTIM_DIER_CC1IE		/* interrupt enable */
+# define DIER_DMA_REQ	GTIM_DIER_CC1DE		/* DMA request enable */
+# define SR_INT_DMA		GTIM_SR_CC1IF		/* interrupt status */
+#elif TIMER_BITBANG_CH == 2
+# define rCCR_DMA		rCCR2				/* compare register */
+# define DIER_DMA_INT	GTIM_DIER_CC2IE		/* interrupt enable */
+# define DIER_DMA_REQ	GTIM_DIER_CC2DE		/* DMA request enable */
+# define SR_INT_DMA		GTIM_SR_CC2IF		/* interrupt status */
+#elif TIMER_BITBANG_CH == 3
+# define rCCR_DMA		rCCR3				/* compare register */
+# define DIER_DMA_INT	GTIM_DIER_CC3IE		/* interrupt enable */
+# define DIER_DMA_REQ	GTIM_DIER_CC3DE		/* DMA request enable */
+# define SR_INT_DMA		GTIM_SR_CC3IF		/* interrupt status */
+#elif TIMER_BITBANG_CH == 4
+# define rCCR_DMA		rCCR4				/* compare register */
+# define DIER_DMA_INT	GTIM_DIER_CC4IE		/* interrupt enable */
+# define DIER_DMA_REQ	GTIM_DIER_CC4DE		/* DMA request enable */
+# define SR_INT_DMA		GTIM_SR_CC4IF		/* interrupt status */
+#else
+# error TIMER_BITBANG_CH must be a value between 1 and 4
+#endif
+
+static DMA_HANDLE	tx_dma;
+
+static void		dma_reset(void);
+static bool init = false;
+
+/* GPIO register accessors */
+#define GPIO_REG(_x)		(*(volatile uint32_t *)(BITBANG_GPIO_REG_BASE + _x))
+#define rBSSR		GPIO_REG(STM32_GPIO_BSRR_OFFSET)
+
+// The rate of timer will be set per following equation
+// Timer_Rate = {(16.8*mult + offset)/168} Mhz
+// The fastest clock which can be generated would be:
+// Clk_fast = Timer_Rate/4 Hz
+void dma_bb_init(uint32_t mult, uint32_t offset)
+{
+	/* clock/power on our timer */
+	modifyreg32(DMA_TIMER_POWER_REG, 0, DMA_TIMER_POWER_BIT);
+
+	tx_dma = stm32_dmachannel(DMAMAP_BITBANG);
+
+	/* configure the timer according to the requested factors*/
+	rPSC = roundf(16.8f * mult + offset) - 1;
+
+	/* run to only one increment*/
+	rARR = 1;
+
+	rCCR_DMA = 1;
+
+	rCR1 = 0;
+	rCR2 = 0;
+
+	/* generate an update event; reloads the counter, all registers */
+	rEGR = GTIM_EGR_UG;
+
+	/* enable the timer */
+	rCR1 = GTIM_CR1_CEN;
+
+	init = true;
+	printf("[init] Starting DMA bitbang driver \n");
+}
+
+/* 
+Sends Set or Reset data to GPIO Register popping data from top at every timer compare
+
+ -- "callback" is called after completion the set of requested pulse is transmitted through 
+ to GPIO bus, 
+ -- with "arg" being the argument to the callback
+ -- "dat" contains the list of pin states over time, data is sent to  GPIOx_BSSR register which
+ has following behaviour:
+
+ -- Bits 31:16 BRx
+		0: No action
+		1: Reset the corresponding GPIOx O/P bit
+ 
+ -- Bits 15:0 BSx
+		0: No action
+		1: Set the corresponding GPIOx O/P bit
+
+Note: If both BSx and BRx are set, BSx has priority.
+*/
+void dma_bb_send_buff(uint32_t* dat, uint32_t len, dma_callback_t callback, void* arg)
+{
+	if(!init) {
+		return;
+	}
+	/* unconfigure the timer request */
+	rDIER &= ~DIER_DMA_REQ;
+	dma_reset();
+
+	stm32_dmasetup(
+		tx_dma,
+		(uint32_t)&rBSSR,
+		(uint32_t)dat,
+		len,
+		DMA_SCR_DIR_M2P		 |
+		DMA_SCR_MINC		 |
+		DMA_SCR_PSIZE_32BITS |
+		DMA_SCR_MSIZE_32BITS);
+	stm32_dmastart(tx_dma, callback, arg, false);
+
+	/* Enable Timer request */
+	rDIER |= DIER_DMA_REQ;
+}
+
+static void
+dma_reset(void)
+{
+	/* kill any pending DMA */
+	stm32_dmastop(tx_dma);
+}
+
+#endif //#ifdef DMAMAP_BITBANG

src/drivers/stm32/module.mk

@@ -40,7 +40,8 @@
 SRCS		= drv_hrt.c \
 		  drv_pwm_servo.c \
 		  drv_io_timer.c \
-		  drv_input_capture.c
+		  drv_input_capture.c \
+		  drv_dma_bitbang.c
 
 
 INCLUDE_DIRS	+= $(NUTTX_SRC)/arch/arm/src/stm32 $(NUTTX_SRC)/arch/arm/src/common