+++ /dev/null
-/*\r
- * Serial back end (Windows-specific).\r
- */\r
-\r
-#include <stdio.h>\r
-#include <stdlib.h>\r
-#include <limits.h>\r
-\r
-#include "putty.h"\r
-\r
-#define SERIAL_MAX_BACKLOG 4096\r
-\r
-typedef struct serial_backend_data {\r
- HANDLE port;\r
- struct handle *out, *in;\r
- void *frontend;\r
- int bufsize;\r
- long clearbreak_time;\r
- int break_in_progress;\r
-} *Serial;\r
-\r
-static void serial_terminate(Serial serial)\r
-{\r
- if (serial->out) {\r
- handle_free(serial->out);\r
- serial->out = NULL;\r
- }\r
- if (serial->in) {\r
- handle_free(serial->in);\r
- serial->in = NULL;\r
- }\r
- if (serial->port != INVALID_HANDLE_VALUE) {\r
- if (serial->break_in_progress)\r
- ClearCommBreak(serial->port);\r
- CloseHandle(serial->port);\r
- serial->port = INVALID_HANDLE_VALUE;\r
- }\r
-}\r
-\r
-static int serial_gotdata(struct handle *h, void *data, int len)\r
-{\r
- Serial serial = (Serial)handle_get_privdata(h);\r
- if (len <= 0) {\r
- const char *error_msg;\r
-\r
- /*\r
- * Currently, len==0 should never happen because we're\r
- * ignoring EOFs. However, it seems not totally impossible\r
- * that this same back end might be usable to talk to named\r
- * pipes or some other non-serial device, in which case EOF\r
- * may become meaningful here.\r
- */\r
- if (len == 0)\r
- error_msg = "End of file reading from serial device";\r
- else\r
- error_msg = "Error reading from serial device";\r
-\r
- serial_terminate(serial);\r
-\r
- notify_remote_exit(serial->frontend);\r
-\r
- logevent(serial->frontend, error_msg);\r
-\r
- connection_fatal(serial->frontend, "%s", error_msg);\r
-\r
- return 0; /* placate optimiser */\r
- } else {\r
- return from_backend(serial->frontend, 0, data, len);\r
- }\r
-}\r
-\r
-static void serial_sentdata(struct handle *h, int new_backlog)\r
-{\r
- Serial serial = (Serial)handle_get_privdata(h);\r
- if (new_backlog < 0) {\r
- const char *error_msg = "Error writing to serial device";\r
-\r
- serial_terminate(serial);\r
-\r
- notify_remote_exit(serial->frontend);\r
-\r
- logevent(serial->frontend, error_msg);\r
-\r
- connection_fatal(serial->frontend, "%s", error_msg);\r
- } else {\r
- serial->bufsize = new_backlog;\r
- }\r
-}\r
-\r
-static const char *serial_configure(Serial serial, HANDLE serport, Config *cfg)\r
-{\r
- DCB dcb;\r
- COMMTIMEOUTS timeouts;\r
-\r
- /*\r
- * Set up the serial port parameters. If we can't even\r
- * GetCommState, we ignore the problem on the grounds that the\r
- * user might have pointed us at some other type of two-way\r
- * device instead of a serial port.\r
- */\r
- if (GetCommState(serport, &dcb)) {\r
- char *msg;\r
- const char *str;\r
-\r
- /*\r
- * Boilerplate.\r
- */\r
- dcb.fBinary = TRUE;\r
- dcb.fDtrControl = DTR_CONTROL_ENABLE;\r
- dcb.fDsrSensitivity = FALSE;\r
- dcb.fTXContinueOnXoff = FALSE;\r
- dcb.fOutX = FALSE;\r
- dcb.fInX = FALSE;\r
- dcb.fErrorChar = FALSE;\r
- dcb.fNull = FALSE;\r
- dcb.fRtsControl = RTS_CONTROL_ENABLE;\r
- dcb.fAbortOnError = FALSE;\r
- dcb.fOutxCtsFlow = FALSE;\r
- dcb.fOutxDsrFlow = FALSE;\r
-\r
- /*\r
- * Configurable parameters.\r
- */\r
- dcb.BaudRate = cfg->serspeed;\r
- msg = dupprintf("Configuring baud rate %d", cfg->serspeed);\r
- logevent(serial->frontend, msg);\r
- sfree(msg);\r
-\r
- dcb.ByteSize = cfg->serdatabits;\r
- msg = dupprintf("Configuring %d data bits", cfg->serdatabits);\r
- logevent(serial->frontend, msg);\r
- sfree(msg);\r
-\r
- switch (cfg->serstopbits) {\r
- case 2: dcb.StopBits = ONESTOPBIT; str = "1"; break;\r
- case 3: dcb.StopBits = ONE5STOPBITS; str = "1.5"; break;\r
- case 4: dcb.StopBits = TWOSTOPBITS; str = "2"; break;\r
- default: return "Invalid number of stop bits (need 1, 1.5 or 2)";\r
- }\r
- msg = dupprintf("Configuring %s data bits", str);\r
- logevent(serial->frontend, msg);\r
- sfree(msg);\r
-\r
- switch (cfg->serparity) {\r
- case SER_PAR_NONE: dcb.Parity = NOPARITY; str = "no"; break;\r
- case SER_PAR_ODD: dcb.Parity = ODDPARITY; str = "odd"; break;\r
- case SER_PAR_EVEN: dcb.Parity = EVENPARITY; str = "even"; break;\r
- case SER_PAR_MARK: dcb.Parity = MARKPARITY; str = "mark"; break;\r
- case SER_PAR_SPACE: dcb.Parity = SPACEPARITY; str = "space"; break;\r
- }\r
- msg = dupprintf("Configuring %s parity", str);\r
- logevent(serial->frontend, msg);\r
- sfree(msg);\r
-\r
- switch (cfg->serflow) {\r
- case SER_FLOW_NONE:\r
- str = "no";\r
- break;\r
- case SER_FLOW_XONXOFF:\r
- dcb.fOutX = dcb.fInX = TRUE;\r
- str = "XON/XOFF";\r
- break;\r
- case SER_FLOW_RTSCTS:\r
- dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;\r
- dcb.fOutxCtsFlow = TRUE;\r
- str = "RTS/CTS";\r
- break;\r
- case SER_FLOW_DSRDTR:\r
- dcb.fDtrControl = DTR_CONTROL_HANDSHAKE;\r
- dcb.fOutxDsrFlow = TRUE;\r
- str = "DSR/DTR";\r
- break;\r
- }\r
- msg = dupprintf("Configuring %s flow control", str);\r
- logevent(serial->frontend, msg);\r
- sfree(msg);\r
-\r
- if (!SetCommState(serport, &dcb))\r
- return "Unable to configure serial port";\r
-\r
- timeouts.ReadIntervalTimeout = 1;\r
- timeouts.ReadTotalTimeoutMultiplier = 0;\r
- timeouts.ReadTotalTimeoutConstant = 0;\r
- timeouts.WriteTotalTimeoutMultiplier = 0;\r
- timeouts.WriteTotalTimeoutConstant = 0;\r
- if (!SetCommTimeouts(serport, &timeouts))\r
- return "Unable to configure serial timeouts";\r
- }\r
-\r
- return NULL;\r
-}\r
-\r
-/*\r
- * Called to set up the serial connection.\r
- * \r
- * Returns an error message, or NULL on success.\r
- *\r
- * Also places the canonical host name into `realhost'. It must be\r
- * freed by the caller.\r
- */\r
-static const char *serial_init(void *frontend_handle, void **backend_handle,\r
- Config *cfg,\r
- char *host, int port, char **realhost, int nodelay,\r
- int keepalive)\r
-{\r
- Serial serial;\r
- HANDLE serport;\r
- const char *err;\r
-\r
- serial = snew(struct serial_backend_data);\r
- serial->port = INVALID_HANDLE_VALUE;\r
- serial->out = serial->in = NULL;\r
- serial->bufsize = 0;\r
- serial->break_in_progress = FALSE;\r
- *backend_handle = serial;\r
-\r
- serial->frontend = frontend_handle;\r
-\r
- {\r
- char *msg = dupprintf("Opening serial device %s", cfg->serline);\r
- logevent(serial->frontend, msg);\r
- }\r
-\r
- {\r
- /*\r
- * Munge the string supplied by the user into a Windows filename.\r
- *\r
- * Windows supports opening a few "legacy" devices (including\r
- * COM1-9) by specifying their names verbatim as a filename to\r
- * open. (Thus, no files can ever have these names. See\r
- * <http://msdn2.microsoft.com/en-us/library/aa365247.aspx>\r
- * ("Naming a File") for the complete list of reserved names.)\r
- *\r
- * However, this doesn't let you get at devices COM10 and above.\r
- * For that, you need to specify a filename like "\\.\COM10".\r
- * This is also necessary for special serial and serial-like\r
- * devices such as \\.\WCEUSBSH001. It also works for the "legacy"\r
- * names, so you can do \\.\COM1 (verified as far back as Win95).\r
- * See <http://msdn2.microsoft.com/en-us/library/aa363858.aspx>\r
- * (CreateFile() docs).\r
- *\r
- * So, we believe that prepending "\\.\" should always be the\r
- * Right Thing. However, just in case someone finds something to\r
- * talk to that doesn't exist under there, if the serial line\r
- * contains a backslash, we use it verbatim. (This also lets\r
- * existing configurations using \\.\ continue working.)\r
- */\r
- char *serfilename =\r
- dupprintf("%s%s",\r
- strchr(cfg->serline, '\\') ? "" : "\\\\.\\",\r
- cfg->serline);\r
- serport = CreateFile(serfilename, GENERIC_READ | GENERIC_WRITE, 0, NULL,\r
- OPEN_EXISTING, FILE_FLAG_OVERLAPPED, NULL);\r
- sfree(serfilename);\r
- }\r
-\r
- if (serport == INVALID_HANDLE_VALUE)\r
- return "Unable to open serial port";\r
-\r
- err = serial_configure(serial, serport, cfg);\r
- if (err)\r
- return err;\r
-\r
- serial->port = serport;\r
- serial->out = handle_output_new(serport, serial_sentdata, serial,\r
- HANDLE_FLAG_OVERLAPPED);\r
- serial->in = handle_input_new(serport, serial_gotdata, serial,\r
- HANDLE_FLAG_OVERLAPPED |\r
- HANDLE_FLAG_IGNOREEOF |\r
- HANDLE_FLAG_UNITBUFFER);\r
-\r
- *realhost = dupstr(cfg->serline);\r
-\r
- /*\r
- * Specials are always available.\r
- */\r
- update_specials_menu(serial->frontend);\r
-\r
- return NULL;\r
-}\r
-\r
-static void serial_free(void *handle)\r
-{\r
- Serial serial = (Serial) handle;\r
-\r
- serial_terminate(serial);\r
- expire_timer_context(serial);\r
- sfree(serial);\r
-}\r
-\r
-static void serial_reconfig(void *handle, Config *cfg)\r
-{\r
- Serial serial = (Serial) handle;\r
- const char *err;\r
-\r
- err = serial_configure(serial, serial->port, cfg);\r
-\r
- /*\r
- * FIXME: what should we do if err returns something?\r
- */\r
-}\r
-\r
-/*\r
- * Called to send data down the serial connection.\r
- */\r
-static int serial_send(void *handle, char *buf, int len)\r
-{\r
- Serial serial = (Serial) handle;\r
-\r
- if (serial->out == NULL)\r
- return 0;\r
-\r
- serial->bufsize = handle_write(serial->out, buf, len);\r
- return serial->bufsize;\r
-}\r
-\r
-/*\r
- * Called to query the current sendability status.\r
- */\r
-static int serial_sendbuffer(void *handle)\r
-{\r
- Serial serial = (Serial) handle;\r
- return serial->bufsize;\r
-}\r
-\r
-/*\r
- * Called to set the size of the window\r
- */\r
-static void serial_size(void *handle, int width, int height)\r
-{\r
- /* Do nothing! */\r
- return;\r
-}\r
-\r
-static void serbreak_timer(void *ctx, long now)\r
-{\r
- Serial serial = (Serial)ctx;\r
-\r
- if (now >= serial->clearbreak_time && serial->port) {\r
- ClearCommBreak(serial->port);\r
- serial->break_in_progress = FALSE;\r
- logevent(serial->frontend, "Finished serial break");\r
- }\r
-}\r
-\r
-/*\r
- * Send serial special codes.\r
- */\r
-static void serial_special(void *handle, Telnet_Special code)\r
-{\r
- Serial serial = (Serial) handle;\r
-\r
- if (serial->port && code == TS_BRK) {\r
- logevent(serial->frontend, "Starting serial break at user request");\r
- SetCommBreak(serial->port);\r
- /*\r
- * To send a serial break on Windows, we call SetCommBreak\r
- * to begin the break, then wait a bit, and then call\r
- * ClearCommBreak to finish it. Hence, I must use timing.c\r
- * to arrange a callback when it's time to do the latter.\r
- * \r
- * SUS says that a default break length must be between 1/4\r
- * and 1/2 second. FreeBSD apparently goes with 2/5 second,\r
- * and so will I. \r
- */\r
- serial->clearbreak_time =\r
- schedule_timer(TICKSPERSEC * 2 / 5, serbreak_timer, serial);\r
- serial->break_in_progress = TRUE;\r
- }\r
-\r
- return;\r
-}\r
-\r
-/*\r
- * Return a list of the special codes that make sense in this\r
- * protocol.\r
- */\r
-static const struct telnet_special *serial_get_specials(void *handle)\r
-{\r
- static const struct telnet_special specials[] = {\r
- {"Break", TS_BRK},\r
- {NULL, TS_EXITMENU}\r
- };\r
- return specials;\r
-}\r
-\r
-static int serial_connected(void *handle)\r
-{\r
- return 1; /* always connected */\r
-}\r
-\r
-static int serial_sendok(void *handle)\r
-{\r
- return 1;\r
-}\r
-\r
-static void serial_unthrottle(void *handle, int backlog)\r
-{\r
- Serial serial = (Serial) handle;\r
- if (serial->in)\r
- handle_unthrottle(serial->in, backlog);\r
-}\r
-\r
-static int serial_ldisc(void *handle, int option)\r
-{\r
- /*\r
- * Local editing and local echo are off by default.\r
- */\r
- return 0;\r
-}\r
-\r
-static void serial_provide_ldisc(void *handle, void *ldisc)\r
-{\r
- /* This is a stub. */\r
-}\r
-\r
-static void serial_provide_logctx(void *handle, void *logctx)\r
-{\r
- /* This is a stub. */\r
-}\r
-\r
-static int serial_exitcode(void *handle)\r
-{\r
- Serial serial = (Serial) handle;\r
- if (serial->port != INVALID_HANDLE_VALUE)\r
- return -1; /* still connected */\r
- else\r
- /* Exit codes are a meaningless concept with serial ports */\r
- return INT_MAX;\r
-}\r
-\r
-/*\r
- * cfg_info for Serial does nothing at all.\r
- */\r
-static int serial_cfg_info(void *handle)\r
-{\r
- return 0;\r
-}\r
-\r
-Backend serial_backend = {\r
- serial_init,\r
- serial_free,\r
- serial_reconfig,\r
- serial_send,\r
- serial_sendbuffer,\r
- serial_size,\r
- serial_special,\r
- serial_get_specials,\r
- serial_connected,\r
- serial_exitcode,\r
- serial_sendok,\r
- serial_ldisc,\r
- serial_provide_ldisc,\r
- serial_provide_logctx,\r
- serial_unthrottle,\r
- serial_cfg_info,\r
- "serial",\r
- PROT_SERIAL,\r
- 0\r
-};\r
OSDN Git Service
