dma_template.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *     http://www.apache.org/licenses/LICENSE-2.0                            *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 ****************************************************************************/
 
/*============================ INCLUDES ======================================*/
/*============================ MACROFIED FUNCTIONS ===========================*/
 
#define VSF_HAL_TEMPLATE_DEC_NAME                   _dma
#define VSF_HAL_TEMPLATE_DEC_UPCASE_NAME            _DMA
 
#ifndef __VSF_TEMPLATE_DMA_H__
#   error "Please include \"vsf_template_dma.h\" before include dma_template.h"
#endif
 
#if !defined(VSF_DMA_CFG_DEC_PREFIX) && !defined(VSF_DMA_CFG_DEC_DEVICE_PREFIX)
#   error "Please define VSF_DMA_CFG_DEC_PREFIX or VSF_DMA_CFG_DEC_DEVICE_PREFIX before include dma_template.h"
#endif
 
#if !defined(VSF_DMA_CFG_DEC_UPCASE_PREFIX) && !defined(VSF_DMA_CFG_DEC_DEVICE_UPCASE_PREFIX)
#   error "Please define VSF_DMA_CFG_DEC_UPCASE_PREFIX or VSF_DMA_CFG_DEC_DEVICE_UPCASE_PREFIX before include dma_template.h"
#endif
 
#ifndef VSF_DMA_CFG_DEC_REMAP_PREFIX
#   define VSF_DMA_CFG_DEC_REMAP_PREFIX             VSF_DMA_CFG_DEC_PREFIX
#endif
 
#ifndef VSF_DMA_CFG_DEC_COUNT_MASK_PREFIX
#   define VSF_DMA_CFG_DEC_COUNT_MASK_PREFIX        VSF_DMA_CFG_DEC_UPCASE_PREFIX
#endif
 
#define VSF_HAL_TEMPLATE_DEC_INSTANCE_APIS(__prefix_name)                                       \
    VSF_DMA_APIS(__prefix_name)                                                                  \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_dma_t *, dma, channel_acquire_from_all, vsf_dma_channel_hint_t *channel_hint_ptr)
 
#include "hal/driver/common/template/vsf_template_instance_declaration.h"
 
#undef VSF_DMA_CFG_DEC_PREFIX
#undef VSF_DMA_CFG_DEC_UPCASE_PREFIX
#undef VSF_DMA_CFG_DEC_DEVICE_PREFIX
#undef VSF_DMA_CFG_DEC_DEVICE_UPCASE_PREFIX
#undef VSF_DMA_CFG_DEC_RENAME_DEVICE_PREFIX
#undef VSF_DMA_CFG_DEC_COUNT_MASK_PREFIX
#undef VSF_DMA_CFG_DEC_REMAP_PREFIX
#undef VSF_DMA_CFG_DEC_EXTERN_OP