// license:BSD-3-Clause
// copyright-holders:Jonathan Gevaryahu
/******************************************************************************
*
* Pacific Educational Systems 'PES' Speech box
* Part number VPU-1 V1
* By Kevin 'kevtris' Horton and Jonathan Gevaryahu AKA Lord Nightmare
*
* RE work done by Kevin Horton and Jonathan Gevaryahu
*
* DONE:
* compiles correctly
* rom loads correctly
* interface with tms5220 is done
* rts and cts bits are stored in struct
* serial is attached to terminal
*
* TODO:
* serial receive clear should happen after delay of one cpu cycle, not ASSERT and then CLEAR immediately after
* figure out how to attach serial to external socket
*
***********************************************************************
This is almost as simple as hardware gets from the digital side:
Hardware consists of:
10.245Mhz xtal
80c31 cpu/mcu
27c64 rom (holds less than 256 bytes of code)
unpopulated 6164 sram, which isn't used
TSP5220C speech chip (aka tms5220c)
mc145406 RS232 driver/receiver (+-24v to 0-5v converter for serial i/o)
74hc573b1 octal tri-state D-latch (part of bus interface for ROM)
74hc74b1 dual d-flipflop with set/reset, positive edge trigger (?)
74hc02b1 quad 2-input NOR gate (wired up to decode address 0, and data 0 and 1 to produce /RS and /WS)
mc14520b dual 4-bit binary up counter (used as a chopper for the analog filter)
Big messy analog section to allow voice output to be filtered extensively by a 4th order filter
Address map:
80C31 ADDR:
0000-1FFF: ROM
2000-3FFF: open bus (would be ram)
4000-ffff: open bus
80C31 IO:
00 W: d0 and d1 are the /RS and /WS bits
port 1.x: tms5220 bus
port 2.x: unused
port 3.0: RxD serial receive
port 3.1: TxD serial send
port 3.2: read, from /INT on tms5220c
port 3.3: read, from /READY on tms5220c
port 3.4: read, from the serial RTS line
port 3.5: read/write, to the serial CTS line, inverted (effectively /CTS)
port 3.6: write, /WR (general) and /WE (pin 27) for unpopulated 6164 SRAM
port 3.7: write, /RD (general) and /OE (pin 22) for unpopulated 6164 SRAM
*/
#include "emu.h"
#include "includes/pes.h"
#include "cpu/mcs51/mcs51.h"
#include "sound/tms5220.h"
#include "speaker.h"
#define CPU_CLOCK XTAL(10'245'000)
#undef DEBUG_FIFO
#undef DEBUG_SERIAL_CB
#undef DEBUG_PORTS
/* Devices */
void pes_state::pes_kbd_input(u8 data)
{
#ifdef DEBUG_FIFO
fprintf(stderr,"keyboard input: %c, ", data);
#endif
// if fifo is full (head ptr = tail ptr-1), do not increment the head ptr and do not store the data
if (((m_infifo_tail_ptr-1)&0x1F) == m_infifo_head_ptr)
{
logerror("infifo was full, write ignored!\n");
#ifdef DEBUG_FIFO
fprintf(stderr,"infifo was full, write ignored!\n");
#endif
return;
}
m_infifo[m_infifo_head_ptr] = data;
m_infifo_head_ptr++;
m_infifo_head_ptr&=0x1F;
#ifdef DEBUG_FIFO
fprintf(stderr,"kb input fifo fullness: %d\n",(m_infifo_head_ptr-m_infifo_tail_ptr)&0x1F);
#endif
// todo: following two should be set so clear happens after one cpu cycle
m_maincpu->set_input_line(MCS51_RX_LINE, ASSERT_LINE);
m_maincpu->set_input_line(MCS51_RX_LINE, CLEAR_LINE);
}
/* Helper Functions */
READ8_MEMBER( pes_state::data_to_i8031)
{
uint8_t data;
data = m_infifo[m_infifo_tail_ptr];
// if fifo is empty (tail ptr == head ptr), do not increment the tail ptr, otherwise do.
if (m_infifo_tail_ptr != m_infifo_head_ptr) m_infifo_tail_ptr++;
m_infifo_tail_ptr&=0x1F;
#ifdef DEBUG_SERIAL_CB
fprintf(stderr,"callback: input to i8031/pes from pc/terminal: %02X\n",data);
#endif
return data;
}
WRITE8_MEMBER(pes_state::data_from_i8031)
{
m_terminal->write(space,0,data);
#ifdef DEBUG_SERIAL_CB
fprintf(stderr,"callback: output from i8031/pes to pc/terminal: %02X\n",data);
#endif
}
/* Port Handlers */
WRITE8_MEMBER( pes_state::rsq_wsq_w )
{
#ifdef DEBUG_PORTS
logerror("port0 write: RSWS states updated: /RS: %d, /WS: %d\n", (data&0x2)>>1, data&0x1);
#endif
/* /RS is bit 1, /WS is bit 0 */
m_speech->combined_rsq_wsq_w(space, 0, data&0x3);
}
WRITE8_MEMBER( pes_state::port1_w )
{
#ifdef DEBUG_PORTS
logerror("port1 write: tms5220 data written: %02X\n", data);
#endif
m_speech->data_w(data);
}
READ8_MEMBER( pes_state::port1_r )
{
uint8_t data = 0xFF;
data = m_speech->status_r();
#ifdef DEBUG_PORTS
logerror("port1 read: tms5220 data read: 0x%02X\n", data);
#endif
return data;
}
/*#define P3_RXD (((state->m_port3_data)&(1<<0))>>0)
#define P3_TXD (((state->m_port3_data)&(1<<1))>>1)
#define P3_INT (((state->m_port3_data)&(1<<2))>>2)
#define P3_RDY (((state->m_port3_data)&(1<<3))>>3)
#define P3_RTS (((state->m_port3_data)&(1<<4))>>4)
#define P3_CTS (((state->m_port3_data)&(1<<5))>>5)
#define P3_WR (((state->m_port3_data)&(1<<6))>>6)
#define P3_RD (((state->m_port3_data)&(1<<7))>>7)
*/
WRITE8_MEMBER( pes_state::port3_w )
{
m_port3_state = data;
#ifdef DEBUG_PORTS
logerror("port3 write: control data written: %02X; ", data);
logerror("RXD: %d; ", BIT(data,0));
logerror("TXD: %d; ", BIT(data,1));
logerror("/INT: %d; ", BIT(data,2));
logerror("/RDY: %d; ", BIT(data,3));
logerror("RTS: %d; ", BIT(data,4));
logerror("CTS: %d; ", BIT(data,5));
logerror("WR: %d; ", BIT(data,6));
logerror("RD: %d;\n", BIT(data,7));
#endif
// todo: poke serial handler here somehow?
}
READ8_MEMBER( pes_state::port3_r )
{
uint8_t data = m_port3_state & 0xE3; // return last written state with rts, /rdy and /int masked out
// check rts state; if virtual fifo is nonzero, rts is set, otherwise it is cleared
if (m_infifo_tail_ptr != m_infifo_head_ptr)
{
data |= 0x10; // set RTS bit
}
data |= (m_speech->intq_r()<<2);
data |= (m_speech->readyq_r()<<3);
#ifdef DEBUG_PORTS
logerror("port3 read: returning 0x%02X: ", data);
logerror("RXD: %d; ", BIT(data,0));
logerror("TXD: %d; ", BIT(data,1));
logerror("/INT: %d; ", BIT(data,2));
logerror("/RDY: %d; ", BIT(data,3));
logerror("RTS: %d; ", BIT(data,4));
logerror("CTS: %d; ", BIT(data,5));
logerror("WR: %d; ", BIT(data,6));
logerror("RD: %d;\n", BIT(data,7));
#endif
return data;
}
/* Reset */
void pes_state::machine_reset()
{
// clear fifos (TODO: memset would work better here...)
int i;
for (i=0; i<32; i++) m_infifo[i] = 0;
m_infifo_tail_ptr = m_infifo_head_ptr = 0;
m_wsstate = 1;
m_rsstate = 1;
m_port3_state = 0; // reset the openbus state of port 3
//m_maincpu->set_input_line(INPUT_LINE_RESET, ASSERT_LINE); // this causes debugger to fail badly if included
m_speech->reset(); // reset the 5220
}
/******************************************************************************
Driver Init and Timer Callbacks
******************************************************************************/
/*static TIMER_CALLBACK_MEMBER(pes_state::serial_read_cb )
{
timer_set(attotime::from_hz(10000), TIMER_OUTFIFO_READ);
}*/
/******************************************************************************
Address Maps
******************************************************************************/
void pes_state::i80c31_mem(address_map &map)
{
map.unmap_value_high();
map(0x0000, 0x1fff).rom(); /* 27C64 ROM */
// AM_RANGE(0x2000, 0x3fff) AM_RAM /* 6164 8k SRAM, not populated */
}
void pes_state::i80c31_io(address_map &map)
{
map.global_mask(0xff);
map(0x0, 0x0).w(FUNC(pes_state::rsq_wsq_w)); /* /WS(0) and /RS(1) */
map(0x1, 0x1).rw(FUNC(pes_state::port1_r), FUNC(pes_state::port1_w)); /* tms5220 reads and writes */
map(0x3, 0x3).rw(FUNC(pes_state::port3_r), FUNC(pes_state::port3_w)); /* writes and reads from port 3, see top of file */
}
/******************************************************************************
Input Ports
******************************************************************************/
static INPUT_PORTS_START( pes )
INPUT_PORTS_END
/******************************************************************************
Machine Drivers
******************************************************************************/
void pes_state::pes(machine_config &config)
{
/* basic machine hardware */
I80C31(config, m_maincpu, CPU_CLOCK);
m_maincpu->set_addrmap(AS_PROGRAM, &pes_state::i80c31_mem);
m_maincpu->set_addrmap(AS_IO, &pes_state::i80c31_io);
m_maincpu->serial_tx_cb().set(FUNC(pes_state::data_from_i8031));
m_maincpu->serial_rx_cb().set(FUNC(pes_state::data_to_i8031));
/* sound hardware */
SPEAKER(config, "mono").front_center();
TMS5220C(config, m_speech, 720000); /* 720Khz clock, 10khz output */
m_speech->add_route(ALL_OUTPUTS, "mono", 1.0);
GENERIC_TERMINAL(config, m_terminal, 0);
m_terminal->set_keyboard_callback(FUNC(pes_state::pes_kbd_input));
}
/******************************************************************************
ROM Definitions
******************************************************************************/
ROM_START( pes )
ROM_REGION( 0x10000, "maincpu", 0 )
ROM_DEFAULT_BIOS("kevbios")
ROM_SYSTEM_BIOS( 0, "orig", "PES box with original firmware v2.5")
ROMX_LOAD( "vpu_2-5.bin", 0x0000, 0x2000, CRC(b27cfdf7) SHA1(c52acf9c080823de5ef26ac55abe168ad53a7d38), ROM_BIOS(0)) // original firmware, rather buggy, 4800bps serial, buggy RTS/CTS flow control, no buffer
ROM_SYSTEM_BIOS( 1, "kevbios", "PES box with kevtris' rewritten firmware")
ROMX_LOAD( "pes.bin", 0x0000, 0x2000, CRC(22c1c4ec) SHA1(042e139cd0cf6ffafcd88904f1636c6fa1b38f25), ROM_BIOS(1)) // rewritten firmware by kevtris, 4800bps serial, RTS/CTS plus XON/XOFF flow control, 64 byte buffer
ROM_END
/******************************************************************************
Drivers
******************************************************************************/
// YEAR NAME PARENT COMPAT MACHINE INPUT CLASS INIT COMPANY FULLNAME FLAGS
COMP( 1987, pes, 0, 0, pes, pes, pes_state, empty_init, "Pacific Educational Systems", "VPU-01 Speech box", MACHINE_NOT_WORKING )