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