AM261x MCU+ SDK: icssg_timesync.h Source File

| AM261x MCU+ SDK 26.00.00 |

icssg_timesync.h
Go to the documentation of this file.
1 /*
2 * Copyright (c) Texas Instruments Incorporated 2021
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the
14 * distribution.
15 *
16 * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
50 #ifndef ICSSG_TIMESYNC_H_
51 #define ICSSG_TIMESYNC_H_
52
53 /* ========================================================================== */
54 /* Include Files */
55 /* ========================================================================== */
56
57 #include <stdint.h>
58 #include <include/core/enet_mod_timesync.h>
59
60 #ifdef __cplusplus
61 extern "C" {
62 #endif
63
64 /* ========================================================================== */
65 /* Macros */
66 /* ========================================================================== */
67
68 /* None */
69
70 /* ========================================================================== */
71 /* Structures and Enums */
72 /* ========================================================================== */
73
77 typedef enum IcssgTimeSync_ClkType_e
78 {
80 ICSSG_TIMESYNC_CLKTYPE_WORKING_CLOCK = 1U,
81
83 ICSSG_TIMESYNC_CLKTYPE_SYSTEM_TIME,
84
86 ICSSG_TIMESYNC_CLKTYPE_GLOBAL_TIME,
87 } IcssgTimeSync_ClkType;
88
92 typedef struct IcssgTimeSync_Cfg_s
93 {
102 bool enable;
103
105 IcssgTimeSync_ClkType clkType;
106
108 uint32_t syncOut_start_WC;
109
111 uint32_t syncOut_pwidth_WC;
112 } IcssgTimeSync_Cfg;
113
114 /* ========================================================================== */
115 /* Global Variables Declarations */
116 /* ========================================================================== */
117
118 /* None */
119
120 /* ========================================================================== */
121 /* Function Declarations */
122 /* ========================================================================== */
123
124 /* None */
125
126 /* ========================================================================== */
127 /* Deprecated Function Declarations */
128 /* ========================================================================== */
129
130 /* None */
131
132 /* ========================================================================== */
133 /* Static Function Definitions */
134 /* ========================================================================== */
135
136 /* None */
137
138 #ifdef __cplusplus
139 }
140 #endif
141
142 #endif /* ICSSG_TIMESYNC_H_ */
143
IcssgTimeSync_ClkType
IcssgTimeSync_ClkType
ICSSG TimeSync clock types.
Definition: icssg_timesync.h:78
ICSSG_TIMESYNC_CLKTYPE_SYSTEM_TIME
@ ICSSG_TIMESYNC_CLKTYPE_SYSTEM_TIME
Definition: icssg_timesync.h:83
ICSSG_TIMESYNC_CLKTYPE_GLOBAL_TIME
@ ICSSG_TIMESYNC_CLKTYPE_GLOBAL_TIME
Definition: icssg_timesync.h:86
IcssgTimeSync_Cfg::enable
bool enable
Definition: icssg_timesync.h:102
ICSSG_TIMESYNC_CLKTYPE_WORKING_CLOCK
@ ICSSG_TIMESYNC_CLKTYPE_WORKING_CLOCK
Definition: icssg_timesync.h:80
enet_mod_timesync.h
This file contains the type definitions and helper macros for the Enet Time Synchronization module in...
IcssgTimeSync_Cfg::clkType
IcssgTimeSync_ClkType clkType
Definition: icssg_timesync.h:105
IcssgTimeSync_Cfg
TimeSync configuration parameters.
Definition: icssg_timesync.h:93
IcssgTimeSync_Cfg::syncOut_start_WC
uint32_t syncOut_start_WC
Definition: icssg_timesync.h:108
IcssgTimeSync_Cfg::syncOut_pwidth_WC
uint32_t syncOut_pwidth_WC
Definition: icssg_timesync.h:111