dali/bacnet_stack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
31af2507fbe201029d438cb06d84c4e6d364ebed
bacnet_stack/src/bacnet/bacdcode.c
T
Steve Karg 31af2507fb Bugfix/secure read range codec (#957) 
* Secured ReadRange service codecs. Added ReadRange unit testing. Secured ReadRange-ACK handler to enable APDU size checking.
2025-04-03 09:14:08 -05:00

4995 lines
143 KiB
C
Raw Blame History

/**
* @file
* @brief BACnet primitive data encode and decode helper functions
* @author Steve Karg <skarg@users.sourceforge.net>
* @date 2004
* @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0
*/
#include <string.h>
/* BACnet Stack defines - first */
#include "bacnet/bacdef.h"
/* BACnet Stack API */
#include "bacnet/bacdcode.h"
#include "bacnet/bacstr.h"
#include "bacnet/bacint.h"
#include "bacnet/bacreal.h"
/* max-segments-accepted
B'000' Unspecified number of segments accepted.
B'001' 2 segments accepted.
B'010' 4 segments accepted.
B'011' 8 segments accepted.
B'100' 16 segments accepted.
B'101' 32 segments accepted.
B'110' 64 segments accepted.
B'111' Greater than 64 segments accepted.
*/
/* max-APDU-length-accepted
B'0000' Up to MinimumMessageSize (50 octets)
B'0001' Up to 128 octets
B'0010' Up to 206 octets (fits in a LonTalk frame)
B'0011' Up to 480 octets (fits in an ARCNET frame)
B'0100' Up to 1024 octets
B'0101' Up to 1476 octets (fits in an ISO 8802-3 frame)
B'0110' reserved by ASHRAE
B'0111' reserved by ASHRAE
B'1000' reserved by ASHRAE
B'1001' reserved by ASHRAE
B'1010' reserved by ASHRAE
B'1011' reserved by ASHRAE
B'1100' reserved by ASHRAE
B'1101' reserved by ASHRAE
B'1110' reserved by ASHRAE
B'1111' reserved by ASHRAE
*/
/* Encoding of BACNET Length/Value/Type tag
From clause 20.2.1.3.1
B'000' interpreted as Value = FALSE if application class == BOOLEAN
B'001' interpreted as Value = TRUE if application class == BOOLEAN
B'000' interpreted as Length = 0 if application class != BOOLEAN
B'001' interpreted as Length = 1
B'010' interpreted as Length = 2
B'011' interpreted as Length = 3
B'100' interpreted as Length = 4
B'101' interpreted as Length > 4
B'110' interpreted as Type = Opening Tag
B'111' interpreted as Type = Closing Tag
*/
/**
* Encode the max APDU value and return the encoded octed.
*
* @param max_segs from clause 20.1.2.4 max-segments-accepted
* @param max_apdu from clause 20.1.2.5 max-APDU-length-accepted
*
* @return The encoded octet
*/
uint8_t encode_max_segs_max_apdu(int max_segs, int max_apdu)
{
uint8_t octet = 0;
if (max_segs < 2) {
octet = 0;
} else if (max_segs < 4) {
octet = 0x10;
} else if (max_segs < 8) {
octet = 0x20;
} else if (max_segs < 16) {
octet = 0x30;
} else if (max_segs < 32) {
octet = 0x40;
} else if (max_segs < 64) {
octet = 0x50;
} else if (max_segs == 64) {
octet = 0x60;
} else {
octet = 0x70;
}
/* max_apdu must be 50 octets minimum */
if (max_apdu <= 50) {
octet |= 0x00;
} else if (max_apdu <= 128) {
octet |= 0x01;
/*fits in a LonTalk frame */
} else if (max_apdu <= 206) {
octet |= 0x02;
/*fits in an ARCNET or MS/TP frame */
} else if (max_apdu <= 480) {
octet |= 0x03;
} else if (max_apdu <= 1024) {
octet |= 0x04;
/* fits in an ISO 8802-3 frame */
} else if (max_apdu <= 1476) {
octet |= 0x05;
}
return octet;
}
/**
* Decode the given octed into a maximum segments value.
*
* @param octed From clause 20.1.2.4 max-segments-accepted
* and clause 20.1.2.5 max-APDU-length-accepted
*
* @return Returns the maximum segments value.
*/
int decode_max_segs(uint8_t octet)
{
int max_segs = 0;
switch (octet & 0xF0) {
case 0:
max_segs = 0;
break;
case 0x10:
max_segs = 2;
break;
case 0x20:
max_segs = 4;
break;
case 0x30:
max_segs = 8;
break;
case 0x40:
max_segs = 16;
break;
case 0x50:
max_segs = 32;
break;
case 0x60:
max_segs = 64;
break;
case 0x70:
max_segs = 65;
break;
default:
break;
}
return max_segs;
}
/**
* Decode the given octed into a maximum APDU value.
*
* @param octet From clause 20.1.2.4 max-segments-accepted
* and clause 20.1.2.5 max-APDU-length-accepted
*
* @return Returns the maximum APDU value.
*/
int decode_max_apdu(uint8_t octet)
{
int max_apdu = 0;
switch (octet & 0x0F) {
case 0:
max_apdu = 50;
break;
case 1:
max_apdu = 128;
break;
case 2:
max_apdu = 206;
break;
case 3:
max_apdu = 480;
break;
case 4:
max_apdu = 1024;
break;
case 5:
max_apdu = 1476;
break;
default:
break;
}
return max_apdu;
}
/**
* Encode a BACnet tag and returns the number of bytes consumed.
* (From clause 20.2.1 General Rules for Encoding BACnet Tags)
*
* @param apdu Pointer to the encode buffer, or NULL for length
* @param tag_number Number of the tag to encode,
* see BACNET_APPLICATION_TAG_X macros.
* @param context_specific Indicates to encode in the given context.
* @param len_value_type Indicates the length of the tag's content.
*
* @return Returns the number of apdu bytes consumed.
*/
int encode_tag(
uint8_t *apdu,
uint8_t tag_number,
bool context_specific,
uint32_t len_value_type)
{
int len = 1; /* return value */
uint8_t *apdu_offset = NULL;
if (apdu) {
apdu[0] = 0;
}
if (context_specific) {
if (apdu) {
apdu[0] = BIT(3);
}
}
/* additional tag byte after this byte */
/* for extended tag byte */
if (tag_number <= 14) {
if (apdu) {
apdu[0] |= (tag_number << 4);
}
} else {
if (apdu) {
apdu[0] |= 0xF0;
apdu[1] = tag_number;
}
len++;
}
/* NOTE: additional len byte(s) after extended tag byte */
/* if larger than 4 */
if (len_value_type <= 4) {
if (apdu) {
apdu[0] |= len_value_type;
}
} else {
if (apdu) {
apdu[0] |= 5;
}
if (len_value_type <= 253) {
if (apdu) {
apdu[len] = (uint8_t)len_value_type;
}
len++;
} else if (len_value_type <= 65535) {
if (apdu) {
apdu[len] = 254;
}
len++;
if (apdu) {
apdu_offset = &apdu[len];
}
len += encode_unsigned16(apdu_offset, (uint16_t)len_value_type);
} else {
if (apdu) {
apdu[len] = 255;
}
len++;
if (apdu) {
apdu_offset = &apdu[len];
}
len += encode_unsigned32(apdu_offset, len_value_type);
}
}
return len;
}
/**
* @brief Encode a BACnet opening tag and returns the number
* of bytes consumed. From clause 20.2.1.3.2 Constructed Data.
*
* An "opening" tag whose Tag Number field shall contain the value
* of the tag number, whose Class field shall indicate
* "context specific," and whose length/value/type field shall
* have the value B'110';
*
* @param apdu Pointer to the encode buffer, or NULL for length
* @param tag_number Number of the tag to encode,
* see BACNET_APPLICATION_TAG_X macros.
*
* @return Returns the number of apdu bytes consumed.
*/
int encode_opening_tag(uint8_t *apdu, uint8_t tag_number)
{
int len = 1;
if (apdu) {
/* set class field to context specific */
apdu[0] = BIT(3);
}
/* additional tag byte after this byte for extended tag byte */
if (tag_number <= 14) {
if (apdu) {
apdu[0] |= (tag_number << 4);
}
} else {
if (apdu) {
apdu[0] |= 0xF0;
apdu[1] = tag_number;
}
len++;
}
if (apdu) {
/* set type field to opening tag */
apdu[0] |= 6;
}
return len;
}
/**
* Encode a BACnet closing tag and returns the number
* of bytes consumed. From clause 20.2.1.3.2 Constructed Data:
*
* A "closing" tag, whose Class and Tag Number fields shall
* contain the same values as the "opening" tag and whose
* length/value/type field shall have the value B'111'.
*
* @param apdu Pointer to the encode buffer, or NULL for length
* @param tag_number Number of the tag to encode,
* see BACNET_APPLICATION_TAG_X macros.
*
* @return Returns the number of apdu bytes consumed.
*/
int encode_closing_tag(uint8_t *apdu, uint8_t tag_number)
{
int len = 1;
/* set class field to context specific */
if (apdu) {
apdu[0] = BIT(3);
}
/* additional tag byte after this byte for extended tag byte */
if (tag_number <= 14) {
if (apdu) {
apdu[0] |= (tag_number << 4);
}
} else {
if (apdu) {
apdu[0] |= 0xF0;
apdu[1] = tag_number;
}
len++;
}
if (apdu) {
/* set type field to closing tag */
apdu[0] |= 7;
}
return len;
}
/**
* Decode a BACnet tag and returns the number of bytes consumed.
*
* @param apdu Pointer to the encode buffer
* @param tag_number Place holder for number of the tag decoded
* see BACNET_APPLICATION_TAG_X macros.
*
* @return Returns the number of apdu bytes consumed.
* @deprecated Use bacnet_tag_number_decode() instead
*/
int decode_tag_number(const uint8_t *apdu, uint8_t *tag_number)
{
int len = 1; /* return value */
/* decode the tag number first */
if (IS_EXTENDED_TAG_NUMBER(apdu[0])) {
/* extended tag */
if (tag_number) {
*tag_number = apdu[1];
}
len++;
} else {
if (tag_number) {
*tag_number = (uint8_t)(apdu[0] >> 4);
}
}
return len;
}
/**
* @brief Decode the BACnet Tag Number
* as defined in clause 20.2.1.2 Tag Number
*
* Bit Number:
* 7 6 5 4 3 2 1 0
* |-----|-----|-----|-----|-----|-----|-----|-----|
* | Tag Number |Class|Length/Value/Type|
* |-----|-----|-----|-----|-----|-----|-----|-----|
*
* Tag numbers ranging from zero to 14 (inclusive) shall be encoded
* in the Tag Number field of the initial octet as a four bit
* binary integer with bit 7 the most significant bit.
*
* Tag numbers ranging from 15 to 254 (inclusive) shall be encoded by
* setting the Tag Number field of the initial octet to B'1111'
* and following the initial tag octet by an octet containing the
* tag number represented as an eight-bit binary integer with bit 7 the
* most significant bit.
*
* The encoding does not allow, nor does BACnet require, tag numbers
* larger than 254. The value B'11111111' of the subsequent
* octet is reserved by ASHRAE.
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param tag_number - BACnet tag number
*
* @return number of bytes decoded, or zero if errors occur
*/
int bacnet_tag_number_decode(
const uint8_t *apdu, uint32_t apdu_size, uint8_t *tag_number)
{
int len = 0; /* return value */
if (apdu_size >= 1) {
if (IS_EXTENDED_TAG_NUMBER(apdu[0])) {
if (apdu_size >= 2) {
/* extended tag */
if (tag_number) {
*tag_number = apdu[1];
}
len = 2;
} else {
/* malfomed */
len = 0;
}
} else {
if (tag_number) {
*tag_number = (uint8_t)(apdu[0] >> 4);
}
len = 1;
}
}
return len;
}
/**
* @brief Encode a BACnet BACnet Tag Number and Value
* as defined in clause 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the data to be encoded, or NULL for length
* @param apdu_size - number of bytes in the buffer
* @param tag - tag value to encode
*
* @return returns the number of apdu bytes consumed,
* or 0 if apdu_size is too small to fit the data
*/
int bacnet_tag_encode(uint8_t *apdu, uint32_t apdu_size, const BACNET_TAG *tag)
{
int apdu_len = 0; /* total length of the apdu, return value */
if (!tag) {
return 0;
}
if (tag->application) {
apdu_len = encode_tag(NULL, tag->number, false, tag->len_value_type);
} else if (tag->context) {
apdu_len = encode_tag(NULL, tag->number, true, tag->len_value_type);
} else if (tag->opening) {
apdu_len = encode_opening_tag(NULL, tag->number);
} else if (tag->closing) {
apdu_len = encode_closing_tag(NULL, tag->number);
}
if (apdu_len > apdu_size) {
apdu_len = 0;
} else {
if (tag->application) {
apdu_len =
encode_tag(apdu, tag->number, false, tag->len_value_type);
} else if (tag->context) {
apdu_len = encode_tag(apdu, tag->number, true, tag->len_value_type);
} else if (tag->opening) {
apdu_len = encode_opening_tag(apdu, tag->number);
} else if (tag->closing) {
apdu_len = encode_closing_tag(apdu, tag->number);
}
}
return apdu_len;
}
/**
* @brief Decode the BACnet Tag Number and Value
* as defined in clause 20.2.1 General Rules For Encoding BACnet Tags
*
* @param apdu - buffer of data to be decoded
* @param apdu_size - number of bytes in the buffer
* @param tag - decoded tag data, if decoded
*
* @return the number of apdu bytes consumed, or zero if malformed
*/
int bacnet_tag_decode(const uint8_t *apdu, uint32_t apdu_size, BACNET_TAG *tag)
{
int len = 0;
uint8_t tag_number = 0;
bool application_tag = false;
bool context_tag = false;
bool opening_tag = false;
bool closing_tag = false;
uint32_t len_value_type = 0;
if (apdu && (apdu_size > 0)) {
len = bacnet_tag_number_decode(&apdu[0], apdu_size, &tag_number);
}
if (len > 0) {
if (IS_EXTENDED_VALUE(apdu[0])) {
if (apdu_size > len) {
apdu_size -= len;
if ((apdu[len] == 255) && (apdu_size >= 5)) {
/* tagged as uint32_t */
uint32_t value32;
len++;
len += decode_unsigned32(&apdu[len], &value32);
len_value_type = value32;
} else if ((apdu[len] == 254) && (apdu_size >= 3)) {
/* tagged as uint16_t */
uint16_t value16;
len++;
len += decode_unsigned16(&apdu[len], &value16);
len_value_type = value16;
} else if ((apdu[len] < 254) && (apdu_size >= 1)) {
/* no tag - must be uint8_t */
len_value_type = apdu[len];
len++;
} else {
/* packet is malformed */
len = 0;
}
} else {
/* packet is malformed */
len = 0;
}
} else if (IS_OPENING_TAG(apdu[0])) {
/* reserved value */
} else if (IS_CLOSING_TAG(apdu[0])) {
/* reserved value */
} else {
/* small value */
len_value_type = apdu[0] & 0x07;
}
if (IS_CONTEXT_SPECIFIC(apdu[0])) {
if (IS_OPENING_TAG(apdu[0])) {
opening_tag = true;
} else if (IS_CLOSING_TAG(apdu[0])) {
closing_tag = true;
} else {
context_tag = true;
}
} else {
application_tag = true;
}
if ((len > 0) && tag) {
tag->number = tag_number;
tag->application = application_tag;
tag->context = context_tag;
tag->opening = opening_tag;
tag->closing = closing_tag;
tag->len_value_type = len_value_type;
}
}
return len;
}
/**
* @brief Returns if at the given pointer a
* opening tag has been found.
* @param apdu Pointer to the tag number.
* @return true/false
* @deprecated Use bacnet_is_opening_tag() instead
*/
bool decode_is_opening_tag(const uint8_t *apdu)
{
return (bool)((apdu[0] & 0x07) == 6);
}
/**
* @brief Returns true if an opening tag has been found.
*
* @param apdu Pointer to the tag number.
* @param apdu_size Number of bytes available to decode
*
* @return true if an opening tag has been found.
*/
bool bacnet_is_opening_tag(const uint8_t *apdu, uint32_t apdu_size)
{
bool tag = false;
if (apdu_size > 0) {
if (IS_CONTEXT_SPECIFIC(apdu[0]) && (IS_OPENING_TAG(apdu[0]))) {
tag = true;
}
}
return tag;
}
/**
* @brief Returns if at the given pointer a
* closing tag has been found.
* @param apdu Pointer to the tag number.
* @return true/false
* @deprecated Use bacnet_is_closing_tag() instead
*/
bool decode_is_closing_tag(const uint8_t *apdu)
{
return (bool)((apdu[0] & 0x07) == 7);
}
/**
* @brief Returns true if a closing tag has been found.
*
* @param apdu Pointer to the tag number.
* @param apdu_size Number of bytes available to decode
*
* @return true if a closing tag has been found.
*/
bool bacnet_is_closing_tag(const uint8_t *apdu, uint32_t apdu_size)
{
bool tag = false;
if (apdu_size > 0) {
if (IS_CONTEXT_SPECIFIC(apdu[0]) && (IS_CLOSING_TAG(apdu[0]))) {
tag = true;
}
}
return tag;
}
/**
* @brief Returns true if a context specific tag has been found.
*
* @param apdu Pointer to the tag number.
* @param apdu_size Number of bytes available to decode
*
* @return true if a context specific tag has been found.
*/
bool bacnet_is_context_specific(const uint8_t *apdu, uint32_t apdu_size)
{
bool tag = false;
if (apdu_size > 0) {
if (IS_CONTEXT_SPECIFIC(apdu[0])) {
tag = true;
}
}
return tag;
}
/**
* @brief Decodes the tag number and the value,
* that the APDU pointer is addressing.
* (From clause 20.2.1.3.2 Constructed Data)
*
* @param apdu Pointer to the message buffer.
* @param tag_number Pointer to a variable
* taking the tag number.
* @param value Pointer to a variable
* taking the value.
*
* @return number of bytes decoded, or zero if errors occur
* @deprecated Use bacnet_tag_decode() instead
*/
int decode_tag_number_and_value(
const uint8_t *apdu, uint8_t *tag_number, uint32_t *value)
{
int len = 1;
uint16_t value16;
uint32_t value32;
len = decode_tag_number(&apdu[0], tag_number);
if (IS_EXTENDED_VALUE(apdu[0])) {
/* tagged as uint32_t */
if (apdu[len] == 255) {
len++;
value32 = 0;
len += decode_unsigned32(&apdu[len], &value32);
if (value) {
*value = value32;
}
}
/* tagged as uint16_t */
else if (apdu[len] == 254) {
len++;
value16 = 0;
len += decode_unsigned16(&apdu[len], &value16);
if (value) {
*value = value16;
}
}
/* no tag - must be uint8_t */
else {
if (value) {
*value = apdu[len];
}
len++;
}
} else if (IS_OPENING_TAG(apdu[0]) && value) {
/* opening tag */
*value = 0;
} else if (IS_CLOSING_TAG(apdu[0]) && value) {
/* closing tag */
*value = 0;
} else if (value) {
/* small value */
*value = apdu[0] & 0x07;
}
return len;
}
/**
* @brief Decode the BACnet Tag Number and Value
* as defined in clause 20.2.1.3.2 Constructed Data
*
* @param apdu - buffer of data to be decoded
* @param apdu_size - number of bytes in the buffer
* @param tag_number - decoded tag number, if decoded
* @param value - decoded value, if decoded
*
* @return the number of apdu bytes consumed, or zero if errors occur
* @deprecated use bacnet_tag_decode() instead
*/
int bacnet_tag_number_and_value_decode(
const uint8_t *apdu,
uint32_t apdu_size,
uint8_t *tag_number,
uint32_t *value)
{
int len = 0;
BACNET_TAG tag = { 0 };
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (value) {
*value = tag.len_value_type;
}
if (value) {
*tag_number = tag.number;
}
}
return len;
}
/**
* @brief Determine the data length from the application tag number
* @param tag_number application tag number to be evaluated.
* @param len_value_type Length of the data in bytes.
* @return datalength for the given tag, or INT_MAX if out of range.
*/
int bacnet_application_data_length(uint8_t tag_number, uint32_t len_value_type)
{
int len = 0;
switch (tag_number) {
case BACNET_APPLICATION_TAG_NULL:
break;
case BACNET_APPLICATION_TAG_BOOLEAN:
break;
case BACNET_APPLICATION_TAG_UNSIGNED_INT:
case BACNET_APPLICATION_TAG_SIGNED_INT:
case BACNET_APPLICATION_TAG_REAL:
case BACNET_APPLICATION_TAG_DOUBLE:
case BACNET_APPLICATION_TAG_OCTET_STRING:
case BACNET_APPLICATION_TAG_CHARACTER_STRING:
case BACNET_APPLICATION_TAG_BIT_STRING:
case BACNET_APPLICATION_TAG_ENUMERATED:
case BACNET_APPLICATION_TAG_DATE:
case BACNET_APPLICATION_TAG_TIME:
case BACNET_APPLICATION_TAG_OBJECT_ID:
len = INT_MAX;
if (len_value_type < INT_MAX) {
len = (int)len_value_type;
}
break;
default:
break;
}
return len;
}
/**
* @brief Returns the length of data between an opening tag and a closing tag.
* @note Expects that the first octet contain the opening tag.
* @param apdu Pointer to the APDU buffer
* @param apdu_size Bytes valid in the buffer
* @param property ID of the property to get the length for.
* @return length of data between an opening tag and a closing tag 0..N,
* or BACNET_STATUS_ERROR.
*/
int bacnet_enclosed_data_length(const uint8_t *apdu, size_t apdu_size)
{
int len = 0;
int total_len = 0;
int apdu_len = 0;
BACNET_TAG tag = { 0 };
uint8_t opening_tag_number = 0;
uint8_t opening_tag_number_counter = 0;
bool total_len_enable = false;
if (!apdu) {
return BACNET_STATUS_ERROR;
}
if (apdu_size <= apdu_len) {
/* error: exceeding our buffer limit */
return BACNET_STATUS_ERROR;
}
if (!bacnet_is_opening_tag(apdu, apdu_size)) {
/* error: opening tag is missing */
return BACNET_STATUS_ERROR;
}
do {
len = bacnet_tag_decode(apdu, apdu_size - apdu_len, &tag);
if (len == 0) {
return BACNET_STATUS_ERROR;
}
if (tag.opening) {
if (opening_tag_number_counter == 0) {
opening_tag_number = tag.number;
opening_tag_number_counter = 1;
total_len_enable = false;
} else if (tag.number == opening_tag_number) {
total_len_enable = true;
opening_tag_number_counter++;
} else {
total_len_enable = true;
}
} else if (tag.closing) {
if (tag.number == opening_tag_number) {
if (opening_tag_number_counter > 0) {
opening_tag_number_counter--;
}
}
total_len_enable = true;
} else if (tag.context) {
if (tag.len_value_type > INT_MAX) {
/* error: length is out of range */
return BACNET_STATUS_ERROR;
}
len += tag.len_value_type;
total_len_enable = true;
} else {
if (tag.len_value_type > INT_MAX) {
/* error: length is out of range */
return BACNET_STATUS_ERROR;
}
/* application tagged data */
len +=
bacnet_application_data_length(tag.number, tag.len_value_type);
total_len_enable = true;
}
if (opening_tag_number_counter > 0) {
if (len > 0) {
if (total_len_enable) {
total_len += len;
}
} else {
/* error: len is not incrementing */
return BACNET_STATUS_ERROR;
}
apdu_len += len;
if (apdu_size <= apdu_len) {
/* error: exceeding our buffer limit */
return BACNET_STATUS_ERROR;
}
apdu += len;
}
} while (opening_tag_number_counter > 0);
return total_len;
}
/**
* @brief Returns true if the tag is context specific
* and matches, as defined in clause 20.2.1.3.2 Constructed
* Data.
*
* @param apdu Pointer to the tag begin.
* @param tag_number Tag number, that has been decoded before.
*
* @return true on a match, false otherwise.
* @deprecated Use bacnet_is_context_tag_number() instead
*/
bool decode_is_context_tag(const uint8_t *apdu, uint8_t tag_number)
{
uint8_t my_tag_number = 0;
decode_tag_number(apdu, &my_tag_number);
return (bool)(IS_CONTEXT_SPECIFIC(*apdu) && (my_tag_number == tag_number));
}
/**
* @brief Returns true if the tag is context specific
* and matches, as defined in clause 20.2.1.3.2 Constructed
* Data. This function returns the tag length as well.
*
* @param apdu Pointer to the tag begin.
* @param tag_number Tag number, that has been decoded before.
* @param tag_length Pointer to a variable, taking the
* length of the tag in bytes.
*
* @return true on a match, false otherwise.
* @deprecated Use bacnet_is_context_tag_number() instead
*/
bool decode_is_context_tag_with_length(
const uint8_t *apdu, uint8_t tag_number, int *tag_length)
{
uint8_t my_tag_number = 0;
*tag_length = decode_tag_number(apdu, &my_tag_number);
return (bool)(IS_CONTEXT_SPECIFIC(*apdu) && (my_tag_number == tag_number));
}
/**
* @brief Returns true if the tag is context specific
* and matches, as defined in clause 20.2.1.3.2 Constructed
* Data. This function returns the tag length as well.
*
* @param apdu Pointer to the tag begin.
* @param apdu_size - number of bytes in the buffer
* @param tag_number Tag number, that has been decoded before.
* @param tag_length Pointer to a variable, or NULL.
* Returns the length of the tag in bytes if not NULL.
* @param len_value_type Pointer to a variable, or NULL.
* Returns the len_value_type of the tag in bytes if not NULL.
*
* @return true on a match, false otherwise.
*/
bool bacnet_is_context_tag_number(
const uint8_t *apdu,
uint32_t apdu_size,
uint8_t tag_number,
int *tag_length,
uint32_t *len_value_type)
{
bool match = false;
int len;
BACNET_TAG tag = { 0 };
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.context && (tag.number == tag_number)) {
if (tag_length) {
*tag_length = len;
}
if (len_value_type) {
*len_value_type = tag.len_value_type;
}
match = true;
}
}
return match;
}
/**
* @brief Returns true if the tag does match and it
* is an opening tag as well.
* As defined in clause 20.2.1.3.2 Constructed Data.
*
* @param apdu Pointer to the tag begin.
* @param tag_number Tag number, that has been decoded before.
*
* @return true on a match, false otherwise.
* @deprecated Use bacnet_is_opening_tag_number() instead
*/
bool decode_is_opening_tag_number(const uint8_t *apdu, uint8_t tag_number)
{
uint8_t my_tag_number = 0;
decode_tag_number(apdu, &my_tag_number);
return (bool)(IS_OPENING_TAG(apdu[0]) && (my_tag_number == tag_number));
}
/**
* @brief Returns true if the tag number matches is an opening tag.
* As defined in clause 20.2.1.3.2 Constructed Data:
* An "opening" tag whose Tag Number field shall contain the
* value of the tag number, whose Class field shall indicate
* "context specific," and whose length/value/type field shall
* have the value B'110';
*
* @param apdu Pointer to the tag begin.
* @param apdu_size - number of bytes in the buffer
* @param tag_number Tag number, that has been decoded before.
* @param tag_length Pointer to a variable, or NULL.
* Returns the length of the tag in bytes if not NULL.
*
* @return true if the tag number matches and is an opening tag.
*/
bool bacnet_is_opening_tag_number(
const uint8_t *apdu,
uint32_t apdu_size,
uint8_t tag_number,
int *tag_length)
{
bool match = false;
int len;
BACNET_TAG tag = { 0 };
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.opening && (tag.number == tag_number)) {
match = true;
if (tag_length) {
*tag_length = len;
}
}
}
return match;
}
/**
* @brief Returns true if the tag does match and it
* is an closing tag as well.
* As defined in clause 20.2.1.3.2 Constructed Data.
*
* @param apdu Pointer to the tag begin.
* @param tag_number Tag number, that has been decoded before.
*
* @return true on a match, false otherwise.
* @deprecated Use bacnet_is_closing_tag_number() instead
*/
bool decode_is_closing_tag_number(const uint8_t *apdu, uint8_t tag_number)
{
uint8_t my_tag_number = 0;
decode_tag_number(apdu, &my_tag_number);
return (bool)(IS_CLOSING_TAG(apdu[0]) && (my_tag_number == tag_number));
}
/**
* @brief Returns true if the tag number matches is an closing tag.
* As defined in clause 20.2.1.3.2 Constructed Data:
* a "closing" tag, whose Class and Tag Number fields shall
* contain the same values as the "opening" tag and whose
* length/value/type field shall have the value B'111'.
*
* @param apdu Pointer to the tag begin.
* @param apdu_size - number of bytes in the buffer
* @param tag_number Tag number, that has been decoded before.
* @param tag_length Pointer to a variable, or NULL.
* Returns the length of the tag in bytes if not NULL.
*
* @return true if the tag number matches is an closing tag.
*/
bool bacnet_is_closing_tag_number(
const uint8_t *apdu,
uint32_t apdu_size,
uint8_t tag_number,
int *tag_length)
{
bool match = false;
int len;
BACNET_TAG tag = { 0 };
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.closing && (tag.number == tag_number)) {
match = true;
if (tag_length) {
*tag_length = len;
}
}
}
return match;
}
/**
* @brief Encode an boolean value.
* From clause 20.2.3 Encoding of a Boolean Value
* and 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu Pointer to the encode buffer.
* @param boolean_value Boolean value to encode.
*
* @return returns the number of apdu bytes consumed
*/
int encode_application_boolean(uint8_t *apdu, bool boolean_value)
{
int len = 0;
uint32_t len_value;
if (boolean_value) {
len_value = 1;
} else {
len_value = 0;
}
len = encode_tag(apdu, BACNET_APPLICATION_TAG_BOOLEAN, false, len_value);
return len;
}
/**
* @brief Encode an boolean value in a context.
* From clause 20.2.3 Encoding of a Boolean Value
* and 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu Pointer to the encode buffer.
* @param tag_number Tag number in which context
* the value shall be encoded.
* @param boolean_value Boolean value to encode.
*
* @return returns the number of apdu bytes consumed
*/
int encode_context_boolean(
uint8_t *apdu, uint8_t tag_number, bool boolean_value)
{
int len; /* return value */
len = encode_tag(apdu, (uint8_t)tag_number, true, 1);
if (apdu) {
apdu[len] = (bool)(boolean_value ? 1 : 0);
}
len++;
return len;
}
/**
* @brief Decode an boolean value.
* @param apdu Pointer to the encode buffer.
* @return true/false
* @deprecated Use bacnet_boolean_context_decode() instead
*/
bool decode_context_boolean(const uint8_t *apdu)
{
bool boolean_value = false;
if (apdu[0]) {
boolean_value = true;
}
return boolean_value;
}
/**
* @brief Decode an boolean value in the context of a tag.
*
* @param apdu Pointer to the encode buffer.
* @param tag_number Tag number in which context
* the value shall be encoded.
* @param boolean_value Pointer to a boolean variable
* taking the value.
*
* @return The count of bytes decoded or BACNET_STATUS_ERROR.
* @deprecated Use bacnet_boolean_context_decode() instead
*/
int decode_context_boolean2(
const uint8_t *apdu, uint8_t tag_number, bool *boolean_value)
{
int len = 0;
if (decode_is_context_tag_with_length(&apdu[len], tag_number, &len)) {
if (apdu[len]) {
*boolean_value = true;
} else {
*boolean_value = false;
}
len++;
} else {
len = BACNET_STATUS_ERROR;
}
return len;
}
/**
* @brief Check the length value and return the boolean meaning.
* From clause 20.2.3 Encoding of a Boolean Value
* and 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param len_value Tag length value.
*
* @return true/false
*/
bool decode_boolean(uint32_t len_value)
{
bool boolean_value;
if (len_value) {
boolean_value = true;
} else {
boolean_value = false;
}
return boolean_value;
}
/**
* @brief Encode an application tagged boolean value.
* From clause 20.2.3 Encoding of a Boolean Value
* and 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu - buffer to hold the data to be encoded, or NULL for length
* @param apdu_size - number of bytes in the buffer
* @param value - value to encode.
*
* @return returns the number of apdu bytes consumed,
* or 0 if apdu_size is too small to fit the data
*/
int bacnet_boolean_application_encode(
uint8_t *apdu, uint32_t apdu_size, bool value)
{
int apdu_len = 0; /* total length of the apdu, return value */
apdu_len = encode_application_boolean(NULL, value);
if (apdu_len > apdu_size) {
apdu_len = 0;
} else {
apdu_len = encode_application_boolean(apdu, value);
}
return apdu_len;
}
/**
* @brief Decode the Boolean Value when application encoded
* From clause 20.2.3 Encoding of a Boolean Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be decoded
* @param apdu_size - number of bytes in the buffer
* @param boolean_value - decoded Boolean Value, if decoded
*
* @return number of bytes decoded, zero if tag mismatch,
* or #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_boolean_application_decode(
const uint8_t *apdu, uint32_t apdu_size, bool *boolean_value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.application && (tag.number == BACNET_APPLICATION_TAG_BOOLEAN)) {
apdu_len = len;
if (boolean_value) {
*boolean_value = decode_boolean(tag.len_value_type);
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Decode a context boolean value.
* @param apdu Pointer to the encode buffer.
* @param apdu_size Number of bytes in the buffer.
* @param boolean_value Pointer to a boolean variable
* @note The Boolean datatype differs from the other datatypes
* in that the encoding of a context-tagged Boolean value is not the
* same as the encoding of an application-tagged Boolean value.
* This is done so that the application-tagged value may be encoded
* in a single octet, without a contents octet. While this same encoding
* could have been used for the context-tagged case, doing
* so would require that the context be known in order to distinguish
* between a length or a value in the length/value/type field.
* This was considered to be undesirable.
* @return number of bytes decoded, or 0 if errors occur
*/
int bacnet_boolean_context_value_decode(
const uint8_t *apdu, uint32_t apdu_size, bool *boolean_value)
{
int len = 0;
if (apdu && (apdu_size > 0)) {
if (boolean_value) {
if (apdu[0]) {
*boolean_value = true;
} else {
*boolean_value = false;
}
}
len = 1;
}
return len;
}
/**
* @brief Decode the Boolean Value when context encoded
* From clause 20.2.3 Encoding of a Boolean Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @note The Boolean datatype differs from the other datatypes
* in that the encoding of a context-tagged Boolean value is not the
* same as the encoding of an application-tagged Boolean value.
* This is done so that the application-tagged value may be encoded
* in a single octet, without a contents octet. While this same encoding
* could have been used for the context-tagged case, doing
* so would require that the context be known in order to distinguish
* between a length or a value in the length/value/type field.
* This was considered to be undesirable.
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param tag_value - context tag number expected
* @param boolean_value - decoded Boolean Value, if decoded
*
* @return number of bytes decoded, zero if tag mismatch,
* or #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_boolean_context_decode(
const uint8_t *apdu,
uint32_t apdu_size,
uint8_t tag_value,
bool *boolean_value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.context && (tag.number == tag_value)) {
apdu_len = len;
len = bacnet_boolean_context_value_decode(
&apdu[apdu_len], apdu_size - apdu_len, boolean_value);
if (len > 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Encode a Null value.
* From clause 20.2.2 Encoding of a Null Value
* and 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu Pointer to the encode buffer.
*
* @return returns the number of apdu bytes consumed.
*/
int encode_application_null(uint8_t *apdu)
{
return encode_tag(apdu, BACNET_APPLICATION_TAG_NULL, false, 0);
}
/**
* @brief Encode a Null value in a tag context.
* From clause 20.2.2 Encoding of a Null Value
* and 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu Pointer to the encode buffer.
* @param tag_number Tag number in which context
* the value shall be encoded.
*
* @return returns the number of apdu bytes consumed.
*/
int encode_context_null(uint8_t *apdu, uint8_t tag_number)
{
return encode_tag(apdu, tag_number, true, 0);
}
/**
* @brief Decode the NULL value when application encoded
* From clause 20.2.2 Encoding of a Null Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be decoded
* @param apdu_size - number of bytes in the buffer
*
* @return number of bytes decoded, zero if tag mismatch,
* or #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_null_application_decode(const uint8_t *apdu, uint32_t apdu_size)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.application && (tag.number == BACNET_APPLICATION_TAG_NULL)) {
apdu_len = len;
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Reverse the bits of the given byte.
*
* @param in_byte Byte to reverse.
*
* @return Byte with reversed bit order.
*/
static uint8_t byte_reverse_bits(uint8_t in_byte)
{
uint8_t out_byte = 0;
if (in_byte & BIT(0)) {
out_byte |= BIT(7);
}
if (in_byte & BIT(1)) {
out_byte |= BIT(6);
}
if (in_byte & BIT(2)) {
out_byte |= BIT(5);
}
if (in_byte & BIT(3)) {
out_byte |= BIT(4);
}
if (in_byte & BIT(4)) {
out_byte |= BIT(3);
}
if (in_byte & BIT(5)) {
out_byte |= BIT(2);
}
if (in_byte & BIT(6)) {
out_byte |= BIT(1);
}
if (in_byte & BIT(7)) {
out_byte |= BIT(0);
}
return out_byte;
}
/**
* @brief Decode a bit string value.
* (From clause 20.2.10 Encoding of a Bit String Value.)
*
* @param apdu Pointer to the buffer holding the message data.
* @param len_value Length of the Data to decode.
* @param bit_string Pointer to the bit string variable,
* taking the decoded result.
*
* @return number of bytes decoded, or zero if errors occur
* @deprecated Use bacnet_bitstring_decode() instead.
*/
int decode_bitstring(
const uint8_t *apdu, uint32_t len_value, BACNET_BIT_STRING *bit_string)
{
int len = 0; /* Return value */
uint8_t unused_bits;
uint32_t i;
uint32_t bytes_used;
if (apdu && bit_string) {
/* Init/empty the string. */
bitstring_init(bit_string);
if (len_value) {
/* The first octet contains the unused bits. */
bytes_used = len_value - 1;
if (bytes_used <= MAX_BITSTRING_BYTES) {
len = 1;
/* Copy the bytes in reversed bit order. */
for (i = 0; i < bytes_used; i++) {
bitstring_set_octet(
bit_string, (uint8_t)i, byte_reverse_bits(apdu[len++]));
}
/* Erase the remaining unused bits. */
unused_bits = (uint8_t)(apdu[0] & 0x07);
bitstring_set_bits_used(
bit_string, (uint8_t)bytes_used, unused_bits);
}
}
}
return len;
}
/**
* @brief Decodes from bytes into a BACnet bit string value.
* From clause 20.2.10 Encoding of a Bit String Value.
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param len_value - number of bytes in the unsigned value encoding
* @param value - value to decode into, or NULL for length checking
* @return number of bytes decoded, or zero if errors occur
*/
int bacnet_bitstring_decode(
const uint8_t *apdu,
uint32_t apdu_size,
uint32_t len_value,
BACNET_BIT_STRING *value)
{
int len = 0;
uint8_t unused_bits;
uint32_t i;
uint32_t bytes_used;
/* check to see if the APDU is long enough */
if (apdu && (len_value <= apdu_size)) {
/* Init/empty the string. */
bitstring_init(value);
if (len_value > 0) {
/* The first octet must contain the unused bits. */
bytes_used = len_value - 1;
if (bytes_used <= MAX_BITSTRING_BYTES) {
len = 1;
/* Copy the bytes in reversed bit order. */
for (i = 0; i < bytes_used; i++) {
bitstring_set_octet(
value, (uint8_t)i, byte_reverse_bits(apdu[len]));
len++;
}
/* Erase the remaining unused bits. */
unused_bits = (uint8_t)(apdu[0] & 0x07);
bitstring_set_bits_used(
value, (uint8_t)bytes_used, unused_bits);
}
}
}
return len;
}
/**
* @brief Encode an application tagged BACnet bit string value.
* From clause 20.2.10 Encoding of a Bit String Value.
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the data to be encoded, or NULL for length
* @param apdu_size - number of bytes in the buffer
* @param value - value to encode.
*
* @return returns the number of apdu bytes consumed,
* or 0 if apdu_size is too small to fit the data
*/
int bacnet_bitstring_application_encode(
uint8_t *apdu, uint32_t apdu_size, const BACNET_BIT_STRING *value)
{
int apdu_len = 0; /* total length of the apdu, return value */
apdu_len = encode_application_bitstring(NULL, value);
if (apdu_len > apdu_size) {
apdu_len = 0;
} else {
apdu_len = encode_application_bitstring(apdu, value);
}
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet bit string value.
* From clause 20.2.10 Encoding of a Bit String Value.
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be decoded
* @param apdu_size - number of bytes in the buffer
* @param value - decoded value, if decoded
*
* @return number of bytes decoded, zero if tag mismatch,
* or #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_bitstring_application_decode(
const uint8_t *apdu, uint32_t apdu_size, BACNET_BIT_STRING *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.application &&
(tag.number == BACNET_APPLICATION_TAG_BIT_STRING)) {
apdu_len = len;
len = bacnet_bitstring_decode(
&apdu[apdu_len], apdu_size - apdu_len, tag.len_value_type,
value);
if (len > 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet bit string value.
* From clause 20.2.10 Encoding of a Bit String Value.
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param tag_value - context tag number expected
* @param value - decoded value, if decoded
*
* @return number of bytes decoded, or zero if tag mismatch, or
* #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_bitstring_context_decode(
const uint8_t *apdu,
uint32_t apdu_size,
uint8_t tag_value,
BACNET_BIT_STRING *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.context && (tag.number == tag_value)) {
apdu_len = len;
len = bacnet_bitstring_decode(
&apdu[apdu_len], apdu_size - apdu_len, tag.len_value_type,
value);
if (len > 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Decode a bit string value in the given context.
* (From clause 20.2.10 Encoding of a Bit String Value.)
*
* @param apdu Pointer to the buffer holding the message data.
* @param tag_number Tag number (context).
* @param bit_string Pointer to the bit string variable,
* taking the decoded result.
*
* @return number of bytes decoded or #BACNET_STATUS_ERROR (-1)
* if wrong tag number or malformed
* @deprecated Use bacnet_bitstring_context_decode() instead.
*/
int decode_context_bitstring(
const uint8_t *apdu, uint8_t tag_number, BACNET_BIT_STRING *bit_string)
{
uint32_t len_value;
int len = 0;
if (decode_is_context_tag(&apdu[len], tag_number) &&
!decode_is_closing_tag(&apdu[len])) {
len += decode_tag_number_and_value(&apdu[len], &tag_number, &len_value);
len += decode_bitstring(&apdu[len], len_value, bit_string);
} else {
len = BACNET_STATUS_ERROR;
}
return len;
}
/**
* @brief Encode the BACnet Bit String Value
* as defined in 20.2.10 Encoding of a Bit String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be encoded, or NULL for length
* @param bit_string - #BACNET_BIT_STRING value
*
* @return the number of apdu bytes encoded
*/
int encode_bitstring(uint8_t *apdu, const BACNET_BIT_STRING *bit_string)
{
int len = 0;
uint8_t remaining_used_bits = 0;
uint8_t used_bytes = 0;
uint8_t i = 0;
/* if the bit string is empty, then the first octet shall be zero */
if (bitstring_bits_used(bit_string) == 0) {
if (apdu) {
apdu[len] = 0;
}
len++;
} else {
used_bytes = bitstring_bytes_used(bit_string);
remaining_used_bits =
(uint8_t)(bitstring_bits_used(bit_string) - ((used_bytes - 1) * 8));
/* number of unused bits in the subsequent final octet */
if (apdu) {
apdu[len] = (uint8_t)(8 - remaining_used_bits);
}
len++;
for (i = 0; i < used_bytes; i++) {
if (apdu) {
apdu[len] = byte_reverse_bits(bitstring_octet(bit_string, i));
}
len++;
}
}
return len;
}
/**
* @brief Encode the BACnet Bit String Value as Application Tagged
* as defined in 20.2.10 Encoding of a Bit String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be encoded, or NULL for length
* @param value - #BACNET_BIT_STRING value to be encoded
*
* @return the number of apdu bytes encoded
*/
int encode_application_bitstring(uint8_t *apdu, const BACNET_BIT_STRING *value)
{
int apdu_len = 0;
int len = 0;
uint32_t bit_string_encoded_length = 1; /* 1 for the bits remaining octet */
/* bit string may use more than 1 octet for the tag, so find out how many */
bit_string_encoded_length += bitstring_bytes_used(value);
len = encode_tag(
apdu, BACNET_APPLICATION_TAG_BIT_STRING, false,
bit_string_encoded_length);
apdu_len += len;
if (apdu) {
apdu += len;
}
len = encode_bitstring(apdu, value);
apdu_len += len;
return apdu_len;
}
/**
* @brief Encode the BACnet Bit String Value as Context Tagged
* as defined in 20.2.10 Encoding of a Bit String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be encoded, or NULL for length
* @param tag_number Tag number to be used
* @param value - #BACNET_BIT_STRING value to be encoded
*
* @return the number of apdu bytes encoded
*/
int encode_context_bitstring(
uint8_t *apdu, uint8_t tag_number, const BACNET_BIT_STRING *value)
{
int apdu_len = 0;
int len = 0;
uint32_t bit_string_encoded_length = 1; /* 1 for the bits remaining octet */
/* bit string may use more than 1 octet for the tag, so find out how many */
bit_string_encoded_length += bitstring_bytes_used(value);
len = encode_tag(apdu, tag_number, true, bit_string_encoded_length);
apdu_len += len;
if (apdu) {
apdu += len;
}
len = encode_bitstring(apdu, value);
apdu_len += len;
return apdu_len;
}
/**
* @brief Decode the BACnet Object Identifier Value
* as defined in clause 20.2.14 Encoding of an Object Identifier Value
*
* @param apdu - buffer of data to be decoded
* @param len_value_type - the expected length of the Object Identifier
* @param object_type - decoded object type, if decoded
* @param object_instance - decoded object instance, if decoded
*
* @return the number of apdu bytes consumed
*/
int decode_object_id_safe(
const uint8_t *apdu,
uint32_t len_value_type,
BACNET_OBJECT_TYPE *object_type,
uint32_t *instance)
{
uint32_t value = 0;
int len = 0;
len = decode_unsigned32(apdu, &value);
if (len_value_type == len) {
if (apdu) {
/* value is meaningless if apdu was NULL */
if (object_type) {
*object_type = (BACNET_OBJECT_TYPE)((
(value >> BACNET_INSTANCE_BITS) & BACNET_MAX_OBJECT));
}
if (instance) {
*instance = (value & BACNET_MAX_INSTANCE);
}
}
}
return len;
}
/**
* @brief Decode the BACnet Object Identifier Value
* as defined in clause 20.2.14 Encoding of an Object Identifier Value
*
* @param apdu - buffer of data to be decoded
* @param len_value_type - the expected length of the Object Identifier
* @param object_type - decoded object type, if decoded
* @param object_instance - decoded object instance, if decoded
*
* @return the number of apdu bytes consumed
*/
int decode_object_id(
const uint8_t *apdu, BACNET_OBJECT_TYPE *object_type, uint32_t *instance)
{
const uint32_t len_value = 4;
return decode_object_id_safe(apdu, len_value, object_type, instance);
}
/**
* @brief Decode the BACnet Object Identifier Value
* as defined in clause 20.2.14 Encoding of an Object Identifier Value
*
* @param apdu - buffer of data to be decoded
* @param apdu_size - number of bytes in the buffer
* @param object_type - decoded object type, if decoded
* @param instance - decoded object instance, if decoded
*
* @return the number of apdu bytes consumed, or 0 if apdu is too small
*/
int bacnet_object_id_decode(
const uint8_t *apdu,
uint32_t apdu_size,
uint32_t len_value_type,
BACNET_OBJECT_TYPE *object_type,
uint32_t *instance)
{
int len = 0;
len = decode_object_id_safe(NULL, len_value_type, object_type, instance);
if (len <= apdu_size) {
return decode_object_id_safe(
apdu, len_value_type, object_type, instance);
}
return 0;
}
/**
* @brief Encode an application tagged BACnet object identifier value.
* From clause 20.2.14 Encoding of an Object Identifier Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the data to be encoded, or NULL for length
* @param apdu_size - number of bytes in the buffer
* @param value - value to encode
*
* @return returns the number of apdu bytes consumed,
* or 0 if apdu_size is too small to fit the data
*/
int bacnet_object_id_application_encode(
uint8_t *apdu,
uint32_t apdu_size,
BACNET_OBJECT_TYPE object_type,
uint32_t object_instance)
{
int apdu_len = 0; /* total length of the apdu, return value */
apdu_len = encode_application_object_id(NULL, object_type, object_instance);
if (apdu_len > apdu_size) {
apdu_len = 0;
} else {
apdu_len =
encode_application_object_id(apdu, object_type, object_instance);
}
return apdu_len;
}
/**
* @brief Decode the BACnet Object Identifier Value when application encoded
* as defined in clause 20.2.14 Encoding of an Object Identifier Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be decoded
* @param apdu_size - number of bytes in the buffer
* @param object_type - decoded object type, if decoded
* @param object_instance - decoded object instance, if decoded
*
* @return number of bytes decoded, zero if tag mismatch,
* or #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_object_id_application_decode(
const uint8_t *apdu,
uint32_t apdu_size,
BACNET_OBJECT_TYPE *object_type,
uint32_t *object_instance)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.application &&
(tag.number == BACNET_APPLICATION_TAG_OBJECT_ID)) {
apdu_len = len;
len = bacnet_object_id_decode(
&apdu[apdu_len], apdu_size - apdu_len, tag.len_value_type,
object_type, object_instance);
if (len > 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Decode the BACnet Object Identifier Value when context encoded
* as defined in clause 20.2.14 Encoding of an Object Identifier Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param tag_value - context tag number expected
* @param object_type - decoded object type, if decoded
* @param object_instance - decoded object instance, if decoded
*
* @return number of bytes decoded, zero if tag mismatch,
* or #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_object_id_context_decode(
const uint8_t *apdu,
uint32_t apdu_size,
uint8_t tag_value,
BACNET_OBJECT_TYPE *object_type,
uint32_t *object_instance)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.context && (tag.number == tag_value)) {
apdu_len = len;
len = bacnet_object_id_decode(
&apdu[apdu_len], apdu_size - apdu_len, tag.len_value_type,
object_type, object_instance);
if (len > 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Compare two object identifiers for equality.
* @param value1 - first object identifier
* @param value2 - second object identifier
* @return true if the object identifiers are the same, false otherwise
*/
bool bacnet_object_id_same(
BACNET_OBJECT_TYPE object_type1,
uint32_t instance1,
BACNET_OBJECT_TYPE object_type2,
uint32_t instance2)
{
bool status = false;
if ((object_type1 == object_type2) && (instance1 == instance2)) {
status = true;
}
return status;
}
/**
* @brief Decode the BACnet Object Identifier Value when context encoded
* as defined in clause 20.2.14 Encoding of an Object Identifier Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param tag_number - context tag number expected
* @param object_type - decoded object type, if decoded
* @param object_instance - decoded object instance, if decoded
*
* @return number of bytes decoded or #BACNET_STATUS_ERROR (-1)
* if wrong tag number or malformed
* @deprecated Use bacnet_object_id_context_decode() instead
*/
int decode_context_object_id(
const uint8_t *apdu,
uint8_t tag_number,
BACNET_OBJECT_TYPE *object_type,
uint32_t *instance)
{
int len = 0;
if (decode_is_context_tag_with_length(&apdu[len], tag_number, &len)) {
len += decode_object_id(&apdu[len], object_type, instance);
} else {
len = BACNET_STATUS_ERROR;
}
return len;
}
/**
* @brief Encode the BACnet Object Identifier Value
* as defined in clause 20.2.14 Encoding of an Object Identifier Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be encoded, or NULL for length
* @param object_type - object type to be encoded
* @param object_instance - object instance to be encoded
*
* @return the number of apdu bytes encoded
*/
int encode_bacnet_object_id(
uint8_t *apdu, BACNET_OBJECT_TYPE object_type, uint32_t instance)
{
uint32_t value = 0;
int len;
value =
(((uint32_t)object_type & BACNET_MAX_OBJECT) << BACNET_INSTANCE_BITS) |
(instance & BACNET_MAX_INSTANCE);
len = encode_unsigned32(apdu, value);
return len;
}
/**
* @brief Encode the BACnet Object Identifier Value as Context Tagged
* as defined in clause 20.2.14 Encoding of an Object Identifier Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be encoded, or NULL for length
* @param tag_number - context tag number to be encoded
* @param object_type - object type to be encoded
* @param object_instance - object instance to be encoded
*
* @return the number of apdu bytes encoded
*/
int encode_context_object_id(
uint8_t *apdu,
uint8_t tag_number,
BACNET_OBJECT_TYPE object_type,
uint32_t instance)
{
int apdu_len = 0;
int len;
/* length of object id is 4 octets, as per 20.2.14 */
len = encode_tag(apdu, tag_number, true, 4);
apdu_len += len;
if (apdu) {
apdu += len;
}
len = encode_bacnet_object_id(apdu, object_type, instance);
apdu_len += len;
return apdu_len;
}
/**
* @brief Encode the BACnet Object Identifier Value as Application Tagged
* as defined in clause 20.2.14 Encoding of an Object Identifier Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be encoded, or NULL for length
* @param object_type - object type to be encoded
* @param object_instance - object instance to be encoded
*
* @return the number of apdu bytes encoded
*/
int encode_application_object_id(
uint8_t *apdu, BACNET_OBJECT_TYPE object_type, uint32_t instance)
{
int apdu_len = 0;
int len, tag_len;
/* get the length by using NULL APDU */
tag_len = encode_bacnet_object_id(NULL, object_type, instance);
len = encode_tag(
apdu, BACNET_APPLICATION_TAG_OBJECT_ID, false, (uint32_t)tag_len);
apdu_len += len;
if (apdu) {
apdu += len;
}
len = encode_bacnet_object_id(apdu, object_type, instance);
apdu_len += len;
return apdu_len;
}
#if BACNET_USE_OCTETSTRING
/**
* @brief Encode the BACnet Octet String value
* from clause 20.2.8 Encoding of an Octet String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param value - the value decoded, or NULL for length
*
* @return returns the number of apdu bytes consumed
*/
int encode_octet_string(uint8_t *apdu, const BACNET_OCTET_STRING *octet_string)
{
int len = 0; /* return value */
const uint8_t *value;
int i = 0; /* loop counter */
if (octet_string) {
len = (int)octetstring_length(octet_string);
value = octetstring_value((BACNET_OCTET_STRING *)octet_string);
if (value && apdu) {
for (i = 0; i < len; i++) {
apdu[i] = value[i];
}
}
}
return len;
}
/**
* @brief Encode the BACnet Octet String value as application tagged
* from clause 20.2.8 Encoding of an Octet String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param value - the value decoded, or NULL for length
*
* @return returns the number of apdu bytes consumed
*/
int encode_application_octet_string(
uint8_t *apdu, const BACNET_OCTET_STRING *value)
{
int len = 0;
if (value) {
len = encode_tag(
apdu, BACNET_APPLICATION_TAG_OCTET_STRING, false,
octetstring_length(value));
if (apdu) {
apdu += len;
}
len += encode_octet_string(apdu, value);
}
return len;
}
/**
* @brief Encode the BACnet Octet String Value as context tagged
* from clause 20.2.8 Encoding of an Octet String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes, or NULL for length
* @param tag_number - context tag number to be encoded
* @param value - the value to be encoded
*
* @return returns the number of apdu bytes consumed
*/
int encode_context_octet_string(
uint8_t *apdu, uint8_t tag_number, const BACNET_OCTET_STRING *value)
{
int len = 0;
if (value) {
len = encode_tag(apdu, tag_number, true, octetstring_length(value));
if (apdu) {
apdu += len;
}
len += encode_octet_string(apdu, value);
}
return len;
}
/**
* @brief Decode the BACnet Octet String Value
* from clause 20.2.8 Encoding of an Octet String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param len_value - number of bytes in the unsigned value encoding, may be
* zero
* @param value - the value decoded, or NULL for length
*
* @return number of bytes decoded (0..N), or BACNET_STATUS_ERROR on error
*/
int bacnet_octet_string_decode(
const uint8_t *apdu,
uint32_t apdu_size,
uint32_t len_value,
BACNET_OCTET_STRING *value)
{
int len = BACNET_STATUS_ERROR;
if (len_value <= apdu_size) {
if (len_value > 0) {
(void)octetstring_init(value, &apdu[0], len_value);
} else {
(void)octetstring_init(value, NULL, 0);
}
len = (int)len_value;
}
return len;
}
/**
* @brief Decode the BACnet Octet String Value
* from clause 20.2.8 Encoding of an Octet String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param len_value - number of bytes in the encoding, may be zero
* @param value - the unsigned value decoded, or NULL for length
*
* @return number of bytes decoded (0..N), or BACNET_STATUS_ERROR on error
* @deprecated use bacnet_octet_string_decode() instead
*/
int decode_octet_string(
const uint8_t *apdu, uint32_t len_value, BACNET_OCTET_STRING *value)
{
const uint16_t apdu_len_max = MAX_APDU;
return bacnet_octet_string_decode(apdu, apdu_len_max, len_value, value);
}
/**
* @brief Decodes from bytes into a BACnet Octet String context encoding
* from clause 20.2.8 Encoding of an Octet String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be decoded
* @param tag_number - context tag number expected
* @param value - decoded value, if decoded, or NULL for length
*
* @return number of bytes decoded or #BACNET_STATUS_ERROR (-1)
* if wrong tag number or malformed
* @deprecated use bacnet_octet_string_context_decode() instead
*/
int decode_context_octet_string(
const uint8_t *apdu, uint8_t tag_number, BACNET_OCTET_STRING *octet_string)
{
int len = 0; /* return value */
bool status = false;
uint32_t len_value = 0;
if (decode_is_context_tag(&apdu[len], tag_number) &&
!decode_is_closing_tag(&apdu[len])) {
len += decode_tag_number_and_value(&apdu[len], &tag_number, &len_value);
if (len_value > 0) {
status = octetstring_init(octet_string, &apdu[len], len_value);
} else {
status = octetstring_init(octet_string, NULL, 0);
}
if (status) {
len += len_value;
}
} else {
len = BACNET_STATUS_ERROR;
}
return len;
}
/**
* @brief Encode an application tagged BACnet Octet String Value
* From clause 20.2.8 Encoding of an Octet String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the data to be encoded, or NULL for length
* @param apdu_size - number of bytes in the buffer
* @param value - value to encode
*
* @return returns the number of apdu bytes consumed,
* or 0 if apdu_size is too small to fit the data
*/
int bacnet_octet_string_application_encode(
uint8_t *apdu, uint32_t apdu_size, const BACNET_OCTET_STRING *value)
{
int apdu_len = 0; /* total length of the apdu, return value */
apdu_len = encode_application_octet_string(NULL, value);
if (apdu_len > apdu_size) {
apdu_len = 0;
} else {
apdu_len = encode_application_octet_string(apdu, value);
}
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet Octet String application encoding
* from clause 20.2.8 Encoding of an Octet String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be decoded
* @param apdu_size - number of bytes in the buffer
* @param value - decoded value, if decoded, or NULL for length
*
* @return number of bytes decoded, zero if tag mismatch,
* or #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_octet_string_application_decode(
const uint8_t *apdu, uint32_t apdu_size, BACNET_OCTET_STRING *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.application &&
(tag.number == BACNET_APPLICATION_TAG_OCTET_STRING)) {
apdu_len = len;
len = bacnet_octet_string_decode(
&apdu[len], apdu_size - apdu_len, tag.len_value_type, value);
if (len >= 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet Octet String application encoding
* from clause 20.2.8 Encoding of an Octet String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param tag_value - context tag number expected
* @param value - the value decoded, or NULL for length
*
* @return number of bytes decoded, or zero if tag mismatch, or
* #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_octet_string_context_decode(
const uint8_t *apdu,
uint32_t apdu_size,
uint8_t tag_value,
BACNET_OCTET_STRING *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.context && (tag.number == tag_value)) {
apdu_len = len;
len = bacnet_octet_string_decode(
&apdu[apdu_len], apdu_size - apdu_len, tag.len_value_type,
value);
if (len >= 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
#endif
/**
* @brief Encode the BACnet Character String Value
* from 20.2.9 Encoding of a Character String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param max_apdu - size of the buffer to hold the bytes
* @param encoding - BACnet Character String encoding value
* @param value - the value to be encoded
* @param length - the size of the value to be encoded
*
* @return returns the number of apdu bytes consumed, or 0 if too large
* @deprecated use encode_bacnet_character_string() instead
*/
uint32_t encode_bacnet_character_string_safe(
uint8_t *apdu,
uint32_t max_apdu,
uint8_t encoding,
const char *value,
uint32_t length)
{
uint32_t apdu_len = 1 /*encoding */;
uint32_t i;
apdu_len += length;
if (apdu_len <= max_apdu) {
if (apdu) {
apdu[0] = encoding;
for (i = 0; i < length; i++) {
apdu[1 + i] = (uint8_t)value[i];
}
}
} else {
apdu_len = 0;
}
return apdu_len;
}
/**
* @brief Encode the BACnet Character String Value
* from 20.2.9 Encoding of a Character String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes, or NULL for length
* @param char_string - the BACnet Character String to be encoded
*
* @return returns the number of apdu bytes consumed
*/
int encode_bacnet_character_string(
uint8_t *apdu, const BACNET_CHARACTER_STRING *char_string)
{
uint32_t apdu_len = 1 /*encoding */;
uint32_t i;
size_t length;
const char *value;
length = characterstring_length(char_string);
if (apdu) {
apdu[0] = characterstring_encoding(char_string);
value = characterstring_value(char_string);
for (i = 0; i < length; i++) {
apdu[1 + i] = (uint8_t)value[i];
}
}
apdu_len += length;
return apdu_len;
}
/**
* @brief Encode the BACnet Character String Value as application tagged
* from 20.2.9 Encoding of a Character String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes, or NULL for length
* @param char_string - the BACnet Character String to be encoded
*
* @return returns the number of apdu bytes consumed
*/
int encode_application_character_string(
uint8_t *apdu, const BACNET_CHARACTER_STRING *char_string)
{
int apdu_len = 0;
int len, tag_len;
tag_len = encode_bacnet_character_string(NULL, char_string);
len = encode_tag(
apdu, BACNET_APPLICATION_TAG_CHARACTER_STRING, false,
(uint32_t)tag_len);
apdu_len += len;
if (apdu) {
apdu += len;
}
len = encode_bacnet_character_string(apdu, char_string);
apdu_len += len;
return apdu_len;
}
/**
* @brief Encode the BACnet Character String Value as context tagged
* from 20.2.9 Encoding of a Character String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes, or NULL for length
* @param tag_number - context tag number to encode
* @param char_string - the BACnet Character String to be encoded
*
* @return returns the number of apdu bytes consumed
*/
int encode_context_character_string(
uint8_t *apdu,
uint8_t tag_number,
const BACNET_CHARACTER_STRING *char_string)
{
int apdu_len = 0;
int len, tag_len;
tag_len = encode_bacnet_character_string(NULL, char_string);
len = encode_tag(apdu, tag_number, true, (uint32_t)tag_len);
apdu_len += len;
if (apdu) {
apdu += len;
}
len = encode_bacnet_character_string(apdu, char_string);
apdu_len += len;
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet Character String value
* from clause 20.2.9 Encoding of a Character String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param len_value - number of bytes in the unsigned value encoding
* @param value - the value decoded, if decoded
*
* @return number of bytes decoded, or zero if errors occur
*/
int bacnet_character_string_decode(
const uint8_t *apdu,
uint32_t apdu_size,
uint32_t len_value,
BACNET_CHARACTER_STRING *char_string)
{
const char *string_value = NULL;
int len = 0;
uint8_t encoding;
/* check to see if the APDU is long enough */
if (len_value <= apdu_size) {
if (len_value > 0) {
encoding = apdu[0];
if (len_value > 1) {
string_value = (const char *)&apdu[1];
(void)characterstring_init(
char_string, encoding, string_value, len_value - 1);
} else {
(void)characterstring_init(char_string, encoding, NULL, 0);
}
len = (int)len_value;
}
}
return len;
}
/**
* @brief Decodes from bytes into a BACnet Character String value
* from clause 20.2.9 Encoding of a Character String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param len_value - number of bytes in the unsigned value encoding
* @param value - the character string value decoded
*
* @return number of bytes decoded, or zero if errors occur
* @deprecated use bacnet_character_string_decode() instead
*/
int decode_character_string(
const uint8_t *apdu, uint32_t len_value, BACNET_CHARACTER_STRING *value)
{
const uint32_t apdu_size = MAX_APDU;
return bacnet_character_string_decode(apdu, apdu_size, len_value, value);
}
/**
* @brief Encode an application tagged BACnet Character String value
* From clause 20.2.9 Encoding of a Character String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the data to be encoded, or NULL for length
* @param apdu_size - number of bytes in the buffer
* @param value - value to encode
*
* @return returns the number of apdu bytes consumed,
* or 0 if apdu_size is too small to fit the data
*/
int bacnet_character_string_application_encode(
uint8_t *apdu, uint32_t apdu_size, const BACNET_CHARACTER_STRING *value)
{
int apdu_len = 0; /* total length of the apdu, return value */
apdu_len = encode_application_character_string(NULL, value);
if (apdu_len > apdu_size) {
apdu_len = 0;
} else {
apdu_len = encode_application_character_string(apdu, value);
}
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet Character String value
* from clause 20.2.9 Encoding of a Character String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be decoded
* @param apdu_size - number of bytes in the buffer
* @param value - decoded value, if decoded
*
* @return number of bytes decoded, zero if tag mismatch,
* or #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_character_string_application_decode(
const uint8_t *apdu, uint32_t apdu_size, BACNET_CHARACTER_STRING *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.application &&
(tag.number == BACNET_APPLICATION_TAG_CHARACTER_STRING)) {
apdu_len = len;
len = bacnet_character_string_decode(
&apdu[len], apdu_size - apdu_len, tag.len_value_type, value);
if (len > 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet Character String value
* from clause 20.2.9 Encoding of a Character String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param tag_value - context tag number expected
* @param value - the value decoded, if decoded
*
* @return number of bytes decoded, or zero if tag mismatch, or
* #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_character_string_context_decode(
const uint8_t *apdu,
uint32_t apdu_size,
uint8_t tag_value,
BACNET_CHARACTER_STRING *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.context && (tag.number == tag_value)) {
apdu_len = len;
len = bacnet_character_string_decode(
&apdu[apdu_len], apdu_size - apdu_len, tag.len_value_type,
value);
if (len > 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet Character String value
* from clause 20.2.9 Encoding of a Character String Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param tag_value - context tag number expected
* @param value - the character string value decoded
*
* @return number of bytes decoded or #BACNET_STATUS_ERROR (-1)
* if wrong tag number or malformed
* @deprecated use bacnet_character_string_context_decode() instead
*/
int decode_context_character_string(
const uint8_t *apdu, uint8_t tag_value, BACNET_CHARACTER_STRING *value)
{
int len = 0; /* return value */
const uint32_t apdu_size = MAX_APDU;
len = bacnet_character_string_context_decode(
apdu, apdu_size, tag_value, value);
if (len <= 0) {
len = BACNET_STATUS_ERROR;
}
return len;
}
/**
* @brief Decodes from bytes into a BACnet Unsigned value
* from clause 20.2.4 Encoding of an Unsigned Integer Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param len_value - number of bytes in the unsigned value encoding
* @param value - the value decoded, if decoded
*
* @return number of bytes decoded, or zero if errors occur
*/
int bacnet_unsigned_decode(
const uint8_t *apdu,
uint32_t apdu_size,
uint32_t len_value,
BACNET_UNSIGNED_INTEGER *value)
{
int len = 0;
uint16_t unsigned16_value = 0;
uint32_t unsigned32_value = 0;
#ifdef UINT64_MAX
uint64_t unsigned64_value = 0;
#endif
if (len_value <= apdu_size) {
switch (len_value) {
case 1:
if (value) {
*value = apdu[0];
}
len = 1;
break;
case 2:
if (value) {
decode_unsigned16(&apdu[0], &unsigned16_value);
*value = unsigned16_value;
}
len = 2;
break;
case 3:
if (value) {
decode_unsigned24(&apdu[0], &unsigned32_value);
*value = unsigned32_value;
}
len = 3;
break;
case 4:
if (value) {
decode_unsigned32(&apdu[0], &unsigned32_value);
*value = unsigned32_value;
}
len = 4;
break;
#ifdef UINT64_MAX
case 5:
if (value) {
decode_unsigned40(&apdu[0], &unsigned64_value);
*value = unsigned64_value;
}
len = 5;
break;
case 6:
if (value) {
decode_unsigned48(&apdu[0], &unsigned64_value);
*value = unsigned64_value;
}
len = 6;
break;
case 7:
if (value) {
decode_unsigned56(&apdu[0], &unsigned64_value);
*value = unsigned64_value;
}
len = 7;
break;
case 8:
if (value) {
decode_unsigned64(&apdu[0], &unsigned64_value);
*value = unsigned64_value;
}
len = 8;
break;
#endif
default:
if (value) {
*value = 0;
}
break;
}
}
return len;
}
/**
* @brief Decodes from bytes into a BACnet Unsigned value
* from clause 20.2.4 Encoding of an Unsigned Integer Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param tag_value - context tag number expected
* @param value - the value decoded, if decoded
*
* @return number of bytes decoded, zero if tag mismatch,
* or #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_unsigned_context_decode(
const uint8_t *apdu,
uint32_t apdu_size,
uint8_t tag_value,
BACNET_UNSIGNED_INTEGER *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.context && (tag.number == tag_value)) {
apdu_len = len;
len = bacnet_unsigned_decode(
&apdu[apdu_len], apdu_size - apdu_len, tag.len_value_type,
value);
if (len > 0) {
apdu_len += len;
} else {
return BACNET_STATUS_ERROR;
}
} else {
/* mismatched tag number */
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Encode an application tagged BACnet Unsigned value
* From clause 20.2.4 Encoding of an Unsigned Integer Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the data to be encoded, or NULL for length
* @param apdu_size - number of bytes in the buffer
* @param value - value to encode
*
* @return returns the number of apdu bytes consumed,
* or 0 if apdu_size is too small to fit the data
*/
int bacnet_unsigned_application_encode(
uint8_t *apdu, uint32_t apdu_size, BACNET_UNSIGNED_INTEGER value)
{
int apdu_len = 0; /* total length of the apdu, return value */
apdu_len = encode_application_unsigned(NULL, value);
if (apdu_len > apdu_size) {
apdu_len = 0;
} else {
apdu_len = encode_application_unsigned(apdu, value);
}
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet Unsigned value
* from clause 20.2.4 Encoding of an Unsigned Integer Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be decoded
* @param apdu_size - number of bytes in the buffer
* @param value - decoded value, if decoded
*
* @return number of bytes decoded, zero if tag mismatch,
* or #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_unsigned_application_decode(
const uint8_t *apdu, uint32_t apdu_size, BACNET_UNSIGNED_INTEGER *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.application &&
(tag.number == BACNET_APPLICATION_TAG_UNSIGNED_INT)) {
apdu_len = len;
len = bacnet_unsigned_decode(
&apdu[apdu_len], apdu_size - apdu_len, tag.len_value_type,
value);
if (len > 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet Unsigned value
* from clause 20.2.4 Encoding of an Unsigned Integer Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param len_value - number of bytes in the unsigned value encoding
* @param value - the unsigned value decoded
*
* @return number of bytes decoded, or zero if errors occur
* @deprecated use bacnet_unsigned_decode() instead
*/
int decode_unsigned(
const uint8_t *apdu, uint32_t len_value, BACNET_UNSIGNED_INTEGER *value)
{
#ifdef UINT64_MAX
const uint32_t apdu_size = 8;
#else
const uint32_t apdu_size = 4;
#endif
return bacnet_unsigned_decode(apdu, apdu_size, len_value, value);
}
/**
* @brief Decodes from bytes into a BACnet Unsigned value
* from clause 20.2.4 Encoding of an Unsigned Integer Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param tag_value - context tag number expected
* @param value - the unsigned value decoded
*
* @return number of bytes decoded or #BACNET_STATUS_ERROR (-1)
* if wrong tag number or malformed
* @deprecated use bacnet_unsigned_context_decode() instead
*/
int decode_context_unsigned(
const uint8_t *apdu, uint8_t tag_value, BACNET_UNSIGNED_INTEGER *value)
{
int len = 0; /* return value */
#ifdef UINT64_MAX
const uint32_t apdu_size = 3 + 8;
#else
const uint32_t apdu_size = 2 + 4;
#endif
len = bacnet_unsigned_context_decode(apdu, apdu_size, tag_value, value);
if (len <= 0) {
len = BACNET_STATUS_ERROR;
}
return len;
}
/**
* @brief Encode the BACnet Unsigned value
* as defined in clause 20.2.4 Encoding of an Unsigned Integer Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be encoded, or NULL for length
* @param value - value to be encoded
*
* @return the number of apdu bytes encoded
*/
int encode_bacnet_unsigned(uint8_t *apdu, BACNET_UNSIGNED_INTEGER value)
{
int len = 0; /* return value */
len = bacnet_unsigned_length(value);
if (apdu) {
if (len == 1) {
apdu[0] = (uint8_t)value;
} else if (len == 2) {
(void)encode_unsigned16(&apdu[0], (uint16_t)value);
} else if (len == 3) {
(void)encode_unsigned24(&apdu[0], (uint32_t)value);
} else if (len == 4) {
(void)encode_unsigned32(&apdu[0], (uint32_t)value);
#ifdef UINT64_MAX
} else if (len == 5) {
(void)encode_unsigned40(&apdu[0], value);
} else if (len == 6) {
(void)encode_unsigned48(&apdu[0], value);
} else if (len == 7) {
(void)encode_unsigned56(&apdu[0], value);
} else if (len == 8) {
(void)encode_unsigned64(&apdu[0], value);
#endif
}
}
return len;
}
/**
* @brief Encode the BACnet Unsigned value as Context Tagged
* as defined in clause 20.2.4 Encoding of an Unsigned Integer Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be encoded, or NULL for length
* @param tag_number - context tag number to be encoded
* @param value - value to be encoded
*
* @return the number of apdu bytes encoded
*/
int encode_context_unsigned(
uint8_t *apdu, uint8_t tag_number, BACNET_UNSIGNED_INTEGER value)
{
int apdu_len = 0;
int len, tag_len;
/* length of unsigned is variable, as per 20.2.4 */
tag_len = bacnet_unsigned_length(value);
len = encode_tag(apdu, tag_number, true, (uint32_t)tag_len);
apdu_len += len;
if (apdu) {
apdu += len;
}
len = encode_bacnet_unsigned(apdu, value);
apdu_len += len;
return apdu_len;
}
/**
* @brief Encode the BACnet Unsigned value as Application Tagged
* as defined in clause 20.2.4 Encoding of an Unsigned Integer Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be encoded, or NULL for length
* @param value - value to be encoded
*
* @return the number of apdu bytes encoded
*/
int encode_application_unsigned(uint8_t *apdu, BACNET_UNSIGNED_INTEGER value)
{
int apdu_len = 0;
int len, tag_len;
tag_len = bacnet_unsigned_length(value);
len = encode_tag(
apdu, BACNET_APPLICATION_TAG_UNSIGNED_INT, false, (uint32_t)tag_len);
apdu_len += len;
if (apdu) {
apdu += len;
}
len = encode_bacnet_unsigned(apdu, value);
apdu_len += len;
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet Enumerated value
* from clause 20.2.11 Encoding of an Enumerated Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param len_value - number of bytes in the unsigned value encoding
* @param value - the enumerated value decoded, or NULL for length
*
* @return number of bytes decoded, or zero if errors occur
*/
int bacnet_enumerated_decode(
const uint8_t *apdu,
uint32_t apdu_size,
uint32_t len_value,
uint32_t *value)
{
BACNET_UNSIGNED_INTEGER unsigned_value = 0;
int len;
len = bacnet_unsigned_decode(apdu, apdu_size, len_value, &unsigned_value);
if (len > 0) {
if (value) {
*value = unsigned_value;
}
}
return len;
}
/**
* @brief Decodes from bytes into a BACnet Enumerated value
* from clause 20.2.11 Encoding of an Enumerated Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param len_value - number of bytes in the unsigned value encoding
* @param value - the enumerated value decoded
*
* @return number of bytes decoded, or zero if errors occur
*/
int decode_enumerated(const uint8_t *apdu, uint32_t len_value, uint32_t *value)
{
const uint32_t apdu_size = 4;
return bacnet_enumerated_decode(apdu, apdu_size, len_value, value);
}
/**
* @brief Encode an application tagged BACnet Enumerated value
* From clause 20.2.11 Encoding of an Enumerated Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the data to be encoded, or NULL for length
* @param apdu_size - number of bytes in the buffer
* @param value - bit string value to encode
*
* @return returns the number of apdu bytes consumed,
* or 0 if apdu_size is too small to fit the data
*/
int bacnet_enumerated_application_encode(
uint8_t *apdu, uint32_t apdu_size, uint32_t value)
{
int apdu_len = 0; /* total length of the apdu, return value */
apdu_len = encode_application_enumerated(NULL, value);
if (apdu_len > apdu_size) {
apdu_len = 0;
} else {
apdu_len = encode_application_enumerated(apdu, value);
}
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet Enumerated value
* from clause 20.2.11 Encoding of an Enumerated Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be decoded
* @param apdu_size - number of bytes in the buffer
* @param value - decoded value, if decoded
*
* @return number of bytes decoded, zero if tag mismatch,
* or #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_enumerated_application_decode(
const uint8_t *apdu, uint32_t apdu_size, uint32_t *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_UNSIGNED_INTEGER unsigned_value = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.application &&
(tag.number == BACNET_APPLICATION_TAG_ENUMERATED)) {
apdu_len = len;
/* note: enumerated is encoded as UNSIGNED INT */
len = bacnet_unsigned_decode(
&apdu[apdu_len], apdu_size - apdu_len, tag.len_value_type,
&unsigned_value);
if (len > 0) {
if (unsigned_value > UINT32_MAX) {
apdu_len = BACNET_STATUS_ERROR;
} else {
if (value) {
*value = unsigned_value;
}
apdu_len += len;
}
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet Enumerated value
* from clause 20.2.11 Encoding of an Enumerated Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param tag_value - context tag number expected
* @param value - the enumerated value decoded
*
* @return number of bytes decoded, or zero if tag mismatch, or
* #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_enumerated_context_decode(
const uint8_t *apdu, uint32_t apdu_size, uint8_t tag_value, uint32_t *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.context && (tag.number == tag_value)) {
apdu_len = len;
len = bacnet_enumerated_decode(
&apdu[apdu_len], apdu_size - apdu_len, tag.len_value_type,
value);
if (len > 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet Enumerated value
* from clause 20.2.11 Encoding of an Enumerated Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param tag_value - context tag number expected
* @param value - the enumerated value decoded
*
* @return number of bytes decoded or #BACNET_STATUS_ERROR (-1)
* if wrong tag number or malformed
* @deprecated use bacnet_enumerated_context_decode() instead
*/
int decode_context_enumerated(
const uint8_t *apdu, uint8_t tag_value, uint32_t *value)
{
const uint32_t apdu_size = 6;
int len = 0;
len = bacnet_enumerated_context_decode(apdu, apdu_size, tag_value, value);
if (len <= 0) {
len = BACNET_STATUS_ERROR;
}
return len;
}
/**
* @brief Encode the BACnet Enumerated Value
* as defined in clause 20.2.11 Encoding of an Enumerated Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be encoded, or NULL for length
* @param value - value to be encoded
*
* @return the number of apdu bytes encoded
*/
int encode_bacnet_enumerated(uint8_t *apdu, uint32_t value)
{
return encode_bacnet_unsigned(apdu, value);
}
/**
* @brief Encode the BACnet Enumerated Value as Application Tagged
* as defined in clause 20.2.11 Encoding of an Enumerated Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be encoded, or NULL for length
* @param value - value to be encoded
*
* @return the number of apdu bytes encoded
*/
int encode_application_enumerated(uint8_t *apdu, uint32_t value)
{
int apdu_len = 0;
int len, tag_len;
tag_len = bacnet_unsigned_length(value);
len = encode_tag(
apdu, BACNET_APPLICATION_TAG_ENUMERATED, false, (uint32_t)tag_len);
apdu_len += len;
if (apdu) {
apdu += len;
}
len = encode_bacnet_enumerated(apdu, value);
apdu_len += len;
return apdu_len;
}
/**
* @brief Encode the BACnet Enumerated Value as Context Tagged
* as defined in clause 20.2.11 Encoding of an Enumerated Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be encoded, or NULL for length
* @param tag_number - context tag number to be encoded
* @param value - value to be encoded
*
* @return the number of apdu bytes encoded
*/
int encode_context_enumerated(uint8_t *apdu, uint8_t tag_number, uint32_t value)
{
int apdu_len = 0;
int len, tag_len;
tag_len = bacnet_unsigned_length(value);
len = encode_tag(apdu, tag_number, true, (uint32_t)tag_len);
apdu_len = len;
if (apdu) {
apdu += len;
}
len = encode_bacnet_enumerated(apdu, value);
apdu_len += len;
return apdu_len;
}
#if BACNET_USE_SIGNED
/**
* @brief Decode the BACnet Signed Integer Value when application encoded
* as defined in clause 20.2.5 Encoding of a Signed Integer Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param len_value - number of bytes in the unsigned value encoding
* @param value - the signed value decoded, or NULL for length
*
* @return number of bytes decoded, or zero if errors occur
*/
int bacnet_signed_decode(
const uint8_t *apdu, uint32_t apdu_size, uint32_t len_value, int32_t *value)
{
int len = 0;
if (apdu && (len_value <= apdu_size)) {
switch (len_value) {
case 1:
len = decode_signed8(&apdu[0], value);
break;
case 2:
len = decode_signed16(&apdu[0], value);
break;
case 3:
len = decode_signed24(&apdu[0], value);
break;
case 4:
len = decode_signed32(&apdu[0], value);
break;
default:
if (value) {
*value = 0;
}
break;
}
}
return len;
}
/**
* @brief Decodes from bytes into a BACnet Signed Integer
* as defined in clause 20.2.5 Encoding of a Signed Integer Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param tag_value - context tag number expected
* @param value - the signed value decoded
*
* @return number of bytes decoded, zero if tag mismatch,
* or error (-1) if malformed
*/
int bacnet_signed_context_decode(
const uint8_t *apdu, uint32_t apdu_size, uint8_t tag_value, int32_t *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.context && (tag.number == tag_value)) {
apdu_len = len;
len = bacnet_signed_decode(
&apdu[apdu_len], apdu_size - apdu_len, tag.len_value_type,
value);
if (len > 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Encode an application tagged BACnet Signed Integer Value
* From clause 20.2.5 Encoding of a Signed Integer Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the data to be encoded, or NULL for length
* @param apdu_size - number of bytes in the buffer
* @param value - value to encode
*
* @return returns the number of apdu bytes consumed,
* or 0 if apdu_size is too small to fit the data
*/
int bacnet_signed_application_encode(
uint8_t *apdu, uint32_t apdu_size, int32_t value)
{
int apdu_len = 0; /* total length of the apdu, return value */
apdu_len = encode_application_signed(NULL, value);
if (apdu_len > apdu_size) {
apdu_len = 0;
} else {
apdu_len = encode_application_signed(apdu, value);
}
return apdu_len;
}
/**
* @brief Decode the BACnet Signed Integer Value when application encoded
* as defined in clause 20.2.5 Encoding of a Signed Integer Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be decoded
* @param apdu_size - number of bytes in the buffer
* @param value - decoded value, if decoded
*
* @return number of bytes decoded, zero if tag mismatch,
* or #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_signed_application_decode(
const uint8_t *apdu, uint32_t apdu_size, int32_t *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.application &&
(tag.number == BACNET_APPLICATION_TAG_SIGNED_INT)) {
apdu_len = len;
len = bacnet_signed_decode(
&apdu[apdu_len], apdu_size - apdu_len, tag.len_value_type,
value);
if (len > 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet Signed Integer
* from clause 20.2.5 Encoding of an Signed Integer Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer holding the bytes
* @param len_value - number of bytes in the unsigned value encoding
* @param value - the signed value decoded
*
* @return number of bytes decoded, #BACNET_STATUS_ERROR (-1) if
* wrong tag number, or error (-1) if malformed
* @deprecated use bacnet_signed_decode() instead
*/
int decode_signed(const uint8_t *apdu, uint32_t len_value, int32_t *value)
{
const unsigned apdu_size = 4;
return bacnet_signed_decode(apdu, apdu_size, len_value, value);
}
/**
* @brief Decodes from bytes into a BACnet Signed Integer
* from clause 20.2.5 Encoding of an Signed Integer Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer holding the bytes
* @param tag_value - context tag number expected
* @param value - the signed value decoded
*
* @return number of bytes decoded, #BACNET_STATUS_ERROR (-1) if
* wrong tag number, or error (-1) if malformed
* @deprecated use bacnet_signed_context_decode() instead
*/
int decode_context_signed(
const uint8_t *apdu, uint8_t tag_value, int32_t *value)
{
const uint32_t apdu_size = 6;
int len = 0;
len = bacnet_signed_context_decode(apdu, apdu_size, tag_value, value);
if (len <= 0) {
len = BACNET_STATUS_ERROR;
}
return len;
}
/**
* @brief Decodes from bytes into a BACnet Signed Integer
* from clause 20.2.5 Encoding of an Signed Integer Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer holding the bytes, or NULL for length
* @param value - the signed value decoded
*
* @return number of bytes encoded
*/
/* */
int encode_bacnet_signed(uint8_t *apdu, int32_t value)
{
int len = 0; /* return value */
len = bacnet_signed_length(value);
if (apdu) {
if (len == 1) {
(void)encode_signed8(&apdu[0], (int8_t)value);
} else if (len == 2) {
(void)encode_signed16(&apdu[0], (int16_t)value);
} else if (len == 3) {
(void)encode_signed24(&apdu[0], value);
} else {
(void)encode_signed32(&apdu[0], value);
}
}
return len;
}
/**
* @brief Encode the BACnet Signed Integer as Application Tagged
* as defined in clause 20.2.5 Encoding of a Signed Integer Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be encoded, or NULL for length
* @param value - value to be encoded
*
* @return the number of apdu bytes encoded
*/
int encode_application_signed(uint8_t *apdu, int32_t value)
{
int apdu_len = 0;
int len, tag_len;
tag_len = bacnet_signed_length(value);
len = encode_tag(
apdu, BACNET_APPLICATION_TAG_SIGNED_INT, false, (uint32_t)tag_len);
apdu_len += len;
if (apdu) {
apdu += len;
}
len = encode_bacnet_signed(apdu, value);
apdu_len += len;
return apdu_len;
}
/**
* @brief Encode the BACnet Signed Integer as Context Tagged
* as defined in clause 20.2.5 Encoding of a Signed Integer Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be encoded, or NULL for length
* @param tag_number - context tag number to be encoded
* @param value - value to be encoded
*
* @return the number of apdu bytes encoded
*/
int encode_context_signed(uint8_t *apdu, uint8_t tag_number, int32_t value)
{
int apdu_len = 0;
int len, tag_len;
tag_len = bacnet_signed_length(value);
len = encode_tag(apdu, tag_number, true, (uint32_t)tag_len);
apdu_len += len;
if (apdu) {
apdu += len;
}
len = encode_bacnet_signed(apdu, value);
apdu_len += len;
return apdu_len;
}
#endif
/**
* @brief Encode a real floating value. From clause 20.2.6 Encoding of a
* Real Number Value and 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu buffer to be encoded, or NULL for length
* @param value The float value to be encoded.
*
* @return the number of apdu bytes consumed.
*/
int encode_application_real(uint8_t *apdu, float value)
{
int apdu_len = 0;
int len;
/* length of REAL is 4 octets, as per 20.2.6 */
len = encode_tag(apdu, BACNET_APPLICATION_TAG_REAL, false, 4);
apdu_len += len;
if (apdu) {
apdu += len;
}
len = encode_bacnet_real(value, apdu);
apdu_len += len;
return apdu_len;
}
/**
* @brief Encode a real floating value with a given tag. From clause 20.2.6
* Encoding of a Real Number Value and 20.2.1 General Rules for
* Encoding BACnet Tags.
*
* @param apdu Transmit buffer
* @param tag_number Tag number to be used
* @param value The float value to be encoded.
*
* @return Returns the number of apdu bytes consumed.
*/
int encode_context_real(uint8_t *apdu, uint8_t tag_number, float value)
{
int apdu_len = 0;
int len;
/* length of REAL is 4 octets, as per 20.2.6 */
len = encode_tag(apdu, tag_number, true, 4);
apdu_len += len;
if (apdu) {
apdu += len;
}
len = encode_bacnet_real(value, apdu);
apdu_len += len;
return apdu_len;
}
/**
* @brief Decode a single precision floating value.
* From clause 20.2.6 Encoding of a Real Number Value
* and clause 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param len_value - number of bytes in the unsigned value encoding
* @param value - the value decoded, if decoded
*
* @return number of bytes decoded, or zero if errors occur
*/
int bacnet_real_decode(
const uint8_t *apdu, uint32_t apdu_size, uint32_t len_value, float *value)
{
int len = 0;
if (apdu && (apdu_size >= 4) && (len_value == 4)) {
len = decode_real(apdu, value);
}
return len;
}
/**
* @brief Decode a context tagged single precision floating value.
* From clause 20.2.6 Encoding of a Real Number Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param tag_value - context tag number expected
* @param value - the value decoded, if decoded
*
* @return number of bytes decoded, zero if tag mismatch,
* or error (-1) if malformed
*/
int bacnet_real_context_decode(
const uint8_t *apdu, uint32_t apdu_size, uint8_t tag_value, float *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.context && (tag.number == tag_value)) {
apdu_len = len;
len = bacnet_real_decode(
&apdu[apdu_len], apdu_size - apdu_len, tag.len_value_type,
value);
if (len > 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Encode an application tagged BACnet Real Number Value
* From clause 20.2.6 Encoding of a Real Number Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the data to be encoded, or NULL for length
* @param apdu_size - number of bytes in the buffer
* @param value - value to encode
*
* @return returns the number of apdu bytes consumed,
* or 0 if apdu_size is too small to fit the data
*/
int bacnet_real_application_encode(
uint8_t *apdu, uint32_t apdu_size, float value)
{
int apdu_len = 0; /* total length of the apdu, return value */
apdu_len = encode_application_real(NULL, value);
if (apdu_len > apdu_size) {
apdu_len = 0;
} else {
apdu_len = encode_application_real(apdu, value);
}
return apdu_len;
}
/**
* @brief Decode an application tagged single precision floating value
* From clause 20.2.6 Encoding of a Real Number Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be decoded
* @param apdu_size - number of bytes in the buffer
* @param value - decoded value, if decoded
*
* @return number of bytes decoded, zero if tag mismatch,
* or #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_real_application_decode(
const uint8_t *apdu, uint32_t apdu_size, float *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.application && (tag.number == BACNET_APPLICATION_TAG_REAL)) {
apdu_len = len;
len = bacnet_real_decode(
&apdu[apdu_len], apdu_size - apdu_len, tag.len_value_type,
value);
if (len > 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Decode a context tagged single precision floating value.
* From clause 20.2.6 Encoding of a Real Number Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param tag_number - context tag number expected
* @param real_value - the signed value decoded
*
* @return number of bytes decoded or #BACNET_STATUS_ERROR (-1)
* if wrong tag number or malformed
* @deprecated use bacnet_real_context_decode() instead
*/
int decode_context_real(
const uint8_t *apdu, uint8_t tag_number, float *real_value)
{
uint32_t len_value;
int len = 0;
if (decode_is_context_tag(&apdu[len], tag_number)) {
len += decode_tag_number_and_value(&apdu[len], &tag_number, &len_value);
len += decode_real(&apdu[len], real_value);
} else {
len = -1;
}
return len;
}
#if BACNET_USE_DOUBLE
/**
* @brief Encode a Double Precision Real Number Value as Application Tagged
* From clause 20.2.7 Encoding of a Double Precision Real Number Value
* and clause 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu buffer to be encoded, or NULL for length
* @param value The value to be encoded.
*
* @return the number of apdu bytes consumed.
*/
int encode_application_double(uint8_t *apdu, double value)
{
int apdu_len = 0;
int len;
/* length of DOUBLE is 8 octets, as per 20.2.7 */
len = encode_tag(apdu, BACNET_APPLICATION_TAG_DOUBLE, false, 8);
apdu_len += len;
if (apdu) {
apdu += len;
}
len = encode_bacnet_double(value, apdu);
apdu_len += len;
return apdu_len;
}
/**
* @brief Encode a Double Precision Real Number Value as Context Tagged
* From clause 20.2.7 Encoding of a Double Precision Real Number Value
* and clause 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu buffer to be encoded, or NULL for length
* @param tag_number Tag number to be used
* @param value The value to be encoded.
*
* @return the number of apdu bytes consumed.
*/
int encode_context_double(uint8_t *apdu, uint8_t tag_number, double value)
{
int apdu_len = 0;
int len;
/* length of double is 8 octets, as per 20.2.7 */
len = encode_tag(apdu, tag_number, true, 8);
apdu_len += len;
if (apdu) {
apdu += len;
}
len = encode_bacnet_double(value, apdu);
apdu_len += len;
return apdu_len;
}
/**
* @brief Decode a double precision floating value.
* From clause 20.2.7 Encoding of a Double Precision Real Number Value
* and clause 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param len_value - number of bytes in the unsigned value encoding
* @param value - the value decoded
*
* @return number of bytes decoded, or zero if errors occur
*/
int bacnet_double_decode(
const uint8_t *apdu, uint32_t apdu_size, uint32_t len_value, double *value)
{
int len = 0;
if (apdu && (apdu_size >= 8) && (len_value == 8)) {
len = decode_double(apdu, value);
}
return len;
}
/**
* @brief Decode a context tagged double precision floating value.
* From clause 20.2.7 Encoding of a Double Precision Real Number Value
* and clause 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param tag_value - context tag number expected
* @param value - the value decoded
*
* @return number of bytes decoded, zero if tag mismatch,
* or error (-1) if malformed
*/
int bacnet_double_context_decode(
const uint8_t *apdu, uint32_t apdu_size, uint8_t tag_value, double *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.context && (tag.number == tag_value)) {
apdu_len = len;
len = bacnet_double_decode(
&apdu[apdu_len], apdu_size - apdu_len, tag.len_value_type,
value);
if (len > 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Encode an application tagged Double Precision Real Number Value
* From clause 20.2.7 Encoding of a Double Precision Real Number Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the data to be encoded, or NULL for length
* @param apdu_size - number of bytes in the buffer
* @param value - value to encode
*
* @return returns the number of apdu bytes consumed,
* or 0 if apdu_size is too small to fit the data
*/
int bacnet_double_application_encode(
uint8_t *apdu, uint32_t apdu_size, double value)
{
int apdu_len = 0; /* total length of the apdu, return value */
apdu_len = encode_application_double(NULL, value);
if (apdu_len > apdu_size) {
apdu_len = 0;
} else {
apdu_len = encode_application_double(apdu, value);
}
return apdu_len;
}
/**
* @brief Decode an application tagged double precision floating value.
* From clause 20.2.7 Encoding of a Double Precision Real Number Value
* and clause 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu - buffer of data to be decoded
* @param apdu_size - number of bytes in the buffer
* @param value - decoded value, if decoded
*
* @return number of bytes decoded, zero if tag mismatch,
* or #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_double_application_decode(
const uint8_t *apdu, uint32_t apdu_size, double *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.application && (tag.number == BACNET_APPLICATION_TAG_DOUBLE)) {
apdu_len = len;
len = bacnet_double_decode(
&apdu[apdu_len], apdu_size - apdu_len, tag.len_value_type,
value);
if (len > 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Decode a context tagged double precision floating value.
* From clause 20.2.7 Encoding of a Double Precision Real Number Value
* and clause 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu - buffer to hold the bytes
* @param tag_number - context tag number expected
* @param double_value - the signed value decoded
*
* @return number of bytes decoded or #BACNET_STATUS_ERROR (-1)
* if wrong tag number or malformed
* @deprecated use bacnet_double_context_decode() instead
*/
int decode_context_double(
const uint8_t *apdu, uint8_t tag_number, double *double_value)
{
uint32_t len_value;
int len = 0;
if (decode_is_context_tag(&apdu[len], tag_number)) {
len += decode_tag_number_and_value(&apdu[len], &tag_number, &len_value);
len += decode_double(&apdu[len], double_value);
} else {
len = -1;
}
return len;
}
#endif
/**
* @brief Encode a Time Value
* From clause 20.2.13 Encoding of a Time Value
* and clause 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu buffer to be encoded, or NULL for length
* @param value The value to be encoded.
*
* @return the number of apdu bytes consumed.
*/
int encode_bacnet_time(uint8_t *apdu, const BACNET_TIME *btime)
{
if (apdu) {
apdu[0] = btime->hour;
apdu[1] = btime->min;
apdu[2] = btime->sec;
apdu[3] = btime->hundredths;
}
return 4;
}
/**
* @brief Encode a Time Value as Application Tagged
* From clause 20.2.13 Encoding of a Time Value
* and clause 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu buffer to be encoded, or NULL for length
* @param btime The value to be encoded.
*
* @return the number of apdu bytes consumed.
*/
int encode_application_time(uint8_t *apdu, const BACNET_TIME *btime)
{
int apdu_len = 0;
int len;
/* length of Time value is 4 octets, as per 20.2.13 */
len = encode_tag(apdu, BACNET_APPLICATION_TAG_TIME, false, 4);
apdu_len += len;
if (apdu) {
apdu += len;
}
len = encode_bacnet_time(apdu, btime);
apdu_len += len;
return apdu_len;
}
/**
* @brief Encode a Time Value as Context Tagged
* From clause 20.2.13 Encoding of a Time Value
* and clause 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu buffer to be encoded, or NULL for length
* @param tag_number Tag number to be used
* @param btime The value to be encoded.
*
* @return the number of apdu bytes consumed.
*/
int encode_context_time(
uint8_t *apdu, uint8_t tag_number, const BACNET_TIME *btime)
{
int apdu_len = 0;
int len;
/* length of time is 4 octets, as per 20.2.13 */
len = encode_tag(apdu, tag_number, true, 4);
apdu_len += len;
if (apdu) {
apdu += len;
}
len = encode_bacnet_time(apdu, btime);
apdu_len += len;
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet Time Value
* from clause 20.2.13 Encoding of a Time Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param len_value - number of bytes encoded
* @param value - the value decoded, if decoded
*
* @return number of bytes decoded, or zero if errors occur
*/
int bacnet_time_decode(
const uint8_t *apdu,
uint32_t apdu_size,
uint32_t len_value,
BACNET_TIME *value)
{
int len = 0;
if ((apdu_size >= 4) && (len_value == 4)) {
/* length of time is 4 octets, as per 20.2.13 */
if (value) {
value->hour = apdu[0];
value->min = apdu[1];
value->sec = apdu[2];
value->hundredths = apdu[3];
}
len = (int)len_value;
}
return len;
}
/**
* @brief Decodes from bytes into a BACnet Time Value context encoded
* from clause 20.2.13 Encoding of a Time Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param tag_value - context tag number expected
* @param value - the value decoded, if decoded
*
* @return number of bytes decoded, zero if tag mismatch,
* or error (-1) if malformed
*/
int bacnet_time_context_decode(
const uint8_t *apdu,
uint32_t apdu_size,
uint8_t tag_value,
BACNET_TIME *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.context && (tag.number == tag_value)) {
apdu_len = len;
len = bacnet_time_decode(
&apdu[apdu_len], apdu_size - apdu_len, tag.len_value_type,
value);
if (len > 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Encode an application tagged BACnet Time Value
* From clause 20.2.13 Encoding of a Time Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the data to be encoded, or NULL for length
* @param apdu_size - number of bytes in the buffer
* @param value - value to encode
*
* @return returns the number of apdu bytes consumed,
* or 0 if apdu_size is too small to fit the data
*/
int bacnet_time_application_encode(
uint8_t *apdu, uint32_t apdu_size, const BACNET_TIME *value)
{
int apdu_len = 0; /* total length of the apdu, return value */
apdu_len = encode_application_time(NULL, value);
if (apdu_len > apdu_size) {
apdu_len = 0;
} else {
apdu_len = encode_application_time(apdu, value);
}
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet Time Value application encoded
* from clause 20.2.13 Encoding of a Time Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be decoded
* @param apdu_size - number of bytes in the buffer
* @param value - decoded value, if decoded
*
* @return number of bytes decoded, zero if tag mismatch,
* or #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_time_application_decode(
const uint8_t *apdu, uint32_t apdu_size, BACNET_TIME *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.application && (tag.number == BACNET_APPLICATION_TAG_TIME)) {
apdu_len = len;
len = bacnet_time_decode(
&apdu[apdu_len], apdu_size - apdu_len, tag.len_value_type,
value);
if (len > 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet Time Value
* from clause 20.2.13 Encoding of a Time Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param value - the unsigned value decoded
*
* @return number of bytes decoded, or zero if errors occur
* @deprecated use bacnet_time_decode() instead
*/
int decode_bacnet_time(const uint8_t *apdu, BACNET_TIME *value)
{
const uint32_t apdu_size = 4;
const uint32_t len_value = 4;
return bacnet_time_decode(apdu, apdu_size, len_value, value);
}
/**
* @brief Decodes from bytes into a BACnet Time Value
* from clause 20.2.13 Encoding of a Time Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param value - the unsigned value decoded
*
* @return number of bytes decoded, or zero if errors occur
* @deprecated use bacnet_time_decode() instead
*/
int decode_bacnet_time_safe(
const uint8_t *apdu, uint32_t len_value, BACNET_TIME *btime)
{
if (len_value != 4) {
if (btime) {
btime->hour = 0;
btime->hundredths = 0;
btime->min = 0;
btime->sec = 0;
}
return (int)len_value;
} else {
return decode_bacnet_time(apdu, btime);
}
}
/**
* @brief Decodes from bytes into a BACnet Time Value application encoded
* from clause 20.2.13 Encoding of a Time Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be decoded
* @param btime - decoded value, if decoded
*
* @return number of bytes decoded, or #BACNET_STATUS_ERROR (-1) if malformed
* or wrong tag number
* @deprecated use bacnet_time_application_decode() instead
*/
int decode_application_time(const uint8_t *apdu, BACNET_TIME *btime)
{
int len = 0;
uint8_t tag_number;
decode_tag_number(&apdu[len], &tag_number);
if (tag_number == BACNET_APPLICATION_TAG_TIME) {
len++;
len += decode_bacnet_time(&apdu[len], btime);
} else {
len = BACNET_STATUS_ERROR;
}
return len;
}
/**
* @brief Decodes from bytes into a BACnet Time Value context encoded
* from clause 20.2.13 Encoding of a Time Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param tag_number - context tag number expected
* @param btime - the unsigned value decoded
*
* @return number of bytes decoded or #BACNET_STATUS_ERROR (-1)
* if wrong tag number or malformed
* @deprecated use bacnet_time_context_decode() instead
*/
int decode_context_bacnet_time(
const uint8_t *apdu, uint8_t tag_number, BACNET_TIME *btime)
{
int len = 0;
if (decode_is_context_tag_with_length(&apdu[len], tag_number, &len)) {
len += decode_bacnet_time(&apdu[len], btime);
} else {
len = BACNET_STATUS_ERROR;
}
return len;
}
/**
* @brief Encode a Date value
* From clause 20.2.12 Encoding of a Date Value
* and clause 20.2.1 General Rules for Encoding BACnet Tags.
*
* BACnet Date
* year = years since 1900, wildcard=1900+255
* month 1=Jan
* day = day of month
* wday 1=Monday...7=Sunday
*
* @param apdu buffer to be encoded, or NULL for length
* @param value The value to be encoded.
*
* @return the number of apdu bytes consumed
*/
int encode_bacnet_date(uint8_t *apdu, const BACNET_DATE *bdate)
{
if (apdu) {
if (bdate->year >= 1900) {
/* normal encoding, including wildcard */
apdu[0] = (uint8_t)(bdate->year - 1900);
} else if (bdate->year < 0x100) {
/* allow 2 digit years */
apdu[0] = (uint8_t)bdate->year;
} else {
apdu[0] = 0xFF;
}
apdu[1] = bdate->month;
apdu[2] = bdate->day;
apdu[3] = bdate->wday;
}
return 4;
}
/**
* @brief Encode a Date Value as Application Tagged
* From clause 20.2.12 Encoding of a Date Value
* and clause 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu buffer to be encoded, or NULL for length
* @param bdate The value to be encoded.
*
* @return the number of apdu bytes consumed.
*/
int encode_application_date(uint8_t *apdu, const BACNET_DATE *bdate)
{
int apdu_len = 0;
int len = 0;
/* length of Date value is 4 octets, as per 20.2.12 */
len = encode_tag(apdu, BACNET_APPLICATION_TAG_DATE, false, 4);
apdu_len += len;
if (apdu) {
apdu += len;
}
len = encode_bacnet_date(apdu, bdate);
apdu_len += len;
return apdu_len;
}
/**
* @brief Encode a Date Value as Context Tagged
* From clause 20.2.12 Encoding of a Date Value
* and clause 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu buffer to be encoded, or NULL for length
* @param tag_number Tag number to be used
* @param bdate The value to be encoded.
*
* @return the number of apdu bytes consumed.
*/
int encode_context_date(
uint8_t *apdu, uint8_t tag_number, const BACNET_DATE *bdate)
{
int apdu_len = 0;
int len = 0; /* return value */
/* length of date is 4 octets, as per 20.2.12 */
len = encode_tag(apdu, tag_number, true, 4);
apdu_len += len;
if (apdu) {
apdu += len;
}
len = encode_bacnet_date(apdu, bdate);
apdu_len += len;
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet Date Value
* From clause 20.2.12 Encoding of a Date Value
* and clause 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu - buffer to hold the bytes
* @param bdate - the value after decode
*
* @return number of bytes decoded, or zero if errors occur
* @deprecated use bacnet_date_decode() instead
*/
int decode_date(const uint8_t *apdu, BACNET_DATE *bdate)
{
bdate->year = (uint16_t)apdu[0] + 1900;
bdate->month = apdu[1];
bdate->day = apdu[2];
bdate->wday = apdu[3];
return 4;
}
/**
* @brief Decodes from bytes into a BACnet Date Value
* From clause 20.2.12 Encoding of a Date Value
* and clause 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu - buffer to hold the bytes
* @param len_value - number of bytes encoded
* @param bdate - the decoded value
*
* @return number of bytes decoded, or zero if errors occur
* @deprecated use bacnet_date_decode() instead
*/
int decode_date_safe(
const uint8_t *apdu, uint32_t len_value, BACNET_DATE *bdate)
{
if (len_value != 4) {
bdate->day = 0;
bdate->month = 0;
bdate->wday = 0;
bdate->year = 0;
return (int)len_value;
} else {
return decode_date(apdu, bdate);
}
}
/**
* @brief Decodes from bytes into a BACnet Date Value
* From clause 20.2.12 Encoding of a Date Value
* and clause 20.2.1 General Rules for Encoding BACnet Tags.
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param len_value - number of bytes encoded
* @param value - the unsigned value decoded
*
* @return number of bytes decoded, or zero if errors occur
*/
int bacnet_date_decode(
const uint8_t *apdu,
uint32_t apdu_size,
uint32_t len_value,
BACNET_DATE *value)
{
int len = 0;
if ((apdu_size >= 4) && (len_value == 4)) {
/* length of date is 4 octets, as per 20.2.12 */
if (value) {
value->year = (uint16_t)apdu[0] + 1900;
value->month = apdu[1];
value->day = apdu[2];
value->wday = apdu[3];
}
len = (int)len_value;
}
return len;
}
/**
* @brief Decodes from bytes into a BACnet Date Value context encoded
* From clause 20.2.12 Encoding of a Date Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param tag_value - context tag number expected
* @param value - the value decoded, if decoded
*
* @return number of bytes decoded, zero if tag mismatch,
* or error (-1) if malformed
*/
int bacnet_date_context_decode(
const uint8_t *apdu,
uint32_t apdu_size,
uint8_t tag_value,
BACNET_DATE *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.context && (tag.number == tag_value)) {
apdu_len = len;
len = bacnet_date_decode(
&apdu[apdu_len], apdu_size - apdu_len, tag.len_value_type,
value);
if (len > 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Encode an application tagged BACnet Date Value
* From clause 20.2.12 Encoding of a Date Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the data to be encoded, or NULL for length
* @param apdu_size - number of bytes in the buffer
* @param value - value to encode
*
* @return returns the number of apdu bytes consumed,
* or 0 if apdu_size is too small to fit the data
*/
int bacnet_date_application_encode(
uint8_t *apdu, uint32_t apdu_size, const BACNET_DATE *value)
{
int apdu_len = 0; /* total length of the apdu, return value */
apdu_len = encode_application_date(NULL, value);
if (apdu_len > apdu_size) {
apdu_len = 0;
} else {
apdu_len = encode_application_date(apdu, value);
}
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet Date Value application encoded
* From clause 20.2.12 Encoding of a Date Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be decoded
* @param apdu_size - number of bytes in the buffer
* @param value - decoded value, if decoded
*
* @return number of bytes decoded, zero if tag mismatch,
* or #BACNET_STATUS_ERROR (-1) if malformed
*/
int bacnet_date_application_decode(
const uint8_t *apdu, uint32_t apdu_size, BACNET_DATE *value)
{
int apdu_len = BACNET_STATUS_ERROR;
int len = 0;
BACNET_TAG tag = { 0 };
if (apdu_size == 0) {
return 0;
}
len = bacnet_tag_decode(apdu, apdu_size, &tag);
if (len > 0) {
if (tag.application && (tag.number == BACNET_APPLICATION_TAG_DATE)) {
apdu_len = len;
len = bacnet_date_decode(
&apdu[len], apdu_size - apdu_len, tag.len_value_type, value);
if (len > 0) {
apdu_len += len;
} else {
apdu_len = BACNET_STATUS_ERROR;
}
} else {
apdu_len = 0;
}
}
return apdu_len;
}
/**
* @brief Decodes from bytes into a BACnet Date Value application encoded
* From clause 20.2.12 Encoding of a Date Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer of data to be decoded
* @param value - decoded value, if decoded
*
* @return number of bytes decoded, or #BACNET_STATUS_ERROR (-1) if malformed
* or wrong tag number
* @deprecated use bacnet_date_application_decode() instead
*/
int decode_application_date(const uint8_t *apdu, BACNET_DATE *value)
{
int len = 0;
const uint32_t apdu_size = BACNET_TAG_SIZE + 4;
len = bacnet_date_application_decode(apdu, apdu_size, value);
if (len <= 0) {
len = BACNET_STATUS_ERROR;
}
return len;
}
/**
* @brief Decodes from bytes into a BACnet Date Value context encoded
* From clause 20.2.12 Encoding of a Date Value
* and 20.2.1 General Rules for Encoding BACnet Tags
*
* @param apdu - buffer to hold the bytes
* @param apdu_size - number of bytes in the buffer to decode
* @param tag_value - context tag number expected
* @param value - the unsigned value decoded
*
* @return number of bytes decoded or #BACNET_STATUS_ERROR (-1)
* if wrong tag number or malformed
* @deprecated use bacnet_date_context_decode() instead
*/
int decode_context_date(
const uint8_t *apdu, uint8_t tag_value, BACNET_DATE *value)
{
int len = 0;
const uint32_t apdu_size = BACNET_TAG_SIZE + 4;
len = bacnet_date_context_decode(apdu, apdu_size, tag_value, value);
if (len <= 0) {
len = BACNET_STATUS_ERROR;
}
return len;
}
/**
* Encode a simple ACK and returns the number of apdu bytes consumed.
*
* @param apdu - buffer to hold encoded data, or NULL for length
* @param invoke_id ID invoked
* @param service_choice Service being acked
*
* @return number of apdu bytes consumed
*/
int encode_simple_ack(uint8_t *apdu, uint8_t invoke_id, uint8_t service_choice)
{
if (apdu) {
apdu[0] = PDU_TYPE_SIMPLE_ACK;
apdu[1] = invoke_id;
apdu[2] = service_choice;
}
return 3;
}
/**
* @brief Encode a BACnetARRAY property value
* @param object_instance [in] BACnet network port object instance number
* @param array_index [in] array index requested:
* 0 for the array size
* 1 to n for individual array members
* BACNET_ARRAY_ALL for the full array to be read.
* @param encoder [in] function to encode one property array element
* @param array_size [in] number of elements in the array
* @param apdu [out] Buffer in which the APDU contents are built.
* @param max_apdu [in] Max length of the APDU buffer.
* @return The length of the apdu encoded or
* BACNET_STATUS_ERROR for an invalid array index
* BACNET_STATUS_ABORT for abort message.
*/
int bacnet_array_encode(
uint32_t object_instance,
BACNET_ARRAY_INDEX array_index,
bacnet_array_property_element_encode_function encoder,
BACNET_UNSIGNED_INTEGER array_size,
uint8_t *apdu,
int max_apdu)
{
int apdu_len = 0, len = 0;
BACNET_ARRAY_INDEX index;
if (array_index == 0) {
/* Array element zero is the number of objects in the list */
len = encode_application_unsigned(NULL, array_size);
if (len > max_apdu) {
apdu_len = BACNET_STATUS_ABORT;
} else {
len = encode_application_unsigned(apdu, array_size);
apdu_len = len;
}
} else if (array_index == BACNET_ARRAY_ALL) {
/* if no index was specified, then try to encode the entire list */
/* into one packet. */
for (index = 0; index < array_size; index++) {
len += encoder(object_instance, index, NULL);
}
if (len > max_apdu) {
/* encoded size is larger than APDU size */
apdu_len = BACNET_STATUS_ABORT;
} else {
for (index = 0; index < array_size; index++) {
len = encoder(object_instance, index, apdu);
if (apdu) {
apdu += len;
}
apdu_len += len;
}
}
} else if (array_index <= array_size) {
/* index was specified; encode a single array element */
index = array_index - 1;
len = encoder(object_instance, index, NULL);
if (len > max_apdu) {
apdu_len = BACNET_STATUS_ABORT;
} else {
len = encoder(object_instance, index, apdu);
apdu_len = len;
}
} else {
/* array_index was specified out of range */
apdu_len = BACNET_STATUS_ERROR;
}
return apdu_len;
}
/**
* @brief Decode a BACnetARRAY property value and call a function for each
* element
* @param object_instance [in] BACnet network port object instance number
* @param array_index [in] array index to be decoded
* 0 for the array size
* 1 to n for individual array members
* BACNET_ARRAY_ALL for the full array to be read.
* @param decode_function [in] function to decode one property array element and
* determine the length
* @param write_function [in] function to write one property array element with
* the encoded value
* @param array_size [in] number of elements in the array
* @param apdu [out] Buffer in which the APDU contents are built.
* @param max_apdu [in] Max length of the APDU buffer.
* @return BACNET_ERROR_CODE value
*/
BACNET_ERROR_CODE bacnet_array_write(
uint32_t object_instance,
BACNET_ARRAY_INDEX array_index,
bacnet_array_property_element_decode_function decode_function,
bacnet_array_property_element_write_function write_function,
BACNET_UNSIGNED_INTEGER array_size,
uint8_t *apdu,
size_t apdu_size)
{
int len = 0;
BACNET_ERROR_CODE error_code = ERROR_CODE_SUCCESS;
size_t apdu_len;
BACNET_ARRAY_INDEX index;
BACNET_UNSIGNED_INTEGER unsigned_value;
if (array_index == 0) {
/* Array element zero is the number of objects in the list */
len = bacnet_unsigned_application_decode(
apdu, apdu_size, &unsigned_value);
if (len > 0) {
error_code =
write_function(object_instance, array_index, apdu, apdu_size);
} else if (len == 0) {
error_code = ERROR_CODE_INVALID_DATA_TYPE;
} else {
error_code = ERROR_CODE_ABORT_OTHER;
}
} else if (array_index == BACNET_ARRAY_ALL) {
/* verify decoding of all elements */
apdu_len = 0;
for (index = 1; index <= array_size; index++) {
len = decode_function(
object_instance, &apdu[apdu_len], apdu_size - apdu_len);
if (len > 0) {
apdu_len += len;
} else {
error_code = ERROR_CODE_VALUE_OUT_OF_RANGE;
break;
}
}
if (error_code == ERROR_CODE_SUCCESS) {
/* write each element */
apdu_len = 0;
for (index = 1; index <= array_size; index++) {
len = decode_function(
object_instance, &apdu[apdu_len], apdu_size - apdu_len);
error_code = write_function(
object_instance, index, &apdu[apdu_len], len);
if (error_code != ERROR_CODE_SUCCESS) {
break;
}
apdu_len += len;
}
}
} else if (array_index <= array_size) {
/* index was specified; write a single array element */
error_code =
write_function(object_instance, array_index, apdu, apdu_size);
} else {
/* array_index was specified out of range */
error_code = ERROR_CODE_INVALID_ARRAY_INDEX;
}
return error_code;
}
Reference in New Issue View Git Blame Copy Permalink