psmove_private.h

#pragma once
/**
 * PS Move API - An interface for the PS Move Motion Controller
 * Copyright (c) 2012 Thomas Perl <m@thp.io>
 * Copyright (c) 2012 Benjamin Venditti <benjamin.venditti@gmail.com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 **/


#ifdef __cplusplus
extern "C" {
#endif

#include "psmove.h"

#include <stdio.h>
#include <wchar.h>
#include <time.h>
#include <stdbool.h>

    /**
     * PRIVATE DEFINITIONS FOR USE IN psmove.c AND psmove_*.c
     *
     * These constants are considered implementation details and should
     * not be used by external code (they are subject to change).
     *
     * All constants that need to be shared between psmove.c and other
     * implementation modules (psmove_*.c) should go here.
     **/

/* Vendor ID and Product ID of PS Move Controller */
/* PS3/PS4 PS Move Controller (MiniUSB), a.k.a. CECH-ZCM1E */
#define PSMOVE_VID 0x054c
#define PSMOVE_PID 0x03d5
/* PS4 PS Move Controller (MicroUSB), a.k.a. CECH-ZCM2J */
#define PSMOVE_PS4_PID 0x0c5e

/* Macros: Return immediately if an assertion fails + log */
#define psmove_return_if_fail(expr) \
        { \
            if (!(expr)) { \
                PSMOVE_ERROR("Assertion failed: %s", (#expr)); \
                return; \
            } \
        }
#define psmove_return_val_if_fail(expr, val) \
        { \
            if (!(expr)) { \
                PSMOVE_ERROR("Assertion failed: %s", (#expr)); \
                return (val); \
            } \
        }

/* Macro: Length of fixed-size array */
#define ARRAY_LENGTH(x) (sizeof(x)/sizeof((x)[0]))

/* RGB value struct used in the tracker */
struct PSMove_RGBValue {
    unsigned char r;
    unsigned char g;
    unsigned char b;
};

/* Buffer size for calibration data */
#define PSMOVE_CALIBRATION_SIZE 49

/* Three blocks, minus header (2 bytes) for blocks 2,3 */
#define PSMOVE_ZCM1_CALIBRATION_BLOB_SIZE	(PSMOVE_CALIBRATION_SIZE*3 - 2*2) 

/* Three blocks, minus header (2 bytes) for block 2 */
#define PSMOVE_ZCM2_CALIBRATION_BLOB_SIZE	(PSMOVE_CALIBRATION_SIZE*2 - 2*1) 

/* The maximum calibration blob size */
#define PSMOVE_MAX_CALIBRATION_BLOB_SIZE	PSMOVE_ZCM1_CALIBRATION_BLOB_SIZE

/* System-wide data directory */
#define PSMOVE_SYSTEM_DATA_DIR "/etc/psmoveapi"

/* Maximum length of the serial string */
#define PSMOVE_MAX_SERIAL_LENGTH 255

/**
 * [PRIVATE API] Write raw data blob to device
 **/
ADDAPI void
ADDCALL _psmove_write_data(PSMove *move, unsigned char *data, size_t length);


/**
 * [PRIVATE API] Read raw data blob from device
 **/
ADDAPI void
ADDCALL _psmove_read_data(PSMove *move, unsigned char *data, size_t length);

/**
 * [PRIVATE API] Internal device open function (hidraw, Linux / for moved)
 **/
ADDAPI PSMove *
ADDCALL psmove_connect_internal(const wchar_t *serial, const char *path, int id, unsigned short pid);

/**
 * [PRIVATE API] Get device path of a controller (hidraw, Linux / for moved)
 **/
ADDAPI const char *
ADDCALL _psmove_get_device_path(PSMove *move);

/**
 * [PRIVATE API] Get the ZCM1 calibration data from a connected USB controller.
 *
 * The pointer *dest will be set to a newly-allocated byte array
 * of a certain size (which will be saved in *size) and the caller
 * has to free this field using \ref psmove_free_mem().
 **/
ADDAPI int
ADDCALL _psmove_get_zcm1_calibration_blob(PSMove *move, char **dest, size_t *size);

/**
 * [PRIVATE API] Get the ZCM2 calibration data from a connected USB controller.
 *
 * The pointer *dest will be set to a newly-allocated byte array
 * of a certain size (which will be saved in *size) and the caller
 * has to free this field using \ref psmove_free_mem().
 **/
ADDAPI int
ADDCALL _psmove_get_zcm2_calibration_blob(PSMove *move, char **dest, size_t *size);

/**
 * [PRIVATE API] Translate a raw temperature value to degrees Celsius
 **/
ADDAPI float
ADDCALL _psmove_temperature_to_celsius(int temperature);

/* A Bluetooth address. */
typedef unsigned char PSMove_Data_BTAddr[6];

/**
 * Read a Bluetooth address from string and write its
 * internal representation into a PSMove_Data_BTAddr.
 *
 * If dest is NULL, the data is not written (only verified).
 *
 * Will return nonzero on success, zero on error.
 **/
ADDAPI int
ADDCALL _psmove_btaddr_from_string(const char *string, PSMove_Data_BTAddr *dest);

/* Return true if the two addresses are equal */
ADDAPI bool
ADDCALL _psmove_btaddrs_equal(const char *addr1, const char *addr2);

/**
 * Formats the contents of addr to a newly-allocated string and
 * returns it. The caller has to free the return value using
 * \ref psmove_free_mem().
 **/
ADDAPI char *
ADDCALL _psmove_btaddr_to_string(const PSMove_Data_BTAddr addr);

/**
 * Normalize a Bluetooth address given a specific format
 *
 * lowercase ... Make all characters lowercase if true
 * separator ... The separator character (usually ':', '-' or '_')
 *
 * This function returns addr.
 **/
ADDAPI char *
ADDCALL _psmove_normalize_btaddr_inplace(char *addr, bool lowercase, char separator);


/**
 * Read the current Bluetooth addresses stored in the controller
 *
 * This only works via USB.
 *
 * If host is not NULL, the current host address will be stored there.
 * If controller is not NULL, the controller address will be stored there.
 **/
ADDAPI int
ADDCALL _psmove_read_btaddrs(PSMove *move, PSMove_Data_BTAddr *host, PSMove_Data_BTAddr *controller);


/* Firmware-related private APIs */

/*! Controller's operation mode. */
enum PSMove_Operation_Mode {
    Mode_Normal, /*!< Default mode after starting the controller */
    Mode_STDFU,
    Mode_BTDFU,
};

typedef struct {
    unsigned short version;    /*!< Move's firmware version number */
    unsigned short bt_version; /*!< Move Bluetooth module's firmware version number */
    unsigned short revision;   /*!< Move's firmware revision number */
    unsigned char _unknown[7];
} PSMove_Firmware_Info;

ADDAPI PSMove_Firmware_Info *
ADDCALL _psmove_get_firmware_info(PSMove *move);

ADDAPI bool
ADDCALL _psmove_set_operation_mode(PSMove *move, enum PSMove_Operation_Mode mode);

/**
 * Set the Host Bluetooth address that is used to connect via
 * Bluetooth. You should set this to the local computer's
 * Bluetooth address when connected via USB, then disconnect
 * and press the PS button to connect the controller via BT.
 **/
ADDAPI int
ADDCALL _psmove_set_btaddr(PSMove *move, PSMove_Data_BTAddr *addr);


/* Authentication-related private APIs */

/* A challenge data buffer for authentication. */
typedef unsigned char PSMove_Data_AuthChallenge[34];

/* A response data buffer for authentication. */
typedef unsigned char PSMove_Data_AuthResponse[22];

ADDAPI bool
ADDCALL _psmove_set_auth_challenge(PSMove *move, PSMove_Data_AuthChallenge *challenge);

ADDAPI PSMove_Data_AuthResponse *
ADDCALL _psmove_get_auth_response(PSMove *move);

#ifdef __cplusplus
}
#endif