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_queue_async( struct fd *fd, const async_data_t *data, int type, int count );
  65
  66 struct serial
  67 {
  68     struct object       obj;
  69     struct fd          *fd;
  70
  71     /* timeout values */
  72     unsigned int        readinterval;
  73     unsigned int        readconst;
  74     unsigned int        readmult;
  75     unsigned int        writeconst;
  76     unsigned int        writemult;
  77
  78     unsigned int        eventmask;
  79     unsigned int        generation; /* event mask change counter */
  80     unsigned int        pending_write : 1;
  81     unsigned int        pending_wait  : 1;
  82
  83     struct termios      original;
  84
  85     /* FIXME: add dcb, comm status, handler module, sharing */
  86 };
  87
  88 static const struct object_ops serial_ops =
  89 {
  90     sizeof(struct serial),        /* size */
  91     serial_dump,                  /* dump */
  92     no_get_type,                  /* get_type */
  93     add_queue,                    /* add_queue */
  94     remove_queue,                 /* remove_queue */
  95     default_fd_signaled,          /* signaled */
  96     no_satisfied,                 /* satisfied */
  97     no_signal,                    /* signal */
  98     serial_get_fd,                /* get_fd */
  99     default_fd_map_access,        /* map_access */
 100     default_get_sd,               /* get_sd */
 101     default_set_sd,               /* set_sd */
 102     no_lookup_name,               /* lookup_name */
 103     no_open_file,                 /* open_file */
 104     fd_close_handle,              /* close_handle */
 105     serial_destroy                /* destroy */
 106 };
 107
 108 static const struct fd_ops serial_fd_ops =
 109 {
 110     default_fd_get_poll_events,   /* get_poll_events */
 111     default_poll_event,           /* poll_event */
 112     no_flush,                     /* flush */
 113     serial_get_fd_type,           /* get_fd_type */
 114     default_fd_ioctl,             /* ioctl */
 115     serial_queue_async,           /* queue_async */
 116     default_fd_reselect_async,    /* reselect_async */
 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->generation   = 0;
 142     serial->pending_write = 0;
 143     serial->pending_wait = 0;
 144     serial->fd = (struct fd *)grab_object( fd );
 145     set_fd_user( fd, &serial_fd_ops, &serial->obj );
 146     return &serial->obj;
 147 }
 148
 149 static struct fd *serial_get_fd( struct object *obj )
 150 {
 151     struct serial *serial = (struct serial *)obj;
 152     return (struct fd *)grab_object( serial->fd );
 153 }
 154
 155 static void serial_destroy( struct object *obj)
 156 {
 157     struct serial *serial = (struct serial *)obj;
 158     release_object( serial->fd );
 159 }
 160
 161 static void serial_dump( struct object *obj, int verbose )
 162 {
 163     struct serial *serial = (struct serial *)obj;
 164     assert( obj->ops == &serial_ops );
 165     fprintf( stderr, "Port fd=%p mask=%x\n", serial->fd, serial->eventmask );
 166 }
 167
 168 static struct serial *get_serial_obj( struct process *process, obj_handle_t handle, unsigned int access )
 169 {
 170     return (struct serial *)get_handle_obj( process, handle, access, &serial_ops );
 171 }
 172
 173 static enum server_fd_type serial_get_fd_type( struct fd *fd )
 174 {
 175     return FD_TYPE_SERIAL;
 176 }
 177
 178 static void serial_queue_async( struct fd *fd, const async_data_t *data, int type, int count )
 179 {
 180     struct serial *serial = get_fd_user( fd );
 181     timeout_t timeout = 0;
 182     struct async *async;
 183
 184     assert(serial->obj.ops == &serial_ops);
 185
 186     switch (type)
 187     {
 188     case ASYNC_TYPE_READ:
 189         timeout = serial->readconst + (timeout_t)serial->readmult*count;
 190         break;
 191     case ASYNC_TYPE_WRITE:
 192         timeout = serial->writeconst + (timeout_t)serial->writemult*count;
 193         break;
 194     }
 195
 196     if ((async = fd_queue_async( fd, data, type )))
 197     {
 198         if (timeout) async_set_timeout( async, timeout * -10000, STATUS_TIMEOUT );
 199         release_object( async );
 200         set_error( STATUS_PENDING );
 201     }
 202 }
 203
 204 DECL_HANDLER(get_serial_info)
 205 {
 206     struct serial *serial;
 207
 208     if ((serial = get_serial_obj( current->process, req->handle, 0 )))
 209     {
 210         if (req->flags & SERIALINFO_PENDING_WAIT)
 211         {
 212             if (serial->pending_wait)
 213             {
 214                 release_object( serial );
 215                 set_error( STATUS_INVALID_PARAMETER );
 216                 return;
 217             }
 218             serial->pending_wait = 1;
 219         }
 220
 221         /* timeouts */
 222         reply->readinterval = serial->readinterval;
 223         reply->readconst    = serial->readconst;
 224         reply->readmult     = serial->readmult;
 225         reply->writeconst   = serial->writeconst;
 226         reply->writemult    = serial->writemult;
 227
 228         /* event mask */
 229         reply->eventmask    = serial->eventmask;
 230         reply->cookie       = serial->generation;
 231
 232         /* pending write */
 233         reply->pending_write = serial->pending_write;
 234         if (req->flags & SERIALINFO_PENDING_WRITE)
 235             serial->pending_write = 0;
 236
 237         release_object( serial );
 238     }
 239 }
 240
 241 DECL_HANDLER(set_serial_info)
 242 {
 243     struct serial *serial;
 244
 245     if ((serial = get_serial_obj( current->process, req->handle, 0 )))
 246     {
 247         if (req->flags & SERIALINFO_PENDING_WAIT)
 248         {
 249             if (!serial->pending_wait)
 250             {
 251                 release_object( serial );
 252                 set_error( STATUS_INVALID_PARAMETER );
 253                 return;
 254             }
 255             serial->pending_wait = 0;
 256         }
 257
 258         /* timeouts */
 259         if (req->flags & SERIALINFO_SET_TIMEOUTS)
 260         {
 261             serial->readinterval = req->readinterval;
 262             serial->readconst    = req->readconst;
 263             serial->readmult     = req->readmult;
 264             serial->writeconst   = req->writeconst;
 265             serial->writemult    = req->writemult;
 266         }
 267
 268         /* pending write */
 269         if (req->flags & SERIALINFO_PENDING_WRITE)
 270             serial->pending_write = 1;
 271
 272         /* event mask */
 273         if (req->flags & SERIALINFO_SET_MASK)
 274         {
 275             serial->eventmask = req->eventmask;
 276             serial->generation++;
 277             fd_async_wake_up( serial->fd, ASYNC_TYPE_WAIT, STATUS_SUCCESS );
 278         }
 279
 280         release_object( serial );
 281     }
 282 }