dma_api.h

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