1 // license:BSD-3-Clause
2 // copyright-holders:Aaron Giles
3 /***************************************************************************
4 
5     midway.h
6 
7     Functions to emulate general the various Midway sound cards.
8 
9 ***************************************************************************/
10 #ifndef MAME_AUDIO_MIDWAY_H
11 #define MAME_AUDIO_MIDWAY_H
12 
13 #pragma once
14 
15 
16 #include "cpu/z80/z80.h"
17 #include "cpu/m68000/m68000.h"
18 #include "cpu/m6800/m6800.h"
19 #include "cpu/m6809/m6809.h"
20 #include "machine/6821pia.h"
21 #include "sound/ay8910.h"
22 #include "sound/dac.h"
23 #include "sound/flt_biquad.h"
24 #include "sound/hc55516.h"
25 #include "sound/tms5220.h"
26 
27 
28 //**************************************************************************
29 //  GLOBAL VARIABLES
30 //**************************************************************************
31 
DECLARE_DEVICE_TYPE(MIDWAY_SSIO,midway_ssio_device)32 DECLARE_DEVICE_TYPE(MIDWAY_SSIO,               midway_ssio_device)
33 DECLARE_DEVICE_TYPE(MIDWAY_SOUNDS_GOOD,        midway_sounds_good_device)
34 DECLARE_DEVICE_TYPE(MIDWAY_TURBO_CHEAP_SQUEAK, midway_turbo_cheap_squeak_device)
35 
36 
37 
38 //**************************************************************************
39 //  TYPE DEFINITIONS
40 //**************************************************************************
41 
42 // ======================> midway_ssio_device
43 
44 class midway_ssio_device :  public device_t,
45 							public device_mixer_interface
46 {
47 public:
48 	// construction/destruction
49 	midway_ssio_device(const machine_config &mconfig, const char *tag, device_t *owner, uint32_t clock = 16'000'000);
50 
51 	// helpers
52 	void suspend_cpu();
53 
54 	// read/write
55 	uint8_t read();
56 	void write(offs_t offset, uint8_t data);
57 	DECLARE_WRITE_LINE_MEMBER(reset_write);
58 	uint8_t ioport_read(offs_t offset);
59 	void ioport_write(offs_t offset, uint8_t data);
60 
61 	// configuration
62 	template <typename... T> void set_custom_input(int which, uint8_t mask, T &&... args)
63 	{
64 		m_custom_input_mask[which] = mask;
65 		m_custom_input[which].set(std::forward<T>(args)...);
66 	}
67 	template <typename... T> void set_custom_output(int which, uint8_t mask, T &&... args)
68 	{
69 		m_custom_output_mask[which / 4] = mask;
70 		m_custom_output[which / 4].set(std::forward<T>(args)...);
71 	}
72 
73 	// internal communications
74 	uint8_t irq_clear();
75 	void status_w(uint8_t data);
76 	uint8_t data_r(offs_t offset);
77 
78 	void ssio_map(address_map &map);
79 	static void ssio_input_ports(address_map &map, const char *ssio);
80 
81 protected:
82 	// device-level overrides
83 	virtual const tiny_rom_entry *device_rom_region() const override;
84 	virtual void device_add_mconfig(machine_config &config) override;
85 	virtual ioport_constructor device_input_ports() const override;
86 	virtual void device_start() override;
87 	virtual void device_reset() override;
88 	virtual void device_timer(emu_timer &timer, device_timer_id id, int param, void *ptr) override;
89 
90 private:
91 	// internal helpers
92 	void compute_ay8910_modulation();
93 	void update_volumes();
94 
95 	// devices
96 	required_device<z80_device> m_cpu;
97 	required_device<ay8910_device> m_ay0;
98 	required_device<ay8910_device> m_ay1;
99 
100 	// I/O ports
101 	optional_ioport_array<5> m_ports;
102 
103 	// internal state
104 	uint8_t m_data[4];
105 	uint8_t m_status;
106 	uint8_t m_14024_count;
107 	uint8_t m_mute;
108 	uint8_t m_overall[2];
109 	uint8_t m_duty_cycle[2][3];
110 	uint8_t m_ayvolume_lookup[16];
111 
112 	// I/O port overrides
113 	uint8_t m_custom_input_mask[5];
114 	read8smo_delegate::array<5> m_custom_input;
115 	uint8_t m_custom_output_mask[2];
116 	write8smo_delegate::array<2> m_custom_output;
117 
118 	INTERRUPT_GEN_MEMBER(clock_14024);
119 	void porta0_w(uint8_t data);
120 	void portb0_w(uint8_t data);
121 	void porta1_w(uint8_t data);
122 	void portb1_w(uint8_t data);
123 };
124 
125 
126 // ======================> midway_sounds_good_device
127 
128 class midway_sounds_good_device :   public device_t,
129 									public device_mixer_interface
130 {
131 public:
132 	// construction/destruction
133 	midway_sounds_good_device(const machine_config &mconfig, const char *tag, device_t *owner, uint32_t clock = 16'000'000);
134 
135 	// read/write
136 	uint8_t read();
137 	void write(uint8_t data);
138 	DECLARE_WRITE_LINE_MEMBER(reset_write);
139 
140 	void soundsgood_map(address_map &map);
141 protected:
142 	// device-level overrides
143 	virtual void device_add_mconfig(machine_config &config) override;
144 	virtual void device_start() override;
145 	virtual void device_reset() override;
146 	virtual void device_timer(emu_timer &timer, device_timer_id id, int param, void *ptr) override;
147 
148 private:
149 	// devices
150 	required_device<m68000_device> m_cpu;
151 	required_device<pia6821_device> m_pia;
152 	required_device<ad7533_device> m_dac;
153 	required_device_array<filter_biquad_device, 3> m_dac_filter;
154 
155 	// internal state
156 	uint8_t m_status;
157 	uint16_t m_dacval;
158 
159 	// internal communications
160 	void porta_w(uint8_t data);
161 	void portb_w(uint8_t data);
162 	DECLARE_WRITE_LINE_MEMBER(irq_w);
163 };
164 
165 
166 // ======================> midway_turbo_cheap_squeak_device
167 
168 class midway_turbo_cheap_squeak_device : public device_t,
169 										public device_mixer_interface
170 {
171 public:
172 	// construction/destruction
173 	midway_turbo_cheap_squeak_device(const machine_config &mconfig, const char *tag, device_t *owner, uint32_t clock = 8'000'000);
174 
175 	// read/write
176 	uint8_t read();
177 	void write(uint8_t data);
178 	DECLARE_WRITE_LINE_MEMBER(reset_write);
179 
180 	void turbocs_map(address_map &map);
181 protected:
182 	// device-level overrides
183 	virtual void device_add_mconfig(machine_config &config) override;
184 	virtual void device_start() override;
185 	virtual void device_reset() override;
186 	virtual void device_timer(emu_timer &timer, device_timer_id id, int param, void *ptr) override;
187 
188 private:
189 	// devices
190 	required_device<mc6809e_device> m_cpu;
191 	required_device<pia6821_device> m_pia;
192 	required_device<ad7533_device> m_dac;
193 	required_device_array<filter_biquad_device, 3> m_dac_filter;
194 
195 	// internal state
196 	uint8_t m_status;
197 	uint16_t m_dacval;
198 
199 	// internal communications
200 	void porta_w(uint8_t data);
201 	void portb_w(uint8_t data);
202 	DECLARE_WRITE_LINE_MEMBER(irq_w);
203 };
204 
205 #endif // MAME_AUDIO_MIDWAY_H
206