summaryrefslogtreecommitdiffstatshomepage
path: root/src/devices/machine/keyboard.h
blob: 42a2d964ad75ca0bc58aa21d1bcde2f7b3dcbeda (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
// license:BSD-3-Clause
// copyright-holders:Vas Crabb
#ifndef MAME_DEVICES_MACHINE_KEYBOARD_H
#define MAME_DEVICES_MACHINE_KEYBOARD_H

#pragma once


/***************************************************************************
    DEVICE CONFIGURATION MACROS
***************************************************************************/

#define MCFG_GENERIC_KEYBOARD_CB(cb) \
		devcb = &generic_keyboard_device::set_keyboard_callback(*device, DEVCB_##cb);



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

extern const device_type GENERIC_KEYBOARD;



/***************************************************************************
    REUSABLE I/O PORTS
***************************************************************************/

INPUT_PORTS_EXTERN( generic_keyboard );



/***************************************************************************
    TYPE DECLARATIONS
***************************************************************************/

template <uint8_t ROW_COUNT>
class device_matrix_keyboard_interface : public device_interface
{
protected:
	template <typename... T>
	device_matrix_keyboard_interface(machine_config const &mconfig, device_t &device, T &&... tags);

	virtual void interface_pre_start() override;
	virtual void interface_post_start() override;
	virtual void device_timer(emu_timer &timer, device_timer_id id, int param, void *ptr);

	void start_processing(const attotime &period);
	void stop_processing();
	void reset_key_state();

	void typematic_start(uint8_t row, uint8_t column, attotime const &delay, attotime const &interval);
	void typematic_restart(attotime const &delay, attotime const &interval);
	void typematic_stop();
	bool typematic_is(uint8_t row, uint8_t column) const { return (m_typematic_row == row) && (m_typematic_column == column); }

	virtual void key_make(uint8_t row, uint8_t column) = 0;
	virtual void key_repeat(uint8_t row, uint8_t column);
	virtual void key_break(uint8_t row, uint8_t column);
	virtual void will_scan_row(uint8_t row);

	bool are_all_keys_up();

private:
	// device_serial_interface uses 10'000 range
	enum {
		TIMER_ID_SCAN = 20'000,
		TIMER_ID_TYPEMATIC
	};

	void scan_row();

	emu_timer       *m_scan_timer;
	emu_timer       *m_typematic_timer;
	required_ioport m_key_rows[ROW_COUNT];
	ioport_value    m_key_states[ROW_COUNT];
	uint8_t           m_next_row;
	uint8_t           m_processing;
	uint8_t           m_typematic_row;
	uint8_t           m_typematic_column;
};


class generic_keyboard_device : public device_t, protected device_matrix_keyboard_interface<4U>
{
public:
	generic_keyboard_device(
			const machine_config &mconfig,
			device_type type,
			char const *name,
			char const *tag,
			device_t *owner,
			uint32_t clock,
			char const *shortname,
			char const *source);
	generic_keyboard_device(
			const machine_config &mconfig,
			const char *tag,
			device_t *owner,
			uint32_t clock);

	template <class Object> static devcb_base &set_keyboard_callback(device_t &device, Object object) { return downcast<generic_keyboard_device &>(device).m_keyboard_cb.set_callback(object); }

	virtual ioport_constructor device_input_ports() const override;

protected:
	virtual void device_start() override;
	virtual void device_reset() override;
	virtual void device_timer(emu_timer &timer, device_timer_id id, int param, void *ptr) override;
	virtual void key_make(uint8_t row, uint8_t column) override;
	virtual void key_repeat(uint8_t row, uint8_t column) override;
	virtual void send_key(uint8_t code);
	virtual bool translate(uint8_t code, uint8_t &translated) const;

	required_ioport m_config;
	required_ioport m_modifiers;

private:
	virtual void will_scan_row(uint8_t row) override;

	void typematic();
	void send_translated(uint8_t code);
	attotime typematic_delay() const;
	attotime typematic_period() const;

	uint16_t          m_last_modifiers;
	devcb_write8    m_keyboard_cb;
};

#endif // MAME_DEVICES_MACHINE_KEYBOARD_H