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