summaryrefslogtreecommitdiffstatshomepage
path: root/src/devices/machine/nmc9306.cpp
blob: 2001f58e78d0c0578eb101994acb297b0e4339d0 (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
// license:BSD-3-Clause
// copyright-holders:Curt Coder
/**********************************************************************

    National Semiconductor NMC9306 256-Bit Serial EEPROM emulation

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

#include "emu.h"
#include "nmc9306.h"

//#define VERBOSE 1
#include "logmacro.h"



//**************************************************************************
//  MACROS / CONSTANTS
//**************************************************************************

#define RAM_SIZE 32


// instructions
enum
{
	OTHER = 0,
	WRITE,          // write register A3A2A1A0
	READ,           // read register  A3A2A1A0
	ERASE           // erase register A3A2A1A0
};

// other instructions
enum
{
	EWDS = 0,       // erase/write disable
	WRAL,           // write all registers
	ERAL,           // erase all registers
	EWEN            // erase/write enable
};

// states
enum
{
	STATE_IDLE = 0,
	STATE_START,
	STATE_COMMAND,
	STATE_ADDRESS,
	STATE_DATA_IN,
	STATE_DUMMY_OUT,
	STATE_DATA_OUT,
	STATE_ERASE,
	STATE_WRITE
};



//**************************************************************************
//  INLINE HELPERS
//**************************************************************************

// device type definition
DEFINE_DEVICE_TYPE(NMC9306, nmc9306_device, "nmc9306", "NMC9306 EEPROM")

//-------------------------------------------------
//  nmc9306_device - constructor
//-------------------------------------------------

inline uint16_t nmc9306_device::read(offs_t offset)
{
	return m_register[offset];
}


//-------------------------------------------------
//  nmc9306_device - constructor
//-------------------------------------------------

inline void nmc9306_device::write(offs_t offset, u16 data)
{
	if (m_ewen)
	{
		m_register[offset] = data;
	}
}


//-------------------------------------------------
//  nmc9306_device - constructor
//-------------------------------------------------

inline void nmc9306_device::erase(offs_t offset)
{
	if (m_ewen)
	{
		m_register[offset] = 0xffff;
	}
}



//**************************************************************************
//  LIVE DEVICE
//**************************************************************************

//-------------------------------------------------
//  nmc9306_device - constructor
//-------------------------------------------------

nmc9306_device::nmc9306_device(const machine_config &mconfig, const char *tag, device_t *owner, uint32_t clock) :
	device_t(mconfig, NMC9306, tag, owner, clock),
	device_nvram_interface(mconfig, *this),
	m_bits(0),
	m_state(STATE_IDLE),
	m_command(0),
	m_address(0),
	m_data(0),
	m_ewen(false),
	m_cs(0),
	m_sk(0),
	m_do(0),
	m_di(0)
{
}


//-------------------------------------------------
//  device_start - device-specific startup
//-------------------------------------------------

void nmc9306_device::device_start()
{
	memset(m_register, 0, sizeof(m_register));

	// state saving
	save_item(NAME(m_bits));
	save_item(NAME(m_state));
	save_item(NAME(m_command));
	save_item(NAME(m_address));
	save_item(NAME(m_data));
	save_item(NAME(m_ewen));
	save_item(NAME(m_cs));
	save_item(NAME(m_sk));
	save_item(NAME(m_do));
	save_item(NAME(m_di));
}


//-------------------------------------------------
//  nvram_default - called to initialize NVRAM to
//  its default state
//-------------------------------------------------

void nmc9306_device::nvram_default()
{
	for (auto & elem : m_register)
		elem = 0xffff;
}


//-------------------------------------------------
//  nvram_read - called to read NVRAM from the
//  .nv file
//-------------------------------------------------

bool nmc9306_device::nvram_read(util::read_stream &file)
{
	auto const [err, actual] = util::read(file, m_register, RAM_SIZE);
	return !err && (actual == RAM_SIZE);
}


//-------------------------------------------------
//  nvram_write - called to write NVRAM to the
//  .nv file
//-------------------------------------------------

bool nmc9306_device::nvram_write(util::write_stream &file)
{
	auto const [err, actual] = util::write(file, m_register, RAM_SIZE);
	return !err;
}


//-------------------------------------------------
//  cs_w - chip select input
//-------------------------------------------------

void nmc9306_device::cs_w(int state)
{
	if (m_cs != state)
	{
		LOG("NMC9306 CS %u\n", state);

		if (m_cs && !state)
		{
			switch ((m_command >> 2) & 0x03)
			{
			case OTHER:
				switch (m_command & 0x03)
				{
				case WRAL:
					if (m_state == STATE_WRITE)
					{
						LOG("NMC9306 WRAL\n");
						for (int address = 0; address < 16; address++)
						{
							write(address, m_data);
						}
					}
					break;

				case ERAL:
					if (m_state == STATE_ERASE)
					{
						LOG("NMC9306 ERAL\n");
						for (int address = 0; address < 16; address++)
						{
							erase(address);
						}
					}
					break;
				}
				break;

			case WRITE:
				if (m_state == STATE_WRITE)
				{
					LOG("NMC9306 WRITE %u:%04x\n", m_address, m_data);
					write(m_address, m_data);
				}
				break;

			case ERASE:
				if (m_state == STATE_ERASE)
				{
					LOG("NMC9306 ERASE %u\n", m_address);
					erase(m_address);
				}
				break;
			}

			m_state = STATE_IDLE;
			m_bits = 0;
			m_do = 0;
		}
	}

	m_cs = state;
}


//-------------------------------------------------
//  ck_w - serial clock input
//-------------------------------------------------

void nmc9306_device::sk_w(int state)
{
	if (!m_cs) return;
	if (m_sk == state) return;

	LOG("NMC9306 SK %u\n", state);

	m_sk = state;

	if (m_sk && ((m_state == STATE_DUMMY_OUT) || (m_state == STATE_DATA_OUT))) return;
	if (!m_sk && (m_state != STATE_DUMMY_OUT) && (m_state != STATE_DATA_OUT)) return;

	switch (m_state)
	{
	case STATE_IDLE:
		LOG("NMC9306 Idle %u\n", m_di);

		if (!m_di)
		{
			// start bit received
			m_state = STATE_START;
		}
		break;

	case STATE_START:
		LOG("NMC9306 Start %u\n", m_di);

		if (m_di)
		{
			m_state = STATE_COMMAND;
			m_bits = 0;
		}
		break;

	case STATE_COMMAND:
		LOG("NMC9306 Command Bit %u\n", m_di);

		m_command <<= 1;
		m_command |= m_di;
		m_command &= 0xf;

		m_bits++;

		if (m_bits == 4)
		{
			m_state = STATE_ADDRESS;
			m_bits = 0;
		}
		break;

	case STATE_ADDRESS:
		LOG("NMC9306 Address Bit %u\n", m_di);

		m_address <<= 1;
		m_address |= m_di;
		m_address &= 0xf;

		m_bits++;

		if (m_bits == 4)
		{
			switch ((m_command >> 2) & 0x03)
			{
			case OTHER:
				switch (m_command & 0x03)
				{
				case EWDS:
					LOG("NMC9306 EWDS\n");
					m_ewen = false;
					m_state = STATE_IDLE;
					break;

				case WRAL:
					LOG("NMC9306 Command WRAL\n");
					m_state = STATE_DATA_IN;
					break;

				case ERAL:
					LOG("NMC9306 Command ERAL\n");
					m_state = ERASE;
					break;

				case EWEN:
					LOG("NMC9306 EWEN\n");
					m_ewen = true;
					m_state = STATE_IDLE;
					break;
				}
				break;

			case WRITE:
				LOG("NMC9306 Command WRITE %u\n", m_address);
				m_state = STATE_DATA_IN;
				break;

			case READ:
				m_data = read(m_address);
				LOG("NMC9306 READ %u:%04x\n", m_address, m_data);
				m_state = STATE_DUMMY_OUT;
				break;

			case ERASE:
				LOG("NMC9306 Command ERASE %u\n", m_address);
				m_state = ERASE;
				break;
			}

			m_bits = 0;
		}
		break;

	case STATE_DATA_IN:
		LOG("NMC9306 Data Bit IN %u\n", m_di);

		m_data <<= 1;
		m_data |= m_di;

		m_bits++;

		if (m_bits == 16)
		{
			m_state = STATE_WRITE;
		}
		break;

	case STATE_DUMMY_OUT:
		m_do = 0;

		LOG("NMC9306 Dummy Bit OUT %u\n", m_do);

		m_state = STATE_DATA_OUT;
		break;

	case STATE_DATA_OUT:
		m_do = BIT(m_data, 15);
		m_data <<= 1;

		LOG("NMC9306 Data Bit OUT %u\n", m_do);

		m_bits++;

		if (m_bits == 16)
		{
			m_state = STATE_IDLE;
		}
		break;
	}
}


//-------------------------------------------------
//  di_w - serial data input
//-------------------------------------------------

void nmc9306_device::di_w(int state)
{
	m_di = state;
}


//-------------------------------------------------
//  do_r - serial data output
//-------------------------------------------------

int nmc9306_device::do_r()
{
	return m_do;
}