1 /** 2 * \file 3 * 4 * \brief USART in SPI mode driver functions. 5 * 6 * Copyright (c) 2010-2015 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 * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a> 45 */ 46 #ifndef USART_SPI_H_INCLUDED 47 #define USART_SPI_H_INCLUDED 48 49 #include <parts.h> 50 51 #if XMEGA 52 # include "xmega_usart_spi/usart_spi.h" 53 #elif MEGA_RF 54 # include "megarf_usart_spi/usart_spi.h" 55 #elif UC3 56 # include "uc3_usart_spi/usart_spi.h" 57 #elif SAM 58 # include "sam_usart_spi/usart_spi.h" 59 #else 60 # error Unsupported chip type 61 #endif 62 63 /** 64 * 65 * \defgroup usart_spi_group USART in SPI (Serial Peripheral Interface) mode 66 * 67 * This is the common API for USART in SPI mode. Additional features are available 68 * in the documentation of the specific modules. 69 * 70 * \section spi_group_platform Platform Dependencies 71 * 72 * The spi API is partially chip- or platform-specific. While all 73 * platforms provide mostly the same functionality, there are some 74 * variations around how different bus types and clock tree structures 75 * are handled. 76 * 77 * The following functions are available on all platforms, but there may 78 * be variations in the function signature (i.e. parameters) and 79 * behaviour. These functions are typically called by platform-specific 80 * parts of drivers, and applications that aren't intended to be 81 * portable: 82 * - usart_spi_init() 83 * - usart_spi_setup_device() 84 * - usart_spi_select_device() 85 * - usart_spi_deselect_device() 86 * - usart_spi_write_single() 87 * - usart_spi_write_packet() 88 * - usart_spi_read_single() 89 * - usart_spi_read_packet() 90 * - usart_spi_is_tx_empty() 91 * - usart_spi_is_tx_ready() 92 * - usart_spi_is_rx_full() 93 * - usart_spi_is_rx_ready() 94 * - usart_spi_enable() 95 * - usart_spi_disable() 96 * - usart_spi_is_enabled() 97 * 98 * 99 * @{ 100 */ 101 102 //! @} 103 104 #endif /* USART_SPI_H_INCLUDED */ 105