mirror of
https://github.com/arduino/Arduino.git
synced 2025-01-19 08:52:15 +01:00
346 lines
14 KiB
C
346 lines
14 KiB
C
/**
|
|
* \file
|
|
*
|
|
* \brief Parallel Input/Output (PIO) Controller driver for SAM.
|
|
*
|
|
* Copyright (c) 2011 - 2012 Atmel Corporation. All rights reserved.
|
|
*
|
|
* \asf_license_start
|
|
*
|
|
* \page License
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright notice,
|
|
* this list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
*
|
|
* 3. The name of Atmel may not be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* 4. This software may only be redistributed and used in connection with an
|
|
* Atmel microcontroller product.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
|
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
|
|
* EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
|
|
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* \asf_license_stop
|
|
*
|
|
*/
|
|
|
|
#ifndef PIO_H_INCLUDED
|
|
#define PIO_H_INCLUDED
|
|
|
|
#include "compiler.h"
|
|
|
|
/// @cond 0
|
|
/**INDENT-OFF**/
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
/**INDENT-ON**/
|
|
/// @endcond
|
|
|
|
#define PIO_DELTA ((uint32_t) PIOB - (uint32_t) PIOA) /* Compute PIO register length */
|
|
|
|
/* GPIO Support */
|
|
#define PIO_TYPE_Pos 27
|
|
/* PIO Type Mask */
|
|
#define PIO_TYPE_Msk (0xFu << PIO_TYPE_Pos)
|
|
/* The pin is not a function pin. */
|
|
#define PIO_TYPE_NOT_A_PIN (0x0u << PIO_TYPE_Pos)
|
|
/* The pin is controlled by the peripheral A. */
|
|
#define PIO_TYPE_PIO_PERIPH_A (0x1u << PIO_TYPE_Pos)
|
|
/* The pin is controlled by the peripheral B. */
|
|
#define PIO_TYPE_PIO_PERIPH_B (0x2u << PIO_TYPE_Pos)
|
|
/* The pin is controlled by the peripheral C. */
|
|
#define PIO_TYPE_PIO_PERIPH_C (0x3u << PIO_TYPE_Pos)
|
|
/* The pin is controlled by the peripheral D. */
|
|
#define PIO_TYPE_PIO_PERIPH_D (0x4u << PIO_TYPE_Pos)
|
|
/* The pin is an input. */
|
|
#define PIO_TYPE_PIO_INPUT (0x5u << PIO_TYPE_Pos)
|
|
/* The pin is an output and has a default level of 0. */
|
|
#define PIO_TYPE_PIO_OUTPUT_0 (0x6u << PIO_TYPE_Pos)
|
|
/* The pin is an output and has a default level of 1. */
|
|
#define PIO_TYPE_PIO_OUTPUT_1 (0x7u << PIO_TYPE_Pos)
|
|
|
|
typedef enum _pio_type {
|
|
PIO_NOT_A_PIN = PIO_TYPE_NOT_A_PIN,
|
|
PIO_PERIPH_A = PIO_TYPE_PIO_PERIPH_A,
|
|
PIO_PERIPH_B = PIO_TYPE_PIO_PERIPH_B,
|
|
#if (SAM3S || SAM3N || SAM4S)
|
|
PIO_PERIPH_C = PIO_TYPE_PIO_PERIPH_C,
|
|
PIO_PERIPH_D = PIO_TYPE_PIO_PERIPH_D,
|
|
#endif
|
|
PIO_INPUT = PIO_TYPE_PIO_INPUT,
|
|
PIO_OUTPUT_0 = PIO_TYPE_PIO_OUTPUT_0,
|
|
PIO_OUTPUT_1 = PIO_TYPE_PIO_OUTPUT_1
|
|
} pio_type_t;
|
|
|
|
/* Default pin configuration (no attribute). */
|
|
#define PIO_DEFAULT (0u << 0)
|
|
/* The internal pin pull-up is active. */
|
|
#define PIO_PULLUP (1u << 0)
|
|
/* The internal glitch filter is active. */
|
|
#define PIO_DEGLITCH (1u << 1)
|
|
/* The pin is open-drain. */
|
|
#define PIO_OPENDRAIN (1u << 2)
|
|
|
|
/* The internal debouncing filter is active. */
|
|
#define PIO_DEBOUNCE (1u << 3)
|
|
|
|
/* Enable additional interrupt modes. */
|
|
#define PIO_IT_AIME (1u << 4)
|
|
|
|
/* Interrupt High Level/Rising Edge detection is active. */
|
|
#define PIO_IT_RE_OR_HL (1u << 5)
|
|
/* Interrupt Edge detection is active. */
|
|
#define PIO_IT_EDGE (1u << 6)
|
|
|
|
/* Low level interrupt is active */
|
|
#define PIO_IT_LOW_LEVEL (0 | 0 | PIO_IT_AIME)
|
|
/* High level interrupt is active */
|
|
#define PIO_IT_HIGH_LEVEL (PIO_IT_RE_OR_HL | 0 | PIO_IT_AIME)
|
|
/* Falling edge interrupt is active */
|
|
#define PIO_IT_FALL_EDGE (0 | PIO_IT_EDGE | PIO_IT_AIME)
|
|
/* Rising edge interrupt is active */
|
|
#define PIO_IT_RISE_EDGE (PIO_IT_RE_OR_HL | PIO_IT_EDGE | PIO_IT_AIME)
|
|
|
|
/*
|
|
* The #attribute# field is a bitmask that can either be set to PIO_DEFAULT,
|
|
* or combine (using bitwise OR '|') any number of the following constants:
|
|
* - PIO_PULLUP
|
|
* - PIO_DEGLITCH
|
|
* - PIO_DEBOUNCE
|
|
* - PIO_OPENDRAIN
|
|
* - PIO_IT_LOW_LEVEL
|
|
* - PIO_IT_HIGH_LEVEL
|
|
* - PIO_IT_FALL_EDGE
|
|
* - PIO_IT_RISE_EDGE
|
|
*/
|
|
void pio_pull_up(Pio *p_pio, const uint32_t ul_mask,
|
|
const uint32_t ul_pull_up_enable);
|
|
void pio_set_debounce_filter(Pio *p_pio, const uint32_t ul_mask,
|
|
const uint32_t ul_cut_off);
|
|
void pio_set(Pio *p_pio, const uint32_t ul_mask);
|
|
void pio_clear(Pio *p_pio, const uint32_t ul_mask);
|
|
uint32_t pio_get(Pio *p_pio, const pio_type_t ul_type,
|
|
const uint32_t ul_mask);
|
|
void pio_set_peripheral(Pio *p_pio, const pio_type_t ul_type,
|
|
const uint32_t ul_mask);
|
|
void pio_set_input(Pio *p_pio, const uint32_t ul_mask,
|
|
const uint32_t ul_attribute);
|
|
void pio_set_output(Pio *p_pio, const uint32_t ul_mask,
|
|
const uint32_t ul_default_level,
|
|
const uint32_t ul_multidrive_enable,
|
|
const uint32_t ul_pull_up_enable);
|
|
uint32_t pio_configure(Pio *p_pio, const pio_type_t ul_type,
|
|
const uint32_t ul_mask, const uint32_t ul_attribute);
|
|
uint32_t pio_get_output_data_status(const Pio *p_pio,
|
|
const uint32_t ul_mask);
|
|
void pio_set_multi_driver(Pio *p_pio, const uint32_t ul_mask,
|
|
const uint32_t ul_multi_driver_enable);
|
|
uint32_t pio_get_multi_driver_status(const Pio *p_pio);
|
|
|
|
#if (SAM3S || SAM3N || SAM4S)
|
|
void pio_pull_down(Pio *p_pio, const uint32_t ul_mask,
|
|
const uint32_t ul_pull_down_enable);
|
|
#endif
|
|
|
|
void pio_enable_output_write(Pio *p_pio, const uint32_t ul_mask);
|
|
void pio_disable_output_write(Pio *p_pio, const uint32_t ul_mask);
|
|
uint32_t pio_get_output_write_status(const Pio *p_pio);
|
|
void pio_sync_output_write(Pio *p_pio, const uint32_t ul_mask);
|
|
|
|
#if (SAM3S || SAM3N || SAM4S)
|
|
void pio_set_schmitt_trigger(Pio *p_pio, const uint32_t ul_mask);
|
|
uint32_t pio_get_schmitt_trigger(const Pio *p_pio);
|
|
#endif
|
|
|
|
void pio_configure_interrupt(Pio *p_pio, const uint32_t ul_mask, const uint32_t ul_attr);
|
|
void pio_enable_interrupt(Pio *p_pio, const uint32_t ul_mask);
|
|
void pio_disable_interrupt(Pio *p_pio, const uint32_t ul_mask);
|
|
uint32_t pio_get_interrupt_status(const Pio *p_pio);
|
|
uint32_t pio_get_interrupt_mask(const Pio *p_pio);
|
|
void pio_set_additional_interrupt_mode(Pio *p_pio,
|
|
const uint32_t ul_mask, const uint32_t ul_attribute);
|
|
void pio_set_writeprotect(Pio *p_pio, const uint32_t ul_enable);
|
|
uint32_t pio_get_writeprotect_status(const Pio *p_pio);
|
|
|
|
#if (SAM3S || SAM4S)
|
|
void pio_capture_set_mode(Pio *p_pio, uint32_t ul_mode);
|
|
void pio_capture_enable(Pio *p_pio);
|
|
void pio_capture_disable(Pio *p_pio);
|
|
uint32_t pio_capture_read(const Pio *p_pio, uint32_t * pul_data);
|
|
void pio_capture_enable_interrupt(Pio *p_pio, const uint32_t ul_mask);
|
|
void pio_capture_disable_interrupt(Pio * p_pio, const uint32_t ul_mask);
|
|
uint32_t pio_capture_get_interrupt_status(const Pio *p_pio);
|
|
uint32_t pio_capture_get_interrupt_mask(const Pio *p_pio);
|
|
Pdc *pio_capture_get_pdc_base(const Pio *p_pio);
|
|
#endif
|
|
|
|
/* GPIO Support */
|
|
uint32_t pio_get_pin_value(uint32_t pin);
|
|
void pio_set_pin_high(uint32_t pin);
|
|
void pio_set_pin_low(uint32_t pin);
|
|
void pio_toggle_pin(uint32_t pin);
|
|
void pio_enable_pin_interrupt(uint32_t pin);
|
|
void pio_disable_pin_interrupt(uint32_t pin);
|
|
Pio *pio_get_pin_group(uint32_t pin);
|
|
uint32_t pio_get_pin_group_id(uint32_t pin);
|
|
uint32_t pio_get_pin_group_mask(uint32_t pin);
|
|
uint32_t pio_configure_pin(uint32_t ul_pin, const uint32_t ul_flags);
|
|
void pio_set_pin_group_high(Pio *p_pio, uint32_t ul_mask);
|
|
void pio_set_pin_group_low(Pio *p_pio, uint32_t ul_mask);
|
|
void pio_toggle_pin_group(Pio *p_pio, uint32_t ul_mask);
|
|
uint32_t pio_configure_pin_group(Pio *p_pio, uint32_t ul_mask, const uint32_t ul_flags);
|
|
|
|
/**
|
|
* \page sam_pio_quickstart Quick Start Guide for the SAM PIO driver
|
|
*
|
|
* This is the quick start guide for the \ref sam_drivers_pio_group "PIO Driver",
|
|
* with step-by-step instructions on how to configure and use the driver for
|
|
* specific use cases.
|
|
*
|
|
* The section described below can be compiled into e.g. the main application
|
|
* loop or any other function that will need to interface with the IO port.
|
|
*
|
|
* \section sam_pio_usecases PIO use cases
|
|
* - \ref sam_pio_quickstart_basic
|
|
* - \ref sam_pio_quickstart_use_case_2
|
|
*
|
|
* \section sam_pio_quickstart_basic Basic usage of the PIO driver
|
|
* This section will present a basic use case for the PIO driver. This use case
|
|
* will configure pin 23 on port A as output and pin 16 as an input with pullup,
|
|
* and then toggle the output pin's value to match that of the input pin.
|
|
*
|
|
* \subsection sam_pio_quickstart_use_case_1_prereq Prerequisites
|
|
* - \ref group_pmc "Power Management Controller driver"
|
|
*
|
|
* \subsection sam_pio_quickstart_use_case_1_setup_steps Initialization code
|
|
* Add to the application initialization code:
|
|
* \code
|
|
* pmc_enable_periph_clk(ID_PIOA);
|
|
*
|
|
* pio_set_output(PIOA, PIO_PA23, LOW, DISABLE, ENABLE);
|
|
* pio_set_input(PIOA, PIO_PA16, PIO_PULLUP);
|
|
* \endcode
|
|
*
|
|
* \subsection sam_pio_quickstart_use_case_1_setup_steps_workflow Workflow
|
|
* -# Enable the module clock to the PIOA peripheral:
|
|
* \code pmc_enable_periph_clk(ID_PIOA); \endcode
|
|
* -# Set pin 23 direction on PIOA as output, default low level:
|
|
* \code pio_set_output(PIOA, PIO_PA23, LOW, DISABLE, ENABLE); \endcode
|
|
* -# Set pin 16 direction on PIOA as input, with pullup:
|
|
* \code pio_set_input(PIOA, PIO_PA16, PIO_PULLUP); \endcode
|
|
*
|
|
* \subsection sam_pio_quickstart_use_case_1_example_code Example code
|
|
* Set the state of output pin 23 to match input pin 16:
|
|
* \code
|
|
* if (pio_get(PIOA, PIO_TYPE_PIO_INPUT, PIO_PA16))
|
|
* pio_clear(PIOA, PIO_PA23);
|
|
* else
|
|
* pio_set(PIOA, PIO_PA23);
|
|
* \endcode
|
|
*
|
|
* \subsection sam_pio_quickstart_use_case_1_example_workflow Workflow
|
|
* -# We check the value of the pin:
|
|
* \code
|
|
* if (pio_get(PIOA, PIO_TYPE_PIO_INPUT, PIO_PA16))
|
|
* \endcode
|
|
* -# Then we set the new output value based on the read pin value:
|
|
* \code
|
|
* pio_clear(PIOA, PIO_PA23);
|
|
* else
|
|
* pio_set(PIOA, PIO_PA23);
|
|
* \endcode
|
|
*/
|
|
|
|
/**
|
|
* \page sam_pio_quickstart_use_case_2 Advanced use case - Interrupt driven edge detection
|
|
*
|
|
* \section sam_pio_quickstart_use_case_2 Advanced Use Case 1
|
|
* This section will present a more advanced use case for the PIO driver. This use case
|
|
* will configure pin 23 on port A as output and pin 16 as an input with pullup,
|
|
* and then toggle the output pin's value to match that of the input pin using the interrupt
|
|
* controller within the device.
|
|
*
|
|
* \subsection sam_pio_quickstart_use_case_2_prereq Prerequisites
|
|
* - \ref group_pmc "Power Management Controller driver"
|
|
*
|
|
* \subsection sam_pio_quickstart_use_case_2_setup_steps Initialization code
|
|
* Add to the application initialization code:
|
|
* \code
|
|
* pmc_enable_periph_clk(ID_PIOA);
|
|
*
|
|
* pio_set_output(PIOA, PIO_PA23, LOW, DISABLE, ENABLE);
|
|
* pio_set_input(PIOA, PIO_PA16, PIO_PULLUP);
|
|
*
|
|
* pio_handler_set(PIOA, ID_PIOA, PIO_PA16, PIO_IT_EDGE, pin_edge_handler);
|
|
* pio_enable_interrupt(PIOA, PIO_PA16);
|
|
*
|
|
* NVIC_EnableIRQ(PIOA_IRQn);
|
|
* \endcode
|
|
*
|
|
* \subsection sam_pio_quickstart_use_case_2_setup_steps_workflow Workflow
|
|
* -# Enable the module clock to the PIOA peripheral:
|
|
* \code pmc_enable_periph_clk(ID_PIOA); \endcode
|
|
* -# Set pin 23 direction on PIOA as output, default low level:
|
|
* \code pio_set_output(PIOA, PIO_PA23, LOW, DISABLE, ENABLE); \endcode
|
|
* -# Set pin 16 direction on PIOA as input, with pullup:
|
|
* \code pio_set_input(PIOA, PIO_PA16, PIO_PULLUP); \endcode
|
|
* -# Configure the input pin 16 interrupt mode and handler:
|
|
* \code pio_handler_set(PIOA, ID_PIOA, PIO_PA16, PIO_IT_EDGE, pin_edge_handler); \endcode
|
|
* -# Enable the interrupt for the configured input pin:
|
|
* \code pio_enable_interrupt(PIOA, PIO_PA16); \endcode
|
|
* -# Enable interrupt handling from the PIOA module:
|
|
* \code NVIC_EnableIRQ(PIOA_IRQn); \endcode
|
|
*
|
|
* \subsection sam_pio_quickstart_use_case_2_example_code Example code
|
|
* Add the following function to your application:
|
|
* \code
|
|
* void pin_edge_handler(void)
|
|
* {
|
|
* if (pio_get(PIOA, PIO_TYPE_PIO_INPUT, PIO_PA16))
|
|
* pio_clear(PIOA, PIO_PA23);
|
|
* else
|
|
* pio_set(PIOA, PIO_PA23);
|
|
* }
|
|
* \endcode
|
|
*
|
|
* \subsection sam_pio_quickstart_use_case_2_example_workflow Workflow
|
|
* -# We check the value of the pin:
|
|
* \code
|
|
* if (pio_get(PIOA, PIO_TYPE_PIO_INPUT, PIO_PA16))
|
|
* \endcode
|
|
* -# Then we set the new output value based on the read pin value:
|
|
* \code
|
|
* pio_clear(PIOA, PIO_PA23);
|
|
* else
|
|
* pio_set(PIOA, PIO_PA23);
|
|
* \endcode
|
|
*/
|
|
|
|
/// @cond 0
|
|
/**INDENT-OFF**/
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
/**INDENT-ON**/
|
|
/// @endcond
|
|
|
|
#endif /* PIO_H_INCLUDED */
|