dma.h

Go to the documentation of this file.

/* Copyright 2012-2014, Peter A. Bigot
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * * 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.
 *
 * * Neither the name of the software 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 HOLDER 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.
 */

#ifndef BSP430_PERIPH_DMA_H
#define BSP430_PERIPH_DMA_H

#include <bsp430/periph.h>

#define BSP430_MODULE_DMAX (defined(__MSP430_HAS_DMAX_3__)       \
                            || defined(__MSP430_HAS_DMAX_6__))

#define BSP430_MODULE_DMA (defined(__MSP430_HAS_DMA_1__)        \
                           || defined(__MSP430_HAS_DMA_6__)     \
                           || (BSP430_MODULE_DMAX - 0))

/* Only provide declarations if module is supported */
#if defined(BSP430_DOXYGEN) || (BSP430_MODULE_DMA - 0)

/* !BSP430! periph=dma instance=dma */

#define BSP430_DMA_HAL_HPL_VARIANT_DMA 1

#define BSP430_DMA_HAL_HPL_VARIANT_DMAX 2

#if defined(__MSP430_HAS_DMA_1__)
#define BSP430_DMA_NUM_CHANNELS 1
#elif defined(BSP430_DOXYGEN) || defined(__MSP430_HAS_DMA_3__) || defined(__MSP430_HAS_DMAX_3__)
#define BSP430_DMA_NUM_CHANNELS 3
#elif defined(__MSP430_HAS_DMAX_6__)
#define BSP430_DMA_NUM_CHANNELS 6
#endif /* MCU DMA */

#if defined(BSP430_DOXYGEN) || (BSP430_MODULE_DMAX - 0)

typedef struct sBSP430hplDMAchannel {
  unsigned int ctl;             
  unsigned long sa;             
  unsigned long da;             
  unsigned int sz;              
  unsigned int _reserved_x0c;
  unsigned int _reserved_x0e;
} sBSP430hplDMAchannel;

#if (BSP430_CORE_FAMILY_IS_5XX - 0)

typedef struct sBSP430hplDMA {
  unsigned int ctl0;            
  unsigned int ctl1;            
  unsigned int ctl2;            
  unsigned int ctl3;            
  unsigned int ctl4;            
  unsigned int _reserved_x0a;
  unsigned int _reserved_x0c;
  unsigned int iv;              
  sBSP430hplDMAchannel ch[BSP430_DMA_NUM_CHANNELS];
} sBSP430hplDMA;
#else /* BSP430_CORE_FAMILY_IS_5XX */

typedef struct sBSP430hplDMA {
  unsigned int ctl0;            
  unsigned int ctl1;            
  unsigned int iv;              
  unsigned int _reserved_skip[(0x1D0 - 0x128) / sizeof(unsigned int)];
  sBSP430hplDMAchannel ch[BSP430_DMA_NUM_CHANNELS]; 
} sBSP430hplDMA;
#endif /* BSP430_CORE_FAMILY_IS_5XX */

#else /* BSP430_MODULE_DMAX */

typedef struct sBSP430hplDMAchannel {
  unsigned int ctl;             
  unsigned int sa;              
  unsigned int da;              
  unsigned int sz;              
} sBSP430hplDMAchannel;

typedef struct sBSP430hplDMA {
  unsigned int ctl0;            
  unsigned int ctl1;            
  unsigned int _reserved_skip[(0x1E0 - 0x126) / sizeof(unsigned int)];
  sBSP430hplDMAchannel ch[DMA_NUM_CHANNELS]; 
} sBSP430hplDMA;

#endif /* BSP430_MODULE_DMAX */

#if defined(BSP430_DOXYGEN) || defined(__MSP430_HAS_DMA_1__) || defined(__MSP430_HAS_DMA_3__)
#define BSP430_PERIPH_DMA_BASEADDRESS_ 0x0122
#elif defined(__MSP430_HAS_DMAX_3__)
#if defined(__MSP430_BASEADDRESS_DMAX_3__)
#define BSP430_PERIPH_DMA_BASEADDRESS_ __MSP430_BASEADDRESS_DMAX_3__
#else /* __MSP430_BASEADDRESS_DMAX_3__ */
#define BSP430_PERIPH_DMA_BASEADDRESS_ 0x0122
#endif /* __MSP430_BASEADDRESS_DMAX_3__ */
#elif defined(__MSP430_HAS_DMAX_6__)
#define BSP430_PERIPH_DMA_BASEADDRESS_ __MSP430_BASEADDRESS_DMAX_6__
#endif /* MCU DMA */

typedef struct sBSP430halDMA {
  sBSP430hplHALStatePrefix hal_state;

  volatile sBSP430hplDMA * const hpl;

  const struct sBSP430halISRIndexedChainNode * volatile * const ch_cbchain_ni;
} sBSP430halDMA;

typedef struct sBSP430halDMA * hBSP430halDMA;

/* !BSP430! insert=hal_decl with_lookup=0 */
/* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [hal_decl] */
#ifndef configBSP430_HAL_DMA
#define configBSP430_HAL_DMA 0
#endif /* configBSP430_HAL_DMA */

#if (configBSP430_HAL_DMA - 0)
/* You do not need to know about this */
extern sBSP430halDMA xBSP430hal_DMA_;
#endif /* configBSP430_HAL_DMA */

#if defined(BSP430_DOXYGEN) || (configBSP430_HAL_DMA - 0)
#define BSP430_HAL_DMA (&xBSP430hal_DMA_)
#endif /* configBSP430_HAL_DMA */

/* END AUTOMATICALLY GENERATED CODE [hal_decl] */
/* !BSP430! end=hal_decl */

/* !BSP430! insert=periph_decl with_lookup=0 */
/* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [periph_decl] */
#ifndef configBSP430_HPL_DMA
#define configBSP430_HPL_DMA (configBSP430_HAL_DMA - 0)
#endif /* configBSP430_HPL_DMA */

#if (configBSP430_HAL_DMA - 0) && ! (configBSP430_HPL_DMA - 0)
#warning configBSP430_HAL_DMA requested without configBSP430_HPL_DMA
#endif /* HAL and not HPL */

#if defined(BSP430_DOXYGEN) || (configBSP430_HPL_DMA - 0)
#define BSP430_PERIPH_DMA ((tBSP430periphHandle)(BSP430_PERIPH_DMA_BASEADDRESS_))
#endif /* configBSP430_HPL_DMA */

/* END AUTOMATICALLY GENERATED CODE [periph_decl] */
/* !BSP430! end=periph_decl */

/* !BSP430! insert=hpl_decl */
/* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [hpl_decl] */
#if defined(BSP430_DOXYGEN) || (configBSP430_HPL_DMA - 0)
#define BSP430_HPL_DMA ((volatile sBSP430hplDMA *)BSP430_PERIPH_DMA)
#endif /* configBSP430_HPL_DMA */

/* END AUTOMATICALLY GENERATED CODE [hpl_decl] */
/* !BSP430! end=hpl_decl */

/* !BSP430! insert=hal_isr_decl */
/* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [hal_isr_decl] */
#ifndef configBSP430_HAL_DMA_ISR
#define configBSP430_HAL_DMA_ISR (configBSP430_HAL_DMA - 0)
#endif /* configBSP430_HAL_DMA_ISR */

#if (configBSP430_HAL_DMA_ISR - 0) && ! (configBSP430_HAL_DMA - 0)
#warning configBSP430_HAL_DMA_ISR requested without configBSP430_HAL_DMA
#endif /* HAL_ISR and not HAL */

/* END AUTOMATICALLY GENERATED CODE [hal_isr_decl] */
/* !BSP430! end=hal_isr_decl */

#endif /* BSP430_MODULE_DMA */

#endif /* BSP430_PERIPH_DMA_H */