tool/mbed/mbed-sdk/libraries/mbed/targets/hal/TARGET_Freescale/TARGET_KPSDK_MCUS/TARGET_KPSDK_CODE/hal/dmamux/fsl_dmamux_hal.h

   1 /*
   2  * Copyright (c) 2013 - 2014, Freescale Semiconductor, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without modification,
   6  * are permitted provided that the following conditions are met:
   7  *
   8  * o Redistributions of source code must retain the above copyright notice, this list
   9  *   of conditions and the following disclaimer.
  10  *
  11  * o Redistributions in binary form must reproduce the above copyright notice, this
  12  *   list of conditions and the following disclaimer in the documentation and/or
  13  *   other materials provided with the distribution.
  14  *
  15  * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
  16  *   contributors may be used to endorse or promote products derived from this
  17  *   software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
  23  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  26  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  28  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30 #ifndef __FSL_DMAMUX_HAL_H__
  31 #define __FSL_DMAMUX_HAL_H__
  32
  33 #include <stdint.h>
  34 #include <stdbool.h>
  35 #include <assert.h>
  36 #include "fsl_dmamux_features.h"
  37 #include "fsl_device_registers.h"
  38
  39 /*!
  40  * @addtogroup dmamux_hal
  41  * @{
  42  */
  43
  44 /*******************************************************************************
  45  * Definitions
  46  ******************************************************************************/
  47 /*!
  48  * @brief A constant for the length of the DMA hardware source. This structure is used inside
  49  * the DMA driver.
  50  */
  51 typedef enum _dmamux_source {
  52     kDmamuxDmaRequestSource = 64U    /*!< Maximum number of the DMA requests allowed for the DMA mux. */
  53 } dmamux_dma_request_source;
  54
  55 /*******************************************************************************
  56  * API
  57  ******************************************************************************/
  58
  59 #if defined(__cplusplus)
  60 extern "C" {
  61 #endif
  62
  63 /*!
  64  * @name DMAMUX HAL function
  65  * @{
  66  */
  67
  68 /*!
  69  * @brief Initializes the DMAMUX module to the reset state.
  70  *
  71  * Initializes the DMAMUX module to the reset state.
  72  *
  73  * @param baseAddr Register base address for DMAMUX module.
  74  */
  75 void DMAMUX_HAL_Init(uint32_t baseAddr);
  76
  77 /*!
  78  * @brief Enables/Disables the DMAMUX channel.
  79  *
  80  * Enables the hardware request. If enabled, the hardware request is  sent to
  81  * the corresponding DMA channel.
  82  *
  83  * @param baseAddr Register base address for DMAMUX module.
  84  * @param channel DMAMUX channel number.
  85  * @param enable Enables (true) or Disables (false) DMAMUX channel.
  86  */
  87 static inline void DMAMUX_HAL_SetChannelCmd(uint32_t baseAddr, uint32_t channel, bool enable)
  88 {
  89     assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
  90     BW_DMAMUX_CHCFGn_ENBL(baseAddr, channel, enable);
  91 }
  92
  93
  94 /*!
  95  * @brief Enables/Disables the period trigger.
  96  *
  97  * @param baseAddr Register base address for DMAMUX module.
  98  * @param channel DMAMUX channel number.
  99  * @param enable Enables (true) or Disables (false) period trigger.
 100  */
 101 static inline void DMAMUX_HAL_SetPeriodTriggerCmd(uint32_t baseAddr, uint32_t channel, bool enable)
 102 {
 103     assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
 104     BW_DMAMUX_CHCFGn_TRIG(baseAddr, channel, enable);
 105 }
 106
 107
 108 /*!
 109  * @brief Configures the DMA request for the DMAMUX channel.
 110  *
 111  * Sets the trigger source for the DMA channel. The trigger source is in the file
 112  * fsl_dma_request.h.
 113  *
 114  * @param baseAddr Register base address for DMAMUX module.
 115  * @param channel DMAMUX channel number.
 116  * @param source DMA request source.
 117  */
 118 static inline void DMAMUX_HAL_SetTriggerSource(uint32_t baseAddr, uint32_t channel, uint8_t source)
 119 {
 120     assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
 121     BW_DMAMUX_CHCFGn_SOURCE(baseAddr, channel, source);
 122 }
 123
 124 /* @} */
 125
 126 #if defined(__cplusplus)
 127 }
 128 #endif
 129
 130 /*! @} */
 131
 132 #endif /* __FSL_DMAMUX_HAL_H__ */
 133 /*******************************************************************************
 134  * EOF
 135  ******************************************************************************/
 136