mirror of
https://github.com/FreeRTOS/FreeRTOS-Plus-TCP
synced 2025-10-24 12:02:37 +08:00
172 lines
5.0 KiB
C
172 lines
5.0 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
|
|
*/
|
|
|
|
/**
|
|
* @file FreeRTOS_IP_Timers.h
|
|
* @brief Header file for IP Timers on FreeRTOS+TCP network stack.
|
|
*/
|
|
|
|
#ifndef FREERTOS_IP_TIMERS_H
|
|
#define FREERTOS_IP_TIMERS_H
|
|
|
|
/* *INDENT-OFF* */
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
/* *INDENT-ON* */
|
|
|
|
/* Standard includes. */
|
|
#include <stdint.h>
|
|
#include <stdio.h>
|
|
#include <string.h>
|
|
|
|
/* FreeRTOS includes. */
|
|
#include "FreeRTOS.h"
|
|
#include "task.h"
|
|
#include "queue.h"
|
|
#include "semphr.h"
|
|
|
|
/* FreeRTOS+TCP includes. */
|
|
#include "FreeRTOS_IP.h"
|
|
#include "FreeRTOS_Sockets.h"
|
|
#include "FreeRTOS_IP_Private.h"
|
|
#include "FreeRTOS_ARP.h"
|
|
#include "FreeRTOS_UDP_IP.h"
|
|
#include "FreeRTOS_DHCP.h"
|
|
#include "NetworkInterface.h"
|
|
#include "NetworkBufferManagement.h"
|
|
#include "FreeRTOS_DNS.h"
|
|
|
|
/*
|
|
* Checks the ARP, DHCP and TCP timers to see if any periodic or timeout
|
|
* processing is required.
|
|
*/
|
|
void vCheckNetworkTimers( void );
|
|
|
|
/*
|
|
* Determine how long the IP task can sleep for, which depends on when the next
|
|
* periodic or timeout processing must be performed.
|
|
*/
|
|
TickType_t xCalculateSleepTime( void );
|
|
|
|
/*
|
|
* Start an ARP Resolution timer.
|
|
*/
|
|
void vIPTimerStartARPResolution( TickType_t xTime );
|
|
/*TODO */
|
|
void vIPSetTCPTimerExpiredState( BaseType_t xExpiredState );
|
|
|
|
/*
|
|
* Enable/disable the ARP timer.
|
|
*/
|
|
void vIPSetARPTimerEnableState( BaseType_t xEnableState );
|
|
|
|
/*
|
|
* Enable or disable the ARP resolution timer.
|
|
*/
|
|
void vIPSetARPResolutionTimerEnableState( BaseType_t xEnableState );
|
|
|
|
#if ( ipconfigUSE_DHCP != 0 )
|
|
|
|
/** TODO
|
|
* @brief Enable/disable the DHCP timer.
|
|
* @param[in] xEnableState: pdTRUE - enable timer; pdFALSE - disable timer.
|
|
*/
|
|
void vIPSetDHCPTimerEnableState( BaseType_t xEnableState );
|
|
#endif
|
|
|
|
#if ( ipconfigUSE_DHCP == 1 ) || ( ipconfigUSE_RA == 1 )
|
|
|
|
/**
|
|
* @brief Enable/disable the DHCP/RA timer.
|
|
* @param[in] pxEndPoint: The end-point for which the timer will be called.
|
|
* @param[in] xEnableState: pdTRUE - enable timer; pdFALSE - disable timer.
|
|
*/
|
|
void vIPSetDHCP_RATimerEnableState( struct xNetworkEndPoint * pxEndPoint,
|
|
BaseType_t xEnableState );
|
|
#endif /* ( ipconfigUSE_DHCP == 1 ) || ( ipconfigUSE_RA == 1 ) */
|
|
|
|
|
|
#if ( ipconfigUSE_DHCP == 1 ) || ( ipconfigUSE_RA == 1 )
|
|
|
|
/**
|
|
* @brief Enable/disable the DHCP/RA timer.
|
|
* @param[in] pxEndPoint: The end-point for which the timer will be called.
|
|
* @param[in] xEnableState: pdTRUE - enable timer; pdFALSE - disable timer.
|
|
*/
|
|
void vIPSetDHCP_RATimerEnableState( struct xNetworkEndPoint * pxEndPoint,
|
|
BaseType_t xEnableState );
|
|
#endif /* ( ipconfigUSE_DHCP == 1 ) || ( ipconfigUSE_RA == 1 ) */
|
|
|
|
#if ( ipconfigDNS_USE_CALLBACKS != 0 )
|
|
|
|
/**
|
|
* @brief Enable/disable the DNS timer.
|
|
* @param[in] xEnableState: pdTRUE - enable timer; pdFALSE - disable timer.
|
|
*/
|
|
void vIPSetDNSTimerEnableState( BaseType_t xEnableState );
|
|
#endif /* ipconfigDNS_USE_CALLBACKS != 0 */
|
|
|
|
/**
|
|
* Sets the reload time of an ARP timer and restarts it.
|
|
*/
|
|
void vARPTimerReload( TickType_t xTime );
|
|
|
|
/**
|
|
* Sets the reload time of an TCP timer and restarts it.
|
|
*/
|
|
void vTCPTimerReload( TickType_t xTime );
|
|
#if ( ipconfigUSE_DHCP == 1 ) /*TODO */
|
|
void vDHCPTimerReload( TickType_t xLeaseTime );
|
|
#endif
|
|
|
|
#if ( ipconfigUSE_DHCP == 1 ) || ( ipconfigUSE_RA == 1 )
|
|
void vDHCP_RATimerReload( struct xNetworkEndPoint * pxEndPoint,
|
|
TickType_t uxClockTicks );
|
|
#endif /* ( ipconfigUSE_DHCP == 1 ) || ( ipconfigUSE_RA == 1 ) */
|
|
|
|
#if ( ipconfigDNS_USE_CALLBACKS != 0 )
|
|
|
|
/**
|
|
* Reload the DNS timer.
|
|
*/
|
|
void vDNSTimerReload( uint32_t ulCheckTime );
|
|
#endif /* ipconfigDNS_USE_CALLBACKS != 0 */
|
|
|
|
/**
|
|
* Reload the Network timer.
|
|
*/
|
|
void vNetworkTimerReload( TickType_t xTime );
|
|
|
|
/* *INDENT-OFF* */
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
/* *INDENT-ON* */
|
|
|
|
#endif /* FREERTOS_IP_TIMERS_H */
|