Atmel Software Framework

Common IOPORT API

See Quick start guide for the common IOPORT service.

This is common IOPORT service for GPIO pin configuration and control in a standardized manner across the MEGA, MEGA_RF, XMEGA, UC3 and ARM devices.

Port pin control code is optimized for each platform, and should produce both compact and fast execution times when used with constant values.

Dependencies

This driver depends on the following modules:

IOPORT Modes

For details on these please see the SAM Manual.

Modules

 
 Quick Start Guide(s)
 In this section you can find a list of all Quick Start guides related to the Common IOPORT API.
 

Macros

#define IOPORT_CREATE_PIN(port, pin)   ((IOPORT_ ## port) * 32 + (pin))
 Create IOPORT pin number. More...
 

Enumerations

enum  ioport_direction {
  IOPORT_DIR_INPUT,
  IOPORT_DIR_OUTPUT
}
 IOPORT pin directions. More...
 
enum  ioport_sense {
  IOPORT_SENSE_BOTHEDGES,
  IOPORT_SENSE_RISING,
  IOPORT_SENSE_FALLING
}
 
enum  ioport_value {
  IOPORT_PIN_LEVEL_LOW,
  IOPORT_PIN_LEVEL_HIGH
}
 IOPORT levels. More...
 

Functions

static void ioport_disable_pin (ioport_pin_t pin)
 Disable IOPORT pin, based on a pin created with IOPORT_CREATE_PIN(). More...
 
static void ioport_disable_port (ioport_port_t port, ioport_port_mask_t mask)
 Disable multiple pins in a single IOPORT port. More...
 
static void ioport_enable_pin (ioport_pin_t pin)
 Enable an IOPORT pin, based on a pin created with IOPORT_CREATE_PIN(). More...
 
static void ioport_enable_port (ioport_port_t port, ioport_port_mask_t mask)
 Enable multiple pins in a single IOPORT port. More...
 
static bool ioport_get_pin_level (ioport_pin_t pin)
 Get current value of an IOPORT pin, which has been configured as an input. More...
 
static ioport_port_mask_t ioport_get_port_level (ioport_pin_t port, ioport_port_mask_t mask)
 Get current value of several IOPORT pins in a single port, which have been configured as an inputs. More...
 
static void ioport_init (void)
 Initializes the IOPORT service, ready for use. More...
 
static ioport_port_mask_t ioport_pin_to_mask (ioport_pin_t pin)
 Convert a pin ID into a bitmask mask for the given pin on its port. More...
 
static ioport_port_t ioport_pin_to_port_id (ioport_pin_t pin)
 Convert a pin ID into a its port ID. More...
 
static void ioport_reset_pin_mode (ioport_pin_t pin)
 Reset pin mode configuration for a single IOPORT pin. More...
 
static void ioport_reset_port_mode (ioport_port_t port, ioport_port_mask_t mask)
 Reset multiple pin modes in a specified IOPORT port to defaults. More...
 
static void ioport_set_pin_dir (ioport_pin_t pin, enum ioport_direction dir)
 Set direction for a single IOPORT pin. More...
 
static void ioport_set_pin_level (ioport_pin_t pin, bool level)
 Set an IOPORT pin to a specified logical value. More...
 
static void ioport_set_pin_mode (ioport_pin_t pin, ioport_mode_t mode)
 Set pin mode for one single IOPORT pin. More...
 
static void ioport_set_pin_sense_mode (ioport_pin_t pin, enum ioport_sense pin_sense)
 Set the pin sense mode of a single IOPORT pin. More...
 
static void ioport_set_port_dir (ioport_port_t port, ioport_port_mask_t mask, enum ioport_direction dir)
 Set I/O direction for a group of pins in a single IOPORT. More...
 
static void ioport_set_port_level (ioport_port_t port, ioport_port_mask_t mask, enum ioport_value level)
 Set a group of IOPORT pins in a single port to a specified logical value. More...
 
static void ioport_set_port_mode (ioport_port_t port, ioport_port_mask_t mask, ioport_mode_t mode)
 Set multiple pin modes in a single IOPORT port, such as pull-up, pull-down, etc. More...
 
static void ioport_set_port_sense_mode (ioport_port_t port, ioport_port_mask_t mask, enum ioport_sense pin_sense)
 Set the pin sense mode of a multiple IOPORT pins on a single port. More...
 
static void ioport_toggle_pin_level (ioport_pin_t pin)
 Toggle the value of an IOPORT pin, which has previously configured as an output. More...
 
static void ioport_toggle_port_level (ioport_port_t port, ioport_port_mask_t mask)
 Toggle the values of several IOPORT pins located in a single port. More...
 

IOPORT Mode bit definitions

#define IOPORT_MODE_MUX_MASK   (0x7 << 0)
 
#define IOPORT_MODE_MUX_BIT0   ( 1 << 0)
 
#define IOPORT_MODE_MUX_A   ( 0 << 0)
 
#define IOPORT_MODE_MUX_B   ( 1 << 0)
 
#define IOPORT_MODE_PULLUP   ( 1 << 3)
 
#define IOPORT_MODE_OPEN_DRAIN   ( 1 << 5)
 
#define IOPORT_MODE_GLITCH_FILTER   ( 1 << 6)
 
#define IOPORT_MODE_DEBOUNCE   ( 1 << 7)
 

#define IOPORT_CREATE_PIN (   port,
  pin 
)    ((IOPORT_ ## port) * 32 + (pin))

Create IOPORT pin number.

Create a IOPORT pin number for use with the IOPORT functions.

Parameters
portIOPORT port (e.g. PORTA, PA or PIOA depending on chosen architecture)
pinIOPORT zero-based index of the I/O pin
#define IOPORT_MODE_DEBOUNCE   ( 1 << 7)

Input debounce

Referenced by arch_ioport_set_port_mode().

#define IOPORT_MODE_GLITCH_FILTER   ( 1 << 6)

Glitch filter

Referenced by arch_ioport_set_port_mode().

#define IOPORT_MODE_MUX_A   ( 0 << 0)

MUX function A

#define IOPORT_MODE_MUX_B   ( 1 << 0)

MUX function B

#define IOPORT_MODE_MUX_BIT0   ( 1 << 0)

MUX BIT0 mask

Referenced by arch_ioport_set_port_mode().

#define IOPORT_MODE_MUX_MASK   (0x7 << 0)

MUX bits mask

#define IOPORT_MODE_OPEN_DRAIN   ( 1 << 5)

Open drain

Referenced by arch_ioport_set_port_mode().

#define IOPORT_MODE_PULLUP   ( 1 << 3)

Pull-up

Referenced by arch_ioport_set_port_mode(), and main().

IOPORT pin directions.

Enumerator
IOPORT_DIR_INPUT 

IOPORT input direction

IOPORT_DIR_OUTPUT 

IOPORT output direction

Enumerator
IOPORT_SENSE_BOTHEDGES 

IOPORT sense both rising and falling edges

IOPORT_SENSE_RISING 

IOPORT sense rising edges

IOPORT_SENSE_FALLING 

IOPORT sense falling edges

IOPORT levels.

Enumerator
IOPORT_PIN_LEVEL_LOW 

IOPORT pin value low

IOPORT_PIN_LEVEL_HIGH 

IOPORT pin value high

static void ioport_disable_pin ( ioport_pin_t  pin)
inlinestatic

Disable IOPORT pin, based on a pin created with IOPORT_CREATE_PIN().

Parameters
pinIOPORT pin to disable

References arch_ioport_disable_pin().

Referenced by configure_tc_trigger(), and main().

static void ioport_disable_port ( ioport_port_t  port,
ioport_port_mask_t  mask 
)
inlinestatic

Disable multiple pins in a single IOPORT port.

Parameters
portIOPORT port to disable
maskPin mask of pins to disable

References arch_ioport_disable_port().

static void ioport_enable_pin ( ioport_pin_t  pin)
inlinestatic

Enable an IOPORT pin, based on a pin created with IOPORT_CREATE_PIN().

Parameters
pinIOPORT pin to enable

References arch_ioport_enable_pin().

static void ioport_enable_port ( ioport_port_t  port,
ioport_port_mask_t  mask 
)
inlinestatic

Enable multiple pins in a single IOPORT port.

Parameters
portIOPORT port to enable
maskMask of pins within the port to enable

References arch_ioport_enable_port().

static bool ioport_get_pin_level ( ioport_pin_t  pin)
inlinestatic

Get current value of an IOPORT pin, which has been configured as an input.

Parameters
pinIOPORT pin to read
Returns
Current logical value of the specified pin

References arch_ioport_get_pin_level().

Referenced by _app_exec(), iso7816_get_reset_statuts(), main(), qt_is_change_line_low(), sd_mmc_is_write_protected(), sd_mmc_select_slot(), trigger_poll(), and wait_for_switches().

static ioport_port_mask_t ioport_get_port_level ( ioport_pin_t  port,
ioport_port_mask_t  mask 
)
inlinestatic

Get current value of several IOPORT pins in a single port, which have been configured as an inputs.

Parameters
portIOPORT port to read
maskPin mask of pins to read
Returns
Logical levels of the specified pins from the read port, returned as a mask.

References arch_ioport_get_port_level().

Referenced by main().

static void ioport_init ( void  )
inlinestatic

Initializes the IOPORT service, ready for use.

This function must be called before using any other functions in the IOPORT service.

References arch_ioport_init().

Referenced by main().

static ioport_port_mask_t ioport_pin_to_mask ( ioport_pin_t  pin)
inlinestatic

Convert a pin ID into a bitmask mask for the given pin on its port.

Parameters
pinIOPORT pin ID to convert
Return values
Bitmaskwith a bit set that corresponds to the given pin ID in its port

References arch_ioport_pin_to_mask().

static ioport_port_t ioport_pin_to_port_id ( ioport_pin_t  pin)
inlinestatic

Convert a pin ID into a its port ID.

Parameters
pinIOPORT pin ID to convert
Return values
PortID for the given pin ID

References arch_ioport_pin_to_port_id().

static void ioport_reset_pin_mode ( ioport_pin_t  pin)
inlinestatic

Reset pin mode configuration for a single IOPORT pin.

Parameters
pinIOPORT pin to configure

References arch_ioport_set_pin_mode().

static void ioport_reset_port_mode ( ioport_port_t  port,
ioport_port_mask_t  mask 
)
inlinestatic

Reset multiple pin modes in a specified IOPORT port to defaults.

Parameters
portIOPORT port to configure
maskMask of pins whose mode configuration is to be reset

References arch_ioport_set_port_mode().

static void ioport_set_pin_dir ( ioport_pin_t  pin,
enum ioport_direction  dir 
)
inlinestatic

Set direction for a single IOPORT pin.

Parameters
pinIOPORT pin to configure
dirDirection to set for the specified pin (ioport_direction)

References arch_ioport_set_pin_dir().

Referenced by _app_exec(), and main().

static void ioport_set_pin_level ( ioport_pin_t  pin,
bool  level 
)
inlinestatic

Set an IOPORT pin to a specified logical value.

Parameters
pinIOPORT pin to configure
levelLogical value of the pin

References arch_ioport_set_pin_level().

Referenced by iso7816_icc_power_off(), iso7816_icc_power_on(), iso7816_init(), main(), ProcessButtonEvt(), qt_hardware_reset(), sn65hvd234_disable(), sn65hvd234_disable_low_power(), sn65hvd234_enable(), and sn65hvd234_enable_low_power().

static void ioport_set_pin_mode ( ioport_pin_t  pin,
ioport_mode_t  mode 
)
inlinestatic

Set pin mode for one single IOPORT pin.

Parameters
pinIOPORT pin to configure
modeMode masks to configure for the specified pin (IOPORT Modes)

References arch_ioport_set_pin_mode().

Referenced by configure_tc_trigger(), and main().

static void ioport_set_pin_sense_mode ( ioport_pin_t  pin,
enum ioport_sense  pin_sense 
)
inlinestatic

Set the pin sense mode of a single IOPORT pin.

Parameters
pinIOPORT pin to configure
pin_senseEdge to sense for the pin (ioport_sense)

References arch_ioport_set_pin_sense_mode().

Referenced by main().

static void ioport_set_port_dir ( ioport_port_t  port,
ioport_port_mask_t  mask,
enum ioport_direction  dir 
)
inlinestatic

Set I/O direction for a group of pins in a single IOPORT.

Parameters
portIOPORT port to configure
maskPin mask of pins to configure
dirDirection to set for the specified pins (ioport_direction)

References arch_ioport_set_port_dir().

Referenced by main().

static void ioport_set_port_level ( ioport_port_t  port,
ioport_port_mask_t  mask,
enum ioport_value  level 
)
inlinestatic

Set a group of IOPORT pins in a single port to a specified logical value.

Parameters
portIOPORT port to write to
maskPin mask of pins to modify
levelLevel of the pins to be modified

References arch_ioport_set_port_level().

Referenced by main().

static void ioport_set_port_mode ( ioport_port_t  port,
ioport_port_mask_t  mask,
ioport_mode_t  mode 
)
inlinestatic

Set multiple pin modes in a single IOPORT port, such as pull-up, pull-down, etc.

configuration.

Parameters
portIOPORT port to configure
maskPin mask of pins to configure
modeMode masks to configure for the specified pins (IOPORT Modes)

References arch_ioport_set_port_mode().

Referenced by main().

static void ioport_set_port_sense_mode ( ioport_port_t  port,
ioport_port_mask_t  mask,
enum ioport_sense  pin_sense 
)
inlinestatic

Set the pin sense mode of a multiple IOPORT pins on a single port.

Parameters
portIOPORT port to configure
maskBitmask if pins whose edge sense is to be configured
pin_senseEdge to sense for the pins (ioport_sense)

References arch_ioport_set_port_sense_mode().

static void ioport_toggle_pin_level ( ioport_pin_t  pin)
inlinestatic

Toggle the value of an IOPORT pin, which has previously configured as an output.

Parameters
pinIOPORT pin to toggle

References arch_ioport_toggle_pin_level().

Referenced by main(), TC0_Handler(), and toggle_led_test().

static void ioport_toggle_port_level ( ioport_port_t  port,
ioport_port_mask_t  mask 
)
inlinestatic

Toggle the values of several IOPORT pins located in a single port.

Parameters
portIOPORT port to modify
maskPin mask of pins to toggle

References arch_ioport_toggle_port_level().

Referenced by main().