avr_timer.h

Go to the documentation of this file.

/*
 * avr_timer.h
 *
 * Copyright 2008, 2009 Michel Pollet <buserror@gmail.com>
 *
 * This file is part of simavr.
 *
 * simavr is free software: you can redistribute it and/or modify it under the terms of the GNU
 * General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * simavr is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
 * Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with simavr.  If not, see
 * <http://www.gnu.org/licenses/>.
 */

#ifndef __AVR_TIMER_H__
#define __AVR_TIMER_H__

#ifdef __cplusplus
extern "C"
{
#endif
  
#include "sim_avr.h"

  enum
    {
      AVR_TIMER_COMPA = 0,
      AVR_TIMER_COMPB,
      AVR_TIMER_COMPC,

      AVR_TIMER_COMP_COUNT
    };

  enum
    {
      TIMER_IRQ_OUT_PWM0 = 0,
      TIMER_IRQ_OUT_PWM1,
      TIMER_IRQ_OUT_COMP,   

      TIMER_IRQ_COUNT = TIMER_IRQ_OUT_COMP + AVR_TIMER_COMP_COUNT
    };

#define AVR_IOCTL_TIMER_GETIRQ(_name) AVR_IOCTL_DEF('t','m','r',(_name))

  enum
    {
      avr_timer_wgm_none = 0,   // invalid mode
      avr_timer_wgm_normal,
      avr_timer_wgm_ctc,
      avr_timer_wgm_pwm,
      avr_timer_wgm_fast_pwm,
      avr_timer_wgm_fc_pwm,
    };

  enum
    {
      avr_timer_com_normal = 0,   
      avr_timer_com_toggle,   
      avr_timer_com_clear,   
      avr_timer_com_set,   
    };

  enum
    {
      avr_timer_wgm_reg_constant = 0,
      avr_timer_wgm_reg_ocra,
      avr_timer_wgm_reg_icr,
    };
  typedef struct avr_timer_wgm_t
  {
    uint32_t top:8, bottom:8, size:8, kind:8;
  } avr_timer_wgm_t;

#define AVR_TIMER_WGM_NORMAL8() { .kind = avr_timer_wgm_normal, .size=8 }
#define AVR_TIMER_WGM_NORMAL16() { .kind = avr_timer_wgm_normal, .size=16 }
#define AVR_TIMER_WGM_CTC() { .kind = avr_timer_wgm_ctc, .top = avr_timer_wgm_reg_ocra }
#define AVR_TIMER_WGM_ICCTC() { .kind = avr_timer_wgm_ctc, .top = avr_timer_wgm_reg_icr }
#define AVR_TIMER_WGM_FASTPWM8() { .kind = avr_timer_wgm_fast_pwm, .size=8 }
#define AVR_TIMER_WGM_FASTPWM9() { .kind = avr_timer_wgm_fast_pwm, .size=9 }
#define AVR_TIMER_WGM_FASTPWM10() { .kind = avr_timer_wgm_fast_pwm, .size=10 }
#define AVR_TIMER_WGM_FCPWM8() { .kind = avr_timer_wgm_fc_pwm, .size=8 }
#define AVR_TIMER_WGM_FCPWM9() { .kind = avr_timer_wgm_fc_pwm, .size=9 }
#define AVR_TIMER_WGM_FCPWM10() { .kind = avr_timer_wgm_fc_pwm, .size=10 }
#define AVR_TIMER_WGM_OCPWM() { .kind = avr_timer_wgm_pwm, .top = avr_timer_wgm_reg_ocra }
#define AVR_TIMER_WGM_ICPWM() { .kind = avr_timer_wgm_pwm, .top = avr_timer_wgm_reg_icr }

  typedef struct avr_timer_comp_t
  {
    avr_int_vector_t interrupt;   
    struct avr_timer_t *timer;   
    avr_io_addr_t r_ocr;   
    avr_io_addr_t r_ocrh;   
    avr_regbit_t com;   
    avr_regbit_t com_pin;   
    uint64_t comp_cycles;
  } avr_timer_comp_t, *avr_timer_comp_p;

  typedef struct avr_timer_t
  {
    avr_io_t io;
    char name;

    avr_regbit_t disabled;   

    avr_io_addr_t r_tcnt, r_icr;
    avr_io_addr_t r_tcnth, r_icrh;

    avr_regbit_t wgm[4];
    avr_timer_wgm_t wgm_op[16];
    avr_timer_wgm_t mode;
    int wgm_op_mode_kind;
    uint32_t wgm_op_mode_size;

    avr_regbit_t as2;   
    avr_regbit_t cs[4];
    uint8_t cs_div[16];
    uint32_t cs_div_clock;

    avr_regbit_t icp;   
    avr_regbit_t ices;   

    avr_timer_comp_t comp[AVR_TIMER_COMP_COUNT];

    avr_int_vector_t overflow;   
    avr_int_vector_t icr;   

    uint64_t tov_cycles;
    uint64_t tov_base;   
    uint16_t tov_top;   
  } avr_timer_t;

  void avr_timer_init (avr_t * avr, avr_timer_t * port);

#ifdef __cplusplus
};
#endif

#endif /*__AVR_TIMER_H__*/