timer.h

Go to the documentation of this file.

/*This file has been prepared for Doxygen automatic documentation generation.*/
/* ************************************************************************

Copyright (c) 2006, 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. 

************************************************************************ */

#ifndef _TIMER_H_
#define _TIMER_H_

#ifdef __GNUC__
#include <avr32/io.h>
#elif __ICCAVR32__
#include <avr32/ioap7000.h>
#else
#error No known compiler used
#endif

#define AVR32_TIMER_COUNT  2
#define TIMER_NUMBER_OF_CHANNELS 3

#define TIMER_INVALID_ARGUMENT          -1
#define TIMER_NUMBER_OF_CHANNELS                3

#define TIMER_COUNTING_MODE_RESTART     0
#define TIMER_COUNTING_MODE_INVERT              1

#define TIMER_CLOCK_SOURCE_TC1          0
#define TIMER_CLOCK_SOURCE_TC2          1
#define TIMER_CLOCK_SOURCE_TC3          2
#define TIMER_CLOCK_SOURCE_TC4          3
#define TIMER_CLOCK_SOURCE_TC5          4
#define TIMER_CLOCK_SOURCE_XC0          5
#define TIMER_CLOCK_SOURCE_XC1          6
#define TIMER_CLOCK_SOURCE_XC2          7

#define TIMER_CLOCK_RISING_EDGE         0
#define TIMER_CLOCK_FALLING_EDGE                1

#define TIMER_TRIGGER_SW                        11
#define TIMER_TRIGGER_SYNC                      12
#define TIMER_TRIGGER_COMPARE_RC                13

#define TIMER_RB_LOAD_STOP                      1
#define TIMER_RB_LOAD_DISABLE                   2

#define TIMER_SEL_NO_EDGE                       0
#define TIMER_SEL_RISING_EDGE                   1
#define TIMER_SEL_FALLING_EDGE          2
#define TIMER_SEL_EACH_EDGE                     3

#define TIMER_EXT_TRIG_SEL_TIOA         1
#define TIMER_EXT_TRIG_SEL_TIOB         0

/* Operating modes */
#define TIMER_CAPTURE_OPERATING_MODE    0

#define TIMER_WAVEFORM_OPERATING_MODE           1

#define TIMER_WAVEFORM_SEL_UP_MODE                              0
#define TIMER_WAVEFORM_SEL_UP_MODE_RC_TRIGGER           2
#define TIMER_WAVEFORM_SEL_UPDOWN_MODE_RC_TRIGGER       1
#define TIMER_WAVEFORM_SEL_UPDOWN_MODE                  3

#define TIMER_SUCCESS 0
#define TIMER_INVALID_ARGUMENT -1

struct timer_capture_opt_t{

  int channel;
  
  int tcclks:3;

  int clki:1;
  
  int burst:2;

  int ldbstop:1;
  
  int ldbdis:1;
  
  int etrgedg:2;
  
  int abetrg:1;
  
  int cpctrg:1;
  
  int ldra:2;
  
  int ldrb:2;
  
};

struct timer_waveform_opt_t{

  int channel;

  int tcclks:3;
  
  int clki:1;
  
  int burst:2;
  
  int cpcstop:1;
  
  int cpcdis:1;
  
  int eevtedg:1;
  
  int eevt:2;
  
  int enetrg:1;

  int wavsel:2;

  int acpa:2;

  int acpc:2;

  int aeevt:2;

  int aswtrg:2;

  int bcpb:2;

  int bcpc:2;

  int beevt:2;

  int bswtrg:2;
};

struct timer_interrupt_t{
        int covfs :1;

        int lovrs :1;

        int cpas :1;

        int cpbs :1;

        int cpcs :1;

        int ldras :1;

        int ldrbs :1;

        int etrgs :1;
};

/* ************************************************************************

INIT FUNCTIONS

************************************************************************ */

int timer_init_capture( unsigned int instance, volatile struct timer_capture_opt_t *opt );


int timer_init_waveform( unsigned int instance, volatile struct timer_waveform_opt_t *opt );


/* ************************************************************************

START / STOP FUNCTIONS

************************************************************************ */

int timer_start( unsigned int instance, unsigned int channel );


int timer_stop( unsigned int instance, unsigned int channel );


/* ************************************************************************

TRIGGER AND CLOCK SELECTIONS

************************************************************************ */

int timer_software_trigger( unsigned int instance, unsigned int channel);


void timer_sync_trigger( unsigned int instance );


int timer_external_clock_selection( unsigned int instance, unsigned int channel, unsigned int clock_signal );


/* ************************************************************************

READ / WRITE COMPARE REGISTERS AND COUNTER CLOCK

************************************************************************ */

int timer_read_ra( unsigned int instance, unsigned int channel );


int timer_read_rb( unsigned int instance, unsigned int channel );


int timer_read_rc( unsigned int instance, unsigned int channel );


int timer_read_tc( unsigned int instance, unsigned int channel );


int timer_write_ra( unsigned int instance, unsigned int channel, unsigned short value );


int timer_write_rb( unsigned int instance, unsigned int channel, unsigned short value );


int timer_write_rc( unsigned int instance, unsigned int channel, unsigned short value );


/* ************************************************************************

INTERRUPT FUNCTIONS

************************************************************************ */

int timer_configure_interrupts(unsigned int instance, unsigned int channel, volatile struct timer_interrupt_t *bitfield);


char timer_interrupt_settings(unsigned int instance, unsigned int channel);


/* ************************************************************************

VARIOUS FUNCTIONS

************************************************************************ */

volatile avr32_timer_t * timer_getHandle( unsigned int instance );


unsigned long timer_read_sr( unsigned int instance, unsigned int channel );


#endif

---