AM261x MCU+ SDK: gptpmasterclock.h Source File

| AM261x MCU+ SDK 26.00.00 |

gptpmasterclock.h
Go to the documentation of this file.
1 /*
2 * Copyright (c) 2023 Texas Instruments Incorporated
3 * Copyright (c) 2023 Excelfore Corporation (https://excelfore.com)
4 *
5 * All rights reserved not granted herein.
6 * Limited License.
7 *
8 * Texas Instruments Incorporated grants a world-wide, royalty-free,
9 * non-exclusive license under copyrights and patents it now or hereafter
10 * owns or controls to make, have made, use, import, offer to sell and sell ("Utilize")
11 * this software subject to the terms herein. With respect to the foregoing patent
12 * license, such license is granted solely to the extent that any such patent is necessary
13 * to Utilize the software alone. The patent license shall not apply to any combinations which
14 * include this software, other than combinations with devices manufactured by or for TI ("TI Devices").
15 * No hardware patent is licensed hereunder.
16 *
17 * Redistributions must preserve existing copyright notices and reproduce this license (including the
18 * above copyright notice and the disclaimer and (if applicable) source code license limitations below)
19 * in the documentation and/or other materials provided with the distribution
20 *
21 * Redistribution and use in binary form, without modification, are permitted provided that the following
22 * conditions are met:
23 *
24 * * No reverse engineering, decompilation, or disassembly of this software is permitted with respect to any
25 * software provided in binary form.
26 * * any redistribution and use are licensed by TI for use only with TI Devices.
27 * * Nothing shall obligate TI to provide you with source code for the software licensed and provided to you in object code.
28 *
29 * If software source code is provided to you, modification and redistribution of the source code are permitted
30 * provided that the following conditions are met:
31 *
32 * * any redistribution and use of the source code, including any resulting derivative works, are licensed by
33 * TI for use only with TI Devices.
34 * * any redistribution and use of any object code compiled from the source code and any resulting derivative
35 * works, are licensed by TI for use only with TI Devices.
36 *
37 * Neither the name of Texas Instruments Incorporated nor the names of its suppliers may be used to endorse or
38 * promote products derived from this software without specific prior written permission.
39 *
40 * DISCLAIMER.
41 *
42 * THIS SOFTWARE IS PROVIDED BY TI AND TI"S LICENSORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
43 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
44 * IN NO EVENT SHALL TI AND TI"S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
45 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
46 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
47 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
48 * POSSIBILITY OF SUCH DAMAGE.
49 */
58 #ifndef GPTPMASTERCLOCK_H_
59 #define GPTPMASTERCLOCK_H_
60
69 int gptpmasterclock_init(const char *shmem_name);
70
75 int gptpmasterclock_close(void);
76
81 int gptpmasterclock_gm_domainIndex(void);
82
88 int64_t gptpmasterclock_getts64(void);
89
99 int gptpmasterclock_wait_until_ts64(int64_t tts, int64_t vclose, int64_t toofar);
100
108 uint64_t gptpmasterclock_expand_timestamp(uint32_t timestamp);
109
119 uint64_t gptpmasterclock_expand_timestamp_ts64(uint32_t timestamp, int64_t ts64);
120
125 int gptpmasterclock_gmchange_ind(void);
126
131 int gptpmasterclock_get_max_domains(void);
132
139 int gptpmasterclock_get_domain_ts64(int64_t *ts64, int domainIndex);
140
144 void gptpmasterclock_dump_offset(void);
145
146 #endif
147
gptpmasterclock_gm_domainIndex
int gptpmasterclock_gm_domainIndex(void)
return the domainIndex which is currently used as systeme wide gptp clock.
gptpmasterclock_dump_offset
void gptpmasterclock_dump_offset(void)
print phase offset for all domains
gptpmasterclock_gmchange_ind
int gptpmasterclock_gmchange_ind(void)
get GM change indicator, the number is incremented whenever GM is changed
gptpmasterclock_wait_until_ts64
int gptpmasterclock_wait_until_ts64(int64_t tts, int64_t vclose, int64_t toofar)
Wait until tts comes.
gptpmasterclock_init
int gptpmasterclock_init(const char *shmem_name)
initialize to get gptp clock from tsn_gptp daemon. if previously initialized, it will simply return 0...
gptpmasterclock_get_domain_ts64
int gptpmasterclock_get_domain_ts64(int64_t *ts64, int domainIndex)
get a synchronized clock value on specific domain
gptpmasterclock_expand_timestamp_ts64
uint64_t gptpmasterclock_expand_timestamp_ts64(uint32_t timestamp, int64_t ts64)
expand 32-bit nsec time to 64 bit with aligning to gptp clock at the time ts64.
gptpmasterclock_expand_timestamp
uint64_t gptpmasterclock_expand_timestamp(uint32_t timestamp)
expand 32-bit nsec time to 64 bit with aligning to gptp clock.
gptpmasterclock_get_max_domains
int gptpmasterclock_get_max_domains(void)
get maximum number of domains
gptpmasterclock_close
int gptpmasterclock_close(void)
close gptpmasterclcock
gptpmasterclock_getts64
int64_t gptpmasterclock_getts64(void)
get 64-bit nsec unit ts of system wide gptp clock