mbed library sources. Supersedes mbed-src.
Fork of mbed-dev by
targets/TARGET_Atmel/TARGET_SAM_CortexM0P/dma_api_HAL.h@153:9398a535854b, 2016-12-22 (annotated)
- Committer:
- fwndz
- Date:
- Thu Dec 22 05:12:40 2016 +0000
- Revision:
- 153:9398a535854b
- Parent:
- 149:156823d33999
device target maximize
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
mbed_official | 15:a81a8d6c1dfe | 1 | /* mbed Microcontroller Library |
mbed_official | 15:a81a8d6c1dfe | 2 | * Copyright (c) 2006-2015 ARM Limited |
mbed_official | 15:a81a8d6c1dfe | 3 | * |
mbed_official | 15:a81a8d6c1dfe | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
mbed_official | 15:a81a8d6c1dfe | 5 | * you may not use this file except in compliance with the License. |
mbed_official | 15:a81a8d6c1dfe | 6 | * You may obtain a copy of the License at |
mbed_official | 15:a81a8d6c1dfe | 7 | * |
mbed_official | 15:a81a8d6c1dfe | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
mbed_official | 15:a81a8d6c1dfe | 9 | * |
mbed_official | 15:a81a8d6c1dfe | 10 | * Unless required by applicable law or agreed to in writing, software |
mbed_official | 15:a81a8d6c1dfe | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
mbed_official | 15:a81a8d6c1dfe | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
mbed_official | 15:a81a8d6c1dfe | 13 | * See the License for the specific language governing permissions and |
mbed_official | 15:a81a8d6c1dfe | 14 | * limitations under the License. |
mbed_official | 15:a81a8d6c1dfe | 15 | */ |
mbed_official | 15:a81a8d6c1dfe | 16 | |
mbed_official | 15:a81a8d6c1dfe | 17 | #ifndef _DMA_API_HAL_H |
mbed_official | 15:a81a8d6c1dfe | 18 | #define _DMA_API_HAL_H |
mbed_official | 15:a81a8d6c1dfe | 19 | |
mbed_official | 15:a81a8d6c1dfe | 20 | #ifdef __cplusplus |
mbed_official | 15:a81a8d6c1dfe | 21 | extern "C" { |
mbed_official | 15:a81a8d6c1dfe | 22 | #endif |
mbed_official | 15:a81a8d6c1dfe | 23 | |
mbed_official | 15:a81a8d6c1dfe | 24 | #include <compiler.h> |
mbed_official | 15:a81a8d6c1dfe | 25 | #include "dma.h" |
mbed_official | 15:a81a8d6c1dfe | 26 | |
mbed_official | 15:a81a8d6c1dfe | 27 | enum dma_status_flags { |
mbed_official | 15:a81a8d6c1dfe | 28 | DMA_NOT_USED = (uint32_t)1, |
mbed_official | 15:a81a8d6c1dfe | 29 | DMA_ALLOCATED = (DMA_NOT_USED << 1), |
mbed_official | 15:a81a8d6c1dfe | 30 | DMA_TEMPORARY = (DMA_NOT_USED << 2), |
mbed_official | 15:a81a8d6c1dfe | 31 | DMA_ERROR = (DMA_NOT_USED << 3), |
mbed_official | 15:a81a8d6c1dfe | 32 | }; |
mbed_official | 15:a81a8d6c1dfe | 33 | |
mbed_official | 15:a81a8d6c1dfe | 34 | /* No other capabilities supported now */ |
mbed_official | 15:a81a8d6c1dfe | 35 | #define DMA_CAP_NONE 0 |
mbed_official | 15:a81a8d6c1dfe | 36 | |
mbed_official | 15:a81a8d6c1dfe | 37 | #define DMA_ADDRESS_INC_DISABLE 0 |
mbed_official | 15:a81a8d6c1dfe | 38 | #define DMA_ADDRESS_INC_ENABLE 1 |
mbed_official | 15:a81a8d6c1dfe | 39 | |
mbed_official | 15:a81a8d6c1dfe | 40 | #define DMA_TRANSFER_ERROR ((uint32_t)1 << 1) |
mbed_official | 15:a81a8d6c1dfe | 41 | #define DMA_TRANSFER_COMPLETE ((uint32_t)1 << 2) |
mbed_official | 15:a81a8d6c1dfe | 42 | |
mbed_official | 15:a81a8d6c1dfe | 43 | #define DMA_EVENT_ALL (DMA_TRANSFER_ERROR | DMA_TRANSFER_COMPLETE) |
mbed_official | 15:a81a8d6c1dfe | 44 | |
mbed_official | 15:a81a8d6c1dfe | 45 | |
mbed_official | 15:a81a8d6c1dfe | 46 | COMPILER_ALIGNED(16) |
mbed_official | 15:a81a8d6c1dfe | 47 | struct dma_instance_s { |
mbed_official | 15:a81a8d6c1dfe | 48 | struct dma_resource resource; |
mbed_official | 15:a81a8d6c1dfe | 49 | DmacDescriptor descriptor; |
mbed_official | 15:a81a8d6c1dfe | 50 | uint8_t status; |
mbed_official | 15:a81a8d6c1dfe | 51 | uint32_t events; |
mbed_official | 15:a81a8d6c1dfe | 52 | uint32_t handler; |
mbed_official | 15:a81a8d6c1dfe | 53 | }; |
mbed_official | 15:a81a8d6c1dfe | 54 | |
mbed_official | 15:a81a8d6c1dfe | 55 | /** Setup a DMA descriptor for specified resource |
mbed_official | 15:a81a8d6c1dfe | 56 | * |
mbed_official | 15:a81a8d6c1dfe | 57 | * @param[in] channel_index DMA channel id |
mbed_official | 15:a81a8d6c1dfe | 58 | * @param[in] src source address |
mbed_official | 15:a81a8d6c1dfe | 59 | * @param[in] src_inc_enable source address auto increment enable flag |
mbed_official | 15:a81a8d6c1dfe | 60 | * @param[in] desc destination address |
mbed_official | 15:a81a8d6c1dfe | 61 | * @param[in] desc_inc_enable destination address auto increment enable flag |
mbed_official | 15:a81a8d6c1dfe | 62 | * @param[in] length length of data to be transferred |
mbed_official | 15:a81a8d6c1dfe | 63 | * @param[in] beat_size beat size to be set |
mbed_official | 15:a81a8d6c1dfe | 64 | * @return void |
mbed_official | 15:a81a8d6c1dfe | 65 | */ |
mbed_official | 15:a81a8d6c1dfe | 66 | void dma_setup_transfer(uint8_t channelid, uint32_t src, bool src_inc_enable, uint32_t desc, bool desc_inc_enable, uint32_t length, uint8_t beat_size); |
mbed_official | 15:a81a8d6c1dfe | 67 | |
mbed_official | 15:a81a8d6c1dfe | 68 | /** Start DMA transfer |
mbed_official | 15:a81a8d6c1dfe | 69 | * |
mbed_official | 15:a81a8d6c1dfe | 70 | * Kick starts transfer in DMA channel with specified channel id |
mbed_official | 15:a81a8d6c1dfe | 71 | * @param[in] channelid Channel id of DMA channel |
mbed_official | 15:a81a8d6c1dfe | 72 | * @return non zero if success otherwise zero |
mbed_official | 15:a81a8d6c1dfe | 73 | */ |
mbed_official | 15:a81a8d6c1dfe | 74 | bool dma_start_transfer(int channelid); |
mbed_official | 15:a81a8d6c1dfe | 75 | |
mbed_official | 15:a81a8d6c1dfe | 76 | /** DMA channel busy check |
mbed_official | 15:a81a8d6c1dfe | 77 | * |
mbed_official | 15:a81a8d6c1dfe | 78 | * To check whether DMA channel is busy with a job or not |
mbed_official | 15:a81a8d6c1dfe | 79 | * @param[in] channelid Channel id of DMA channel |
mbed_official | 15:a81a8d6c1dfe | 80 | * @return non zero if busy otherwise zero |
mbed_official | 15:a81a8d6c1dfe | 81 | */ |
mbed_official | 15:a81a8d6c1dfe | 82 | bool dma_busy(int channelid); |
mbed_official | 15:a81a8d6c1dfe | 83 | |
mbed_official | 15:a81a8d6c1dfe | 84 | /** DMA channel transfer completion check |
mbed_official | 15:a81a8d6c1dfe | 85 | * |
mbed_official | 15:a81a8d6c1dfe | 86 | * To check whether DMA channel job is completed or not |
mbed_official | 15:a81a8d6c1dfe | 87 | * @param[in] channelid Channel id of DMA channel |
mbed_official | 15:a81a8d6c1dfe | 88 | * @return non zero if busy otherwise zero |
mbed_official | 15:a81a8d6c1dfe | 89 | */ |
mbed_official | 15:a81a8d6c1dfe | 90 | bool dma_is_transfer_complete(int channelid); |
mbed_official | 15:a81a8d6c1dfe | 91 | |
mbed_official | 15:a81a8d6c1dfe | 92 | /** Registers callback function for DMA |
mbed_official | 15:a81a8d6c1dfe | 93 | * |
mbed_official | 15:a81a8d6c1dfe | 94 | * Registers callback function for DMA for specified events |
mbed_official | 15:a81a8d6c1dfe | 95 | * @param[in] channelid Channel id of DMA channel |
mbed_official | 15:a81a8d6c1dfe | 96 | * @param[in] handler Callback function pointer |
mbed_official | 15:a81a8d6c1dfe | 97 | * @param[in] event Events mask |
mbed_official | 15:a81a8d6c1dfe | 98 | * @return void |
mbed_official | 15:a81a8d6c1dfe | 99 | */ |
mbed_official | 15:a81a8d6c1dfe | 100 | void dma_set_handler(int channelid, uint32_t handler, uint32_t event); |
mbed_official | 15:a81a8d6c1dfe | 101 | |
mbed_official | 15:a81a8d6c1dfe | 102 | #ifdef __cplusplus |
mbed_official | 15:a81a8d6c1dfe | 103 | } |
mbed_official | 15:a81a8d6c1dfe | 104 | #endif |
mbed_official | 15:a81a8d6c1dfe | 105 | |
mbed_official | 64:41a834223ea3 | 106 | #endif /* _DMA_API_HAL_H */ |