common.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 RDMnet. For more information, go to:
 * https://github.com/ETCLabs/RDMnet
 *****************************************************************************/
 
#ifndef RDMNET_COMMON_H_
#define RDMNET_COMMON_H_
 
#include "etcpal/error.h"
#include "etcpal/inet.h"
#include "etcpal/log.h"
#include "rdm/message.h"
#include "rdmnet/defs.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum
{
  kRptStatusUnknownRptUid = VECTOR_RPT_STATUS_UNKNOWN_RPT_UID,
  kRptStatusRdmTimeout = VECTOR_RPT_STATUS_RDM_TIMEOUT,
  kRptStatusInvalidRdmResponse = VECTOR_RPT_STATUS_RDM_INVALID_RESPONSE,
  kRptStatusUnknownRdmUid = VECTOR_RPT_STATUS_UNKNOWN_RDM_UID,
  kRptStatusUnknownEndpoint = VECTOR_RPT_STATUS_UNKNOWN_ENDPOINT,
  kRptStatusBroadcastComplete = VECTOR_RPT_STATUS_BROADCAST_COMPLETE,
  kRptStatusUnknownVector = VECTOR_RPT_STATUS_UNKNOWN_VECTOR,
  kRptStatusInvalidMessage = VECTOR_RPT_STATUS_INVALID_MESSAGE,
  kRptStatusInvalidCommandClass = VECTOR_RPT_STATUS_INVALID_COMMAND_CLASS
} rpt_status_code_t;
 
typedef enum
{
  kEptStatusUnknownCid = VECTOR_EPT_STATUS_UNKNOWN_CID,
  kEptStatusUnknownVector = VECTOR_EPT_STATUS_UNKNOWN_VECTOR
} ept_status_code_t;
 
typedef enum
{
  kRdmnetDisconnectShutdown = E133_DISCONNECT_SHUTDOWN,
  kRdmnetDisconnectCapacityExhausted = E133_DISCONNECT_CAPACITY_EXHAUSTED,
  kRdmnetDisconnectHardwareFault = E133_DISCONNECT_HARDWARE_FAULT,
  kRdmnetDisconnectSoftwareFault = E133_DISCONNECT_SOFTWARE_FAULT,
  kRdmnetDisconnectSoftwareReset = E133_DISCONNECT_SOFTWARE_RESET,
  kRdmnetDisconnectIncorrectScope = E133_DISCONNECT_INCORRECT_SCOPE,
  kRdmnetDisconnectRptReconfigure = E133_DISCONNECT_RPT_RECONFIGURE,
  kRdmnetDisconnectLlrpReconfigure = E133_DISCONNECT_LLRP_RECONFIGURE,
  kRdmnetDisconnectUserReconfigure = E133_DISCONNECT_USER_RECONFIGURE
} rdmnet_disconnect_reason_t;
 
typedef enum
{
  kRdmnetConnectOk = E133_CONNECT_OK,
  kRdmnetConnectScopeMismatch = E133_CONNECT_SCOPE_MISMATCH,
  kRdmnetConnectCapacityExceeded = E133_CONNECT_CAPACITY_EXCEEDED,
  kRdmnetConnectDuplicateUid = E133_CONNECT_DUPLICATE_UID,
  kRdmnetConnectInvalidClientEntry = E133_CONNECT_INVALID_CLIENT_ENTRY,
  kRdmnetConnectInvalidUid = E133_CONNECT_INVALID_UID
} rdmnet_connect_status_t;
 
typedef enum
{
  kRdmnetDynamicUidStatusOk = E133_DYNAMIC_UID_STATUS_OK,
  kRdmnetDynamicUidStatusInvalidRequest = E133_DYNAMIC_UID_STATUS_INVALID_REQUEST,
  kRdmnetDynamicUidStatusUidNotFound = E133_DYNAMIC_UID_STATUS_UID_NOT_FOUND,
  kRdmnetDynamicUidStatusDuplicateRid = E133_DYNAMIC_UID_STATUS_DUPLICATE_RID,
  kRdmnetDynamicUidStatusCapacityExhausted = E133_DYNAMIC_UID_STATUS_CAPACITY_EXHAUSTED
} rdmnet_dynamic_uid_status_t;
 
typedef enum
{
  kRdmnetConnectFailSocketFailure,
  kRdmnetConnectFailTcpLevel,
  kRdmnetConnectFailNoReply,
  kRdmnetConnectFailRejected
} rdmnet_connect_fail_event_t;
 
typedef enum
{
  kRdmnetDisconnectAbruptClose,
  kRdmnetDisconnectNoHeartbeat,
  kRdmnetDisconnectRedirected,
  kRdmnetDisconnectGracefulRemoteInitiated,
  kRdmnetDisconnectGracefulLocalInitiated
} rdmnet_disconnect_event_t;
 
typedef enum
{
  kRdmnetRdmResponseActionSendAck,
  kRdmnetRdmResponseActionSendNack,
  kRdmnetRdmResponseActionDefer,
  kRdmnetRdmResponseActionRetryLater
} rdmnet_rdm_response_action_t;
 
typedef struct RdmnetSyncRdmResponse
{
  rdmnet_rdm_response_action_t response_action;
 
  union
  {
    size_t response_data_len;
    rdm_nack_reason_t nack_reason;
  } response_data;
} RdmnetSyncRdmResponse;
 
#define RDMNET_SYNC_SEND_RDM_ACK(response_ptr, response_data_len_in)          \
  if (response_ptr)                                                           \
  {                                                                           \
    (response_ptr)->response_action = kRdmnetRdmResponseActionSendAck;        \
    (response_ptr)->response_data.response_data_len = (response_data_len_in); \
  }
 
#define RDMNET_SYNC_SEND_RDM_NACK(response_ptr, nack_reason_in)         \
  if (response_ptr)                                                     \
  {                                                                     \
    (response_ptr)->response_action = kRdmnetRdmResponseActionSendNack; \
    (response_ptr)->response_data.nack_reason = (nack_reason_in);       \
  }
 
#define RDMNET_SYNC_DEFER_RDM_RESPONSE(response_ptr)                 \
  if (response_ptr)                                                  \
  {                                                                  \
    (response_ptr)->response_action = kRdmnetRdmResponseActionDefer; \
  }
 
#define RDMNET_SYNC_RETRY_LATER(response_ptr)                             \
  if (response_ptr)                                                       \
  {                                                                       \
    (response_ptr)->response_action = kRdmnetRdmResponseActionRetryLater; \
  }
 
typedef enum
{
  kRdmnetEptResponseActionSendData,
  kRdmnetEptResponseActionSendStatus,
  kRdmnetEptResponseActionDefer
} rdmnet_ept_response_action_t;
 
typedef struct RdmnetSyncEptResponse
{
  rdmnet_ept_response_action_t response_action;
 
  union
  {
    size_t response_data_len;
    ept_status_code_t status_code;
  } response_data;
} RdmnetSyncEptResponse;
 
#define RDMNET_SYNC_SEND_EPT_DATA(response_ptr, response_data_len_in)         \
  if (response_ptr)                                                           \
  {                                                                           \
    (response_ptr)->response_action = kRdmnetEptResponseActionSendData;       \
    (response_ptr)->response_data.response_data_len = (response_data_len_in); \
  }
 
#define RDMNET_SYNC_SEND_EPT_STATUS(response_ptr, status_code_in)         \
  if (response_ptr)                                                       \
  {                                                                       \
    (response_ptr)->response_action = kRdmnetEptResponseActionSendStatus; \
    (response_ptr)->response_data.status_code = (status_code_in);         \
  }
 
#define RDMNET_SYNC_DEFER_EPT_RESPONSE(response_ptr)                 \
  if (response_ptr)                                                  \
  {                                                                  \
    (response_ptr)->response_action = kRdmnetEptResponseActionDefer; \
  }
 
typedef enum
{
  kRdmnetCCGetCommand = 0x20,
  kRdmnetCCSetCommand = 0x30
} rdmnet_command_class_t;
 
typedef struct RdmnetNetintConfig
{
  const EtcPalMcastNetintId* netints;
  size_t num_netints;
  bool no_netints;
} RdmnetNetintConfig;
 
#define RDMNET_NETINT_CONFIG_DEFAULT_INIT \
  {                                       \
    NULL, 0, false                        \
  }
 
etcpal_error_t rdmnet_init(const EtcPalLogParams* log_params, const RdmnetNetintConfig* netint_config);
void           rdmnet_deinit(void);
 
const char* rdmnet_rpt_status_code_to_string(rpt_status_code_t code);
const char* rdmnet_ept_status_code_to_string(ept_status_code_t code);
const char* rdmnet_connect_fail_event_to_string(rdmnet_connect_fail_event_t event);
const char* rdmnet_disconnect_event_to_string(rdmnet_disconnect_event_t event);
const char* rdmnet_connect_status_to_string(rdmnet_connect_status_t code);
const char* rdmnet_disconnect_reason_to_string(rdmnet_disconnect_reason_t code);
const char* rdmnet_dynamic_uid_status_to_string(rdmnet_dynamic_uid_status_t code);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RDMNET_COMMON_H_ */