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     add_queue,                    /* add_queue */
  91     remove_queue,                 /* remove_queue */
  92     default_fd_signaled,          /* signaled */
  93     no_satisfied,                 /* satisfied */
  94     no_signal,                    /* signal */
  95     serial_get_fd,                /* get_fd */
  96     default_fd_map_access,        /* map_access */
  97     default_get_sd,               /* get_sd */
  98     default_set_sd,               /* set_sd */
  99     no_lookup_name,               /* lookup_name */
 100     no_open_file,                 /* open_file */
 101     fd_close_handle,              /* close_handle */
 102     serial_destroy                /* destroy */
 103 };
 104
 105 static const struct fd_ops serial_fd_ops =
 106 {
 107     default_fd_get_poll_events,   /* get_poll_events */
 108     default_poll_event,           /* poll_event */
 109     serial_flush,                 /* flush */
 110     serial_get_fd_type,           /* get_file_info */
 111     default_fd_ioctl,             /* ioctl */
 112     serial_queue_async,           /* queue_async */
 113     default_fd_reselect_async,    /* reselect_async */
 114     default_fd_cancel_async       /* cancel_async */
 115 };
 116
 117 /* check if the given fd is a serial port */
 118 int is_serial_fd( struct fd *fd )
 119 {
 120     struct termios tios;
 121
 122     return !tcgetattr( get_unix_fd(fd), &tios );
 123 }
 124
 125 /* create a serial object for a given fd */
 126 struct object *create_serial( struct fd *fd )
 127 {
 128     struct serial *serial;
 129
 130     if (!(serial = alloc_object( &serial_ops ))) return NULL;
 131
 132     serial->readinterval = 0;
 133     serial->readmult     = 0;
 134     serial->readconst    = 0;
 135     serial->writemult    = 0;
 136     serial->writeconst   = 0;
 137     serial->eventmask    = 0;
 138     serial->fd = (struct fd *)grab_object( fd );
 139     set_fd_user( fd, &serial_fd_ops, &serial->obj );
 140     return &serial->obj;
 141 }
 142
 143 static struct fd *serial_get_fd( struct object *obj )
 144 {
 145     struct serial *serial = (struct serial *)obj;
 146     return (struct fd *)grab_object( serial->fd );
 147 }
 148
 149 static void serial_destroy( struct object *obj)
 150 {
 151     struct serial *serial = (struct serial *)obj;
 152     release_object( serial->fd );
 153 }
 154
 155 static void serial_dump( struct object *obj, int verbose )
 156 {
 157     struct serial *serial = (struct serial *)obj;
 158     assert( obj->ops == &serial_ops );
 159     fprintf( stderr, "Port fd=%p mask=%x\n", serial->fd, serial->eventmask );
 160 }
 161
 162 static struct serial *get_serial_obj( struct process *process, obj_handle_t handle, unsigned int access )
 163 {
 164     return (struct serial *)get_handle_obj( process, handle, access, &serial_ops );
 165 }
 166
 167 static enum server_fd_type serial_get_fd_type( struct fd *fd )
 168 {
 169     return FD_TYPE_SERIAL;
 170 }
 171
 172 static void serial_queue_async( struct fd *fd, const async_data_t *data, int type, int count )
 173 {
 174     struct serial *serial = get_fd_user( fd );
 175     timeout_t timeout = 0;
 176     struct async *async;
 177
 178     assert(serial->obj.ops == &serial_ops);
 179
 180     switch (type)
 181     {
 182     case ASYNC_TYPE_READ:
 183         timeout = serial->readconst + (timeout_t)serial->readmult*count;
 184         break;
 185     case ASYNC_TYPE_WRITE:
 186         timeout = serial->writeconst + (timeout_t)serial->writemult*count;
 187         break;
 188     }
 189
 190     if ((async = fd_queue_async( fd, data, type, count )))
 191     {
 192         if (timeout) async_set_timeout( async, timeout * -10000, STATUS_TIMEOUT );
 193         release_object( async );
 194         set_error( STATUS_PENDING );
 195     }
 196 }
 197
 198 static void serial_flush( struct fd *fd, struct event **event )
 199 {
 200     /* MSDN says: If hFile is a handle to a communications device,
 201      * the function only flushes the transmit buffer.
 202      */
 203     if (tcflush( get_unix_fd(fd), TCOFLUSH ) == -1) file_set_error();
 204 }
 205
 206 DECL_HANDLER(get_serial_info)
 207 {
 208     struct serial *serial;
 209
 210     if ((serial = get_serial_obj( current->process, req->handle, 0 )))
 211     {
 212         /* timeouts */
 213         reply->readinterval = serial->readinterval;
 214         reply->readconst    = serial->readconst;
 215         reply->readmult     = serial->readmult;
 216         reply->writeconst   = serial->writeconst;
 217         reply->writemult    = serial->writemult;
 218
 219         /* event mask */
 220         reply->eventmask    = serial->eventmask;
 221
 222         release_object( serial );
 223     }
 224 }
 225
 226 DECL_HANDLER(set_serial_info)
 227 {
 228     struct serial *serial;
 229
 230     if ((serial = get_serial_obj( current->process, req->handle, 0 )))
 231     {
 232         /* timeouts */
 233         if (req->flags & SERIALINFO_SET_TIMEOUTS)
 234         {
 235             serial->readinterval = req->readinterval;
 236             serial->readconst    = req->readconst;
 237             serial->readmult     = req->readmult;
 238             serial->writeconst   = req->writeconst;
 239             serial->writemult    = req->writemult;
 240         }
 241
 242         /* event mask */
 243         if (req->flags & SERIALINFO_SET_MASK)
 244         {
 245             serial->eventmask = req->eventmask;
 246             if (!serial->eventmask)
 247             {
 248                 fd_async_wake_up( serial->fd, ASYNC_TYPE_WAIT, STATUS_SUCCESS );
 249             }
 250         }
 251
 252         release_object( serial );
 253     }
 254 }