sim_irq.h

Go to the documentation of this file.

/*
 * sim_irq.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 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_IRQ_H__
#define __SIM_IRQ_H__

#include <stdint.h>

#ifdef __cplusplus
extern "C"
{
#endif

  struct avr_irq_t;

  typedef void (*avr_irq_notify_t) (struct avr_irq_t * irq, uint32_t value, void *param);

  enum
    {
      IRQ_FLAG_NOT = (1 << 0),   
      IRQ_FLAG_FILTERED = (1 << 1),   
      IRQ_FLAG_ALLOC = (1 << 2),   
      IRQ_FLAG_INIT = (1 << 3),   
    };

  typedef struct avr_irq_pool_t
  {
    int count;   
    struct avr_irq_t **irq;   
  } avr_irq_pool_t;

  typedef struct avr_irq_t
  {
    struct avr_irq_pool_t *pool;   // TODO: migration in progress
    const char *name;
    uint32_t irq;   
    uint32_t value;   
    uint8_t flags;   
    struct avr_irq_hook_t *hook;   
  } avr_irq_t;

  avr_irq_t *avr_alloc_irq (avr_irq_pool_t * pool, uint32_t base, uint32_t count,
                            const char **names /* optional */ );
  void avr_free_irq (avr_irq_t * irq, uint32_t count);

  void avr_init_irq (avr_irq_pool_t * pool, avr_irq_t * irq, uint32_t base, uint32_t count,
                     const char **names /* optional */ );

  void avr_raise_irq (avr_irq_t * irq, uint32_t value);

  void avr_connect_irq (avr_irq_t * src, avr_irq_t * dst);
  void avr_unconnect_irq (avr_irq_t * src, avr_irq_t * dst);

  void avr_irq_register_notify (avr_irq_t * irq, avr_irq_notify_t notify, void *param);
  void avr_irq_unregister_notify (avr_irq_t * irq, avr_irq_notify_t notify, void *param);

#ifdef __cplusplus
};
#endif

#endif /* __SIM_IRQ_H__ */