constants.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
 *
 * constants.h
 * Copyright (C) 2015 Simon Newton
 */

#ifndef FIRMWARE_SRC_CONSTANTS_H_
#define FIRMWARE_SRC_CONSTANTS_H_

// *****************************************************************************
// USB specific constants
// *****************************************************************************

#define USB_MAX_PACKET_SIZE 64u

#define USB_READ_BUFFER_SIZE 576u

#define USB_POLLING_INTERVAL 1u

// *****************************************************************************
// Network specific constants
// *****************************************************************************

enum { MAC_ADDRESS_SIZE = 6 };

// *****************************************************************************
// RDM specific constants
// *****************************************************************************

#define RDM_START_CODE 0xccu

#define RDM_SUB_START_CODE 0x01u

// *****************************************************************************
// Protocol specific constants
// *****************************************************************************

typedef enum {
  // Base commands
  COMMAND_RESET_DEVICE = 0x00,

  COMMAND_SET_MODE = 0x01,

  COMMAND_GET_HARDWARE_INFO = 0x02,

  COMMAND_RUN_SELF_TEST = 0x03,

  // User Configuration
  COMMAND_SET_BREAK_TIME = 0x10,

  COMMAND_GET_BREAK_TIME = 0x11,

  COMMAND_SET_MARK_TIME = 0x12,

  COMMAND_GET_MARK_TIME = 0x13,

  // Advanced Configuration
  COMMAND_SET_RDM_BROADCAST_TIMEOUT = 0x20,

  COMMAND_GET_RDM_BROADCAST_TIMEOUT = 0x21,

  COMMAND_SET_RDM_RESPONSE_TIMEOUT = 0x22,

  COMMAND_GET_RDM_RESPONSE_TIMEOUT = 0x23,

  COMMAND_SET_RDM_DUB_RESPONSE_LIMIT = 0x24,

  COMMAND_GET_RDM_DUB_RESPONSE_LIMIT = 0x25,

  COMMAND_SET_RDM_RESPONDER_DELAY = 0x26,

  COMMAND_GET_RDM_RESPONDER_DELAY = 0x27,

  COMMAND_SET_RDM_RESPONDER_JITTER = 0x28,

  COMMAND_GET_RDM_RESPONDER_JITTER = 0x29,

  // DMX
  TX_DMX = 0x30,  

  // RDM
  COMMAND_RDM_DUB_REQUEST = 0x40,

  COMMAND_RDM_REQUEST = 0x41,

  COMMAND_RDM_BROADCAST_REQUEST = 0x42,

  // Experimental / testing
  COMMAND_ECHO = 0xf0,  
  GET_FLAGS = 0xf2,  
} Command;

typedef enum {
  RC_OK = 0,  
  RC_UNKNOWN = 1,  

  RC_BUFFER_FULL = 2,
  RC_BAD_PARAM = 3,  
  RC_TX_ERROR = 4,  
  RC_RDM_TIMEOUT = 5,  

  RC_RDM_BCAST_RESPONSE = 6,
  RC_RDM_INVALID_RESPONSE = 7,  
  RC_INVALID_MODE = 8,  

  RC_TEST_FAILED = 9,  
  RC_CANCELLED = 10  
} ReturnCode;

#define START_OF_MESSAGE_ID 0x5au

#define END_OF_MESSAGE_ID 0xa5u

#define PAYLOAD_SIZE 513u

#define DEFAULT_BREAK_TIME 176u

#define DEFAULT_MARK_TIME 12u

#define DEFAULT_RDM_BROADCAST_TIMEOUT 28u

#define DEFAULT_RDM_RESPONSE_TIMEOUT 28u

#define DEFAULT_RDM_DUB_RESPONSE_LIMIT 29000u

#define DEFAULT_RDM_RESPONDER_DELAY 1760u

#endif  // FIRMWARE_SRC_CONSTANTS_H_