wincwifi 0.2.1

WINC1500 Wifi chip embedded driver
Documentation
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
use core::net::SocketAddrV4;

use super::ClientSocketOp;
use super::Handle;
use super::StackError;
use super::WincClient;
use embedded_nal::UdpClientStack;
use embedded_nal::UdpFullStack;

use super::Xfer;

use crate::debug;
use crate::manager::SocketError;
use crate::stack::socket_callbacks::SendRequest;
use crate::stack::socket_callbacks::NUM_TCP_SOCKETS;
use crate::stack::socket_callbacks::{AsyncOp, AsyncState};
use embedded_nal::nb;

use crate::stack::sock_holder::SocketStore;

impl<X: Xfer> WincClient<'_, X> {
    fn send_udp_inner(
        &mut self,
        socket: &mut Handle,
        addr: SocketAddrV4,
        data: &[u8],
    ) -> nb::Result<(), StackError> {
        let res = Self::async_op(
            false,
            socket,
            &mut self.callbacks,
            &mut self.manager,
            self.poll_loop_delay_us,
            |op| matches!(op, AsyncOp::SendTo(..)),
            |sock, manager| -> Result<ClientSocketOp, StackError> {
                let to_send = data.len().min(Self::MAX_SEND_LENGTH);
                let req = SendRequest {
                    offset: 0,
                    grand_total_sent: 0,
                    total_sent: 0,
                    remaining: to_send as i16,
                };
                debug!(
                    "Sending INITIAL send_send to {:?} len:{}/{} req:{:?}",
                    sock,
                    to_send,
                    data.len(),
                    req
                );
                manager
                    .send_sendto(*sock, addr, &data[..to_send])
                    .map_err(StackError::SendSendFailed)?;
                Ok(ClientSocketOp::AsyncOp(
                    AsyncOp::SendTo(req, None),
                    AsyncState::Pending(None),
                ))
            },
            |sock, manager, _, asyncop| {
                if let AsyncOp::SendTo(req, Some(_len)) = asyncop {
                    let total_sent = req.total_sent;
                    let grand_total_sent = req.grand_total_sent + total_sent;
                    let offset = req.offset + total_sent as usize;
                    if offset >= data.len() {
                        Ok(())
                    } else {
                        let to_send = data[offset..].len().min(Self::MAX_SEND_LENGTH);
                        let new_req = SendRequest {
                            offset,
                            grand_total_sent,
                            total_sent: 0,
                            remaining: to_send as i16,
                        };
                        *asyncop = AsyncOp::SendTo(new_req, None);
                        manager
                            .send_sendto(*sock, addr, &data[offset..offset + to_send])
                            .map_err(StackError::SendSendFailed)?;
                        Err(StackError::ContinueOperation)
                    }
                } else {
                    Err(StackError::Unexpected)
                }
            },
        );
        self.test_hook();
        res
    }
}

impl<X: Xfer> UdpClientStack for WincClient<'_, X> {
    type UdpSocket = Handle;

    type Error = StackError;

    fn socket(&mut self) -> Result<Self::UdpSocket, Self::Error> {
        debug!("<> Calling new UDP socket");
        self.dispatch_events()?;
        let s = self.get_next_session_id();
        let handle = self
            .callbacks
            .udp_sockets
            .add(s)
            .ok_or(StackError::OutOfSockets)?;
        debug!("<> Got handle {:?} ", handle.0);
        Ok(handle)
    }

    // Not a blocking call
    fn connect(
        &mut self,
        socket: &mut Self::UdpSocket,
        remote: core::net::SocketAddr,
    ) -> Result<(), Self::Error> {
        self.dispatch_events()?;
        match remote {
            core::net::SocketAddr::V4(addr) => {
                debug!("<> Connect handle is {:?}", socket.0);
                let (sock, _op) = self.callbacks.udp_sockets.get(*socket).unwrap();
                self.callbacks.udp_socket_connect_addr[sock.v as usize - NUM_TCP_SOCKETS] =
                    Some(addr);
            }
            core::net::SocketAddr::V6(_) => unimplemented!("IPv6 not supported"),
        }
        Ok(())
    }

    fn send(&mut self, socket: &mut Self::UdpSocket, data: &[u8]) -> nb::Result<(), Self::Error> {
        let addr = {
            let (sock, _op) = self
                .callbacks
                .udp_sockets
                .get(*socket)
                .ok_or(StackError::SocketNotFound)?;
            self.callbacks.udp_socket_connect_addr[sock.v as usize - NUM_TCP_SOCKETS]
                .ok_or(StackError::Unexpected)?
        };
        self.send_udp_inner(socket, addr, data)
    }

    // Todo: consider consolidating this with TCP
    // Todo: Bug: If a caller passes us a very large buffer that is larger than
    // max receive buffer, this should loop through serveral packets with
    // an offset - like send does.
    fn receive(
        &mut self,
        socket: &mut Self::UdpSocket,
        buffer: &mut [u8],
    ) -> nb::Result<(usize, core::net::SocketAddr), Self::Error> {
        let res = Self::async_op(
            false,
            socket,
            &mut self.callbacks,
            &mut self.manager,
            self.poll_loop_delay_us,
            |op| matches!(op, AsyncOp::RecvFrom(..)),
            |sock, manager| -> Result<ClientSocketOp, StackError> {
                debug!("<> Sending udp socket send_recv to {:?}", sock);
                manager
                    .send_recvfrom(*sock, Self::RECV_TIMEOUT)
                    .map_err(StackError::ReceiveFailed)?;
                Ok(ClientSocketOp::AsyncOp(
                    AsyncOp::RecvFrom(None),
                    AsyncState::Pending(None),
                ))
            },
            |sock, manager, recv_buffer, asyncop| {
                if let AsyncOp::RecvFrom(Some(recv_result)) = asyncop {
                    match recv_result.error {
                        SocketError::NoError => {
                            let recv_len = recv_result.recv_len;
                            let dest_slice = &mut buffer[..recv_len];
                            dest_slice.copy_from_slice(&recv_buffer[..recv_len]);
                            Ok((
                                recv_result.recv_len,
                                core::net::SocketAddr::V4(recv_result.from_addr),
                            ))
                        }
                        SocketError::Timeout => {
                            debug!("Timeout on receive, re-sending receive command");
                            manager
                                .send_recvfrom(*sock, Self::RECV_TIMEOUT)
                                .map_err(StackError::ReceiveFailed)?;
                            Err(StackError::ContinueOperation)
                        }
                        _ => {
                            debug!("Error in receive: {:?}", recv_result.error);
                            Err(StackError::OpFailed(recv_result.error))
                        }
                    }
                } else {
                    Err(StackError::Unexpected)
                }
            },
        );
        self.test_hook();
        res
    }

    // Not a blocking call
    fn close(&mut self, socket: Self::UdpSocket) -> Result<(), Self::Error> {
        self.dispatch_events()?;
        let (sock, _op) = self.callbacks.udp_sockets.get(socket).unwrap();
        let sock_id = sock.v;
        self.manager
            .send_close(*sock)
            .map_err(StackError::SendCloseFailed)?;
        self.callbacks
            .udp_sockets
            .get(socket)
            .ok_or(StackError::CloseFailed)?;
        self.callbacks.udp_sockets.remove(socket);
        // clear send addresses
        self.callbacks.udp_socket_connect_addr[sock_id as usize - NUM_TCP_SOCKETS] = None;
        Ok(())
    }
}

impl<X: Xfer> UdpFullStack for WincClient<'_, X> {
    // Not a blocking call
    fn bind(&mut self, socket: &mut Self::UdpSocket, local_port: u16) -> Result<(), Self::Error> {
        // Local server ports needs to be bound to 0.0.0.0
        let server_addr =
            core::net::SocketAddrV4::new(core::net::Ipv4Addr::new(0, 0, 0, 0), local_port);
        let (sock, op) = self.callbacks.udp_sockets.get(*socket).unwrap();
        *op = ClientSocketOp::Bind(None);
        debug!("<> Sending UDP socket bind to {:?}", sock);
        self.manager
            .send_bind(*sock, server_addr)
            .map_err(StackError::BindFailed)?;
        self.wait_with_timeout(Self::BIND_TIMEOUT, |client, _| {
            let (_, op) = client.callbacks.udp_sockets.get(*socket).unwrap();
            let res = match op {
                ClientSocketOp::Bind(Some(bind_result)) => match bind_result.error {
                    SocketError::NoError => Some(Ok(())),
                    _ => Some(Err(StackError::OpFailed(bind_result.error))),
                },
                _ => None,
            };
            if res.is_some() {
                *op = ClientSocketOp::None;
            }
            res
        })
    }

    // Todo: Reduce copy-paste between send and send_to implementations
    fn send_to(
        &mut self,
        socket: &mut Self::UdpSocket,
        remote: core::net::SocketAddr,
        data: &[u8],
    ) -> nb::Result<(), Self::Error> {
        let addr = match remote {
            core::net::SocketAddr::V4(addr) => addr,
            core::net::SocketAddr::V6(_) => unimplemented!("IPv6 not supported"),
        };
        self.send_udp_inner(socket, addr, data)
    }
}

#[cfg(test)]
mod test {

    use super::*;
    use crate::client::{self, test_shared::*};
    use crate::{client::SocketCallbacks, manager::EventListener, socket::Socket};
    use core::net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4};
    use embedded_nal::{UdpClientStack, UdpFullStack};

    #[test]
    fn test_udp_socket_open() {
        let mut client = make_test_client();
        let udp_socket = client.socket();
        assert!(udp_socket.is_ok());
    }

    #[test]
    fn test_udp_connect() {
        let mut client = make_test_client();
        let mut udp_socket = client.socket().unwrap();

        let socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 80);

        let result = client.connect(&mut udp_socket, socket_addr);

        assert!(result.is_ok());
    }

    #[test]
    #[should_panic]
    fn test_udp_connect_v6_failure() {
        let mut client = make_test_client();
        let mut udp_socket = client.socket().unwrap();

        let socket_addr = SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)), 80);

        let _ = client.connect(&mut udp_socket, socket_addr);
    }

    #[test]
    fn test_udp_send() {
        let mut client = make_test_client();
        let mut udp_socket = client.socket().unwrap();
        let packet = "Hello, World";
        let valid_len: i16 = client::WincClient::<'_, MockTransfer>::MAX_SEND_LENGTH as i16;

        // Connect to address
        let socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 80);
        let result = client.connect(&mut udp_socket, socket_addr);
        assert!(result.is_ok());

        // set callback
        let mut my_debug = |callbacks: &mut SocketCallbacks| {
            callbacks.on_send_to(Socket::new(7, 0), valid_len as i16);
        };
        client.debug_callback = Some(&mut my_debug);

        // call send
        let result = nb::block!(client.send(&mut udp_socket, packet.as_bytes()));

        assert_eq!(result.ok(), Some(()));
    }

    #[test]
    fn test_udp_receive() {
        let mut client = make_test_client();
        let mut udp_socket = client.socket().unwrap();
        let _ipv4 = Ipv4Addr::new(127, 0, 0, 1);
        let socket_addr_v4 = SocketAddrV4::new(_ipv4, 80);
        let mut recv_buff = [0u8; 32];
        let test_data = "Hello, World".as_bytes();

        // Connect to address
        let socket_addr = SocketAddr::new(IpAddr::V4(_ipv4), 80);
        let result = client.connect(&mut udp_socket, socket_addr);
        assert!(result.is_ok());

        // set callback
        let mut my_debug = |callbacks: &mut SocketCallbacks| {
            callbacks.on_recvfrom(
                Socket::new(7, 0),
                socket_addr_v4,
                &test_data,
                SocketError::NoError,
            );
        };

        client.debug_callback = Some(&mut my_debug);

        // call receive
        let result = nb::block!(client.receive(&mut udp_socket, &mut recv_buff));

        assert_eq!(result.ok(), Some((test_data.len(), socket_addr)));
        assert_eq!(&recv_buff[..test_data.len()], test_data);
    }

    #[test]
    fn test_udp_close() {
        let mut client = make_test_client();
        let udp_socket = client.socket().unwrap();

        let result = client.close(udp_socket);

        assert!(result.is_ok());
    }

    #[test]
    fn test_udp_bind() {
        let mut client = make_test_client();
        let mut udp_socket = client.socket().unwrap();

        let mut my_debug = |callbacks: &mut SocketCallbacks| {
            callbacks.on_bind(Socket::new(7, 0), SocketError::NoError);
        };

        client.debug_callback = Some(&mut my_debug);

        let result = client.bind(&mut udp_socket, 8080);

        assert!(result.is_ok());
    }

    #[test]
    fn test_udp_send_to() {
        let mut client = make_test_client();
        let mut udp_socket = client.socket().unwrap();
        let packet = "Hello, World";
        let socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 80);

        let mut my_debug = |callbacks: &mut SocketCallbacks| {
            callbacks.on_send_to(Socket::new(7, 0), packet.len() as i16);
        };
        client.debug_callback = Some(&mut my_debug);

        let result = nb::block!(client.send_to(&mut udp_socket, socket_addr, packet.as_bytes()));

        assert_eq!(result.ok(), Some(()));
    }

    #[test]
    fn test_udp_check_max_send_buffer() {
        let mut client = make_test_client();
        let mut udp_socket = client.socket().unwrap();
        let packet = "Hello, World";
        let socket = Socket::new(7, 0);
        let valid_len: i16 = client::WincClient::<'_, MockTransfer>::MAX_SEND_LENGTH as i16;

        // Connect to address
        let socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 80);
        let result = client.connect(&mut udp_socket, socket_addr);
        assert!(result.is_ok());

        // set callback
        let mut my_debug = |callbacks: &mut SocketCallbacks| {
            callbacks.on_send_to(socket, valid_len);
        };
        client.debug_callback = Some(&mut my_debug);

        // call send
        let result = client.send(&mut udp_socket, packet.as_bytes());

        assert_eq!(result, Err(nb::Error::WouldBlock));

        if let Some((_, ClientSocketOp::AsyncOp(AsyncOp::SendTo(req, _), _))) =
            client.callbacks.resolve(socket)
        {
            assert!((req.total_sent == valid_len) && (req.remaining == 0 as i16));
        } else {
            assert!(false, "Expected Some value, but it returned None");
        }
    }

    #[test]
    fn test_udp_check_receive_timeout() {
        let mut client = make_test_client();
        let mut udp_socket = client.socket().unwrap();
        let _ipv4 = Ipv4Addr::new(127, 0, 0, 1);
        let socket_addr_v4 = SocketAddrV4::new(_ipv4, 80);
        let mut recv_buff = [0u8; 32];
        let mut counter = 5;

        // Connect to address
        let socket_addr = SocketAddr::new(IpAddr::V4(_ipv4), 80);
        let result = client.connect(&mut udp_socket, socket_addr);
        assert!(result.is_ok());

        // set callback
        let mut my_debug = |callbacks: &mut SocketCallbacks| {
            callbacks.on_recvfrom(Socket::new(7, 0), socket_addr_v4, &[], SocketError::Timeout);
        };

        client.debug_callback = Some(&mut my_debug);

        while counter != 0 {
            // call receive
            let result = client.receive(&mut udp_socket, &mut recv_buff);

            assert_eq!(result.err(), Some(nb::Error::WouldBlock));
            counter -= 1;
        }
    }

    #[test]
    #[should_panic]
    fn test_udp_check_send_to_ipv6() {
        let mut client = make_test_client();
        let mut udp_socket = client.socket().unwrap();
        let packet = "Hello, World";
        let socket_addr = SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)), 80);

        let _ = nb::block!(client.send_to(&mut udp_socket, socket_addr, packet.as_bytes()));
    }

    #[test]
    fn test_udp_check_bind_err() {
        let mut client = make_test_client();
        let mut udp_socket = client.socket().unwrap();

        let mut my_debug = |callbacks: &mut SocketCallbacks| {
            callbacks.on_bind(Socket::new(7, 0), SocketError::MaxUdpSock);
        };

        client.debug_callback = Some(&mut my_debug);

        let result = client.bind(&mut udp_socket, 8080);

        assert!(result.is_err());
    }

    #[test]
    fn test_udp_check_receive_err() {
        let mut client = make_test_client();
        let mut udp_socket = client.socket().unwrap();
        let _ipv4 = Ipv4Addr::new(127, 0, 0, 1);
        let socket_addr_v4 = SocketAddrV4::new(_ipv4, 80);
        let mut recv_buff = [0u8; 32];

        // Connect to address
        let socket_addr = SocketAddr::new(IpAddr::V4(_ipv4), 80);
        let result = client.connect(&mut udp_socket, socket_addr);
        assert!(result.is_ok());

        // set callback
        let mut my_debug = |callbacks: &mut SocketCallbacks| {
            callbacks.on_recvfrom(
                Socket::new(7, 0),
                socket_addr_v4,
                &[],
                SocketError::InvalidAddress,
            );
        };

        client.debug_callback = Some(&mut my_debug);

        // call receive
        let result = nb::block!(client.receive(&mut udp_socket, &mut recv_buff));

        assert!(result.is_err());
    }
}