git.sur5r.net Git - freertos/blob - FreeRTOS-Plus/Source/FreeRTOS-Plus-TCP/include/NetworkBufferManagement.h

   1 /*\r
   2  * FreeRTOS+TCP V2.0.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. If you wish to use our Amazon\r
  14  * FreeRTOS name, please do so in a fair use way that does not cause confusion.\r
  15  *\r
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  18  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  19  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  20  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  22  *\r
  23  * http://www.FreeRTOS.org\r
  24  * http://aws.amazon.com/freertos\r
  25  *\r
  26  * 1 tab == 4 spaces!\r
  27  */\r
  28 \r
  29 #ifndef NETWORK_BUFFER_MANAGEMENT_H\r
  30 #define NETWORK_BUFFER_MANAGEMENT_H\r
  31 \r
  32 #ifdef __cplusplus\r
  33 extern "C" {\r
  34 #endif\r
  35 \r
  36 /* NOTE PUBLIC API FUNCTIONS. */\r
  37 BaseType_t xNetworkBuffersInitialise( void );\r
  38 NetworkBufferDescriptor_t *pxGetNetworkBufferWithDescriptor( size_t xRequestedSizeBytes, TickType_t xBlockTimeTicks );\r
  39 NetworkBufferDescriptor_t *pxNetworkBufferGetFromISR( size_t xRequestedSizeBytes );\r
  40 void vReleaseNetworkBufferAndDescriptor( NetworkBufferDescriptor_t * const pxNetworkBuffer );\r
  41 BaseType_t vNetworkBufferReleaseFromISR( NetworkBufferDescriptor_t * const pxNetworkBuffer );\r
  42 uint8_t *pucGetNetworkBuffer( size_t *pxRequestedSizeBytes );\r
  43 void vReleaseNetworkBuffer( uint8_t *pucEthernetBuffer );\r
  44 \r
  45 /* Get the current number of free network buffers. */\r
  46 UBaseType_t uxGetNumberOfFreeNetworkBuffers( void );\r
  47 \r
  48 /* Get the lowest number of free network buffers. */\r
  49 UBaseType_t uxGetMinimumFreeNetworkBuffers( void );\r
  50 \r
  51 /* Copy a network buffer into a bigger buffer. */\r
  52 NetworkBufferDescriptor_t *pxDuplicateNetworkBufferWithDescriptor( NetworkBufferDescriptor_t * const pxNetworkBuffer,\r
  53         BaseType_t xNewLength);\r
  54 \r
  55 /* Increase the size of a Network Buffer.\r
  56 In case BufferAllocation_2.c is used, the new space must be allocated. */\r
  57 NetworkBufferDescriptor_t *pxResizeNetworkBufferWithDescriptor( NetworkBufferDescriptor_t * pxNetworkBuffer,\r
  58         size_t xNewSizeBytes );\r
  59 \r
  60 #if ipconfigTCP_IP_SANITY\r
  61         /*\r
  62          * Check if an address is a valid pointer to a network descriptor\r
  63          * by looking it up in the array of network descriptors\r
  64          */\r
  65         UBaseType_t bIsValidNetworkDescriptor (const NetworkBufferDescriptor_t * pxDesc);\r
  66         BaseType_t prvIsFreeBuffer( const NetworkBufferDescriptor_t *pxDescr );\r
  67 #endif\r
  68 \r
  69 #ifdef __cplusplus\r
  70 } // extern "C"\r
  71 #endif\r
  72 \r
  73 #endif /* NETWORK_BUFFER_MANAGEMENT_H */\r