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 /**   Transmission Control Protocol (TCP)                                 */
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_tcp.h"
29 
30 /* Bring in externs for caller checking code.  */
31 
32 NX_CALLER_CHECKING_EXTERNS
33 
34 
35 /**************************************************************************/
36 /*                                                                        */
37 /*  FUNCTION                                               RELEASE        */
38 /*                                                                        */
39 /*    _nxe_tcp_socket_receive_notify                      PORTABLE C      */
40 /*                                                           6.2.1        */
41 /*  AUTHOR                                                                */
42 /*                                                                        */
43 /*    Yuxin Zhou, Microsoft Corporation                                   */
44 /*                                                                        */
45 /*  DESCRIPTION                                                           */
46 /*                                                                        */
47 /*    This function checks for errors in the TCP socket receive notify    */
48 /*    function call.                                                      */
49 /*                                                                        */
50 /*  INPUT                                                                 */
51 /*                                                                        */
52 /*    socket_ptr                            Pointer to TCP socket         */
53 /*    tcp_receive_notify                    Routine to call when one or   */
54 /*                                            receive packets are         */
55 /*                                            available for the socket    */
56 /*                                                                        */
57 /*  OUTPUT                                                                */
58 /*                                                                        */
59 /*    status                                Completion status             */
60 /*                                                                        */
61 /*  CALLS                                                                 */
62 /*                                                                        */
63 /*    _nx_tcp_socket_receive_notify         Actual socket receive notify  */
64 /*                                            function                    */
65 /*                                                                        */
66 /*  CALLED BY                                                             */
67 /*                                                                        */
68 /*    Application Code                                                    */
69 /*                                                                        */
70 /*  RELEASE HISTORY                                                       */
71 /*                                                                        */
72 /*    DATE              NAME                      DESCRIPTION             */
73 /*                                                                        */
74 /*  05-19-2020     Yuxin Zhou               Initial Version 6.0           */
75 /*  09-30-2020     Yuxin Zhou               Modified comment(s),          */
76 /*                                            resulting in version 6.1    */
77 /*  03-08-2023     Yajun Xia                Modified comment(s),          */
78 /*                                            removed invalid check,      */
79 /*                                            resulting in version 6.2.1  */
80 /*                                                                        */
81 /**************************************************************************/
_nxe_tcp_socket_receive_notify(NX_TCP_SOCKET * socket_ptr,VOID (* tcp_receive_notify)(NX_TCP_SOCKET * socket_ptr))82 UINT  _nxe_tcp_socket_receive_notify(NX_TCP_SOCKET *socket_ptr,
83                                      VOID (*tcp_receive_notify)(NX_TCP_SOCKET *socket_ptr))
84 {
85 
86 UINT status;
87 
88     /* Check for invalid input pointers.  */
89     if ((socket_ptr == NX_NULL) || (socket_ptr -> nx_tcp_socket_id != NX_TCP_ID))
90     {
91         return(NX_PTR_ERROR);
92     }
93 
94     /* Check to see if TCP is enabled.  */
95     if (!(socket_ptr -> nx_tcp_socket_ip_ptr) -> nx_ip_tcp_packet_receive)
96     {
97         return(NX_NOT_ENABLED);
98     }
99 
100     /* Check for appropriate caller.  */
101     NX_INIT_AND_THREADS_CALLER_CHECKING
102 
103 
104     /* Call actual socket receive notify function.  */
105     status =  _nx_tcp_socket_receive_notify(socket_ptr, tcp_receive_notify);
106 
107     /* Return to caller.  */
108     return(status);
109 }
110 
111