1 /***************************************************************************
2 * Copyright (c) 2024 Microsoft Corporation
3 *
4 * This program and the accompanying materials are made available under the
5 * terms of the MIT License which is available at
6 * https://opensource.org/licenses/MIT.
7 *
8 * SPDX-License-Identifier: MIT
9 **************************************************************************/
10
11
12 /**************************************************************************/
13 /**************************************************************************/
14 /** */
15 /** NetX Component */
16 /** */
17 /** Internet Protocol (IP) */
18 /** */
19 /**************************************************************************/
20 /**************************************************************************/
21
22 #define NX_SOURCE_CODE
23
24
25 /* Include necessary system files. */
26
27 #include "nx_api.h"
28 #include "nx_ip.h"
29 #include "tx_timer.h"
30
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _nx_ip_periodic_timer_entry PORTABLE C */
37 /* 6.1 */
38 /* AUTHOR */
39 /* */
40 /* Yuxin Zhou, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This function handles waking up the IP helper thread on a periodic */
45 /* basis. Periodic IP processing includes ARP requests, IP fragment */
46 /* timeouts, and TCP timeouts. All of which are driven from this */
47 /* single periodic timer. */
48 /* */
49 /* INPUT */
50 /* */
51 /* ip_address IP address in a ULONG */
52 /* */
53 /* OUTPUT */
54 /* */
55 /* None */
56 /* */
57 /* CALLS */
58 /* */
59 /* tx_event_flags_set Set event flags to wakeup */
60 /* IP helper thread */
61 /* */
62 /* CALLED BY */
63 /* */
64 /* ThreadX system timer thread */
65 /* */
66 /* RELEASE HISTORY */
67 /* */
68 /* DATE NAME DESCRIPTION */
69 /* */
70 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
71 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
72 /* resulting in version 6.1 */
73 /* */
74 /**************************************************************************/
_nx_ip_periodic_timer_entry(ULONG ip_address)75 VOID _nx_ip_periodic_timer_entry(ULONG ip_address)
76 {
77
78 NX_IP *ip_ptr;
79
80
81 /* Setup IP pointer. */
82 NX_TIMER_EXTENSION_PTR_GET(ip_ptr, NX_IP, ip_address)
83
84 /* Wakeup this IP's helper thread. */
85 tx_event_flags_set(&(ip_ptr -> nx_ip_events), NX_IP_PERIODIC_EVENT, TX_OR);
86 }
87
88