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