mbed official
mbed library sources
Dependents: Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more
Superseded
This library was superseded by mbed-dev - https://os.mbed.com/users/mbed_official/code/mbed-dev/.
Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.
If you are looking for a stable and tested release, please import one of the official mbed library releases:
Import librarymbed
The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.
Last commit 20 Feb 2019 by 
mbed official
targets/hal/TARGET_Atmel/TARGET_SAM21/drivers/dma/quick_start/qs_dma_basic.h@579:53297373a894, 2015-07-01 (annotated)
- Committer:
- mbed_official
- Date:
- Wed Jul 01 09:45:11 2015 +0100
- Revision:
- 579:53297373a894
- Child:
- 592:a274ee790e56
Synchronized with git revision d5b4d2ab9c47edb4dc5776e7177b0c2263459081
Full URL: https://github.com/mbedmicro/mbed/commit/d5b4d2ab9c47edb4dc5776e7177b0c2263459081/
Initial version of drivers for SAMR21
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| mbed_official | 579:53297373a894 | 1 | /** |
| mbed_official | 579:53297373a894 | 2 | * \file |
| mbed_official | 579:53297373a894 | 3 | * |
| mbed_official | 579:53297373a894 | 4 | * \brief SAM Direct Memory Access Controller(DMAC) Driver Quick Start |
| mbed_official | 579:53297373a894 | 5 | * |
| mbed_official | 579:53297373a894 | 6 | * Copyright (C) 2014 Atmel Corporation. All rights reserved. |
| mbed_official | 579:53297373a894 | 7 | * |
| mbed_official | 579:53297373a894 | 8 | * \asf_license_start |
| mbed_official | 579:53297373a894 | 9 | * |
| mbed_official | 579:53297373a894 | 10 | * \page License |
| mbed_official | 579:53297373a894 | 11 | * |
| mbed_official | 579:53297373a894 | 12 | * Redistribution and use in source and binary forms, with or without |
| mbed_official | 579:53297373a894 | 13 | * modification, are permitted provided that the following conditions are met: |
| mbed_official | 579:53297373a894 | 14 | * |
| mbed_official | 579:53297373a894 | 15 | * 1. Redistributions of source code must retain the above copyright notice, |
| mbed_official | 579:53297373a894 | 16 | * this list of conditions and the following disclaimer. |
| mbed_official | 579:53297373a894 | 17 | * |
| mbed_official | 579:53297373a894 | 18 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
| mbed_official | 579:53297373a894 | 19 | * this list of conditions and the following disclaimer in the documentation |
| mbed_official | 579:53297373a894 | 20 | * and/or other materials provided with the distribution. |
| mbed_official | 579:53297373a894 | 21 | * |
| mbed_official | 579:53297373a894 | 22 | * 3. The name of Atmel may not be used to endorse or promote products derived |
| mbed_official | 579:53297373a894 | 23 | * from this software without specific prior written permission. |
| mbed_official | 579:53297373a894 | 24 | * |
| mbed_official | 579:53297373a894 | 25 | * 4. This software may only be redistributed and used in connection with an |
| mbed_official | 579:53297373a894 | 26 | * Atmel microcontroller product. |
| mbed_official | 579:53297373a894 | 27 | * |
| mbed_official | 579:53297373a894 | 28 | * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED |
| mbed_official | 579:53297373a894 | 29 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| mbed_official | 579:53297373a894 | 30 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE |
| mbed_official | 579:53297373a894 | 31 | * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR |
| mbed_official | 579:53297373a894 | 32 | * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| mbed_official | 579:53297373a894 | 33 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| mbed_official | 579:53297373a894 | 34 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| mbed_official | 579:53297373a894 | 35 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
| mbed_official | 579:53297373a894 | 36 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
| mbed_official | 579:53297373a894 | 37 | * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| mbed_official | 579:53297373a894 | 38 | * POSSIBILITY OF SUCH DAMAGE. |
| mbed_official | 579:53297373a894 | 39 | * |
| mbed_official | 579:53297373a894 | 40 | * \asf_license_stop |
| mbed_official | 579:53297373a894 | 41 | * |
| mbed_official | 579:53297373a894 | 42 | */ |
| mbed_official | 579:53297373a894 | 43 | |
| mbed_official | 579:53297373a894 | 44 | /** |
| mbed_official | 579:53297373a894 | 45 | * \page asfdoc_sam0_dma_basic_use_case Quick Start Guide for Memory to Memory Data Transfer Using DMAC |
| mbed_official | 579:53297373a894 | 46 | * |
| mbed_official | 579:53297373a894 | 47 | * The supported board list: |
| mbed_official | 579:53297373a894 | 48 | * - SAMD21 Xplained Pro |
| mbed_official | 579:53297373a894 | 49 | * - SAMR21 Xplained Pro |
| mbed_official | 579:53297373a894 | 50 | * - SAMD11 Xplained Pro |
| mbed_official | 579:53297373a894 | 51 | * - SAML21 Xplained Pro |
| mbed_official | 579:53297373a894 | 52 | * |
| mbed_official | 579:53297373a894 | 53 | * In this use case, the DMAC is configured for: |
| mbed_official | 579:53297373a894 | 54 | * \li Moving data from memory to memory |
| mbed_official | 579:53297373a894 | 55 | * \li Using software trigger |
| mbed_official | 579:53297373a894 | 56 | * \li Using DMA priority level 0 |
| mbed_official | 579:53297373a894 | 57 | * \li Transaction as DMA trigger action |
| mbed_official | 579:53297373a894 | 58 | * \li No action on input events |
| mbed_official | 579:53297373a894 | 59 | * \li Output event not enabled |
| mbed_official | 579:53297373a894 | 60 | * |
| mbed_official | 579:53297373a894 | 61 | * \section asfdoc_sam0_dma_basic_use_case_setup Setup |
| mbed_official | 579:53297373a894 | 62 | * |
| mbed_official | 579:53297373a894 | 63 | * \subsection asfdoc_sam0_dma_basic_use_casesetup_prereq Prerequisites |
| mbed_official | 579:53297373a894 | 64 | * There are no special setup requirements for this use-case. |
| mbed_official | 579:53297373a894 | 65 | * |
| mbed_official | 579:53297373a894 | 66 | * \subsection asfdoc_sam0_dma_basic_use_casesetup_code Code |
| mbed_official | 579:53297373a894 | 67 | * Copy-paste the following setup code to your user application: |
| mbed_official | 579:53297373a894 | 68 | * \snippet qs_dma_basic.c setup |
| mbed_official | 579:53297373a894 | 69 | * |
| mbed_official | 579:53297373a894 | 70 | * Add the below section to user application initialization (typically the |
| mbed_official | 579:53297373a894 | 71 | * start of \c main()): |
| mbed_official | 579:53297373a894 | 72 | * \snippet qs_dma_basic.c setup_init |
| mbed_official | 579:53297373a894 | 73 | * |
| mbed_official | 579:53297373a894 | 74 | * \subsection asfdoc_sam0_dma_basic_use_casesetup_flow Workflow |
| mbed_official | 579:53297373a894 | 75 | * -# Create a DMA resource configuration structure, which can be filled out to |
| mbed_official | 579:53297373a894 | 76 | * adjust the configuration of a single DMA transfer. |
| mbed_official | 579:53297373a894 | 77 | * \snippet qs_dma_basic.c setup_1 |
| mbed_official | 579:53297373a894 | 78 | * \br |
| mbed_official | 579:53297373a894 | 79 | * |
| mbed_official | 579:53297373a894 | 80 | * -# Initialize the DMA resource configuration struct with the module's |
| mbed_official | 579:53297373a894 | 81 | * default values. |
| mbed_official | 579:53297373a894 | 82 | * \snippet qs_dma_basic.c setup_2 |
| mbed_official | 579:53297373a894 | 83 | * \note This should always be performed before using the configuration |
| mbed_official | 579:53297373a894 | 84 | * struct to ensure that all values are initialized to known default |
| mbed_official | 579:53297373a894 | 85 | * settings. |
| mbed_official | 579:53297373a894 | 86 | * |
| mbed_official | 579:53297373a894 | 87 | * -# Allocate a DMA resource with the configurations. |
| mbed_official | 579:53297373a894 | 88 | * \snippet qs_dma_basic.c setup_3 |
| mbed_official | 579:53297373a894 | 89 | * \br |
| mbed_official | 579:53297373a894 | 90 | |
| mbed_official | 579:53297373a894 | 91 | * -# Declare a DMA transfer descriptor configuration structure, which can be |
| mbed_official | 579:53297373a894 | 92 | * filled out to adjust the configuration of a single DMA transfer. |
| mbed_official | 579:53297373a894 | 93 | * \snippet qs_dma_basic.c setup_4 |
| mbed_official | 579:53297373a894 | 94 | * \br |
| mbed_official | 579:53297373a894 | 95 | * |
| mbed_official | 579:53297373a894 | 96 | * -# Initialize the DMA transfer descriptor configuration struct with the |
| mbed_official | 579:53297373a894 | 97 | * module's default values. |
| mbed_official | 579:53297373a894 | 98 | * \snippet qs_dma_basic.c setup_5 |
| mbed_official | 579:53297373a894 | 99 | * \note This should always be performed before using the configuration |
| mbed_official | 579:53297373a894 | 100 | * struct to ensure that all values are initialized to known default |
| mbed_official | 579:53297373a894 | 101 | * settings. |
| mbed_official | 579:53297373a894 | 102 | * |
| mbed_official | 579:53297373a894 | 103 | * -# Set the specific parameters for a DMA transfer with transfer size, source |
| mbed_official | 579:53297373a894 | 104 | * address, and destination address. In this example, we have enabled the |
| mbed_official | 579:53297373a894 | 105 | * source and destination address increment. |
| mbed_official | 579:53297373a894 | 106 | * The source and destination addresses to be stored into descriptor_config |
| mbed_official | 579:53297373a894 | 107 | * must correspond to the end of the transfer. |
| mbed_official | 579:53297373a894 | 108 | * |
| mbed_official | 579:53297373a894 | 109 | * \snippet qs_dma_basic.c setup_6 |
| mbed_official | 579:53297373a894 | 110 | * \br |
| mbed_official | 579:53297373a894 | 111 | * |
| mbed_official | 579:53297373a894 | 112 | * -# Create the DMA transfer descriptor. |
| mbed_official | 579:53297373a894 | 113 | * \snippet qs_dma_basic.c setup_7 |
| mbed_official | 579:53297373a894 | 114 | * \br |
| mbed_official | 579:53297373a894 | 115 | * |
| mbed_official | 579:53297373a894 | 116 | * -# Add the DMA transfer descriptor to the allocated DMA resource. |
| mbed_official | 579:53297373a894 | 117 | * \snippet qs_dma_basic.c add_descriptor_to_dma_resource |
| mbed_official | 579:53297373a894 | 118 | * \br |
| mbed_official | 579:53297373a894 | 119 | * |
| mbed_official | 579:53297373a894 | 120 | * -# Register a callback to indicate transfer status. |
| mbed_official | 579:53297373a894 | 121 | * \snippet qs_dma_basic.c setup_callback_register |
| mbed_official | 579:53297373a894 | 122 | * \br |
| mbed_official | 579:53297373a894 | 123 | * |
| mbed_official | 579:53297373a894 | 124 | * -# Set the transfer done flag in the registered callback function. |
| mbed_official | 579:53297373a894 | 125 | * \snippet qs_dma_basic.c _transfer_done |
| mbed_official | 579:53297373a894 | 126 | * \br |
| mbed_official | 579:53297373a894 | 127 | * |
| mbed_official | 579:53297373a894 | 128 | * -# Enable the registered callbacks. |
| mbed_official | 579:53297373a894 | 129 | * \snippet qs_dma_basic.c setup_enable_callback |
| mbed_official | 579:53297373a894 | 130 | * \br |
| mbed_official | 579:53297373a894 | 131 | * |
| mbed_official | 579:53297373a894 | 132 | * \section asfdoc_sam0_dma_basic_use_case_main Use Case |
| mbed_official | 579:53297373a894 | 133 | * |
| mbed_official | 579:53297373a894 | 134 | * \subsection asfdoc_sam0_dma_basic_use_casecode_code Code |
| mbed_official | 579:53297373a894 | 135 | * Add the following code at the start of \c main(): |
| mbed_official | 579:53297373a894 | 136 | * \snippet qs_dma_basic.c sample_resource |
| mbed_official | 579:53297373a894 | 137 | * Copy the following code to your user application: |
| mbed_official | 579:53297373a894 | 138 | * \snippet qs_dma_basic.c main |
| mbed_official | 579:53297373a894 | 139 | * |
| mbed_official | 579:53297373a894 | 140 | * \subsection dma_basic_use_case_code_flow Workflow |
| mbed_official | 579:53297373a894 | 141 | * -# Start the DMA transfer job with the allocated DMA resource and |
| mbed_official | 579:53297373a894 | 142 | * transfer descriptor. |
| mbed_official | 579:53297373a894 | 143 | * \snippet qs_dma_basic.c main_1 |
| mbed_official | 579:53297373a894 | 144 | * |
| mbed_official | 579:53297373a894 | 145 | * -# Set the software trigger for the DMA channel. This can be done before |
| mbed_official | 579:53297373a894 | 146 | * or after the DMA job is started. Note that all transfers needs a trigger |
| mbed_official | 579:53297373a894 | 147 | * to start. |
| mbed_official | 579:53297373a894 | 148 | * \snippet qs_dma_basic.c main_1_1 |
| mbed_official | 579:53297373a894 | 149 | * |
| mbed_official | 579:53297373a894 | 150 | * -# Waiting for the setting of the transfer done flag. |
| mbed_official | 579:53297373a894 | 151 | * \snippet qs_dma_basic.c main_2 |
| mbed_official | 579:53297373a894 | 152 | */ |
| mbed_official | 579:53297373a894 | 153 | /** |
| mbed_official | 579:53297373a894 | 154 | * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a> |
| mbed_official | 579:53297373a894 | 155 | */ |
