serial.c 10.3 KB
Newer Older
1 2 3 4
/*
 * Server-side serial port communications management
 *
 * Copyright (C) 1998 Alexandre Julliard
5
 * Copyright (C) 2000,2001 Mike McCormack
6
 *
7 8 9 10 11 12 13 14 15 16 17 18 19 20
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * 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 27

#include <assert.h>
#include <fcntl.h>
28
#include <stdarg.h>
29 30 31 32 33 34 35
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <sys/time.h>
#include <sys/types.h>
#include <time.h>
#include <unistd.h>
Steven Edwards's avatar
Steven Edwards committed
36
#ifdef HAVE_UTIME_H
37
#include <utime.h>
Steven Edwards's avatar
Steven Edwards committed
38 39
#endif
#ifdef HAVE_TERMIOS_H
40
#include <termios.h>
Steven Edwards's avatar
Steven Edwards committed
41 42
#endif
#ifdef HAVE_SYS_IOCTL_H
43
#include <sys/ioctl.h>
Steven Edwards's avatar
Steven Edwards committed
44
#endif
45 46 47
#ifdef HAVE_POLL_H
#include <poll.h>
#endif
48 49

#include "winerror.h"
50
#include "windef.h"
51
#include "winbase.h"
52 53
#include "winreg.h"
#include "winternl.h"
54

55
#include "file.h"
56 57 58 59 60
#include "handle.h"
#include "thread.h"
#include "request.h"

static void serial_dump( struct object *obj, int verbose );
61
static struct fd *serial_get_fd( struct object *obj );
62 63 64 65
static void serial_destroy(struct object *obj);

static int serial_get_poll_events( struct fd *fd );
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 69
static void serial_queue_async( struct fd *fd, void *apc, void *user, void *iosb, int type, int count );
static void serial_cancel_async( struct fd *fd );
70 71 72 73

struct serial
{
    struct object       obj;
74
    struct fd          *fd;
75
    unsigned int        options;
76 77 78 79 80 81 82 83 84 85 86 87 88

    /* timeout values */
    unsigned int        readinterval;
    unsigned int        readconst;
    unsigned int        readmult;
    unsigned int        writeconst;
    unsigned int        writemult;

    unsigned int        eventmask;
    unsigned int        commerror;

    struct termios      original;

89 90 91
    struct list         read_q;
    struct list         write_q;
    struct list         wait_q;
92

93 94 95 96 97 98 99
    /* FIXME: add dcb, comm status, handler module, sharing */
};

static const struct object_ops serial_ops =
{
    sizeof(struct serial),        /* size */
    serial_dump,                  /* dump */
100 101 102
    default_fd_add_queue,         /* add_queue */
    default_fd_remove_queue,      /* remove_queue */
    default_fd_signaled,          /* signaled */
103
    no_satisfied,                 /* satisfied */
104
    serial_get_fd,                /* get_fd */
105
    serial_destroy                /* destroy */
106 107 108 109
};

static const struct fd_ops serial_fd_ops =
{
110
    serial_get_poll_events,       /* get_poll_events */
111
    serial_poll_event,            /* poll_event */
112
    serial_flush,                 /* flush */
113
    serial_get_info,              /* get_file_info */
114 115
    serial_queue_async,           /* queue_async */
    serial_cancel_async           /* cancel_async */
116 117
};

118 119
/* check if the given fd is a serial port */
int is_serial_fd( struct fd *fd )
120
{
121 122
    struct termios tios;

123 124
    return !tcgetattr( get_unix_fd(fd), &tios );
}
125

126 127 128 129 130
/* create a serial object for a given fd */
struct object *create_serial( struct fd *fd, unsigned int options )
{
    struct serial *serial;
    int unix_fd;
131

132
    if ((unix_fd = dup( get_unix_fd(fd) )) == -1) return NULL;
133

134
    /* set the fd back to blocking if necessary */
135 136
    if (options & (FILE_SYNCHRONOUS_IO_ALERT | FILE_SYNCHRONOUS_IO_NONALERT))
        fcntl( unix_fd, F_SETFL, 0 );
137

138
    if (!(serial = alloc_object( &serial_ops )))
139
    {
140
        close( unix_fd );
141 142
        return NULL;
    }
143
    serial->options      = options;
144 145 146 147 148 149 150
    serial->readinterval = 0;
    serial->readmult     = 0;
    serial->readconst    = 0;
    serial->writemult    = 0;
    serial->writeconst   = 0;
    serial->eventmask    = 0;
    serial->commerror    = 0;
151 152 153
    list_init( &serial->read_q );
    list_init( &serial->write_q );
    list_init( &serial->wait_q );
154
    if (!(serial->fd = create_anonymous_fd( &serial_fd_ops, unix_fd, &serial->obj )))
155 156 157
    {
        release_object( serial );
        return NULL;
158
    }
159
    return &serial->obj;
160 161
}

162 163 164 165 166 167
static struct fd *serial_get_fd( struct object *obj )
{
    struct serial *serial = (struct serial *)obj;
    return (struct fd *)grab_object( serial->fd );
}

168
static void serial_destroy( struct object *obj)
169 170 171
{
    struct serial *serial = (struct serial *)obj;

172 173 174
    async_terminate_queue( &serial->read_q, STATUS_CANCELLED );
    async_terminate_queue( &serial->write_q, STATUS_CANCELLED );
    async_terminate_queue( &serial->wait_q, STATUS_CANCELLED );
175
    if (serial->fd) release_object( serial->fd );
176 177
}

178
static void serial_dump( struct object *obj, int verbose )
179
{
180
    struct serial *serial = (struct serial *)obj;
181
    assert( obj->ops == &serial_ops );
182
    fprintf( stderr, "Port fd=%p mask=%x\n", serial->fd, serial->eventmask );
183 184
}

185
static struct serial *get_serial_obj( struct process *process, obj_handle_t handle, unsigned int access )
186 187 188 189
{
    return (struct serial *)get_handle_obj( process, handle, access, &serial_ops );
}

190
static int serial_get_poll_events( struct fd *fd )
191
{
192
    struct serial *serial = get_fd_user( fd );
193
    int events = 0;
194
    assert( serial->obj.ops == &serial_ops );
195

196 197 198
    if (!list_empty( &serial->read_q ))  events |= POLLIN;
    if (!list_empty( &serial->write_q )) events |= POLLOUT;
    if (!list_empty( &serial->wait_q ))  events |= POLLIN;
199 200 201

    /* fprintf(stderr,"poll events are %04x\n",events); */

202 203 204
    return events;
}

205
static int serial_get_info( struct fd *fd )
206
{
207
    int flags = 0;
208 209
    struct serial *serial = get_fd_user( fd );
    assert( serial->obj.ops == &serial_ops );
210

211
    if (!(serial->options & (FILE_SYNCHRONOUS_IO_ALERT | FILE_SYNCHRONOUS_IO_NONALERT)))
212
        flags |= FD_FLAG_OVERLAPPED;
213 214
    else if (!(serial->readinterval == MAXDWORD &&
               serial->readmult == 0 && serial->readconst == 0))
215 216
        flags |= FD_FLAG_TIMEOUT;
    if (serial->readinterval == MAXDWORD &&
217
        serial->readmult == 0 && serial->readconst == 0)
218
        flags |= FD_FLAG_AVAILABLE;
219

220
    return flags;
221 222
}

223
static void serial_poll_event(struct fd *fd, int event)
224
{
225
    struct serial *serial = get_fd_user( fd );
226 227 228

    /* fprintf(stderr,"Poll event %02x\n",event); */

229 230
    if (!list_empty( &serial->read_q ) && (POLLIN & event) )
        async_terminate_head( &serial->read_q, STATUS_ALERTED );
231

232 233
    if (!list_empty( &serial->write_q ) && (POLLOUT & event) )
        async_terminate_head( &serial->write_q, STATUS_ALERTED );
234

235 236
    if (!list_empty( &serial->wait_q ) && (POLLIN & event) )
        async_terminate_head( &serial->wait_q, STATUS_ALERTED );
237

238
    set_fd_events( fd, serial_get_poll_events(fd) );
239 240
}

241 242
static void serial_queue_async( struct fd *fd, void *apc, void *user, void *iosb,
                                int type, int count )
243
{
244
    struct serial *serial = get_fd_user( fd );
245
    struct list *queue;
246
    int timeout;
247
    int events;
248

249
    assert(serial->obj.ops == &serial_ops);
250

251
    switch (type)
252 253
    {
    case ASYNC_TYPE_READ:
254
        queue = &serial->read_q;
255 256 257
        timeout = serial->readconst + serial->readmult*count;
        break;
    case ASYNC_TYPE_WAIT:
258
        queue = &serial->wait_q;
259 260
        timeout = 0;
        break;
261
    case ASYNC_TYPE_WRITE:
262
        queue = &serial->write_q;
263 264 265 266
        timeout = serial->writeconst + serial->writemult*count;
        break;
    default:
        set_error(STATUS_INVALID_PARAMETER);
267
        return;
268 269
    }

270
    if (!create_async( fd, current, timeout, queue, apc, user, iosb ))
271
        return;
272

273 274 275
    /* Check if the new pending request can be served immediately */
    events = check_fd_events( fd, serial_get_poll_events( fd ) );
    if (events)
276
    {
277 278 279 280
        /* serial_poll_event() calls set_select_events() */
        serial_poll_event( fd, events );
        return;
    }
281

282 283
    set_fd_events( fd, serial_get_poll_events( fd ) );
}
284

285 286 287 288
static void serial_cancel_async( struct fd *fd )
{
    struct serial *serial = get_fd_user( fd );
    assert(serial->obj.ops == &serial_ops);
289

290 291 292
    async_terminate_queue( &serial->read_q, STATUS_CANCELLED );
    async_terminate_queue( &serial->write_q, STATUS_CANCELLED );
    async_terminate_queue( &serial->wait_q, STATUS_CANCELLED );
293
}
294

295
static int serial_flush( struct fd *fd, struct event **event )
296 297 298 299
{
    /* MSDN says: If hFile is a handle to a communications device,
     * the function only flushes the transmit buffer.
     */
300
    int ret = (tcflush( get_unix_fd(fd), TCOFLUSH ) != -1);
301 302 303 304
    if (!ret) file_set_error();
    return ret;
}

305 306 307 308 309 310 311
DECL_HANDLER(get_serial_info)
{
    struct serial *serial;

    if ((serial = get_serial_obj( current->process, req->handle, 0 )))
    {
        /* timeouts */
312 313 314 315 316
        reply->readinterval = serial->readinterval;
        reply->readconst    = serial->readconst;
        reply->readmult     = serial->readmult;
        reply->writeconst   = serial->writeconst;
        reply->writemult    = serial->writemult;
317 318

        /* event mask */
319
        reply->eventmask    = serial->eventmask;
320 321

        /* comm port error status */
322
        reply->commerror    = serial->commerror;
323 324 325 326 327 328 329 330 331 332 333 334

        release_object( serial );
    }
}

DECL_HANDLER(set_serial_info)
{
    struct serial *serial;

    if ((serial = get_serial_obj( current->process, req->handle, 0 )))
    {
        /* timeouts */
335
        if (req->flags & SERIALINFO_SET_TIMEOUTS)
336 337 338 339 340 341 342 343 344
        {
            serial->readinterval = req->readinterval;
            serial->readconst    = req->readconst;
            serial->readmult     = req->readmult;
            serial->writeconst   = req->writeconst;
            serial->writemult    = req->writemult;
        }

        /* event mask */
345
        if (req->flags & SERIALINFO_SET_MASK)
346 347
        {
            serial->eventmask = req->eventmask;
348
            if (!serial->eventmask)
349
            {
350
                async_terminate_queue( &serial->wait_q, STATUS_SUCCESS );
351
            }
352 353 354
        }

        /* comm port error status */
355
        if (req->flags & SERIALINFO_SET_ERROR)
356 357 358 359 360 361 362
        {
            serial->commerror = req->commerror;
        }

        release_object( serial );
    }
}