summaryrefslogtreecommitdiffstatshomepage
path: root/src/devices/machine/wd1000.cpp
blob: b0dbb1825901bf8fc735480d2eb28ead3fc1209c (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
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
// license:BSD-3-Clause
// copyright-holders:68bit
/***************************************************************************

    Western Digital WD1000 Winchester Disk Controller

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

#include "emu.h"
#include "machine/wd1000.h"

//**************************************************************************
//  DEVICE DEFINITIONS
//**************************************************************************

DEFINE_DEVICE_TYPE(WD1000, wd1000_device, "wd1000", "Western Digital WD1000 Winchester Disk Controller")


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

//-------------------------------------------------
//  wd1000_device - constructor
//-------------------------------------------------

wd1000_device::wd1000_device(const machine_config &mconfig, const char *tag, device_t *owner, uint32_t clock)
	: device_t(mconfig, WD1000, tag, owner, clock)
	, m_intrq_cb(*this)
	, m_drq_cb(*this)
	, m_drives(*this, "%u", 0)
	, m_sector_base(0)
	, m_buffer_index(0)
	, m_buffer_end(0)
	, m_intrq(0)
	, m_drq(0)
	, m_stepping_rate(0x00)
	, m_command(0x00)
	, m_error(0x00)
	, m_precomp(0x00)
	, m_sector_count(0x00)
	, m_sector_number(0x00)
	, m_cylinder(0x0000)
	, m_sdh(0x00)
	, m_status(0x00)
{
}

void wd1000_device::set_sector_base(uint32_t base)
{
	m_sector_base = base;
}

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

void wd1000_device::device_start()
{
	// Resolve callbacks
	m_intrq_cb.resolve();
	m_drq_cb.resolve();

	// Allocate timers
	m_seek_timer = timer_alloc(TIMER_SEEK);
	m_drq_timer = timer_alloc(TIMER_DRQ);

	// Empty buffer.
	m_buffer_index = 0;

	for (int i = 0; i < 4; i++)
		m_drive_cylinder[i] = 0;

	// Initialize the status as ready if the initial drive exists,
	// and assume it has been restored so seek is complete.
	if (m_drives[drive()] && m_drives[drive()]->exists())
		m_status |= S_RDY | S_SC;

	save_item(NAME(m_drive_cylinder));
	save_item(NAME(m_sector_base));
	save_item(NAME(m_buffer));
	save_item(NAME(m_buffer_index));
	save_item(NAME(m_buffer_end));
	save_item(NAME(m_intrq));
	save_item(NAME(m_drq));
	save_item(NAME(m_stepping_rate));
	save_item(NAME(m_command));
	save_item(NAME(m_error));
	save_item(NAME(m_precomp));
	save_item(NAME(m_sector_count));
	save_item(NAME(m_sector_number));
	save_item(NAME(m_cylinder));
	save_item(NAME(m_sdh));
	save_item(NAME(m_status));
}

//-------------------------------------------------
//  device_reset - device-specific reset
//-------------------------------------------------

void wd1000_device::device_reset()
{
	m_buffer_index = 0;
	m_sdh = 0x20;

	for (int i = 0; i < 4; i++)
		m_drive_cylinder[i] = 0;

	if (m_drives[drive()] && m_drives[drive()]->exists())
		m_status |= S_RDY | S_SC;
}

//-------------------------------------------------
//  device_timer - device-specific timer
//-------------------------------------------------

void wd1000_device::device_timer(emu_timer &timer, device_timer_id tid, int param, void *ptr)
{
	switch (tid)
	{
	case TIMER_SEEK:

		m_drive_cylinder[drive()] = param;
		m_status |= S_SC;

		switch (m_command >> 4)
		{
		case CMD_RESTORE:
			cmd_restore();
			break;

		case CMD_SEEK:
			cmd_seek();
			break;

		case CMD_READ_SECTOR:
			cmd_read_sector();
			break;

		case CMD_WRITE_SECTOR:
			cmd_write_sector();
			break;

		case CMD_WRITE_FORMAT:
			cmd_format_sector();
			break;
		}

		break;

	case TIMER_DRQ:
		set_drq();
		break;
	}
}

void wd1000_device::set_error(int error)
{
	if (error)
	{
		m_error |= error;
		m_status |= S_ERR;
	}
	else
	{
		m_error = 0;
		m_status &= ~S_ERR;
	}
}

void wd1000_device::set_intrq(int state)
{
	if (m_intrq == 0 && state == 1)
	{
		m_intrq = 1;
		m_intrq_cb(1);
	}
	else if (m_intrq == 1 && state == 0)
	{
		m_intrq = 0;
		m_intrq_cb(0);
	}
}

void wd1000_device::set_drq()
{
	if ((m_status & S_DRQ) == 0)
	{
		m_status |= S_DRQ;
		if (!m_drq_cb.isnull())
			m_drq_cb(true);
	}
}

void wd1000_device::drop_drq()
{
	if (m_status & S_DRQ)
	{
		m_status &= ~S_DRQ;
		if (!m_drq_cb.isnull())
			m_drq_cb(false);
	}
}

attotime wd1000_device::get_stepping_rate()
{
	if (m_stepping_rate)
		return attotime::from_usec(500 * m_stepping_rate);
	else
		return attotime::from_usec(10);
}

void wd1000_device::start_command()
{
	m_status |= S_BSY;
	set_error(0);

	switch (m_command >> 4)
	{
	case CMD_RESTORE:
		m_stepping_rate = m_command & 0x0f;
		break;
	case CMD_READ_SECTOR:
		break;
	case CMD_WRITE_SECTOR:
		break;
	case CMD_WRITE_FORMAT:
		break;
	case CMD_SEEK:
		m_stepping_rate = m_command & 0x0f;
		break;
	}
}

void wd1000_device::end_command()
{
	m_status &= ~S_BSY;
	set_intrq(1);
}

int wd1000_device::get_lbasector()
{
	hard_disk_file *file = m_drives[drive()]->get_hard_disk_file();
	hard_disk_info *info = hard_disk_get_info(file);
	int lbasector;

	if (m_cylinder > info->cylinders)
	{
		logerror("%s: Unexpected cylinder %d for range 0 to %d\n", machine().describe_context(), m_cylinder, info->cylinders - 1);
	}

	if (head() >= info->heads)
	{
		logerror("%s: Unexpected head %d for range 0 to %d\n", machine().describe_context(), head(), info->heads - 1);
	}

	int16_t sector = m_sector_number - m_sector_base;

	if (sector < 0 || sector >= info->sectors)
	{
		logerror("%s: Unexpected sector number %d for range %d to %d\n", machine().describe_context(), m_sector_number, m_sector_base, info->sectors + m_sector_base);
	}

	if (sector_bytes() != info->sectorbytes)
	{
		logerror("%s: Unexpected sector bytes %d, expected %d\n", machine().describe_context(), sector_bytes(), info->sectorbytes);
	}

	lbasector = m_cylinder;
	lbasector *= info->heads;
	lbasector += head();
	lbasector *= info->sectors;
	lbasector += sector;

	return lbasector;
}

uint8_t wd1000_device::data_r()
{
	uint8_t data = 0x00;

	if (machine().side_effects_disabled())
		return data;

	drop_drq();

	if (m_buffer_index >= m_buffer_end)
	{
		// Transfer has already completed.
		logerror("%s: Unexpected buffer read at %d beyond tail %d\n", machine().describe_context(), m_buffer_index, m_buffer_end);
		return data;
	}

	data = m_buffer[m_buffer_index++];

	if (m_buffer_index == m_buffer_end)
	{
		// Tranfer completed.
		if ((m_command >> 4) == CMD_READ_SECTOR)
		{
			uint8_t dma = BIT(m_command, 3);

			if (dma)
			{
				set_intrq(1);
			}
		}
		else
		{
			logerror("%s: Unexpected buffer read transfer for command %02x\n", machine().describe_context(), m_command);
		}
	}
	else
	{
		// Continue the transfer. A delay is implemented here to avoid
		// recursion in the DRQ handler.
		m_drq_timer->adjust(attotime::from_usec(1));
	}

	return data;
}

READ8_MEMBER( wd1000_device::read )
{
	if ((m_status & S_BSY) && offset != 7)
	{
		logerror("%s Unexpected register %d read while busy\n", machine().describe_context(), offset & 0x07);
		return m_status;
	}

	switch (offset & 0x07)
	{
	case 0:
		// Data register.
		return data_r();

	case 1:
		// Error register:
		//  bit 7 bad block detect
		//  bit 6 CRC error, data field
		//  bit 5 CRC error, ID field
		//  bit 4 ID not found
		//  bit 3 unused
		//  bit 2 Aborted Command
		//  bit 1 TR000 (track zero) error
		//  bit 0 DAM not found
		// The error register is only valid if the error bit in the
		// status register is set
		return m_error;

	case 2:
		// Sector count. This is only used in the format command where
		// it is decremented to zero.
		return m_sector_count;

	case 3:
		// Sector number.
		return m_sector_number;

	case 4:
		// Cylinder low byte C0-C7
		// This read clears DRQ. This is intended for the handling
		// aborted sector reads that leave DRQ asserted.
		if (!machine().side_effects_disabled())
		{
			set_intrq(0);
			drop_drq();
		}
		return m_cylinder & 0xff;

	case 5:
		// Cylinder high byte C8-C9
		return m_cylinder >> 8;

	case 6:
		// Size / head / drive
		return m_sdh;

	case 7:
		// Status.
		// bit 7 Busy
		// bit 6 Ready
		// bit 5 Write fault
		// bit 4 Seek complete
		// bit 3 Data request (DRQ)
		// bit 2 -
		// bit 1 -
		// bit 0 Error
		// return 'ready' + 'seek complete'
		// If the busy bit is set then no other bits are valid!!!
		//
		// Reading the status register clears the interrupt.
		//
		// TODO should reading the status register while busy reset
		// the interrupt?
		if (!machine().side_effects_disabled())
			set_intrq(0);

		return m_status;
	}

	return 0x00;
}

void wd1000_device::data_w(uint8_t data)
{
	drop_drq();

	if (m_buffer_index >= m_buffer_end)
	{
		// Transfer has already completed.
		logerror("%s: Unexpected buffer write at %d beyond tail %d\n", machine().describe_context(), m_buffer_index, m_buffer_end);
		return;
	}

	m_buffer[m_buffer_index++] = data;

	if (m_buffer_index == m_buffer_end)
	{
		// Tranfer completed.
		if ((m_command >> 4) == CMD_WRITE_SECTOR ||
			(m_command >> 4) == CMD_WRITE_FORMAT)
		{
			m_status |= S_BSY;
			set_error(0);
			// Implied seek
			m_status &= ~S_SC;
			int amount = abs(m_drive_cylinder[drive()] - m_cylinder);
			int target = m_cylinder;
			m_seek_timer->adjust(get_stepping_rate() * amount, target);
		}
		else
		{
			logerror("%s: Unexpected buffer write transfer for command %02x\n", machine().describe_context(), m_command);
		}
	}
	else
	{
		// Continue the transfer
		m_drq_timer->adjust(attotime::from_usec(1));
	}
}

WRITE8_MEMBER( wd1000_device::write )
{
	switch (offset & 0x07)
	{
	case 0:
		// Data register
		data_w(data);
		break;

	case 1:
		// Write precomp
		m_precomp = data;
		break;

	case 2:
		// Sector Count
		m_sector_count = data;
		break;

	case 3:
		// Sector Number
		m_sector_number = data;
		break;

	case 4:
		// Cylinder Low
		m_cylinder = (m_cylinder & 0xff00) | (data << 0);
		break;

	case 5:
		// Cylinder High
		m_cylinder = (m_cylinder & 0x00ff) | (data << 8);
		break;

	case 6:
	  {
		// Size / drive / head
		//   bit 7    : Honour error correction (WD-1001 only?)
		//   bit 6,5  : sector size (0: 256, 1: 512, 3: 128)
		//   bit 4,3  : drive select (0,1,2,3)
		//   bit 2,1,0: head select (0-7)
		uint8_t drive = (data & 0x18) >> 3;
		m_sdh = data;

		// Update the drive ready flag in the status register which
		// indicates the ready state for the selected drive.
		// TODO should this also set the SC flag?
		if (m_drives[drive] && m_drives[drive]->exists())
			m_status |= S_RDY;
		else
			m_status &= ~S_RDY;

		break;
	  }

	case 7:
		// Command register
		// Load while the controller is not busy.
		// Task file must have been loaded??
		// Not if 'Seek complete' or 'Ready' are false, or 'Write fault' is true.

		if (m_status & S_BSY)
		{
			logerror("%s: Unexpected command %02x issued when already busy with %02x\n", machine().describe_context(), data, m_command);
			// TODO should it be ignored?
			//return;
		}

		// Interrupts are cleared and the error bit is reset
		// on receipt of a new command.
		set_intrq(0);
		set_error(0);

		if (!(m_status & S_RDY))
		{
			logerror("%s: Unexpected command %02x when not ready\n", machine().describe_context(), m_command);
			set_error(ERR_AC);
			end_command();
		}
		else
		{
			m_command = data;

			switch (m_command >> 4)
			{
			case CMD_RESTORE:
			  {
				start_command();
				// Schedule an implied seek.
				m_status &= ~S_SC;
				int amount = m_drive_cylinder[drive()];
				int target = 0;
				m_seek_timer->adjust(get_stepping_rate() * amount, target);
				break;
			  }

			case CMD_SEEK:
			case CMD_READ_SECTOR:
			  {
				start_command();
				int amount = abs(m_drive_cylinder[drive()] - m_cylinder);
				int target = m_cylinder;
				m_seek_timer->adjust(get_stepping_rate() * amount, target);
				break;
			  }

			case CMD_WRITE_SECTOR:
			case CMD_WRITE_FORMAT:
				// These commands do not perform an implied
				// seek until all the data has been
				// transferred, so just start the transfer
				// here.
				m_buffer_index = 0;
				m_buffer_end = 512;
				set_drq();
				break;
			}

		}

		break;
	}
}

void wd1000_device::cmd_restore()
{
	end_command();
}

// These commands should only be reachable if the status flag S_RDY is
// true, and that should only occur if the m_drives element is there,
// so it is not necessary to guard that case in these functions.
void wd1000_device::cmd_read_sector()
{
	hard_disk_file *file = m_drives[drive()]->get_hard_disk_file();
	uint8_t dma = BIT(m_command, 3);

	hard_disk_read(file, get_lbasector(), m_buffer);

	m_buffer_index = 0;
	m_buffer_end = 512;

	m_status &= ~S_BSY;

	set_drq();

	if (!dma)
	{
		// Interrupt now, rather than at the end of the DMA transfer.
		set_intrq(1);
	}
}

void wd1000_device::cmd_write_sector()
{
	hard_disk_file *file = m_drives[drive()]->get_hard_disk_file();

	if (m_buffer_index != sector_bytes())
	{
		logerror("%s: Unexpected unfilled buffer on write, only %d or %d bytes filled\n", machine().describe_context(), m_buffer_index, sector_bytes());
	}

	hard_disk_write(file, get_lbasector(), m_buffer);

	end_command();
}

void wd1000_device::cmd_format_sector()
{
	hard_disk_file *file = m_drives[drive()]->get_hard_disk_file();
	uint8_t buffer[512];

	// The m_buffer appears to be loaded with an interleave table which is
	// not used here. The sectors are zero filled.

	for (int i = 0; i < m_sector_count; i++)
	{
		std::fill(std::begin(buffer), std::end(buffer), 0);
		hard_disk_write(file, get_lbasector(), buffer);
	}

	m_sector_count = 0;

	end_command();
}

void wd1000_device::cmd_seek()
{
	end_command();
}