ioport: Add an ioctl to get the port state
[simavr] / 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_COUNT
33 };
34
35 // add port name (uppercase) to get the real IRQ
36 #define AVR_IOCTL_IOPORT_GETIRQ(_name) AVR_IOCTL_DEF('i','o','g',(_name))
37
38
39 // this ioctl takes a avr_regbit_t, compares the register address
40 // to PORT/PIN/DDR and return the corresponding IRQ(s) if it matches
41 typedef struct avr_ioport_getirq_t {
42         avr_regbit_t bit;       // bit wanted
43         avr_irq_t * irq[8];     // result, terminated by NULL if < 8
44 } avr_ioport_getirq_t;
45
46 #define AVR_IOCTL_IOPORT_GETIRQ_REGBIT AVR_IOCTL_DEF('i','o','g','r')
47
48 /*
49  * ioctl used to get a port state.
50  *
51  * for (int i = 'A'; i <= 'F'; i++) {
52  *      avr_ioport_state_t state;
53  *      if (avr_ioctl(AVR_IOCTL_IOPORT_GETSTATE(i), &state) == 0)
54  *              printf("PORT%c %02x DDR %02x PIN %02x\n",
55  *                      state.name, state.port, state.ddr, state.pin);
56  * }
57  */
58 typedef struct avr_ioport_state_t {
59         unsigned long name : 7,
60                 port : 8, ddr : 8, pin : 8;
61 } avr_ioport_state_t;
62
63 // add port name (uppercase) to get the port state
64 #define AVR_IOCTL_IOPORT_GETSTATE(_name) AVR_IOCTL_DEF('i','o','s',(_name))
65
66 /*
67  * Definition for an IO port
68  */
69 typedef struct avr_ioport_t {
70         avr_io_t        io;
71         char name;
72         avr_io_addr_t r_port;
73         avr_io_addr_t r_ddr;
74         avr_io_addr_t r_pin;
75
76         avr_int_vector_t pcint; // PCINT vector
77         avr_io_addr_t r_pcint;          // pcint 8 pins mask
78 } avr_ioport_t;
79
80 void avr_ioport_init(avr_t * avr, avr_ioport_t * port);
81
82
83 #endif /* __AVR_IOPORT_H__ */