summaryrefslogtreecommitdiffstatshomepage
path: root/src/devices/bus/sunmouse/hlemouse.cpp
blob: 3256f171aee0dadedf1bba9ceb6497302017bed0 (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
// license:BSD-3-Clause
// copyright-holders:Vas Crabb
#include "emu.h"
#include "hlemouse.h"

#define LOG_GENERAL (1U << 0)
#define LOG_BIT     (1U << 1)

//#define VERBOSE (LOG_GENERAL | LOG_BIT)
//#define LOG_OUTPUT_STREAM std::cerr

#include "logmacro.h"

#define LOGBIT(...) LOGMASKED(LOG_BIT, __VA_ARGS__)


/*
    Mostly compatible with the Mouse Systems "non-rotatable" protocol.
    The only real difference is that the mouse may send a 3-byte frame
    if the movement in each axis doesn't exceed the range -120 to 127
    counts (values in the range -128 to -121 are indistinguishable from
    button states).
*/


/***************************************************************************
    DEVICE TYPE GLOBALS
***************************************************************************/

DEFINE_DEVICE_TYPE(SUN_1200BAUD_HLE_MOUSE, bus::sunmouse::hle_1200baud_device, "sunmouse_hle1200", "Sun Mouse (1200 Baud, HLE)")
DEFINE_DEVICE_TYPE(SUN_4800BAUD_HLE_MOUSE, bus::sunmouse::hle_4800baud_device, "sunmouse_hle4800", "Sun Mouse (4800 Baud, HLE)")

namespace bus::sunmouse {

namespace {

INPUT_PORTS_START( mouse )
	PORT_START("BTN")
	PORT_BIT( 0xfff8, IP_ACTIVE_HIGH, IPT_UNUSED )
	PORT_BIT( 0x0004, IP_ACTIVE_LOW, IPT_BUTTON1 ) PORT_CODE(MOUSECODE_BUTTON1) PORT_CHANGED_MEMBER(DEVICE_SELF, hle_device_base, input_changed, 0)
	PORT_BIT( 0x0002, IP_ACTIVE_LOW, IPT_BUTTON2 ) PORT_CODE(MOUSECODE_BUTTON3) PORT_CHANGED_MEMBER(DEVICE_SELF, hle_device_base, input_changed, 0)
	PORT_BIT( 0x0001, IP_ACTIVE_LOW, IPT_BUTTON3 ) PORT_CODE(MOUSECODE_BUTTON2) PORT_CHANGED_MEMBER(DEVICE_SELF, hle_device_base, input_changed, 0)

	PORT_START("X")
	PORT_BIT( 0xf000, IP_ACTIVE_HIGH, IPT_UNUSED )
	PORT_BIT( 0x0fff, 0x00, IPT_MOUSE_X ) PORT_SENSITIVITY(100) PORT_KEYDELTA(0) PORT_CHANGED_MEMBER(DEVICE_SELF, hle_device_base, input_changed, 0)

	PORT_START("Y")
	PORT_BIT( 0xf000, IP_ACTIVE_HIGH, IPT_UNUSED )
	PORT_BIT( 0x0fff, 0x00, IPT_MOUSE_Y ) PORT_SENSITIVITY(100) PORT_KEYDELTA(0) PORT_CHANGED_MEMBER(DEVICE_SELF, hle_device_base, input_changed, 0)
INPUT_PORTS_END


uint8_t extract_delta_byte(int32_t &delta)
{
	int32_t const result(std::clamp<int32_t>(delta, -120, 127));
	delta -= result;
	return uint8_t(int8_t(result));
}

} // anonymous namespace



/***************************************************************************
    BASE HLE MOUSE DEVICE
***************************************************************************/

hle_device_base::hle_device_base(
		machine_config const &mconfig,
		device_type type,
		char const *tag,
		device_t *owner,
		uint32_t clock,
		unsigned multiplier)
	: device_t(mconfig, type, tag, owner, clock)
	, device_serial_interface(mconfig, *this)
	, device_sun_mouse_port_interface(mconfig, *this)
	, m_buttons(*this, "BTN")
	, m_x_axis(*this, "X")
	, m_y_axis(*this, "Y")
	, m_multiplier(multiplier)
	, m_x_delta(0)
	, m_y_delta(0)
	, m_x_val(0U)
	, m_y_val(0U)
	, m_btn_sent(0x00U)
	, m_btn_val(0x00U)
	, m_phase(0U)
{
}


hle_device_base::~hle_device_base()
{
}


INPUT_CHANGED_MEMBER( hle_device_base::input_changed )
{
	if (is_transmit_register_empty())
	{
		assert((0U == m_phase) || (3U == m_phase));

		check_inputs();
		if (0U == m_phase)
		{
			if (m_x_delta || m_y_delta || (m_btn_sent != m_btn_val))
			{
				LOG("Inputs changed (B=%X->%x X=%d Y=%d) - sending button state\n",
						m_btn_sent,
						m_btn_val,
						m_x_delta,
						m_y_delta);
				transmit_register_setup((m_btn_sent = m_btn_val) | 0x80U);
			}
		}
		else if (m_x_delta || m_y_delta)
		{
			LOG("Inputs changed (B=%X->%x X=%d Y=%d) - sending X delta\n",
					m_btn_sent,
					m_btn_val,
					m_x_delta,
					m_y_delta);
			transmit_register_setup(extract_delta_byte(m_x_delta));
		}
		else if (m_btn_sent != m_btn_val)
		{
			LOG("Inputs changed (B=%X->%x X=%d Y=%d) - sending button state\n",
					m_btn_sent,
					m_btn_val,
					m_x_delta,
					m_y_delta);
			m_phase = 0U;
			transmit_register_setup((m_btn_sent = m_btn_val) | 0x80U);
		}
	}
	else
	{
		LOG("Ignoring input changed while transmit register not empty\n");
	}
}


ioport_constructor hle_device_base::device_input_ports() const
{
	return INPUT_PORTS_NAME(mouse);
}


void hle_device_base::device_start()
{
	save_item(NAME(m_x_delta));
	save_item(NAME(m_y_delta));
	save_item(NAME(m_x_val));
	save_item(NAME(m_y_val));
	save_item(NAME(m_phase));

	set_data_frame(START_BIT_COUNT, DATA_BIT_COUNT, PARITY, STOP_BITS);
	set_rate(BAUD * m_multiplier);
	receive_register_reset();
	transmit_register_reset();

	output_rxd(0);

	m_x_delta = 0;
	m_y_delta = 0;
	m_btn_sent = 0x00U;
	m_phase = 0U;
}


void hle_device_base::device_reset()
{
	m_x_val = m_x_axis->read();
	m_y_val = m_y_axis->read();
	m_btn_val = m_buttons->read();
}


void hle_device_base::tra_callback()
{
	int const bit(transmit_register_get_data_bit() ? 0 : 1);
	LOGBIT("Send bit !%d\n", bit);
	output_rxd(bit);
}


void hle_device_base::tra_complete()
{
	check_inputs();

	if (4U <= m_phase)
		m_phase = 0U;
	else
		++m_phase;

	switch (m_phase)
	{
	// sent second Y delta - send button state if anything changed
	case 0U:
		if (m_x_delta || m_y_delta || (m_btn_sent != m_btn_val))
		{
			LOG("Sent Y delta (B=%X->%x X=%d Y=%d) - sending button state\n",
					m_btn_sent,
					m_btn_val,
					m_x_delta,
					m_y_delta);
			transmit_register_setup((m_btn_sent = m_btn_val) | 0x80U);
		}
		else
		{
			LOG("Sent Y delta (B=%X->%x X=%d Y=%d) - nothing to send\n",
					m_btn_sent,
					m_btn_val,
					m_x_delta,
					m_y_delta);
		}
		break;

	// can wait after sending first Y delta
	case 3U:
		if (!m_x_delta && !m_y_delta && (m_btn_sent == m_btn_val))
		{
			LOG("Sent Y delta (B=%X->%x X=%d Y=%d) - nothing to send\n",
					m_btn_sent,
					m_btn_val,
					m_x_delta,
					m_y_delta);
			//break; uncommenting this causes problems with early versions of Solaris
		}
		[[fallthrough]];
	case 1U:
		LOG("Sent %s (B=%X->%x X=%d Y=%d) - sending X delta\n",
				(1U == m_phase) ? "button state" : "Y delta",
				m_btn_sent,
				m_btn_val,
				m_x_delta,
				m_y_delta);
		transmit_register_setup(extract_delta_byte(m_x_delta));
		break;

	// sent X delta - always follow with Y delta
	case 2U:
	case 4U:
		LOG("Sent X delta (B=%X->%x X=%d Y=%d) - sending Y delta\n",
				m_btn_sent,
				m_btn_val,
				m_x_delta,
				m_y_delta);
		transmit_register_setup(extract_delta_byte(m_y_delta));
		break;
	}
}


void hle_device_base::check_inputs()
{
	// read new axis values and get difference
	uint16_t const x_val(m_x_axis->read());
	uint16_t const y_val(m_y_axis->read());
	int16_t x_delta(x_val - m_x_val);
	int16_t y_delta(y_val - m_y_val);

	// deal with wraparound
	if (0x0800 <= x_delta)
		x_delta -= 0x1000;
	else if (-0x0800 >= x_delta)
		x_delta += 0x1000;
	if (0x0800 <= y_delta)
		y_delta -= 0x1000;
	else if (-0x0800 >= y_delta)
		x_delta += 0x1000;

	// update state
	m_x_delta += x_delta;
	m_y_delta -= y_delta;
	m_x_val = x_val;
	m_y_val = y_val;

	// read new button values
	m_btn_val = m_buttons->read();
}



/***************************************************************************
    1200 BAUD HLE MOUSE DEVICE
***************************************************************************/

hle_1200baud_device::hle_1200baud_device(
		machine_config const &mconfig,
		char const *tag,
		device_t *owner,
		uint32_t clock)
	: hle_device_base(mconfig, SUN_1200BAUD_HLE_MOUSE, tag, owner, clock, 1U)
{
}



/***************************************************************************
    4800 BAUD HLE MOUSE DEVICE
***************************************************************************/

hle_4800baud_device::hle_4800baud_device(
		machine_config const &mconfig,
		char const *tag,
		device_t *owner,
		uint32_t clock)
	: hle_device_base(mconfig, SUN_4800BAUD_HLE_MOUSE, tag, owner, clock, 4U)
{
}

} // namespace bus::sunmouse