dma_api.h

00001 
00002 /** \addtogroup hal */
00003 /** @{*/
00004 /* mbed Microcontroller Library
00005  * Copyright (c) 2014-2015 ARM Limited
00006  *
00007  * Licensed under the Apache License, Version 2.0 (the "License");
00008  * you may not use this file except in compliance with the License.
00009  * You may obtain a copy of the License at
00010  *
00011  *     http://www.apache.org/licenses/LICENSE-2.0
00012  *
00013  * Unless required by applicable law or agreed to in writing, software
00014  * distributed under the License is distributed on an "AS IS" BASIS,
00015  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00016  * See the License for the specific language governing permissions and
00017  * limitations under the License.
00018  */
00019 #ifndef MBED_DMA_API_H
00020 #define MBED_DMA_API_H
00021 
00022 #include <stdint.h>
00023 
00024 #define DMA_ERROR_OUT_OF_CHANNELS (-1)
00025 
00026 typedef enum {
00027     DMA_USAGE_NEVER,
00028     DMA_USAGE_OPPORTUNISTIC,
00029     DMA_USAGE_ALWAYS,
00030     DMA_USAGE_TEMPORARY_ALLOCATED,
00031     DMA_USAGE_ALLOCATED
00032 } DMAUsage;
00033 
00034 #ifdef __cplusplus
00035 extern "C" {
00036 #endif
00037 
00038 void dma_init(void);
00039 
00040 int dma_channel_allocate(uint32_t capabilities);
00041 
00042 int dma_channel_free(int channelid);
00043 
00044 #ifdef __cplusplus
00045 }
00046 #endif
00047 
00048 #endif
00049 
00050 /** @}*/