git.rot13.org Git - simavr/blob - simavr/sim/avr_ioport.h

   1 /*
   2         avr_ioport.h
   3
   4         Copyright 2008, 2009 Michel Pollet <buserror@gmail.com>
   5
   6         This file is part of simavr.
   7
   8         simavr is free software: you can redistribute it and/or modify
   9         it under the terms of the GNU General Public License as published by
  10         the Free Software Foundation, either version 3 of the License, or
  11         (at your option) any later version.
  12
  13         simavr is distributed in the hope that it will be useful,
  14         but WITHOUT ANY WARRANTY; without even the implied warranty of
  15         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16         GNU General Public License for more details.
  17
  18         You should have received a copy of the GNU General Public License
  19         along with simavr.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #ifndef __AVR_IOPORT_H__
  23 #define __AVR_IOPORT_H__
  24
  25 #include "sim_avr.h"
  26
  27 enum {
  28         IOPORT_IRQ_PIN0 = 0,
  29         IOPORT_IRQ_PIN1,IOPORT_IRQ_PIN2,IOPORT_IRQ_PIN3,IOPORT_IRQ_PIN4,
  30         IOPORT_IRQ_PIN5,IOPORT_IRQ_PIN6,IOPORT_IRQ_PIN7,
  31         IOPORT_IRQ_PIN_ALL,
  32         IOPORT_IRQ_DIRECTION_ALL,
  33         IOPORT_IRQ_COUNT
  34 };
  35
  36 #define AVR_IOPORT_OUTPUT 0x100
  37
  38 // add port name (uppercase) to get the real IRQ
  39 #define AVR_IOCTL_IOPORT_GETIRQ(_name) AVR_IOCTL_DEF('i','o','g',(_name))
  40
  41
  42 // this ioctl takes a avr_regbit_t, compares the register address
  43 // to PORT/PIN/DDR and return the corresponding IRQ(s) if it matches
  44 typedef struct avr_ioport_getirq_t {
  45         avr_regbit_t bit;       // bit wanted
  46         avr_irq_t * irq[8];     // result, terminated by NULL if < 8
  47 } avr_ioport_getirq_t;
  48
  49 #define AVR_IOCTL_IOPORT_GETIRQ_REGBIT AVR_IOCTL_DEF('i','o','g','r')
  50
  51 /*
  52  * ioctl used to get a port state.
  53  *
  54  * for (int i = 'A'; i <= 'F'; i++) {
  55  *      avr_ioport_state_t state;
  56  *      if (avr_ioctl(AVR_IOCTL_IOPORT_GETSTATE(i), &state) == 0)
  57  *              printf("PORT%c %02x DDR %02x PIN %02x\n",
  58  *                      state.name, state.port, state.ddr, state.pin);
  59  * }
  60  */
  61 typedef struct avr_ioport_state_t {
  62         unsigned long name : 7,
  63                 port : 8, ddr : 8, pin : 8;
  64 } avr_ioport_state_t;
  65
  66 // add port name (uppercase) to get the port state
  67 #define AVR_IOCTL_IOPORT_GETSTATE(_name) AVR_IOCTL_DEF('i','o','s',(_name))
  68
  69 /**
  70  * pin structure
  71  */
  72 typedef struct avr_iopin_t {
  73         uint16_t port : 8;                      ///< port e.g. 'B'
  74         uint16_t pin : 8;               ///< pin number
  75 } avr_iopin_t;
  76 #define AVR_IOPIN(_port, _pin)  { .port = _port, .pin = _pin }
  77
  78 /*
  79  * Definition for an IO port
  80  */
  81 typedef struct avr_ioport_t {
  82         avr_io_t        io;
  83         char name;
  84         avr_io_addr_t r_port;
  85         avr_io_addr_t r_ddr;
  86         avr_io_addr_t r_pin;
  87
  88         avr_int_vector_t pcint; // PCINT vector
  89         avr_io_addr_t r_pcint;          // pcint 8 pins mask
  90 } avr_ioport_t;
  91
  92 void avr_ioport_init(avr_t * avr, avr_ioport_t * port);
  93
  94
  95 #endif /* __AVR_IOPORT_H__ */