xref: /freebsd/include/protocols/timed.h (revision bdcbfde31e8e9b343f113a1956384bdf30d1ed62)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1983, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #ifndef	_PROTOCOLS_TIMED_H_
33 #define	_PROTOCOLS_TIMED_H_
34 
35 /*
36  * Time Synchronization Protocol
37  */
38 
39 #define	TSPVERSION	1
40 #define ANYADDR 	NULL
41 
42 struct tsp {
43 	u_int8_t	tsp_type;
44 	u_int8_t	tsp_vers;
45 	u_int16_t	tsp_seq;
46 	union {
47 		struct {
48 			int32_t	tv_sec;
49 			int32_t	tv_usec;
50 		} tspu_time;
51 		char tspu_hopcnt;
52 	} tsp_u;
53 	char tsp_name[MAXHOSTNAMELEN];
54 };
55 
56 #define	tsp_time	tsp_u.tspu_time
57 #define	tsp_hopcnt	tsp_u.tspu_hopcnt
58 
59 /*
60  * Command types.
61  */
62 #define	TSP_ANY			0	/* match any types */
63 #define	TSP_ADJTIME		1	/* send adjtime */
64 #define	TSP_ACK			2	/* generic acknowledgement */
65 #define	TSP_MASTERREQ		3	/* ask for master's name */
66 #define	TSP_MASTERACK		4	/* acknowledge master request */
67 #define	TSP_SETTIME		5	/* send network time */
68 #define	TSP_MASTERUP		6	/* inform slaves that master is up */
69 #define	TSP_SLAVEUP		7	/* slave is up but not polled */
70 #define	TSP_ELECTION		8	/* advance candidature for master */
71 #define	TSP_ACCEPT		9	/* support candidature of master */
72 #define	TSP_REFUSE		10	/* reject candidature of master */
73 #define	TSP_CONFLICT		11	/* two or more masters present */
74 #define	TSP_RESOLVE		12	/* masters' conflict resolution */
75 #define	TSP_QUIT		13	/* reject candidature if master is up */
76 #define	TSP_DATE		14	/* reset the time (date command) */
77 #define	TSP_DATEREQ		15	/* remote request to reset the time */
78 #define	TSP_DATEACK		16	/* acknowledge time setting  */
79 #define	TSP_TRACEON		17	/* turn tracing on */
80 #define	TSP_TRACEOFF		18	/* turn tracing off */
81 #define	TSP_MSITE		19	/* find out master's site */
82 #define	TSP_MSITEREQ		20	/* remote master's site request */
83 #define	TSP_TEST		21	/* for testing election algo */
84 #define	TSP_SETDATE		22	/* New from date command */
85 #define	TSP_SETDATEREQ		23	/* New remote for above */
86 #define	TSP_LOOP		24	/* loop detection packet */
87 
88 #define	TSPTYPENUMBER		25
89 
90 #ifdef TSPTYPES
91 static char const * const tsptype[] =
92   { "ANY", "ADJTIME", "ACK", "MASTERREQ", "MASTERACK", "SETTIME", "MASTERUP",
93   "SLAVEUP", "ELECTION", "ACCEPT", "REFUSE", "CONFLICT", "RESOLVE", "QUIT",
94   "DATE", "DATEREQ", "DATEACK", "TRACEON", "TRACEOFF", "MSITE", "MSITEREQ",
95   "TEST", "SETDATE", "SETDATEREQ", "LOOP" };
96 _Static_assert(sizeof(tsptype) / sizeof(const char *) == TSPTYPENUMBER,
97     "Size of tsptype does not match TSPTYPENUMBER");
98 #endif
99 
100 #endif /* !_TIMED_H_ */
101