ntp_common.h File Reference

Definitions common to NTP client and server. More...

#include "core/net.h"

Go to the source code of this file.

Macros

#define NTP_PORT   123
 
#define NTP_MAX_MSG_SIZE   68
 
#define NTP_UNIX_EPOCH   2208988800U
 
#define NTP_KISS_CODE(a, b, c, d)   (((a) << 24) | ((b) << 16) | ((c) << 8) | (d))
 

Typedefs

struct {
   char_t   type
 
   uint32_t   dataStart
 
   uint32_t   dataLength
 
   uint8_t   nameLength
 
   char_t   name []
 
   uint8_t   tokenLen: 4
 
   uint8_t   type: 2
 
   uint8_t   version: 2
 
   uint8_t   code
 
   uint16_t   mid
 
   uint8_t   token []
 
   union {
      uint8_t   b [6]
 
      uint16_t   w [3]
 
   } 
 
   uint16_t   srcPort
 
   uint16_t   destPort
 
   uint32_t   seqNum
 
   uint32_t   ackNum
 
   uint8_t   reserved1: 4
 
   uint8_t   dataOffset: 4
 
   uint8_t   flags: 6
 
   uint8_t   reserved2: 2
 
   uint16_t   window
 
   uint16_t   checksum
 
   uint16_t   urgentPointer
 
   uint8_t   options []
 
   uint16_t   length
 
   uint8_t   data []
 
   uint8_t   op
 
   uint8_t   htype
 
   uint8_t   hlen
 
   uint8_t   hops
 
   uint32_t   xid
 
   uint16_t   secs
 
   uint16_t   flags
 
   Ipv4Addr   ciaddr
 
   Ipv4Addr   yiaddr
 
   Ipv4Addr   siaddr
 
   Ipv4Addr   giaddr
 
   MacAddr   chaddr
 
   uint8_t   unused [10]
 
   uint8_t   sname [64]
 
   uint8_t   file [128]
 
   uint32_t   magicCookie
 
   uint16_t   type
 
   uint16_t   hardwareType
 
   uint32_t   time
 
   MacAddr   linkLayerAddr
 
   uint16_t   id
 
   uint8_t   rd: 1
 
   uint8_t   tc: 1
 
   uint8_t   aa: 1
 
   uint8_t   opcode: 4
 
   uint8_t   qr: 1
 
   uint8_t   rcode: 4
 
   uint8_t   z: 3
 
   uint8_t   ra: 1
 
   uint16_t   qdcount
 
   uint16_t   ancount
 
   uint16_t   nscount
 
   uint16_t   arcount
 
   uint8_t   questions []
 
   uint16_t   controlWord
 
   uint16_t   byteCount
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint16_t   bcdUsb
 
   uint8_t   bDeviceClass
 
   uint8_t   bDeviceSubClass
 
   uint8_t   bDeviceProtocol
 
   uint8_t   bMaxPacketSize0
 
   uint16_t   idVendor
 
   uint16_t   idProduct
 
   uint16_t   bcdDevice
 
   uint8_t   iManufacturer
 
   uint8_t   iProduct
 
   uint8_t   iSerialNumber
 
   uint8_t   bNumConfigurations
 
   uint8_t   maxRespTime
 
   Ipv4Addr   groupAddr
 
   uint16_t   hrd
 
   uint16_t   pro
 
   uint8_t   hln
 
   uint8_t   pln
 
   uint16_t   op
 
   MacAddr   sha
 
   Ipv4Addr   spa
 
   MacAddr   tha
 
   Ipv4Addr   tpa
 
   uint8_t   length
 
   uint8_t   value []
 
   uint16_t   first
 
   uint16_t   last
 
   uint16_t   next
 
   union {
      uint8_t   b [16]
 
      uint16_t   w [8]
 
      uint32_t   dw [4]
 
   } 
 
   uint16_t   maxRespDelay
 
   uint16_t   reserved
 
   Ipv6Addr   multicastAddr
 
   uint32_t   reserved
 
   uint16_t   pvid
 
   uint8_t   autoNegSupportStatus
 
   uint16_t   pmdAutoNegAdvCap
 
   uint16_t   operationalMauType
 
   uint16_t   capabilities
 
   uint8_t   deviceType
 
   uint8_t   lengthH: 1
 
   uint8_t   lengthL
 
   uint8_t   t: 1
 
   uint8_t   c: 1
 
   union {
      int32_t   integer
 
      uint8_t   octetString [1]
 
      uint8_t   oid [1]
 
      uint8_t   ipAddr [4]
 
      uint32_t   counter32
 
      uint32_t   gauge32
 
      uint32_t   unsigned32
 
      uint32_t   timeTicks
 
      uint64_t   counter64
 
   } 
 
   uint16_t   transactionId
 
   uint16_t   protocolId
 
   uint8_t   unitId
 
   uint8_t   pdu []
 
   uint8_t   retain: 1
 
   uint8_t   qos: 2
 
   uint8_t   dup: 1
 
   union {
      uint8_t   all
 
      struct {
         uint8_t   topicIdType: 2
 
         uint8_t   cleanSession: 1
 
         uint8_t   will: 1
 
         uint8_t   retain: 1
 
         uint8_t   qos: 2
 
         uint8_t   dup: 1
 
      } 
 
   } 
 
   uint8_t   b: 1
 
   uint8_t   identifier
 
   uint8_t   valueSize
 
   Ipv4Addr   srcIpAddr
 
   Ipv4Addr   destIpAddr
 
   Eui64   interfaceId
 
   uint16_t   mru
 
   uint8_t   peerIdLength
 
   uint8_t   peerId []
 
   uint32_t   seconds
 
   uint32_t   fraction
 
   uint16_t   opcode
 
   char_t   filename []
 
   uint8_t   reserved: 3
 
   uint8_t   fin: 1
 
   uint8_t   payloadLen: 7
 
   uint8_t   mask: 1
 
   uint8_t   extPayloadLen []
 
   uint32_t   length
 
   uint8_t   payload []
 
   uint32_t   packetLen
 
   uint8_t   paddingLen
 
   uint8_t   protocolVersionId
 
   uint8_t   bpduType
 
   StpBridgeId   rootId
 
   uint32_t   rootPathCost
 
   StpBridgeId   bridgeId
 
   uint16_t   portId
 
   uint16_t   messageAge
 
   uint16_t   maxAge
 
   uint16_t   helloTime
 
   uint16_t   forwardDelay
 
   uint8_t   version1Length
 
   uint16_t   priority
 
   MacAddr   addr
 
NtpTimestamp
 NTP timestamp representation. More...
 
struct {
   char_t   type
 
   uint32_t   dataStart
 
   uint32_t   dataLength
 
   uint8_t   nameLength
 
   uint8_t   length: 4
 
   uint8_t   delta: 4
 
   union {
      uint8_t   b [8]
 
      uint16_t   w [4]
 
      uint32_t   dw [2]
 
   } 
 
   uint8_t   kind
 
   uint8_t   value []
 
   uint8_t   code
 
   uint16_t   type
 
   uint32_t   enterpriseNumber
 
   uint8_t   identifier []
 
   uint16_t   qtype
 
   uint16_t   qclass
 
   uint16_t   statusWord
 
   uint16_t   byteCount
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint16_t   wTotalLength
 
   uint8_t   bNumInterfaces
 
   uint8_t   bConfigurationValue
 
   uint8_t   iConfiguration
 
   uint8_t   bmAttributes
 
   uint8_t   bMaxPower
 
   uint8_t   type
 
   uint16_t   checksum
 
   uint8_t   parameter
 
   uint8_t   unused [3]
 
   uint8_t   data []
 
   uint32_t   parameter
 
   uint8_t   nextHeader
 
   uint8_t   hdrExtLen
 
   uint8_t   options []
 
   uint8_t   curHopLimit
 
   uint8_t   reserved: 2
 
   uint8_t   p: 1
 
   uint8_t   prf: 2
 
   uint8_t   h: 1
 
   uint8_t   o: 1
 
   uint8_t   m: 1
 
   uint16_t   routerLifetime
 
   uint32_t   reachableTime
 
   uint32_t   retransTimer
 
   uint8_t   flags
 
   uint16_t   ppvid
 
   uint8_t   mdiPowerSupport
 
   uint8_t   psePowerPair
 
   uint8_t   powerClass
 
   uint8_t   appType
 
   uint8_t   vlanIdH: 5
 
   uint8_t   x: 1
 
   uint8_t   t: 1
 
   uint8_t   u: 1
 
   uint8_t   l2PriorityH: 1
 
   uint8_t   vlanIdL: 7
 
   uint8_t   dscpValue: 6
 
   uint8_t   l2PriorityL: 2
 
   uint8_t   chassisIdSubtype
 
   uint8_t   chassisId []
 
   uint8_t   functionCode
 
   uint16_t   startingAddr
 
   uint16_t   quantityOfCoils
 
   uint16_t   length
 
   uint8_t   msgType
 
   uint16_t   flags
 
   Ipv4Addr   addr
 
   uint8_t   valueSize
 
   uint16_t   protocol
 
   uint32_t   accm
 
   uint8_t   msgLength
 
   uint8_t   message []
 
   uint8_t   mode: 3
 
   uint8_t   vn: 3
 
   uint8_t   li: 2
 
   uint8_t   stratum
 
   uint8_t   poll
 
   int8_t   precision
 
   uint32_t   rootDelay
 
   uint32_t   rootDispersion
 
   uint32_t   referenceId
 
   NtpTimestamp   referenceTimestamp
 
   NtpTimestamp   originateTimestamp
 
   NtpTimestamp   receiveTimestamp
 
   NtpTimestamp   transmitTimestamp
 
   uint16_t   opcode
 
   char_t   filename []
 
   uint16_t   value []
 
   uint16_t   group
 
   uint8_t   keyExchange []
 
   uint32_t   id
 
   uint32_t   dataLen
 
NtpHeader
 NTP packet header. More...
 
struct {
   uint32_t   totalSize
 
   ResRootEntry   rootEntry
 
   MacAddr   destAddr
 
   MacAddr   srcAddr
 
   uint16_t   type
 
   uint8_t   data []
 
   uint16_t   hardwareType
 
   MacAddr   linkLayerAddr
 
   uint16_t   rtype
 
   uint16_t   rclass
 
   uint32_t   ttl
 
   uint16_t   rdlength
 
   uint8_t   rdata []
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint8_t   bInterfaceNumber
 
   uint8_t   bAlternateSetting
 
   uint8_t   bNumEndpoints
 
   uint8_t   bInterfaceClass
 
   uint8_t   bInterfaceSubClass
 
   uint8_t   bInterfaceProtocol
 
   uint8_t   iInterface
 
   uint8_t   type
 
   uint8_t   code
 
   uint16_t   checksum
 
   uint32_t   unused
 
   uint8_t   nextHeader
 
   uint8_t   hdrExtLen
 
   uint8_t   options []
 
   uint32_t   reserved
 
   Ipv6Addr   targetAddr
 
   uint16_t   vlanId
 
   uint8_t   vlanNameLen
 
   char_t   vlanName []
 
   uint8_t   aggregationStatus
 
   uint32_t   aggregatedPortId
 
   uint8_t   locationDataFormat
 
   uint8_t   locationId []
 
   uint8_t   portIdSubtype
 
   uint8_t   portId []
 
   uint8_t   functionCode
 
   uint8_t   byteCount
 
   uint8_t   coilStatus []
 
   uint8_t   prefix
 
   uint16_t   length
 
   uint8_t   msgType
 
   uint8_t   identifier
 
   uint8_t   message []
 
   uint8_t   length
 
   Ipv4Addr   ipAddr
 
   uint16_t   protocol
 
   uint8_t   msgLength
 
   uint8_t   rejectedPacket []
 
   uint32_t   keyId
 
   uint8_t   messageDigest [16]
 
   uint16_t   opcode
 
   uint16_t   block
 
   uint16_t   value []
 
   uint8_t   value []
 
NtpAuthenticator
 NTP authenticator. More...
 

Enumerations

enum  NtpLeapIndicator { NTP_LI_NO_WARNING = 0, NTP_LI_LAST_MIN_HAS_61_SECS = 1, NTP_LI_LAST_MIN_HAS_59_SECS = 2, NTP_LI_ALARM_CONDITION = 3 }
 Leap indicator. More...
 
enum  NtpVersion { NTP_VERSION_1 = 1, NTP_VERSION_2 = 2, NTP_VERSION_3 = 3, NTP_VERSION_4 = 4 }
 NTP version numbers. More...
 
enum  NtpMode {
  NTP_MODE_SYMMETRIC_ACTIVE = 1, NTP_MODE_SYMMETRIC_PASSIVE = 2, NTP_MODE_CLIENT = 3, NTP_MODE_SERVER = 4,
  NTP_MODE_BROADCAST = 5
}
 Protocol modes. More...
 
enum  NtpKissCode {
  NTP_KISS_CODE_ACST = NTP_KISS_CODE('A', 'C', 'S', 'T'), NTP_KISS_CODE_AUTH = NTP_KISS_CODE('A', 'U', 'T', 'H'), NTP_KISS_CODE_AUTO = NTP_KISS_CODE('A', 'U', 'T', 'O'), NTP_KISS_CODE_BCST = NTP_KISS_CODE('B', 'C', 'S', 'T'),
  NTP_KISS_CODE_CRYP = NTP_KISS_CODE('C', 'R', 'Y', 'P'), NTP_KISS_CODE_DENY = NTP_KISS_CODE('D', 'E', 'N', 'Y'), NTP_KISS_CODE_DROP = NTP_KISS_CODE('D', 'R', 'O', 'P'), NTP_KISS_CODE_RSTR = NTP_KISS_CODE('R', 'S', 'T', 'R'),
  NTP_KISS_CODE_INIT = NTP_KISS_CODE('I', 'N', 'I', 'T'), NTP_KISS_CODE_MCST = NTP_KISS_CODE('M', 'C', 'S', 'T'), NTP_KISS_CODE_NKEY = NTP_KISS_CODE('N', 'K', 'E', 'Y'), NTP_KISS_CODE_RATE = NTP_KISS_CODE('R', 'A', 'T', 'E'),
  NTP_KISS_CODE_RMOT = NTP_KISS_CODE('R', 'M', 'O', 'T'), NTP_KISS_CODE_STEP = NTP_KISS_CODE('S', 'T', 'E', 'P')
}
 Kiss codes. More...
 

Detailed Description

Definitions common to NTP client and server.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2022 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
2.1.6

Definition in file ntp_common.h.

Macro Definition Documentation

◆ NTP_KISS_CODE

#define NTP_KISS_CODE (   a,
  b,
  c,
 
)    (((a) << 24) | ((b) << 16) | ((c) << 8) | (d))

Definition at line 45 of file ntp_common.h.

◆ NTP_MAX_MSG_SIZE

#define NTP_MAX_MSG_SIZE   68

Definition at line 40 of file ntp_common.h.

◆ NTP_PORT

#define NTP_PORT   123

Definition at line 38 of file ntp_common.h.

◆ NTP_UNIX_EPOCH

#define NTP_UNIX_EPOCH   2208988800U

Definition at line 42 of file ntp_common.h.

Typedef Documentation

◆ NtpAuthenticator

typedef { ... } NtpAuthenticator

NTP authenticator.

◆ NtpHeader

typedef { ... } NtpHeader

NTP packet header.

◆ NtpTimestamp

typedef { ... } NtpTimestamp

NTP timestamp representation.

Enumeration Type Documentation

◆ NtpKissCode

Kiss codes.

The kiss codes can provide useful information for an intelligent client. These codes are encoded in four-character ASCII strings left justified and zero filled

Enumerator
NTP_KISS_CODE_ACST 

The association belongs to a anycast server.

NTP_KISS_CODE_AUTH 

Server authentication failed.

NTP_KISS_CODE_AUTO 

Autokey sequence failed.

NTP_KISS_CODE_BCST 

The association belongs to a broadcast server.

NTP_KISS_CODE_CRYP 

Cryptographic authentication or identification failed.

NTP_KISS_CODE_DENY 

Access denied by remote server.

NTP_KISS_CODE_DROP 

Lost peer in symmetric mode.

NTP_KISS_CODE_RSTR 

Access denied due to local policy.

NTP_KISS_CODE_INIT 

The association has not yet synchronized for the first time.

NTP_KISS_CODE_MCST 

The association belongs to a manycast server.

NTP_KISS_CODE_NKEY 

No key found.

NTP_KISS_CODE_RATE 

Rate exceeded.

NTP_KISS_CODE_RMOT 

Somebody is tinkering with the association from a remote host running ntpdc.

NTP_KISS_CODE_STEP 

A step change in system time has occurred.

Definition at line 102 of file ntp_common.h.

◆ NtpLeapIndicator

Leap indicator.

Enumerator
NTP_LI_NO_WARNING 
NTP_LI_LAST_MIN_HAS_61_SECS 
NTP_LI_LAST_MIN_HAS_59_SECS 
NTP_LI_ALARM_CONDITION 

Definition at line 57 of file ntp_common.h.

◆ NtpMode

enum NtpMode

Protocol modes.

Enumerator
NTP_MODE_SYMMETRIC_ACTIVE 
NTP_MODE_SYMMETRIC_PASSIVE 
NTP_MODE_CLIENT 
NTP_MODE_SERVER 
NTP_MODE_BROADCAST 

Definition at line 83 of file ntp_common.h.

◆ NtpVersion

enum NtpVersion

NTP version numbers.

Enumerator
NTP_VERSION_1 
NTP_VERSION_2 
NTP_VERSION_3 
NTP_VERSION_4 

Definition at line 70 of file ntp_common.h.

Variable Documentation

◆ fraction

uint32_t fraction

Definition at line 134 of file ntp_common.h.

◆ keyId

uint32_t keyId

Definition at line 172 of file ntp_common.h.

◆ li

uint8_t li

Definition at line 151 of file ntp_common.h.

◆ messageDigest

uint8_t messageDigest[16]

Definition at line 173 of file ntp_common.h.

◆ mode

uint8_t mode

Definition at line 149 of file ntp_common.h.

◆ originateTimestamp

NtpTimestamp originateTimestamp

Definition at line 160 of file ntp_common.h.

◆ poll

uint8_t poll

Definition at line 154 of file ntp_common.h.

◆ precision

int8_t precision

Definition at line 155 of file ntp_common.h.

◆ receiveTimestamp

NtpTimestamp receiveTimestamp

Definition at line 161 of file ntp_common.h.

◆ referenceId

uint32_t referenceId

Definition at line 158 of file ntp_common.h.

◆ referenceTimestamp

NtpTimestamp referenceTimestamp

Definition at line 159 of file ntp_common.h.

◆ rootDelay

uint32_t rootDelay

Definition at line 156 of file ntp_common.h.

◆ rootDispersion

uint32_t rootDispersion

Definition at line 157 of file ntp_common.h.

◆ seconds

uint32_t seconds

Definition at line 133 of file ntp_common.h.

◆ stratum

uint8_t stratum

Definition at line 153 of file ntp_common.h.

◆ transmitTimestamp

NtpTimestamp transmitTimestamp

Definition at line 162 of file ntp_common.h.

◆ vn

uint8_t vn

Definition at line 150 of file ntp_common.h.