xref: /FreeRTOS-Plus-TCP-v4.0.0/tools/tcp_utilities/include/NTPDemo.h (revision 2d3f4daa567ffe71aeda2e0f6d0bc02850db0627) 
1 /*
2  * FreeRTOS+TCP <DEVELOPMENT BRANCH>
3  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
4  *
5  * SPDX-License-Identifier: MIT
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy of
8  * this software and associated documentation files (the "Software"), to deal in
9  * the Software without restriction, including without limitation the rights to
10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
11  * the Software, and to permit persons to whom the Software is furnished to do so,
12  * subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in all
15  * copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * http://aws.amazon.com/freertos
25  * http://www.FreeRTOS.org
26  */
27 
28 
29 /*
30  * A simple demo for NTP using FreeRTOS+TCP
31  */
32 
33 #ifndef NTPDEMO_H
34 
35 #define NTPDEMO_H
36 
37 void vStartNTPTask( uint16_t usTaskStackSize,
38                     UBaseType_t uxTaskPriority );
39 
40 /*
41  * xIPVersion = 4 or 6.
42  * xAsynchronous = true for asynchronous DNS lookups.
43  * xLogging = true to get more logging.
44  */
45 void vNTPSetNTPType( BaseType_t aIPType,
46                      BaseType_t xAsynchronous,
47                      BaseType_t xLogging );
48 
49 /* Delete the IP-addresses of the NTP server to force a DNS lookup. */
50 void vNTPClearCache( void );
51 
52 /* Check if the NTP task is running. */
53 BaseType_t xNTPTaskIsRunning( void );
54 
55 extern BaseType_t xNTPHasTime;
56 extern uint32_t ulNTPTime;
57 
58 #endif /* ifndef NTPDEMO_H */
59