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 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
use crate::{
io::{Read, Seek, SeekFrom, Write},
port_is_unique, Error,
};
use core::cmp::min;
use w5500_ll::{
net::SocketAddrV4, Protocol, Registers, Sn, SocketCommand, SocketMode, SocketStatus, TxPtrs,
};
/// Streaming reader for a TCP socket buffer.
///
/// This implements the [`Read`] and [`Seek`] traits.
///
/// Created with [`Tcp::tcp_reader`].
///
/// # Example
///
/// ```no_run
/// # use ehm::eh1 as h;
/// # let mut w5500 = w5500_ll::eh1::vdm::W5500::new(h::spi::Mock::new(&[]));
/// use w5500_hl::{
/// io::Read,
/// ll::{Registers, Sn, SocketInterrupt},
/// net::{Ipv4Addr, SocketAddrV4},
/// Tcp, TcpReader,
/// };
///
/// const MQTT_SOCKET: Sn = Sn::Sn0;
/// const MQTT_SOURCE_PORT: u16 = 33650;
/// const MQTT_SERVER: SocketAddrV4 = SocketAddrV4::new(Ipv4Addr::new(192, 168, 2, 10), 1883);
///
/// w5500.tcp_connect(MQTT_SOCKET, MQTT_SOURCE_PORT, &MQTT_SERVER)?;
///
/// // ... wait for a CON interrupt
///
/// const CONNECT: [u8; 14] = [
/// 0x10, 0x0C, 0x00, 0x04, b'M', b'Q', b'T', b'T', 0x04, 0x02, 0x0E, 0x10, 0x00, 0x00,
/// ];
/// let tx_bytes: u16 = w5500.tcp_write(MQTT_SOCKET, &CONNECT)?;
/// assert_eq!(usize::from(tx_bytes), CONNECT.len());
///
/// // ... wait for a RECV interrupt
///
/// let mut reader: TcpReader<_> = w5500.tcp_reader(MQTT_SOCKET)?;
/// let mut buf = [0; 2];
///
/// // read the first two bytes
/// reader.read_exact(&mut buf)?;
/// // ... do something with the data
///
/// // read another two bytes into the same buffer
/// reader.read_exact(&mut buf)?;
/// // ... do something with the data
///
/// // mark the data as read
/// reader.done()?;
/// # Ok::<(), w5500_hl::Error<_>>(())
/// ```
#[derive(Debug)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct TcpReader<'w, W5500> {
pub(crate) w5500: &'w mut W5500,
pub(crate) sn: Sn,
pub(crate) head_ptr: u16,
pub(crate) tail_ptr: u16,
pub(crate) ptr: u16,
}
impl<'w, W5500> Seek for TcpReader<'w, W5500> {
fn seek<E>(&mut self, pos: SeekFrom) -> Result<(), Error<E>> {
self.ptr = pos.new_ptr(self.ptr, self.head_ptr, self.tail_ptr)?;
Ok(())
}
fn rewind(&mut self) {
self.ptr = self.head_ptr
}
fn stream_len(&self) -> u16 {
self.tail_ptr.wrapping_sub(self.head_ptr)
}
fn stream_position(&self) -> u16 {
self.ptr.wrapping_sub(self.head_ptr)
}
fn remain(&self) -> u16 {
self.tail_ptr.wrapping_sub(self.ptr)
}
}
impl<'a, W5500: Registers> Read<W5500::Error> for TcpReader<'a, W5500> {
fn read(&mut self, buf: &mut [u8]) -> Result<u16, W5500::Error> {
let read_size: u16 = min(self.remain(), buf.len().try_into().unwrap_or(u16::MAX));
if read_size != 0 {
self.w5500
.sn_rx_buf(self.sn, self.ptr, &mut buf[..usize::from(read_size)])?;
self.ptr = self.ptr.wrapping_add(read_size);
Ok(read_size)
} else {
Ok(0)
}
}
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error<W5500::Error>> {
let buf_len: u16 = buf.len().try_into().unwrap_or(u16::MAX);
let read_size: u16 = min(self.remain(), buf_len);
if read_size != buf_len {
Err(Error::UnexpectedEof)
} else {
self.w5500.sn_rx_buf(self.sn, self.ptr, buf)?;
self.ptr = self.ptr.wrapping_add(read_size);
Ok(())
}
}
fn done(self) -> Result<(), W5500::Error> {
self.w5500.set_sn_rx_rd(self.sn, self.ptr)?;
self.w5500.set_sn_cr(self.sn, SocketCommand::Recv)?;
Ok(())
}
}
/// Streaming writer for a TCP socket buffer.
///
/// This implements the [`Seek`] traits.
///
/// Created with [`Tcp::tcp_writer`](crate::Tcp::tcp_writer).
///
/// # Example
///
/// ```no_run
/// # use ehm::eh1 as h;
/// # let mut w5500 = w5500_ll::eh1::vdm::W5500::new(h::spi::Mock::new(&[]));
/// use w5500_hl::{
/// io::Write,
/// ll::{Registers, Sn, SocketInterrupt},
/// net::{Ipv4Addr, SocketAddrV4},
/// Tcp, TcpWriter,
/// };
///
/// const MQTT_SOCKET: Sn = Sn::Sn0;
/// const MQTT_SOURCE_PORT: u16 = 33650;
/// const MQTT_SERVER: SocketAddrV4 = SocketAddrV4::new(Ipv4Addr::new(192, 168, 2, 10), 1883);
///
/// w5500.tcp_connect(MQTT_SOCKET, MQTT_SOURCE_PORT, &MQTT_SERVER)?;
///
/// // ... wait for a CON interrupt
///
/// const CONNECT: [u8; 14] = [
/// 0x10, 0x0C, 0x00, 0x04, b'M', b'Q', b'T', b'T', 0x04, 0x02, 0x0E, 0x10, 0x00, 0x00,
/// ];
/// let mut writer: TcpWriter<_> = w5500.tcp_writer(MQTT_SOCKET)?;
/// writer.write_all(&CONNECT)?;
/// writer.send()?;
/// # Ok::<(), w5500_hl::Error<_>>(())
/// ```
#[derive(Debug, PartialEq, Eq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct TcpWriter<'w, W5500> {
pub(crate) w5500: &'w mut W5500,
pub(crate) sn: Sn,
pub(crate) head_ptr: u16,
pub(crate) tail_ptr: u16,
pub(crate) ptr: u16,
}
impl<'w, W5500> Seek for TcpWriter<'w, W5500> {
fn seek<E>(&mut self, pos: SeekFrom) -> Result<(), Error<E>> {
self.ptr = pos.new_ptr(self.ptr, self.head_ptr, self.tail_ptr)?;
Ok(())
}
fn rewind(&mut self) {
self.ptr = self.head_ptr
}
fn stream_len(&self) -> u16 {
self.tail_ptr.wrapping_sub(self.head_ptr)
}
fn stream_position(&self) -> u16 {
self.ptr.wrapping_sub(self.head_ptr)
}
fn remain(&self) -> u16 {
self.tail_ptr.wrapping_sub(self.ptr)
}
}
impl<'w, W5500: Registers> Write<W5500::Error> for TcpWriter<'w, W5500> {
fn write(&mut self, buf: &[u8]) -> Result<u16, W5500::Error> {
let write_size: u16 = min(self.remain(), buf.len().try_into().unwrap_or(u16::MAX));
if write_size != 0 {
self.w5500
.set_sn_tx_buf(self.sn, self.ptr, &buf[..usize::from(write_size)])?;
self.ptr = self.ptr.wrapping_add(write_size);
Ok(write_size)
} else {
Ok(0)
}
}
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error<W5500::Error>> {
let buf_len: u16 = buf.len().try_into().unwrap_or(u16::MAX);
let write_size: u16 = min(self.remain(), buf_len);
if write_size != buf_len {
Err(Error::OutOfMemory)
} else {
self.w5500.set_sn_tx_buf(self.sn, self.ptr, buf)?;
self.ptr = self.ptr.wrapping_add(write_size);
Ok(())
}
}
fn send(self) -> Result<(), W5500::Error> {
self.w5500.set_sn_tx_wr(self.sn, self.ptr)?;
self.w5500.set_sn_cr(self.sn, SocketCommand::Send)?;
Ok(())
}
}
/// A W5500 TCP trait.
pub trait Tcp: Registers {
/// Starts the 3-way TCP handshake with the remote host.
///
/// This method is used to create and interact with a TCP stream between
/// a local host and a remote socket.
///
/// After initiating a connection with [`tcp_connect`] and receiving the
/// [`con`] interrupt data can be transmitting by using [`tcp_read`] and
/// [`tcp_write`].
///
/// Calling this method **does not** mean the socket will be connected
/// afterwards, this simply starts the three way handshake.
///
/// After calling this method you will eventually get one of 3 interrupts on
/// the socket:
///
/// 1. [`con`](w5500_ll::SocketInterrupt::con_raised)
/// 2. [`discon`](w5500_ll::SocketInterrupt::discon_raised)
/// 3. [`timeout`](w5500_ll::SocketInterrupt::timeout_raised)
///
/// # Arguments
///
/// * `socket` - The socket number to use for this TCP stream.
/// * `port` - The local port to use for the TCP connection.
/// * `addr` - Address of the remote host to connect to.
///
/// # Panics
///
/// * (debug) The port must not be in use by any other socket on the W5500.
///
/// # Example
///
/// ```no_run
/// # let mut w5500 = w5500_ll::eh1::vdm::W5500::new(ehm::eh1::spi::Mock::new(&[]));
/// use w5500_hl::{
/// ll::{Registers, Sn, SocketInterrupt},
/// net::{Ipv4Addr, SocketAddrV4},
/// Tcp,
/// };
///
/// const MQTT_SOCKET: Sn = Sn::Sn0;
/// const MQTT_SOURCE_PORT: u16 = 33650;
/// const MQTT_SERVER: SocketAddrV4 = SocketAddrV4::new(Ipv4Addr::new(192, 168, 2, 10), 1883);
///
/// w5500.tcp_connect(MQTT_SOCKET, MQTT_SOURCE_PORT, &MQTT_SERVER)?;
///
/// // wait for a socket interrupt
/// // you should use the actual interrupt pin, polling is just for demonstration
/// loop {
/// let sn_ir: SocketInterrupt = w5500.sn_ir(MQTT_SOCKET)?;
///
/// // in reality you will want to handle disconnections gracefully with retries
/// assert!(!sn_ir.discon_raised());
/// assert!(!sn_ir.timeout_raised());
///
/// // connection succeded
/// if sn_ir.con_raised() {
/// break;
/// }
/// }
/// # Ok::<(), embedded_hal::spi::ErrorKind>(())
/// ```
///
/// [`tcp_write`]: Tcp::tcp_write
/// [`tcp_read`]: Tcp::tcp_read
/// [`tcp_connect`]: Tcp::tcp_connect
/// [`con`]: w5500_ll::SocketInterrupt::con_raised
fn tcp_connect(&mut self, sn: Sn, port: u16, addr: &SocketAddrV4) -> Result<(), Self::Error> {
debug_assert!(
port_is_unique(self, sn, port)?,
"Local port {port} is in use"
);
self.set_sn_cr(sn, SocketCommand::Close)?;
// This will not hang, the socket status will always change to closed
// after a close command.
// (unless you do somthing silly like holding the W5500 in reset)
while self.sn_sr(sn)? != Ok(SocketStatus::Closed) {}
const MODE: SocketMode = SocketMode::DEFAULT.set_protocol(Protocol::Tcp);
self.set_sn_mr(sn, MODE)?;
self.set_sn_port(sn, port)?;
self.set_sn_cr(sn, SocketCommand::Open)?;
self.set_sn_dest(sn, addr)?;
// This will not hang, the socket status will always change to Init
// after a open command with SN_MR set to TCP.
// (unless you do somthing silly like holding the W5500 in reset)
while self.sn_sr(sn)? != Ok(SocketStatus::Init) {}
self.set_sn_cr(sn, SocketCommand::Connect)
}
/// Open a TCP listener on the given port.
///
/// After opening a listener with [`tcp_listen`] and receiving the
/// [`con`] interrupt data can be transmitting by using [`tcp_read`] and
/// [`tcp_write`].
///
/// # Arguments
///
/// * `socket` - The socket number to use for this TCP listener.
/// * `port` - The local port to listen for remote connections on.
///
/// # Panics
///
/// * (debug) The port must not be in use by any other socket on the W5500.
///
/// # Example
///
/// Create an HTTP server.
///
/// ```no_run
/// # let mut w5500 = w5500_ll::eh1::vdm::W5500::new(ehm::eh1::spi::Mock::new(&[]));
/// use w5500_hl::{
/// ll::{Registers, Sn, SocketInterrupt},
/// net::{Ipv4Addr, SocketAddrV4},
/// Tcp,
/// };
/// // global_allocator is currently avaliable on nightly for embedded rust
/// extern crate alloc;
/// use alloc::vec::{self, Vec};
///
/// const HTTP_SOCKET: Sn = Sn::Sn1;
/// const HTTP_PORT: u16 = 80;
///
/// // start serving
/// w5500.tcp_listen(HTTP_SOCKET, HTTP_PORT)?;
///
/// // wait for the RECV interrupt, indicating there is data to read from a client
/// loop {
/// let sn_ir = w5500.sn_ir(HTTP_SOCKET).unwrap();
/// if sn_ir.recv_raised() {
/// w5500.set_sn_ir(HTTP_SOCKET, sn_ir).unwrap();
/// break;
/// }
/// if sn_ir.discon_raised() | sn_ir.timeout_raised() {
/// panic!("Socket disconnected while waiting for RECV");
/// }
/// }
///
/// let mut buf: Vec<u8> = vec![0; 256];
/// let rx_bytes: u16 = w5500.tcp_read(HTTP_SOCKET, &mut buf)?;
/// // Truncate the buffer to the number of bytes read
/// // Safety: BUF is only borrowed mutably in one location
/// let filled_buf: &[u8] = &buf[..rx_bytes.into()];
///
/// // parse HTTP request here using filled_buf
/// # Ok::<(), embedded_hal::spi::ErrorKind>(())
/// ```
///
/// [`tcp_write`]: Tcp::tcp_write
/// [`tcp_read`]: Tcp::tcp_read
/// [`tcp_listen`]: Tcp::tcp_listen
/// [`con`]: w5500_ll::SocketInterrupt::con_raised
fn tcp_listen(&mut self, sn: Sn, port: u16) -> Result<(), Self::Error> {
debug_assert!(
port_is_unique(self, sn, port)?,
"Local port {port} is in use"
);
self.set_sn_cr(sn, SocketCommand::Close)?;
// This will not hang, the socket status will always change to closed
// after a close command.
// (unless you do somthing silly like holding the W5500 in reset)
while self.sn_sr(sn)? != Ok(SocketStatus::Closed) {}
const MODE: SocketMode = SocketMode::DEFAULT.set_protocol(Protocol::Tcp);
self.set_sn_mr(sn, MODE)?;
self.set_sn_port(sn, port)?;
self.set_sn_cr(sn, SocketCommand::Open)?;
// This will not hang, the socket status will always change to Init
// after a open command with SN_MR set to TCP.
// (unless you do somthing silly like holding the W5500 in reset)
while self.sn_sr(sn)? != Ok(SocketStatus::Init) {}
self.set_sn_cr(sn, SocketCommand::Listen)
}
/// Read data from the remote host, returning the number of bytes read.
///
/// You should wait for the socket [`recv`] interrupt before calling this method.
///
/// # Panics
///
/// * (debug) The socket must be an [`Established`] TCP socket.
///
/// # Example
///
/// Send a MQTT CONNECT packet and read a CONNACK.
///
/// ```no_run
/// # let mut w5500 = w5500_ll::eh1::vdm::W5500::new(ehm::eh1::spi::Mock::new(&[]));
/// use w5500_hl::{
/// ll::{Registers, Sn, SocketInterrupt},
/// net::{Ipv4Addr, SocketAddrV4},
/// Tcp,
/// };
///
/// const MQTT_SOCKET: Sn = Sn::Sn0;
/// const MQTT_SOURCE_PORT: u16 = 33650;
/// const MQTT_SERVER: SocketAddrV4 = SocketAddrV4::new(Ipv4Addr::new(192, 168, 2, 10), 1883);
///
/// w5500.tcp_connect(MQTT_SOCKET, MQTT_SOURCE_PORT, &MQTT_SERVER)?;
///
/// // ... wait for a CON interrupt
///
/// const CONNECT: [u8; 14] = [
/// 0x10, 0x0C, 0x00, 0x04, b'M', b'Q', b'T', b'T', 0x04, 0x02, 0x0E, 0x10, 0x00, 0x00,
/// ];
/// let tx_bytes: u16 = w5500.tcp_write(MQTT_SOCKET, &CONNECT)?;
/// assert_eq!(usize::from(tx_bytes), CONNECT.len());
///
/// // ... wait for a RECV interrupt
///
/// let mut buf = [0; 10];
/// let rx_bytes: u16 = w5500.tcp_read(MQTT_SOCKET, &mut buf)?;
/// let filled_buf = &buf[..rx_bytes.into()];
/// # Ok::<(), embedded_hal::spi::ErrorKind>(())
/// ```
///
/// [`Established`]: w5500_ll::SocketStatus::Established
/// [`recv`]: w5500_ll::SocketInterrupt::recv_raised
fn tcp_read(&mut self, sn: Sn, buf: &mut [u8]) -> Result<u16, Self::Error> {
debug_assert!(!matches!(
self.sn_sr(sn)?,
Ok(SocketStatus::Udp) | Ok(SocketStatus::Init) | Ok(SocketStatus::Macraw)
));
let rx_bytes: u16 = {
let rsr: u16 = self.sn_rx_rsr(sn)?;
min(rsr, u16::try_from(buf.len()).unwrap_or(u16::MAX))
};
if rx_bytes != 0 {
let ptr: u16 = self.sn_rx_rd(sn)?;
self.sn_rx_buf(sn, ptr, &mut buf[..usize::from(rx_bytes)])?;
self.set_sn_rx_rd(sn, ptr.wrapping_add(rx_bytes))?;
self.set_sn_cr(sn, SocketCommand::Recv)?;
}
Ok(rx_bytes)
}
/// Send data to the remote host, returning the number of bytes written.
///
/// # Panics
///
/// * (debug) The socket must be an [`Established`] TCP socket.
///
/// # Example
///
/// Send a MQTT CONNECT packet.
///
/// ```no_run
/// # let mut w5500 = w5500_ll::eh1::vdm::W5500::new(ehm::eh1::spi::Mock::new(&[]));
/// use w5500_hl::{
/// ll::{Registers, Sn, SocketInterrupt},
/// net::{Ipv4Addr, SocketAddrV4},
/// Tcp,
/// };
///
/// const MQTT_SOCKET: Sn = Sn::Sn0;
/// const MQTT_SOURCE_PORT: u16 = 33650;
/// const MQTT_SERVER: SocketAddrV4 = SocketAddrV4::new(Ipv4Addr::new(192, 168, 2, 10), 1883);
///
/// w5500.tcp_connect(MQTT_SOCKET, MQTT_SOURCE_PORT, &MQTT_SERVER)?;
///
/// // ... wait for a CON interrupt
///
/// const CONNECT: [u8; 14] = [
/// 0x10, 0x0C, 0x00, 0x04, b'M', b'Q', b'T', b'T', 0x04, 0x02, 0x0E, 0x10, 0x00, 0x00,
/// ];
/// let tx_bytes: u16 = w5500.tcp_write(MQTT_SOCKET, &CONNECT)?;
/// assert_eq!(usize::from(tx_bytes), CONNECT.len());
/// # Ok::<(), embedded_hal::spi::ErrorKind>(())
/// ```
///
/// [`Established`]: w5500_ll::SocketStatus::Established
fn tcp_write(&mut self, sn: Sn, buf: &[u8]) -> Result<u16, Self::Error> {
debug_assert!(!matches!(
self.sn_sr(sn)?,
Ok(SocketStatus::Udp) | Ok(SocketStatus::Init) | Ok(SocketStatus::Macraw)
));
let tx_bytes: u16 = {
let data_len: u16 = u16::try_from(buf.len()).unwrap_or(u16::MAX);
let free_size: u16 = self.sn_tx_fsr(sn)?;
min(data_len, free_size)
};
if tx_bytes != 0 {
let ptr: u16 = self.sn_tx_wr(sn)?;
self.set_sn_tx_buf(sn, ptr, &buf[..usize::from(tx_bytes)])?;
self.set_sn_tx_wr(sn, ptr.wrapping_add(tx_bytes))?;
self.set_sn_cr(sn, SocketCommand::Send)?;
}
Ok(tx_bytes)
}
/// Disconnect from the peer.
///
/// If the disconnect is successful (FIN/ACK packet is received) the socket
/// status changes to [`Closed`], otherwise TCP<sub>TO</sub> occurs, the
/// [timeout interrupt] is raised, and the socket status changes to
/// [`Closed`].
///
/// # Panics
///
/// * (debug) The socket must be an [`Established`] TCP socket.
///
/// # Example
///
/// Connect and disconnect from a MQTT server.
///
/// ```no_run
/// # let mut w5500 = w5500_ll::eh1::vdm::W5500::new(ehm::eh1::spi::Mock::new(&[]));
/// use w5500_hl::{
/// ll::{Registers, Sn, SocketInterrupt},
/// net::{Ipv4Addr, SocketAddrV4},
/// Tcp,
/// };
///
/// const MQTT_SOCKET: Sn = Sn::Sn0;
/// const MQTT_SOURCE_PORT: u16 = 33650;
/// const MQTT_SERVER: SocketAddrV4 = SocketAddrV4::new(Ipv4Addr::new(192, 168, 2, 10), 1883);
///
/// w5500.tcp_connect(MQTT_SOCKET, MQTT_SOURCE_PORT, &MQTT_SERVER)?;
///
/// // ... wait for a CON interrupt
///
/// w5500.tcp_disconnect(MQTT_SOCKET)?;
/// # Ok::<(), embedded_hal::spi::ErrorKind>(())
/// ```
///
/// [`Closed`]: w5500_ll::SocketStatus::Closed
/// [`Established`]: w5500_ll::SocketStatus::Established
/// [timeout interrupt]: w5500_ll::SocketInterrupt::timeout_raised
fn tcp_disconnect(&mut self, sn: Sn) -> Result<(), Self::Error> {
debug_assert!(!matches!(
self.sn_sr(sn)?,
Ok(SocketStatus::Udp) | Ok(SocketStatus::Init) | Ok(SocketStatus::Macraw)
));
self.set_sn_cr(sn, SocketCommand::Disconnect)
}
/// Create a TCP reader.
///
/// This returns a [`TcpReader`] structure, which contains functions to
/// stream data from the W5500 socket buffers incrementally.
///
/// This will return [`Error::WouldBlock`] if there is no data to read.
///
/// # Errors
///
/// This method can only return:
///
/// * [`Error::Other`]
/// * [`Error::WouldBlock`]
///
/// # Example
///
/// See [`TcpReader`].
fn tcp_reader(&mut self, sn: Sn) -> Result<TcpReader<Self>, Error<Self::Error>>
where
Self: Sized,
{
debug_assert!(!matches!(
self.sn_sr(sn)?,
Ok(SocketStatus::Udp) | Ok(SocketStatus::Init) | Ok(SocketStatus::Macraw)
));
let sn_rx_rsr: u16 = self.sn_rx_rsr(sn)?;
if sn_rx_rsr == 0 {
return Err(Error::WouldBlock);
}
let sn_rx_rd: u16 = self.sn_rx_rd(sn)?;
Ok(TcpReader {
w5500: self,
sn,
head_ptr: sn_rx_rd,
tail_ptr: sn_rx_rd.wrapping_add(sn_rx_rsr),
ptr: sn_rx_rd,
})
}
/// Create a TCP writer.
///
/// This returns a [`TcpWriter`] structure, which contains functions to
/// stream data to the W5500 socket buffers incrementally.
///
/// # Example
///
/// See [`TcpWriter`].
fn tcp_writer(&mut self, sn: Sn) -> Result<TcpWriter<Self>, Self::Error>
where
Self: Sized,
{
let tx_ptrs: TxPtrs = self.sn_tx_ptrs(sn)?;
Ok(TcpWriter {
w5500: self,
sn,
head_ptr: tx_ptrs.wr,
tail_ptr: tx_ptrs.wr.wrapping_add(tx_ptrs.fsr),
ptr: tx_ptrs.wr,
})
}
}
/// Implement the TCP trait for any structure that implements [`w5500_ll::Registers`].
impl<T> Tcp for T where T: Registers {}