1 /** 2 * \file 3 * 4 * \brief Common GPIO API. 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 _GPIO_H_ 47 #define _GPIO_H_ 48 49 #include <parts.h> 50 51 #if (SAM3S || SAM3U || SAM3N || SAM3XA || SAM4S || SAM4E || SAM4N || SAM4C || SAMG || SAM4CP || SAM4CM || SAMV71 || SAMV70 || SAME70 || SAMS70) 52 # include "sam_gpio/sam_gpio.h" 53 #elif XMEGA 54 # include "xmega_gpio/xmega_gpio.h" 55 #elif MEGA || MEGA_RF 56 # include "mega_gpio/mega_gpio.h" 57 #else 58 # error Unsupported chip type 59 #endif 60 61 /** 62 * \defgroup gpio_group General Purpose Input/Output 63 * 64 * This is the common API for GPIO. Additional features are available 65 * in the documentation of the specific modules. 66 * 67 * \section io_group_platform Platform Dependencies 68 * 69 * The following functions are available on all platforms, but there may 70 * be variations in the function signature (i.e. parameters) and 71 * behaviour. These functions are typically called by platform-specific 72 * parts of drivers, and applications that aren't intended to be 73 * portable: 74 * - gpio_pin_is_low() 75 * - gpio_pin_is_high() 76 * - gpio_set_pin_high() 77 * - gpio_set_pin_group_high() 78 * - gpio_set_pin_low() 79 * - gpio_set_pin_group_low() 80 * - gpio_toggle_pin() 81 * - gpio_toggle_pin_group() 82 * - gpio_configure_pin() 83 * - gpio_configure_group() 84 */ 85 86 #endif /* _GPIO_H_ */ 87