2013-02-28 16:23:19 +00:00
|
|
|
/*
|
|
|
|
ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
|
|
|
|
2011,2012,2013 Giovanni Di Sirio.
|
|
|
|
|
|
|
|
This file is part of ChibiOS/RT.
|
|
|
|
|
|
|
|
ChibiOS/RT is free software; you can redistribute it and/or modify
|
|
|
|
it under the terms of the GNU General Public License as published by
|
|
|
|
the Free Software Foundation; either version 3 of the License, or
|
|
|
|
(at your option) any later version.
|
|
|
|
|
|
|
|
ChibiOS/RT is distributed in the hope that it will be useful,
|
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
GNU General Public License for more details.
|
|
|
|
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @file SPC5xx/edma.h
|
|
|
|
* @brief EDMA helper driver header.
|
|
|
|
*
|
|
|
|
* @addtogroup SPC5xx_EDMA
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _EDMA_H_
|
|
|
|
#define _EDMA_H_
|
|
|
|
|
|
|
|
/*===========================================================================*/
|
|
|
|
/* Driver constants. */
|
|
|
|
/*===========================================================================*/
|
|
|
|
|
2013-03-04 08:17:33 +00:00
|
|
|
/**
|
|
|
|
* @brief EDMA channel allocation error.
|
|
|
|
*/
|
|
|
|
#define EDMA_ERROR -1
|
|
|
|
|
2013-02-28 16:23:19 +00:00
|
|
|
/*===========================================================================*/
|
|
|
|
/* Driver pre-compile time settings. */
|
|
|
|
/*===========================================================================*/
|
|
|
|
|
2013-03-04 11:10:29 +00:00
|
|
|
/**
|
|
|
|
* @brief Default EDMA CR register initialization.
|
|
|
|
*/
|
|
|
|
#if !defined(SPC5_EDMA_ERROR_HANDLER) || defined(__DOXYGEN__)
|
|
|
|
#define SPC5_EDMA_CR_SETTING 0x0000C400
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief EDMA critical error handler, must not return.
|
|
|
|
*/
|
|
|
|
#if !defined(SPC5_EDMA_ERROR_HANDLER) || defined(__DOXYGEN__)
|
|
|
|
#define SPC5_EDMA_ERROR_HANDLER() chSysHalt()
|
|
|
|
#endif
|
|
|
|
|
2013-02-28 16:23:19 +00:00
|
|
|
/*===========================================================================*/
|
|
|
|
/* Derived constants and error checks. */
|
|
|
|
/*===========================================================================*/
|
|
|
|
|
2013-03-04 11:10:29 +00:00
|
|
|
#if !SPC5_HAS_EDMAA
|
|
|
|
#error "this device does not have an eDMA unit"
|
|
|
|
#endif
|
|
|
|
|
2013-02-28 16:23:19 +00:00
|
|
|
/*===========================================================================*/
|
|
|
|
/* Driver data structures and types. */
|
|
|
|
/*===========================================================================*/
|
|
|
|
|
2013-03-04 08:17:33 +00:00
|
|
|
/**
|
|
|
|
* @brief Type of and EDMA channel number.
|
|
|
|
*/
|
|
|
|
typedef int32_t edma_channel_t;
|
|
|
|
|
2013-02-28 16:23:19 +00:00
|
|
|
/**
|
|
|
|
* @brief Type of an EDMA TCD.
|
|
|
|
*/
|
|
|
|
typedef struct {
|
|
|
|
uint32_t word[8];
|
|
|
|
} edma_tcd_t;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief DMA ISR function type.
|
|
|
|
*
|
2013-03-04 11:10:29 +00:00
|
|
|
* @param[in] channel the channel number
|
2013-02-28 16:23:19 +00:00
|
|
|
* @param[in] p parameter for the registered function
|
|
|
|
*/
|
2013-03-04 11:10:29 +00:00
|
|
|
typedef void (*edma_callback_t)(edma_channel_t channel, void *p);
|
2013-02-28 16:23:19 +00:00
|
|
|
|
2013-03-01 14:37:07 +00:00
|
|
|
/**
|
|
|
|
* @brief Type of an EDMA channel configuration structure.
|
|
|
|
*/
|
2013-02-28 16:23:19 +00:00
|
|
|
typedef struct {
|
2013-03-04 11:10:29 +00:00
|
|
|
uint8_t dma_periph; /**< @brief Peripheral to be
|
2013-03-04 08:17:33 +00:00
|
|
|
associated to the channel. */
|
2013-03-04 15:11:20 +00:00
|
|
|
uint8_t dma_prio; /**< @brief Priority register value
|
2013-03-04 11:10:29 +00:00
|
|
|
for this channel. */
|
2013-03-04 15:11:20 +00:00
|
|
|
uint8_t dma_irq_prio; /**< @brief IRQ priority level for
|
|
|
|
this channel. */
|
2013-03-04 11:10:29 +00:00
|
|
|
edma_callback_t dma_func; /**< @brief Channel callback. */
|
|
|
|
edma_callback_t dma_error_func; /**< @brief Channel error callback. */
|
2013-03-01 14:37:07 +00:00
|
|
|
void *dma_param; /**< @brief Channel callback param. */
|
|
|
|
} edma_channel_config_t;
|
2013-02-28 16:23:19 +00:00
|
|
|
|
|
|
|
/*===========================================================================*/
|
|
|
|
/* Driver macros. */
|
|
|
|
/*===========================================================================*/
|
|
|
|
|
2013-03-04 11:10:29 +00:00
|
|
|
/**
|
|
|
|
* @brief Starts or restarts an EDMA channel.
|
|
|
|
*
|
|
|
|
* @param[in] channel the channel number
|
|
|
|
*
|
|
|
|
* @api
|
|
|
|
*/
|
|
|
|
#define edmaChannelStart(channel) (EDMA.SERQR.R = (channel))
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Stops an EDMA channel.
|
|
|
|
*
|
|
|
|
* @param[in] channel the channel number
|
|
|
|
*
|
|
|
|
* @api
|
|
|
|
*/
|
|
|
|
#define edmaChannelStop(channel) (EDMA.CERQR.R = (channel))
|
|
|
|
|
2013-02-28 16:23:19 +00:00
|
|
|
/*===========================================================================*/
|
|
|
|
/* External declarations. */
|
|
|
|
/*===========================================================================*/
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
void edmaInit(void);
|
2013-03-04 08:57:20 +00:00
|
|
|
edma_channel_t edmaChannelAllocate(const edma_channel_config_t *ccfg);
|
|
|
|
void edmaChannelRelease(edma_channel_t channel);
|
2013-02-28 16:23:19 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif /* _EDMA_H_ */
|
|
|
|
|
|
|
|
/** @} */
|