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