1 /** 2 * \file 3 * 4 * \brief SAM USART in SPI mode driver functions. 5 * 6 * Copyright (c) 2011-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 47 #ifndef _USART_SPI_H_ 48 #define _USART_SPI_H_ 49 50 #include "compiler.h" 51 #include "usart.h" 52 53 /// @cond 0 54 /**INDENT-OFF**/ 55 #ifdef __cplusplus 56 extern "C" { 57 #endif 58 /**INDENT-ON**/ 59 /// @endcond 60 61 /*! \name USART in SPI mode Management Configuration. 62 */ 63 //! @{ 64 #include "conf_usart_spi.h" 65 66 //! Default Configuration of SPI Master Dummy Field 67 #ifndef CONFIG_USART_SPI_DUMMY 68 #define CONFIG_USART_SPI_DUMMY 0xFF 69 #endif 70 //! @} 71 72 #ifndef SPI_TYPE_DEFS 73 #define SPI_TYPE_DEFS 74 //! SPI Flags Definition 75 typedef uint8_t spi_flags_t; 76 77 //! Board SPI Select Id Definition 78 typedef uint32_t board_spi_select_id_t; 79 #endif 80 81 typedef uint8_t port_pin_t; 82 83 //! \brief Polled SPI device definition. 84 struct usart_spi_device { 85 /* Board specific select id. */ 86 port_pin_t id; 87 }; 88 89 void usart_spi_init(Usart *p_usart); 90 void usart_spi_setup_device(Usart *p_usart, struct usart_spi_device *device, 91 spi_flags_t flags, unsigned long baud_rate, board_spi_select_id_t sel_id); 92 void usart_spi_write_single(Usart *p_usart, uint8_t data); 93 uint32_t usart_spi_write_packet(Usart *p_usart, const uint8_t *data, size_t len); 94 void usart_spi_read_single(Usart *p_usart, uint8_t *data); 95 uint32_t usart_spi_read_packet(Usart *p_usart, uint8_t *data, size_t len); 96 void usart_spi_select_device(Usart *p_usart, struct usart_spi_device *device); 97 void usart_spi_deselect_device(Usart *p_usart, struct usart_spi_device *device); 98 uint32_t usart_spi_is_tx_empty(Usart *p_usart); 99 uint32_t usart_spi_is_rx_ready(Usart *p_usart); 100 uint32_t usart_spi_is_tx_ready(Usart *p_usart); 101 uint32_t usart_spi_is_rx_full(Usart *p_usart); 102 void usart_spi_enable(Usart *p_usart); 103 void usart_spi_disable(Usart *p_usart); 104 105 /// @cond 0 106 /**INDENT-OFF**/ 107 #ifdef __cplusplus 108 } 109 #endif 110 /**INDENT-ON**/ 111 /// @endcond 112 113 #endif /* _USART_SPI_H_ */ 114