mbed library sources

Fork of mbed-src by mbed official

Revision:
613:bc40b8d2aec4
Parent:
612:fba1c7dc54c0
Child:
614:9d86c2ae5de0
--- a/targets/hal/TARGET_Atmel/TARGET_SAM21/drivers/port/port.h	Tue Aug 18 15:00:09 2015 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,745 +0,0 @@
-#ifndef PORT_H_INCLUDED
-#define PORT_H_INCLUDED
-
-/**
- * \defgroup asfdoc_sam0_port_group SAM Port Driver (PORT)
- *
- * This driver for Atmel庐 | SMART SAM devices provides an interface for the configuration
- * and management of the device's General Purpose Input/Output (GPIO) pin
- * functionality, for manual pin state reading and writing.
- *
- * The following peripherals are used by this module:
- *  - PORT (GPIO Management)
- *
- * The following devices can use this module:
- *  - Atmel | SMART SAM D20/D21
- *  - Atmel | SMART SAM R21
- *  - Atmel | SMART SAM D10/D11
- *  - Atmel | SMART SAM L21
- *
- * The outline of this documentation is as follows:
- *  - \ref asfdoc_sam0_port_prerequisites
- *  - \ref asfdoc_sam0_port_module_overview
- *  - \ref asfdoc_sam0_port_special_considerations
- *  - \ref asfdoc_sam0_port_extra_info
- *  - \ref asfdoc_sam0_port_examples
- *  - \ref asfdoc_sam0_port_api_overview
- *
- *
- * \section asfdoc_sam0_port_prerequisites Prerequisites
- *
- * There are no prerequisites for this module.
- *
- *
- * \section asfdoc_sam0_port_module_overview Module Overview
- *
- * The device GPIO (PORT) module provides an interface between the user
- * application logic and external hardware peripherals, when general pin state
- * manipulation is required. This driver provides an easy-to-use interface to
- * the physical pin input samplers and output drivers, so that pins can be read
- * from or written to for general purpose external hardware control.
- *
- * \subsection asfdoc_sam0_port_features Driver Feature Macro Definition
- * <table>
- *  <tr>
- *    <th>Driver Feature Macro</th>
- *    <th>Supported devices</th>
- *  </tr>
- *  <tr>
- *    <td>FEATURE_PORT_INPUT_EVENT</td>
- *    <td>SAML21</td>
- *  </tr>
- * </table>
- * \note The specific features are only available in the driver when the
- * selected device supports those features.
- *
- * \subsection asfdoc_sam0_port_module_overview_pin_numbering Physical and Logical GPIO Pins
- * SAM devices use two naming conventions for the I/O pins in the device; one
- * physical and one logical. Each physical pin on a device package is assigned
- * both a physical port and pin identifier (e.g. "PORTA.0") as well as a
- * monotonically incrementing logical GPIO number (e.g. "GPIO0"). While the
- * former is used to map physical pins to their physical internal device module
- * counterparts, for simplicity the design of this driver uses the logical GPIO
- * numbers instead.
- *
- * \subsection asfdoc_sam0_port_module_overview_physical Physical Connection
- *
- * \ref asfdoc_sam0_port_module_int_connections "The diagram below" shows how
- * this module is interconnected within the device.
- *
- * \anchor asfdoc_sam0_port_module_int_connections
- * \dot
- * digraph overview {
- *   node [label="Port Pad" shape=square] pad;
- *
- *   subgraph driver {
- *     node [label="Peripheral MUX" shape=trapezium] pinmux;
- *     node [label="GPIO Module" shape=ellipse] gpio;
- *     node [label="Other Peripheral Modules" shape=ellipse style=filled fillcolor=lightgray] peripherals;
- *   }
- *
- *   pinmux -> gpio;
- *   pad    -> pinmux;
- *   pinmux -> peripherals;
- * }
- * \enddot
- *
- *
- * \section asfdoc_sam0_port_special_considerations Special Considerations
- *
- * The SAM port pin input sampler can be disabled when the pin is configured
- * in pure output mode to save power; reading the pin state of a pin configured
- * in output-only mode will read the logical output state that was last set.
- *
- * \section asfdoc_sam0_port_extra_info Extra Information
- *
- * For extra information, see \ref asfdoc_sam0_port_extra. This includes:
- *  - \ref asfdoc_sam0_port_extra_acronyms
- *  - \ref asfdoc_sam0_port_extra_dependencies
- *  - \ref asfdoc_sam0_port_extra_errata
- *  - \ref asfdoc_sam0_port_extra_history
- *
- *
- * \section asfdoc_sam0_port_examples Examples
- *
- * For a list of examples related to this driver, see
- * \ref asfdoc_sam0_port_exqsg.
- *
- *
- * \section asfdoc_sam0_port_api_overview API Overview
- * @{
- */
-
-#include <compiler.h>
-#include <pinmux.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/**
- * \name Driver Feature Definition
- * Define port features set according to different device family.
- * @{
-*/
-#if (SAML21) || defined(__DOXYGEN__)
-/** Event input control feature support for PORT group. */
-#  define FEATURE_PORT_INPUT_EVENT
-#endif
-/*@}*/
-
-/** \name PORT Alias Macros
- * @{
- */
-
-/** Convenience definition for GPIO module group A on the device (if
- *  available). */
-#if (PORT_GROUPS > 0) || defined(__DOXYGEN__)
-#  define PORTA             PORT->Group[0]
-#endif
-
-#if (PORT_GROUPS > 1) || defined(__DOXYGEN__)
-/** Convenience definition for GPIO module group B on the device (if
- *  available). */
-#  define PORTB             PORT->Group[1]
-#endif
-
-#if (PORT_GROUPS > 2) || defined(__DOXYGEN__)
-/** Convenience definition for GPIO module group C on the device (if
- *  available). */
-#  define PORTC             PORT->Group[2]
-#endif
-
-#if (PORT_GROUPS > 3) || defined(__DOXYGEN__)
-/** Convenience definition for GPIO module group D on the device (if
- *  available). */
-#  define PORTD             PORT->Group[3]
-#endif
-
-/** @} */
-
-/**
- *  \brief Port pin direction configuration enum.
- *
- *  Enum for the possible pin direction settings of the port pin configuration
- *  structure, to indicate the direction the pin should use.
- */
-enum port_pin_dir {
-    /** The pin's input buffer should be enabled, so that the pin state can
-     *  be read. */
-    PORT_PIN_DIR_INPUT               = SYSTEM_PINMUX_PIN_DIR_INPUT,
-    /** The pin's output buffer should be enabled, so that the pin state can
-     *  be set. */
-    PORT_PIN_DIR_OUTPUT              = SYSTEM_PINMUX_PIN_DIR_OUTPUT,
-    /** The pin's output and input buffers should be enabled, so that the pin
-     *  state can be set and read back. */
-    PORT_PIN_DIR_OUTPUT_WTH_READBACK = SYSTEM_PINMUX_PIN_DIR_OUTPUT_WITH_READBACK,
-};
-
-/**
- *  \brief Port pin input pull configuration enum.
- *
- *  Enum for the possible pin pull settings of the port pin configuration
- *  structure, to indicate the type of logic level pull the pin should use.
- */
-enum port_pin_pull {
-    /** No logical pull should be applied to the pin. */
-    PORT_PIN_PULL_NONE = SYSTEM_PINMUX_PIN_PULL_NONE,
-    /** Pin should be pulled up when idle. */
-    PORT_PIN_PULL_UP   = SYSTEM_PINMUX_PIN_PULL_UP,
-    /** Pin should be pulled down when idle. */
-    PORT_PIN_PULL_DOWN = SYSTEM_PINMUX_PIN_PULL_DOWN,
-};
-
-#ifdef FEATURE_PORT_INPUT_EVENT
-/**
- *  \brief Port input event action.
- *
- *  List of port input events action on pin.
- */
-enum port_input_event_action {
-    /** Event out to pin. */
-    PORT_INPUT_EVENT_ACTION_OUT	= 0,
-    /** Set output register of pin on event. */
-    PORT_INPUT_EVENT_ACTION_SET,
-    /** Clear output register pin on event. */
-    PORT_INPUT_EVENT_ACTION_CLR,
-    /** Toggle output register pin on event. */
-    PORT_INPUT_EVENT_ACTION_TGL,
-};
-
-/**
- *  \brief Port input event.
- *
- *  List of port input events.
- */
-enum port_input_event {
-    /** Port input event 0. */
-    PORT_INPUT_EVENT_0	= 0,
-    /** Port input event 1. */
-    PORT_INPUT_EVENT_1	= 1,
-    /** Port input event 2. */
-    PORT_INPUT_EVENT_2	= 2,
-    /** Port input event 3. */
-    PORT_INPUT_EVENT_3	= 3,
-};
-
-/**
- *  \brief Port input event configuration structure.
- *
- *  Configuration structure for a port input event.
- */
-struct port_input_event_config {
-    /** PPort input event action. */
-    enum port_input_event_action  action;
-    /** GPIO pin. */
-    uint8_t gpio_pin;
-};
-#endif
-
-/**
- *  \brief Port pin configuration structure.
- *
- *  Configuration structure for a port pin instance. This structure should be
- *  initialized by the \ref port_get_config_defaults() function before being
- *  modified by the user application.
- */
-struct port_config {
-    /** Port buffer input/output direction. */
-    enum port_pin_dir  direction;
-
-    /** Port pull-up/pull-down for input pins. */
-    enum port_pin_pull input_pull;
-
-    /** Enable lowest possible powerstate on the pin
-     *
-     *  \note All other configurations will be ignored, the pin will be disabled.
-     */
-    bool powersave;
-};
-
-/** \name State Reading/Writing (Physical Group Orientated)
- * @{
- */
-
-/**
- *  \brief Retrieves the PORT module group instance from a given GPIO pin number.
- *
- *  Retrieves the PORT module group instance associated with a given logical
- *  GPIO pin number.
- *
- *  \param[in] gpio_pin  Index of the GPIO pin to convert
- *
- *  \return Base address of the associated PORT module.
- */
-static inline PortGroup* port_get_group_from_gpio_pin(
-    const uint8_t gpio_pin)
-{
-    return system_pinmux_get_group_from_gpio_pin(gpio_pin);
-}
-
-/**
- *  \brief Retrieves the state of a group of port pins that are configured as inputs.
- *
- *  Reads the current logic level of a port module's pins and returns the
- *  current levels as a bitmask.
- *
- *  \param[in] port  Base of the PORT module to read from
- *  \param[in] mask  Mask of the port pin(s) to read
- *
- *  \return Status of the port pin(s) input buffers.
- */
-static inline uint32_t port_group_get_input_level(
-    const PortGroup *const port,
-    const uint32_t mask)
-{
-    /* Sanity check arguments */
-    Assert(port);
-
-    return (port->IN.reg & mask);
-}
-
-/**
- *  \brief Retrieves the state of a group of port pins that are configured as outputs.
- *
- *  Reads the current logical output level of a port module's pins and returns
- *  the current levels as a bitmask.
- *
- *  \param[in] port  Base of the PORT module to read from
- *  \param[in] mask  Mask of the port pin(s) to read
- *
- *  \return Status of the port pin(s) output buffers.
- */
-static inline uint32_t port_group_get_output_level(
-    const PortGroup *const port,
-    const uint32_t mask)
-{
-    /* Sanity check arguments */
-    Assert(port);
-
-    return (port->OUT.reg & mask);
-}
-
-/**
- *  \brief Sets the state of a group of port pins that are configured as outputs.
- *
- *  Sets the current output level of a port module's pins to a given logic
- *  level.
- *
- *  \param[out] port        Base of the PORT module to write to
- *  \param[in]  mask        Mask of the port pin(s) to change
- *  \param[in]  level_mask  Mask of the port level(s) to set
- */
-static inline void port_group_set_output_level(
-    PortGroup *const port,
-    const uint32_t mask,
-    const uint32_t level_mask)
-{
-    /* Sanity check arguments */
-    Assert(port);
-
-    port->OUTSET.reg = (mask &  level_mask);
-    port->OUTCLR.reg = (mask & ~level_mask);
-}
-
-/**
- *  \brief Toggles the state of a group of port pins that are configured as an outputs.
- *
- *  Toggles the current output levels of a port module's pins.
- *
- *  \param[out] port  Base of the PORT module to write to
- *  \param[in]  mask  Mask of the port pin(s) to toggle
- */
-static inline void port_group_toggle_output_level(
-    PortGroup *const port,
-    const uint32_t mask)
-{
-    /* Sanity check arguments */
-    Assert(port);
-
-    port->OUTTGL.reg = mask;
-}
-
-/** @} */
-
-/** \name Configuration and Initialization
- * @{
- */
-
-/**
- *  \brief Initializes a Port pin/group configuration structure to defaults.
- *
- *  Initializes a given Port pin/group configuration structure to a set of
- *  known default values. This function should be called on all new
- *  instances of these configuration structures before being modified by the
- *  user application.
- *
- *  The default configuration is as follows:
- *   \li Input mode with internal pullup enabled
- *
- *  \param[out] config  Configuration structure to initialize to default values
- */
-static inline void port_get_config_defaults(
-    struct port_config *const config)
-{
-    /* Sanity check arguments */
-    Assert(config);
-
-    /* Default configuration values */
-    config->direction  = PORT_PIN_DIR_INPUT;
-    config->input_pull = PORT_PIN_PULL_UP;
-    config->powersave  = false;
-}
-
-void port_pin_set_config(
-    const uint8_t gpio_pin,
-    const struct port_config *const config);
-
-void port_group_set_config(
-    PortGroup *const port,
-    const uint32_t mask,
-    const struct port_config *const config);
-
-/** @} */
-
-/** \name State Reading/Writing (Logical Pin Orientated)
- * @{
- */
-
-/**
- *  \brief Retrieves the state of a port pin that is configured as an input.
- *
- *  Reads the current logic level of a port pin and returns the current
- *  level as a Boolean value.
- *
- *  \param[in] gpio_pin  Index of the GPIO pin to read
- *
- *  \return Status of the port pin's input buffer.
- */
-static inline bool port_pin_get_input_level(
-    const uint8_t gpio_pin)
-{
-    PortGroup *const port_base = port_get_group_from_gpio_pin(gpio_pin);
-    uint32_t pin_mask  = (1UL << (gpio_pin % 32));
-
-    return (port_base->IN.reg & pin_mask);
-}
-
-/**
- *  \brief Retrieves the state of a port pin that is configured as an output.
- *
- *  Reads the current logical output level of a port pin and returns the current
- *  level as a Boolean value.
- *
- *  \param[in] gpio_pin  Index of the GPIO pin to read
- *
- *  \return Status of the port pin's output buffer.
- */
-static inline bool port_pin_get_output_level(
-    const uint8_t gpio_pin)
-{
-    PortGroup *const port_base = port_get_group_from_gpio_pin(gpio_pin);
-    uint32_t pin_mask  = (1UL << (gpio_pin % 32));
-
-    return (port_base->OUT.reg & pin_mask);
-}
-
-/**
- *  \brief Sets the state of a port pin that is configured as an output.
- *
- *  Sets the current output level of a port pin to a given logic level.
- *
- *  \param[in] gpio_pin  Index of the GPIO pin to write to
- *  \param[in] level     Logical level to set the given pin to
- */
-static inline void port_pin_set_output_level(
-    const uint8_t gpio_pin,
-    const bool level)
-{
-    PortGroup *const port_base = port_get_group_from_gpio_pin(gpio_pin);
-    uint32_t pin_mask  = (1UL << (gpio_pin % 32));
-
-    /* Set the pin to high or low atomically based on the requested level */
-    if (level) {
-        port_base->OUTSET.reg = pin_mask;
-    } else {
-        port_base->OUTCLR.reg = pin_mask;
-    }
-}
-
-/**
- *  \brief Toggles the state of a port pin that is configured as an output.
- *
- *  Toggles the current output level of a port pin.
- *
- *  \param[in] gpio_pin  Index of the GPIO pin to toggle
- */
-static inline void port_pin_toggle_output_level(
-    const uint8_t gpio_pin)
-{
-    PortGroup *const port_base = port_get_group_from_gpio_pin(gpio_pin);
-    uint32_t pin_mask  = (1UL << (gpio_pin % 32));
-
-    /* Toggle pin output level */
-    port_base->OUTTGL.reg = pin_mask;
-}
-
-/** @} */
-
-#ifdef FEATURE_PORT_INPUT_EVENT
-
-/** \name Port Input Event
- * @{
- */
-
-/**
- *  \brief Enable the port event input.
- *
- *  Enable the port event input with the given pin and event.
- *
- *  \param[in] gpio_pin  Index of the GPIO pin
- *  \param[in] n  Port input event
- *
- * \retval STATUS_ERR_INVALID_ARG  Invalid parameter
- * \retval STATUS_OK               Successfully
- */
-static inline enum status_code port_enable_input_event(
-    const uint8_t gpio_pin,
-    const enum port_input_event n)
-{
-    PortGroup *const port_base = port_get_group_from_gpio_pin(gpio_pin);
-    switch (n) {
-        case PORT_INPUT_EVENT_0:
-            port_base->EVCTRL.reg |= PORT_EVCTRL_PORTEI0;
-            break;
-        case PORT_INPUT_EVENT_1:
-            port_base->EVCTRL.reg |= PORT_EVCTRL_PORTEI1;
-            break;
-        case PORT_INPUT_EVENT_2:
-            port_base->EVCTRL.reg |= PORT_EVCTRL_PORTEI2;
-            break;
-        case PORT_INPUT_EVENT_3:
-            port_base->EVCTRL.reg |= PORT_EVCTRL_PORTEI3;
-            break;
-        default:
-            Assert(false);
-            return STATUS_ERR_INVALID_ARG;
-    }
-    return STATUS_OK;
-}
-
-/**
- *  \brief Disable the port event input.
- *
- *  Disable the port event input with the given pin and event.
- *
- *  \param[in] gpio_pin  Index of the GPIO pin
- *  \param[in] gpio_pin  Port input event
- *
- * \retval STATUS_ERR_INVALID_ARG  Invalid parameter
- * \retval STATUS_OK               Successfully
- */
-static inline enum status_code port_disable_input_event(
-    const uint8_t gpio_pin,
-    const enum port_input_event n)
-{
-    PortGroup *const port_base = port_get_group_from_gpio_pin(gpio_pin);
-    switch (n) {
-        case PORT_INPUT_EVENT_0:
-            port_base->EVCTRL.reg &= ~PORT_EVCTRL_PORTEI0;
-            break;
-        case PORT_INPUT_EVENT_1:
-            port_base->EVCTRL.reg &= ~PORT_EVCTRL_PORTEI1;
-            break;
-        case PORT_INPUT_EVENT_2:
-            port_base->EVCTRL.reg &= ~PORT_EVCTRL_PORTEI2;
-            break;
-        case PORT_INPUT_EVENT_3:
-            port_base->EVCTRL.reg &= ~PORT_EVCTRL_PORTEI3;
-            break;
-        default:
-            Assert(false);
-            return STATUS_ERR_INVALID_ARG;
-    }
-    return STATUS_OK;
-}
-
-/**
- * \brief Retrieve the default configuration for port input event.
- *
- * Fills a configuration structure with the default configuration for port input event:
- *   - Event output to pin
- *   - Event action to be executed on PIN 0
- *
- * \param[out] config  Configuration structure to fill with default values
- */
-static inline void port_input_event_get_config_defaults(
-    struct port_input_event_config *const config)
-{
-    Assert(config);
-    config->action   = PORT_INPUT_EVENT_ACTION_OUT;
-    config->gpio_pin = 0;
-}
-
-/**
- * \brief Configure port input event.
- *
- * Configures port input event with the given configuration settings.
- *
- * \param[in] config  Port input even configuration structure containing the new config
- *
- * \retval STATUS_ERR_INVALID_ARG  Invalid parameter
- * \retval STATUS_OK               Successfully
- */
-
-static inline enum status_code port_input_event_set_config(
-    const enum port_input_event n,
-    struct port_input_event_config *const config)
-{
-    Assert(config);
-    PortGroup *const port_base = port_get_group_from_gpio_pin(config->gpio_pin);
-    uint8_t pin_index = config->gpio_pin % 32;
-    struct port_config pin_conf;
-
-    port_get_config_defaults(&pin_conf);
-    /* Configure the GPIO pin as outputs*/
-    pin_conf.direction  = PORT_PIN_DIR_OUTPUT;
-    port_pin_set_config(config->gpio_pin, &pin_conf);
-
-    switch (n) {
-        case PORT_INPUT_EVENT_0:
-            port_base->EVCTRL.reg |= PORT_EVCTRL_EVACT0(config->action)
-                                     | PORT_EVCTRL_PID0(pin_index);
-            break;
-        case PORT_INPUT_EVENT_1:
-            port_base->EVCTRL.reg |= PORT_EVCTRL_EVACT0(config->action)
-                                     | PORT_EVCTRL_PID0(pin_index);
-            break;
-        case PORT_INPUT_EVENT_2:
-            port_base->EVCTRL.reg |= PORT_EVCTRL_EVACT0(config->action)
-                                     | PORT_EVCTRL_PID0(pin_index);
-            break;
-        case PORT_INPUT_EVENT_3:
-            port_base->EVCTRL.reg |= PORT_EVCTRL_EVACT0(config->action)
-                                     | PORT_EVCTRL_PID0(pin_index);
-            break;
-        default:
-            Assert(false);
-            return STATUS_ERR_INVALID_ARG;
-    }
-    return STATUS_OK;
-}
-
-/** @} */
-
-#endif
-
-#ifdef __cplusplus
-}
-#endif
-
-/** @} */
-
-/**
- * \page asfdoc_sam0_port_extra Extra Information for PORT Driver
- *
- * \section asfdoc_sam0_port_extra_acronyms Acronyms
- * Below is a table listing the acronyms used in this module, along with their
- * intended meanings.
- *
- * <table>
- *	<tr>
- *		<th>Acronym</th>
- *		<th>Description</th>
- *	</tr>
- *	<tr>
- *		<td>GPIO</td>
- *		<td>General Purpose Input/Output</td>
- *	</tr>
- *	<tr>
- *		<td>MUX</td>
- *		<td>Multiplexer</td>
- *	</tr>
- * </table>
- *
- *
- * \section asfdoc_sam0_port_extra_dependencies Dependencies
- * This driver has the following dependencies:
- *
- *  - \ref asfdoc_sam0_system_pinmux_group "System Pin Multiplexer Driver"
- *
- *
- * \section asfdoc_sam0_port_extra_errata Errata
- * There are no errata related to this driver.
- *
- *
- * \section asfdoc_sam0_port_extra_history Module History
- * An overview of the module history is presented in the table below, with
- * details on the enhancements and fixes made to the module since its first
- * release. The current version of this corresponds to the newest version in
- * the table.
- *
- * <table>
- *	<tr>
- *		<th>Changelog</th>
- *	</tr>
- *	<tr>
- *		<td>Added input event feature and support for SAML21</td>
- *	</tr>
- *	<tr>
- *		<td>Added support for SAMD21</td>
- *	</tr>
- *	<tr>
- *		<td>Initial Release</td>
- *	</tr>
- * </table>
- */
-
-/**
- * \page asfdoc_sam0_port_exqsg Examples for PORT Driver
- *
- * This is a list of the available Quick Start guides (QSGs) and example
- * applications for \ref asfdoc_sam0_port_group. QSGs are simple examples with
- * step-by-step instructions to configure and use this driver in a selection of
- * use cases. Note that QSGs can be compiled as a standalone application or be
- * added to the user application.
- *
- *  - \subpage asfdoc_sam0_port_basic_use_case
- *
- * \page asfdoc_sam0_port_document_revision_history Document Revision History
- *
- * <table>
- *	<tr>
- *		<th>Doc. Rev.</td>
- *		<th>Date</td>
- *		<th>Comments</td>
- *	</tr>
-  *	<tr>
- *		<td>E</td>
- *		<td>11/2014</td>
- *		<td>Added input event feature and support for SAML21.</td>
- *	</tr>
- *	<tr>
- *		<td>D</td>
- *		<td>12/2014</td>
- *		<td>Added support for SAMR21 and SAMD10/D11.</td>
- *	</tr>
- *	<tr>
- *		<td>C</td>
- *		<td>01/2014</td>
- *		<td>Added support for SAMD21.</td>
- *	</tr>
- *	<tr>
- *		<td>B</td>
- *		<td>06/2013</td>
- *		<td>Corrected documentation typos.</td>
- *	</tr>
- *	<tr>
- *		<td>A</td>
- *		<td>06/2013</td>
- *		<td>Initial release</td>
- *	</tr>
- * </table>
- */
-
-#endif