transceiver.h

Go to the documentation of this file.

/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * transceiver.h
 * Copyright (C) 2015 Simon Newton
 */

#ifndef FIRMWARE_SRC_TRANSCEIVER_H_
#define FIRMWARE_SRC_TRANSCEIVER_H_

#include <stdint.h>
#include <stdbool.h>

#include "iovec.h"
#include "system_config.h"
#include "peripheral/ic/plib_ic.h"
#include "peripheral/ports/plib_ports.h"
#include "peripheral/tmr/plib_tmr.h"
#include "peripheral/usart/plib_usart.h"
#include "system/int/sys_int.h"

#ifdef __cplusplus
extern "C" {
#endif

extern const int16_t TRANSCEIVER_NO_NOTIFICATION;

typedef enum {
  T_MODE_CONTROLLER,  
  T_MODE_RESPONDER,  
  T_MODE_SELF_TEST,  
  T_MODE_LAST  
} TransceiverMode;

typedef enum {
  T_OP_TX_ONLY,  
  T_OP_RDM_DUB,  
  T_OP_RDM_BROADCAST,  
  T_OP_RDM_WITH_RESPONSE,  
  T_OP_RX,  
  T_OP_MODE_CHANGE,  
  T_OP_SELF_TEST  
} TransceiverOperation;

typedef enum {
  T_RESULT_OK,  

  T_RESULT_TX_ERROR,  
  T_RESULT_RX_DATA,  
  T_RESULT_RX_TIMEOUT,  
  T_RESULT_RX_INVALID,  

  T_RESULT_RX_START_FRAME,  
  T_RESULT_RX_CONTINUE_FRAME,  

  T_RESULT_RX_FRAME_TIMEOUT,

  T_RESULT_CANCELLED,  
  T_RESULT_SELF_TEST_FAILED  
} TransceiverOperationResult;

typedef union {
  struct {
    uint16_t start;  
    uint16_t end;  
  } dub_response;

  struct {
    uint16_t break_start;  
    uint16_t mark_start;  
    uint16_t mark_end;  
  } get_set_response;

  struct {
    uint16_t break_time;  
    uint16_t mark_time;  
  } request;
} TransceiverTiming;

typedef struct {
  int16_t token;

  TransceiverOperation op;

  TransceiverOperationResult result;

  const uint8_t *data;

  unsigned int length;

  TransceiverTiming *timing;
} TransceiverEvent;

typedef bool (*TransceiverEventCallback)(const TransceiverEvent *event);

typedef struct {
  USART_MODULE_ID usart;  
  INT_VECTOR usart_vector;  
  INT_SOURCE usart_tx_source;  
  INT_SOURCE usart_rx_source;  
  INT_SOURCE usart_error_source;  
  PORTS_CHANNEL port;  
  PORTS_BIT_POS break_bit;  
  PORTS_BIT_POS tx_enable_bit;  
  PORTS_BIT_POS rx_enable_bit;  
  IC_MODULE_ID input_capture_module;  
  INT_VECTOR input_capture_vector;  
  INT_SOURCE input_capture_source;  
  TMR_MODULE_ID timer_module_id;  
  INT_VECTOR timer_vector;  
  INT_SOURCE timer_source;  
  IC_TIMERS input_capture_timer;  
} TransceiverHardwareSettings;

void Transceiver_Initialize(const TransceiverHardwareSettings *settings,
                            TransceiverEventCallback tx_callback,
                            TransceiverEventCallback rx_callback);

bool Transceiver_SetMode(TransceiverMode mode, int16_t token);

TransceiverMode Transceiver_GetMode();

void Transceiver_Tasks();

bool Transceiver_QueueDMX(int16_t token, const uint8_t* data,
                          unsigned int size);

bool Transceiver_QueueASC(int16_t token, uint8_t start_code,
                          const uint8_t* data, unsigned int size);

bool Transceiver_QueueRDMDUB(int16_t token, const uint8_t* data,
                             unsigned int size);

bool Transceiver_QueueRDMRequest(int16_t token, const uint8_t* data,
                                 unsigned int size, bool is_broadcast);

bool Transceiver_QueueRDMResponse(bool include_break,
                                  const IOVec* iov,
                                  unsigned int iov_count);


bool Transceiver_QueueSelfTest(int16_t token);

void Transceiver_Reset();

bool Transceiver_SetBreakTime(uint16_t break_time_us);

uint16_t Transceiver_GetBreakTime();

bool Transceiver_SetMarkTime(uint16_t mark_time_us);

uint16_t Transceiver_GetMarkTime();

bool Transceiver_SetRDMBroadcastTimeout(uint16_t delay);

uint16_t Transceiver_GetRDMBroadcastTimeout();

bool Transceiver_SetRDMResponseTimeout(uint16_t delay);

uint16_t Transceiver_GetRDMResponseTimeout();

bool Transceiver_SetRDMDUBResponseLimit(uint16_t limit);

uint16_t Transceiver_GetRDMDUBResponseLimit();

bool Transceiver_SetRDMResponderDelay(uint16_t delay);

uint16_t Transceiver_GetRDMResponderDelay();

bool Transceiver_SetRDMResponderJitter(uint16_t max_jitter);

uint16_t Transceiver_GetRDMResponderJitter();

#ifdef __cplusplus
}
#endif

#endif  // FIRMWARE_SRC_TRANSCEIVER_H_