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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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 int serial_get_poll_events( struct fd *fd );
  65 static void serial_poll_event( struct fd *fd, int event );
  66 static int serial_get_info( struct fd *fd );
  67 static int serial_flush( struct fd *fd, struct event **event );
  68 static void serial_queue_async( struct fd *fd, void *apc, void *user, void *iosb, int type, int count );
  69 static void serial_cancel_async( struct fd *fd );
  70
  71 struct serial
  72 {
  73     struct object       obj;
  74     struct fd          *fd;
  75     unsigned int        options;
  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        commerror;
  86
  87     struct termios      original;
  88
  89     struct list         read_q;
  90     struct list         write_q;
  91     struct list         wait_q;
  92
  93     /* FIXME: add dcb, comm status, handler module, sharing */
  94 };
  95
  96 static const struct object_ops serial_ops =
  97 {
  98     sizeof(struct serial),        /* size */
  99     serial_dump,                  /* dump */
 100     default_fd_add_queue,         /* add_queue */
 101     default_fd_remove_queue,      /* remove_queue */
 102     default_fd_signaled,          /* signaled */
 103     no_satisfied,                 /* satisfied */
 104     no_signal,                    /* signal */
 105     serial_get_fd,                /* get_fd */
 106     serial_map_access,            /* map_access */
 107     no_lookup_name,               /* lookup_name */
 108     no_close_handle,              /* close_handle */
 109     serial_destroy                /* destroy */
 110 };
 111
 112 static const struct fd_ops serial_fd_ops =
 113 {
 114     serial_get_poll_events,       /* get_poll_events */
 115     serial_poll_event,            /* poll_event */
 116     serial_flush,                 /* flush */
 117     serial_get_info,              /* get_file_info */
 118     serial_queue_async,           /* queue_async */
 119     serial_cancel_async           /* cancel_async */
 120 };
 121
 122 /* check if the given fd is a serial port */
 123 int is_serial_fd( struct fd *fd )
 124 {
 125     struct termios tios;
 126
 127     return !tcgetattr( get_unix_fd(fd), &tios );
 128 }
 129
 130 /* create a serial object for a given fd */
 131 struct object *create_serial( struct fd *fd, unsigned int options )
 132 {
 133     struct serial *serial;
 134     int unix_fd;
 135
 136     if ((unix_fd = dup( get_unix_fd(fd) )) == -1) return NULL;
 137
 138     /* set the fd back to blocking if necessary */
 139     if (options & (FILE_SYNCHRONOUS_IO_ALERT | FILE_SYNCHRONOUS_IO_NONALERT))
 140         fcntl( unix_fd, F_SETFL, 0 );
 141
 142     if (!(serial = alloc_object( &serial_ops )))
 143     {
 144         close( unix_fd );
 145         return NULL;
 146     }
 147     serial->options      = options;
 148     serial->readinterval = 0;
 149     serial->readmult     = 0;
 150     serial->readconst    = 0;
 151     serial->writemult    = 0;
 152     serial->writeconst   = 0;
 153     serial->eventmask    = 0;
 154     serial->commerror    = 0;
 155     list_init( &serial->read_q );
 156     list_init( &serial->write_q );
 157     list_init( &serial->wait_q );
 158     if (!(serial->fd = create_anonymous_fd( &serial_fd_ops, unix_fd, &serial->obj )))
 159     {
 160         release_object( serial );
 161         return NULL;
 162     }
 163     return &serial->obj;
 164 }
 165
 166 static struct fd *serial_get_fd( struct object *obj )
 167 {
 168     struct serial *serial = (struct serial *)obj;
 169     return (struct fd *)grab_object( serial->fd );
 170 }
 171
 172 static unsigned int serial_map_access( struct object *obj, unsigned int access )
 173 {
 174     if (access & GENERIC_READ)    access |= FILE_GENERIC_READ;
 175     if (access & GENERIC_WRITE)   access |= FILE_GENERIC_WRITE;
 176     if (access & GENERIC_EXECUTE) access |= FILE_GENERIC_EXECUTE;
 177     if (access & GENERIC_ALL)     access |= FILE_ALL_ACCESS;
 178     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
 179 }
 180
 181 static void serial_destroy( struct object *obj)
 182 {
 183     struct serial *serial = (struct serial *)obj;
 184
 185     async_terminate_queue( &serial->read_q, STATUS_CANCELLED );
 186     async_terminate_queue( &serial->write_q, STATUS_CANCELLED );
 187     async_terminate_queue( &serial->wait_q, STATUS_CANCELLED );
 188     if (serial->fd) release_object( serial->fd );
 189 }
 190
 191 static void serial_dump( struct object *obj, int verbose )
 192 {
 193     struct serial *serial = (struct serial *)obj;
 194     assert( obj->ops == &serial_ops );
 195     fprintf( stderr, "Port fd=%p mask=%x\n", serial->fd, serial->eventmask );
 196 }
 197
 198 static struct serial *get_serial_obj( struct process *process, obj_handle_t handle, unsigned int access )
 199 {
 200     return (struct serial *)get_handle_obj( process, handle, access, &serial_ops );
 201 }
 202
 203 static int serial_get_poll_events( struct fd *fd )
 204 {
 205     struct serial *serial = get_fd_user( fd );
 206     int events = 0;
 207     assert( serial->obj.ops == &serial_ops );
 208
 209     if (!list_empty( &serial->read_q ))  events |= POLLIN;
 210     if (!list_empty( &serial->write_q )) events |= POLLOUT;
 211     if (!list_empty( &serial->wait_q ))  events |= POLLIN;
 212
 213     /* fprintf(stderr,"poll events are %04x\n",events); */
 214
 215     return events;
 216 }
 217
 218 static int serial_get_info( struct fd *fd )
 219 {
 220     int flags = 0;
 221     struct serial *serial = get_fd_user( fd );
 222     assert( serial->obj.ops == &serial_ops );
 223
 224     if (!(serial->options & (FILE_SYNCHRONOUS_IO_ALERT | FILE_SYNCHRONOUS_IO_NONALERT)))
 225         flags |= FD_FLAG_OVERLAPPED;
 226     else if (!(serial->readinterval == MAXDWORD &&
 227                serial->readmult == 0 && serial->readconst == 0))
 228         flags |= FD_FLAG_TIMEOUT;
 229     if (serial->readinterval == MAXDWORD &&
 230         serial->readmult == 0 && serial->readconst == 0)
 231         flags |= FD_FLAG_AVAILABLE;
 232
 233     return flags;
 234 }
 235
 236 static void serial_poll_event(struct fd *fd, int event)
 237 {
 238     struct serial *serial = get_fd_user( fd );
 239
 240     /* fprintf(stderr,"Poll event %02x\n",event); */
 241
 242     if (!list_empty( &serial->read_q ) && (POLLIN & event) )
 243         async_terminate_head( &serial->read_q, STATUS_ALERTED );
 244
 245     if (!list_empty( &serial->write_q ) && (POLLOUT & event) )
 246         async_terminate_head( &serial->write_q, STATUS_ALERTED );
 247
 248     if (!list_empty( &serial->wait_q ) && (POLLIN & event) )
 249         async_terminate_head( &serial->wait_q, STATUS_ALERTED );
 250
 251     set_fd_events( fd, serial_get_poll_events(fd) );
 252 }
 253
 254 static void serial_queue_async( struct fd *fd, void *apc, void *user, void *iosb,
 255                                 int type, int count )
 256 {
 257     struct serial *serial = get_fd_user( fd );
 258     struct list *queue;
 259     int timeout;
 260     int events;
 261
 262     assert(serial->obj.ops == &serial_ops);
 263
 264     switch (type)
 265     {
 266     case ASYNC_TYPE_READ:
 267         queue = &serial->read_q;
 268         timeout = serial->readconst + serial->readmult*count;
 269         break;
 270     case ASYNC_TYPE_WAIT:
 271         queue = &serial->wait_q;
 272         timeout = 0;
 273         break;
 274     case ASYNC_TYPE_WRITE:
 275         queue = &serial->write_q;
 276         timeout = serial->writeconst + serial->writemult*count;
 277         break;
 278     default:
 279         set_error(STATUS_INVALID_PARAMETER);
 280         return;
 281     }
 282
 283     if (!create_async( current, &timeout, queue, apc, user, iosb ))
 284         return;
 285
 286     /* Check if the new pending request can be served immediately */
 287     events = check_fd_events( fd, serial_get_poll_events( fd ) );
 288     if (events)
 289     {
 290         /* serial_poll_event() calls set_select_events() */
 291         serial_poll_event( fd, events );
 292         return;
 293     }
 294
 295     set_fd_events( fd, serial_get_poll_events( fd ) );
 296 }
 297
 298 static void serial_cancel_async( struct fd *fd )
 299 {
 300     struct serial *serial = get_fd_user( fd );
 301     assert(serial->obj.ops == &serial_ops);
 302
 303     async_terminate_queue( &serial->read_q, STATUS_CANCELLED );
 304     async_terminate_queue( &serial->write_q, STATUS_CANCELLED );
 305     async_terminate_queue( &serial->wait_q, STATUS_CANCELLED );
 306 }
 307
 308 static int serial_flush( struct fd *fd, struct event **event )
 309 {
 310     /* MSDN says: If hFile is a handle to a communications device,
 311      * the function only flushes the transmit buffer.
 312      */
 313     int ret = (tcflush( get_unix_fd(fd), TCOFLUSH ) != -1);
 314     if (!ret) file_set_error();
 315     return ret;
 316 }
 317
 318 DECL_HANDLER(get_serial_info)
 319 {
 320     struct serial *serial;
 321
 322     if ((serial = get_serial_obj( current->process, req->handle, 0 )))
 323     {
 324         /* timeouts */
 325         reply->readinterval = serial->readinterval;
 326         reply->readconst    = serial->readconst;
 327         reply->readmult     = serial->readmult;
 328         reply->writeconst   = serial->writeconst;
 329         reply->writemult    = serial->writemult;
 330
 331         /* event mask */
 332         reply->eventmask    = serial->eventmask;
 333
 334         /* comm port error status */
 335         reply->commerror    = serial->commerror;
 336
 337         release_object( serial );
 338     }
 339 }
 340
 341 DECL_HANDLER(set_serial_info)
 342 {
 343     struct serial *serial;
 344
 345     if ((serial = get_serial_obj( current->process, req->handle, 0 )))
 346     {
 347         /* timeouts */
 348         if (req->flags & SERIALINFO_SET_TIMEOUTS)
 349         {
 350             serial->readinterval = req->readinterval;
 351             serial->readconst    = req->readconst;
 352             serial->readmult     = req->readmult;
 353             serial->writeconst   = req->writeconst;
 354             serial->writemult    = req->writemult;
 355         }
 356
 357         /* event mask */
 358         if (req->flags & SERIALINFO_SET_MASK)
 359         {
 360             serial->eventmask = req->eventmask;
 361             if (!serial->eventmask)
 362             {
 363                 async_terminate_queue( &serial->wait_q, STATUS_SUCCESS );
 364             }
 365         }
 366
 367         /* comm port error status */
 368         if (req->flags & SERIALINFO_SET_ERROR)
 369         {
 370             serial->commerror = req->commerror;
 371         }
 372
 373         release_object( serial );
 374     }
 375 }