llrp_target.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_LLRP_TARGET_H_
#define RDMNET_LLRP_TARGET_H_
 
#include <stdint.h>
#include "etcpal/common.h"
#include "etcpal/uuid.h"
#include "etcpal/error.h"
#include "etcpal/inet.h"
#include "rdm/uid.h"
#include "rdm/message.h"
#include "rdmnet/common.h"
#include "rdmnet/llrp.h"
#include "rdmnet/message.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef int llrp_target_t;
#define LLRP_TARGET_INVALID -1
 
typedef void (*LlrpTargetRdmCommandReceivedCallback)(llrp_target_t          handle,
                                                     const LlrpRdmCommand*  cmd,
                                                     RdmnetSyncRdmResponse* response,
                                                     void*                  context);
 
typedef struct LlrpTargetCallbacks
{
  LlrpTargetRdmCommandReceivedCallback rdm_command_received; 
  void* context; 
} LlrpTargetCallbacks;
 
typedef struct LlrpTargetConfig
{
  /************************************************************************************************
   * Required Values
   ***********************************************************************************************/
 
  EtcPalUuid cid;
  LlrpTargetCallbacks callbacks;
 
  /************************************************************************************************
   * Optional Values
   ***********************************************************************************************/
 
  uint8_t* response_buf;
 
  RdmUid uid;
} LlrpTargetConfig;
 
#define LLRP_TARGET_CONFIG_DEFAULT_INIT(manu_id)         \
  {                                                      \
    {{0}}, {NULL, NULL}, NULL, { (0x8000 | manu_id), 0 } \
  }
 
void llrp_target_config_init(LlrpTargetConfig* config, uint16_t manufacturer_id);
 
etcpal_error_t llrp_target_create(const LlrpTargetConfig* config, llrp_target_t* handle);
etcpal_error_t llrp_target_destroy(llrp_target_t handle);
 
etcpal_error_t llrp_target_send_ack(llrp_target_t              handle,
                                    const LlrpSavedRdmCommand* received_cmd,
                                    const uint8_t*             response_data,
                                    uint8_t                    response_data_len);
etcpal_error_t llrp_target_send_nack(llrp_target_t              handle,
                                     const LlrpSavedRdmCommand* received_cmd,
                                     rdm_nack_reason_t          nack_reason);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RDMNET_LLRP_TARGET_H_ */