Definitions common to DHCP client and server. More...
Go to the source code of this file.
Macros | |
| #define | DHCP_SERVER_PORT 67 |
| #define | DHCP_CLIENT_PORT 68 |
| #define | DHCP_MIN_MSG_SIZE 300 |
| #define | DHCP_MAX_MSG_SIZE 548 |
| #define | DHCP_HARDWARE_TYPE_ETH 1 |
| #define | DHCP_MAGIC_COOKIE 0x63825363 |
| #define | DHCP_INFINITE_TIME 0xFFFFFFFF |
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 | |
| } | DhcpMessage |
| DHCP message. 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 | |
| } | DhcpOption |
| DHCP option. More... | |
Functions | |
| error_t | dhcpAddOption (DhcpMessage *message, size_t *messageLen, uint8_t optionCode, const void *optionValue, size_t optionLen) |
| Append an option to a DHCP message. More... | |
| DhcpOption * | dhcpGetOption (const DhcpMessage *message, size_t length, uint8_t optionCode) |
| Search a DHCP message for a given option. More... | |
Detailed Description
Definitions common to DHCP client and server.
License
SPDX-License-Identifier: GPL-2.0-or-later
Copyright (C) 2010-2023 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.
- Version
- 2.2.4
Definition in file dhcp_common.h.
Macro Definition Documentation
◆ DHCP_CLIENT_PORT
| #define DHCP_CLIENT_PORT 68 |
Definition at line 41 of file dhcp_common.h.
◆ DHCP_HARDWARE_TYPE_ETH
| #define DHCP_HARDWARE_TYPE_ETH 1 |
Definition at line 49 of file dhcp_common.h.
◆ DHCP_INFINITE_TIME
| #define DHCP_INFINITE_TIME 0xFFFFFFFF |
Definition at line 53 of file dhcp_common.h.
◆ DHCP_MAGIC_COOKIE
| #define DHCP_MAGIC_COOKIE 0x63825363 |
Definition at line 51 of file dhcp_common.h.
◆ DHCP_MAX_MSG_SIZE
| #define DHCP_MAX_MSG_SIZE 548 |
Definition at line 46 of file dhcp_common.h.
◆ DHCP_MIN_MSG_SIZE
| #define DHCP_MIN_MSG_SIZE 300 |
Definition at line 44 of file dhcp_common.h.
◆ DHCP_SERVER_PORT
| #define DHCP_SERVER_PORT 67 |
Definition at line 40 of file dhcp_common.h.
Typedef Documentation
◆ DhcpMessage
| typedef { ... } DhcpMessage |
DHCP message.
◆ DhcpOption
| typedef { ... } DhcpOption |
DHCP option.
Enumeration Type Documentation
◆ DhcpFlags
| enum DhcpFlags |
DHCP flags.
| Enumerator | |
|---|---|
| DHCP_FLAG_UNICAST | |
| DHCP_FLAG_BROADCAST | |
Definition at line 76 of file dhcp_common.h.
◆ DhcpMessageType
| enum DhcpMessageType |
DHCP message types.
| Enumerator | |
|---|---|
| DHCP_MSG_TYPE_DISCOVER | |
| DHCP_MSG_TYPE_OFFER | |
| DHCP_MSG_TYPE_REQUEST | |
| DHCP_MSG_TYPE_DECLINE | |
| DHCP_MSG_TYPE_ACK | |
| DHCP_MSG_TYPE_NAK | |
| DHCP_MSG_TYPE_RELEASE | |
| DHCP_MSG_TYPE_INFORM | |
Definition at line 87 of file dhcp_common.h.
◆ DhcpOpcode
| enum DhcpOpcode |
DHCP opcodes.
| Enumerator | |
|---|---|
| DHCP_OPCODE_BOOTREQUEST | |
| DHCP_OPCODE_BOOTREPLY | |
Definition at line 65 of file dhcp_common.h.
◆ DhcpOptionCode
| enum DhcpOptionCode |
DHCP option codes.
Definition at line 104 of file dhcp_common.h.
Function Documentation
◆ dhcpAddOption()
| error_t dhcpAddOption | ( | DhcpMessage * | message, |
| size_t * | messageLen, | ||
| uint8_t | optionCode, | ||
| const void * | optionValue, | ||
| size_t | optionLen | ||
| ) |
Append an option to a DHCP message.
- Parameters
-
[in] message Pointer to the DHCP message [in,out] messageLen Actual length of the DHCP message [in] optionCode Option code [in] optionValue Option value [in] optionLen Length of the option value
- Returns
- Error code
Definition at line 53 of file dhcp_common.c.
◆ dhcpGetOption()
| DhcpOption* dhcpGetOption | ( | const DhcpMessage * | message, |
| size_t | length, | ||
| uint8_t | optionCode | ||
| ) |
Search a DHCP message for a given option.
- Parameters
-
[in] message Pointer to the DHCP message [in] length Length of the message [in] optionCode Code of the option to find
- Returns
- If the specified option is found, a pointer to the corresponding option is returned. Otherwise NULL pointer is returned
Definition at line 115 of file dhcp_common.c.
Variable Documentation
◆ chaddr
| MacAddr chaddr |
Definition at line 218 of file dhcp_common.h.
◆ ciaddr
| Ipv4Addr ciaddr |
Definition at line 214 of file dhcp_common.h.
◆ code
| uint8_t code |
Definition at line 233 of file dhcp_common.h.
◆ file
| uint8_t file[128] |
Definition at line 221 of file dhcp_common.h.
◆ flags
| uint16_t flags |
Definition at line 213 of file dhcp_common.h.
◆ giaddr
| Ipv4Addr giaddr |
Definition at line 217 of file dhcp_common.h.
◆ hlen
| uint8_t hlen |
Definition at line 209 of file dhcp_common.h.
◆ hops
| uint8_t hops |
Definition at line 210 of file dhcp_common.h.
◆ htype
| uint8_t htype |
Definition at line 208 of file dhcp_common.h.
◆ length
| uint8_t length |
Definition at line 234 of file dhcp_common.h.
◆ magicCookie
| uint32_t magicCookie |
Definition at line 222 of file dhcp_common.h.
◆ op
| uint8_t op |
Definition at line 207 of file dhcp_common.h.
◆ options
| uint8_t options[] |
Definition at line 223 of file dhcp_common.h.
◆ secs
| uint16_t secs |
Definition at line 212 of file dhcp_common.h.
◆ siaddr
| Ipv4Addr siaddr |
Definition at line 216 of file dhcp_common.h.
◆ sname
| uint8_t sname[64] |
Definition at line 220 of file dhcp_common.h.
◆ unused
| uint8_t unused[10] |
Definition at line 219 of file dhcp_common.h.
◆ value
| uint8_t value[] |
Definition at line 235 of file dhcp_common.h.
◆ xid
| uint32_t xid |
Definition at line 211 of file dhcp_common.h.
◆ yiaddr
| Ipv4Addr yiaddr |
Definition at line 215 of file dhcp_common.h.