wincwifi 0.3.0

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
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
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
use core::net::Ipv4Addr;

use crate::manager::{
    AuthType, ConnectionInfo, Credentials, EventListener, PingError, ProvisioningInfo, ScanResult,
    SocketError, Ssid, WifiConnError, WifiConnState, WpaKey, PRNG_DATA_LENGTH,
    SOCKET_BUFFER_MAX_LENGTH,
};

#[cfg(feature = "experimental-ota")]
use crate::manager::{OtaUpdateError, OtaUpdateStatus};

#[cfg(feature = "wep")]
use crate::manager::{WepKey, WepKeyIndex};

#[cfg(feature = "ssl")]
use crate::manager::{SslCallbackInfo, SslResponse};

#[cfg(feature = "experimental-ecc")]
use crate::manager::EccRequest;

#[cfg(feature = "ethernet")]
use crate::manager::EthernetRxInfo;

use super::sock_holder::{SockHolder, SocketStore};
use crate::{debug, error, info};
use crate::{socket::Socket, Ipv4AddrFormatWrapper};

/// Opaque handle to a socket. Returned by socket APIs
#[derive(Clone, Copy, PartialEq, Debug)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct Handle(pub u8);

#[derive(Debug, PartialEq, Clone)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub(crate) enum WifiModuleState {
    Reset,
    Starting,
    Unconnected,
    ConnectingToAp,
    ConnectedToAp,
    ConnectionFailed,
    Disconnecting,
    Provisioning,
    AccessPoint,
    DownloadMode,
}

#[cfg(feature = "experimental-ota")]
/// States to control the operational flow of OTA update.
#[derive(PartialEq, Eq, Copy, Clone)]
pub(crate) enum OtaUpdateState {
    NotStarted,
    InProgress,
    Complete,
    SwitchingFirmware,
    Switched,
    RollingBack,
    RolledBack,
    Aborting,
    Aborted,
    Failed(OtaUpdateError),
}

/// Ping operation results
#[derive(Debug)]
pub struct PingResult {
    pub ip: Ipv4Addr,
    pub rtt: u32,
    pub num_successful: u16,
    pub num_failed: u16,
    pub error: PingError,
}

#[cfg(feature = "defmt")]
impl defmt::Format for PingResult {
    fn format(&self, f: defmt::Formatter) {
        defmt::write!(
            f,
            "ip: {}, rtt: {}, num_successful: {}, num_failed: {}, error: {}",
            Ipv4AddrFormatWrapper::new(&self.ip),
            self.rtt,
            self.num_successful,
            self.num_failed,
            self.error
        );
    }
}

// TODO: This should be exposed to user
#[allow(dead_code)]
pub struct SystemTime {
    year: u16,
    month: u8,
    day: u8,
    hour: u8,
    minute: u8,
    second: u8,
}

pub(crate) struct ConnectionState {
    conn_state: WifiConnState,
    pub conn_error: Option<WifiConnError>,
    pub ip_conf: Option<crate::manager::IPConf>,
    system_time: Option<SystemTime>,
    ip_conflict: Option<Ipv4Addr>,
    pub scan_number_aps: Option<Option<u8>>,
    pub scan_results: Option<Option<ScanResult>>,
    pub conn_info: Option<Option<ConnectionInfo>>,
    pub rssi_level: Option<Option<i8>>,
    pub ping_result: Option<Option<PingResult>>,
}

impl ConnectionState {
    fn new() -> Self {
        Self {
            conn_state: WifiConnState::Disconnected,
            conn_error: None,
            ip_conf: None,
            system_time: None,
            rssi_level: None,
            ip_conflict: None,
            conn_info: None,
            scan_number_aps: None,
            scan_results: None,
            ping_result: None,
        }
    }
}

pub(crate) const NUM_TCP_SOCKETS: usize = 7;
pub(crate) const MAX_UDP_SOCKETS: usize = 4;

pub(crate) struct SocketCallbacks {
    // #define TCP_SOCK_MAX										(7)
    // indexes 0-6
    pub tcp_sockets: SockHolder<NUM_TCP_SOCKETS, 0>,
    // #define UDP_SOCK_MAX										4
    pub udp_sockets: SockHolder<MAX_UDP_SOCKETS, NUM_TCP_SOCKETS>,
    pub listening_sockets: [bool; NUM_TCP_SOCKETS],
    pub accept_backlog: [Option<(Socket, core::net::SocketAddrV4)>; NUM_TCP_SOCKETS],
    // Needed to keep track of connect() and recvfrom address
    pub udp_socket_connect_addr: [Option<core::net::SocketAddrV4>; MAX_UDP_SOCKETS],
    pub recv_buffer: [u8; SOCKET_BUFFER_MAX_LENGTH],

    // This is global
    pub dns_resolved_addr: Option<Option<core::net::Ipv4Addr>>,
    pub connection_state: ConnectionState,
    pub state: WifiModuleState,
    // Random Number Generator
    pub prng: Option<Option<Prng>>,
    pub provisioning_info: Option<Option<ProvisioningInfo>>,
    #[cfg(feature = "experimental-ota")]
    pub ota_state: OtaUpdateState,
    #[cfg(feature = "ssl")]
    pub ssl_cb_info: SslCallbackInfo,
    #[cfg(feature = "ethernet")]
    pub eth_rx_info: Option<Option<EthernetRxInfo>>,
}

#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub(crate) struct ConnectResult {
    pub error: SocketError,
}

#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub(crate) struct SendRequest {
    pub offset: usize,
    pub grand_total_sent: i16,
    pub total_sent: i16,
    pub remaining: i16,
}

#[derive(Debug, Clone, Copy, PartialEq)]
pub(crate) struct RecvResult {
    pub recv_len: usize,
    pub from_addr: core::net::SocketAddrV4,
    pub error: SocketError,
    pub return_offset: usize, // Track how much data has been returned to caller
}
#[cfg(feature = "defmt")]
impl defmt::Format for RecvResult {
    fn format(&self, f: defmt::Formatter) {
        defmt::write!(
            f,
            "recv_len: {}, from_addr: {:?}, error: {}, return_offset: {}",
            self.recv_len,
            Ipv4AddrFormatWrapper::new(self.from_addr.ip()),
            self.error,
            self.return_offset
        );
    }
}

#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub(crate) struct BindListenResult {
    pub error: SocketError,
}

#[derive(Debug, Clone, Copy, PartialEq)]
pub(crate) struct AcceptResult {
    pub accept_addr: core::net::SocketAddrV4,
    pub accepted_socket: Socket,
}
#[cfg(feature = "defmt")]
impl defmt::Format for AcceptResult {
    fn format(&self, f: defmt::Formatter) {
        defmt::write!(
            f,
            "accept_addr: {:?}, port: {}, accepted_socket: {:?}",
            Ipv4AddrFormatWrapper::new(self.accept_addr.ip()),
            self.accept_addr.port(),
            self.accepted_socket
        );
    }
}

#[derive(PartialEq, Clone, Copy, Debug)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum AsyncState {
    Pending(Option<u32>),
    Done,
}

#[derive(PartialEq, Clone, Copy, Debug)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum AsyncOp {
    Connect(Option<ConnectResult>),
    Send(SendRequest, Option<i16>),
    SendTo(SendRequest, Option<i16>),
    Recv(Option<RecvResult>),
    RecvFrom(Option<RecvResult>),
    Accept(Option<AcceptResult>),
}

#[derive(PartialEq, Clone, Copy, Debug)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum ClientSocketOp {
    None,
    New,
    Bind(Option<BindListenResult>),
    Listen(Option<BindListenResult>),
    AsyncOp(AsyncOp, AsyncState),
}

/// PRNG (Pseudorandom Number Generator) structure.
/// The `defmt` feature derives `defmt::Format` for logging/serialization if enabled.
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct Prng {
    pub offset: usize,
    pub rcv_buffer: Option<[u8; PRNG_DATA_LENGTH]>,
}

impl SocketCallbacks {
    pub fn new() -> Self {
        Self {
            tcp_sockets: SockHolder::new(),
            udp_sockets: SockHolder::new(),
            listening_sockets: [false; NUM_TCP_SOCKETS],
            accept_backlog: [None; NUM_TCP_SOCKETS],
            udp_socket_connect_addr: [None; MAX_UDP_SOCKETS],
            recv_buffer: [0; SOCKET_BUFFER_MAX_LENGTH],
            dns_resolved_addr: None,
            connection_state: ConnectionState::new(),
            state: WifiModuleState::Reset,
            prng: None,
            provisioning_info: None,
            #[cfg(feature = "experimental-ota")]
            ota_state: OtaUpdateState::NotStarted,
            #[cfg(feature = "ssl")]
            ssl_cb_info: SslCallbackInfo::default(),
            #[cfg(feature = "ethernet")]
            eth_rx_info: None,
        }
    }
    pub fn resolve(&mut self, socket: Socket) -> Option<&mut (Socket, ClientSocketOp)> {
        if socket.v < NUM_TCP_SOCKETS as u8 {
            debug!("resolving tcp: {:?}", socket.v);
            self.tcp_sockets.get(Handle(socket.v))
        } else {
            debug!("resolving udp: {:?}", socket.v);
            self.udp_sockets
                .get(Handle(socket.v - NUM_TCP_SOCKETS as u8))
        }
    }
}

impl EventListener for SocketCallbacks {
    fn on_rssi(&mut self, level: i8) {
        info!("client: Got RSSI:{}", level);
        self.connection_state.rssi_level = Some(Some(level));
    }

    fn on_resolve(&mut self, ip: core::net::Ipv4Addr, host: &str) {
        debug!(
            "on_resolve: ip:{:?} host:{:?}",
            Ipv4AddrFormatWrapper::new(&ip),
            host
        );
        self.dns_resolved_addr = Some(Some(ip));
    }

    fn on_default_connect(&mut self, status: WifiConnError) {
        debug!(
            "client: got connected {}",
            (status == WifiConnError::NoError)
        );

        if (self.state == WifiModuleState::ConnectingToAp) && (status != WifiConnError::NoError) {
            self.state = WifiModuleState::ConnectionFailed;
            self.connection_state.conn_error = Some(status);
        }
    }
    fn on_dhcp(&mut self, conf: crate::manager::IPConf) {
        debug!("client: on_dhcp: IP config: {}", conf);
        self.connection_state.ip_conf = Some(conf);
    }
    fn on_connstate_changed(&mut self, state: WifiConnState, err: WifiConnError) {
        debug!("client: Connection state changed: {:?} {:?}", state, err);
        self.connection_state.conn_state = state;
        self.connection_state.conn_error = Some(err);

        match self.connection_state.conn_state {
            WifiConnState::Connected => {
                if self.state != WifiModuleState::Provisioning
                    && self.state != WifiModuleState::AccessPoint
                {
                    self.state = WifiModuleState::ConnectedToAp;
                }
            }
            WifiConnState::Disconnected => {
                if self.state == WifiModuleState::ConnectingToAp {
                    self.state = WifiModuleState::ConnectionFailed;
                    debug!(
                        "on_connstate_changed FAILED: {:?} {:?}",
                        self.connection_state.conn_state, self.connection_state.conn_error
                    );
                } else if self.state != WifiModuleState::Provisioning
                    && self.state != WifiModuleState::AccessPoint
                {
                    self.state = WifiModuleState::Unconnected;
                }
            }
            _ => {
                error!(
                    "UNKNOWN STATE on_connstate_changed: {:?} {:?}",
                    self.connection_state.conn_state, self.connection_state.conn_error
                );
            }
        }
    }

    fn on_connection_info(&mut self, info: ConnectionInfo) {
        debug!("client: conninfo, state:{}", info);
        self.connection_state.conn_info = Some(Some(info));
    }
    fn on_system_time(&mut self, year: u16, month: u8, day: u8, hour: u8, minute: u8, second: u8) {
        debug!(
            "client: on_system_time: {}-{:02}-{:02} {:02}:{:02}:{:02}",
            year, month, day, hour, minute, second
        );
        self.connection_state.system_time = Some(SystemTime {
            year,
            month,
            day,
            hour,
            minute,
            second,
        });
    }
    fn on_ip_conflict(&mut self, ip: Ipv4Addr) {
        info!(
            "client: on_ip_conflict: {:?}",
            Ipv4AddrFormatWrapper::new(&ip)
        );
        self.connection_state.ip_conflict = Some(ip);
    }

    fn on_scan_result(&mut self, result: ScanResult) {
        debug!("Scanresult {}", result);
        self.connection_state.scan_results = Some(Some(result));
    }
    fn on_scan_done(&mut self, num_aps: u8, err: WifiConnError) {
        debug!("Scan done, aps:{} error:{}", num_aps, err);
        if err != WifiConnError::NoError {
            self.connection_state.conn_error = Some(err);
        }
        self.connection_state.scan_number_aps = Some(Some(num_aps));
    }
    fn on_ping(
        &mut self,
        ip: Ipv4Addr,
        token: u32,
        rtt: u32,
        num_successful: u16,
        num_failed: u16,
        error: PingError,
    ) {
        let ping_result = PingResult {
            ip,
            rtt,
            num_successful,
            num_failed,
            error,
        };
        debug!("client: on_ping: {:?} token:# {}", ping_result, token);
        self.connection_state.ping_result = Some(Some(ping_result));
    }

    // todo: Consolidate the error cases to match statements below
    fn on_connect(&mut self, socket: Socket, err: SocketError) {
        debug!("on_connect: socket {:?}", socket);
        match self.resolve(socket) {
            Some((
                _sock,
                ClientSocketOp::AsyncOp(
                    AsyncOp::Connect(option),
                    asyncstate @ AsyncState::Pending(_),
                ),
            )) => {
                #[cfg(feature = "ssl")]
                // update the data offset for ssl operations.
                _sock.set_ssl_data_offset(socket.get_ssl_data_offset());
                option.replace(ConnectResult { error: err });
                *asyncstate = AsyncState::Done;
            }
            Some((s, op)) => error!(
                "UNKNOWN STATE on_connect (x): socket:{:?} error:{:?} state:{:?}",
                s, err, op
            ),
            None => error!(
                "on_connect (x): COULD NOT FIND SOCKET socket:{:?} error:{:?}",
                socket, err
            ),
        }
    }
    fn on_send_to(&mut self, socket: Socket, len: i16) {
        debug!("on_send_to: socket:{:?} length:{:?}", socket, len);
        match self.resolve(socket) {
            Some((
                s,
                ClientSocketOp::AsyncOp(
                    AsyncOp::SendTo(req, option),
                    asyncstate @ AsyncState::Pending(_),
                ),
            )) => {
                req.total_sent += len;
                req.remaining -= len;
                if (req.remaining <= 0) || (len < 0) {
                    debug!("FIN: on_send_to: socket:{:?} length:{:?}", s, len);
                    option.replace(len);
                    *asyncstate = AsyncState::Done;
                } else {
                    debug!("CONT: on_send_to: socket:{:?} length:{:?}", s, len);
                }
            }
            Some((s, op)) => error!(
                "UNKNOWN STATE on_send_to (x): socket:{:?} len:{:?} state:{:?}",
                s, len, *op
            ),
            None => error!(
                "on_send (x): COULD NOT FIND SOCKET socket:{:?} len:{:?}",
                socket, len
            ),
        }
    }
    fn on_send(&mut self, socket: Socket, len: i16) {
        debug!("on_send: socket {:?} len:{}", socket, len);
        match self.resolve(socket) {
            Some((
                s,
                ClientSocketOp::AsyncOp(
                    AsyncOp::Send(req, option),
                    asyncstate @ AsyncState::Pending(_),
                ),
            )) => {
                req.total_sent += len;
                req.remaining -= len;
                if (req.remaining <= 0) || (len < 0) {
                    debug!("FIN: on_send: socket:{:?} length:{:?}", s, len);
                    option.replace(len);
                    *asyncstate = AsyncState::Done;
                } else {
                    debug!("CONT: on_send: socket:{:?} length:{:?}", s, len);
                }
            }
            Some((s, op)) => error!(
                "UNKNOWN STATE on_send (x): socket:{:?} len:{:?} state:{:?}",
                s, len, *op
            ),
            None => error!(
                "on_send (x): COULD NOT FIND SOCKET socket:{:?} len:{:?}",
                socket, len
            ),
        }
    }
    fn on_recv(
        &mut self,
        socket: Socket,
        address: core::net::SocketAddrV4,
        data: &[u8],
        err: crate::manager::SocketError,
    ) {
        debug!("on_recv: socket {:?}", socket);
        match self.resolve(socket) {
            Some((s, ClientSocketOp::AsyncOp(
                    AsyncOp::Recv(option),
                    asyncstate @ AsyncState::Pending(_),))) => {
                debug!(
                    "on_recv: socket:{:?} address:{:?} data:{:?} len:{:?} error:{:?}",
                    s,
                    Ipv4AddrFormatWrapper::new(address.ip()),
                    data,
                    data.len(),
                    err
                );
                option.replace(RecvResult {
                    recv_len: data.len(),
                    from_addr: address,
                    error: err,
                    return_offset: 0,
                });
                *asyncstate = AsyncState::Done;
                self.recv_buffer[..data.len()].copy_from_slice(data);
            }
            Some((_, op)) => error!(
                "Socket NOT in recv: socket:{:?} address:{:?} data:{:?} error:{:?} actual state:{:?}",
                socket,
                Ipv4AddrFormatWrapper::new(address.ip()),
                data,
                err, op
            ),
            None => error!(
                "UNKNOWN on_recv: socket:{:?} address:{:?} data:{:?} error:{:?}",
                socket,
                Ipv4AddrFormatWrapper::new(address.ip()),
                data,
                err
            ),
        }
    }
    fn on_recvfrom(
        &mut self,
        socket: Socket,
        address: core::net::SocketAddrV4,
        data: &[u8],
        err: crate::manager::SocketError,
    ) {
        debug!("on_recvfrom: socket {:?}", socket);
        match self.resolve(socket) {
            Some((s, ClientSocketOp::AsyncOp(
                    AsyncOp::RecvFrom(option),
                    asyncstate @ AsyncState::Pending(_),))) => {
                debug!(
                    "on_recvfrom: raw:{:?} socket:{:?} address:{:?} data:{:?} error:{:?}",
                    socket,
                    s,
                    Ipv4AddrFormatWrapper::new(address.ip()),
                    data,
                    err
                );
                option.replace(RecvResult {
                    recv_len: data.len(),
                    from_addr: address,
                    error: err,
                    return_offset: 0,
                });
                *asyncstate = AsyncState::Done;
                self.recv_buffer[..data.len()].copy_from_slice(data);
            }
            Some((_, op)) => error!(
                "Socket NOT in recvfrom: socket:{:?} address:{:?} data:{:?} error:{:?} actual state:{:?}",
                socket,
                Ipv4AddrFormatWrapper::new(address.ip()),
                data,
                err,
                op
            ),
            None => error!(
                "UNKNOWN on_recvfrom: socket:{:?} address:{:?} data:{:?} error:{:?}",
                socket,
                Ipv4AddrFormatWrapper::new(address.ip()),
                data,
                err
            ),
        }
    }
    fn on_bind(&mut self, sock: Socket, err: SocketError) {
        debug!("on_bind: socket {:?}", sock);
        match self.resolve(sock) {
            Some((_, ClientSocketOp::Bind(option))) => {
                option.replace(BindListenResult { error: err });
            }
            Some((s, op)) => error!(
                "UNKNOWN on_bind: socket:{:?} error:{:?} state:{:?}",
                s, err, op
            ),
            None => error!("UNKNOWN socket on_bind: socket:{:?} error:{:?}", sock, err),
        }
    }
    fn on_listen(&mut self, sock: Socket, err: SocketError) {
        debug!("on_listen: socket {:?}", sock);
        match self.resolve(sock) {
            Some((_, ClientSocketOp::Listen(option))) => {
                option.replace(BindListenResult { error: err });
            }
            Some((s, op)) => error!(
                "UNKNOWN on_listen: socket:{:?} error:{:?} state:{:?}",
                s, err, op
            ),
            None => error!(
                "UNKNOWN socket on_listen: socket:{:?} error:{:?}",
                sock, err
            ),
        }
    }

    fn on_accept(
        &mut self,
        address: core::net::SocketAddrV4,
        listen_socket: Socket,
        accepted_socket: Socket,
        _data_offset: u16,
    ) {
        debug!(
            "on_accept: address:{:?} port:{:?} listen_socket:{:?} accepted_socket:{:?}",
            Ipv4AddrFormatWrapper::new(address.ip()),
            address.port(),
            listen_socket,
            accepted_socket
        );
        let was_listening = self.listening_sockets[listen_socket.v as usize];

        match self.resolve(listen_socket) {
            Some((s, ClientSocketOp::AsyncOp(
                    AsyncOp::Accept(option),
                    asyncstate @ AsyncState::Pending(_),))) => {
                debug!("on_accept: socket:{:?} port:{:?} address:{:?} accepted_socket:{:?}", s,
                    Ipv4AddrFormatWrapper::new(address.ip()),
                    address.port(),
                    accepted_socket);
                option.replace(AcceptResult {
                    accept_addr: address,
                    accepted_socket,
                });
                *asyncstate = AsyncState::Done;
            }
            // Todo here: If it was in None state, move it to accept backlog
            Some((_, op)) => {
                info!(
                    "Socket was NOT in accept: address:{:?} port:{:?} listen_socket:{:?} accepted_socket:{:?} actual state:{:?} listening:{:?}",
                    Ipv4AddrFormatWrapper::new(address.ip()),
                    address.port(),
                    listen_socket,
                    accepted_socket,
                    op,
                    was_listening
                );

                // If the socket was listening, we will mark it as backlogged new socket
                // and put it in tcp sock store
                if was_listening {
                    let accept_socket_id = accepted_socket.v;
                    let handle = self.tcp_sockets.put(
                        Handle(accept_socket_id ),accepted_socket.s
                    );
                    if handle.is_some() {
                        if self.accept_backlog[accept_socket_id as usize].is_none() {
                            self.accept_backlog[accept_socket_id as usize] = Some((accepted_socket, address));
                        } else {
                            error!("Failed to put socket {:?} in tcp sock store, collision in accept backlog ?", accept_socket_id);
                        }
                    } else {
                        error!("Failed to put socket in tcp sock store, collision in tcp sock store ?");
                    }
                } else {
                    error!("Socket was not listening on {:?}", listen_socket);
                }
            } ,
            None => error!(
                "UNKNOWN socket on_accept: address:{:?} port:{:?} listen_socket:{:?} accepted_socket:{:?}",
                Ipv4AddrFormatWrapper::new(address.ip()),
                address.port(),
                listen_socket,
                accepted_socket
            ),
        }
    }

    /// Callback function to store the random bytes read from the chip in the PRNG data.
    ///
    /// # Arguments
    ///
    /// * `data` - Random bytes read from the chip.
    fn on_prng(&mut self, data: &[u8]) {
        if let Some(Some(prng)) = self.prng.as_mut() {
            if let ref mut buffer @ None = prng.rcv_buffer {
                let mut new_buf = [0u8; PRNG_DATA_LENGTH];
                new_buf[..data.len()].copy_from_slice(data);
                *buffer = Some(new_buf);
            }
        }
    }

    /// Callback function to store the provisioning information.
    ///
    /// # Arguments
    ///
    /// * `ssid` - The SSID received from the chip.
    /// * `passphrase` - The Wi-Fi passphrase.
    /// * `security` - The security type (e.g., WPA2).
    /// * `status` - Provisioning status (`true` if successful).
    fn on_provisioning(&mut self, ssid: Ssid, key: WpaKey, security: AuthType, status: bool) {
        let mut info = ProvisioningInfo {
            ssid,
            key: Credentials::Open,
            status,
        };
        // Check if provisioning was successful
        if status {
            let mut cred = Credentials::Open;

            match security {
                AuthType::Open => cred = Credentials::Open,
                AuthType::WpaPSK => cred = Credentials::WpaPSK(key),
                #[cfg(feature = "wep")]
                AuthType::WEP => {
                    let mut wep_key = WepKey::new();
                    let key_len = key.len().min(wep_key.capacity());
                    wep_key.push_str(&key[..key_len]);
                    cred = Credentials::Wep(wep_key, WepKeyIndex::Key1);
                }
                _ => error!("Invalid or Unsupported Authentication type"),
            }
            // Update the Credentials
            info.key = cred;
        }
        self.provisioning_info = Some(Some(info));
    }

    #[cfg(feature = "experimental-ota")]
    /// Callback function for OTA events.
    ///
    /// # Arguments
    ///
    /// * `status` - OTA Update Status.
    fn on_ota(&mut self, status: OtaUpdateStatus, error: OtaUpdateError) {
        if error == OtaUpdateError::AlreadyEnabled {
            error!("OTA operation {:?} is already enabled", status)
        }

        self.ota_state = match (status, self.ota_state) {
            (OtaUpdateStatus::Abort, OtaUpdateState::Aborting) => {
                if error == OtaUpdateError::NoError || error == OtaUpdateError::Aborted {
                    OtaUpdateState::Aborted
                } else {
                    OtaUpdateState::Failed(error)
                }
            }
            (OtaUpdateStatus::Download, OtaUpdateState::InProgress) => {
                if error == OtaUpdateError::UpdateInProgress {
                    OtaUpdateState::InProgress
                } else if error == OtaUpdateError::NoError {
                    OtaUpdateState::Complete
                } else {
                    OtaUpdateState::Failed(error)
                }
            }
            (OtaUpdateStatus::Rollback, OtaUpdateState::RollingBack) => {
                if error == OtaUpdateError::NoError {
                    OtaUpdateState::RolledBack
                } else {
                    OtaUpdateState::Failed(error)
                }
            }
            (OtaUpdateStatus::SwitchingFirmware, OtaUpdateState::SwitchingFirmware) => {
                if error == OtaUpdateError::NoError {
                    OtaUpdateState::Switched
                } else {
                    OtaUpdateState::Failed(error)
                }
            }
            (OtaUpdateStatus::Unhandled, _) => {
                error!("Invalid OTA update status received");
                OtaUpdateState::Failed(OtaUpdateError::Unhandled)
            }
            _ => {
                error!("OTA status does not match the required state.");
                self.ota_state // retain the value if conditions doesn't match
            }
        };
    }

    /// Callback function for SSL events triggered by the module.
    ///
    /// # Arguments
    ///
    /// * `ssl_res` - Type of SSL response received from the module.
    /// * `cipher_suite` - Optional 4-byte cipher suite bitmap.
    /// * `ecc_req` - Optional ECC request data.
    #[cfg(feature = "ssl")]
    fn on_ssl(
        &mut self,
        ssl_res: SslResponse,
        cipher_suite: Option<u32>,
        #[cfg(feature = "experimental-ecc")] ecc_req: Option<EccRequest>,
    ) {
        match ssl_res {
            SslResponse::CipherSuiteUpdate => {
                self.ssl_cb_info.cipher_suite_bitmap = Some(cipher_suite);
            }
            #[cfg(feature = "experimental-ecc")]
            SslResponse::EccReqUpdate => {
                self.ssl_cb_info.ecc_req = ecc_req;
            }
            _ => {
                error!("Invalid SSL event received.");
            }
        }
    }

    /// Callback function for Ethernet RX events triggered by the module.
    ///
    /// # Arguments
    ///
    /// * `packet_size` - The size of the data available to read.
    /// * `data_offset` - The register address offset from which data can be read.
    /// * `hif_address` - The HIF memory address where the Ethernet frame is stored.
    #[cfg(feature = "ethernet")]
    fn on_eth(&mut self, packet_size: u16, data_offset: u16, hif_address: u32) {
        self.eth_rx_info = Some(Some(EthernetRxInfo {
            packet_size,
            data_offset,
            hif_address,
        }));
    }
}