1 /** 2 * \file 3 * 4 * \brief Common SPI DMA related functionality declaration. 5 * 6 * Copyright (C) 2016 Atmel Corporation. All rights reserved. 7 * 8 * \asf_license_start 9 * 10 * \page License 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions are met: 14 * 15 * 1. Redistributions of source code must retain the above copyright notice, 16 * this list of conditions and the following disclaimer. 17 * 18 * 2. Redistributions in binary form must reproduce the above copyright notice, 19 * this list of conditions and the following disclaimer in the documentation 20 * and/or other materials provided with the distribution. 21 * 22 * 3. The name of Atmel may not be used to endorse or promote products derived 23 * from this software without specific prior written permission. 24 * 25 * 4. This software may only be redistributed and used in connection with an 26 * Atmel microcontroller product. 27 * 28 * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED 29 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 30 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE 31 * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR 32 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 36 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 37 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 38 * POSSIBILITY OF SUCH DAMAGE. 39 * 40 * \asf_license_stop 41 * 42 */ 43 44 #ifndef _HPL_SPI_DMA_H_INCLUDED 45 #define _HPL_SPI_DMA_H_INCLUDED 46 47 #include <hpl_irq.h> 48 #include <hpl_dma.h> 49 50 #ifdef __cplusplus 51 extern "C" { 52 #endif 53 54 /** The callback types */ 55 enum _spi_dma_dev_cb_type { 56 /** Callback type for DMA transmit. */ 57 SPI_DEV_CB_DMA_TX, 58 /** Callback type for DMA receive. */ 59 SPI_DEV_CB_DMA_RX, 60 /** Callback type for DMA error. */ 61 SPI_DEV_CB_DMA_ERROR, 62 /** Number of callbacks. */ 63 SPI_DEV_CB_DMA_N 64 }; 65 66 struct _spi_dma_dev; 67 68 /** 69 * \brief The prototype for callback on SPI DMA. 70 */ 71 typedef void (*_spi_dma_cb_t)(struct _dma_resource *resource); 72 73 /** 74 * \brief The callbacks offered by SPI driver 75 */ 76 struct _spi_dma_dev_callbacks { 77 _spi_dma_cb_t tx; 78 _spi_dma_cb_t rx; 79 _spi_dma_cb_t error; 80 }; 81 82 /** SPI driver to support DMA HAL */ 83 struct _spi_dma_dev { 84 /** Pointer to the hardware base or private data for special device. */ 85 void *prvt; 86 /** Pointer to callback functions */ 87 struct _spi_dma_dev_callbacks callbacks; 88 /** IRQ instance for SPI device. */ 89 struct _irq_descriptor irq; 90 /** DMA resource */ 91 struct _dma_resource *resource; 92 }; 93 94 #ifdef __cplusplus 95 } 96 #endif 97 98 #endif /* ifndef _HPL_SPI_DMA_H_INCLUDED */ 99
