1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
//! Windows impl of mio-enabled serial ports. use mio::{Evented, Poll, PollOpt, Ready, Token}; use mio_named_pipes::NamedPipe; use serialport::prelude::*; use serialport::windows::COMPort; use std::ffi::OsStr; use std::io::{self, Read, Write}; use std::mem; use std::os::windows::ffi::OsStrExt; use std::os::windows::io::{AsRawHandle, FromRawHandle, RawHandle}; use std::path::Path; use std::ptr; use std::time::Duration; use winapi::um::commapi::SetCommTimeouts; use winapi::um::fileapi::*; use winapi::um::handleapi::INVALID_HANDLE_VALUE; use winapi::um::winbase::{COMMTIMEOUTS, FILE_FLAG_OVERLAPPED}; use winapi::um::winnt::{FILE_ATTRIBUTE_NORMAL, GENERIC_READ, GENERIC_WRITE, HANDLE}; /// Windows serial port pub struct Serial { inner: COMPort, pipe: NamedPipe, } impl Serial { /// Opens a COM port at the specified path pub fn from_path<T: AsRef<Path>>(path: T, settings: &SerialPortSettings) -> io::Result<Self> { let mut name = Vec::<u16>::new(); name.extend(OsStr::new("\\\\.\\").encode_wide()); name.extend(path.as_ref().as_os_str().encode_wide()); name.push(0); let handle = unsafe { CreateFileW( name.as_ptr(), GENERIC_READ | GENERIC_WRITE, 0, ptr::null_mut(), OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED, 0 as HANDLE, ) }; if handle != INVALID_HANDLE_VALUE { let handle = unsafe { mem::transmute(handle) }; // Construct NamedPipe and COMPort from Handle let pipe = unsafe { NamedPipe::from_raw_handle(handle) }; let mut serial = unsafe { COMPort::from_raw_handle(handle) }; serial.set_all(settings)?; override_comm_timeouts(handle)?; Ok(Serial { inner: serial, pipe: pipe, }) } else { Err(io::Error::last_os_error()) } } } impl SerialPort for Serial { /// Returns a struct with the current port settings fn settings(&self) -> SerialPortSettings { self.inner.settings() } /// Return the name associated with the serial port, if known. fn name(&self) -> Option<String> { self.inner.name() } /// Returns the current baud rate. /// /// This function returns `None` if the baud rate could not be determined. This may occur if /// the hardware is in an uninitialized state. Setting a baud rate with `set_baud_rate()` /// should initialize the baud rate to a supported value. fn baud_rate(&self) -> crate::Result<u32> { self.inner.baud_rate() } /// Returns the character size. /// /// This function returns `None` if the character size could not be determined. This may occur /// if the hardware is in an uninitialized state or is using a non-standard character size. /// Setting a baud rate with `set_char_size()` should initialize the character size to a /// supported value. fn data_bits(&self) -> crate::Result<DataBits> { self.inner.data_bits() } /// Returns the flow control mode. /// /// This function returns `None` if the flow control mode could not be determined. This may /// occur if the hardware is in an uninitialized state or is using an unsupported flow control /// mode. Setting a flow control mode with `set_flow_control()` should initialize the flow /// control mode to a supported value. fn flow_control(&self) -> crate::Result<FlowControl> { self.inner.flow_control() } /// Returns the parity-checking mode. /// /// This function returns `None` if the parity mode could not be determined. This may occur if /// the hardware is in an uninitialized state or is using a non-standard parity mode. Setting /// a parity mode with `set_parity()` should initialize the parity mode to a supported value. fn parity(&self) -> crate::Result<Parity> { self.inner.parity() } /// Returns the number of stop bits. /// /// This function returns `None` if the number of stop bits could not be determined. This may /// occur if the hardware is in an uninitialized state or is using an unsupported stop bit /// configuration. Setting the number of stop bits with `set_stop-bits()` should initialize the /// stop bits to a supported value. fn stop_bits(&self) -> crate::Result<StopBits> { self.inner.stop_bits() } /// Returns the current timeout. fn timeout(&self) -> Duration { Duration::from_secs(0) } // Port settings setters /// Applies all settings for a struct. This isn't guaranteed to involve only /// a single call into the driver, though that may be done on some /// platforms. fn set_all(&mut self, settings: &SerialPortSettings) -> crate::Result<()> { self.inner.set_all(settings)?; override_comm_timeouts(self.inner.as_raw_handle())?; Ok(()) } /// Sets the baud rate. /// /// ## Errors /// /// If the implementation does not support the requested baud rate, this function may return an /// `InvalidInput` error. Even if the baud rate is accepted by `set_baud_rate()`, it may not be /// supported by the underlying hardware. fn set_baud_rate(&mut self, baud_rate: u32) -> crate::Result<()> { self.inner.set_baud_rate(baud_rate) } /// Sets the character size. fn set_data_bits(&mut self, data_bits: DataBits) -> crate::Result<()> { self.inner.set_data_bits(data_bits) } /// Sets the flow control mode. fn set_flow_control(&mut self, flow_control: FlowControl) -> crate::Result<()> { self.inner.set_flow_control(flow_control) } /// Sets the parity-checking mode. fn set_parity(&mut self, parity: Parity) -> crate::Result<()> { self.inner.set_parity(parity) } /// Sets the number of stop bits. fn set_stop_bits(&mut self, stop_bits: StopBits) -> crate::Result<()> { self.inner.set_stop_bits(stop_bits) } /// Sets the timeout for future I/O operations. This parameter is ignored but /// required for trait completeness. fn set_timeout(&mut self, _: Duration) -> crate::Result<()> { Ok(()) } // Functions for setting non-data control signal pins /// Sets the state of the RTS (Request To Send) control signal. /// /// Setting a value of `true` asserts the RTS control signal. `false` clears the signal. /// /// ## Errors /// /// This function returns an error if the RTS control signal could not be set to the desired /// state on the underlying hardware: /// /// * `NoDevice` if the device was disconnected. /// * `Io` for any other type of I/O error. fn write_request_to_send(&mut self, level: bool) -> crate::Result<()> { self.inner.write_request_to_send(level) } /// Writes to the Data Terminal Ready pin /// /// Setting a value of `true` asserts the DTR control signal. `false` clears the signal. /// /// ## Errors /// /// This function returns an error if the DTR control signal could not be set to the desired /// state on the underlying hardware: /// /// * `NoDevice` if the device was disconnected. /// * `Io` for any other type of I/O error. fn write_data_terminal_ready(&mut self, level: bool) -> crate::Result<()> { self.inner.write_data_terminal_ready(level) } // Functions for reading additional pins /// Reads the state of the CTS (Clear To Send) control signal. /// /// This function returns a boolean that indicates whether the CTS control signal is asserted. /// /// ## Errors /// /// This function returns an error if the state of the CTS control signal could not be read /// from the underlying hardware: /// /// * `NoDevice` if the device was disconnected. /// * `Io` for any other type of I/O error. fn read_clear_to_send(&mut self) -> crate::Result<bool> { self.inner.read_clear_to_send() } /// Reads the state of the Data Set Ready control signal. /// /// This function returns a boolean that indicates whether the DSR control signal is asserted. /// /// ## Errors /// /// This function returns an error if the state of the DSR control signal could not be read /// from the underlying hardware: /// /// * `NoDevice` if the device was disconnected. /// * `Io` for any other type of I/O error. fn read_data_set_ready(&mut self) -> crate::Result<bool> { self.inner.read_data_set_ready() } /// Reads the state of the Ring Indicator control signal. /// /// This function returns a boolean that indicates whether the RI control signal is asserted. /// /// ## Errors /// /// This function returns an error if the state of the RI control signal could not be read from /// the underlying hardware: /// /// * `NoDevice` if the device was disconnected. /// * `Io` for any other type of I/O error. fn read_ring_indicator(&mut self) -> crate::Result<bool> { self.inner.read_ring_indicator() } /// Reads the state of the Carrier Detect control signal. /// /// This function returns a boolean that indicates whether the CD control signal is asserted. /// /// ## Errors /// /// This function returns an error if the state of the CD control signal could not be read from /// the underlying hardware: /// /// * `NoDevice` if the device was disconnected. /// * `Io` for any other type of I/O error. fn read_carrier_detect(&mut self) -> crate::Result<bool> { self.inner.read_carrier_detect() } /// Gets the number of bytes available to be read from the input buffer. /// /// # Errors /// /// This function may return the following errors: /// /// * `NoDevice` if the device was disconnected. /// * `Io` for any other type of I/O error. fn bytes_to_read(&self) -> crate::Result<u32> { self.inner.bytes_to_read() } /// Get the number of bytes written to the output buffer, awaiting transmission. /// /// # Errors /// /// This function may return the following errors: /// /// * `NoDevice` if the device was disconnected. /// * `Io` for any other type of I/O error. fn bytes_to_write(&self) -> crate::Result<u32> { self.inner.bytes_to_write() } /// Discards all bytes from the serial driver's input buffer and/or output buffer. /// /// # Errors /// /// This function may return the following errors: /// /// * `NoDevice` if the device was disconnected. /// * `Io` for any other type of I/O error. fn clear(&self, buffer_to_clear: ClearBuffer) -> crate::Result<()> { self.inner.clear(buffer_to_clear) } // Misc methods /// Attempts to clone the `SerialPort`. This allow you to write and read simultaneously from the /// same serial connection. Please note that if you want a real asynchronous serial port you /// should look at [mio-serial](https://crates.io/crates/mio-serial) or /// [tokio-serial](https://crates.io/crates/tokio-serial). /// /// Also, you must be very carefull when changing the settings of a cloned `SerialPort` : since /// the settings are cached on a per object basis, trying to modify them from two different /// objects can cause some nasty behavior. /// /// # Errors /// /// This function returns an error if the serial port couldn't be cloned. fn try_clone(&self) -> crate::Result<Box<dyn SerialPort>> { self.inner.try_clone() } } impl Read for Serial { fn read(&mut self, bytes: &mut [u8]) -> io::Result<usize> { self.pipe.read(bytes) } } impl Write for Serial { fn write(&mut self, bytes: &[u8]) -> io::Result<usize> { self.pipe.write(bytes) } fn flush(&mut self) -> io::Result<()> { self.pipe.flush() } } impl Evented for Serial { fn register( &self, poll: &Poll, token: Token, interest: Ready, opts: PollOpt, ) -> io::Result<()> { self.pipe.register(poll, token, interest, opts) } fn reregister( &self, poll: &Poll, token: Token, interest: Ready, opts: PollOpt, ) -> io::Result<()> { self.pipe.reregister(poll, token, interest, opts) } fn deregister(&self, poll: &Poll) -> io::Result<()> { self.pipe.deregister(poll) } } /// Overrides timeout value set by serialport-rs so that the read end will /// never wake up with 0-byte payload. fn override_comm_timeouts(handle: RawHandle) -> io::Result<()> { let mut timeouts = COMMTIMEOUTS { // wait at most 1ms between two bytes (0 means no timeout) ReadIntervalTimeout: 1, // disable "total" timeout to wait at least 1 byte forever ReadTotalTimeoutMultiplier: 0, ReadTotalTimeoutConstant: 0, // write timeouts are just copied from serialport-rs WriteTotalTimeoutMultiplier: 0, WriteTotalTimeoutConstant: 0, }; let r = unsafe { SetCommTimeouts(handle, &mut timeouts) }; if r == 0 { return Err(io::Error::last_os_error()); } Ok(()) }