oc_dma_lld.h

Go to the documentation of this file.

#ifndef INC_LLD_OC_DMA_LLD_H_
#define INC_LLD_OC_DMA_LLD_H_

#include <oc_machine.h>
#include <oc_errors.h>

#if oC_Channel_IsModuleDefined(DMA) == false
#error DMA module is not defined
#else

#define _________________________________________TYPES_SECTION______________________________________________________________________________
#define MODULE_NAME DMA

//==========================================================================================================================================
//==========================================================================================================================================
oC_ModuleChannel_DefineType;

//==========================================================================================================================================
//==========================================================================================================================================
typedef enum
{
    oC_DMA_LLD_Priority_Low ,   
    oC_DMA_LLD_Priority_Medium ,
    oC_DMA_LLD_Priority_High    
} oC_DMA_LLD_Priority_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef void (*oC_DMA_LLD_EventHandler_t)(oC_DMA_Channel_t Channel);

//==========================================================================================================================================
//==========================================================================================================================================
typedef enum
{
    oC_DMA_LLD_ElementSize_Byte         = 0 ,
    oC_DMA_LLD_ElementSize_HalfWord     = 1 ,
    oC_DMA_LLD_ElementSize_Word         = 2  
} oC_DMA_LLD_ElementSize_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef enum
{
    oC_DMA_LLD_Direction_Transmit ,
    oC_DMA_LLD_Direction_Receive   
} oC_DMA_LLD_Direction_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef struct
{
    const void *                Source;                         
    void *                      Destination;                    
    oC_DMA_LLD_EventHandler_t   TransferCompleteEventHandler;   
    oC_UInt_t                   BufferSize;                     
    oC_DMA_LLD_Priority_t       Priority;                       
    oC_DMA_LLD_ElementSize_t    ElementSize;                    
} oC_DMA_LLD_SoftwareTradeConfig_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef struct
{
    void *                      Buffer;                         
    oC_DMA_LLD_EventHandler_t   TransferCompleteEventHandler;   
    oC_Channel_t                PeripheralChannel;              
    void *                      PeripheralData;                 
    oC_UInt_t                   BufferSize;                     
    oC_DMA_LLD_Priority_t       Priority;                       
    oC_DMA_LLD_ElementSize_t    ElementSize;                    
    oC_DMA_LLD_Direction_t      TransmitDirection;              
    oC_Machine_DmaSignalType_t  SignalType;                     
} oC_DMA_LLD_PeripheralTradeConfig_t;

#undef MODULE_NAME
#undef  _________________________________________TYPES_SECTION______________________________________________________________________________

#define _________________________________________MACROS_SECTION_____________________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_DMA_LLD_ForeachChannel(Channel)          oC_Channel_Foreach(DMA , Channel)

#undef  _________________________________________MACROS_SECTION_____________________________________________________________________________



#define _________________________________________FUNCTIONS_SECTION__________________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
extern oC_ErrorCode_t oC_DMA_LLD_TurnOnDriver( void );
//==========================================================================================================================================
//==========================================================================================================================================
extern oC_ErrorCode_t oC_DMA_LLD_TurnOffDriver( void );
//==========================================================================================================================================
//==========================================================================================================================================
extern bool oC_DMA_LLD_IsChannelAvailable( oC_DMA_Channel_t Channel );
//==========================================================================================================================================
//==========================================================================================================================================
extern void oC_DMA_LLD_RestoreDefaultStateOnChannel( oC_DMA_Channel_t Channel );
//==========================================================================================================================================
//==========================================================================================================================================
extern bool oC_DMA_LLD_IsChannelSupportedOnDmaChannel( oC_DMA_Channel_t DmaChannel , oC_Channel_t Channel , oC_Machine_DmaSignalType_t SignalType );
//==========================================================================================================================================
//==========================================================================================================================================
extern bool oC_DMA_LLD_IsSoftwareTradeSupportedOnDmaChannel( oC_DMA_Channel_t DmaChannel );
//==========================================================================================================================================
//==========================================================================================================================================
extern bool oC_DMA_LLD_DoesDmaHasAccessToAddress( oC_DMA_Channel_t Channel , const void * Address );
//==========================================================================================================================================
//==========================================================================================================================================
extern oC_ErrorCode_t oC_DMA_LLD_ConfigureSoftwareTrade( oC_DMA_Channel_t Channel , const oC_DMA_LLD_SoftwareTradeConfig_t * Config );
//==========================================================================================================================================
//==========================================================================================================================================
extern oC_ErrorCode_t oC_DMA_LLD_ConfigurePeripheralTrade( oC_DMA_Channel_t Channel , const oC_DMA_LLD_PeripheralTradeConfig_t * Config );
//==========================================================================================================================================
//==========================================================================================================================================
extern bool oC_DMA_LLD_IsTransferCompleteOnChannel( oC_DMA_Channel_t Channel );
//==========================================================================================================================================
//==========================================================================================================================================
extern oC_ErrorCode_t oC_DMA_LLD_ReadChannelUsedReference( oC_DMA_Channel_t Channel , bool ** outChannelUsedFlag );
//==========================================================================================================================================
//==========================================================================================================================================
extern oC_ErrorCode_t oC_DMA_LLD_FindFreeDmaChannelForPeripheralTrade( oC_DMA_Channel_t * outDmaChannel , oC_Channel_t Channel , oC_Machine_DmaSignalType_t SignalType );

#undef  _________________________________________FUNCTIONS_SECTION__________________________________________________________________________

#endif /* DMA DEFINED */
#endif /* INC_LLD_OC_DMA_LLD_H_ */