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