Xmega Application Note


pmic_driver.h File Reference


Detailed Description

XMEGA PMIC driver header file.

This file contains the function prototypes and enumerator definitions for various configuration parameters for the XMEGA Programmable Multi-level Interrupt Controller driver/example.

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 PMIC 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.

Application note:
AVR1305: XMEGA Interrupts and the Programmable Multi-level Interrupt Controller
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 pmic_driver.h.

#include "avr_compiler.h"

Include dependency graph for pmic_driver.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines

#define PMIC_DisableHighLevel()   (PMIC.CTRL &= ~PMIC_HILVLEN_bm)
 Disable high-level interrupts.
#define PMIC_DisableLowLevel()   (PMIC.CTRL &= ~PMIC_LOLVLEN_bm)
 Disable low-level interrupts.
#define PMIC_DisableMediumLevel()   (PMIC.CTRL &= ~PMIC_MEDLVLEN_bm)
 Disable medium-level interrupts.
#define PMIC_DisableRoundRobin()   (PMIC.CTRL &= ~PMIC_RREN_bm)
 Disable round-robin scheduling for low-level interrupts.
#define PMIC_EnableHighLevel()   (PMIC.CTRL |= PMIC_HILVLEN_bm)
 Enable high-level interrupts.
#define PMIC_EnableLowLevel()   (PMIC.CTRL |= PMIC_LOLVLEN_bm)
 Enable low-level interrupts.
#define PMIC_EnableMediumLevel()   (PMIC.CTRL |= PMIC_MEDLVLEN_bm)
 Enable medium-level interrupts.
#define PMIC_EnableRoundRobin()   (PMIC.CTRL |= PMIC_RREN_bm)
 Enable round-robin scheduling for low-level interrupts.
#define PMIC_IsHighLevelExecuting()   (PMIC.STATUS & PMIC_HILVLEX_bm)
 Check if a high-level interrupt handler is currently executing.
#define PMIC_IsLowLevelExecuting()   (PMIC.STATUS & PMIC_LOLVLEX_bm)
 Check if a low-level interrupt handler is currently executing.
#define PMIC_IsMediumLevelExecuting()   (PMIC.STATUS & PMIC_MEDLVLEX_bm)
 Check if a medium-level interrupt handler is currently executing.
#define PMIC_IsNMIExecuting()   (PMIC.STATUS & PMIC_NMIEX_bm)
 Check if an NMI handler is currently executing.
#define PMIC_SetNextRoundRobinInterrupt(_vectorAddress)   (PMIC.INTPRI = (_vectorAddress >> 2) - 1)
 Set interrupt priority for round-robin scheduling.

Functions

void PMIC_SetVectorLocationToApplication (void)
 Move interrupt vector table to application area.
void PMIC_SetVectorLocationToBoot (void)
 Move interrupt vector table to boot area.


Define Documentation

 
#define PMIC_DisableHighLevel (  )     (PMIC.CTRL &= ~PMIC_HILVLEN_bm)

Disable high-level interrupts.

Definition at line 89 of file pmic_driver.h.

 
#define PMIC_DisableLowLevel (  )     (PMIC.CTRL &= ~PMIC_LOLVLEN_bm)

Disable low-level interrupts.

Definition at line 73 of file pmic_driver.h.

 
#define PMIC_DisableMediumLevel (  )     (PMIC.CTRL &= ~PMIC_MEDLVLEN_bm)

Disable medium-level interrupts.

Definition at line 81 of file pmic_driver.h.

 
#define PMIC_DisableRoundRobin (  )     (PMIC.CTRL &= ~PMIC_RREN_bm)

Disable round-robin scheduling for low-level interrupts.

Definition at line 97 of file pmic_driver.h.

 
#define PMIC_EnableHighLevel (  )     (PMIC.CTRL |= PMIC_HILVLEN_bm)

Enable high-level interrupts.

Definition at line 85 of file pmic_driver.h.

Referenced by main().

 
#define PMIC_EnableLowLevel (  )     (PMIC.CTRL |= PMIC_LOLVLEN_bm)

Enable low-level interrupts.

Definition at line 69 of file pmic_driver.h.

Referenced by main().

 
#define PMIC_EnableMediumLevel (  )     (PMIC.CTRL |= PMIC_MEDLVLEN_bm)

Enable medium-level interrupts.

Definition at line 77 of file pmic_driver.h.

Referenced by main().

 
#define PMIC_EnableRoundRobin (  )     (PMIC.CTRL |= PMIC_RREN_bm)

Enable round-robin scheduling for low-level interrupts.

Definition at line 93 of file pmic_driver.h.

 
#define PMIC_IsHighLevelExecuting (  )     (PMIC.STATUS & PMIC_HILVLEX_bm)

Check if a high-level interrupt handler is currently executing.

Returns:
Non-zero if interrupt handler is executing. Zero otherwise.

Definition at line 120 of file pmic_driver.h.

 
#define PMIC_IsLowLevelExecuting (  )     (PMIC.STATUS & PMIC_LOLVLEX_bm)

Check if a low-level interrupt handler is currently executing.

Returns:
Non-zero if interrupt handler is executing. Zero otherwise.

Definition at line 136 of file pmic_driver.h.

 
#define PMIC_IsMediumLevelExecuting (  )     (PMIC.STATUS & PMIC_MEDLVLEX_bm)

Check if a medium-level interrupt handler is currently executing.

Returns:
Non-zero if interrupt handler is executing. Zero otherwise.

Definition at line 128 of file pmic_driver.h.

 
#define PMIC_IsNMIExecuting (  )     (PMIC.STATUS & PMIC_NMIEX_bm)

Check if an NMI handler is currently executing.

Returns:
Non-zero if interrupt handler is executing. Zero otherwise.

Definition at line 144 of file pmic_driver.h.

#define PMIC_SetNextRoundRobinInterrupt ( _vectorAddress   )     (PMIC.INTPRI = (_vectorAddress >> 2) - 1)

Set interrupt priority for round-robin scheduling.

This macro selects which low-level interrupt has highest priority. Use this function together with round-robin scheduling.

Note:
The INTPRI register wants the vector _number_ (not address) of the lowest prioritized interrupt among low-level interrupts. Since vector addresses lies on 4-byte boundaries, we divide by 4.
Parameters:
_vectorAddress Number between 0 and the maximum vector address for the device.

Definition at line 112 of file pmic_driver.h.


Function Documentation

void PMIC_SetVectorLocationToApplication ( void   ) 

Move interrupt vector table to application area.

This function moves the interrupt vector table to application area. The function writes the correct signature to the Configuration Change Protection register before writing the CTRL register. Interrupts are automatically ignored during the change enable period.

Definition at line 86 of file pmic_driver.c.

Referenced by main().

00087 {
00088         uint8_t temp = PMIC.CTRL & ~PMIC_IVSEL_bm;
00089         CCP = CCP_IOREG_gc;
00090         PMIC.CTRL = temp;
00091 }

void PMIC_SetVectorLocationToBoot ( void   ) 

Move interrupt vector table to boot area.

This function moves the interrupt vector table to boot area. The function writes the correct signature to the Configuration Change Protection register before writing the CTRL register. Interrupts are automatically ignored during the change enable period.

Definition at line 71 of file pmic_driver.c.

00072 {
00073         uint8_t temp = PMIC.CTRL | PMIC_IVSEL_bm;
00074         CCP = CCP_IOREG_gc;
00075         PMIC.CTRL = temp;
00076 }

@DOC_TITLE@
Generated on Wed Apr 23 07:41:40 2008 for AVR1305 XMEGA Interrupts and the Programmable Multi-level Interrupt Controller by doxygen 1.5.5