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

   1 /*\r
   2  * FreeRTOS+TCP V2.0.1\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://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  * 1 tab == 4 spaces!\r
  26  */\r
  27 \r
  28 #ifndef NETWORK_BUFFER_MANAGEMENT_H\r
  29 #define NETWORK_BUFFER_MANAGEMENT_H\r
  30 \r
  31 #ifdef __cplusplus\r
  32 extern "C" {\r
  33 #endif\r
  34 \r
  35 /* NOTE PUBLIC API FUNCTIONS. */\r
  36 BaseType_t xNetworkBuffersInitialise( void );\r
  37 NetworkBufferDescriptor_t *pxGetNetworkBufferWithDescriptor( size_t xRequestedSizeBytes, TickType_t xBlockTimeTicks );\r
  38 NetworkBufferDescriptor_t *pxNetworkBufferGetFromISR( size_t xRequestedSizeBytes );\r
  39 void vReleaseNetworkBufferAndDescriptor( NetworkBufferDescriptor_t * const pxNetworkBuffer );\r
  40 BaseType_t vNetworkBufferReleaseFromISR( NetworkBufferDescriptor_t * const pxNetworkBuffer );\r
  41 uint8_t *pucGetNetworkBuffer( size_t *pxRequestedSizeBytes );\r
  42 void vReleaseNetworkBuffer( uint8_t *pucEthernetBuffer );\r
  43 \r
  44 /* Get the current number of free network buffers. */\r
  45 UBaseType_t uxGetNumberOfFreeNetworkBuffers( void );\r
  46 \r
  47 /* Get the lowest number of free network buffers. */\r
  48 UBaseType_t uxGetMinimumFreeNetworkBuffers( void );\r
  49 \r
  50 /* Copy a network buffer into a bigger buffer. */\r
  51 NetworkBufferDescriptor_t *pxDuplicateNetworkBufferWithDescriptor( NetworkBufferDescriptor_t * const pxNetworkBuffer,\r
  52         BaseType_t xNewLength);\r
  53 \r
  54 /* Increase the size of a Network Buffer.\r
  55 In case BufferAllocation_2.c is used, the new space must be allocated. */\r
  56 NetworkBufferDescriptor_t *pxResizeNetworkBufferWithDescriptor( NetworkBufferDescriptor_t * pxNetworkBuffer,\r
  57         size_t xNewSizeBytes );\r
  58 \r
  59 #if ipconfigTCP_IP_SANITY\r
  60         /*\r
  61          * Check if an address is a valid pointer to a network descriptor\r
  62          * by looking it up in the array of network descriptors\r
  63          */\r
  64         UBaseType_t bIsValidNetworkDescriptor (const NetworkBufferDescriptor_t * pxDesc);\r
  65         BaseType_t prvIsFreeBuffer( const NetworkBufferDescriptor_t *pxDescr );\r
  66 #endif\r
  67 \r
  68 #ifdef __cplusplus\r
  69 } // extern "C"\r
  70 #endif\r
  71 \r
  72 #endif /* NETWORK_BUFFER_MANAGEMENT_H */\r