lwpa_uid.h

/******************************************************************************
 * Copyright 2018 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 lwpa. For more information, go to:
 * https://github.com/ETCLabs/lwpa
 ******************************************************************************/
 
/* lwpa_uid.h: A type and helper functions for the Unique ID (UID) used in the
 * RDM family of protocols. */
#ifndef _LWPA_UID_H_
#define _LWPA_UID_H_
 
#include "lwpa_int.h"
 
typedef struct LwpaUid
{
  uint16_t manu;
  uint32_t id;
} LwpaUid;
 
/*************************** UID Comparison Macros ***************************/
 
#define uid_cmp(uidptr1, uidptr2)                                                   \
  (((uidptr1)->manu == (uidptr2)->manu) ? ((int)(uidptr1)->id - (int)(uidptr2)->id) \
                                        : ((int)(uidptr1)->manu - (int)(uidptr2)->manu))
 
#define uid_equal(uidptr1, uidptr2) ((uidptr1)->manu == (uidptr2)->manu && (uidptr1)->id == (uidptr2)->id)
 
/************************* UID Initialization Macros *************************/
 
#define init_static_uid(uidptr, manu_val, id_val) \
  do                                              \
  {                                               \
    (uidptr)->manu = (manu_val);                  \
    (uidptr)->id = (id_val);                      \
  } while (0)
 
#define init_dynamic_uid(uidptr, manu_val, id_val) \
  do                                               \
  {                                                \
    (uidptr)->manu = (0x8000u | (manu_val));       \
    (uidptr)->id = (id_val);                       \
  } while (0)
 
/**************************** UID Broadcast Macros ***************************/
 
#define uid_is_broadcast(uidptr) ((uidptr)->manu == kBroadcastUid.manu && (uidptr)->id == kBroadcastUid.id)
 
#define uid_is_rdmnet_controller_broadcast(uidptr) \
  ((uidptr)->manu == kRdmnetControllerBroadcastUid.manu && (uidptr)->id == kRdmnetControllerBroadcastUid.id)
 
#define uid_is_rdmnet_device_broadcast(uidptr) \
  ((uidptr)->manu == kRdmnetDeviceBroadcastUid.manu && (uidptr)->id == kRdmnetDeviceBroadcastUid.id)
 
#define uid_is_rdmnet_device_manu_broadcast(uidptr) \
  ((uidptr)->manu == kRdmnetControllerBroadcastUid.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 uid_is_dynamic(uidptr)                                                         \
  ((((uidptr)->manu & 0x8000u) != 0) && !uid_is_rdmnet_controller_broadcast(uidptr) && \
   !uid_is_rdmnet_device_manu_broadcast(uidptr) && !uid_is_broadcast(uidptr))
 
#define get_manufacturer_id(uidptr) ((uidptr)->manu & 0x7fffu)
 
#define get_device_id(uidptr) ((uidptr)->id)
 
#ifdef __cplusplus
extern "C" {
#endif
 
extern const LwpaUid kBroadcastUid;
 
extern const LwpaUid kRdmnetControllerBroadcastUid;
 
extern const LwpaUid kRdmnetDeviceBroadcastUid;
 
#ifdef __cplusplus
}
#endif
 
#endif /* _LWPA_UID_H_ */