ntp_packet.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2016 Luminița Lăzărescu <cluminita.lazarescu@gmail.com>
3  *
4  * This file is subject to the terms and conditions of the GNU Lesser
5  * General Public License v2.1. See the file LICENSE in the top level
6  * directory for more details.
7  */
8 
9 #pragma once
10 
24 #include <stdint.h>
25 #include "byteorder.h"
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
38 #define NTP_PACKET_LI_POS (6U)
39 #define NTP_PACKET_LI_MASK (0xc0)
40 #define NTP_PACKET_VN_POS (3U)
41 #define NTP_PACKET_VN_MASK (0x38)
42 #define NTP_PACKET_MODE_MASK (0x07)
45 #define NTP_VERSION (4U)
46 #define NTP_PORT (123U)
52 #define NTP_UNIX_OFFSET (2208988800)
53 
57 typedef enum {
66 
72 typedef struct __attribute__((packed)) {
76 
82 typedef struct __attribute__((packed)) {
83  uint8_t li_vn_mode;
84  uint8_t stratum;
85  uint8_t poll;
86  uint8_t precision;
94 } ntp_packet_t;
95 
102 static inline void ntp_packet_set_li(ntp_packet_t *packet, uint8_t li)
103 {
104  packet->li_vn_mode &= ~NTP_PACKET_LI_MASK;
105  packet->li_vn_mode |= li << NTP_PACKET_LI_POS;
106 }
107 
113 static inline void ntp_packet_set_vn(ntp_packet_t *packet)
114 {
115  packet->li_vn_mode &= ~NTP_PACKET_VN_MASK;
117 }
118 
125 static inline void ntp_packet_set_mode(ntp_packet_t *packet, ntp_mode_t mode)
126 {
127  packet->li_vn_mode &= ~NTP_PACKET_MODE_MASK;
128  packet->li_vn_mode |= mode & NTP_PACKET_MODE_MASK;
129 }
130 
138 static inline uint8_t ntp_packet_get_li(ntp_packet_t *packet)
139 {
140  return (packet->li_vn_mode & NTP_PACKET_LI_MASK) >> NTP_PACKET_LI_POS;
141 }
142 
150 static inline uint8_t ntp_packet_get_vn(ntp_packet_t *packet)
151 {
152  return (packet->li_vn_mode & NTP_PACKET_VN_MASK) >> NTP_PACKET_VN_POS;
153 }
154 
163 {
164  return (packet->li_vn_mode & NTP_PACKET_MODE_MASK);
165 }
166 
167 #ifdef __cplusplus
168 }
169 #endif
170 
Functions to work with different byte orders.
#define NTP_VERSION
NTP version.
Definition: ntp_packet.h:45
static uint8_t ntp_packet_get_li(ntp_packet_t *packet)
Get leap indicator from a NTP packet.
Definition: ntp_packet.h:138
ntp_mode_t
NTP modes.
Definition: ntp_packet.h:57
static void ntp_packet_set_mode(ntp_packet_t *packet, ntp_mode_t mode)
Set mode in a NTP packet.
Definition: ntp_packet.h:125
static void ntp_packet_set_li(ntp_packet_t *packet, uint8_t li)
Set leap indicator in a NTP packet.
Definition: ntp_packet.h:102
#define NTP_PACKET_VN_POS
version position
Definition: ntp_packet.h:40
static ntp_mode_t ntp_packet_get_mode(ntp_packet_t *packet)
Get mode from a NTP packet.
Definition: ntp_packet.h:162
#define NTP_PACKET_LI_POS
Bit positions and masks for ntp_packet_t::li_vn_mode.
Definition: ntp_packet.h:38
#define NTP_PACKET_VN_MASK
version mask
Definition: ntp_packet.h:41
static void ntp_packet_set_vn(ntp_packet_t *packet)
Set version in a NTP packet.
Definition: ntp_packet.h:113
#define NTP_PACKET_MODE_MASK
mode mask
Definition: ntp_packet.h:42
#define NTP_PACKET_LI_MASK
leap indicator mask
Definition: ntp_packet.h:39
static uint8_t ntp_packet_get_vn(ntp_packet_t *packet)
Get version from a NTP packet.
Definition: ntp_packet.h:150
@ NTP_MODE_CLIENT
client
Definition: ntp_packet.h:61
@ NTP_MODE_RESERVED
reserved
Definition: ntp_packet.h:58
@ NTP_MODE_SERVER
server
Definition: ntp_packet.h:62
@ NTP_MODE_SYM_ACTIVE
symmetric active
Definition: ntp_packet.h:59
@ NTP_MODE_SYM_PASSIVE
symmetric passive
Definition: ntp_packet.h:60
@ NTP_MODE_PRIV
reserved for private use
Definition: ntp_packet.h:64
@ NTP_MODE_BROADCAST
broadcast
Definition: ntp_packet.h:63
NTP packet.
Definition: ntp_packet.h:82
ntp_timestamp_t receive
receive timestamp
Definition: ntp_packet.h:92
uint8_t li_vn_mode
leap indicator, version and mode
Definition: ntp_packet.h:83
ntp_timestamp_t reference
reference timestamp
Definition: ntp_packet.h:90
uint8_t precision
precision in log2 seconds
Definition: ntp_packet.h:86
uint8_t poll
poll in log2 seconds
Definition: ntp_packet.h:85
uint8_t stratum
stratum
Definition: ntp_packet.h:84
ntp_timestamp_t transmit
transmit timestamp
Definition: ntp_packet.h:93
network_uint32_t root_dispersion
root dispersion in NTP short format
Definition: ntp_packet.h:88
ntp_timestamp_t origin
origin timesptamp
Definition: ntp_packet.h:91
network_uint32_t reference_id
reference ID
Definition: ntp_packet.h:89
network_uint32_t root_delay
root delay in NTP short format
Definition: ntp_packet.h:87
NTP timestamp.
Definition: ntp_packet.h:72
network_uint32_t seconds
seconds since 1 January 1900 00:00 UTC
Definition: ntp_packet.h:73
network_uint32_t fraction
fraction of seconds in 232 picoseconds
Definition: ntp_packet.h:74
A 32 bit integer in big endian aka network byte order.
Definition: byteorder.h:83