GameOpener / mbed-src

mbed library sources

Fork of mbed-src by mbed official

targets/hal/TARGET_Atmel/TARGET_SAM21/drivers/system/pinmux/quick_start/qs_pinmux_basic.h@579:53297373a894, 2015-07-01 (annotated)

Committer:
mbed_official
Date:
Wed Jul 01 09:45:11 2015 +0100
Revision:
579:53297373a894
Child:
592:a274ee790e56
Synchronized with git revision d5b4d2ab9c47edb4dc5776e7177b0c2263459081



Full URL: https://github.com/mbedmicro/mbed/commit/d5b4d2ab9c47edb4dc5776e7177b0c2263459081/



Initial version of drivers for SAMR21

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 579:53297373a894 1 /**
mbed_official 579:53297373a894 2 * \file
mbed_official 579:53297373a894 3 *
mbed_official 579:53297373a894 4 * \brief SAM PINMUX Driver Quick Start
mbed_official 579:53297373a894 5 *
mbed_official 579:53297373a894 6 * Copyright (C) 2012-2014 Atmel Corporation. All rights reserved.
mbed_official 579:53297373a894 7 *
mbed_official 579:53297373a894 8 * \asf_license_start
mbed_official 579:53297373a894 9 *
mbed_official 579:53297373a894 10 * \page License
mbed_official 579:53297373a894 11 *
mbed_official 579:53297373a894 12 * Redistribution and use in source and binary forms, with or without
mbed_official 579:53297373a894 13 * modification, are permitted provided that the following conditions are met:
mbed_official 579:53297373a894 14 *
mbed_official 579:53297373a894 15 * 1. Redistributions of source code must retain the above copyright notice,
mbed_official 579:53297373a894 16 * this list of conditions and the following disclaimer.
mbed_official 579:53297373a894 17 *
mbed_official 579:53297373a894 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
mbed_official 579:53297373a894 19 * this list of conditions and the following disclaimer in the documentation
mbed_official 579:53297373a894 20 * and/or other materials provided with the distribution.
mbed_official 579:53297373a894 21 *
mbed_official 579:53297373a894 22 * 3. The name of Atmel may not be used to endorse or promote products derived
mbed_official 579:53297373a894 23 * from this software without specific prior written permission.
mbed_official 579:53297373a894 24 *
mbed_official 579:53297373a894 25 * 4. This software may only be redistributed and used in connection with an
mbed_official 579:53297373a894 26 * Atmel microcontroller product.
mbed_official 579:53297373a894 27 *
mbed_official 579:53297373a894 28 * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
mbed_official 579:53297373a894 29 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
mbed_official 579:53297373a894 30 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
mbed_official 579:53297373a894 31 * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
mbed_official 579:53297373a894 32 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
mbed_official 579:53297373a894 33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
mbed_official 579:53297373a894 34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
mbed_official 579:53297373a894 35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
mbed_official 579:53297373a894 36 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
mbed_official 579:53297373a894 37 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
mbed_official 579:53297373a894 38 * POSSIBILITY OF SUCH DAMAGE.
mbed_official 579:53297373a894 39 *
mbed_official 579:53297373a894 40 * \asf_license_stop
mbed_official 579:53297373a894 41 *
mbed_official 579:53297373a894 42 */
mbed_official 579:53297373a894 43
mbed_official 579:53297373a894 44 /**
mbed_official 579:53297373a894 45 * \page asfdoc_sam0_system_pinmux_basic_use_case Quick Start Guide for SYSTEM PINMUX - Basic
mbed_official 579:53297373a894 46 *
mbed_official 579:53297373a894 47 * In this use case, the PINMUX module is configured for:
mbed_official 579:53297373a894 48 * \li One pin in input mode, with pull-up enabled, connected to the GPIO
mbed_official 579:53297373a894 49 * module
mbed_official 579:53297373a894 50 * \li Sampling mode of the pin changed to sample on demand
mbed_official 579:53297373a894 51 *
mbed_official 579:53297373a894 52 * This use case sets up the PINMUX to configure a physical I/O pin set as
mbed_official 579:53297373a894 53 * an input with pull-up and changes the sampling mode of the pin to reduce
mbed_official 579:53297373a894 54 * power by only sampling the physical pin state when the user application
mbed_official 579:53297373a894 55 * attempts to read it.
mbed_official 579:53297373a894 56 *
mbed_official 579:53297373a894 57 * \section asfdoc_sam0_system_pinmux_basic_use_case_setup Setup
mbed_official 579:53297373a894 58 *
mbed_official 579:53297373a894 59 * \subsection asfdoc_sam0_system_pinmux_basic_use_case_setup_prereq Prerequisites
mbed_official 579:53297373a894 60 * There are no special setup requirements for this use-case.
mbed_official 579:53297373a894 61 *
mbed_official 579:53297373a894 62 * \subsection asfdoc_sam0_system_pinmux_basic_use_case_setup_code Code
mbed_official 579:53297373a894 63 * Copy-paste the following setup code to your application:
mbed_official 579:53297373a894 64 * \snippet qs_pinmux_basic.c setup
mbed_official 579:53297373a894 65 *
mbed_official 579:53297373a894 66 * \subsection asfdoc_sam0_system_pinmux_basic_use_case_setup_flow Workflow
mbed_official 579:53297373a894 67 * -# Create a PINMUX module pin configuration struct, which can be filled out
mbed_official 579:53297373a894 68 * to adjust the configuration of a single port pin.
mbed_official 579:53297373a894 69 * \snippet qs_pinmux_basic.c pinmux_config
mbed_official 579:53297373a894 70 * -# Initialize the pin configuration struct with the module's default values.
mbed_official 579:53297373a894 71 * \snippet qs_pinmux_basic.c pinmux_config_defaults
mbed_official 579:53297373a894 72 * \note This should always be performed before using the configuration
mbed_official 579:53297373a894 73 * struct to ensure that all values are initialized to known default
mbed_official 579:53297373a894 74 * settings.
mbed_official 579:53297373a894 75 *
mbed_official 579:53297373a894 76 * -# Adjust the configuration struct to request an input pin with pullup
mbed_official 579:53297373a894 77 * connected to the GPIO peripheral.
mbed_official 579:53297373a894 78 * \snippet qs_pinmux_basic.c pinmux_update_config_values
mbed_official 579:53297373a894 79 * -# Configure GPIO10 with the initialized pin configuration struct, to enable
mbed_official 579:53297373a894 80 * the input sampler on the pin.
mbed_official 579:53297373a894 81 * \snippet qs_pinmux_basic.c pinmux_set_config
mbed_official 579:53297373a894 82 *
mbed_official 579:53297373a894 83 * \section asfdoc_sam0_system_pinmux_basic_use_case_use_main Use Case
mbed_official 579:53297373a894 84 *
mbed_official 579:53297373a894 85 * \subsection asfdoc_sam0_system_pinmux_basic_use_case_code Code
mbed_official 579:53297373a894 86 * Copy-paste the following code to your user application:
mbed_official 579:53297373a894 87 * \snippet qs_pinmux_basic.c main
mbed_official 579:53297373a894 88 *
mbed_official 579:53297373a894 89 * \subsection asfdoc_sam0_system_pinmux_basic_use_case_flow Workflow
mbed_official 579:53297373a894 90
mbed_official 579:53297373a894 91 * -# Adjust the configuration of the pin to enable on-demand sampling mode.
mbed_official 579:53297373a894 92 * \snippet qs_pinmux_basic.c pinmux_change_input_sampling
mbed_official 579:53297373a894 93 */
mbed_official 579:53297373a894 94 /**
mbed_official 579:53297373a894 95 * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
mbed_official 579:53297373a894 96 */