port_driver.c File Reference


Detailed Description

XMEGA I/O Port driver source file.

This file contains the function implementations the XMEGA I/O Port driver.

The driver is not intended for size and/or speed critical code, since most functions are just a few lines of code, and the function call overhead would decrease code performance. The driver is intended for rapid prototyping and documentation purposes for getting started with the XMEGA I/O Port module.

For size and/or speed critical code, it is recommended to copy the function contents directly into your application instead of making a function call.

Several functions use the following construct: "some_register = ... | (some_parameter ? SOME_BIT_bm : 0) | ..." Although the use of the ternary operator ( if ? then : else ) is discouraged, in some occasions the operator makes it possible to write pretty clean and neat code. In this driver, the construct is used to set or not set a configuration bit based on a boolean input parameter, such as the "some_parameter" in the example above.

Application note:
AVR1313: Using the XMEGA I/O Pins and External Interrupts
Documentation
For comprehensive code documentation, supported compilers, compiler settings and supported devices see readme.html
Author:
Atmel Corporation: http://www.atmel.com
Support email: avr@atmel.com
Revision
1569
Date
2008-04-22 13:03:43 +0200 (ti, 22 apr 2008)

Copyright (c) 2008, Atmel Corporation All rights reserved.

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.

THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 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.

Definition in file port_driver.c.

#include "port_driver.h"

Include dependency graph for port_driver.c:

Go to the source code of this file.

Functions

void PORT_ConfigureInterrupt0 (PORT_t *port, PORT_INT0LVL_t intLevel, uint8_t pinMask)
 Configures interrupt 0.
void PORT_ConfigureInterrupt1 (PORT_t *port, PORT_INT1LVL_t intLevel, uint8_t pinMask)
 Configures interrupt 1.
void PORT_ConfigurePins (PORT_t *port, uint8_t pinMask, uint8_t slewRateEnable, uint8_t invertEnable, PORT_OPC_t opc, PORT_ISC_t isc)
 This function changes the configuration of a set of pins.
void PORT_MapVirtualPort0 (PORTCFG_VP0MAP_t realPort)
 Maps a real port to virtual port 0.
void PORT_MapVirtualPort1 (PORTCFG_VP1MAP_t realPort)
 Maps a real port to virtual port 1.
void PORT_MapVirtualPort2 (PORTCFG_VP2MAP_t realPort)
 Maps a real port to virtual port 2.
void PORT_MapVirtualPort3 (PORTCFG_VP3MAP_t realPort)
 Maps a real port to virtual port 3.


Function Documentation

void PORT_ConfigureInterrupt0 ( PORT_t *  port,
PORT_INT0LVL_t  intLevel,
uint8_t  pinMask 
)

Configures interrupt 0.

This function configures interrupt 0 to be associated with a set of pins and sets the desired interrupt level.

Parameters:
port The port to configure.
intLevel The desired interrupt level for port interrupt 0.
pinMask A mask that selects the pins to associate with port interrupt 0.

Definition at line 80 of file port_driver.c.

00083 {
00084         port->INTCTRL = ( port->INTCTRL & ~PORT_INT0LVL_gm ) | intLevel;
00085         port->INT0MASK = pinMask;
00086 }

void PORT_ConfigureInterrupt1 ( PORT_t *  port,
PORT_INT1LVL_t  intLevel,
uint8_t  pinMask 
)

Configures interrupt 1.

This function configures interrupt 1 to be associated with a set of pins and sets the desired interrupt level.

Parameters:
port The port to configure.
intLevel The desired interrupt level for port interrupt 1.
pinMask A mask that selects the pins to associate with port interrupt 1.

Definition at line 98 of file port_driver.c.

00101 {
00102         port->INTCTRL = ( port->INTCTRL & ~PORT_INT1LVL_gm ) | intLevel;
00103         port->INT1MASK = pinMask;
00104 }

void PORT_ConfigurePins ( PORT_t *  port,
uint8_t  pinMask,
uint8_t  slewRateEnable,
uint8_t  invertEnable,
PORT_OPC_t  opc,
PORT_ISC_t  isc 
)

This function changes the configuration of a set of pins.

Parameters:
port The port.
pinMask A bit mask that selects the pins to configure.
slewRateEnable Enable/disable slew rate control.
invertEnable Enable/disable I/O inversion.
opc Output/Pull Configuration.
isc Input/Sense Configuration.

Definition at line 117 of file port_driver.c.

00123 {
00124         /* Build pin control register value. */
00125         uint8_t temp = (uint8_t) opc |
00126                        isc |
00127                        (slewRateEnable ? PORT_SRLEN_bm : 0) |
00128                        (invertEnable ? PORT_INVEN_bm : 0);
00129 
00130         /* Configure the pins in one atomic operation. */
00131 
00132         /* Save status register. */
00133         uint8_t sreg = SREG;
00134 
00135         cli();
00136         PORTCFG.MPCMASK = pinMask;
00137         port->PIN0CTRL = temp;
00138 
00139         /* Restore status register. */
00140         SREG = sreg;
00141 }

void PORT_MapVirtualPort0 ( PORTCFG_VP0MAP_t  realPort  ) 

Maps a real port to virtual port 0.

This function maps a real port to virtual port 0 to make some of the registers available in I/O space.

Parameters:
realPort Selects the real port to map to virtual port 0.

Definition at line 151 of file port_driver.c.

00152 {
00153         PORTCFG.VPCTRLA = ( PORTCFG.VPCTRLA & ~PORTCFG_VP0MAP_gm ) | realPort;
00154 }

void PORT_MapVirtualPort1 ( PORTCFG_VP1MAP_t  realPort  ) 

Maps a real port to virtual port 1.

This function maps a real port to virtual port 1 to make some of the registers available in I/O space.

Parameters:
realPort Selects the real port to map to virtual port 1.

Definition at line 164 of file port_driver.c.

00165 {
00166         PORTCFG.VPCTRLA = ( PORTCFG.VPCTRLA & ~PORTCFG_VP1MAP_gm ) | realPort;
00167 }

void PORT_MapVirtualPort2 ( PORTCFG_VP2MAP_t  realPort  ) 

Maps a real port to virtual port 2.

This function maps a real port to virtual port 2 to make some of the registers available in I/O space.

Parameters:
realPort Selects the real port to map to virtual port 2.

Definition at line 177 of file port_driver.c.

00178 {
00179         PORTCFG.VPCTRLB = ( PORTCFG.VPCTRLB & ~PORTCFG_VP2MAP_gm ) | realPort;
00180 }

void PORT_MapVirtualPort3 ( PORTCFG_VP3MAP_t  realPort  ) 

Maps a real port to virtual port 3.

This function maps a real port to virtual port 3 to make some of the registers available in I/O space.

Parameters:
realPort Selects the real port to map to virtual port 3.

Definition at line 190 of file port_driver.c.

00191 {
00192         PORTCFG.VPCTRLB = ( PORTCFG.VPCTRLB & ~PORTCFG_VP3MAP_gm ) | realPort;
00193 }


Generated on Fri Sep 4 16:08:56 2009 for AVR1606: Calibration of the internal RC oscillator of XMEGA by  doxygen 1.5.6