hal_dma.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2024 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**
****************************************************************************/
#ifndef _HAL_DMA_H_
#define _HAL_DMA_H_
 
#ifdef __cplusplus
extern "C"{
#endif
 
#include "hal_target.h"
 
typedef enum
{
    HAL_DMA_SUCCESS = 0, 
    HAL_DMA_ERROR = (-1) 
} hal_dma_err_t;
 
typedef enum
{
    HAL_DMA_STATE_FREE = 0,  
    HAL_DMA_STATE_ALLOCATED  
} hal_dma_state_t;
 
typedef enum
{
    HAL_DMA_SOURCE_MEMORY_REGION_RAM      = 0,  
    HAL_DMA_SOURCE_MEMORY_REGION_PFM      = 1,  
    HAL_DMA_SOURCE_MEMORY_REGION_DEEPROM  = 2  
} hal_dma_source_memory_region_t;
 
typedef enum
{
    HAL_DMA_DIRECTION_MEMORY_TO_MEMORY = 0, 
    HAL_DMA_DIRECTION_MEMORY_TO_PERIPH,     
    HAL_DMA_DIRECTION_PERIPH_TO_MEMORY,     
    HAL_DMA_DIRECTION_PERIPH_TO_PERIPH,     
    HAL_DMA_DIRECTION_DEFAULT = HAL_DMA_DIRECTION_MEMORY_TO_MEMORY 
} hal_dma_direction_t;
 
typedef enum
{
    HAL_DMA_DATA_ALIGN_BYTES_1 = 0, 
    HAL_DMA_DATA_ALIGN_BYTES_2,    
    HAL_DMA_DATA_ALIGN_BYTES_3,    
    HAL_DMA_DATA_ALIGN_BYTES_4,    
    HAL_DMA_DATA_ALIGN_DEFAULT = HAL_DMA_DATA_ALIGN_BYTES_1 
} hal_dma_data_align_t;
 
typedef enum
{
    HAL_DMA_MODE_NORMAL = 0, 
    HAL_DMA_MODE_CIRCULAR,   
    HAL_DMA_MODE_DEFAULT = HAL_DMA_MODE_NORMAL 
} hal_dma_mode_t;
 
typedef enum
{
    HAL_DMA_PRIORITY_LOW = 0,   
    HAL_DMA_PRIORITY_MEDIUM,    
    HAL_DMA_PRIORITY_HIGH,      
    HAL_DMA_PRIORITY_VERY_HIGH, 
    HAL_DMA_PRIORITY_DEFAULT = HAL_DMA_PRIORITY_MEDIUM 
} hal_dma_priority_t;
 
typedef enum
{
    HAL_DMA_BURST_SIZE_INCREMENT_1 = 0, 
    HAL_DMA_BURST_SIZE_INCREMENT_2,     
    HAL_DMA_BURST_SIZE_INCREMENT_4,     
    HAL_DMA_BURST_SIZE_INCREMENT_8,     
    HAL_DMA_BURST_SIZE_INCREMENT_16,    
    HAL_DMA_BURST_SIZE_INCREMENT_32,    
    HAL_DMA_BURST_SIZE_INCREMENT_DEFAULT = HAL_DMA_BURST_SIZE_INCREMENT_1 
} hal_dma_burst_size_t;
 
typedef uint8_t hal_dma_channel_t[ DMA_NUM_OF_MODULES ][ DMA_NUM_OF_STREAMS_FAMILY ][ DMA_NUM_OF_CHANNELS_FAMILY ];
 
typedef struct
{
    uint8_t module;                             
    uint8_t stream;                             
    uint8_t channel;                            
    hal_dma_direction_t direction;              
    hal_dma_mode_t mode;                        
    bool source_inc;                            
    hal_dma_data_align_t data_align_source;     
    hal_dma_burst_size_t burst_size_source;     
    bool destination_inc;                           
    hal_dma_data_align_t data_align_destination;
    hal_dma_burst_size_t burst_size_destination;
    hal_dma_priority_t priority;                
    uint32_t addr_src;                          
    uint32_t addr_dst;                          
    size_t transfer_length;                     
} hal_dma_config_t;
 
typedef struct
{
    handle_t handle; 
    hal_dma_config_t config; 
    uint8_t module; 
    uint8_t stream; 
    uint8_t channel; 
    hal_dma_state_t allocated; 
    bool initialized; 
} hal_dma_t;
 
void hal_dma_configure_default( hal_dma_config_t *config );
 
err_t hal_dma_open( hal_dma_t *obj, hal_dma_config_t *config );
 
void hal_dma_get_channels( hal_dma_channel_t *channels );
 
err_t hal_dma_set_mode( hal_dma_t *obj, hal_dma_mode_t mode );
 
err_t hal_dma_set_direction( hal_dma_t *obj, hal_dma_direction_t direction );
 
err_t hal_dma_set_priority( hal_dma_t *obj, hal_dma_priority_t priority );
 
err_t hal_dma_set_transfer_config( hal_dma_t *obj, uint32_t addr_src, uint32_t addr_dst, size_t transfer_size, hal_dma_source_memory_region_t src_mem_type );
 
err_t hal_dma_transfer_start( hal_dma_t *obj );
 
err_t hal_dma_transfer_stop( hal_dma_t *obj );
 
err_t hal_dma_transfer_abort( hal_dma_t *obj );
 
err_t hal_dma_close( hal_dma_t *obj );
 
 // haldmagroup
 // halgroup
 // pergroup
 
#ifdef __cplusplus
}
#endif
 
#endif // _HAL_DMA_H_
// ------------------------------------------------------------------------- END