1 /* Main file for COMM support
3 * DEC 93 Erik Bos <erik@xs4all.nl>
4 * Copyright 1996 Marcus Meissner
5 * Copyright 2005,2006 Eric Pouech
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
23 #include "wine/port.h"
43 #ifdef HAVE_SYS_STAT_H
44 # include <sys/stat.h>
46 #include <sys/types.h>
47 #ifdef HAVE_SYS_FILIO_H
48 # include <sys/filio.h>
50 #ifdef HAVE_SYS_IOCTL_H
51 #include <sys/ioctl.h>
53 #ifdef HAVE_SYS_POLL_H
54 # include <sys/poll.h>
56 #ifdef HAVE_SYS_MODEM_H
57 # include <sys/modem.h>
59 #ifdef HAVE_SYS_STRTIO_H
60 # include <sys/strtio.h>
63 #define NONAMELESSUNION
64 #define NONAMELESSSTRUCT
66 #define WIN32_NO_STATUS
70 #include "ddk/ntddser.h"
71 #include "ntdll_misc.h"
72 #include "wine/server.h"
73 #include "wine/library.h"
74 #include "wine/debug.h"
76 #ifdef HAVE_LINUX_SERIAL_H
77 #ifdef HAVE_ASM_TYPES_H
78 #include <asm/types.h>
80 #include <linux/serial.h>
83 #if !defined(TIOCINQ) && defined(FIONREAD)
84 #define TIOCINQ FIONREAD
87 WINE_DEFAULT_DEBUG_CHANNEL(comm);
89 static const char* iocode2str(DWORD ioc)
93 #define X(x) case (x): return #x
94 X(IOCTL_SERIAL_CLEAR_STATS);
95 X(IOCTL_SERIAL_CLR_DTR);
96 X(IOCTL_SERIAL_CLR_RTS);
97 X(IOCTL_SERIAL_CONFIG_SIZE);
98 X(IOCTL_SERIAL_GET_BAUD_RATE);
99 X(IOCTL_SERIAL_GET_CHARS);
100 X(IOCTL_SERIAL_GET_COMMSTATUS);
101 X(IOCTL_SERIAL_GET_DTRRTS);
102 X(IOCTL_SERIAL_GET_HANDFLOW);
103 X(IOCTL_SERIAL_GET_LINE_CONTROL);
104 X(IOCTL_SERIAL_GET_MODEM_CONTROL);
105 X(IOCTL_SERIAL_GET_MODEMSTATUS);
106 X(IOCTL_SERIAL_GET_PROPERTIES);
107 X(IOCTL_SERIAL_GET_STATS);
108 X(IOCTL_SERIAL_GET_TIMEOUTS);
109 X(IOCTL_SERIAL_GET_WAIT_MASK);
110 X(IOCTL_SERIAL_IMMEDIATE_CHAR);
111 X(IOCTL_SERIAL_LSRMST_INSERT);
112 X(IOCTL_SERIAL_PURGE);
113 X(IOCTL_SERIAL_RESET_DEVICE);
114 X(IOCTL_SERIAL_SET_BAUD_RATE);
115 X(IOCTL_SERIAL_SET_BREAK_ON);
116 X(IOCTL_SERIAL_SET_BREAK_OFF);
117 X(IOCTL_SERIAL_SET_CHARS);
118 X(IOCTL_SERIAL_SET_DTR);
119 X(IOCTL_SERIAL_SET_FIFO_CONTROL);
120 X(IOCTL_SERIAL_SET_HANDFLOW);
121 X(IOCTL_SERIAL_SET_LINE_CONTROL);
122 X(IOCTL_SERIAL_SET_MODEM_CONTROL);
123 X(IOCTL_SERIAL_SET_QUEUE_SIZE);
124 X(IOCTL_SERIAL_SET_RTS);
125 X(IOCTL_SERIAL_SET_TIMEOUTS);
126 X(IOCTL_SERIAL_SET_WAIT_MASK);
127 X(IOCTL_SERIAL_SET_XOFF);
128 X(IOCTL_SERIAL_SET_XON);
129 X(IOCTL_SERIAL_WAIT_ON_MASK);
130 X(IOCTL_SERIAL_XOFF_COUNTER);
132 default: { static char tmp[32]; sprintf(tmp, "IOCTL_SERIAL_%d\n", ioc); return tmp; }
136 static NTSTATUS get_baud_rate(int fd, SERIAL_BAUD_RATE* sbr)
141 if (tcgetattr(fd, &port) == -1)
143 ERR("tcgetattr error '%s'\n", strerror(errno));
144 return FILE_GetNtStatus();
148 speed = port.c_cflag & CBAUD;
150 speed = cfgetospeed(&port);
154 case B0: sbr->BaudRate = 0; break;
155 case B50: sbr->BaudRate = 50; break;
156 case B75: sbr->BaudRate = 75; break;
157 case B110: sbr->BaudRate = 110; break;
158 case B134: sbr->BaudRate = 134; break;
159 case B150: sbr->BaudRate = 150; break;
160 case B200: sbr->BaudRate = 200; break;
161 case B300: sbr->BaudRate = 300; break;
162 case B600: sbr->BaudRate = 600; break;
163 case B1200: sbr->BaudRate = 1200; break;
164 case B1800: sbr->BaudRate = 1800; break;
165 case B2400: sbr->BaudRate = 2400; break;
166 case B4800: sbr->BaudRate = 4800; break;
167 case B9600: sbr->BaudRate = 9600; break;
168 case B19200: sbr->BaudRate = 19200; break;
169 case B38400: sbr->BaudRate = 38400; break;
171 case B57600: sbr->BaudRate = 57600; break;
174 case B115200: sbr->BaudRate = 115200; break;
177 case B230400: sbr->BaudRate = 230400; break;
180 case B460800: sbr->BaudRate = 460800; break;
183 ERR("unknown speed %x\n", speed);
184 return STATUS_INVALID_PARAMETER;
187 return STATUS_INVALID_PARAMETER;
189 return STATUS_SUCCESS;
192 static NTSTATUS get_hand_flow(int fd, SERIAL_HANDFLOW* shf)
197 if (tcgetattr(fd, &port) == -1)
199 ERR("tcgetattr error '%s'\n", strerror(errno));
200 return FILE_GetNtStatus();
202 /* termios does not support DTR/DSR flow control */
203 shf->ControlHandShake = 0;
204 shf->FlowReplace = 0;
206 if (ioctl(fd, TIOCMGET, &stat) == -1)
208 WARN("ioctl error '%s'\n", strerror(errno));
209 shf->ControlHandShake |= SERIAL_DTR_CONTROL;
210 shf->FlowReplace |= SERIAL_RTS_CONTROL;
213 WARN("Setting DTR/RTS to enabled by default\n");
214 shf->ControlHandShake |= SERIAL_DTR_CONTROL;
215 shf->FlowReplace |= SERIAL_RTS_CONTROL;
218 if (stat & TIOCM_DTR)
220 shf->ControlHandShake |= SERIAL_DTR_CONTROL;
222 if (port.c_cflag & CRTSCTS)
224 shf->FlowReplace |= SERIAL_RTS_CONTROL;
225 shf->ControlHandShake |= SERIAL_CTS_HANDSHAKE;
231 if (stat & TIOCM_RTS)
233 shf->FlowReplace |= SERIAL_RTS_CONTROL;
235 if (port.c_iflag & IXOFF)
236 shf->FlowReplace |= SERIAL_AUTO_RECEIVE;
237 if (port.c_iflag & IXON)
238 shf->FlowReplace |= SERIAL_AUTO_TRANSMIT;
242 return STATUS_SUCCESS;
245 static NTSTATUS get_line_control(int fd, SERIAL_LINE_CONTROL* slc)
249 if (tcgetattr(fd, &port) == -1)
251 ERR("tcgetattr error '%s'\n", strerror(errno));
252 return FILE_GetNtStatus();
256 switch (port.c_cflag & (PARENB | PARODD | CMSPAR))
258 switch (port.c_cflag & (PARENB | PARODD))
261 case 0: slc->Parity = NOPARITY; break;
262 case PARENB: slc->Parity = EVENPARITY; break;
263 case PARENB|PARODD: slc->Parity = ODDPARITY; break;
265 case PARENB|CMSPAR: slc->Parity = MARKPARITY; break;
266 case PARENB|PARODD|CMSPAR: slc->Parity = SPACEPARITY; break;
269 switch (port.c_cflag & CSIZE)
271 case CS5: slc->WordLength = 5; break;
272 case CS6: slc->WordLength = 6; break;
273 case CS7: slc->WordLength = 7; break;
274 case CS8: slc->WordLength = 8; break;
275 default: ERR("unknown size %x\n", (UINT)(port.c_cflag & CSIZE));
278 if (port.c_cflag & CSTOPB)
280 if (slc->WordLength == 5)
281 slc->StopBits = ONE5STOPBITS;
283 slc->StopBits = TWOSTOPBITS;
286 slc->StopBits = ONESTOPBIT;
288 return STATUS_SUCCESS;
291 static NTSTATUS get_modem_status(int fd, DWORD* lpModemStat)
293 NTSTATUS status = STATUS_NOT_SUPPORTED;
298 if (!ioctl(fd, TIOCMGET, &mstat))
301 if (mstat & TIOCM_CTS) *lpModemStat |= MS_CTS_ON;
304 if (mstat & TIOCM_DSR) *lpModemStat |= MS_DSR_ON;
307 if (mstat & TIOCM_RNG) *lpModemStat |= MS_RING_ON;
310 /* FIXME: Not really sure about RLSD UB 990810 */
311 if (mstat & TIOCM_CAR) *lpModemStat |= MS_RLSD_ON;
313 TRACE("%04x -> %s%s%s%s\n", mstat,
314 (*lpModemStat & MS_RLSD_ON) ? "MS_RLSD_ON " : "",
315 (*lpModemStat & MS_RING_ON) ? "MS_RING_ON " : "",
316 (*lpModemStat & MS_DSR_ON) ? "MS_DSR_ON " : "",
317 (*lpModemStat & MS_CTS_ON) ? "MS_CTS_ON " : "");
318 return STATUS_SUCCESS;
320 WARN("ioctl failed\n");
321 status = FILE_GetNtStatus();
326 static NTSTATUS get_special_chars(int fd, SERIAL_CHARS* sc)
330 if (tcgetattr(fd, &port) == -1)
332 ERR("tcgetattr error '%s'\n", strerror(errno));
333 return FILE_GetNtStatus();
335 sc->EofChar = port.c_cc[VEOF];
336 sc->ErrorChar = 0xFF;
337 sc->BreakChar = 0; /* FIXME */
338 sc->EventChar = 0; /* FIXME */
339 sc->XonChar = port.c_cc[VSTART];
340 sc->XoffChar = port.c_cc[VSTOP];
342 return STATUS_SUCCESS;
345 static NTSTATUS get_status(int fd, SERIAL_STATUS* ss)
347 NTSTATUS status = STATUS_SUCCESS;
351 ss->EofReceived = FALSE;
352 ss->WaitForImmediate = FALSE;
354 if (ioctl(fd, TIOCOUTQ, &ss->AmountInOutQueue) == -1)
356 WARN("ioctl returned error\n");
357 status = FILE_GetNtStatus();
360 ss->AmountInOutQueue = 0; /* FIXME: find a different way to find out */
364 if (ioctl(fd, TIOCINQ, &ss->AmountInInQueue))
366 WARN("ioctl returned error\n");
367 status = FILE_GetNtStatus();
370 ss->AmountInInQueue = 0; /* FIXME: find a different way to find out */
375 static NTSTATUS get_timeouts(HANDLE handle, SERIAL_TIMEOUTS* st)
378 SERVER_START_REQ( get_serial_info )
380 req->handle = wine_server_obj_handle( handle );
381 if (!(status = wine_server_call( req )))
383 st->ReadIntervalTimeout = reply->readinterval;
384 st->ReadTotalTimeoutMultiplier = reply->readmult;
385 st->ReadTotalTimeoutConstant = reply->readconst;
386 st->WriteTotalTimeoutMultiplier = reply->writemult;
387 st->WriteTotalTimeoutConstant = reply->writeconst;
394 static NTSTATUS get_wait_mask(HANDLE hDevice, DWORD* mask)
398 SERVER_START_REQ( get_serial_info )
400 req->handle = wine_server_obj_handle( hDevice );
401 if (!(status = wine_server_call( req )))
402 *mask = reply->eventmask;
408 static NTSTATUS purge(int fd, DWORD flags)
411 ** not exactly sure how these are different
412 ** Perhaps if we had our own internal queues, one flushes them
413 ** and the other flushes the kernel's buffers.
415 if (flags & PURGE_TXABORT) tcflush(fd, TCOFLUSH);
416 if (flags & PURGE_RXABORT) tcflush(fd, TCIFLUSH);
417 if (flags & PURGE_TXCLEAR) tcflush(fd, TCOFLUSH);
418 if (flags & PURGE_RXCLEAR) tcflush(fd, TCIFLUSH);
419 return STATUS_SUCCESS;
422 static NTSTATUS set_baud_rate(int fd, const SERIAL_BAUD_RATE* sbr)
426 if (tcgetattr(fd, &port) == -1)
428 ERR("tcgetattr error '%s'\n", strerror(errno));
429 return FILE_GetNtStatus();
433 port.c_cflag &= ~CBAUD;
434 switch (sbr->BaudRate)
436 case 0: port.c_cflag |= B0; break;
437 case 50: port.c_cflag |= B50; break;
438 case 75: port.c_cflag |= B75; break;
440 case CBR_110: port.c_cflag |= B110; break;
441 case 134: port.c_cflag |= B134; break;
442 case 150: port.c_cflag |= B150; break;
443 case 200: port.c_cflag |= B200; break;
445 case CBR_300: port.c_cflag |= B300; break;
447 case CBR_600: port.c_cflag |= B600; break;
449 case CBR_1200: port.c_cflag |= B1200; break;
450 case 1800: port.c_cflag |= B1800; break;
452 case CBR_2400: port.c_cflag |= B2400; break;
454 case CBR_4800: port.c_cflag |= B4800; break;
456 case CBR_9600: port.c_cflag |= B9600; break;
458 case CBR_19200: port.c_cflag |= B19200; break;
460 case CBR_38400: port.c_cflag |= B38400; break;
462 case 57600: port.c_cflag |= B57600; break;
465 case 115200: port.c_cflag |= B115200;break;
468 case 230400: port.c_cflag |= B230400;break;
471 case 460800: port.c_cflag |= B460800;break;
474 #if defined (HAVE_LINUX_SERIAL_H) && defined (TIOCSSERIAL)
476 struct serial_struct nuts;
479 ioctl(fd, TIOCGSERIAL, &nuts);
480 nuts.custom_divisor = nuts.baud_base / sbr->BaudRate;
481 if (!(nuts.custom_divisor)) nuts.custom_divisor = 1;
482 arby = nuts.baud_base / nuts.custom_divisor;
483 nuts.flags &= ~ASYNC_SPD_MASK;
484 nuts.flags |= ASYNC_SPD_CUST;
485 WARN("You (or a program acting at your behest) have specified\n"
486 "a non-standard baud rate %d. Wine will set the rate to %d,\n"
487 "which is as close as we can get by our present understanding of your\n"
488 "hardware. I hope you know what you are doing. Any disruption Wine\n"
489 "has caused to your linux system can be undone with setserial\n"
490 "(see man setserial). If you have incapacitated a Hayes type modem,\n"
491 "reset it and it will probably recover.\n", sbr->BaudRate, arby);
492 ioctl(fd, TIOCSSERIAL, &nuts);
493 port.c_cflag |= B38400;
496 #else /* Don't have linux/serial.h or lack TIOCSSERIAL */
497 ERR("baudrate %d\n", sbr->BaudRate);
498 return STATUS_NOT_SUPPORTED;
499 #endif /* Don't have linux/serial.h or lack TIOCSSERIAL */
501 #elif !defined(__EMX__)
502 switch (sbr->BaudRate)
504 case 0: port.c_ospeed = B0; break;
505 case 50: port.c_ospeed = B50; break;
506 case 75: port.c_ospeed = B75; break;
508 case CBR_110: port.c_ospeed = B110; break;
509 case 134: port.c_ospeed = B134; break;
510 case 150: port.c_ospeed = B150; break;
511 case 200: port.c_ospeed = B200; break;
513 case CBR_300: port.c_ospeed = B300; break;
515 case CBR_600: port.c_ospeed = B600; break;
517 case CBR_1200: port.c_ospeed = B1200; break;
518 case 1800: port.c_ospeed = B1800; break;
520 case CBR_2400: port.c_ospeed = B2400; break;
522 case CBR_4800: port.c_ospeed = B4800; break;
524 case CBR_9600: port.c_ospeed = B9600; break;
526 case CBR_19200: port.c_ospeed = B19200; break;
528 case CBR_38400: port.c_ospeed = B38400; break;
531 case CBR_57600: port.c_cflag |= B57600; break;
535 case CBR_115200: port.c_cflag |= B115200;break;
538 case 230400: port.c_cflag |= B230400;break;
541 case 460800: port.c_cflag |= B460800;break;
544 ERR("baudrate %d\n", sbr->BaudRate);
545 return STATUS_NOT_SUPPORTED;
547 port.c_ispeed = port.c_ospeed;
549 if (tcsetattr(fd, TCSANOW, &port) == -1)
551 ERR("tcsetattr error '%s'\n", strerror(errno));
552 return FILE_GetNtStatus();
554 return STATUS_SUCCESS;
557 static int whack_modem(int fd, unsigned int andy, unsigned int orrie)
560 unsigned int mstat, okay;
561 okay = ioctl(fd, TIOCMGET, &mstat);
562 if (okay) return okay;
563 if (andy) mstat &= andy;
565 return ioctl(fd, TIOCMSET, &mstat);
571 static NTSTATUS set_handflow(int fd, const SERIAL_HANDFLOW* shf)
575 if ((shf->FlowReplace & (SERIAL_RTS_CONTROL | SERIAL_RTS_HANDSHAKE)) ==
576 (SERIAL_RTS_CONTROL | SERIAL_RTS_HANDSHAKE))
577 return STATUS_NOT_SUPPORTED;
579 if (tcgetattr(fd, &port) == -1)
581 ERR("tcgetattr error '%s'\n", strerror(errno));
582 return FILE_GetNtStatus();
586 if ((shf->ControlHandShake & SERIAL_CTS_HANDSHAKE) ||
587 (shf->FlowReplace & SERIAL_RTS_HANDSHAKE))
589 port.c_cflag |= CRTSCTS;
593 port.c_cflag &= ~CRTSCTS;
596 if (shf->ControlHandShake & SERIAL_DTR_HANDSHAKE)
598 WARN("DSR/DTR flow control not supported\n");
599 } else if (!(shf->ControlHandShake & SERIAL_DTR_CONTROL))
600 whack_modem(fd, ~TIOCM_DTR, 0);
602 whack_modem(fd, 0, TIOCM_DTR);
605 if (!(shf->ControlHandShake & SERIAL_CTS_HANDSHAKE))
607 if ((shf->FlowReplace & (SERIAL_RTS_CONTROL|SERIAL_RTS_HANDSHAKE)) == 0)
608 whack_modem(fd, ~TIOCM_RTS, 0);
610 whack_modem(fd, 0, TIOCM_RTS);
614 if (shf->FlowReplace & SERIAL_AUTO_RECEIVE)
615 port.c_iflag |= IXOFF;
617 port.c_iflag &= ~IXOFF;
618 if (shf->FlowReplace & SERIAL_AUTO_TRANSMIT)
619 port.c_iflag |= IXON;
621 port.c_iflag &= ~IXON;
622 if (tcsetattr(fd, TCSANOW, &port) == -1)
624 ERR("tcsetattr error '%s'\n", strerror(errno));
625 return FILE_GetNtStatus();
628 return STATUS_SUCCESS;
631 static NTSTATUS set_line_control(int fd, const SERIAL_LINE_CONTROL* slc)
634 unsigned bytesize, stopbits;
636 if (tcgetattr(fd, &port) == -1)
638 ERR("tcgetattr error '%s'\n", strerror(errno));
639 return FILE_GetNtStatus();
643 port.c_iflag &= ~(ISTRIP|BRKINT|IGNCR|ICRNL|INLCR|PARMRK|IMAXBEL);
645 port.c_iflag &= ~(ISTRIP|BRKINT|IGNCR|ICRNL|INLCR|PARMRK);
647 port.c_iflag |= IGNBRK | INPCK;
649 port.c_oflag &= ~(OPOST);
651 port.c_cflag &= ~(HUPCL);
652 port.c_cflag |= CLOCAL | CREAD;
655 * on FreeBSD, turning off ICANON does not disable IEXTEN,
656 * so we must turn it off explicitly. No harm done on Linux.
658 port.c_lflag &= ~(ICANON|ECHO|ISIG|IEXTEN);
659 port.c_lflag |= NOFLSH;
661 bytesize = slc->WordLength;
662 stopbits = slc->StopBits;
665 port.c_cflag &= ~(PARENB | PARODD | CMSPAR);
667 port.c_cflag &= ~(PARENB | PARODD);
670 /* make sure that reads don't block */
672 port.c_cc[VTIME] = 0;
676 case NOPARITY: port.c_iflag &= ~INPCK; break;
677 case ODDPARITY: port.c_cflag |= PARENB | PARODD; break;
678 case EVENPARITY: port.c_cflag |= PARENB; break;
680 /* Linux defines mark/space (stick) parity */
681 case MARKPARITY: port.c_cflag |= PARENB | CMSPAR; break;
682 case SPACEPARITY: port.c_cflag |= PARENB | PARODD | CMSPAR; break;
684 /* try the POSIX way */
686 if (slc->StopBits == ONESTOPBIT)
688 stopbits = TWOSTOPBITS;
689 port.c_iflag &= ~INPCK;
693 ERR("Cannot set MARK Parity\n");
694 return STATUS_NOT_SUPPORTED;
698 if (slc->WordLength < 8)
701 port.c_iflag &= ~INPCK;
705 ERR("Cannot set SPACE Parity\n");
706 return STATUS_NOT_SUPPORTED;
712 return STATUS_NOT_SUPPORTED;
715 port.c_cflag &= ~CSIZE;
718 case 5: port.c_cflag |= CS5; break;
719 case 6: port.c_cflag |= CS6; break;
720 case 7: port.c_cflag |= CS7; break;
721 case 8: port.c_cflag |= CS8; break;
724 return STATUS_NOT_SUPPORTED;
729 case ONESTOPBIT: port.c_cflag &= ~CSTOPB; break;
730 case ONE5STOPBITS: /* will be selected if bytesize is 5 */
731 case TWOSTOPBITS: port.c_cflag |= CSTOPB; break;
734 return STATUS_NOT_SUPPORTED;
736 /* otherwise it hangs with pending input*/
737 if (tcsetattr(fd, TCSANOW, &port) == -1)
739 ERR("tcsetattr error '%s'\n", strerror(errno));
740 return FILE_GetNtStatus();
742 return STATUS_SUCCESS;
745 static NTSTATUS set_queue_size(int fd, const SERIAL_QUEUE_SIZE* sqs)
747 FIXME("insize %d outsize %d unimplemented stub\n", sqs->InSize, sqs->OutSize);
748 return STATUS_SUCCESS;
751 static NTSTATUS set_special_chars(int fd, const SERIAL_CHARS* sc)
755 if (tcgetattr(fd, &port) == -1)
757 ERR("tcgetattr error '%s'\n", strerror(errno));
758 return FILE_GetNtStatus();
761 port.c_cc[VEOF ] = sc->EofChar;
762 /* FIXME: sc->ErrorChar is not supported */
763 /* FIXME: sc->BreakChar is not supported */
764 /* FIXME: sc->EventChar is not supported */
765 port.c_cc[VSTART] = sc->XonChar;
766 port.c_cc[VSTOP ] = sc->XoffChar;
768 if (tcsetattr(fd, TCSANOW, &port) == -1)
770 ERR("tcsetattr error '%s'\n", strerror(errno));
771 return FILE_GetNtStatus();
773 return STATUS_SUCCESS;
776 static NTSTATUS set_timeouts(HANDLE handle, const SERIAL_TIMEOUTS* st)
780 SERVER_START_REQ( set_serial_info )
782 req->handle = wine_server_obj_handle( handle );
783 req->flags = SERIALINFO_SET_TIMEOUTS;
784 req->readinterval = st->ReadIntervalTimeout ;
785 req->readmult = st->ReadTotalTimeoutMultiplier ;
786 req->readconst = st->ReadTotalTimeoutConstant ;
787 req->writemult = st->WriteTotalTimeoutMultiplier ;
788 req->writeconst = st->WriteTotalTimeoutConstant ;
789 status = wine_server_call( req );
795 static NTSTATUS set_wait_mask(HANDLE hDevice, DWORD mask)
799 SERVER_START_REQ( set_serial_info )
801 req->handle = wine_server_obj_handle( hDevice );
802 req->flags = SERIALINFO_SET_MASK;
803 req->eventmask = mask;
804 status = wine_server_call( req );
811 * does not change IXOFF but simulates that IXOFF has been received:
813 static NTSTATUS set_XOff(int fd)
815 if (tcflow(fd, TCOOFF))
817 return FILE_GetNtStatus();
819 return STATUS_SUCCESS;
823 * does not change IXON but simulates that IXON has been received:
825 static NTSTATUS set_XOn(int fd)
827 if (tcflow(fd, TCOON))
829 return FILE_GetNtStatus();
831 return STATUS_SUCCESS;
835 * local structure holding the irq values we need for WaitCommEvent()
837 * Stripped down from struct serial_icounter_struct, which may not be available on some systems
838 * As the modem line interrupts (cts, dsr, rng, dcd) only get updated with TIOCMIWAIT active,
839 * no need to carry them in the internal structure
842 typedef struct serial_irq_info
844 int rx , tx, frame, overrun, parity, brk, buf_overrun;
847 /***********************************************************************
848 * Data needed by the thread polling for the changing CommEvent
850 typedef struct async_commio
854 IO_STATUS_BLOCK* iosb;
858 serial_irq_info irq_info;
861 /***********************************************************************
862 * Get extended interrupt count info, needed for wait_on
864 static NTSTATUS get_irq_info(int fd, serial_irq_info *irq_info)
866 NTSTATUS status = STATUS_NOT_IMPLEMENTED;
868 struct serial_icounter_struct einfo;
869 if (!ioctl(fd, TIOCGICOUNT, &einfo))
871 irq_info->rx = einfo.rx;
872 irq_info->tx = einfo.tx;
873 irq_info->frame = einfo.frame;
874 irq_info->overrun = einfo.overrun;
875 irq_info->parity = einfo.parity;
876 irq_info->brk = einfo.brk;
877 irq_info->buf_overrun = einfo.buf_overrun;
878 return STATUS_SUCCESS;
880 TRACE("TIOCGICOUNT err %s\n", strerror(errno));
881 status = FILE_GetNtStatus();
883 memset(irq_info,0, sizeof(serial_irq_info));
888 static DWORD check_events(int fd, DWORD mask,
889 const serial_irq_info *new,
890 const serial_irq_info *old,
891 DWORD new_mstat, DWORD old_mstat)
893 DWORD ret = 0, queue;
895 TRACE("mask 0x%08x\n", mask);
896 TRACE("old->rx 0x%08x vs. new->rx 0x%08x\n", old->rx, new->rx);
897 TRACE("old->tx 0x%08x vs. new->tx 0x%08x\n", old->tx, new->tx);
898 TRACE("old->frame 0x%08x vs. new->frame 0x%08x\n", old->frame, new->frame);
899 TRACE("old->overrun 0x%08x vs. new->overrun 0x%08x\n", old->overrun, new->overrun);
900 TRACE("old->parity 0x%08x vs. new->parity 0x%08x\n", old->parity, new->parity);
901 TRACE("old->brk 0x%08x vs. new->brk 0x%08x\n", old->brk, new->brk);
902 TRACE("old->buf_overrun 0x%08x vs. new->buf_overrun 0x%08x\n", old->buf_overrun, new->buf_overrun);
904 if (old->brk != new->brk) ret |= EV_BREAK;
905 if ((old_mstat & MS_CTS_ON ) != (new_mstat & MS_CTS_ON )) ret |= EV_CTS;
906 if ((old_mstat & MS_DSR_ON ) != (new_mstat & MS_DSR_ON )) ret |= EV_DSR;
907 if ((old_mstat & MS_RING_ON) != (new_mstat & MS_RING_ON)) ret |= EV_RING;
908 if ((old_mstat & MS_RLSD_ON) != (new_mstat & MS_RLSD_ON)) ret |= EV_RLSD;
909 if (old->frame != new->frame || old->overrun != new->overrun || old->parity != new->parity) ret |= EV_ERR;
910 if (mask & EV_RXCHAR)
914 if (ioctl(fd, TIOCINQ, &queue))
915 WARN("TIOCINQ returned error\n");
920 if (mask & EV_TXEMPTY)
923 /* We really want to know when all characters have gone out of the transmitter */
924 #if defined(TIOCSERGETLSR)
925 if (ioctl(fd, TIOCSERGETLSR, &queue))
926 WARN("TIOCSERGETLSR returned error\n");
928 /* TIOCOUTQ only checks for an empty buffer */
929 #elif defined(TIOCOUTQ)
930 if (ioctl(fd, TIOCOUTQ, &queue))
931 WARN("TIOCOUTQ returned error\n");
935 TRACE("OUTQUEUE %d, Transmitter %sempty\n",
936 queue, (ret & EV_TXEMPTY) ? "" : "not ");
941 /***********************************************************************
942 * wait_for_event (INTERNAL)
944 * We need to poll for what is interesting
945 * TIOCMIWAIT only checks modem status line and may not be aborted by a changing mask
948 static DWORD CALLBACK wait_for_event(LPVOID arg)
950 async_commio *commio = arg;
953 if (!server_get_unix_fd( commio->hDevice, FILE_READ_DATA | FILE_WRITE_DATA, &fd, &needs_close, NULL, NULL ))
955 serial_irq_info new_irq_info;
956 DWORD new_mstat, new_evtmask;
959 TRACE("device=%p fd=0x%08x mask=0x%08x buffer=%p event=%p irq_info=%p\n",
960 commio->hDevice, fd, commio->evtmask, commio->events, commio->hEvent, &commio->irq_info);
962 time.QuadPart = (ULONGLONG)10000;
963 time.QuadPart = -time.QuadPart;
967 * TIOCMIWAIT is not adequate
970 * We don't handle the EV_RXFLAG (the eventchar)
972 NtDelayExecution(FALSE, &time);
973 get_irq_info(fd, &new_irq_info);
974 if (get_modem_status(fd, &new_mstat))
975 TRACE("get_modem_status failed\n");
976 *commio->events = check_events(fd, commio->evtmask,
977 &new_irq_info, &commio->irq_info,
978 new_mstat, commio->mstat);
979 if (*commio->events) break;
980 get_wait_mask(commio->hDevice, &new_evtmask);
981 if (commio->evtmask != new_evtmask)
987 if (needs_close) close( fd );
989 if (commio->iosb) commio->iosb->u.Status = *commio->events ? STATUS_SUCCESS : STATUS_CANCELLED;
990 if (commio->hEvent) NtSetEvent(commio->hEvent, NULL);
991 RtlFreeHeap(GetProcessHeap(), 0, commio);
995 static NTSTATUS wait_on(HANDLE hDevice, int fd, HANDLE hEvent, PIO_STATUS_BLOCK piosb, DWORD* events)
997 async_commio* commio;
1000 if ((status = NtResetEvent(hEvent, NULL)))
1003 commio = RtlAllocateHeap(GetProcessHeap(), 0, sizeof (async_commio));
1004 if (!commio) return STATUS_NO_MEMORY;
1006 commio->hDevice = hDevice;
1007 commio->events = events;
1008 commio->iosb = piosb;
1009 commio->hEvent = hEvent;
1010 get_wait_mask(commio->hDevice, &commio->evtmask);
1012 /* We may never return, if some capabilities miss
1013 * Return error in that case
1015 #if !defined(TIOCINQ)
1016 if (commio->evtmask & EV_RXCHAR)
1019 #if !(defined(TIOCSERGETLSR) && defined(TIOCSER_TEMT)) || !defined(TIOCINQ)
1020 if (commio->evtmask & EV_TXEMPTY)
1023 #if !defined(TIOCMGET)
1024 if (commio->evtmask & (EV_CTS | EV_DSR| EV_RING| EV_RLSD))
1027 #if !defined(TIOCM_CTS)
1028 if (commio->evtmask & EV_CTS)
1031 #if !defined(TIOCM_DSR)
1032 if (commio->evtmask & EV_DSR)
1035 #if !defined(TIOCM_RNG)
1036 if (commio->evtmask & EV_RING)
1039 #if !defined(TIOCM_CAR)
1040 if (commio->evtmask & EV_RLSD)
1043 if (commio->evtmask & EV_RXFLAG)
1044 FIXME("EV_RXFLAG not handled\n");
1046 if ((status = get_irq_info(fd, &commio->irq_info)) &&
1047 (commio->evtmask & (EV_BREAK | EV_ERR)))
1050 if ((status = get_modem_status(fd, &commio->mstat)) &&
1051 (commio->evtmask & (EV_CTS | EV_DSR| EV_RING| EV_RLSD)))
1054 /* We might have received something or the TX buffer is delivered */
1055 *events = check_events(fd, commio->evtmask,
1056 &commio->irq_info, &commio->irq_info,
1057 commio->mstat, commio->mstat);
1060 status = STATUS_SUCCESS;
1064 /* create the worker for the task */
1065 status = RtlQueueWorkItem(wait_for_event, commio, 0 /* FIXME */);
1066 if (status != STATUS_SUCCESS) goto out_now;
1067 return STATUS_PENDING;
1069 #if !defined(TIOCINQ) || (!(defined(TIOCSERGETLSR) && defined(TIOCSER_TEMT)) || !defined(TIOCINQ)) || !defined(TIOCMGET) || !defined(TIOCM_CTS) ||!defined(TIOCM_DSR) || !defined(TIOCM_RNG) || !defined(TIOCM_CAR)
1071 FIXME("Returning error because of missing capabilities\n");
1072 status = STATUS_INVALID_PARAMETER;
1075 RtlFreeHeap(GetProcessHeap(), 0, commio);
1079 static NTSTATUS xmit_immediate(HANDLE hDevice, int fd, const char* ptr)
1081 /* FIXME: not perfect as it should bypass the in-queue */
1082 WARN("(%p,'%c') not perfect!\n", hDevice, *ptr);
1083 if (write(fd, ptr, 1) != 1)
1084 return FILE_GetNtStatus();
1085 return STATUS_SUCCESS;
1088 /******************************************************************
1089 * COMM_DeviceIoControl
1093 static inline NTSTATUS io_control(HANDLE hDevice,
1094 HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
1095 PVOID UserApcContext,
1096 PIO_STATUS_BLOCK piosb,
1097 ULONG dwIoControlCode,
1098 LPVOID lpInBuffer, DWORD nInBufferSize,
1099 LPVOID lpOutBuffer, DWORD nOutBufferSize)
1101 DWORD sz = 0, access = FILE_READ_DATA;
1102 NTSTATUS status = STATUS_SUCCESS;
1103 int fd = -1, needs_close = 0;
1105 TRACE("%p %s %p %d %p %d %p\n",
1106 hDevice, iocode2str(dwIoControlCode), lpInBuffer, nInBufferSize,
1107 lpOutBuffer, nOutBufferSize, piosb);
1109 piosb->Information = 0;
1111 if (dwIoControlCode != IOCTL_SERIAL_GET_TIMEOUTS &&
1112 dwIoControlCode != IOCTL_SERIAL_SET_TIMEOUTS)
1114 enum server_fd_type type;
1115 if ((status = server_get_unix_fd( hDevice, access, &fd, &needs_close, &type, NULL )))
1117 if (type != FD_TYPE_SERIAL)
1119 if (needs_close) close( fd );
1120 status = STATUS_OBJECT_TYPE_MISMATCH;
1125 switch (dwIoControlCode)
1127 case IOCTL_SERIAL_CLR_DTR:
1129 if (whack_modem(fd, ~TIOCM_DTR, 0) == -1) status = FILE_GetNtStatus();
1131 status = STATUS_NOT_SUPPORTED;
1134 case IOCTL_SERIAL_CLR_RTS:
1136 if (whack_modem(fd, ~TIOCM_RTS, 0) == -1) status = FILE_GetNtStatus();
1138 status = STATUS_NOT_SUPPORTED;
1141 case IOCTL_SERIAL_GET_BAUD_RATE:
1142 if (lpOutBuffer && nOutBufferSize == sizeof(SERIAL_BAUD_RATE))
1144 if (!(status = get_baud_rate(fd, lpOutBuffer)))
1145 sz = sizeof(SERIAL_BAUD_RATE);
1148 status = STATUS_INVALID_PARAMETER;
1150 case IOCTL_SERIAL_GET_CHARS:
1151 if (lpOutBuffer && nOutBufferSize == sizeof(SERIAL_CHARS))
1153 if (!(status = get_special_chars(fd, lpOutBuffer)))
1154 sz = sizeof(SERIAL_CHARS);
1157 status = STATUS_INVALID_PARAMETER;
1159 case IOCTL_SERIAL_GET_COMMSTATUS:
1160 if (lpOutBuffer && nOutBufferSize == sizeof(SERIAL_STATUS))
1162 if (!(status = get_status(fd, lpOutBuffer)))
1163 sz = sizeof(SERIAL_STATUS);
1165 else status = STATUS_INVALID_PARAMETER;
1167 case IOCTL_SERIAL_GET_HANDFLOW:
1168 if (lpOutBuffer && nOutBufferSize == sizeof(SERIAL_HANDFLOW))
1170 if (!(status = get_hand_flow(fd, lpOutBuffer)))
1171 sz = sizeof(SERIAL_HANDFLOW);
1174 status = STATUS_INVALID_PARAMETER;
1176 case IOCTL_SERIAL_GET_LINE_CONTROL:
1177 if (lpOutBuffer && nOutBufferSize == sizeof(SERIAL_LINE_CONTROL))
1179 if (!(status = get_line_control(fd, lpOutBuffer)))
1180 sz = sizeof(SERIAL_LINE_CONTROL);
1183 status = STATUS_INVALID_PARAMETER;
1185 case IOCTL_SERIAL_GET_MODEMSTATUS:
1186 if (lpOutBuffer && nOutBufferSize == sizeof(DWORD))
1188 if (!(status = get_modem_status(fd, lpOutBuffer)))
1191 else status = STATUS_INVALID_PARAMETER;
1193 case IOCTL_SERIAL_GET_TIMEOUTS:
1194 if (lpOutBuffer && nOutBufferSize == sizeof(SERIAL_TIMEOUTS))
1196 if (!(status = get_timeouts(hDevice, lpOutBuffer)))
1197 sz = sizeof(SERIAL_TIMEOUTS);
1200 status = STATUS_INVALID_PARAMETER;
1202 case IOCTL_SERIAL_GET_WAIT_MASK:
1203 if (lpOutBuffer && nOutBufferSize == sizeof(DWORD))
1205 if (!(status = get_wait_mask(hDevice, lpOutBuffer)))
1209 status = STATUS_INVALID_PARAMETER;
1211 case IOCTL_SERIAL_IMMEDIATE_CHAR:
1212 if (lpInBuffer && nInBufferSize == sizeof(CHAR))
1213 status = xmit_immediate(hDevice, fd, lpInBuffer);
1215 status = STATUS_INVALID_PARAMETER;
1217 case IOCTL_SERIAL_PURGE:
1218 if (lpInBuffer && nInBufferSize == sizeof(DWORD))
1219 status = purge(fd, *(DWORD*)lpInBuffer);
1221 status = STATUS_INVALID_PARAMETER;
1223 case IOCTL_SERIAL_RESET_DEVICE:
1224 FIXME("Unsupported\n");
1226 case IOCTL_SERIAL_SET_BAUD_RATE:
1227 if (lpInBuffer && nInBufferSize == sizeof(SERIAL_BAUD_RATE))
1228 status = set_baud_rate(fd, lpInBuffer);
1230 status = STATUS_INVALID_PARAMETER;
1232 case IOCTL_SERIAL_SET_BREAK_OFF:
1233 #if defined(TIOCSBRK) && defined(TIOCCBRK) /* check if available for compilation */
1234 if (ioctl(fd, TIOCCBRK, 0) == -1)
1236 TRACE("ioctl failed\n");
1237 status = FILE_GetNtStatus();
1240 FIXME("ioctl not available\n");
1241 status = STATUS_NOT_SUPPORTED;
1244 case IOCTL_SERIAL_SET_BREAK_ON:
1245 #if defined(TIOCSBRK) && defined(TIOCCBRK) /* check if available for compilation */
1246 if (ioctl(fd, TIOCSBRK, 0) == -1)
1248 TRACE("ioctl failed\n");
1249 status = FILE_GetNtStatus();
1252 FIXME("ioctl not available\n");
1253 status = STATUS_NOT_SUPPORTED;
1256 case IOCTL_SERIAL_SET_CHARS:
1257 if (lpInBuffer && nInBufferSize == sizeof(SERIAL_CHARS))
1258 status = set_special_chars(fd, lpInBuffer);
1260 status = STATUS_INVALID_PARAMETER;
1262 case IOCTL_SERIAL_SET_DTR:
1264 if (whack_modem(fd, 0, TIOCM_DTR) == -1) status = FILE_GetNtStatus();
1266 status = STATUS_NOT_SUPPORTED;
1269 case IOCTL_SERIAL_SET_HANDFLOW:
1270 if (lpInBuffer && nInBufferSize == sizeof(SERIAL_HANDFLOW))
1271 status = set_handflow(fd, lpInBuffer);
1273 status = STATUS_INVALID_PARAMETER;
1275 case IOCTL_SERIAL_SET_LINE_CONTROL:
1276 if (lpInBuffer && nInBufferSize == sizeof(SERIAL_LINE_CONTROL))
1277 status = set_line_control(fd, lpInBuffer);
1279 status = STATUS_INVALID_PARAMETER;
1281 case IOCTL_SERIAL_SET_QUEUE_SIZE:
1282 if (lpInBuffer && nInBufferSize == sizeof(SERIAL_QUEUE_SIZE))
1283 status = set_queue_size(fd, lpInBuffer);
1285 status = STATUS_INVALID_PARAMETER;
1287 case IOCTL_SERIAL_SET_RTS:
1289 if (whack_modem(fd, 0, TIOCM_RTS) == -1) status = FILE_GetNtStatus();
1291 status = STATUS_NOT_SUPPORTED;
1294 case IOCTL_SERIAL_SET_TIMEOUTS:
1295 if (lpInBuffer && nInBufferSize == sizeof(SERIAL_TIMEOUTS))
1296 status = set_timeouts(hDevice, lpInBuffer);
1298 status = STATUS_INVALID_PARAMETER;
1300 case IOCTL_SERIAL_SET_WAIT_MASK:
1301 if (lpInBuffer && nInBufferSize == sizeof(DWORD))
1303 status = set_wait_mask(hDevice, *(DWORD*)lpInBuffer);
1305 else status = STATUS_INVALID_PARAMETER;
1307 case IOCTL_SERIAL_SET_XOFF:
1308 status = set_XOff(fd);
1310 case IOCTL_SERIAL_SET_XON:
1311 status = set_XOn(fd);
1313 case IOCTL_SERIAL_WAIT_ON_MASK:
1314 if (lpOutBuffer && nOutBufferSize == sizeof(DWORD))
1316 if (!(status = wait_on(hDevice, fd, hEvent, piosb, lpOutBuffer)))
1320 status = STATUS_INVALID_PARAMETER;
1323 FIXME("Unsupported IOCTL %x (type=%x access=%x func=%x meth=%x)\n",
1324 dwIoControlCode, dwIoControlCode >> 16, (dwIoControlCode >> 14) & 3,
1325 (dwIoControlCode >> 2) & 0xFFF, dwIoControlCode & 3);
1327 status = STATUS_INVALID_PARAMETER;
1330 if (needs_close) close( fd );
1332 piosb->u.Status = status;
1333 piosb->Information = sz;
1334 if (hEvent && status != STATUS_PENDING) NtSetEvent(hEvent, NULL);
1338 NTSTATUS COMM_DeviceIoControl(HANDLE hDevice,
1339 HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
1340 PVOID UserApcContext,
1341 PIO_STATUS_BLOCK piosb,
1342 ULONG dwIoControlCode,
1343 LPVOID lpInBuffer, DWORD nInBufferSize,
1344 LPVOID lpOutBuffer, DWORD nOutBufferSize)
1348 if (dwIoControlCode == IOCTL_SERIAL_WAIT_ON_MASK)
1350 HANDLE hev = hEvent;
1352 /* this is an ioctl we implement in a non blocking way if hEvent is not
1354 * so we have to explicitly wait if no hEvent is provided
1358 OBJECT_ATTRIBUTES attr;
1360 attr.Length = sizeof(attr);
1361 attr.RootDirectory = 0;
1362 attr.ObjectName = NULL;
1363 attr.Attributes = OBJ_CASE_INSENSITIVE | OBJ_OPENIF;
1364 attr.SecurityDescriptor = NULL;
1365 attr.SecurityQualityOfService = NULL;
1366 status = NtCreateEvent(&hev, EVENT_ALL_ACCESS, &attr, FALSE, FALSE);
1368 if (status) goto done;
1370 status = io_control(hDevice, hev, UserApcRoutine, UserApcContext,
1371 piosb, dwIoControlCode, lpInBuffer, nInBufferSize,
1372 lpOutBuffer, nOutBufferSize);
1375 if (status == STATUS_PENDING)
1377 NtWaitForSingleObject(hev, FALSE, NULL);
1378 status = STATUS_SUCCESS;
1383 else status = io_control(hDevice, hEvent, UserApcRoutine, UserApcContext,
1384 piosb, dwIoControlCode, lpInBuffer, nInBufferSize,
1385 lpOutBuffer, nOutBufferSize);