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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include "wine/port.h"
33 #include <sys/types.h>
42 #ifdef HAVE_SYS_IOCTL_H
43 #include <sys/ioctl.h>
60 static void serial_dump( struct object
*obj
, int verbose
);
61 static struct fd
*serial_get_fd( struct object
*obj
);
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 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
);
78 unsigned int readinterval
;
79 unsigned int readconst
;
80 unsigned int readmult
;
81 unsigned int writeconst
;
82 unsigned int writemult
;
84 unsigned int eventmask
;
85 unsigned int commerror
;
87 struct termios original
;
93 /* FIXME: add dcb, comm status, handler module, sharing */
96 static const struct object_ops serial_ops
=
98 sizeof(struct serial
), /* size */
99 serial_dump
, /* dump */
100 default_fd_add_queue
, /* add_queue */
101 default_fd_remove_queue
, /* remove_queue */
102 default_fd_signaled
, /* signaled */
103 no_satisfied
, /* satisfied */
104 no_signal
, /* signal */
105 serial_get_fd
, /* get_fd */
106 serial_destroy
/* destroy */
109 static const struct fd_ops serial_fd_ops
=
111 serial_get_poll_events
, /* get_poll_events */
112 serial_poll_event
, /* poll_event */
113 serial_flush
, /* flush */
114 serial_get_info
, /* get_file_info */
115 serial_queue_async
, /* queue_async */
116 serial_cancel_async
/* cancel_async */
119 /* check if the given fd is a serial port */
120 int is_serial_fd( struct fd
*fd
)
124 return !tcgetattr( get_unix_fd(fd
), &tios
);
127 /* create a serial object for a given fd */
128 struct object
*create_serial( struct fd
*fd
, unsigned int options
)
130 struct serial
*serial
;
133 if ((unix_fd
= dup( get_unix_fd(fd
) )) == -1) return NULL
;
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
)))
144 serial
->options
= options
;
145 serial
->readinterval
= 0;
146 serial
->readmult
= 0;
147 serial
->readconst
= 0;
148 serial
->writemult
= 0;
149 serial
->writeconst
= 0;
150 serial
->eventmask
= 0;
151 serial
->commerror
= 0;
152 list_init( &serial
->read_q
);
153 list_init( &serial
->write_q
);
154 list_init( &serial
->wait_q
);
155 if (!(serial
->fd
= create_anonymous_fd( &serial_fd_ops
, unix_fd
, &serial
->obj
)))
157 release_object( serial
);
163 static struct fd
*serial_get_fd( struct object
*obj
)
165 struct serial
*serial
= (struct serial
*)obj
;
166 return (struct fd
*)grab_object( serial
->fd
);
169 static void serial_destroy( struct object
*obj
)
171 struct serial
*serial
= (struct serial
*)obj
;
173 async_terminate_queue( &serial
->read_q
, STATUS_CANCELLED
);
174 async_terminate_queue( &serial
->write_q
, STATUS_CANCELLED
);
175 async_terminate_queue( &serial
->wait_q
, STATUS_CANCELLED
);
176 if (serial
->fd
) release_object( serial
->fd
);
179 static void serial_dump( struct object
*obj
, int verbose
)
181 struct serial
*serial
= (struct serial
*)obj
;
182 assert( obj
->ops
== &serial_ops
);
183 fprintf( stderr
, "Port fd=%p mask=%x\n", serial
->fd
, serial
->eventmask
);
186 static struct serial
*get_serial_obj( struct process
*process
, obj_handle_t handle
, unsigned int access
)
188 return (struct serial
*)get_handle_obj( process
, handle
, access
, &serial_ops
);
191 static int serial_get_poll_events( struct fd
*fd
)
193 struct serial
*serial
= get_fd_user( fd
);
195 assert( serial
->obj
.ops
== &serial_ops
);
197 if (!list_empty( &serial
->read_q
)) events
|= POLLIN
;
198 if (!list_empty( &serial
->write_q
)) events
|= POLLOUT
;
199 if (!list_empty( &serial
->wait_q
)) events
|= POLLIN
;
201 /* fprintf(stderr,"poll events are %04x\n",events); */
206 static int serial_get_info( struct fd
*fd
)
209 struct serial
*serial
= get_fd_user( fd
);
210 assert( serial
->obj
.ops
== &serial_ops
);
212 if (!(serial
->options
& (FILE_SYNCHRONOUS_IO_ALERT
| FILE_SYNCHRONOUS_IO_NONALERT
)))
213 flags
|= FD_FLAG_OVERLAPPED
;
214 else if (!(serial
->readinterval
== MAXDWORD
&&
215 serial
->readmult
== 0 && serial
->readconst
== 0))
216 flags
|= FD_FLAG_TIMEOUT
;
217 if (serial
->readinterval
== MAXDWORD
&&
218 serial
->readmult
== 0 && serial
->readconst
== 0)
219 flags
|= FD_FLAG_AVAILABLE
;
224 static void serial_poll_event(struct fd
*fd
, int event
)
226 struct serial
*serial
= get_fd_user( fd
);
228 /* fprintf(stderr,"Poll event %02x\n",event); */
230 if (!list_empty( &serial
->read_q
) && (POLLIN
& event
) )
231 async_terminate_head( &serial
->read_q
, STATUS_ALERTED
);
233 if (!list_empty( &serial
->write_q
) && (POLLOUT
& event
) )
234 async_terminate_head( &serial
->write_q
, STATUS_ALERTED
);
236 if (!list_empty( &serial
->wait_q
) && (POLLIN
& event
) )
237 async_terminate_head( &serial
->wait_q
, STATUS_ALERTED
);
239 set_fd_events( fd
, serial_get_poll_events(fd
) );
242 static void serial_queue_async( struct fd
*fd
, void *apc
, void *user
, void *iosb
,
243 int type
, int count
)
245 struct serial
*serial
= get_fd_user( fd
);
250 assert(serial
->obj
.ops
== &serial_ops
);
254 case ASYNC_TYPE_READ
:
255 queue
= &serial
->read_q
;
256 timeout
= serial
->readconst
+ serial
->readmult
*count
;
258 case ASYNC_TYPE_WAIT
:
259 queue
= &serial
->wait_q
;
262 case ASYNC_TYPE_WRITE
:
263 queue
= &serial
->write_q
;
264 timeout
= serial
->writeconst
+ serial
->writemult
*count
;
267 set_error(STATUS_INVALID_PARAMETER
);
271 if (!create_async( current
, &timeout
, queue
, apc
, user
, iosb
))
274 /* Check if the new pending request can be served immediately */
275 events
= check_fd_events( fd
, serial_get_poll_events( fd
) );
278 /* serial_poll_event() calls set_select_events() */
279 serial_poll_event( fd
, events
);
283 set_fd_events( fd
, serial_get_poll_events( fd
) );
286 static void serial_cancel_async( struct fd
*fd
)
288 struct serial
*serial
= get_fd_user( fd
);
289 assert(serial
->obj
.ops
== &serial_ops
);
291 async_terminate_queue( &serial
->read_q
, STATUS_CANCELLED
);
292 async_terminate_queue( &serial
->write_q
, STATUS_CANCELLED
);
293 async_terminate_queue( &serial
->wait_q
, STATUS_CANCELLED
);
296 static int serial_flush( struct fd
*fd
, struct event
**event
)
298 /* MSDN says: If hFile is a handle to a communications device,
299 * the function only flushes the transmit buffer.
301 int ret
= (tcflush( get_unix_fd(fd
), TCOFLUSH
) != -1);
302 if (!ret
) file_set_error();
306 DECL_HANDLER(get_serial_info
)
308 struct serial
*serial
;
310 if ((serial
= get_serial_obj( current
->process
, req
->handle
, 0 )))
313 reply
->readinterval
= serial
->readinterval
;
314 reply
->readconst
= serial
->readconst
;
315 reply
->readmult
= serial
->readmult
;
316 reply
->writeconst
= serial
->writeconst
;
317 reply
->writemult
= serial
->writemult
;
320 reply
->eventmask
= serial
->eventmask
;
322 /* comm port error status */
323 reply
->commerror
= serial
->commerror
;
325 release_object( serial
);
329 DECL_HANDLER(set_serial_info
)
331 struct serial
*serial
;
333 if ((serial
= get_serial_obj( current
->process
, req
->handle
, 0 )))
336 if (req
->flags
& SERIALINFO_SET_TIMEOUTS
)
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
;
346 if (req
->flags
& SERIALINFO_SET_MASK
)
348 serial
->eventmask
= req
->eventmask
;
349 if (!serial
->eventmask
)
351 async_terminate_queue( &serial
->wait_q
, STATUS_SUCCESS
);
355 /* comm port error status */
356 if (req
->flags
& SERIALINFO_SET_ERROR
)
358 serial
->commerror
= req
->commerror
;
361 release_object( serial
);