marcus chiou / 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@592:a274ee790e56, 2015-07-17 (annotated)

Committer:
mbed_official
Date:
Fri Jul 17 09:15:10 2015 +0100
Revision:
592:a274ee790e56
Parent:
579:53297373a894 
Synchronized with git revision e7144f83a8d75df80c4877936b6ffe552b0be9e6



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



More API implementation for SAMR21

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 579:53297373a894 1 /**
mbed_official 579:53297373a894 2 * \page asfdoc_sam0_system_pinmux_basic_use_case Quick Start Guide for SYSTEM PINMUX - Basic
mbed_official 579:53297373a894 3 *
mbed_official 579:53297373a894 4 * In this use case, the PINMUX module is configured for:
mbed_official 579:53297373a894 5 * \li One pin in input mode, with pull-up enabled, connected to the GPIO
mbed_official 579:53297373a894 6 * module
mbed_official 579:53297373a894 7 * \li Sampling mode of the pin changed to sample on demand
mbed_official 579:53297373a894 8 *
mbed_official 579:53297373a894 9 * This use case sets up the PINMUX to configure a physical I/O pin set as
mbed_official 579:53297373a894 10 * an input with pull-up and changes the sampling mode of the pin to reduce
mbed_official 579:53297373a894 11 * power by only sampling the physical pin state when the user application
mbed_official 579:53297373a894 12 * attempts to read it.
mbed_official 579:53297373a894 13 *
mbed_official 579:53297373a894 14 * \section asfdoc_sam0_system_pinmux_basic_use_case_setup Setup
mbed_official 579:53297373a894 15 *
mbed_official 579:53297373a894 16 * \subsection asfdoc_sam0_system_pinmux_basic_use_case_setup_prereq Prerequisites
mbed_official 579:53297373a894 17 * There are no special setup requirements for this use-case.
mbed_official 579:53297373a894 18 *
mbed_official 579:53297373a894 19 * \subsection asfdoc_sam0_system_pinmux_basic_use_case_setup_code Code
mbed_official 579:53297373a894 20 * Copy-paste the following setup code to your application:
mbed_official 579:53297373a894 21 * \snippet qs_pinmux_basic.c setup
mbed_official 579:53297373a894 22 *
mbed_official 579:53297373a894 23 * \subsection asfdoc_sam0_system_pinmux_basic_use_case_setup_flow Workflow
mbed_official 579:53297373a894 24 * -# Create a PINMUX module pin configuration struct, which can be filled out
mbed_official 579:53297373a894 25 * to adjust the configuration of a single port pin.
mbed_official 579:53297373a894 26 * \snippet qs_pinmux_basic.c pinmux_config
mbed_official 579:53297373a894 27 * -# Initialize the pin configuration struct with the module's default values.
mbed_official 579:53297373a894 28 * \snippet qs_pinmux_basic.c pinmux_config_defaults
mbed_official 579:53297373a894 29 * \note This should always be performed before using the configuration
mbed_official 579:53297373a894 30 * struct to ensure that all values are initialized to known default
mbed_official 579:53297373a894 31 * settings.
mbed_official 579:53297373a894 32 *
mbed_official 579:53297373a894 33 * -# Adjust the configuration struct to request an input pin with pullup
mbed_official 579:53297373a894 34 * connected to the GPIO peripheral.
mbed_official 579:53297373a894 35 * \snippet qs_pinmux_basic.c pinmux_update_config_values
mbed_official 579:53297373a894 36 * -# Configure GPIO10 with the initialized pin configuration struct, to enable
mbed_official 579:53297373a894 37 * the input sampler on the pin.
mbed_official 579:53297373a894 38 * \snippet qs_pinmux_basic.c pinmux_set_config
mbed_official 579:53297373a894 39 *
mbed_official 579:53297373a894 40 * \section asfdoc_sam0_system_pinmux_basic_use_case_use_main Use Case
mbed_official 579:53297373a894 41 *
mbed_official 579:53297373a894 42 * \subsection asfdoc_sam0_system_pinmux_basic_use_case_code Code
mbed_official 579:53297373a894 43 * Copy-paste the following code to your user application:
mbed_official 579:53297373a894 44 * \snippet qs_pinmux_basic.c main
mbed_official 579:53297373a894 45 *
mbed_official 579:53297373a894 46 * \subsection asfdoc_sam0_system_pinmux_basic_use_case_flow Workflow
mbed_official 579:53297373a894 47
mbed_official 579:53297373a894 48 * -# Adjust the configuration of the pin to enable on-demand sampling mode.
mbed_official 579:53297373a894 49 * \snippet qs_pinmux_basic.c pinmux_change_input_sampling
mbed_official 579:53297373a894 50 */
mbed_official 579:53297373a894 51 /**
mbed_official 579:53297373a894 52 * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
mbed_official 579:53297373a894 53 */