git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_ATSAM3S-EK2_Atmel_Studio/src/asf/common/services/gpio/gpio.h

   1 /**\r
   2  * \file\r
   3  *\r
   4  * \brief Common GPIO API.\r
   5  *\r
   6  * Copyright (c) 2010 Atmel Corporation. All rights reserved.\r
   7  *\r
   8  * \asf_license_start\r
   9  *\r
  10  * \page License\r
  11  *\r
  12  * Redistribution and use in source and binary forms, with or without\r
  13  * modification, are permitted provided that the following conditions are met:\r
  14  *\r
  15  * 1. Redistributions of source code must retain the above copyright notice,\r
  16  *    this list of conditions and the following disclaimer.\r
  17  *\r
  18  * 2. Redistributions in binary form must reproduce the above copyright notice,\r
  19  *    this list of conditions and the following disclaimer in the documentation\r
  20  *    and/or other materials provided with the distribution.\r
  21  *\r
  22  * 3. The name of Atmel may not be used to endorse or promote products derived\r
  23  *    from this software without specific prior written permission.\r
  24  *\r
  25  * 4. This software may only be redistributed and used in connection with an\r
  26  *    Atmel microcontroller product.\r
  27  *\r
  28  * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED\r
  29  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  30  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE\r
  31  * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR\r
  32  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
  33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS\r
  34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
  35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,\r
  36  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN\r
  37  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
  38  * POSSIBILITY OF SUCH DAMAGE.\r
  39  *\r
  40  * \asf_license_stop\r
  41  *\r
  42  */\r
  43 #ifndef _GPIO_H_\r
  44 #define _GPIO_H_\r
  45 \r
  46 #include <parts.h>\r
  47 \r
  48 #if ( SAM3S || SAM3U || SAM3N || SAM3XA || SAM4S )\r
  49 # include "sam_ioport/sam_gpio.h"\r
  50 #elif XMEGA\r
  51 # include "xmega_ioport/xmega_gpio.h"\r
  52 #else\r
  53 # error Unsupported chip type\r
  54 #endif\r
  55 \r
  56 \r
  57 /**\r
  58  * \defgroup gpio_group General Purpose Input/Output\r
  59  *\r
  60  * This is the common API for GPIO. Additional features are available\r
  61  * in the documentation of the specific modules.\r
  62  *\r
  63  * \section io_group_platform Platform Dependencies\r
  64  *\r
  65  * The following functions are available on all platforms, but there may\r
  66  * be variations in the function signature (i.e. parameters) and\r
  67  * behaviour. These functions are typically called by platform-specific\r
  68  * parts of drivers, and applications that aren't intended to be\r
  69  * portable:\r
  70  *   - gpio_pin_is_low()\r
  71  *   - gpio_pin_is_high()\r
  72  *   - gpio_set_pin_high()\r
  73  *   - gpio_set_pin_group_high()\r
  74  *   - gpio_set_pin_low()\r
  75  *   - gpio_set_pin_group_low()\r
  76  *   - gpio_toggle_pin()\r
  77  *   - gpio_toggle_pin_group()\r
  78  *   - gpio_configure_pin()\r
  79  *   - gpio_configure_group()\r
  80  */\r
  81 \r
  82 #endif  // _GPIO_H_\r