summaryrefslogtreecommitdiffstatshomepage
path: root/src/emu/devfind.cpp
blob: 90daaa0a4997af1e73507331dfbf9ff523850874 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
// license:BSD-3-Clause
// copyright-holders:Aaron Giles
/***************************************************************************

    devfind.c

    Device finding template helpers.

***************************************************************************/

#include "emu.h"


//**************************************************************************
//  EXPLICIT TEMPLATE INSTANTIATIONS
//**************************************************************************

template class object_finder_base<memory_region, false>;
template class object_finder_base<memory_region, true>;
template class object_finder_base<memory_bank, false>;
template class object_finder_base<memory_bank, true>;
template class object_finder_base<ioport_port, false>;
template class object_finder_base<ioport_port, true>;

template class object_finder_base<uint8_t, false>;
template class object_finder_base<uint8_t, true>;
template class object_finder_base<uint16_t, false>;
template class object_finder_base<uint16_t, true>;
template class object_finder_base<uint32_t, false>;
template class object_finder_base<uint32_t, true>;
template class object_finder_base<uint64_t, false>;
template class object_finder_base<uint64_t, true>;

template class object_finder_base<int8_t, false>;
template class object_finder_base<int8_t, true>;
template class object_finder_base<int16_t, false>;
template class object_finder_base<int16_t, true>;
template class object_finder_base<int32_t, false>;
template class object_finder_base<int32_t, true>;
template class object_finder_base<int64_t, false>;
template class object_finder_base<int64_t, true>;

template class memory_region_finder<false>;
template class memory_region_finder<true>;

template class memory_bank_finder<false>;
template class memory_bank_finder<true>;

template class ioport_finder<false>;
template class ioport_finder<true>;

template class region_ptr_finder<uint8_t, false>;
template class region_ptr_finder<uint8_t, true>;
template class region_ptr_finder<uint16_t, false>;
template class region_ptr_finder<uint16_t, true>;
template class region_ptr_finder<uint32_t, false>;
template class region_ptr_finder<uint32_t, true>;
template class region_ptr_finder<uint64_t, false>;
template class region_ptr_finder<uint64_t, true>;

template class region_ptr_finder<int8_t, false>;
template class region_ptr_finder<int8_t, true>;
template class region_ptr_finder<int16_t, false>;
template class region_ptr_finder<int16_t, true>;
template class region_ptr_finder<int32_t, false>;
template class region_ptr_finder<int32_t, true>;
template class region_ptr_finder<int64_t, false>;
template class region_ptr_finder<int64_t, true>;

template class shared_ptr_finder<uint8_t, false>;
template class shared_ptr_finder<uint8_t, true>;
template class shared_ptr_finder<uint16_t, false>;
template class shared_ptr_finder<uint16_t, true>;
template class shared_ptr_finder<uint32_t, false>;
template class shared_ptr_finder<uint32_t, true>;
template class shared_ptr_finder<uint64_t, false>;
template class shared_ptr_finder<uint64_t, true>;

template class shared_ptr_finder<int8_t, false>;
template class shared_ptr_finder<int8_t, true>;
template class shared_ptr_finder<int16_t, false>;
template class shared_ptr_finder<int16_t, true>;
template class shared_ptr_finder<int32_t, false>;
template class shared_ptr_finder<int32_t, true>;
template class shared_ptr_finder<int64_t, false>;
template class shared_ptr_finder<int64_t, true>;



//**************************************************************************
//  BASE FINDER CLASS
//**************************************************************************

constexpr char finder_base::DUMMY_TAG[];


//-------------------------------------------------
//  finder_base - constructor
//-------------------------------------------------

finder_base::finder_base(device_t &base, const char *tag)
	: m_next(base.register_auto_finder(*this))
	, m_base(base)
	, m_tag(tag)
{
}


//-------------------------------------------------
//  ~finder_base - destructor
//-------------------------------------------------

finder_base::~finder_base()
{
}


//-------------------------------------------------
//  find_memregion - find memory region
//-------------------------------------------------

void *finder_base::find_memregion(uint8_t width, size_t &length, bool required) const
{
	// look up the region and return nullptr if not found
	memory_region *const region = m_base.memregion(m_tag);
	if (region == nullptr)
	{
		length = 0;
		return nullptr;
	}

	// check the width and warn if not correct
	if (region->bytewidth() != width)
	{
		if (required)
			osd_printf_warning("Region '%s' found but is width %d, not %d as requested\n", m_tag, region->bitwidth(), width*8);
		length = 0;
		return nullptr;
	}

	// check the length and warn if other than specified
	size_t const length_found = region->bytes() / width;
	if (length != 0 && length != length_found)
	{
		if (required)
			osd_printf_warning("Region '%s' found but has %d bytes, not %ld as requested\n", m_tag, region->bytes(), long(length*width));
		length = 0;
		return nullptr;
	}

	// return results
	length = length_found;
	return region->base();
}


//-------------------------------------------------
//  validate_memregion - find memory region
//-------------------------------------------------

bool finder_base::validate_memregion(size_t bytes, bool required) const
{
	// make sure we can resolve the full path to the region
	size_t bytes_found = 0;
	std::string region_fulltag = m_base.subtag(m_tag);

	// look for the region
	for (device_t &dev : device_iterator(m_base.mconfig().root_device()))
	{
		for (const rom_entry *romp = rom_first_region(dev); romp != nullptr; romp = rom_next_region(romp))
		{
			if (rom_region_name(dev, romp) == region_fulltag)
			{
				bytes_found = ROMREGION_GETLENGTH(romp);
				break;
			}
		}
		if (bytes_found != 0)
			break;
	}

	// check the length and warn if other than specified
	if ((bytes_found != 0) && (bytes != 0) && (bytes != bytes_found))
	{
		osd_printf_warning("Region '%s' found but has %ld bytes, not %ld as requested\n", m_tag, long(bytes_found), long(bytes));
		bytes_found = 0;
	}

	return report_missing(bytes_found != 0, "memory region", required);
}


//-------------------------------------------------
//  find_memshare - find memory share
//-------------------------------------------------

void *finder_base::find_memshare(uint8_t width, size_t &bytes, bool required) const
{
	// look up the share and return nullptr if not found
	memory_share *share = m_base.memshare(m_tag);
	if (share == nullptr)
		return nullptr;

	// check the width and warn if not correct
	if (width != 0 && share->bitwidth() != width)
	{
		if (required)
			osd_printf_warning("Shared ptr '%s' found but is width %d, not %d as requested\n", m_tag, share->bitwidth(), width);
		return nullptr;
	}

	// return results
	bytes = share->bytes();
	return share->ptr();
}


//-------------------------------------------------
//  report_missing - report missing objects and
//  return true if it's ok
//-------------------------------------------------

bool finder_base::report_missing(bool found, const char *objname, bool required) const
{
	if (required && (strcmp(m_tag, DUMMY_TAG) == 0))
	{
		osd_printf_error("Tag not defined for required %s\n", objname);
		return false;
	}

	// just pass through in the found case
	if (found)
		return true;

	// otherwise, report
	std::string const region_fulltag = m_base.subtag(m_tag);
	if (required)
		osd_printf_error("Required %s '%s' not found\n", objname, region_fulltag.c_str());
	else
		osd_printf_verbose("Optional %s '%s' not found\n", objname, region_fulltag.c_str());
	return !required;
}


void finder_base::printf_warning(const char *format, ...)
{
	va_list argptr;
	char buffer[1024];

	/* do the output */
	va_start(argptr, format);
	vsnprintf(buffer, 1024, format, argptr);
	osd_printf_warning("%s", buffer);
	va_end(argptr);
}