xref: /FreeRTOS-Plus-TCP-v3.1.0/test/unit-test/ConfigFiles/NetworkBufferManagement.h (revision 37bdfe577f3b728058de714e2e747d3c78803f26) 
1 /*
2  * FreeRTOS+TCP V3.1.0
3  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
4  *
5  * SPDX-License-Identifier: MIT
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy of
8  * this software and associated documentation files (the "Software"), to deal in
9  * the Software without restriction, including without limitation the rights to
10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
11  * the Software, and to permit persons to whom the Software is furnished to do so,
12  * subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in all
15  * copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * http://aws.amazon.com/freertos
25  * http://www.FreeRTOS.org
26  */
27 
28 #ifndef NETWORK_BUFFER_MANAGEMENT_H
29     #define NETWORK_BUFFER_MANAGEMENT_H
30 
31     #ifdef __cplusplus
32         extern "C" {
33     #endif
34 
35 /* NOTE PUBLIC API FUNCTIONS. */
36     BaseType_t xNetworkBuffersInitialise( void );
37     NetworkBufferDescriptor_t * pxGetNetworkBufferWithDescriptor( size_t xRequestedSizeBytes,
38                                                                   TickType_t xBlockTimeTicks );
39     NetworkBufferDescriptor_t * pxNetworkBufferGetFromISR( size_t xRequestedSizeBytes );
40     void vReleaseNetworkBufferAndDescriptor( NetworkBufferDescriptor_t * const pxNetworkBuffer );
41     BaseType_t vNetworkBufferReleaseFromISR( NetworkBufferDescriptor_t * const pxNetworkBuffer );
42     uint8_t * pucGetNetworkBuffer( size_t * pxRequestedSizeBytes );
43     void vReleaseNetworkBuffer( uint8_t * pucEthernetBuffer );
44 
45 /* Get the current number of free network buffers. */
46     UBaseType_t uxGetNumberOfFreeNetworkBuffers( void );
47 
48 /* Get the lowest number of free network buffers. */
49     UBaseType_t uxGetMinimumFreeNetworkBuffers( void );
50 
51 /* Copy a network buffer into a bigger buffer. */
52     NetworkBufferDescriptor_t * pxDuplicateNetworkBufferWithDescriptor( NetworkBufferDescriptor_t * const pxNetworkBuffer,
53                                                                         size_t uxNewLength );
54 
55 /* Increase the size of a Network Buffer.
56  * In case BufferAllocation_2.c is used, the new space must be allocated. */
57     NetworkBufferDescriptor_t * pxResizeNetworkBufferWithDescriptor( NetworkBufferDescriptor_t * pxNetworkBuffer,
58                                                                      size_t xNewSizeBytes );
59 
60     #if ipconfigTCP_IP_SANITY
61 
62 /*
63  * Check if an address is a valid pointer to a network descriptor
64  * by looking it up in the array of network descriptors
65  */
66         UBaseType_t bIsValidNetworkDescriptor( const NetworkBufferDescriptor_t * pxDesc );
67         BaseType_t prvIsFreeBuffer( const NetworkBufferDescriptor_t * pxDescr );
68     #endif
69 
70     #ifdef __cplusplus
71         } /* extern "C" */
72     #endif
73 
74 #endif /* NETWORK_BUFFER_MANAGEMENT_H */
75