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
|
/*
* SPDX-License-Identifier: GPL-2.0-or-later
*
* Copyright (C) 2021-2022 The DOSBox Staging Team
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#include "program_serial.h"
#include <map>
#include "../hardware/serialport/directserial.h"
#include "../hardware/serialport/serialdummy.h"
#include "../hardware/serialport/softmodem.h"
#include "../hardware/serialport/nullmodem.h"
#include "../hardware/serialport/serialmouse.h"
// Map the serial port type enums to printable names
static std::map<SERIAL_PORT_TYPE, const std::string> serial_type_names = {
{SERIAL_PORT_TYPE::DISABLED, "disabled"},
{SERIAL_PORT_TYPE::DUMMY, "dummy"},
#ifdef C_DIRECTSERIAL
{SERIAL_PORT_TYPE::DIRECT, "direct"},
#endif
#if C_MODEM
{SERIAL_PORT_TYPE::MODEM, "modem"},
{SERIAL_PORT_TYPE::NULL_MODEM, "nullmodem"},
#endif
{SERIAL_PORT_TYPE::MOUSE, "mouse"},
{SERIAL_PORT_TYPE::INVALID, "invalid"},
};
void SERIAL::showPort(int port)
{
if (serialports[port] != nullptr) {
WriteOut(MSG_Get("PROGRAM_SERIAL_SHOW_PORT"), port + 1,
serial_type_names[serialports[port]->serialType].c_str(),
serialports[port]->commandLineString.c_str());
} else {
WriteOut(MSG_Get("PROGRAM_SERIAL_SHOW_PORT"), port + 1,
serial_type_names[SERIAL_PORT_TYPE::DISABLED].c_str(), "");
}
}
void SERIAL::Run()
{
// Show current serial configurations.
if (!cmd->GetCount()) {
for (int x = 0; x < SERIAL_MAX_PORTS; x++)
showPort(x);
return;
}
// Select COM port type.
if (cmd->GetCount() >= 1 && !HelpRequested()) {
// Which COM did they want to change?
if (!cmd->FindCommand(1, temp_line)) {
// Port number not provided or invalid type
WriteOut(MSG_Get("PROGRAM_SERIAL_BAD_PORT"), SERIAL_MAX_PORTS);
return;
}
// A port value was provided, can it be converted to an integer?
int port = -1;
try {
port = stoi(temp_line);
} catch (...) {
}
if (port < 1 || port > SERIAL_MAX_PORTS) {
// Didn't understand the port number.
WriteOut(MSG_Get("PROGRAM_SERIAL_BAD_PORT"), SERIAL_MAX_PORTS);
return;
}
const auto port_index = port - 1;
assert(port_index >= 0 && port_index < SERIAL_MAX_PORTS);
if (cmd->GetCount() == 1) {
showPort(port_index);
return;
}
// Which type of device do they want?
SERIAL_PORT_TYPE desired_type = SERIAL_PORT_TYPE::INVALID;
cmd->FindCommand(2, temp_line);
for (const auto &[type, name] : serial_type_names) {
if (temp_line == name) {
desired_type = type;
break;
}
}
if (desired_type == SERIAL_PORT_TYPE::INVALID) {
// No idea what they asked for.
WriteOut(MSG_Get("PROGRAM_SERIAL_BAD_TYPE"));
for (const auto &type_name : serial_type_names) {
if (type_name.first == SERIAL_PORT_TYPE::DISABLED)
continue; // Don't show the invalid placeholder.
WriteOut(MSG_Get("PROGRAM_SERIAL_INDENTED_LIST"),
type_name.second.c_str());
}
return;
}
// Build command line, if any.
int i = 3;
std::string commandLineString = "";
while (cmd->FindCommand(i++, temp_line)) {
commandLineString.append(temp_line);
commandLineString.append(" ");
}
CommandLine *commandLine = new CommandLine("SERIAL.COM",
commandLineString.c_str());
// Remove existing port.
delete serialports[port_index];
// Recreate the port with the new type.
switch (desired_type) {
case SERIAL_PORT_TYPE::INVALID:
case SERIAL_PORT_TYPE::DISABLED:
serialports[port_index] = nullptr;
break;
case SERIAL_PORT_TYPE::DUMMY:
serialports[port_index] = new CSerialDummy(port_index,
commandLine);
break;
#ifdef C_DIRECTSERIAL
case SERIAL_PORT_TYPE::DIRECT:
serialports[port_index] = new CDirectSerial(port_index,
commandLine);
break;
#endif
#if C_MODEM
case SERIAL_PORT_TYPE::MODEM:
serialports[port_index] = new CSerialModem(port_index,
commandLine);
break;
case SERIAL_PORT_TYPE::NULL_MODEM:
serialports[port_index] = new CNullModem(port_index, commandLine);
break;
#endif
case SERIAL_PORT_TYPE::MOUSE:
serialports[port_index] = new CSerialMouse(port_index,
commandLine);
break;
default:
serialports[port_index] = nullptr;
LOG_WARNING("SERIAL: Unknown serial port type %d", desired_type);
break;
}
if (serialports[port_index] != nullptr) {
serialports[port_index]->serialType = desired_type;
serialports[port_index]->commandLineString = commandLineString;
}
delete commandLine;
showPort(port_index);
return;
}
// Show help.
WriteOut(MSG_Get("PROGRAM_SERIAL_HELP_LONG"), SERIAL_MAX_PORTS);
}
void SERIAL::AddMessages() {
MSG_Add("PROGRAM_SERIAL_HELP_LONG",
"Manages the serial ports.\n"
"\n"
"Usage:\n"
" [color=green]serial[reset] [color=white][PORT#][reset] List all or specified ([color=white]1[reset], [color=white]2[reset], [color=white]3[reset], or [color=white]4[reset]) ports.\n"
" [color=green]serial[reset] [color=white]PORT#[reset] [color=cyan]DEVICE[reset] [settings] Attach specified device to the given port.\n"
"\n"
"Where:\n"
" [color=cyan]DEVICE[reset] One of: [color=cyan]MODEM[reset], [color=cyan]NULLMODEM[reset], [color=cyan]MOUSE[reset], [color=cyan]DIRECT[reset], [color=cyan]DUMMY[reset], or [color=cyan]DISABLED[reset]\n"
"\n"
" Optional settings for each [color=cyan]DEVICE[reset]:\n"
" For [color=cyan]MODEM[reset] : IRQ, LISTENPORT, SOCK\n"
" For [color=cyan]NULLMODEM[reset] : IRQ, SERVER, RXDELAY, TXDELAY, TELNET, USEDTR, TRANSPARENT,\n"
" PORT, INHSOCKET, SOCK\n"
" For [color=cyan]MOUSE[reset] : IRQ, RATE (NORMAL or SMOOTH), TYPE (2BTN, 3BTN, WHEEL, MSM,\n"
" 2BTN+MSM, 3BTN+MSM, or WHEEL+MSM)\n"
" For [color=cyan]DIRECT[reset] : IRQ, REALPORT (required), RXDELAY\n"
" For [color=cyan]DUMMY[reset] : IRQ\n"
"\n"
"Examples:\n"
" [color=green]SERIAL[reset] [color=white]1[reset] [color=cyan]NULLMODEM[reset] PORT:1250 : Listen on TCP:1250 as server\n"
" [color=green]SERIAL[reset] [color=white]2[reset] [color=cyan]NULLMODEM[reset] SERVER:10.0.0.6 PORT:1250 : Connect to TCP:1250 as client\n"
" [color=green]SERIAL[reset] [color=white]3[reset] [color=cyan]MODEM[reset] LISTENPORT:5000 SOCK:1 : Listen on UDP:5000 as server\n"
" [color=green]SERIAL[reset] [color=white]4[reset] [color=cyan]DIRECT[reset] REALPORT:ttyUSB0 : Use a physical port on Linux\n"
" [color=green]SERIAL[reset] [color=white]1[reset] [color=cyan]MOUSE[reset] TYPE:MSM : Mouse Systems mouse\n");
MSG_Add("PROGRAM_SERIAL_SHOW_PORT", "COM%d: %s %s\n");
MSG_Add("PROGRAM_SERIAL_BAD_PORT",
"Must specify a numeric port value between 1 and %d, inclusive.\n");
MSG_Add("PROGRAM_SERIAL_BAD_TYPE", "Type must be one of the following:\n");
MSG_Add("PROGRAM_SERIAL_INDENTED_LIST", " %s\n");
}
|
