filename | src/mmio.h |
changeset | 55:96323c198da3 |
prev | 31:495e480360d7 |
next | 136:f07efd59604f |
author | nkeynes |
date | Sun Feb 05 04:05:27 2006 +0000 (18 years ago) |
permissions | -rw-r--r-- |
last change | Video code reshuffle to start getting real video happening. Implement colourspace conversions Various tweaks |
file | annotate | diff | log | raw |
nkeynes@31 | 1 | /** |
nkeynes@55 | 2 | * $Id: mmio.h,v 1.3 2006-01-01 08:09:17 nkeynes Exp $ |
nkeynes@31 | 3 | * |
nkeynes@31 | 4 | * mmio.h defines a complicated batch of macros used to build up the |
nkeynes@31 | 5 | * memory-mapped I/O regions in a reasonably readable fashion. |
nkeynes@31 | 6 | * |
nkeynes@31 | 7 | * Copyright (c) 2005 Nathan Keynes. |
nkeynes@31 | 8 | * |
nkeynes@31 | 9 | * This program is free software; you can redistribute it and/or modify |
nkeynes@31 | 10 | * it under the terms of the GNU General Public License as published by |
nkeynes@31 | 11 | * the Free Software Foundation; either version 2 of the License, or |
nkeynes@31 | 12 | * (at your option) any later version. |
nkeynes@31 | 13 | * |
nkeynes@31 | 14 | * This program is distributed in the hope that it will be useful, |
nkeynes@31 | 15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
nkeynes@31 | 16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
nkeynes@31 | 17 | * GNU General Public License for more details. |
nkeynes@31 | 18 | */ |
nkeynes@10 | 19 | #ifndef dream_mmio_H |
nkeynes@10 | 20 | #define dream_mmio_H 1 |
nkeynes@10 | 21 | |
nkeynes@10 | 22 | #ifdef __cplusplus |
nkeynes@10 | 23 | extern "C" { |
nkeynes@10 | 24 | #if 0 |
nkeynes@10 | 25 | } |
nkeynes@10 | 26 | #endif |
nkeynes@10 | 27 | #endif |
nkeynes@10 | 28 | |
nkeynes@10 | 29 | #include <stdint.h> |
nkeynes@10 | 30 | #include <stdlib.h> |
nkeynes@10 | 31 | |
nkeynes@10 | 32 | #define PAGE_TABLE_ENTRIES 128*1024 |
nkeynes@10 | 33 | #define PAGE_SIZE 4096 |
nkeynes@10 | 34 | #define PAGE_BITS 12 |
nkeynes@10 | 35 | |
nkeynes@10 | 36 | #define PORT_R 1 |
nkeynes@10 | 37 | #define PORT_W 2 |
nkeynes@10 | 38 | #define PORT_MEM 4 /* store written value */ |
nkeynes@10 | 39 | #define PORT_RW 3 |
nkeynes@10 | 40 | #define PORT_MR 5 |
nkeynes@10 | 41 | #define PORT_MRW 7 |
nkeynes@10 | 42 | #define UNDEFINED 0xDEADBEEF /* This has to be a value that nothing inits to */ |
nkeynes@10 | 43 | |
nkeynes@10 | 44 | struct mmio_region { |
nkeynes@10 | 45 | char *id, *desc; |
nkeynes@10 | 46 | uint32_t base; |
nkeynes@10 | 47 | int32_t (*io_read)(uint32_t addr); |
nkeynes@10 | 48 | void (*io_write)(uint32_t addr, uint32_t val); |
nkeynes@10 | 49 | char *mem; |
nkeynes@10 | 50 | char *save_mem; /* Used to compare for gui updates */ |
nkeynes@10 | 51 | struct mmio_port { |
nkeynes@10 | 52 | char *id, *desc; |
nkeynes@10 | 53 | int width; |
nkeynes@10 | 54 | uint32_t offset; |
nkeynes@10 | 55 | uint32_t def_val; |
nkeynes@10 | 56 | int flags; |
nkeynes@10 | 57 | uint32_t *val; |
nkeynes@10 | 58 | } ports[80]; |
nkeynes@10 | 59 | struct mmio_port **index; /* reverse lookup by address */ |
nkeynes@10 | 60 | int trace_flag; /* set to 1 to enable transfer traces */ |
nkeynes@10 | 61 | }; |
nkeynes@10 | 62 | |
nkeynes@10 | 63 | void register_io_region( struct mmio_region *mmio ); |
nkeynes@10 | 64 | void register_io_regions( struct mmio_region **mmiolist ); |
nkeynes@10 | 65 | |
nkeynes@10 | 66 | extern struct mmio_region *io_rgn[]; |
nkeynes@10 | 67 | extern int num_io_rgns; |
nkeynes@10 | 68 | |
nkeynes@10 | 69 | #define MMIO_READ( id, r ) *((int32_t *)(mmio_region_##id.mem + (r))) |
nkeynes@10 | 70 | #define MMIO_WRITE( id, r, v ) *((int32_t *)(mmio_region_##id.mem + (r))) = (v) |
nkeynes@10 | 71 | #define MMIO_REG( id, r ) ((int32_t *)(mmio_region_##id.mem + (r))) |
nkeynes@10 | 72 | #define MMIO_REGID( mid, r ) (mmio_region_##mid.index[(r)>>2] != NULL ? \ |
nkeynes@10 | 73 | mmio_region_##mid.index[(r)>>2]->id : "<UNDEF>" ) |
nkeynes@10 | 74 | #define MMIO_REGDESC( mid, r) (mmio_region_##mid.index[(r)>>2] != NULL ? \ |
nkeynes@10 | 75 | mmio_region_##mid.index[(r)>>2]->desc : "Undefined register" ) |
nkeynes@10 | 76 | #define MMIO_TRACE( mid ) mmio_region_##mid.trace_flag = 1 |
nkeynes@10 | 77 | #define MMIO_NOTRACE( mid ) mmio_region_##mid.trace_flag = 0 |
nkeynes@10 | 78 | |
nkeynes@10 | 79 | #define MMIO_REGID_BYNUM( mid, r ) (io_rgn[mid]->index[(r)>>2] != NULL ? \ |
nkeynes@10 | 80 | io_rgn[mid]->index[(r)>>2]->id : "<UNDEF>" ) |
nkeynes@10 | 81 | #define MMIO_REGDESC_BYNUM( mid, r ) (io_rgn[mid]->index[(r)>>2] != NULL ? \ |
nkeynes@10 | 82 | io_rgn[mid]->index[(r)>>2]->desc : "Undefined register" ) |
nkeynes@10 | 83 | #define MMIO_NAME_BYNUM( mid ) (io_rgn[mid]->id) |
nkeynes@10 | 84 | |
nkeynes@10 | 85 | #ifdef __cplusplus |
nkeynes@10 | 86 | } |
nkeynes@10 | 87 | #endif |
nkeynes@10 | 88 | |
nkeynes@10 | 89 | #endif |
nkeynes@10 | 90 | |
nkeynes@10 | 91 | #ifdef MMIO_IMPL |
nkeynes@10 | 92 | |
nkeynes@10 | 93 | #ifndef MMIO_IMPL_INCLUDED |
nkeynes@10 | 94 | #define MMIO_IMPL_INCLUDED |
nkeynes@10 | 95 | #undef MMIO_REGION_BEGIN |
nkeynes@10 | 96 | #undef LONG_PORT |
nkeynes@10 | 97 | #undef WORD_PORT |
nkeynes@10 | 98 | #undef BYTE_PORT |
nkeynes@10 | 99 | #undef MMIO_REGION_END |
nkeynes@10 | 100 | #undef MMIO_REGION_LIST_BEGIN |
nkeynes@10 | 101 | #undef MMIO_REGION |
nkeynes@10 | 102 | #undef MMIO_REGION_LIST_END |
nkeynes@10 | 103 | #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, { |
nkeynes@10 | 104 | #define LONG_PORT( o,id,f,def,d ) { #id, d, 32, o, def, f }, |
nkeynes@10 | 105 | #define WORD_PORT( o,id,f,def,d ) { #id, d, 16, o, def, f }, |
nkeynes@10 | 106 | #define BYTE_PORT( o,id,f,def,d ) { #id, d, 8, o, def, f }, |
nkeynes@10 | 107 | #define MMIO_REGION_END {NULL, NULL, 0, 0, 0, 0} } }; |
nkeynes@10 | 108 | #define MMIO_REGION_LIST_BEGIN(id) struct mmio_region *mmio_list_##id[] = { |
nkeynes@10 | 109 | #define MMIO_REGION( id ) &mmio_region_##id, |
nkeynes@10 | 110 | #define MMIO_REGION_LIST_END NULL}; |
nkeynes@10 | 111 | |
nkeynes@10 | 112 | /* Stub defines for modules we haven't got to yet, or ones which don't |
nkeynes@10 | 113 | * actually need any direct code on read and/or write |
nkeynes@10 | 114 | */ |
nkeynes@10 | 115 | #define MMIO_REGION_READ_STUBFN( id ) \ |
nkeynes@10 | 116 | int32_t mmio_region_##id##_read( uint32_t reg ) { \ |
nkeynes@10 | 117 | int32_t val = MMIO_READ( id, reg ); \ |
nkeynes@10 | 118 | WARN( "Read from unimplemented module %s (%03X => %08X) [%s: %s]",\ |
nkeynes@10 | 119 | #id, reg, val, MMIO_REGID(id,reg), MMIO_REGDESC(id,reg) ); \ |
nkeynes@10 | 120 | return val; \ |
nkeynes@10 | 121 | } |
nkeynes@10 | 122 | #define MMIO_REGION_WRITE_STUBFN( id ) \ |
nkeynes@10 | 123 | void mmio_region_##id##_write( uint32_t reg, uint32_t val ) { \ |
nkeynes@10 | 124 | WARN( "Write to unimplemented module %s (%03X <= %08X) [%s: %s]", \ |
nkeynes@10 | 125 | #id, reg, val, MMIO_REGID(id,reg), MMIO_REGDESC(id,reg) ); \ |
nkeynes@10 | 126 | MMIO_WRITE( id, reg, val ); \ |
nkeynes@10 | 127 | } |
nkeynes@10 | 128 | #define MMIO_REGION_STUBFNS( id ) \ |
nkeynes@10 | 129 | MMIO_REGION_READ_STUBFN( id ) \ |
nkeynes@10 | 130 | MMIO_REGION_WRITE_STUBFN( id ) |
nkeynes@10 | 131 | #define MMIO_REGION_READ_DEFFN( id ) \ |
nkeynes@10 | 132 | int32_t mmio_region_##id##_read( uint32_t reg ) { \ |
nkeynes@10 | 133 | return MMIO_READ( id, reg ); \ |
nkeynes@10 | 134 | } |
nkeynes@10 | 135 | #define MMIO_REGION_WRITE_DEFFN( id ) \ |
nkeynes@10 | 136 | void mmio_region_##id##_write( uint32_t reg, uint32_t val ) { \ |
nkeynes@10 | 137 | MMIO_WRITE( id, reg, val ); \ |
nkeynes@10 | 138 | } |
nkeynes@10 | 139 | #define MMIO_REGION_DEFFNS( id ) \ |
nkeynes@10 | 140 | MMIO_REGION_READ_DEFFN( id ) \ |
nkeynes@10 | 141 | MMIO_REGION_WRITE_DEFFN( id ) |
nkeynes@10 | 142 | #endif |
nkeynes@10 | 143 | |
nkeynes@10 | 144 | #define MMIO_REGION_WRITE_FN( id, reg, val ) \ |
nkeynes@10 | 145 | void mmio_region_##id##_write( uint32_t reg, uint32_t val ) |
nkeynes@10 | 146 | |
nkeynes@10 | 147 | #define MMIO_REGION_READ_FN( id, reg ) \ |
nkeynes@10 | 148 | int32_t mmio_region_##id##_read( uint32_t reg ) |
nkeynes@10 | 149 | |
nkeynes@10 | 150 | #else |
nkeynes@10 | 151 | |
nkeynes@10 | 152 | #ifndef MMIO_IFACE_INCLUDED |
nkeynes@10 | 153 | #define MMIO_IFACE_INCLUDED |
nkeynes@10 | 154 | #define MMIO_REGION_BEGIN(b,id,d) \ |
nkeynes@10 | 155 | extern struct mmio_region mmio_region_##id; \ |
nkeynes@10 | 156 | int32_t mmio_region_##id##_read(uint32_t); \ |
nkeynes@10 | 157 | void mmio_region_##id##_write(uint32_t, uint32_t); \ |
nkeynes@10 | 158 | enum mmio_region_##id##_port_t { |
nkeynes@10 | 159 | #define LONG_PORT( o,id,f,def,d ) id = o, |
nkeynes@10 | 160 | #define WORD_PORT( o,id,f,def,d ) id = o, |
nkeynes@10 | 161 | #define BYTE_PORT( o,id,f,def,d ) id = o, |
nkeynes@10 | 162 | #define MMIO_REGION_END }; |
nkeynes@10 | 163 | #define MMIO_REGION_LIST_BEGIN(id) extern struct mmio_region *mmio_list_##id[]; |
nkeynes@10 | 164 | #define MMIO_REGION( id ) |
nkeynes@10 | 165 | #define MMIO_REGION_LIST_END |
nkeynes@10 | 166 | #endif |
nkeynes@10 | 167 | |
nkeynes@10 | 168 | #endif |
nkeynes@10 | 169 |
.