mirror of
https://github.com/FreeRTOS/FreeRTOS-Plus-TCP
synced 2025-10-23 10:07:43 +08:00
31a549b73a
* End Point changes #PR 713 * Fix build issues in PR#713 : extra */ in FreeRTOS_Routing.c * Fix Mathcing EndPoint function in Zynq Interface * Update FreeRTOS_ARP.c * Spell check fix * Fix build check issue : add const in xIPv6_GetIPType declaration * Uncrustify: triggered by comment. --------- Co-authored-by: GitHub Action <action@github.com>
89 lines
3.7 KiB
C
89 lines
3.7 KiB
C
/*
|
|
* FreeRTOS+TCP <DEVELOPMENT BRANCH>
|
|
* Copyright (C) 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
*
|
|
* SPDX-License-Identifier: MIT
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
* this software and associated documentation files (the "Software"), to deal in
|
|
* the Software without restriction, including without limitation the rights to
|
|
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
* the Software, and to permit persons to whom the Software is furnished to do so,
|
|
* subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
* copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*
|
|
* http://aws.amazon.com/freertos
|
|
* http://www.FreeRTOS.org
|
|
*/
|
|
|
|
#ifndef NETWORK_BUFFER_MANAGEMENT_H
|
|
#define NETWORK_BUFFER_MANAGEMENT_H
|
|
|
|
/* *INDENT-OFF* */
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
/* *INDENT-ON* */
|
|
|
|
/* _HT_ Two macro's needed while debugging/testing, please ignore. */
|
|
|
|
#define BUFFER_FROM_WHERE_DECL
|
|
#define BUFFER_FROM_WHERE_CALL( aWhere )
|
|
|
|
/* NOTE PUBLIC API FUNCTIONS. */
|
|
BaseType_t xNetworkBuffersInitialise( void );
|
|
NetworkBufferDescriptor_t * pxGetNetworkBufferWithDescriptor( size_t xRequestedSizeBytes,
|
|
TickType_t xBlockTimeTicks );
|
|
|
|
/* The definition of the below function is only available if BufferAllocation_2.c has been linked into the source. */
|
|
NetworkBufferDescriptor_t * pxNetworkBufferGetFromISR( size_t xRequestedSizeBytes );
|
|
void vReleaseNetworkBufferAndDescriptor( NetworkBufferDescriptor_t * const pxNetworkBuffer );
|
|
|
|
/* The definition of the below function is only available if BufferAllocation_2.c has been linked into the source. */
|
|
BaseType_t vNetworkBufferReleaseFromISR( NetworkBufferDescriptor_t * const pxNetworkBuffer );
|
|
uint8_t * pucGetNetworkBuffer( size_t * pxRequestedSizeBytes );
|
|
void vReleaseNetworkBuffer( uint8_t * pucEthernetBuffer );
|
|
|
|
/* Get the current number of free network buffers. */
|
|
UBaseType_t uxGetNumberOfFreeNetworkBuffers( void );
|
|
|
|
/* Get the lowest number of free network buffers. */
|
|
UBaseType_t uxGetMinimumFreeNetworkBuffers( void );
|
|
|
|
/* Copy a network buffer into a bigger buffer. */
|
|
NetworkBufferDescriptor_t * pxDuplicateNetworkBufferWithDescriptor( const NetworkBufferDescriptor_t * const pxNetworkBuffer,
|
|
size_t uxNewLength );
|
|
|
|
/* Increase the size of a Network Buffer.
|
|
* In case BufferAllocation_2.c is used, the new space must be allocated. */
|
|
NetworkBufferDescriptor_t * pxResizeNetworkBufferWithDescriptor( NetworkBufferDescriptor_t * pxNetworkBuffer,
|
|
size_t xNewSizeBytes );
|
|
|
|
#if ipconfigTCP_IP_SANITY
|
|
|
|
/*
|
|
* Check if an address is a valid pointer to a network descriptor
|
|
* by looking it up in the array of network descriptors
|
|
*/
|
|
UBaseType_t bIsValidNetworkDescriptor( const NetworkBufferDescriptor_t * pxDesc );
|
|
BaseType_t prvIsFreeBuffer( const NetworkBufferDescriptor_t * pxDescr );
|
|
#endif
|
|
|
|
/* *INDENT-OFF* */
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
/* *INDENT-ON* */
|
|
|
|
|
|
#endif /* NETWORK_BUFFER_MANAGEMENT_H */
|