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 unsigned int serial_map_access( struct object *obj, unsigned int access );
  62 static void serial_destroy(struct object *obj);
  63
  64 static enum server_fd_type serial_get_fd_type( struct fd *fd );
  65 static void serial_flush( struct fd *fd, struct event **event );
  66 static void serial_queue_async( struct fd *fd, const async_data_t *data, int type, int count );
  67
  68 struct serial
  69 {
  70     struct object       obj;
  71     struct fd          *fd;
  72
  73     /* timeout values */
  74     unsigned int        readinterval;
  75     unsigned int        readconst;
  76     unsigned int        readmult;
  77     unsigned int        writeconst;
  78     unsigned int        writemult;
  79
  80     unsigned int        eventmask;
  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     add_queue,                    /* add_queue */
  92     remove_queue,                 /* remove_queue */
  93     default_fd_signaled,          /* signaled */
  94     no_satisfied,                 /* satisfied */
  95     no_signal,                    /* signal */
  96     serial_get_fd,                /* get_fd */
  97     serial_map_access,            /* map_access */
  98     no_lookup_name,               /* lookup_name */
  99     no_open_file,                 /* open_file */
 100     fd_close_handle,              /* close_handle */
 101     serial_destroy                /* destroy */
 102 };
 103
 104 static const struct fd_ops serial_fd_ops =
 105 {
 106     default_fd_get_poll_events,   /* get_poll_events */
 107     default_poll_event,           /* poll_event */
 108     serial_flush,                 /* flush */
 109     serial_get_fd_type,           /* get_file_info */
 110     serial_queue_async,           /* queue_async */
 111     default_fd_reselect_async,    /* reselect_async */
 112     default_fd_cancel_async       /* cancel_async */
 113 };
 114
 115 /* check if the given fd is a serial port */
 116 int is_serial_fd( struct fd *fd )
 117 {
 118     struct termios tios;
 119
 120     return !tcgetattr( get_unix_fd(fd), &tios );
 121 }
 122
 123 /* create a serial object for a given fd */
 124 struct object *create_serial( struct fd *fd )
 125 {
 126     struct serial *serial;
 127
 128     if (!(serial = alloc_object( &serial_ops ))) return NULL;
 129
 130     serial->readinterval = 0;
 131     serial->readmult     = 0;
 132     serial->readconst    = 0;
 133     serial->writemult    = 0;
 134     serial->writeconst   = 0;
 135     serial->eventmask    = 0;
 136     serial->fd = (struct fd *)grab_object( fd );
 137     set_fd_user( fd, &serial_fd_ops, &serial->obj );
 138     return &serial->obj;
 139 }
 140
 141 static struct fd *serial_get_fd( struct object *obj )
 142 {
 143     struct serial *serial = (struct serial *)obj;
 144     return (struct fd *)grab_object( serial->fd );
 145 }
 146
 147 static unsigned int serial_map_access( struct object *obj, unsigned int access )
 148 {
 149     if (access & GENERIC_READ)    access |= FILE_GENERIC_READ;
 150     if (access & GENERIC_WRITE)   access |= FILE_GENERIC_WRITE;
 151     if (access & GENERIC_EXECUTE) access |= FILE_GENERIC_EXECUTE;
 152     if (access & GENERIC_ALL)     access |= FILE_ALL_ACCESS;
 153     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
 154 }
 155
 156 static void serial_destroy( struct object *obj)
 157 {
 158     struct serial *serial = (struct serial *)obj;
 159     release_object( serial->fd );
 160 }
 161
 162 static void serial_dump( struct object *obj, int verbose )
 163 {
 164     struct serial *serial = (struct serial *)obj;
 165     assert( obj->ops == &serial_ops );
 166     fprintf( stderr, "Port fd=%p mask=%x\n", serial->fd, serial->eventmask );
 167 }
 168
 169 static struct serial *get_serial_obj( struct process *process, obj_handle_t handle, unsigned int access )
 170 {
 171     return (struct serial *)get_handle_obj( process, handle, access, &serial_ops );
 172 }
 173
 174 static enum server_fd_type serial_get_fd_type( struct fd *fd )
 175 {
 176     return FD_TYPE_SERIAL;
 177 }
 178
 179 static void serial_queue_async( struct fd *fd, const async_data_t *data, int type, int count )
 180 {
 181     struct serial *serial = get_fd_user( fd );
 182     int timeout = 0;
 183     struct async *async;
 184
 185     assert(serial->obj.ops == &serial_ops);
 186
 187     switch (type)
 188     {
 189     case ASYNC_TYPE_READ:
 190         timeout = serial->readconst + serial->readmult*count;
 191         break;
 192     case ASYNC_TYPE_WRITE:
 193         timeout = serial->writeconst + serial->writemult*count;
 194         break;
 195     }
 196
 197     if ((async = fd_queue_async( fd, data, type, count )))
 198     {
 199         if (timeout)
 200         {
 201             struct timeval when = current_time;
 202             add_timeout( &when, timeout );
 203             async_set_timeout( async, &when, STATUS_TIMEOUT );
 204         }
 205         release_object( async );
 206         set_error( STATUS_PENDING );
 207     }
 208 }
 209
 210 static void serial_flush( struct fd *fd, struct event **event )
 211 {
 212     /* MSDN says: If hFile is a handle to a communications device,
 213      * the function only flushes the transmit buffer.
 214      */
 215     if (tcflush( get_unix_fd(fd), TCOFLUSH ) == -1) file_set_error();
 216 }
 217
 218 DECL_HANDLER(get_serial_info)
 219 {
 220     struct serial *serial;
 221
 222     if ((serial = get_serial_obj( current->process, req->handle, 0 )))
 223     {
 224         /* timeouts */
 225         reply->readinterval = serial->readinterval;
 226         reply->readconst    = serial->readconst;
 227         reply->readmult     = serial->readmult;
 228         reply->writeconst   = serial->writeconst;
 229         reply->writemult    = serial->writemult;
 230
 231         /* event mask */
 232         reply->eventmask    = serial->eventmask;
 233
 234         release_object( serial );
 235     }
 236 }
 237
 238 DECL_HANDLER(set_serial_info)
 239 {
 240     struct serial *serial;
 241
 242     if ((serial = get_serial_obj( current->process, req->handle, 0 )))
 243     {
 244         /* timeouts */
 245         if (req->flags & SERIALINFO_SET_TIMEOUTS)
 246         {
 247             serial->readinterval = req->readinterval;
 248             serial->readconst    = req->readconst;
 249             serial->readmult     = req->readmult;
 250             serial->writeconst   = req->writeconst;
 251             serial->writemult    = req->writemult;
 252         }
 253
 254         /* event mask */
 255         if (req->flags & SERIALINFO_SET_MASK)
 256         {
 257             serial->eventmask = req->eventmask;
 258             if (!serial->eventmask)
 259             {
 260                 fd_async_wake_up( serial->fd, ASYNC_TYPE_WAIT, STATUS_SUCCESS );
 261             }
 262         }
 263
 264         release_object( serial );
 265     }
 266 }