dma.h File Reference

This is the generated driver header file for the DMA driver. More...

#include <xc.h>
#include <stdbool.h>
#include <stdint.h>
#include "dma_types.h"
#include "dma_interface.h"

Include dependency graph for dma.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	DMA_SPI_Initialize   DMA_Initialize
	This macro defines the Custom Name for DMA_Initialize API.
#define	DMA_SPI_Deinitialize   DMA_Deinitialize
	This macro defines the Custom Name for DMA_Deinitialize API.
#define	DMA_SPI_ChannelEnable   DMA_ChannelEnable
	This macro defines the Custom Name for DMA_ChannelEnable API.
#define	DMA_SPI_TransferCountSet   DMA_TransferCountSet
	This macro defines the Custom Name for DMA_TransferCountSet API.
#define	DMA_SPI_TransferCountGet   DMA_TransferCountGet
	This macro defines the Custom Name for DMA_TransferCountGet API.
#define	DMA_SPI_SoftwareTriggerEnable   DMA_SoftwareTriggerEnable
	This macro defines the Custom Name for DMA_SoftwareTriggerEnable API.
#define	DMA_SPI_SourceAddressSet   DMA_SourceAddressSet
	This macro defines the Custom Name for DMA_SourceAddressSet API.
#define	DMA_SPI_DestinationAddressSet   DMA_DestinationAddressSet
	This macro defines the Custom Name for DMA_DestinationAddressSet API.
#define	DMA_SPI_IsSoftwareRequestPending   DMA_IsSoftwareRequestPending
	This macro defines the Custom Name for DMA_IsSoftwareRequestPending API.
#define	DMA_SPI_ChannelTasks   DMA_ChannelTasks
	This macro defines the Custom Name for DMA_ChannelTasks API.
#define	DMA_SPI_ChannelCallbackRegister   DMA_ChannelCallbackRegister
	This macro defines the Custom Name for DMA_ChannelCallbackRegister API.

Functions
void	DMA_Initialize (void)
	Initializes the DMA module.
void	DMA_Deinitialize (void)
	Deinitializes the DMA to POR values.
static void	DMA_ChannelEnable (enum DMA_CHANNEL channel)
	This inline function enables the DMA channel.
static void	DMA_ChannelDisable (enum DMA_CHANNEL channel)
	This inline function disables the DMA channel.
static void	DMA_TransferCountSet (enum DMA_CHANNEL channel, uint16_t transferCount)
	This inline function sets the number of transfer counts to DMA channel.
static uint16_t	DMA_TransferCountGet (enum DMA_CHANNEL channel)
	This inline function returns the number of transfer counts from DMA channel.
static void	DMA_SoftwareTriggerEnable (enum DMA_CHANNEL channel)
	This inline function sets the software trigger of the DMA channel.
static void	DMA_SourceAddressSet (enum DMA_CHANNEL channel, uint16_t address)
	This inline function sets the source address to specified DMA channel.
static void	DMA_DestinationAddressSet (enum DMA_CHANNEL channel, uint16_t address)
	This inline function sets the destination address to specified DMA channel.
static bool	DMA_IsSoftwareRequestPending (enum DMA_CHANNEL channel)
	This inline function returns the status of the software request of the DMA channel.
void	DMA_ChannelTasks (void)
	This function is used to implement the tasks for polled implementations of DMA Channel.
void	DMA_ChannelCallbackRegister (void(*callback)(enum DMA_CHANNEL channel))
	This function can be used to override default callback and to define custom callback for DMA Channel event.
void	DMA_ChannelCallback (enum DMA_CHANNEL channel)
	This is the default callback with weak attribute. The user can override and implement the default callback without weak attribute or can register a custom callback function using DMA_ChannelCallbackRegister.

Variables
const struct DMA_INTERFACE	DMA_SPI
	Structure object of type DMA_INTERFACE with the custom name given by the user in the Melody Driver User interface. The default name e.g. DMA can be changed by the user in the DMA user interface. This allows defining a structure with application specific name using the 'Custom Name' field. Application specific name allows the API Portability.

Detailed Description

DMA Generated Driver Header File

Definition in file dma.h.