1 /**************************************************************************/
2 /* */
3 /* Copyright (c) Microsoft Corporation. All rights reserved. */
4 /* */
5 /* This software is licensed under the Microsoft Software License */
6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */
7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
8 /* and in the root directory of this software. */
9 /* */
10 /**************************************************************************/
11
12
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** NetX Component */
17 /** */
18 /** Packet Pool Management (Packet) */
19 /** */
20 /**************************************************************************/
21 /**************************************************************************/
22
23 #define NX_SOURCE_CODE
24
25
26 /* Include necessary system files. */
27
28 #include "nx_api.h"
29 #include "nx_packet.h"
30
31
32 /* Bring in externs for caller checking code. */
33
34 NX_CALLER_CHECKING_EXTERNS
35
36
37 /**************************************************************************/
38 /* */
39 /* FUNCTION RELEASE */
40 /* */
41 /* _nxe_packet_allocate PORTABLE C */
42 /* 6.1 */
43 /* AUTHOR */
44 /* */
45 /* Yuxin Zhou, Microsoft Corporation */
46 /* */
47 /* DESCRIPTION */
48 /* */
49 /* This function checks for errors in the packet allocate function */
50 /* call. */
51 /* */
52 /* INPUT */
53 /* */
54 /* pool_ptr Pool to allocate the packet */
55 /* packet_ptr Pointer to place allocated */
56 /* packet pointer */
57 /* packet_type Type of packet to allocate */
58 /* wait_option Suspension option */
59 /* */
60 /* OUTPUT */
61 /* */
62 /* status Completion status */
63 /* */
64 /* CALLS */
65 /* */
66 /* _nx_packet_allocate Actual packet allocate service*/
67 /* */
68 /* CALLED BY */
69 /* */
70 /* Application Code */
71 /* */
72 /* RELEASE HISTORY */
73 /* */
74 /* DATE NAME DESCRIPTION */
75 /* */
76 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
77 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
78 /* resulting in version 6.1 */
79 /* */
80 /**************************************************************************/
_nxe_packet_allocate(NX_PACKET_POOL * pool_ptr,NX_PACKET ** packet_ptr,ULONG packet_type,ULONG wait_option)81 UINT _nxe_packet_allocate(NX_PACKET_POOL *pool_ptr, NX_PACKET **packet_ptr,
82 ULONG packet_type, ULONG wait_option)
83 {
84
85 UINT status;
86
87
88 /* Check for invalid input pointers. */
89 if ((pool_ptr == NX_NULL) || (pool_ptr -> nx_packet_pool_id != NX_PACKET_POOL_ID) || (packet_ptr == NX_NULL))
90 {
91 return(NX_PTR_ERROR);
92 }
93
94 /* Check for an invalid packet type - for alignment purposes, it must be evenly divisible by the size
95 of a ULONG. */
96 if (packet_type % sizeof(ULONG))
97 {
98 return(NX_OPTION_ERROR);
99 }
100
101 /* Check for a thread caller if the wait option specifies suspension. */
102 NX_THREAD_WAIT_CALLER_CHECKING
103
104 /* Call actual packet allocate function. */
105 status = _nx_packet_allocate(pool_ptr, packet_ptr, packet_type, wait_option);
106
107 /* Return completion status. */
108 return(status);
109 }
110
111
