modbus_common.h File Reference

Definitions common to Modbus/TCP client and server. More...

#include "core/net.h"

Go to the source code of this file.

Macros
#define	MODBUS_TCP_PORT   502
#define	MODBUS_TCP_SECURE_PORT   802
#define	MODBUS_PROTOCOL_ID   0
#define	MODBUS_DEFAULT_UNIT_ID   255
#define	MODBUS_MAX_PDU_SIZE   253
#define	MODBUS_MAX_ADU_SIZE   260
#define	MODBUS_FUNCTION_CODE_MASK   0x7F
#define	MODBUS_EXCEPTION_MASK   0x80
#define	MODBUS_SET_COIL(a, n)   ((a)[(n) / 8] |= (1 << ((n) % 8)))
#define	MODBUS_RESET_COIL(a, n)   ((a)[(n) / 8] &= ~(1 << ((n) % 8)))
#define	MODBUS_TEST_COIL(a, n)   ((a[(n) / 8] >> ((n) % 8)) & 1)

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
}	ModbusHeader
	MBAP header (Modbus Application Protocol) 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
}	ModbusReadCoilsReq
	Read Coils request PDU. 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 []
}	ModbusReadCoilsResp
	Read Coils response PDU. More...
struct {
uint8_t   dsap
uint8_t   ssap
uint8_t   control
uint8_t   msgType
uint8_t   transactionId [3]
uint8_t   options []
uint16_t   rtype
uint16_t   rclass
uint32_t   ttl
uint16_t   rdlength
uint8_t   rdata [4]
uint8_t   bLength
uint8_t   bDescriptorType
uint8_t   bEndpointAddress
uint8_t   bmAttributes
uint16_t   wMaxPacketSize
uint8_t   bInterval
uint8_t   type
uint8_t   code
uint16_t   checksum
uint32_t   unused
uint8_t   data []
uint32_t   mtu
uint8_t   nextHeader
uint8_t   hdrExtLen
uint8_t   routingType
uint8_t   segmentsLeft
uint32_t   reserved
Ipv6Addr   address []
uint8_t   reserved1: 5
uint8_t   o: 1
uint8_t   s: 1
uint8_t   r: 1
uint8_t   reserved2 [3]
Ipv6Addr   targetAddr
uint8_t   protocolIdLen
uint8_t   protocolId []
uint16_t   maxFrameSize
uint8_t   powerPriority: 4
uint8_t   powerSource: 2
uint8_t   powerType: 2
uint16_t   powerValue
uint16_t   ttl
uint8_t   functionCode
uint16_t   startingAddr
uint16_t   quantityOfInputs
uint8_t   gwId
uint16_t   duration
uint8_t   identifier
uint16_t   length
uint8_t   message []
uint8_t   length
Ipv4Addr   ipAddr
uint16_t   protocol
uint16_t   rejectedProtocol
uint8_t   rejectedInfo []
uint16_t   opcode
uint16_t   block
uint16_t   version
uint16_t   epoch
DtlsSequenceNumber   seqNum
uint8_t   hash
uint8_t   signature
uint8_t   value []
}	ModbusReadDiscreteInputsReq
	Read Discrete Inputs request PDU. More...
struct {
uint16_t   tci
uint16_t   type
uint8_t   msgType
uint8_t   hopCount
Ipv6Addr   linkAddress
Ipv6Addr   peerAddress
uint8_t   options []
uint16_t   rtype
uint16_t   rclass
uint32_t   ttl
uint16_t   rdlength
uint8_t   rdata [16]
uint8_t   bLength
uint8_t   bDescriptorType
uint16_t   bString []
uint8_t   type
uint8_t   code
uint16_t   checksum
uint8_t   pointer
uint8_t   unused [3]
uint8_t   data []
uint32_t   unused
uint8_t   nextHeader
uint8_t   payloadLen
uint16_t   reserved
uint32_t   securityParamIndex
uint32_t   sequenceNumber
uint8_t   authData []
uint32_t   reserved
Ipv6Addr   targetAddr
Ipv6Addr   destAddr
uint8_t   measurements [20]
uint16_t   psePowerPriceIndex
uint16_t   supportedCap
uint16_t   enabledCap
uint8_t   functionCode
uint8_t   byteCount
uint8_t   inputStatus []
uint8_t   radius
uint8_t   length
Ipv4Addr   ipAddr
uint32_t   magicNumber
uint8_t   identifier
uint16_t   length
uint16_t   opcode
uint16_t   errorCode
char_t   errorMsg []
uint16_t   msgSeq
uint8_t   fragOffset [3]
uint8_t   fragLength [3]
TlsSignHashAlgo   value []
uint8_t   value []
}	ModbusReadDiscreteInputsResp
	Read Discrete Inputs response PDU. More...
struct {
uint16_t   code
uint16_t   length
uint8_t   value []
uint16_t   rtype
uint16_t   rclass
uint32_t   ttl
uint16_t   rdlength
uint16_t   priority
uint16_t   weight
uint16_t   port
uint8_t   target []
uint8_t   bFunctionLength
uint8_t   bDescriptorType
uint8_t   bDescriptorSubtype
uint16_t   bcdCdc
uint8_t   type
uint8_t   code
uint16_t   checksum
uint16_t   identifier
uint16_t   sequenceNumber
uint8_t   data []
uint32_t   pointer
uint32_t   securityParamIndex
uint32_t   sequenceNumber
uint8_t   payloadData []
uint8_t   length
uint8_t   powerPriority: 2
uint8_t   pd4pid: 1
uint8_t   reserved: 1
uint8_t   powerSource: 2
uint8_t   powerType: 2
uint16_t   pdRequestedPower
uint16_t   pseAllocatedPower
uint8_t   mgmtAddrLen
uint8_t   mgmtAddrSubtype
uint8_t   mgmtAddr []
uint8_t   functionCode
uint16_t   startingAddr
uint16_t   quantityOfRegs
uint8_t   gwId
uint8_t   gwAdd []
Ipv4Addr   ipAddr
uint8_t   identifier
uint32_t   magicNumber
uint16_t   serverVersion
uint8_t   cookieLength
uint8_t   cookie []
}	ModbusReadHoldingRegsReq
	Read Holding Registers request PDU. More...
struct {
uint32_t   iaId
uint32_t   t1
uint32_t   t2
uint8_t   options []
uint8_t   bFunctionLength
uint8_t   bDescriptorType
uint8_t   bDescriptorSubtype
uint8_t   bmCapabilities
uint8_t   bDataInterface
uint8_t   type
uint8_t   code
uint16_t   checksum
uint16_t   identifier
uint16_t   sequenceNumber
uint8_t   data []
uint8_t   length
MacAddr   linkLayerAddr
uint16_t   pdRequestedPowerA
uint16_t   pdRequestedPowerB
uint16_t   pseAllocatedPowerA
uint16_t   pseAllocatedPowerB
uint16_t   powerStatus
uint8_t   systemSetup
uint16_t   pseMaxAvailablePower
uint8_t   autoclass
uint8_t   powerDown [3]
uint8_t   ifNumSubtype
uint32_t   ifNum
uint8_t   oidLen
uint8_t   oid []
uint8_t   functionCode
uint8_t   byteCount
uint16_t   regValue []
MqttSnFlags   flags
uint8_t   protocolId
uint16_t   duration
char_t   clientId []
Ipv4Addr   ipAddr
uint16_t   length
uint8_t   value []
}	ModbusReadHoldingRegsResp
	Read Holding Registers response PDU. More...
struct {
uint32_t   iaId
uint8_t   options []
uint8_t   bFunctionLength
uint8_t   bDescriptorType
uint8_t   bDescriptorSubtype
uint8_t   bmCapabilities
uint8_t   type
uint8_t   length
uint8_t   prefixLength
uint8_t   reserved1: 5
uint8_t   r: 1
uint8_t   a: 1
uint8_t   l: 1
uint32_t   validLifetime
uint32_t   preferredLifetime
uint32_t   reserved2
Ipv6Addr   prefix
uint8_t   oui [LLDP_OUI_SIZE]
uint8_t   subtype
uint8_t   value []
uint8_t   functionCode
uint16_t   startingAddr
uint16_t   quantityOfRegs
uint8_t   returnCode
uint16_t   type
uint16_t   length
}	ModbusReadInputRegsReq
	Read Holding Input request PDU. More...
struct {
Ipv6Addr   address
uint32_t   preferredLifetime
uint32_t   validLifetime
uint8_t   options []
uint8_t   bFunctionLength
uint8_t   bDescriptorType
uint8_t   bDescriptorSubtype
uint8_t   bMasterInterface
uint8_t   bSlaveInterface0
uint8_t   type
uint8_t   length
uint16_t   reserved1
uint32_t   reserved2
uint8_t   ipPacket []
uint8_t   functionCode
uint8_t   byteCount
uint16_t   regValue []
MqttSnFlags   flags
char_t   willTopic []
uint16_t   length
uint8_t   value []
}	ModbusReadInputRegsResp
	Read Holding Input response PDU. More...
struct {
uint16_t   requestedOption [1]
UsbConfigDescriptor   configDescriptor
UsbInterfaceDescriptor   communicationInterfaceDescriptor
CdcHeaderDescriptor   cdcHeaderDescriptor
CdcCallManagementDescriptor   cdcCallManagementDescriptor
CdcAcmDescriptor   cdcAcmDescriptor
CdcUnionDescriptor   cdcUnionDescriptor
UsbEndpointDescriptor   notificationEndpointDescriptor
UsbInterfaceDescriptor   dataInterfaceDescriptor
UsbEndpointDescriptor   dataOutEndpointDescriptor
UsbEndpointDescriptor   dataInEndpointDescriptor
uint8_t   type
uint8_t   length
uint16_t   reserved
uint32_t   mtu
uint8_t   functionCode
uint16_t   outputAddr
uint16_t   outputValue
uint16_t   topicId
uint16_t   msgId
char_t   topicName []
uint16_t   value []
uint16_t   algorithm
uint16_t   length
uint8_t   value []
}	ModbusWriteSingleCoilReq
	Write Single Coil request PDU. More...
struct {
uint8_t   value
uint8_t   type
uint8_t   length
uint8_t   prefixLength
uint8_t   reserved2: 3
uint8_t   prf: 2
uint8_t   reserved1: 3
uint32_t   routeLifetime
Ipv6Addr   prefix
uint8_t   functionCode
uint16_t   outputAddr
uint16_t   outputValue
uint16_t   topicId
uint16_t   msgId
uint8_t   returnCode
uint16_t   length
char_t   hostname []
uint16_t   serverVersion
uint8_t   random [32]
uint8_t   sessionIdLen
uint8_t   sessionId []
}	ModbusWriteSingleCoilResp
	Write Single Coil response PDU. More...
struct {
uint16_t   value
uint8_t   type
uint8_t   length
uint16_t   reserved
uint32_t   lifetime
Ipv6Addr   address []
uint8_t   functionCode
uint16_t   regAddr
uint16_t   regValue
MqttSnFlags   flags
uint16_t   topicId
uint16_t   msgId
uint8_t   data []
uint16_t   length
uint8_t   value []
uint16_t   extensionsLen
uint8_t   extensions []
}	ModbusWriteSingleRegReq
	Write Single Register request PDU. More...
struct {
uint8_t   protocol
uint8_t   algorithm
uint8_t   rdm
uint8_t   replayDetection [8]
uint8_t   authInfo []
uint8_t   type
uint8_t   length
uint16_t   reserved
uint32_t   lifetime
uint8_t   domainNames []
uint8_t   functionCode
uint16_t   regAddr
uint16_t   regValue
uint16_t   topicId
uint16_t   msgId
uint8_t   returnCode
char_t   value []
uint32_t   ticketLifetime
uint32_t   ticketAgeAdd
uint8_t   ticketNonceLen
uint8_t   ticketNonce []
}	ModbusWriteSingleRegResp
	Write Single Register response PDU. More...
struct {
Ipv6Addr   serverAddr
uint8_t   type
uint8_t   length
uint8_t   contextLength
uint8_t   cid: 4
uint8_t   c: 1
uint8_t   reserved1: 3
uint16_t   reserved2
uint16_t   validLifetime
Ipv6Addr   contextPrefix
uint8_t   functionCode
uint16_t   startingAddr
uint16_t   quantityOfOutputs
uint8_t   byteCount
uint8_t   outputValue []
uint16_t   msgId
uint16_t   length
uint8_t   value []
uint8_t   requestUpdate
}	ModbusWriteMultipleCoilsReq
	Write Multiple Coils request PDU. More...
struct {
uint16_t   statusCode
char_t   statusMessage []
uint8_t   functionCode
uint16_t   startingAddr
uint16_t   quantityOfOutputs
uint16_t   msgId
uint16_t   length
uint16_t   value []
uint8_t   data []
}	ModbusWriteMultipleCoilsResp
	Write Multiple Coils response PDU. More...
struct {
uint8_t   msgType
uint8_t   functionCode
uint16_t   startingAddr
uint16_t   quantityOfRegs
uint8_t   byteCount
uint16_t   regValue []
uint16_t   msgId
uint8_t   length
uint8_t   value []
uint16_t   version
	Protocol version. More...
uint16_t   cipherSuite
	Cipher suite identifier. More...
systime_t   ticketTimestamp
	Timestamp to manage ticket lifetime. More...
uint32_t   ticketLifetime
	Lifetime of the ticket. More...
uint32_t   ticketAgeAdd
	Random value used to obscure the age of the ticket. More...
uint8_t   ticketNonce [4]
	A per-ticket value that is unique across all tickets issued. More...
size_t   ticketPskLen
	Length of the PSK associated with the ticket. More...
uint8_t   ticketPsk [TLS13_MAX_HKDF_DIGEST_SIZE]
	PSK associated with the ticket. More...
}	ModbusWriteMultipleRegsReq
	Write Multiple Registers request PDU. More...
struct {
Ipv6Addr   address [1]
uint8_t   functionCode
uint16_t   startingAddr
uint16_t   quantityOfRegs
MqttSnFlags   flags
uint16_t   msgId
char_t   topicName []
uint8_t   length
uint8_t   value []
}	ModbusWriteMultipleRegsResp
	Write Multiple Registers response PDU. More...
struct {
uint8_t   searchList [1]
uint8_t   functionCode
uint16_t   referenceAddr
uint16_t   andMask
uint16_t   orMask
MqttSnFlags   flags
uint16_t   topicId
uint16_t   msgId
uint8_t   returnCode
uint8_t   length
uint8_t   value []
}	ModbusMaskWriteRegReq
	Mask Write Register request PDU. More...
struct {
uint32_t   iaId
uint32_t   t1
uint32_t   t2
uint8_t   options []
uint8_t   functionCode
uint16_t   referenceAddr
uint16_t   andMask
uint16_t   orMask
MqttSnFlags   flags
uint16_t   msgId
char_t   topicName []
uint16_t   length
uint8_t   value []
}	ModbusMaskWriteRegResp
	Mask Write Register response PDU. More...
struct {
uint32_t   preferredLifetime
uint32_t   validLifetime
uint8_t   prefixLen
Ipv6Addr   prefix
uint8_t   options []
uint8_t   functionCode
uint16_t   readStartingAddr
uint16_t   quantityToRead
uint16_t   writeStartingAddr
uint16_t   quantityToWrite
uint8_t   writeByteCount
uint16_t   writeRegValue []
uint16_t   msgId
uint16_t   length
uint8_t   value []
}	ModbusReadWriteMultipleRegsReq
	Read/Write Multiple Registers request PDU. More...
struct {
uint8_t   s: 1
uint8_t   o: 1
uint8_t   n: 1
uint8_t   mbz: 5
uint8_t   domainName []
uint8_t   functionCode
uint8_t   readByteCount
uint16_t   readRegValue []
uint16_t   duration
uint16_t   length
uint8_t   value []
}	ModbusReadWriteMultipleRegsResp
	Read/Write Multiple Registers response PDU. More...
struct {
uint8_t   functionCode
uint8_t   exceptionCode
MqttSnFlags   flags
char_t   willTopic []
TlsSignHashAlgo   algorithm
uint16_t   length
uint8_t   value []
}	ModbusExceptionResp
	Exception response PDU. More...

Enumerations
enum	ModbusFunctionCode {   MODBUS_FUNCTION_READ_COILS = 1, MODBUS_FUNCTION_READ_DISCRETE_INPUTS = 2, MODBUS_FUNCTION_READ_HOLDING_REGS = 3, MODBUS_FUNCTION_READ_INPUT_REGS = 4,   MODBUS_FUNCTION_WRITE_SINGLE_COIL = 5, MODBUS_FUNCTION_WRITE_SINGLE_REG = 6, MODBUS_FUNCTION_READ_EXCEPTION_STATUS = 7, MODBUS_FUNCTION_DIAGNOSTICS = 8,   MODBUS_FUNCTION_GET_COMM_EVENT_COUNTER = 11, MODBUS_FUNCTION_GET_COMM_EVENT_LOG = 12, MODBUS_FUNCTION_WRITE_MULTIPLE_COILS = 15, MODBUS_FUNCTION_WRITE_MULTIPLE_REGS = 16,   MODBUS_FUNCTION_REPORT_SLAVE_ID = 17, MODBUS_FUNCTION_READ_FILE_RECORD = 20, MODBUS_FUNCTION_WRITE_FILE_RECORD = 21, MODBUS_FUNCTION_MASK_WRITE_REG = 22,   MODBUS_FUNCTION_READ_WRITE_MULTIPLE_REGS = 23, MODBUS_FUNCTION_READ_FIFO_QUEUE = 24, MODBUS_FUNCTION_ENCAPSULATED_IF_TRANSPORT = 43 }
	Modbus functions codes. More...
enum	ModbusExceptionCode {   MODBUS_EXCEPTION_ILLEGAL_FUNCTION = 1, MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS = 2, MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE = 3, MODBUS_EXCEPTION_SLAVE_DEVICE_FAILURE = 4,   MODBUS_EXCEPTION_ACKNOWLEDGE = 5, MODBUS_EXCEPTION_SLAVE_DEVICE_BUSY = 6, MODBUS_EXCEPTION_MEMORY_PARITY_ERROR = 8, MODBUS_EXCEPTION_GATEWAY_PATH_UNAVAILABLE = 10,   MODBUS_EXCEPTION_GATEWAY_NO_RESPONSE_FROM_TARGET = 11 }
	Modbus exception codes. More...
enum	ModbusCoilState { MODBUS_COIL_STATE_OFF = 0x0000, MODBUS_COIL_STATE_ON = 0xFF00 }
	Coil states. More...

Detailed Description

Definitions common to Modbus/TCP 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.

Author

Oryx Embedded SARL (www.oryx-embedded.com)

Version

2.2.4

Definition in file modbus_common.h.

Macro Definition Documentation

MODBUS_DEFAULT_UNIT_ID

#define MODBUS_DEFAULT_UNIT_ID   255

Definition at line 45 of file modbus_common.h.

MODBUS_EXCEPTION_MASK

#define MODBUS_EXCEPTION_MASK   0x80

Definition at line 55 of file modbus_common.h.

MODBUS_FUNCTION_CODE_MASK

#define MODBUS_FUNCTION_CODE_MASK   0x7F

Definition at line 53 of file modbus_common.h.

MODBUS_MAX_ADU_SIZE

#define MODBUS_MAX_ADU_SIZE   260

Definition at line 50 of file modbus_common.h.

MODBUS_MAX_PDU_SIZE

#define MODBUS_MAX_PDU_SIZE   253

Definition at line 48 of file modbus_common.h.

MODBUS_PROTOCOL_ID

#define MODBUS_PROTOCOL_ID   0

Definition at line 43 of file modbus_common.h.

MODBUS_RESET_COIL

#define MODBUS_RESET_COIL	(		a,
			n
	)		((a)[(n) / 8] &= ~(1 << ((n) % 8)))

Definition at line 60 of file modbus_common.h.

MODBUS_SET_COIL

#define MODBUS_SET_COIL	(		a,
			n
	)		((a)[(n) / 8] |= (1 << ((n) % 8)))

Definition at line 58 of file modbus_common.h.

MODBUS_TCP_PORT

#define MODBUS_TCP_PORT   502

Definition at line 38 of file modbus_common.h.

MODBUS_TCP_SECURE_PORT

#define MODBUS_TCP_SECURE_PORT   802

Definition at line 40 of file modbus_common.h.

MODBUS_TEST_COIL

#define MODBUS_TEST_COIL	(		a,
			n
	)		((a[(n) / 8] >> ((n) % 8)) & 1)

Definition at line 62 of file modbus_common.h.

Typedef Documentation

ModbusExceptionResp

typedef { ... } ModbusExceptionResp

Exception response PDU.

ModbusHeader

typedef { ... } ModbusHeader

MBAP header (Modbus Application Protocol)

ModbusMaskWriteRegReq

typedef { ... } ModbusMaskWriteRegReq

Mask Write Register request PDU.

ModbusMaskWriteRegResp

typedef { ... } ModbusMaskWriteRegResp

Mask Write Register response PDU.

ModbusReadCoilsReq

typedef { ... } ModbusReadCoilsReq

Read Coils request PDU.

ModbusReadCoilsResp

typedef { ... } ModbusReadCoilsResp

Read Coils response PDU.

ModbusReadDiscreteInputsReq

typedef { ... } ModbusReadDiscreteInputsReq

Read Discrete Inputs request PDU.

ModbusReadDiscreteInputsResp

typedef { ... } ModbusReadDiscreteInputsResp

Read Discrete Inputs response PDU.

ModbusReadHoldingRegsReq

typedef { ... } ModbusReadHoldingRegsReq

Read Holding Registers request PDU.

ModbusReadHoldingRegsResp

typedef { ... } ModbusReadHoldingRegsResp

Read Holding Registers response PDU.

ModbusReadInputRegsReq

typedef { ... } ModbusReadInputRegsReq

Read Holding Input request PDU.

ModbusReadInputRegsResp

typedef { ... } ModbusReadInputRegsResp

Read Holding Input response PDU.

ModbusReadWriteMultipleRegsReq

typedef { ... } ModbusReadWriteMultipleRegsReq

Read/Write Multiple Registers request PDU.

ModbusReadWriteMultipleRegsResp

typedef { ... } ModbusReadWriteMultipleRegsResp

Read/Write Multiple Registers response PDU.

ModbusWriteMultipleCoilsReq

typedef { ... } ModbusWriteMultipleCoilsReq

Write Multiple Coils request PDU.

ModbusWriteMultipleCoilsResp

typedef { ... } ModbusWriteMultipleCoilsResp

Write Multiple Coils response PDU.

ModbusWriteMultipleRegsReq

typedef { ... } ModbusWriteMultipleRegsReq

Write Multiple Registers request PDU.

ModbusWriteMultipleRegsResp

typedef { ... } ModbusWriteMultipleRegsResp

Write Multiple Registers response PDU.

ModbusWriteSingleCoilReq

typedef { ... } ModbusWriteSingleCoilReq

Write Single Coil request PDU.

ModbusWriteSingleCoilResp

typedef { ... } ModbusWriteSingleCoilResp

Write Single Coil response PDU.

ModbusWriteSingleRegReq

typedef { ... } ModbusWriteSingleRegReq

Write Single Register request PDU.

ModbusWriteSingleRegResp

typedef { ... } ModbusWriteSingleRegResp

Write Single Register response PDU.

Enumeration Type Documentation

ModbusCoilState

enum ModbusCoilState

Coil states.

Enumerator
MODBUS_COIL_STATE_OFF
MODBUS_COIL_STATE_ON

Definition at line 120 of file modbus_common.h.

ModbusExceptionCode

enum ModbusExceptionCode

Modbus exception codes.

Enumerator
MODBUS_EXCEPTION_ILLEGAL_FUNCTION
MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS
MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE
MODBUS_EXCEPTION_SLAVE_DEVICE_FAILURE
MODBUS_EXCEPTION_ACKNOWLEDGE
MODBUS_EXCEPTION_SLAVE_DEVICE_BUSY
MODBUS_EXCEPTION_MEMORY_PARITY_ERROR
MODBUS_EXCEPTION_GATEWAY_PATH_UNAVAILABLE
MODBUS_EXCEPTION_GATEWAY_NO_RESPONSE_FROM_TARGET

Definition at line 102 of file modbus_common.h.

ModbusFunctionCode

enum ModbusFunctionCode

Modbus functions codes.

Enumerator
MODBUS_FUNCTION_READ_COILS
MODBUS_FUNCTION_READ_DISCRETE_INPUTS
MODBUS_FUNCTION_READ_HOLDING_REGS
MODBUS_FUNCTION_READ_INPUT_REGS
MODBUS_FUNCTION_WRITE_SINGLE_COIL
MODBUS_FUNCTION_WRITE_SINGLE_REG
MODBUS_FUNCTION_READ_EXCEPTION_STATUS
MODBUS_FUNCTION_DIAGNOSTICS
MODBUS_FUNCTION_GET_COMM_EVENT_COUNTER
MODBUS_FUNCTION_GET_COMM_EVENT_LOG
MODBUS_FUNCTION_WRITE_MULTIPLE_COILS
MODBUS_FUNCTION_WRITE_MULTIPLE_REGS
MODBUS_FUNCTION_REPORT_SLAVE_ID
MODBUS_FUNCTION_READ_FILE_RECORD
MODBUS_FUNCTION_WRITE_FILE_RECORD
MODBUS_FUNCTION_MASK_WRITE_REG
MODBUS_FUNCTION_READ_WRITE_MULTIPLE_REGS
MODBUS_FUNCTION_READ_FIFO_QUEUE
MODBUS_FUNCTION_ENCAPSULATED_IF_TRANSPORT

Definition at line 74 of file modbus_common.h.

Variable Documentation

andMask

uint16_t andMask

Definition at line 351 of file modbus_common.h.

byteCount

uint8_t byteCount

Definition at line 166 of file modbus_common.h.

coilStatus

uint8_t coilStatus[]

Definition at line 167 of file modbus_common.h.

exceptionCode

uint8_t exceptionCode

Definition at line 404 of file modbus_common.h.

functionCode

uint8_t functionCode

Definition at line 153 of file modbus_common.h.

inputStatus

uint8_t inputStatus[]

Definition at line 191 of file modbus_common.h.

length

uint16_t length

Definition at line 141 of file modbus_common.h.

orMask

uint16_t orMask

Definition at line 352 of file modbus_common.h.

outputAddr

uint16_t outputAddr

Definition at line 250 of file modbus_common.h.

outputValue

uint8_t outputValue[]

Definition at line 251 of file modbus_common.h.

pdu

uint8_t pdu[]

Definition at line 143 of file modbus_common.h.

protocolId

uint16_t protocolId

Definition at line 140 of file modbus_common.h.

quantityOfCoils

uint16_t quantityOfCoils

Definition at line 155 of file modbus_common.h.

quantityOfInputs

uint16_t quantityOfInputs

Definition at line 179 of file modbus_common.h.

quantityOfOutputs

uint16_t quantityOfOutputs

Definition at line 299 of file modbus_common.h.

quantityOfRegs

uint16_t quantityOfRegs

Definition at line 203 of file modbus_common.h.

quantityToRead

uint16_t quantityToRead

Definition at line 377 of file modbus_common.h.

quantityToWrite

uint16_t quantityToWrite

Definition at line 379 of file modbus_common.h.

readByteCount

uint8_t readByteCount

Definition at line 392 of file modbus_common.h.

readRegValue

uint16_t readRegValue[]

Definition at line 393 of file modbus_common.h.

readStartingAddr

uint16_t readStartingAddr

Definition at line 376 of file modbus_common.h.

referenceAddr

uint16_t referenceAddr

Definition at line 350 of file modbus_common.h.

regAddr

uint16_t regAddr

Definition at line 274 of file modbus_common.h.

regValue

uint16_t regValue[]

Definition at line 215 of file modbus_common.h.

startingAddr

uint16_t startingAddr

Definition at line 154 of file modbus_common.h.

transactionId

uint16_t transactionId

Definition at line 139 of file modbus_common.h.

unitId

uint8_t unitId

Definition at line 142 of file modbus_common.h.

writeByteCount

uint8_t writeByteCount

Definition at line 380 of file modbus_common.h.

writeRegValue

uint16_t writeRegValue[]

Definition at line 381 of file modbus_common.h.

writeStartingAddr

uint16_t writeStartingAddr

Definition at line 378 of file modbus_common.h.