2 * Server-side serial port communications management
4 * Copyright (C) 1998 Alexandre Julliard
5 * Copyright (C) 2000,2001 Mike McCormack
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.
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.
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
24 #include "wine/port.h"
33 #include <sys/types.h>
42 #ifdef HAVE_SYS_IOCTL_H
43 #include <sys/ioctl.h>
50 #define WIN32_NO_STATUS
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
);
64 static int serial_get_poll_events( struct fd
*fd
);
65 static void serial_poll_event( struct fd
*fd
, int event
);
66 static enum server_fd_type
serial_get_info( struct fd
*fd
, int *flags
);
67 static int serial_flush( struct fd
*fd
, struct event
**event
);
68 static void serial_queue_async( struct fd
*fd
, const async_data_t
*data
, int type
, int count
);
69 static void serial_cancel_async( struct fd
*fd
);
78 unsigned int readinterval
;
79 unsigned int readconst
;
80 unsigned int readmult
;
81 unsigned int writeconst
;
82 unsigned int writemult
;
84 unsigned int eventmask
;
86 struct termios original
;
92 /* FIXME: add dcb, comm status, handler module, sharing */
95 static const struct object_ops serial_ops
=
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 fd_close_handle
, /* close_handle */
108 serial_destroy
/* destroy */
111 static const struct fd_ops serial_fd_ops
=
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 */
121 /* check if the given fd is a serial port */
122 int is_serial_fd( struct fd
*fd
)
126 return !tcgetattr( get_unix_fd(fd
), &tios
);
129 /* create a serial object for a given fd */
130 struct object
*create_serial( struct fd
*fd
, unsigned int options
)
132 struct serial
*serial
;
133 int unix_fd
= get_unix_fd( fd
);
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 );
139 if (!(serial
= alloc_object( &serial_ops
))) return NULL
;
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
);
156 static struct fd
*serial_get_fd( struct object
*obj
)
158 struct serial
*serial
= (struct serial
*)obj
;
159 return (struct fd
*)grab_object( serial
->fd
);
162 static unsigned int serial_map_access( struct object
*obj
, unsigned int access
)
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
);
171 static void serial_destroy( struct object
*obj
)
173 struct serial
*serial
= (struct serial
*)obj
;
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
);
181 static void serial_dump( struct object
*obj
, int verbose
)
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
);
188 static struct serial
*get_serial_obj( struct process
*process
, obj_handle_t handle
, unsigned int access
)
190 return (struct serial
*)get_handle_obj( process
, handle
, access
, &serial_ops
);
193 static int serial_get_poll_events( struct fd
*fd
)
195 struct serial
*serial
= get_fd_user( fd
);
197 assert( serial
->obj
.ops
== &serial_ops
);
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
;
203 /* fprintf(stderr,"poll events are %04x\n",events); */
208 static enum server_fd_type
serial_get_info( struct fd
*fd
, int *flags
)
210 struct serial
*serial
= get_fd_user( fd
);
211 assert( serial
->obj
.ops
== &serial_ops
);
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
;
223 return FD_TYPE_SERIAL
;
226 static void serial_poll_event(struct fd
*fd
, int event
)
228 struct serial
*serial
= get_fd_user( fd
);
230 /* fprintf(stderr,"Poll event %02x\n",event); */
232 if (!list_empty( &serial
->read_q
) && (POLLIN
& event
) )
233 async_terminate_head( &serial
->read_q
, STATUS_ALERTED
);
235 if (!list_empty( &serial
->write_q
) && (POLLOUT
& event
) )
236 async_terminate_head( &serial
->write_q
, STATUS_ALERTED
);
238 if (!list_empty( &serial
->wait_q
) && (POLLIN
& event
) )
239 async_terminate_head( &serial
->wait_q
, STATUS_ALERTED
);
241 set_fd_events( fd
, serial_get_poll_events(fd
) );
244 static void serial_queue_async( struct fd
*fd
, const async_data_t
*data
, int type
, int count
)
246 struct serial
*serial
= get_fd_user( fd
);
248 struct timeval when
= current_time
;
252 assert(serial
->obj
.ops
== &serial_ops
);
256 case ASYNC_TYPE_READ
:
257 queue
= &serial
->read_q
;
258 timeout
= serial
->readconst
+ serial
->readmult
*count
;
260 case ASYNC_TYPE_WAIT
:
261 queue
= &serial
->wait_q
;
264 case ASYNC_TYPE_WRITE
:
265 queue
= &serial
->write_q
;
266 timeout
= serial
->writeconst
+ serial
->writemult
*count
;
269 set_error(STATUS_INVALID_PARAMETER
);
273 add_timeout( &when
, timeout
);
274 if (!create_async( current
, timeout
? &when
: NULL
, queue
, data
)) return;
276 /* Check if the new pending request can be served immediately */
277 events
= check_fd_events( fd
, serial_get_poll_events( fd
) );
280 /* serial_poll_event() calls set_select_events() */
281 serial_poll_event( fd
, events
);
285 set_fd_events( fd
, serial_get_poll_events( fd
) );
288 static void serial_cancel_async( struct fd
*fd
)
290 struct serial
*serial
= get_fd_user( fd
);
291 assert(serial
->obj
.ops
== &serial_ops
);
293 async_terminate_queue( &serial
->read_q
, STATUS_CANCELLED
);
294 async_terminate_queue( &serial
->write_q
, STATUS_CANCELLED
);
295 async_terminate_queue( &serial
->wait_q
, STATUS_CANCELLED
);
298 static int serial_flush( struct fd
*fd
, struct event
**event
)
300 /* MSDN says: If hFile is a handle to a communications device,
301 * the function only flushes the transmit buffer.
303 int ret
= (tcflush( get_unix_fd(fd
), TCOFLUSH
) != -1);
304 if (!ret
) file_set_error();
308 DECL_HANDLER(get_serial_info
)
310 struct serial
*serial
;
312 if ((serial
= get_serial_obj( current
->process
, req
->handle
, 0 )))
315 reply
->readinterval
= serial
->readinterval
;
316 reply
->readconst
= serial
->readconst
;
317 reply
->readmult
= serial
->readmult
;
318 reply
->writeconst
= serial
->writeconst
;
319 reply
->writemult
= serial
->writemult
;
322 reply
->eventmask
= serial
->eventmask
;
324 release_object( serial
);
328 DECL_HANDLER(set_serial_info
)
330 struct serial
*serial
;
332 if ((serial
= get_serial_obj( current
->process
, req
->handle
, 0 )))
335 if (req
->flags
& SERIALINFO_SET_TIMEOUTS
)
337 serial
->readinterval
= req
->readinterval
;
338 serial
->readconst
= req
->readconst
;
339 serial
->readmult
= req
->readmult
;
340 serial
->writeconst
= req
->writeconst
;
341 serial
->writemult
= req
->writemult
;
345 if (req
->flags
& SERIALINFO_SET_MASK
)
347 serial
->eventmask
= req
->eventmask
;
348 if (!serial
->eventmask
)
350 async_terminate_queue( &serial
->wait_q
, STATUS_SUCCESS
);
354 release_object( serial
);