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 #include "winioctl.h"
  54 #include "ddk/ntddser.h"
  55
  56 #include "file.h"
  57 #include "handle.h"
  58 #include "thread.h"
  59 #include "request.h"
  60
  61 static void serial_dump( struct object *obj, int verbose );
  62 static struct fd *serial_get_fd( struct object *obj );
  63 static void serial_destroy(struct object *obj);
  64
  65 static enum server_fd_type serial_get_fd_type( struct fd *fd );
  66 static obj_handle_t serial_ioctl( struct fd *fd, ioctl_code_t code, struct async *async );
  67 static void serial_queue_async( struct fd *fd, struct async *async, int type, int count );
  68 static void serial_reselect_async( struct fd *fd, struct async_queue *queue );
  69
  70 struct serial
  71 {
  72     struct object       obj;
  73     struct fd          *fd;
  74
  75     struct timeout_user *read_timer;
  76
  77     /* timeout values */
  78     unsigned int        readinterval;
  79     unsigned int        readconst;
  80     unsigned int        readmult;
  81     unsigned int        writeconst;
  82     unsigned int        writemult;
  83
  84     unsigned int        eventmask;
  85     unsigned int        generation; /* event mask change counter */
  86     unsigned int        pending_write : 1;
  87     unsigned int        pending_wait  : 1;
  88
  89     struct termios      original;
  90
  91     /* FIXME: add dcb, comm status, handler module, sharing */
  92 };
  93
  94 static const struct object_ops serial_ops =
  95 {
  96     sizeof(struct serial),        /* size */
  97     serial_dump,                  /* dump */
  98     no_get_type,                  /* get_type */
  99     add_queue,                    /* add_queue */
 100     remove_queue,                 /* remove_queue */
 101     default_fd_signaled,          /* signaled */
 102     no_satisfied,                 /* satisfied */
 103     no_signal,                    /* signal */
 104     serial_get_fd,                /* get_fd */
 105     default_fd_map_access,        /* map_access */
 106     default_get_sd,               /* get_sd */
 107     default_set_sd,               /* set_sd */
 108     no_lookup_name,               /* lookup_name */
 109     no_link_name,                 /* link_name */
 110     NULL,                         /* unlink_name */
 111     no_open_file,                 /* open_file */
 112     fd_close_handle,              /* close_handle */
 113     serial_destroy                /* destroy */
 114 };
 115
 116 static const struct fd_ops serial_fd_ops =
 117 {
 118     default_fd_get_poll_events,   /* get_poll_events */
 119     default_poll_event,           /* poll_event */
 120     serial_get_fd_type,           /* get_fd_type */
 121     no_fd_read,                   /* read */
 122     no_fd_write,                  /* write */
 123     no_fd_flush,                  /* flush */
 124     serial_ioctl,                 /* ioctl */
 125     serial_queue_async,           /* queue_async */
 126     serial_reselect_async         /* reselect_async */
 127 };
 128
 129 /* check if the given fd is a serial port */
 130 int is_serial_fd( struct fd *fd )
 131 {
 132     struct termios tios;
 133
 134     return !tcgetattr( get_unix_fd(fd), &tios );
 135 }
 136
 137 /* create a serial object for a given fd */
 138 struct object *create_serial( struct fd *fd )
 139 {
 140     struct serial *serial;
 141
 142     if (!(serial = alloc_object( &serial_ops ))) return NULL;
 143
 144     serial->read_timer   = NULL;
 145     serial->readinterval = 0;
 146     serial->readmult     = 0;
 147     serial->readconst    = 0;
 148     serial->writemult    = 0;
 149     serial->writeconst   = 0;
 150     serial->eventmask    = 0;
 151     serial->generation   = 0;
 152     serial->pending_write = 0;
 153     serial->pending_wait = 0;
 154     serial->fd = (struct fd *)grab_object( fd );
 155     set_fd_user( fd, &serial_fd_ops, &serial->obj );
 156     return &serial->obj;
 157 }
 158
 159 static struct fd *serial_get_fd( struct object *obj )
 160 {
 161     struct serial *serial = (struct serial *)obj;
 162     return (struct fd *)grab_object( serial->fd );
 163 }
 164
 165 static void serial_destroy( struct object *obj)
 166 {
 167     struct serial *serial = (struct serial *)obj;
 168     if (serial->read_timer) remove_timeout_user( serial->read_timer );
 169     release_object( serial->fd );
 170 }
 171
 172 static void serial_dump( struct object *obj, int verbose )
 173 {
 174     struct serial *serial = (struct serial *)obj;
 175     assert( obj->ops == &serial_ops );
 176     fprintf( stderr, "Port fd=%p mask=%x\n", serial->fd, serial->eventmask );
 177 }
 178
 179 static struct serial *get_serial_obj( struct process *process, obj_handle_t handle, unsigned int access )
 180 {
 181     return (struct serial *)get_handle_obj( process, handle, access, &serial_ops );
 182 }
 183
 184 static enum server_fd_type serial_get_fd_type( struct fd *fd )
 185 {
 186     return FD_TYPE_SERIAL;
 187 }
 188
 189 static obj_handle_t serial_ioctl( struct fd *fd, ioctl_code_t code, struct async *async )
 190 {
 191     struct serial *serial = get_fd_user( fd );
 192
 193     switch (code)
 194     {
 195     case IOCTL_SERIAL_GET_TIMEOUTS:
 196         if (get_reply_max_size() >= sizeof(SERIAL_TIMEOUTS))
 197         {
 198             SERIAL_TIMEOUTS *timeouts = set_reply_data_size( sizeof(*timeouts ));
 199
 200             timeouts->ReadIntervalTimeout = serial->readinterval;
 201             timeouts->ReadTotalTimeoutConstant = serial->readconst;
 202             timeouts->ReadTotalTimeoutMultiplier = serial->readmult;
 203             timeouts->WriteTotalTimeoutConstant = serial->writeconst;
 204             timeouts->WriteTotalTimeoutMultiplier = serial->writemult;
 205         }
 206         else set_error( STATUS_BUFFER_TOO_SMALL );
 207         return 0;
 208
 209     case IOCTL_SERIAL_SET_TIMEOUTS:
 210         if (get_req_data_size() >= sizeof(SERIAL_TIMEOUTS))
 211         {
 212             const SERIAL_TIMEOUTS *timeouts = get_req_data();
 213
 214             serial->readinterval = timeouts->ReadIntervalTimeout;
 215             serial->readconst    = timeouts->ReadTotalTimeoutConstant;
 216             serial->readmult     = timeouts->ReadTotalTimeoutMultiplier;
 217             serial->writeconst   = timeouts->WriteTotalTimeoutConstant;
 218             serial->writemult    = timeouts->WriteTotalTimeoutMultiplier;
 219         }
 220         else set_error( STATUS_BUFFER_TOO_SMALL );
 221         return 0;
 222
 223     case IOCTL_SERIAL_GET_WAIT_MASK:
 224         if (get_reply_max_size() >= sizeof(serial->eventmask))
 225             set_reply_data( &serial->eventmask, sizeof(serial->eventmask) );
 226         else
 227             set_error( STATUS_BUFFER_TOO_SMALL );
 228         return 0;
 229
 230     case IOCTL_SERIAL_SET_WAIT_MASK:
 231         if (get_req_data_size() >= sizeof(serial->eventmask))
 232         {
 233             serial->eventmask = *(unsigned int *)get_req_data();
 234             serial->generation++;
 235             fd_async_wake_up( serial->fd, ASYNC_TYPE_WAIT, STATUS_SUCCESS );
 236         }
 237         else set_error( STATUS_BUFFER_TOO_SMALL );
 238         return 0;
 239
 240     default:
 241         set_error( STATUS_NOT_SUPPORTED );
 242         return 0;
 243     }
 244 }
 245
 246 static void serial_queue_async( struct fd *fd, struct async *async, int type, int count )
 247 {
 248     struct serial *serial = get_fd_user( fd );
 249     timeout_t timeout = 0;
 250
 251     assert(serial->obj.ops == &serial_ops);
 252
 253     switch (type)
 254     {
 255     case ASYNC_TYPE_READ:
 256         timeout = serial->readconst + (timeout_t)serial->readmult*count;
 257         break;
 258     case ASYNC_TYPE_WRITE:
 259         timeout = serial->writeconst + (timeout_t)serial->writemult*count;
 260         break;
 261     }
 262
 263     if (fd_queue_async( fd, async, type ))
 264     {
 265         if (timeout) async_set_timeout( async, timeout * -10000, STATUS_TIMEOUT );
 266         set_error( STATUS_PENDING );
 267     }
 268 }
 269
 270 static void serial_read_timeout( void *arg )
 271 {
 272     struct serial *serial = arg;
 273
 274     serial->read_timer = NULL;
 275     fd_async_wake_up( serial->fd, ASYNC_TYPE_READ, STATUS_TIMEOUT );
 276 }
 277
 278 static void serial_reselect_async( struct fd *fd, struct async_queue *queue )
 279 {
 280     struct serial *serial = get_fd_user( fd );
 281
 282     if (serial->read_timer)
 283     {
 284         if (!(default_fd_get_poll_events( fd ) & POLLIN))
 285         {
 286             remove_timeout_user( serial->read_timer );
 287             serial->read_timer = NULL;
 288         }
 289     }
 290     else if (serial->readinterval && (default_fd_get_poll_events( fd ) & POLLIN))
 291     {
 292         serial->read_timer = add_timeout_user( (timeout_t)serial->readinterval * -10000,
 293                                                serial_read_timeout, serial );
 294     }
 295     default_fd_reselect_async( fd, queue );
 296 }
 297
 298 DECL_HANDLER(get_serial_info)
 299 {
 300     struct serial *serial;
 301
 302     if ((serial = get_serial_obj( current->process, req->handle, 0 )))
 303     {
 304         if (req->flags & SERIALINFO_PENDING_WAIT)
 305         {
 306             if (serial->pending_wait)
 307             {
 308                 release_object( serial );
 309                 set_error( STATUS_INVALID_PARAMETER );
 310                 return;
 311             }
 312             serial->pending_wait = 1;
 313         }
 314
 315         /* event mask */
 316         reply->eventmask    = serial->eventmask;
 317         reply->cookie       = serial->generation;
 318
 319         /* pending write */
 320         reply->pending_write = serial->pending_write;
 321         if (req->flags & SERIALINFO_PENDING_WRITE)
 322             serial->pending_write = 0;
 323
 324         release_object( serial );
 325     }
 326 }
 327
 328 DECL_HANDLER(set_serial_info)
 329 {
 330     struct serial *serial;
 331
 332     if ((serial = get_serial_obj( current->process, req->handle, 0 )))
 333     {
 334         if (req->flags & SERIALINFO_PENDING_WAIT)
 335         {
 336             if (!serial->pending_wait)
 337             {
 338                 release_object( serial );
 339                 set_error( STATUS_INVALID_PARAMETER );
 340                 return;
 341             }
 342             serial->pending_wait = 0;
 343         }
 344
 345         /* pending write */
 346         if (req->flags & SERIALINFO_PENDING_WRITE)
 347             serial->pending_write = 1;
 348
 349         release_object( serial );
 350     }
 351 }