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