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
  25 #include <assert.h>
  26 #include <fcntl.h>
  27 #include <stdarg.h>
  28 #include <stdio.h>
  29 #include <string.h>
  30 #include <stdlib.h>
  31 #include <sys/time.h>
  32 #include <sys/types.h>
  33 #include <time.h>
  34 #include <unistd.h>
  35 #include <poll.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
  46 #include "ntstatus.h"
  47 #define WIN32_NO_STATUS
  48 #include "windef.h"
  49 #include "winternl.h"
  50 #include "winioctl.h"
  51 #include "ddk/ntddser.h"
  52
  53 #include "file.h"
  54 #include "handle.h"
  55 #include "thread.h"
  56 #include "request.h"
  57
  58 static void serial_dump( struct object *obj, int verbose );
  59 static struct fd *serial_get_fd( struct object *obj );
  60 static void serial_destroy(struct object *obj);
  61
  62 static enum server_fd_type serial_get_fd_type( struct fd *fd );
  63 static void serial_ioctl( struct fd *fd, ioctl_code_t code, struct async *async );
  64 static void serial_queue_async( struct fd *fd, struct async *async, int type, int count );
  65 static void serial_reselect_async( struct fd *fd, struct async_queue *queue );
  66
  67 struct serial
  68 {
  69     struct object       obj;
  70     struct fd          *fd;
  71
  72     struct timeout_user *read_timer;
  73     SERIAL_TIMEOUTS     timeouts;
  74     unsigned int        eventmask;
  75     unsigned int        generation; /* event mask change counter */
  76     unsigned int        pending_write : 1;
  77     unsigned int        pending_wait  : 1;
  78
  79     struct termios      original;
  80
  81     /* FIXME: add dcb, comm status, handler module, sharing */
  82 };
  83
  84 static const struct object_ops serial_ops =
  85 {
  86     sizeof(struct serial),        /* size */
  87     &file_type,                   /* type */
  88     serial_dump,                  /* dump */
  89     add_queue,                    /* add_queue */
  90     remove_queue,                 /* remove_queue */
  91     default_fd_signaled,          /* signaled */
  92     no_satisfied,                 /* satisfied */
  93     no_signal,                    /* signal */
  94     serial_get_fd,                /* get_fd */
  95     default_map_access,           /* map_access */
  96     default_get_sd,               /* get_sd */
  97     default_set_sd,               /* set_sd */
  98     no_get_full_name,             /* get_full_name */
  99     no_lookup_name,               /* lookup_name */
 100     no_link_name,                 /* link_name */
 101     NULL,                         /* unlink_name */
 102     no_open_file,                 /* open_file */
 103     no_kernel_obj_list,           /* get_kernel_obj_list */
 104     no_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     serial_get_fd_type,           /* get_fd_type */
 113     no_fd_read,                   /* read */
 114     no_fd_write,                  /* write */
 115     no_fd_flush,                  /* flush */
 116     default_fd_get_file_info,     /* get_file_info */
 117     no_fd_get_volume_info,        /* get_volume_info */
 118     serial_ioctl,                 /* ioctl */
 119     default_fd_cancel_async,      /* cancel_async */
 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 void 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;
 191         }
 192         set_reply_data( &serial->timeouts, sizeof(serial->timeouts ));
 193         return;
 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;
 200         }
 201         memcpy( &serial->timeouts, get_req_data(), sizeof(serial->timeouts) );
 202         return;
 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;
 209         }
 210         set_reply_data( &serial->eventmask, sizeof(serial->eventmask) );
 211         return;
 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;
 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;
 223
 224     default:
 225         set_error( STATUS_NOT_SUPPORTED );
 226     }
 227 }
 228
 229 static void serial_queue_async( struct fd *fd, struct async *async, int type, int count )
 230 {
 231     struct serial *serial = get_fd_user( fd );
 232     timeout_t timeout = 0;
 233
 234     assert(serial->obj.ops == &serial_ops);
 235
 236     switch (type)
 237     {
 238     case ASYNC_TYPE_READ:
 239         timeout = serial->timeouts.ReadTotalTimeoutConstant +
 240             (timeout_t)serial->timeouts.ReadTotalTimeoutMultiplier * count;
 241         break;
 242     case ASYNC_TYPE_WRITE:
 243         timeout = serial->timeouts.WriteTotalTimeoutConstant +
 244             (timeout_t)serial->timeouts.WriteTotalTimeoutMultiplier * count;
 245         break;
 246     }
 247
 248     fd_queue_async( fd, async, type );
 249     if (timeout) async_set_timeout( async, timeout * -10000, STATUS_TIMEOUT );
 250     set_error( STATUS_PENDING );
 251 }
 252
 253 static void serial_read_timeout( void *arg )
 254 {
 255     struct serial *serial = arg;
 256
 257     serial->read_timer = NULL;
 258     fd_async_wake_up( serial->fd, ASYNC_TYPE_READ, STATUS_TIMEOUT );
 259 }
 260
 261 static void serial_reselect_async( struct fd *fd, struct async_queue *queue )
 262 {
 263     struct serial *serial = get_fd_user( fd );
 264
 265     if (serial->read_timer)
 266     {
 267         if (!(default_fd_get_poll_events( fd ) & POLLIN))
 268         {
 269             remove_timeout_user( serial->read_timer );
 270             serial->read_timer = NULL;
 271         }
 272     }
 273     else if (serial->timeouts.ReadIntervalTimeout && (default_fd_get_poll_events( fd ) & POLLIN))
 274     {
 275         serial->read_timer = add_timeout_user( (timeout_t)serial->timeouts.ReadIntervalTimeout * -10000,
 276                                                serial_read_timeout, serial );
 277     }
 278     default_fd_reselect_async( fd, queue );
 279 }
 280
 281 DECL_HANDLER(get_serial_info)
 282 {
 283     struct serial *serial;
 284
 285     if ((serial = get_serial_obj( current->process, req->handle, 0 )))
 286     {
 287         if (req->flags & SERIALINFO_PENDING_WAIT)
 288         {
 289             if (serial->pending_wait)
 290             {
 291                 release_object( serial );
 292                 set_error( STATUS_INVALID_PARAMETER );
 293                 return;
 294             }
 295             serial->pending_wait = 1;
 296         }
 297
 298         /* event mask */
 299         reply->eventmask    = serial->eventmask;
 300         reply->cookie       = serial->generation;
 301
 302         /* pending write */
 303         reply->pending_write = serial->pending_write;
 304         if (req->flags & SERIALINFO_PENDING_WRITE)
 305             serial->pending_write = 0;
 306
 307         release_object( serial );
 308     }
 309 }
 310
 311 DECL_HANDLER(set_serial_info)
 312 {
 313     struct serial *serial;
 314
 315     if ((serial = get_serial_obj( current->process, req->handle, 0 )))
 316     {
 317         if (req->flags & SERIALINFO_PENDING_WAIT)
 318         {
 319             if (!serial->pending_wait)
 320             {
 321                 release_object( serial );
 322                 set_error( STATUS_INVALID_PARAMETER );
 323                 return;
 324             }
 325             serial->pending_wait = 0;
 326         }
 327
 328         /* pending write */
 329         if (req->flags & SERIALINFO_PENDING_WRITE)
 330             serial->pending_write = 1;
 331
 332         release_object( serial );
 333     }
 334 }