summaryrefslogtreecommitdiffstatshomepage
path: root/src/emu/machine/eepromdev.c
blob: 77a9b8bab5a67d58a35835a6b4adb692cdaf8896 (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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
/*
 * Serial eeproms
 *
 */

#include "driver.h"
#include "machine/eepromdev.h"

#define VERBOSE 0
#define LOG(x) do { if (VERBOSE) logerror x; } while (0)

#define SERIAL_BUFFER_LENGTH 40
#define MEMORY_SIZE 1024

/* FIXME: many drivers do not need default_data / default_data_size and put them to 0 in the drivers seems a waste of code */
UINT8 *eeprom_empty_default_data = NULL;

typedef struct _eeprom_state eeprom_state;
struct _eeprom_state
{
	const eeprom_interface *intf;
	int serial_count;
	UINT8 serial_buffer[SERIAL_BUFFER_LENGTH];
	UINT8 data[MEMORY_SIZE];
	int data_bits;
	int read_address;
	int clock_count;
	int latch,reset_line,clock_line,sending;
	int locked;
	int reset_delay;
};

/*-------------------------------------------------
    get_safe_token - makes sure that the passed
    in device is, in fact, an I2C memory
-------------------------------------------------*/

INLINE eeprom_state *get_safe_token(const device_config *device)
{
	assert( device != NULL );
	assert( device->token != NULL );
	assert( device->type == EEPROM );

	return (eeprom_state *)device->token;
}

/*
    eeprom_command_match:

    Try to match the first (len) digits in the EEPROM serial buffer
    string (*buf) with  an EEPROM command string (*cmd).
    Return non zero if a match was found.

    The serial buffer only contains '0' or '1' (e.g. "1001").
    The command can contain: '0' or '1' or these wildcards:

    'x' :   match both '0' and '1'
    "*1":   match "1", "01", "001", "0001" etc.
    "*0":   match "0", "10", "110", "1110" etc.

    Note: (cmd) may be NULL. Return 0 (no match) in this case.
*/
static int eeprom_command_match(const char *buf, const char *cmd, int len)
{
	if ( cmd == 0 )	return 0;
	if ( len == 0 )	return 0;

	for (;len>0;)
	{
		char b = *buf;
		char c = *cmd;

		if ((b==0) || (c==0))
			return (b==c);

		switch ( c )
		{
			case '0':
			case '1':
				if (b != c)	return 0;
			case 'X':
			case 'x':
				buf++;
				len--;
				cmd++;
				break;

			case '*':
				c = cmd[1];
				switch( c )
				{
					case '0':
					case '1':
					  	if (b == c)	{	cmd++;			}
						else		{	buf++;	len--;	}
						break;
					default:	return 0;
				}
		}
	}
	return (*cmd==0);
}


const eeprom_interface eepromdev_interface_93C46 =
{
	6,				// address bits 6
	16,				// data bits    16
	"*110",			// read         1 10 aaaaaa
	"*101",			// write        1 01 aaaaaa dddddddddddddddd
	"*111",			// erase        1 11 aaaaaa
	"*10000xxxx",	// lock         1 00 00xxxx
	"*10011xxxx",	// unlock       1 00 11xxxx
	1,
//  "*10001xxxx"    // write all    1 00 01xxxx dddddddddddddddd
//  "*10010xxxx"    // erase all    1 00 10xxxx
};

const eeprom_interface eepromdev_interface_93C66B =
{
	8,				/* address bits */
	16,				/* data bits */
	"*110",			/* read command */
	"*101",			/* write command */
	"*111",			/* erase command */
	"*10000xxxxxx",	/* lock command */
	"*10011xxxxxx", /* unlock command */
	1,
//  "*10001xxxxxx", /* write all */
//  "*10010xxxxxx", /* erase all */
};

static void eeprom_write(eeprom_state *eestate, int bit)
{
	LOG(("EEPROM write bit %d\n",bit));

	if (eestate->serial_count >= SERIAL_BUFFER_LENGTH-1)
	{
		logerror("error: EEPROM serial buffer overflow\n");
		return;
	}

	eestate->serial_buffer[eestate->serial_count++] = (bit ? '1' : '0');
	eestate->serial_buffer[eestate->serial_count] = 0;	/* nul terminate so we can treat it as a string */

	if ( (eestate->serial_count > eestate->intf->address_bits) &&
	      eeprom_command_match((char*)(eestate->serial_buffer),eestate->intf->cmd_read,strlen((char*)(eestate->serial_buffer))-eestate->intf->address_bits) )
	{
		int i,address;

		address = 0;
		for (i = eestate->serial_count-eestate->intf->address_bits;i < eestate->serial_count;i++)
		{
			address <<= 1;
			if (eestate->serial_buffer[i] == '1') address |= 1;
		}
		if (eestate->intf->data_bits == 16)
			eestate->data_bits = (eestate->data[2*address+0] << 8) + eestate->data[2*address+1];
		else
			eestate->data_bits = eestate->data[address];
		eestate->read_address = address;
		eestate->clock_count = 0;
		eestate->sending = 1;
		eestate->serial_count = 0;
logerror("EEPROM read %04x from address %02x\n",eestate->data_bits,address);
	}
	else if ( (eestate->serial_count > eestate->intf->address_bits) &&
	           eeprom_command_match((char*)(eestate->serial_buffer),eestate->intf->cmd_erase,strlen((char*)(eestate->serial_buffer))-eestate->intf->address_bits) )
	{
		int i,address;

		address = 0;
		for (i = eestate->serial_count-eestate->intf->address_bits;i < eestate->serial_count;i++)
		{
			address <<= 1;
			if (eestate->serial_buffer[i] == '1') address |= 1;
		}
logerror("EEPROM erase address %02x\n",address);
		if (eestate->locked == 0)
		{
			if (eestate->intf->data_bits == 16)
			{
				eestate->data[2*address+0] = 0x00;
				eestate->data[2*address+1] = 0x00;
			}
			else
				eestate->data[address] = 0x00;
		}
		else
logerror("Error: EEPROM is locked\n");
		eestate->serial_count = 0;
	}
	else if ( (eestate->serial_count > (eestate->intf->address_bits + eestate->intf->data_bits)) &&
	           eeprom_command_match((char*)(eestate->serial_buffer),eestate->intf->cmd_write,strlen((char*)(eestate->serial_buffer))-(eestate->intf->address_bits + eestate->intf->data_bits)) )
	{
		int i,address,data;

		address = 0;
		for (i = eestate->serial_count-eestate->intf->data_bits-eestate->intf->address_bits;i < (eestate->serial_count-eestate->intf->data_bits);i++)
		{
			address <<= 1;
			if (eestate->serial_buffer[i] == '1') address |= 1;
		}
		data = 0;
		for (i = eestate->serial_count-eestate->intf->data_bits;i < eestate->serial_count;i++)
		{
			data <<= 1;
			if (eestate->serial_buffer[i] == '1') data |= 1;
		}
logerror("EEPROM write %04x to address %02x\n",data,address);
		if (eestate->locked == 0)
		{
			if (eestate->intf->data_bits == 16)
			{
				eestate->data[2*address+0] = data >> 8;
				eestate->data[2*address+1] = data & 0xff;
			}
			else
				eestate->data[address] = data;
		}
		else
logerror("Error: EEPROM is locked\n");
		eestate->serial_count = 0;
	}
	else if ( eeprom_command_match((char*)(eestate->serial_buffer),eestate->intf->cmd_lock,strlen((char*)(eestate->serial_buffer))) )
	{
logerror("EEPROM lock\n");
		eestate->locked = 1;
		eestate->serial_count = 0;
	}
	else if ( eeprom_command_match((char*)(eestate->serial_buffer),eestate->intf->cmd_unlock,strlen((char*)(eestate->serial_buffer))) )
	{
logerror("EEPROM unlock\n");
		eestate->locked = 0;
		eestate->serial_count = 0;
	}
}

static void eeprom_reset(eeprom_state *eestate)
{
	if (eestate->serial_count)
		logerror("EEPROM reset, buffer = %s\n",eestate->serial_buffer);

	eestate->serial_count = 0;
	eestate->sending = 0;
	eestate->reset_delay = eestate->intf->reset_delay;	/* delay a little before returning setting data to 1 (needed by wbeachvl) */
}


WRITE_LINE_DEVICE_HANDLER( eepromdev_write_bit )
{
	eeprom_state *eestate = get_safe_token(device);

	LOG(("write bit %d\n",state));
	eestate->latch = state;
}

READ_LINE_DEVICE_HANDLER( eepromdev_read_bit )
{
	eeprom_state *eestate = get_safe_token(device);
	int res;

	if (eestate->sending)
		res = (eestate->data_bits >> eestate->intf->data_bits) & 1;
	else
	{
		if (eestate->reset_delay > 0)
		{
			/* this is needed by wbeachvl */
			eestate->reset_delay--;
			res = 0;
		}
		else
			res = 1;
	}

	LOG(("read bit %d\n",res));

	return res;
}

WRITE_LINE_DEVICE_HANDLER( eepromdev_set_cs_line )
{
	eeprom_state *eestate = get_safe_token(device);

	LOG(("set reset line %d\n",state));
	eestate->reset_line = state;

	if (eestate->reset_line != CLEAR_LINE)
		eeprom_reset(eestate);
}

WRITE_LINE_DEVICE_HANDLER( eepromdev_set_clock_line )
{
	eeprom_state *eestate = get_safe_token(device);

	LOG(("set clock line %d\n",state));
	if (state == PULSE_LINE || (eestate->clock_line == CLEAR_LINE && state != CLEAR_LINE))
	{
		if (eestate->reset_line == CLEAR_LINE)
		{
			if (eestate->sending)
			{
				if (eestate->clock_count == eestate->intf->data_bits && eestate->intf->enable_multi_read)
				{
					eestate->read_address = (eestate->read_address + 1) & ((1 << eestate->intf->address_bits) - 1);
					if (eestate->intf->data_bits == 16)
						eestate->data_bits = (eestate->data[2*eestate->read_address+0] << 8) + eestate->data[2*eestate->read_address+1];
					else
						eestate->data_bits = eestate->data[eestate->read_address];
					eestate->clock_count = 0;
logerror("EEPROM read %04x from address %02x\n",eestate->data_bits,eestate->read_address);
				}
				eestate->data_bits = (eestate->data_bits << 1) | 1;
				eestate->clock_count++;
			}
			else
				eeprom_write(eestate,eestate->latch);
		}
	}

	eestate->clock_line = state;
}


static void eepromdev_load(const device_config *device, mame_file *f)
{
	eeprom_state *eestate = get_safe_token(device);

	mame_fread(f, eestate->data, (1 << eestate->intf->address_bits) * eestate->intf->data_bits / 8);
}

static void eepromdev_save(const device_config *device, mame_file *f)
{
	eeprom_state *eestate = get_safe_token(device);

	mame_fwrite(f, eestate->data, (1 << eestate->intf->address_bits) * eestate->intf->data_bits / 8);
}

void eepromdev_set_data(const device_config *device, const UINT8 *data, int length)
{
	eeprom_state *eestate = get_safe_token(device);

	assert(length <= ((1 << eestate->intf->address_bits) * eestate->intf->data_bits / 8));
	memcpy(eestate->data, data, length);
/* temporary: write data to eeprom.bin when this happens so we capture it
   for adding to a region */
{
	FILE *f = fopen("eeprom.bin", "wb");
	fwrite(eestate->data, 1, (1 << eestate->intf->address_bits) * eestate->intf->data_bits / 8, f);
	fclose(f);
}
}

void *eepromdev_get_data_pointer(const device_config *device, UINT32 *length, UINT32 *size)
{
	eeprom_state *eestate = get_safe_token(device);

	if (length != NULL && eestate->intf != NULL)
		*length = 1 << eestate->intf->address_bits;
	if (size != NULL && eestate->intf != NULL)
		*size = eestate->intf->data_bits / 8;

	return eestate->data;
}

static DEVICE_NVRAM( eeprom )
{
	const eeprom_config *config = (const eeprom_config *)device->inline_config;

	if (read_or_write)
		eepromdev_save(device, file);
	else
		if (file)
			eepromdev_load(device, file);
		else
			if ((config->default_data != NULL) && (config->default_data_size != 0))
				eepromdev_set_data(device, config->default_data, config->default_data_size);
}

static DEVICE_START(eeprom)
{
	eeprom_state *eestate = get_safe_token(device);
	const eeprom_config *config;
	UINT8 *region_base;

	/* validate some basic stuff */
	assert(device != NULL);
	assert(device->inline_config != NULL);
	assert(device->machine != NULL);
	assert(device->machine->config != NULL);

	config = (const eeprom_config *)device->inline_config;

	eestate->intf = config->pinterface;

	if ((1 << eestate->intf->address_bits) * eestate->intf->data_bits / 8 > MEMORY_SIZE)
	{
		fatalerror("EEPROM larger than eepromdev.c allows");
	}

	memset(eestate->data, 0xff, (1 << eestate->intf->address_bits) * eestate->intf->data_bits / 8);
	if ((config->default_data != NULL) && (config->default_data_size != 0))
		eepromdev_set_data(device, config->default_data, config->default_data_size);

	region_base = memory_region(device->machine, device->tag);
	if (region_base != NULL)
	{
		UINT32 region_length = memory_region_length(device->machine, device->tag);
		UINT32 region_flags = memory_region_flags(device->machine, device->tag);

		if (region_length != (1 << eestate->intf->address_bits) * eestate->intf->data_bits / 8)
			fatalerror("eeprom region '%s' wrong size (expected size = 0x%X)", device->tag, (1 << eestate->intf->address_bits) * eestate->intf->data_bits / 8);
		if (eestate->intf->data_bits == 8 && (region_flags & ROMREGION_WIDTHMASK) != ROMREGION_8BIT)
			fatalerror("eeprom region '%s' needs to be an 8-bit region", device->tag);
		if (eestate->intf->data_bits == 16 && ((region_flags & ROMREGION_WIDTHMASK) != ROMREGION_16BIT || (region_flags & ROMREGION_ENDIANMASK) != ROMREGION_BE))
			fatalerror("eeprom region '%s' needs to be a 16-bit big-endian region (flags=%08x)", device->tag, region_flags);
		memcpy(eestate->data, region_base, region_length);
	}

	eestate->serial_count = 0;
	eestate->latch = 0;
	eestate->reset_line = ASSERT_LINE;
	eestate->clock_line = ASSERT_LINE;
	eestate->read_address = 0;
	eestate->sending = 0;
	if (eestate->intf->cmd_unlock) eestate->locked = 1;
	else eestate->locked = 0;

	state_save_register_device_item_pointer( device, 0, eestate->data, MEMORY_SIZE);
	state_save_register_device_item_pointer( device, 0, eestate->serial_buffer, SERIAL_BUFFER_LENGTH);
	state_save_register_device_item( device, 0, eestate->clock_line);
	state_save_register_device_item( device, 0, eestate->reset_line);
	state_save_register_device_item( device, 0, eestate->locked);
	state_save_register_device_item( device, 0, eestate->serial_count);
	state_save_register_device_item( device, 0, eestate->latch);
	state_save_register_device_item( device, 0, eestate->reset_delay);
	state_save_register_device_item( device, 0, eestate->clock_count);
	state_save_register_device_item( device, 0, eestate->data_bits);
	state_save_register_device_item( device, 0, eestate->read_address);
}

static DEVICE_RESET(eeprom)
{
}


static const char DEVTEMPLATE_SOURCE[] = __FILE__;

#define DEVTEMPLATE_ID(p,s)		p##eeprom##s
#define DEVTEMPLATE_FEATURES	DT_HAS_START | DT_HAS_RESET | DT_HAS_NVRAM | DT_HAS_INLINE_CONFIG
#define DEVTEMPLATE_NAME		"EEPROM"
#define DEVTEMPLATE_FAMILY		"EEPROM"
#include "devtempl.h"