server/serial.c

   1 /*
   2  * Server-side serial port communications management
   3  *
   4  * Copyright (C) 1998 Alexandre Julliard
   5  * Copyright (C) 2000,2001 Mike McCormack
   6  *
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  21  */
  22
  23 #include "config.h"
  24 #include "wine/port.h"
  25
  26 #include <assert.h>
  27 #include <fcntl.h>
  28 #include <stdarg.h>
  29 #include <stdio.h>
  30 #include <string.h>
  31 #include <stdlib.h>
  32 #include <sys/time.h>
  33 #include <sys/types.h>
  34 #include <time.h>
  35 #include <unistd.h>
  36 #ifdef HAVE_UTIME_H
  37 #include <utime.h>
  38 #endif
  39 #ifdef HAVE_TERMIOS_H
  40 #include <termios.h>
  41 #endif
  42 #ifdef HAVE_SYS_IOCTL_H
  43 #include <sys/ioctl.h>
  44 #endif
  45 #ifdef HAVE_POLL_H
  46 #include <poll.h>
  47 #endif
  48
  49 #include "ntstatus.h"
  50 #define WIN32_NO_STATUS
  51 #include "windef.h"
  52 #include "winternl.h"
  53
  54 #include "file.h"
  55 #include "handle.h"
  56 #include "thread.h"
  57 #include "request.h"
  58
  59 static void serial_dump( struct object *obj, int verbose );
  60 static struct fd *serial_get_fd( struct object *obj );
  61 static void serial_destroy(struct object *obj);
  62
  63 static enum server_fd_type serial_get_fd_type( struct fd *fd );
  64 static void serial_flush( struct fd *fd, struct event **event );
  65 static void serial_queue_async( struct fd *fd, const async_data_t *data, int type, int count );
  66
  67 struct serial
  68 {
  69     struct object       obj;
  70     struct fd          *fd;
  71
  72     /* timeout values */
  73     unsigned int        readinterval;
  74     unsigned int        readconst;
  75     unsigned int        readmult;
  76     unsigned int        writeconst;
  77     unsigned int        writemult;
  78
  79     unsigned int        eventmask;
  80
  81     struct termios      original;
  82
  83     /* FIXME: add dcb, comm status, handler module, sharing */
  84 };
  85
  86 static const struct object_ops serial_ops =
  87 {
  88     sizeof(struct serial),        /* size */
  89     serial_dump,                  /* dump */
  90     no_get_type,                  /* get_type */
  91     add_queue,                    /* add_queue */
  92     remove_queue,                 /* remove_queue */
  93     default_fd_signaled,          /* signaled */
  94     no_satisfied,                 /* satisfied */
  95     no_signal,                    /* signal */
  96     serial_get_fd,                /* get_fd */
  97     default_fd_map_access,        /* map_access */
  98     default_get_sd,               /* get_sd */
  99     default_set_sd,               /* set_sd */
 100     no_lookup_name,               /* lookup_name */
 101     no_open_file,                 /* open_file */
 102     fd_close_handle,              /* close_handle */
 103     serial_destroy                /* destroy */
 104 };
 105
 106 static const struct fd_ops serial_fd_ops =
 107 {
 108     default_fd_get_poll_events,   /* get_poll_events */
 109     default_poll_event,           /* poll_event */
 110     serial_flush,                 /* flush */
 111     serial_get_fd_type,           /* get_file_info */
 112     default_fd_removable,         /* removable */
 113     default_fd_ioctl,             /* ioctl */
 114     serial_queue_async,           /* queue_async */
 115     default_fd_async_event,       /* async_event */
 116     default_fd_async_terminated,  /* async_terminated */
 117     default_fd_cancel_async       /* cancel_async */
 118 };
 119
 120 /* check if the given fd is a serial port */
 121 int is_serial_fd( struct fd *fd )
 122 {
 123     struct termios tios;
 124
 125     return !tcgetattr( get_unix_fd(fd), &tios );
 126 }
 127
 128 /* create a serial object for a given fd */
 129 struct object *create_serial( struct fd *fd )
 130 {
 131     struct serial *serial;
 132
 133     if (!(serial = alloc_object( &serial_ops ))) return NULL;
 134
 135     serial->readinterval = 0;
 136     serial->readmult     = 0;
 137     serial->readconst    = 0;
 138     serial->writemult    = 0;
 139     serial->writeconst   = 0;
 140     serial->eventmask    = 0;
 141     serial->fd = (struct fd *)grab_object( fd );
 142     set_fd_user( fd, &serial_fd_ops, &serial->obj );
 143     return &serial->obj;
 144 }
 145
 146 static struct fd *serial_get_fd( struct object *obj )
 147 {
 148     struct serial *serial = (struct serial *)obj;
 149     return (struct fd *)grab_object( serial->fd );
 150 }
 151
 152 static void serial_destroy( struct object *obj)
 153 {
 154     struct serial *serial = (struct serial *)obj;
 155     release_object( serial->fd );
 156 }
 157
 158 static void serial_dump( struct object *obj, int verbose )
 159 {
 160     struct serial *serial = (struct serial *)obj;
 161     assert( obj->ops == &serial_ops );
 162     fprintf( stderr, "Port fd=%p mask=%x\n", serial->fd, serial->eventmask );
 163 }
 164
 165 static struct serial *get_serial_obj( struct process *process, obj_handle_t handle, unsigned int access )
 166 {
 167     return (struct serial *)get_handle_obj( process, handle, access, &serial_ops );
 168 }
 169
 170 static enum server_fd_type serial_get_fd_type( struct fd *fd )
 171 {
 172     return FD_TYPE_SERIAL;
 173 }
 174
 175 static void serial_queue_async( struct fd *fd, const async_data_t *data, int type, int count )
 176 {
 177     struct serial *serial = get_fd_user( fd );
 178     timeout_t timeout = 0;
 179     struct async *async;
 180
 181     assert(serial->obj.ops == &serial_ops);
 182
 183     switch (type)
 184     {
 185     case ASYNC_TYPE_READ:
 186         timeout = serial->readconst + (timeout_t)serial->readmult*count;
 187         break;
 188     case ASYNC_TYPE_WRITE:
 189         timeout = serial->writeconst + (timeout_t)serial->writemult*count;
 190         break;
 191     }
 192
 193     if ((async = fd_queue_async( fd, data, type )))
 194     {
 195         if (timeout) async_set_timeout( async, timeout * -10000, STATUS_TIMEOUT );
 196         release_object( async );
 197         set_error( STATUS_PENDING );
 198     }
 199 }
 200
 201 static void serial_flush( struct fd *fd, struct event **event )
 202 {
 203     /* MSDN says: If hFile is a handle to a communications device,
 204      * the function only flushes the transmit buffer.
 205      */
 206     if (tcflush( get_unix_fd(fd), TCOFLUSH ) == -1) file_set_error();
 207 }
 208
 209 DECL_HANDLER(get_serial_info)
 210 {
 211     struct serial *serial;
 212
 213     if ((serial = get_serial_obj( current->process, req->handle, 0 )))
 214     {
 215         /* timeouts */
 216         reply->readinterval = serial->readinterval;
 217         reply->readconst    = serial->readconst;
 218         reply->readmult     = serial->readmult;
 219         reply->writeconst   = serial->writeconst;
 220         reply->writemult    = serial->writemult;
 221
 222         /* event mask */
 223         reply->eventmask    = serial->eventmask;
 224
 225         release_object( serial );
 226     }
 227 }
 228
 229 DECL_HANDLER(set_serial_info)
 230 {
 231     struct serial *serial;
 232
 233     if ((serial = get_serial_obj( current->process, req->handle, 0 )))
 234     {
 235         /* timeouts */
 236         if (req->flags & SERIALINFO_SET_TIMEOUTS)
 237         {
 238             serial->readinterval = req->readinterval;
 239             serial->readconst    = req->readconst;
 240             serial->readmult     = req->readmult;
 241             serial->writeconst   = req->writeconst;
 242             serial->writemult    = req->writemult;
 243         }
 244
 245         /* event mask */
 246         if (req->flags & SERIALINFO_SET_MASK)
 247         {
 248             serial->eventmask = req->eventmask;
 249             if (!serial->eventmask)
 250             {
 251                 fd_async_wake_up( serial->fd, ASYNC_TYPE_WAIT, STATUS_SUCCESS );
 252             }
 253         }
 254
 255         release_object( serial );
 256     }
 257 }