2 * $Id: mmio.h,v 1.6 2006-06-27 11:02:46 nkeynes Exp $
4 * mmio.h defines a complicated batch of macros used to build up the
5 * memory-mapped I/O regions in a reasonably readable fashion.
7 * Copyright (c) 2005 Nathan Keynes.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
20 #define dream_mmio_H 1
32 #define PAGE_TABLE_ENTRIES 128*1024
33 #define PAGE_SIZE 4096
38 #define PORT_MEM 4 /* store written value */
42 #define PORT_NOTRACE 16
43 #define UNDEFINED 0xDEADBEEF /* This has to be a value that nothing inits to */
48 int32_t (*io_read)(uint32_t addr);
49 void (*io_write)(uint32_t addr, uint32_t val);
51 char *save_mem; /* Used to compare for gui updates */
60 struct mmio_port **index; /* reverse lookup by address */
61 int trace_flag; /* set to 1 to enable transfer traces */
64 void register_io_region( struct mmio_region *mmio );
65 void register_io_regions( struct mmio_region **mmiolist );
67 extern struct mmio_region *io_rgn[];
68 extern int num_io_rgns;
70 #define MMIO_READ( id, r ) *((int32_t *)(mmio_region_##id.mem + (r)))
71 #define MMIO_READF( id, r ) *((float *)(mmio_region_##id.mem + (r)))
72 #define MMIO_WRITE( id, r, v ) *((int32_t *)(mmio_region_##id.mem + (r))) = (v)
73 #define MMIO_REG( id, r ) ((int32_t *)(mmio_region_##id.mem + (r)))
74 #define MMIO_REGID( mid, r ) (mmio_region_##mid.index[(r)>>2] != NULL ? \
75 mmio_region_##mid.index[(r)>>2]->id : "<UNDEF>" )
76 #define MMIO_REGDESC( mid, r) (mmio_region_##mid.index[(r)>>2] != NULL ? \
77 mmio_region_##mid.index[(r)>>2]->desc : "Undefined register" )
78 #define MMIO_TRACE( mid ) mmio_region_##mid.trace_flag = 1
79 #define MMIO_NOTRACE( mid ) mmio_region_##mid.trace_flag = 0
81 #define MMIO_REGID_BYNUM( mid, r ) (io_rgn[mid]->index[(r)>>2] != NULL ? \
82 io_rgn[mid]->index[(r)>>2]->id : "<UNDEF>" )
83 #define MMIO_REGDESC_BYNUM( mid, r ) (io_rgn[mid]->index[(r)>>2] != NULL ? \
84 io_rgn[mid]->index[(r)>>2]->desc : "Undefined register" )
85 #define MMIO_NOTRACE_BYNUM( mid, r ) (io_rgn[mid]->index[(r)>>2] != NULL ? \
86 (io_rgn[mid]->index[(r)>>2]->flags & PORT_NOTRACE) : 0 )
87 #define MMIO_NAME_BYNUM( mid ) (io_rgn[mid]->id)
89 #define MMIO_REGID_IOBYNUM( io, r ) (io->index[(r)>>2] != NULL ? \
90 io->index[(r)>>2]->id : "<UNDEF>" )
91 #define MMIO_REGDESC_IOBYNUM( io, r ) (io->index[(r)>>2] != NULL ? \
92 io->index[(r)>>2]->desc : "Undefined register" )
93 #define MMIO_NOTRACE_IOBYNUM( io, r ) (io->index[(r)>>2] != NULL ? \
94 (io->index[(r)>>2]->flags & PORT_NOTRACE) : 0 )
104 #ifndef MMIO_IMPL_INCLUDED
105 #define MMIO_IMPL_INCLUDED
106 #undef MMIO_REGION_BEGIN
110 #undef MMIO_REGION_END
111 #undef MMIO_REGION_LIST_BEGIN
113 #undef MMIO_REGION_LIST_END
114 #define MMIO_REGION_BEGIN(b,id,d) struct mmio_region mmio_region_##id = { #id, d, b, mmio_region_##id##_read, mmio_region_##id##_write, 0, 0, {
115 #define LONG_PORT( o,id,f,def,d ) { #id, d, 32, o, def, f },
116 #define WORD_PORT( o,id,f,def,d ) { #id, d, 16, o, def, f },
117 #define BYTE_PORT( o,id,f,def,d ) { #id, d, 8, o, def, f },
118 #define MMIO_REGION_END {NULL, NULL, 0, 0, 0, 0} } };
119 #define MMIO_REGION_LIST_BEGIN(id) struct mmio_region *mmio_list_##id[] = {
120 #define MMIO_REGION( id ) &mmio_region_##id,
121 #define MMIO_REGION_LIST_END NULL};
123 /* Stub defines for modules we haven't got to yet, or ones which don't
124 * actually need any direct code on read and/or write
126 #define MMIO_REGION_READ_STUBFN( id ) \
127 int32_t mmio_region_##id##_read( uint32_t reg ) { \
128 int32_t val = MMIO_READ( id, reg ); \
129 WARN( "Read from unimplemented module %s (%03X => %08X) [%s: %s]",\
130 #id, reg, val, MMIO_REGID(id,reg), MMIO_REGDESC(id,reg) ); \
133 #define MMIO_REGION_WRITE_STUBFN( id ) \
134 void mmio_region_##id##_write( uint32_t reg, uint32_t val ) { \
135 WARN( "Write to unimplemented module %s (%03X <= %08X) [%s: %s]", \
136 #id, reg, val, MMIO_REGID(id,reg), MMIO_REGDESC(id,reg) ); \
137 MMIO_WRITE( id, reg, val ); \
139 #define MMIO_REGION_STUBFNS( id ) \
140 MMIO_REGION_READ_STUBFN( id ) \
141 MMIO_REGION_WRITE_STUBFN( id )
142 #define MMIO_REGION_READ_DEFFN( id ) \
143 int32_t mmio_region_##id##_read( uint32_t reg ) { \
144 return MMIO_READ( id, reg ); \
146 #define MMIO_REGION_WRITE_DEFFN( id ) \
147 void mmio_region_##id##_write( uint32_t reg, uint32_t val ) { \
148 MMIO_WRITE( id, reg, val ); \
150 #define MMIO_REGION_DEFFNS( id ) \
151 MMIO_REGION_READ_DEFFN( id ) \
152 MMIO_REGION_WRITE_DEFFN( id )
155 #define MMIO_REGION_WRITE_FN( id, reg, val ) \
156 void mmio_region_##id##_write( uint32_t reg, uint32_t val )
158 #define MMIO_REGION_READ_FN( id, reg ) \
159 int32_t mmio_region_##id##_read( uint32_t reg )
163 #ifndef MMIO_IFACE_INCLUDED
164 #define MMIO_IFACE_INCLUDED
165 #define MMIO_REGION_BEGIN(b,id,d) \
166 extern struct mmio_region mmio_region_##id; \
167 int32_t mmio_region_##id##_read(uint32_t); \
168 void mmio_region_##id##_write(uint32_t, uint32_t); \
169 enum mmio_region_##id##_port_t {
170 #define LONG_PORT( o,id,f,def,d ) id = o,
171 #define WORD_PORT( o,id,f,def,d ) id = o,
172 #define BYTE_PORT( o,id,f,def,d ) id = o,
173 #define MMIO_REGION_END };
174 #define MMIO_REGION_LIST_BEGIN(id) extern struct mmio_region *mmio_list_##id[];
175 #define MMIO_REGION( id )
176 #define MMIO_REGION_LIST_END
.