mbed library sources
Fork of mbed-src by
targets/hal/TARGET_Atmel/TARGET_SAM21/drivers/system/pinmux/quick_start/qs_pinmux_basic.h
- Committer:
- mbed_official
- Date:
- 2015-07-17
- Revision:
- 592:a274ee790e56
- Parent:
- 579:53297373a894
File content as of revision 592:a274ee790e56:
/** * \page asfdoc_sam0_system_pinmux_basic_use_case Quick Start Guide for SYSTEM PINMUX - Basic * * In this use case, the PINMUX module is configured for: * \li One pin in input mode, with pull-up enabled, connected to the GPIO * module * \li Sampling mode of the pin changed to sample on demand * * This use case sets up the PINMUX to configure a physical I/O pin set as * an input with pull-up and changes the sampling mode of the pin to reduce * power by only sampling the physical pin state when the user application * attempts to read it. * * \section asfdoc_sam0_system_pinmux_basic_use_case_setup Setup * * \subsection asfdoc_sam0_system_pinmux_basic_use_case_setup_prereq Prerequisites * There are no special setup requirements for this use-case. * * \subsection asfdoc_sam0_system_pinmux_basic_use_case_setup_code Code * Copy-paste the following setup code to your application: * \snippet qs_pinmux_basic.c setup * * \subsection asfdoc_sam0_system_pinmux_basic_use_case_setup_flow Workflow * -# Create a PINMUX module pin configuration struct, which can be filled out * to adjust the configuration of a single port pin. * \snippet qs_pinmux_basic.c pinmux_config * -# Initialize the pin configuration struct with the module's default values. * \snippet qs_pinmux_basic.c pinmux_config_defaults * \note This should always be performed before using the configuration * struct to ensure that all values are initialized to known default * settings. * * -# Adjust the configuration struct to request an input pin with pullup * connected to the GPIO peripheral. * \snippet qs_pinmux_basic.c pinmux_update_config_values * -# Configure GPIO10 with the initialized pin configuration struct, to enable * the input sampler on the pin. * \snippet qs_pinmux_basic.c pinmux_set_config * * \section asfdoc_sam0_system_pinmux_basic_use_case_use_main Use Case * * \subsection asfdoc_sam0_system_pinmux_basic_use_case_code Code * Copy-paste the following code to your user application: * \snippet qs_pinmux_basic.c main * * \subsection asfdoc_sam0_system_pinmux_basic_use_case_flow Workflow * -# Adjust the configuration of the pin to enable on-demand sampling mode. * \snippet qs_pinmux_basic.c pinmux_change_input_sampling */ /** * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a> */