uid.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2020 ETC Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************
 * This file is a part of RDM. For more information, go to:
 * https://github.com/ETCLabs/RDM
 *****************************************************************************/
 
#ifndef RDM_UID_H_
#define RDM_UID_H_
 
#include <stdbool.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct RdmUid
{
  uint16_t manu; 
  uint32_t id;   
} RdmUid;
 
/*************************** UID Comparison Macros ***************************/
 
#define RDM_UID_EQUAL(uidptr1, uidptr2) ((uidptr1)->manu == (uidptr2)->manu && (uidptr1)->id == (uidptr2)->id)
 
/************************* UID Initialization Macros *************************/
 
#define RDM_INIT_STATIC_UID(uidptr, manu_val, id_val) \
  do                                                  \
  {                                                   \
    (uidptr)->manu = (manu_val);                      \
    (uidptr)->id = (id_val);                          \
  } while (0)
 
#define RDMNET_INIT_DYNAMIC_UID_REQUEST(uidptr, manu_val) \
  do                                                      \
  {                                                       \
    (uidptr)->manu = (0x8000u | (manu_val));              \
    (uidptr)->id = 0;                                     \
  } while (0)
 
#define RDMNET_INIT_DEVICE_MANU_BROADCAST(uidptr, manu_val)                       \
  do                                                                              \
  {                                                                               \
    (uidptr)->manu = kRdmnetDeviceBroadcastUid.manu;                              \
    (uidptr)->id = (kRdmnetDeviceBroadcastUid.id & ((manu_val << 16) | 0xffffu)); \
  } while (0)
 
/**************************** UID Broadcast Macros ***************************/
 
#define RDM_UID_IS_BROADCAST(uidptr) ((uidptr)->manu == kRdmBroadcastUid.manu && (uidptr)->id == kRdmBroadcastUid.id)
 
#define RDMNET_UID_IS_CONTROLLER_BROADCAST(uidptr) \
  ((uidptr)->manu == kRdmnetControllerBroadcastUid.manu && (uidptr)->id == kRdmnetControllerBroadcastUid.id)
 
#define RDMNET_UID_IS_DEVICE_BROADCAST(uidptr) \
  ((uidptr)->manu == kRdmnetDeviceBroadcastUid.manu && (uidptr)->id == kRdmnetDeviceBroadcastUid.id)
 
#define RDMNET_UID_IS_DEVICE_MANU_BROADCAST(uidptr) \
  ((uidptr)->manu == kRdmnetDeviceBroadcastUid.manu && (((uidptr)->id & 0xffffu) == 0xffffu))
 
#define RDMNET_DEVICE_BROADCAST_MANU_MATCHES(uidptr, manu_val) (RDMNET_DEVICE_BROADCAST_MANU_ID(uidptr) == manu_val)
 
#define RDMNET_DEVICE_BROADCAST_MANU_ID(uidptr) ((uint16_t)((uidptr)->id >> 16))
 
/******************************* UID Inspection ******************************/
 
#define RDM_UID_IS_NULL(uidptr) ((uidptr)->manu == 0 && (uidptr)->id == 0)
 
#define RDMNET_UID_IS_DYNAMIC_UID_REQUEST(uidptr) ((((uidptr)->manu & 0x8000u) != 0) && (uidptr)->id == 0u)
 
#define RDMNET_UID_IS_DYNAMIC(uidptr)                                                  \
  ((((uidptr)->manu & 0x8000u) != 0) && !RDMNET_UID_IS_CONTROLLER_BROADCAST(uidptr) && \
   !RDMNET_UID_IS_DEVICE_MANU_BROADCAST(uidptr) && !RDM_UID_IS_BROADCAST(uidptr) &&    \
   !RDMNET_UID_IS_DYNAMIC_UID_REQUEST(uidptr))
 
#define RDMNET_UID_IS_STATIC(uidptr) (!RDM_UID_IS_NULL(uidptr) && ((uidptr)->manu & 0x8000u) == 0)
 
#define RDM_GET_MANUFACTURER_ID(uidptr) ((uidptr)->manu & 0x7fffu)
 
#define RDM_GET_DEVICE_ID(uidptr) ((uidptr)->id)
 
extern const RdmUid kRdmBroadcastUid;
 
extern const RdmUid kRdmnetControllerBroadcastUid;
 
extern const RdmUid kRdmnetDeviceBroadcastUid;
 
#define RDM_UID_STRING_BYTES 14
 
int  rdm_uid_compare(const RdmUid* a, const RdmUid* b);
bool rdm_uid_to_string(const RdmUid* uid, char* buf);
bool rdm_string_to_uid(const char* str, RdmUid* uid);
 
#ifdef __cplusplus
}
#endif
 
#ifdef __cplusplus
/* C++ utilities */
 
/* Comparison operators for UIDs */
 
constexpr bool operator==(const RdmUid& a, const RdmUid& b) noexcept
{
  return ((a.manu == b.manu && a.id == b.id));
}
 
constexpr bool operator!=(const RdmUid& a, const RdmUid& b) noexcept
{
  return !(a == b);
}
 
constexpr bool operator<(const RdmUid& a, const RdmUid& b) noexcept
{
  return ((a.manu == b.manu) ? (a.id < b.id) : (a.manu < b.manu));
}
 
constexpr bool operator>(const RdmUid& a, const RdmUid& b) noexcept
{
  return b < a;
}
 
constexpr bool operator<=(const RdmUid& a, const RdmUid& b) noexcept
{
  return !(b < a);
}
 
constexpr bool operator>=(const RdmUid& a, const RdmUid& b) noexcept
{
  return !(a < b);
}
 
#endif /* __cplusplus */
#endif /* RDM_UID_H_ */