Definitions common to NBNS client and NBNS responder. More...

#include "core/net.h"
#include "dns/dns_common.h"

Macros
#define	NBNS_DEFAULT_RESOURCE_RECORD_TTL 120

#define	NBNS_PORT 137

#define	NBNS_ENCODE_H(c) ('A' + (((c) >> 4) & 0x0F))

#define	NBNS_ENCODE_L(c) ('A' + ((c) & 0x0F))

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 []

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

}	NbnsHeader
	NBNS message header. 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

}	NbnsAddrEntry
	NBNS address entry. More...

Enumerations
enum	DnsFlags { NBNS_ONT_BNODE = 0x0000, NBNS_ONT_PNODE = 0x2000, NBNS_ONT_MNODE = 0x4000, NBNS_G_UNIQUE = 0x0000, NBNS_G_GROUP = 0x8000 }
	NBNS flags. More...

Functions
error_t	nbnsInit (NetInterface *interface)
	NBNS related initialization. More...

void	nbnsProcessMessage (NetInterface interface, const IpPseudoHeader pseudoHeader, const UdpHeader udpHeader, const NetBuffer buffer, size_t offset, const NetRxAncillary ancillary, void param)
	Process incoming NBNS message. More...

size_t	nbnsEncodeName (const char_t src, uint8_t dest)
	Encode a NetBIOS name. More...

size_t	nbnsParseName (const NbnsHeader message, size_t length, size_t pos, char_t dest)
	Decode a NetBIOS name. More...

bool_t	nbnsCompareName (const NbnsHeader message, size_t length, size_t pos, const char_t name)
	Compare NetBIOS names. More...

Detailed Description

Definitions common to NBNS client and NBNS responder.

License

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

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.2.2

Definition in file nbns_common.h.

Macro Definition Documentation

◆ NBNS_DEFAULT_RESOURCE_RECORD_TTL

#define NBNS_DEFAULT_RESOURCE_RECORD_TTL 120

Definition at line 40 of file nbns_common.h.

◆ NBNS_ENCODE_H

#define NBNS_ENCODE_H ( c ) ('A' + (((c) >> 4) & 0x0F))

Definition at line 49 of file nbns_common.h.

◆ NBNS_ENCODE_L

#define NBNS_ENCODE_L ( c ) ('A' + ((c) & 0x0F))

Definition at line 50 of file nbns_common.h.

◆ NBNS_PORT

#define NBNS_PORT 137

Definition at line 46 of file nbns_common.h.

Typedef Documentation

◆ NbnsAddrEntry

typedef { ... } NbnsAddrEntry

NBNS address entry.

◆ NbnsHeader

typedef { ... } NbnsHeader

NBNS message header.

Enumeration Type Documentation

◆ DnsFlags

enum DnsFlags

NBNS flags.

Enumerator
NBNS_ONT_BNODE
NBNS_ONT_PNODE
NBNS_ONT_MNODE
NBNS_G_UNIQUE
NBNS_G_GROUP

Definition at line 62 of file nbns_common.h.

Function Documentation

◆ nbnsCompareName()

bool_t nbnsCompareName	(	const NbnsHeader *	message,
		size_t	length,
		size_t	pos,
		const char_t *	name
	)

Compare NetBIOS names.

Parameters

[in]	message	Pointer to the NBNS message
[in]	length	Length of the NBNS message
[in]	pos	Offset of the encoded domain name
[in]	name	NULL-terminated string that holds a domain name

Returns: TRUE if the NetBIOS names match, else FALSE

Definition at line 288 of file nbns_common.c.

◆ nbnsEncodeName()

size_t nbnsEncodeName	(	const char_t *	src,
		uint8_t *	dest
	)

Encode a NetBIOS name.

Parameters

[in]	src	Pointer to the name to encode
[out]	dest	Pointer to the encoded NetBIOS name

Returns: Length of the encoded NetBIOS name

Definition at line 152 of file nbns_common.c.

◆ nbnsInit()

error_t nbnsInit ( NetInterface * interface )

NBNS related initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 55 of file nbns_common.c.

◆ nbnsParseName()

size_t nbnsParseName	(	const NbnsHeader *	message,
		size_t	length,
		size_t	pos,
		char_t *	dest
	)

Decode a NetBIOS name.

Parameters

[in]	message	Pointer to the NBNS message
[in]	length	Length of the NBNS message
[in]	pos	Offset of the name to decode
[out]	dest	Pointer to the decoded name (optional)

Returns: The position of the resource record that immediately follows the NetBIOS name

Definition at line 204 of file nbns_common.c.

◆ nbnsProcessMessage()

void nbnsProcessMessage	(	NetInterface *	interface,
		const IpPseudoHeader *	pseudoHeader,
		const UdpHeader *	udpHeader,
		const NetBuffer *	buffer,
		size_t	offset,
		const NetRxAncillary *	ancillary,
		void *	param
	)

Process incoming NBNS message.

Parameters

[in]	interface	Underlying network interface
[in]	pseudoHeader	UDP pseudo header
[in]	udpHeader	UDP header
[in]	buffer	Multi-part buffer containing the incoming NBNS message
[in]	offset	Offset to the first byte of the NBNS message
[in]	ancillary	Additional options passed to the stack along with the packet
[in]	param	Callback function parameter (not used)

Definition at line 82 of file nbns_common.c.

Variable Documentation

◆ aa

uint8_t aa

Definition at line 98 of file nbns_common.h.

◆ addr

Ipv4Addr addr

Definition at line 121 of file nbns_common.h.

◆ ancount

uint16_t ancount

Definition at line 107 of file nbns_common.h.

◆ arcount

uint16_t arcount

Definition at line 109 of file nbns_common.h.

◆ b

uint8_t b

Definition at line 102 of file nbns_common.h.

◆ flags

uint16_t flags

Definition at line 120 of file nbns_common.h.

◆ id

uint16_t id

Definition at line 84 of file nbns_common.h.

◆ nscount

uint16_t nscount

Definition at line 108 of file nbns_common.h.

◆ opcode

uint8_t opcode

Definition at line 99 of file nbns_common.h.

◆ qdcount

uint16_t qdcount

Definition at line 106 of file nbns_common.h.

◆ qr

uint8_t qr

Definition at line 100 of file nbns_common.h.

◆ questions

uint8_t questions[]

Definition at line 110 of file nbns_common.h.

◆ ra

uint8_t ra

Definition at line 104 of file nbns_common.h.

◆ rcode

uint8_t rcode

Definition at line 101 of file nbns_common.h.

◆ rd

uint8_t rd

Definition at line 96 of file nbns_common.h.

◆ tc

uint8_t tc

Definition at line 97 of file nbns_common.h.

◆ z

uint8_t z

Definition at line 103 of file nbns_common.h.

Macros

Typedefs

Enumerations

Functions

Detailed Description

License

Macro Definition Documentation

◆ NBNS_DEFAULT_RESOURCE_RECORD_TTL

◆ NBNS_ENCODE_H

◆ NBNS_ENCODE_L

◆ NBNS_PORT

Typedef Documentation

◆ NbnsAddrEntry

◆ NbnsHeader

Enumeration Type Documentation

◆ DnsFlags

Function Documentation

◆ nbnsCompareName()

◆ nbnsEncodeName()

◆ nbnsInit()

◆ nbnsParseName()

◆ nbnsProcessMessage()

Variable Documentation

◆ aa

◆ addr

◆ ancount

◆ arcount

◆ b

◆ flags

◆ id

◆ nscount

◆ opcode

◆ qdcount

◆ qr

◆ questions

◆ ra

◆ rcode

◆ rd

◆ tc

◆ z