io: Create irq names for io addresses
[simavr] / simavr / sim / sim_io.c
1 /*
2         sim_io.c
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
23 #include <stdlib.h>
24 #include <stdio.h>
25 #include <string.h>
26 #include <ctype.h>
27 #include <stdint.h>
28 #include "sim_io.h"
29
30 int
31 avr_ioctl(
32                 avr_t *avr,
33                 uint32_t ctl,
34                 void * io_param)
35 {
36         avr_io_t * port = avr->io_port;
37         int res = -1;
38         while (port && res == -1) {
39                 if (port->ioctl)
40                         res = port->ioctl(port, ctl, io_param);
41                 port = port->next;
42         }
43         return res;
44 }
45
46 void
47 avr_register_io(
48                 avr_t *avr,
49                 avr_io_t * io)
50 {
51         io->next = avr->io_port;
52         io->avr = avr;
53         avr->io_port = io;
54 }
55
56 void
57 avr_register_io_read(
58                 avr_t *avr,
59                 avr_io_addr_t addr,
60                 avr_io_read_t readp,
61                 void * param)
62 {
63         avr_io_addr_t a = AVR_DATA_TO_IO(addr);
64         if (avr->io[a].r.param || avr->io[a].r.c) {
65                 if (avr->io[a].r.param != param || avr->io[a].r.c != readp) {
66                         AVR_LOG(avr, LOG_ERROR, "IO: avr_register_io_read(): Already registered, refusing to override.\n");
67                         AVR_LOG(avr, LOG_ERROR, "IO: avr_register_io_read(%04x : %p/%p): %p/%p\n", a,
68                                         avr->io[a].r.c, avr->io[a].r.param, readp, param);
69                         abort();
70                 }
71         }
72         avr->io[a].r.param = param;
73         avr->io[a].r.c = readp;
74 }
75
76 static void
77 _avr_io_mux_write(
78                 avr_t * avr,
79                 avr_io_addr_t addr,
80                 uint8_t v,
81                 void * param)
82 {
83         int io = (intptr_t)param;
84         for (int i = 0; i < avr->io_shared_io[io].used; i++) {
85                 avr_io_write_t c = avr->io_shared_io[io].io[i].c;
86                 if (c)
87                         c(avr, addr, v, avr->io_shared_io[io].io[i].param);
88         }
89 }
90
91 void
92 avr_register_io_write(
93                 avr_t *avr,
94                 avr_io_addr_t addr,
95                 avr_io_write_t writep,
96                 void * param)
97 {
98         avr_io_addr_t a = AVR_DATA_TO_IO(addr);
99
100         if (a >= MAX_IOs) {
101                 AVR_LOG(avr, LOG_ERROR, "IO: avr_register_io_write(): IO address 0x%04x out of range (max 0x%04x).\n",
102                                         a, MAX_IOs);
103                 abort();
104         }
105         /*
106          * Verifying that some other piece of code is not installed to watch write
107          * on this address. If there is, this code installs a "dispatcher" callback
108          * instead to handle multiple clients, otherwise, it continues as usual
109          */
110         if (avr->io[a].w.param || avr->io[a].w.c) {
111                 if (avr->io[a].w.param != param || avr->io[a].w.c != writep) {
112                         // if the muxer not already installed, allocate a new slot
113                         if (avr->io[a].w.c != _avr_io_mux_write) {
114                                 int no = avr->io_shared_io_count++;
115                                 if (avr->io_shared_io_count > 4) {
116                                         AVR_LOG(avr, LOG_ERROR, "IO: avr_register_io_write(): Too many shared IO registers.\n");
117                                         abort();
118                                 }
119                                 AVR_LOG(avr, LOG_TRACE, "IO: avr_register_io_write(%04x): Installing muxer on register.\n", addr);
120                                 avr->io_shared_io[no].used = 1;
121                                 avr->io_shared_io[no].io[0].param = avr->io[a].w.param;
122                                 avr->io_shared_io[no].io[0].c = avr->io[a].w.c;
123                                 avr->io[a].w.param = (void*)(intptr_t)no;
124                                 avr->io[a].w.c = _avr_io_mux_write;
125                         }
126                         int no = (intptr_t)avr->io[a].w.param;
127                         int d = avr->io_shared_io[no].used++;
128                         if (avr->io_shared_io[no].used > 4) {
129                                 AVR_LOG(avr, LOG_ERROR, "IO: avr_register_io_write(): Too many callbacks on %04x.\n", addr);
130                                 abort();
131                         }
132                         avr->io_shared_io[no].io[d].param = param;
133                         avr->io_shared_io[no].io[d].c = writep;
134                 }
135         }
136
137         avr->io[a].w.param = param;
138         avr->io[a].w.c = writep;
139 }
140
141 avr_irq_t *
142 avr_io_getirq(
143                 avr_t * avr,
144                 uint32_t ctl,
145                 int index)
146 {
147         avr_io_t * port = avr->io_port;
148         while (port) {
149                 if (port->irq && port->irq_ioctl_get == ctl && port->irq_count > index)
150                         return port->irq + index;
151                 port = port->next;
152         }
153         return NULL;
154         
155 }
156
157 avr_irq_t *
158 avr_iomem_getirq(
159                 avr_t * avr,
160                 avr_io_addr_t addr,
161                 int index)
162 {
163         avr_io_addr_t a = AVR_DATA_TO_IO(addr);
164         if (avr->io[a].irq == NULL) {
165                 /*
166                  * Prepare an array of names for the io IRQs. Ideally we'd love to have
167                  * a proper name for these, but it's not possible at this time.
168                  */
169                 char names[9 * 20];
170                 char * d = names;
171                 const char * namep[9];
172                 for (int ni = 0; ni < 9; ni++) {
173                         if (ni < 8)
174                                 sprintf(d, "=avr.io%04x.%d", addr, ni);
175                         else
176                                 sprintf(d, "8=avr.io%04x.all", addr);
177                         namep[ni] = d;
178                         d += strlen(d) + 1;
179                 }
180                 avr->io[a].irq = avr_alloc_irq(&avr->irq_pool, 0, 9, namep);
181                 // mark the pin ones as filtered, so they only are raised when changing
182                 for (int i = 0; i < 8; i++)
183                         avr->io[a].irq[i].flags |= IRQ_FLAG_FILTERED;
184         }
185         return index < 9 ? avr->io[a].irq + index : NULL;
186 }
187
188 avr_irq_t *
189 avr_io_setirqs(
190                 avr_io_t * io,
191                 uint32_t ctl,
192                 int count,
193                 avr_irq_t * irqs )
194 {
195         // allocate this module's IRQ
196         io->irq_count = count;
197
198         if (!irqs) {
199                 const char ** irq_names = NULL;
200
201                 if (io->irq_names) {
202                         irq_names = malloc(count * sizeof(char*));
203                         memset(irq_names, 0, count * sizeof(char*));
204                         char buf[64];
205                         for (int i = 0; i < count; i++) {
206                                 /*
207                                  * this bit takes the io module 'kind' ("port")
208                                  * the IRQ name ("=0") and the last character of the ioctl ('p','o','r','A')
209                                  * to create a full name "=porta.0"
210                                  */
211                                 char * dst = buf;
212                                 // copy the 'flags' of the name out
213                                 const char * kind = io->irq_names[i];
214                                 while (isdigit(*kind))
215                                         *dst++ = *kind++;
216                                 while (!isalpha(*kind))
217                                         *dst++ = *kind++;
218                                 // add avr name
219 //                              strcpy(dst, io->avr->mmcu);
220                                 strcpy(dst, "avr");
221                                 dst += strlen(dst);
222                                 *dst ++ = '.';
223                                 // add module 'kind'
224                                 strcpy(dst, io->kind);
225                                 dst += strlen(dst);
226                                 // add port name, if any
227                                 if ((ctl & 0xff) > ' ')
228                                         *dst ++ = tolower(ctl & 0xff);
229                                 *dst ++ = '.';
230                                 // add the rest of the irq name
231                                 strcpy(dst, kind);
232                                 dst += strlen(dst);
233                                 *dst = 0;
234
235 //                              printf("%s\n", buf);
236                                 irq_names[i] = strdup(buf);
237                         }
238                 }
239                 irqs = avr_alloc_irq(&io->avr->irq_pool, 0,
240                                                 count, irq_names);
241                 if (irq_names) {
242                         for (int i = 0; i < count; i++)
243                                 free((char*)irq_names[i]);
244                         free((char*)irq_names);
245                 }
246         }
247
248         io->irq = irqs;
249         io->irq_ioctl_get = ctl;
250         return io->irq;
251 }
252
253 static void
254 avr_deallocate_io(
255                 avr_io_t * io)
256 {
257         if (io->dealloc)
258                 io->dealloc(io);
259         avr_free_irq(io->irq, io->irq_count);
260         io->irq_count = 0;
261         io->irq_ioctl_get = 0;
262         io->avr = NULL;
263         io->next = NULL;
264 }
265
266 void
267 avr_deallocate_ios(
268                 avr_t * avr)
269 {
270         avr_io_t * port = avr->io_port;
271         while (port) {
272                 avr_io_t * next = port->next;
273                 avr_deallocate_io(port);
274                 port = next;
275         }
276         avr->io_port = NULL;
277 }