sim_io.h

Go to the documentation of this file.

/*
 *  sim_io.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 __SIM_IO_H__
#define __SIM_IO_H__

#include "sim_avr.h"

#ifdef __cplusplus
extern "C"
{
#endif

#define AVR_IOCTL_DEF(_a,_b,_c,_d)          \
  (((_a) << 24)|((_b) << 16)|((_c) << 8)|((_d)))

  typedef struct avr_io_t
  {
    struct avr_io_t *next;
    avr_t *avr;    
    const char *kind;    

    const char **irq_names;    

    uint32_t irq_ioctl_get;    
    int irq_count;    
    struct avr_irq_t *irq;    

    void (*reset) (struct avr_io_t * io);
    int (*ioctl) (struct avr_io_t * io, uint32_t ctl, void *io_param);
    void (*dealloc) (struct avr_io_t * io);
  } avr_io_t;

  /*
   * IO modules helper functions
   */

  void avr_register_io (avr_t * avr, avr_io_t * io);
  avr_irq_t *avr_io_setirqs (avr_io_t * io, uint32_t ctl, int count, avr_irq_t * irqs);

  void avr_register_io_read (avr_t * avr, avr_io_addr_t addr, avr_io_read_t read, void *param);
  void avr_register_io_write (avr_t * avr, avr_io_addr_t addr, avr_io_write_t write, void *param);
  int avr_ioctl (avr_t * avr, uint32_t ctl, void *io_param);
  struct avr_irq_t *avr_io_getirq (avr_t * avr, uint32_t ctl, int index);

#define AVR_IOMEM_IRQ_ALL 8

  avr_irq_t *avr_iomem_getirq (avr_t * avr,
                               avr_io_addr_t addr,
                               const char *name /* Optional, if NULL, "ioXXXX" will be used */ ,
                               int index);

  void avr_deallocate_ios (avr_t * avr);

#ifdef __cplusplus
};
#endif

#endif /* __SIM_IO_H__ */