sim_vcd_file.h

Go to the documentation of this file.

/*
 * sim_vcd_file.c
 *
 * 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 __SIM_VCD_FILE_H__
#define __SIM_VCD_FILE_H__

#include <stdio.h>
#include "sim_irq.h"

#ifdef __cplusplus
extern "C"
{
#endif

#define AVR_VCD_MAX_SIGNALS 32

  typedef struct avr_vcd_signal_t
  {
    avr_irq_t irq;    
    char alias;    
    int size;    
    char name[32];    
  } avr_vcd_signal_t;

  typedef struct avr_vcd_log_t
  {
    uint64_t when;
    avr_vcd_signal_t *signal;
    uint32_t value;
  } avr_vcd_log_t, *avr_vcd_log_p;

#define AVR_VCD_LOG_CHUNK_SIZE (4096 / sizeof(avr_vcd_signal_t))

  typedef struct avr_vcd_t
  {
    struct avr_t *avr;    

    char filename[74];    
    FILE *output;

    int signal_count;
    avr_vcd_signal_t signal[AVR_VCD_MAX_SIGNALS];

    uint64_t period;
    uint64_t start;

    size_t logsize;
    uint32_t logindex;
    avr_vcd_log_p log;
  } avr_vcd_t;

  int avr_vcd_init (struct avr_t *avr, const char *filename,   // filename to write
                    avr_vcd_t * vcd,   // vcd struct to initialize
                    uint32_t period);   // file flushing period is in usec
  void avr_vcd_close (avr_vcd_t * vcd);

  int avr_vcd_add_signal (avr_vcd_t * vcd, avr_irq_t * signal_irq, int signal_bit_size, const char *name);

  int avr_vcd_start (avr_vcd_t * vcd);
  int avr_vcd_stop (avr_vcd_t * vcd);

#ifdef __cplusplus
};
#endif

#endif /* __SIM_VCD_FILE_H__ */