stk-code_catmod/lib/wiiuse/wiiuse_internal.h

/*
 *	wiiuse
 *
 *	Written By:
 *		Michael Laforest	< para >
 *		Email: < thepara (--AT--) g m a i l [--DOT--] com >
 *
 *	Copyright 2006-2007
 *
 *	This file is part of wiiuse.
 *
 *	Mac device classes based on wiic_internal.h from WiiC, written By:
 *		Gabriele Randelli
 *		Email: < randelli (--AT--) dis [--DOT--] uniroma1 [--DOT--] it >
 *
 *	Copyright 2010
 *
 *	This program is free software; you can redistribute it and/or modify
 *	it under the terms of the GNU General Public License as published by
 *	the Free Software Foundation; either version 3 of the License, or
 *	(at your option) any later version.
 *
 *	This program 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 General Public License for more details.
 *
 *	You should have received a copy of the GNU General Public License
 *	along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *	$Header$
 *
 */

/**
 *	@file
 *	@brief General internal wiiuse stuff.
 *
 *	Since Wiiuse is a library, wiiuse.h is a duplicate
 *	of the API header.
 *
 *	The code that would normally go in that file, but
 *	which is not needed by third party developers,
 *	is put here.
 *
 *	So wiiuse_internal.h is included by other files
 *	internally, wiiuse.h is included only here.
 */

#ifndef WIIUSE_INTERNAL_H_INCLUDED
#define WIIUSE_INTERNAL_H_INCLUDED

#ifndef WIIUSE_PLATFORM
	#if defined(_WIN32)
		#define WIIUSE_PLATFORM
		#define WIIUSE_WIN32
	#elif defined(__linux)
		#define WIIUSE_PLATFORM
		#define WIIUSE_BLUEZ
	#elif defined(__APPLE__)
		#define WIIUSE_PLATFORM
		#define WIIUSE_MAC
	#else
		#error "Platform not yet supported!"
	#endif
#endif

#ifdef WIIUSE_WIN32
	#include <winsock2.h>
#endif
#ifdef WIIUSE_BLUEZ
	#include <arpa/inet.h>				/* htons() */
	#include <bluetooth/bluetooth.h>
#endif
#ifdef WIIUSE_MAC
	/* mac */
	#include <CoreFoundation/CoreFoundation.h>		/*CFRunLoops and CFNumberRef in Bluetooth classes*/
	#include <IOBluetooth/IOBluetoothUserLib.h>		/*IOBluetoothDeviceRef and IOBluetoothL2CAPChannelRef*/
#endif

#include "definitions.h"

#if defined(_MSC_VER)
/* MS compilers of pre-VC2010 versions don't have stdint.h
 * and I can't get VC2010's stdint.h to compile nicely in
 * WiiUse
 */
	#include "wiiuse_msvcstdint.h"
#else
	#include <stdint.h>
#endif

/********************
 *
 *	Wiimote internal codes
 *
 ********************/


/** @addtogroup internal_general Internal: API for General Internal Use */
/** @{ */
/* Communication channels */
#define WM_OUTPUT_CHANNEL			0x11
#define WM_INPUT_CHANNEL			0x13

#define WM_SET_REPORT				0x50
#define WM_SET_DATA					0xA0

/* commands */
#define WM_CMD_LED					0x11
#define WM_CMD_REPORT_TYPE			0x12
#define WM_CMD_RUMBLE				0x13
#define WM_CMD_IR					0x13
#define WM_CMD_CTRL_STATUS			0x15
#define WM_CMD_WRITE_DATA			0x16
#define WM_CMD_READ_DATA			0x17
#define WM_CMD_IR_2					0x1A

/* input report ids */
#define WM_RPT_CTRL_STATUS			0x20
#define WM_RPT_READ					0x21
#define WM_RPT_WRITE				0x22
#define WM_RPT_BTN					0x30
#define WM_RPT_BTN_ACC				0x31
#define WM_RPT_BTN_ACC_IR			0x33
#define WM_RPT_BTN_EXP				0x34
#define WM_RPT_BTN_ACC_EXP			0x35
#define WM_RPT_BTN_IR_EXP			0x36
#define WM_RPT_BTN_ACC_IR_EXP		0x37

#define WM_BT_INPUT					0x01
#define WM_BT_OUTPUT				0x02

/* Identify the wiimote device by its class */

/* (Explanation and mac classes taken from WiiC)
 * The different codes wrt. to Linux
 * is a bit hard to explain.
 * Looking at Bluetooth CoD format, we have 24 bits.
 * In wiic Linux they are stored in three fields,
 * each one 8bit long. The result number is
 * 0x002504. However, MacOS Bluetooth does
 * not store them in such a way, rather it uses
 * the concept of major service, major class,
 * and minor class, that are respectivelly
 * 11bit, 5bit, and 6bit long. Hence, the
 * numbers are different.
 * The Wiimote CoD Bluetooth division is the following:
 * 00000000001 00101 000001 00 (major service - major class - minor class - format type)
 * This can also be seen in the WiiC Linux way:
 * 00000000 00100101 00000100
 */
#ifdef WIIUSE_MAC
	#define WM_DEV_MINOR_CLASS				0x01	// Regular wiimote
	#define WM_DEV_MAJOR_CLASS				0x05
	#define WM_DEV_MAJOR_SERVICE			0x01

	#define WM_PLUS_DEV_MINOR_CLASS			0x02	// For the newer RVL-CNT-01-TR (MotionPlus Inside)
	#define WM_PLUS_DEV_MAJOR_CLASS			0x05
	#define WM_PLUS_DEV_MAJOR_SERVICE		0x00
#else
	#define WM_DEV_CLASS_0				0x04	// Regular wiimote
	#define WM_DEV_CLASS_1				0x25
	#define WM_DEV_CLASS_2				0x00

	#define WM_PLUS_DEV_CLASS_0			0x08	// For the newer RVL-CNT-01-TR (MotionPlus Inside)
	#define WM_PLUS_DEV_CLASS_1			0x05
	#define WM_PLUS_DEV_CLASS_2			0x00
#endif
#define WM_VENDOR_ID				0x057E
#define WM_PRODUCT_ID				0x0306	// Regular wiimote
#define WM_PLUS_PRODUCT_ID			0x0330	// For the newer RVL-CNT-01-TR (MotionPlus Inside)

/* controller status stuff */
#define WM_MAX_BATTERY_CODE			0xC8

/* offsets in wiimote memory */
#define WM_MEM_OFFSET_CALIBRATION	0x16
#define WM_EXP_MEM_BASE				0x04A40000
#define WM_EXP_ID				0x04A400FA
#define WM_EXP_MEM_ENABLE			0x04A40040
#define WM_EXP_MEM_ENABLE1			0x04A400F0
#define WM_EXP_MEM_ENABLE2			0x04A400FB
#define WM_EXP_MEM_CALIBR			0x04A40020
#define WM_EXP_MOTION_PLUS_IDENT    0x04A600FA
#define WM_EXP_MOTION_PLUS_ENABLE   		0x04A600FE
#define WM_EXP_MOTION_PLUS_INIT     0x04A600F0
#define WM_REG_IR				0x04B00030
#define WM_REG_IR_BLOCK1			0x04B00000
#define WM_REG_IR_BLOCK2			0x04B0001A
#define WM_REG_IR_MODENUM			0x04B00033


#define WM_IR_TYPE_BASIC			0x01
#define WM_IR_TYPE_EXTENDED			0x03

/* controller status flags for the first message byte */
/* bit 1 is unknown */
#define WM_CTRL_STATUS_BYTE1_ATTACHMENT			0x02
#define WM_CTRL_STATUS_BYTE1_SPEAKER_ENABLED	0x04
#define WM_CTRL_STATUS_BYTE1_IR_ENABLED			0x08
#define WM_CTRL_STATUS_BYTE1_LED_1				0x10
#define WM_CTRL_STATUS_BYTE1_LED_2				0x20
#define WM_CTRL_STATUS_BYTE1_LED_3				0x40
#define WM_CTRL_STATUS_BYTE1_LED_4				0x80

/* aspect ratio */
#define WM_ASPECT_16_9_X	660
#define WM_ASPECT_16_9_Y	370
#define WM_ASPECT_4_3_X		560
#define WM_ASPECT_4_3_Y		420


/**
 *	Expansion stuff
 */

/* decrypted expansion id codes (located at 0x04A400FC) */
#define EXP_ID_CODE_NUNCHUK                 0xA4200000
#define EXP_ID_CODE_WII_BOARD               0xA4200402
#define EXP_ID_CODE_CLASSIC_CONTROLLER      0xA4200101
#define EXP_ID_CODE_GUITAR                  0xA4200103
#define EXP_ID_CODE_MOTION_PLUS             0xA4200405
#define EXP_ID_CODE_MOTION_PLUS_NUNCHUK     0xA4200505 /** Motion Plus ID in Nunchuck passthrough mode */
#define EXP_ID_CODE_MOTION_PLUS_CLASSIC     0xA4200705 /** Motion Plus ID in Classic control. passthrough */

/* decrypted M+ codes at 0x04A600FA */
#define EXP_ID_CODE_INACTIVE_MOTION_PLUS        0xA6200005 /** Inactive Motion Plus ID */
#define EXP_ID_CODE_NLA_MOTION_PLUS             0xA6200405 /** No longer active Motion Plus ID */
#define EXP_ID_CODE_NLA_MOTION_PLUS_NUNCHUK     0xA6200505 /** No longer active Motion Plus ID in Nunchuck passthrough mode */
#define EXP_ID_CODE_NLA_MOTION_PLUS_CLASSIC     0xA6200705 /** No longer active Motion Plus ID in Classic control. passthrough */

#define EXP_HANDSHAKE_LEN					224

/********************
 *
 *	End Wiimote internal codes
 *
 ********************/

#define WIIMOTE_INIT_STATES					(WIIMOTE_STATE_IR_SENS_LVL3)

/* macro to manage states */
#define WIIMOTE_ENABLE_STATE(wm, s)		(wm->state |= (s))
#define WIIMOTE_DISABLE_STATE(wm, s)	(wm->state &= ~(s))
#define WIIMOTE_TOGGLE_STATE(wm, s)		((wm->state & (s)) ? WIIMOTE_DISABLE_STATE(wm, s) : WIIMOTE_ENABLE_STATE(wm, s))

#define WIIMOTE_IS_FLAG_SET(wm, s)		((wm->flags & (s)) == (s))
#define WIIMOTE_ENABLE_FLAG(wm, s)		(wm->flags |= (s))
#define WIIMOTE_DISABLE_FLAG(wm, s)		(wm->flags &= ~(s))
#define WIIMOTE_TOGGLE_FLAG(wm, s)		((wm->flags & (s)) ? WIIMOTE_DISABLE_FLAG(wm, s) : WIIMOTE_ENABLE_FLAG(wm, s))

#define NUNCHUK_IS_FLAG_SET(wm, s)		((*(wm->flags) & (s)) == (s))

/*
 *	Largest known payload is 21 bytes.
 *	Add 1 (Win32) or 2 (Mac, *nix) for the prefix and round up to a power of 2.
 */
#define MAX_PAYLOAD			32

/*
 *	Smooth tilt calculations are computed with the
 *	exponential moving average formula:
 *		St = St_last + (alpha * (tilt - St_last))
 *	alpha is between 0 and 1
 */
#define WIIUSE_DEFAULT_SMOOTH_ALPHA		0.07f

#define SMOOTH_ROLL						0x01
#define SMOOTH_PITCH					0x02

/** @} */
#include "wiiuse.h"
/** @addtogroup internal_general */
/** @{ */
#define _STRINGIFY(s) _STRINGIFY_IMPL(s)
#define _STRINGIFY_IMPL(s) #s

/* wiiuse version, from public per-component version defines */
#define WIIUSE_VERSION _STRINGIFY(WIIUSE_MAJOR) "." _STRINGIFY(WIIUSE_MINOR) "." _STRINGIFY(WIIUSE_MICRO)

#ifdef _MSC_VER
#	define INLINE_UTIL __inline
#else
#	define INLINE_UTIL static inline
#endif

#ifdef __cplusplus
extern "C" {
#endif

	/* not part of the api */

	/** @brief Cross-platform call to sleep for at least the specified number
	 * of milliseconds.
	 *
	 * Use instead of Sleep(), usleep(), or similar functions.
	 * Defined in util.c
	 */
	void wiiuse_millisleep(int durationMilliseconds);

	int wiiuse_set_report_type(struct wiimote_t* wm);
	void wiiuse_send_next_pending_read_request(struct wiimote_t* wm);
	void wiiuse_send_next_pending_write_request(struct wiimote_t* wm);
	int wiiuse_send(struct wiimote_t* wm, byte report_type, byte* msg, int len);
	int wiiuse_read_data_cb(struct wiimote_t* wm, wiiuse_read_cb read_cb, byte* buffer, unsigned int offset, uint16_t len);
	int wiiuse_write_data_cb(struct wiimote_t *wm, unsigned int addr, byte* data, byte len, wiiuse_write_cb write_cb);


#ifdef WIIUSE_DOXYGEN_PARSING
	/** @addtogroup betosystem Big-endian buffer to system-byte-order value
		@{ */

	/** @brief Given a buffer buf, copy and return a value of type uint8_t.
	*/
	uint8_t from_big_endian_uint8_t(byte * buf);
	/** @brief Given a buffer buf, copy out a uint16_t, convert it from big-endian
		to system byte order, and return it.

		@note Requires that at least 2 bytes be available in buf, but does not
		check this - it is your responsibility.
	*/
	uint16_t from_big_endian_uint16_t(byte * buf);

	/** @brief Given a buffer buf, copy out a uint32_t, convert it from big-endian
		to system byte order, and return it.

		@note Requires that at least 4 bytes be available in buf, but does not
		check this - it is your responsibility.
	*/
	uint32_t from_big_endian_uint32_t(byte * buf);
	/** @} */

	/** @addtogroup systemtobe System-byte-order value to big-endian buffer
		@{
	*/

	/** @brief Copies the value val into the buffer buf.
		@note Requires that at least 1 byte is available in buf, but does not
		check this - it is your responsibility.
	*/
	void to_big_endian_uint8_t(byte * buf, uint8_t val);

	/** @brief Converts the value val from system byte order to big endian,
		and copies it into the given buffer starting at buf.

		@note Requires that at least 2 bytes be available in buf, but does not
		check this - it is your responsibility.
	*/
	void to_big_endian_uint16_t(byte * buf, uint16_t val);

	/** @brief Converts the value val from system byte order to big endian,
		and copies it into the given buffer starting at buf.

		@note Requires that at least 4 bytes be available in buf, but does not
		check this - it is your responsibility.
	*/
	void to_big_endian_uint32_t(byte * buf, uint32_t val);
	/** @}
	*/

	/** @addtogroup bufferfunc Buffering functions
		@brief These wrap around from/to_big_endian_TYPE, but take a byte** so that
		they can advance the input/output pointer appropriately.
		@{
	*/
	/** @brief Converts the value val from system byte order to big endian,
		copies it into the given buffer starting at *buf, and advances buf by
		sizeof(uint16_t).
	*/
	void buffer_big_endian_uint16_t(byte ** buf, uint16_t val);

	/** @brief Given the address of a buffer pointer buf, copy out a uint16_t
		from *buf, convert it from big-endian to system byte order, advance
		buf by sizeof(uint16_t), and return the value retrieved.
	*/
	uint16_t unbuffer_big_endian_uint16_t(byte ** buf);

	/** @sa buffer_big_endian_uint16_t()
	*/
	void buffer_big_endian_uint8_t(byte ** buf, uint8_t val);

	/** @sa unbuffer_big_endian_uint8_t
	*/
	uint8_t unbuffer_big_endian_uint8_t(byte ** buf);

	/** @sa buffer_big_endian_uint16_t
	*/
	void buffer_big_endian_uint32_t(byte ** buf, uint32_t val);

	/** @sa unbuffer_big_endian_uint32_t
	*/
	uint8_t unbuffer_big_endian_uint32_t(byte ** buf)

	/** @} */
#else /* this else is true when not in doxygen */

	INLINE_UTIL void to_big_endian_uint8_t(byte * buf, uint8_t val) {
		memcpy(buf, &val, 1);
	}

	INLINE_UTIL uint8_t from_big_endian_uint8_t(byte * buf) {
		uint8_t beVal;
		memcpy(&beVal, buf, 1);
		return beVal;
	}

#define WIIUSE_DECLARE_ENDIAN_CONVERSION_OPS(_TYPE, _TOBE, _FROMBE) \
INLINE_UTIL void to_big_endian_##_TYPE(byte * buf, _TYPE val) { \
	_TYPE beVal = _TOBE(val); \
	memcpy(buf, &beVal, sizeof(_TYPE)); \
} \
INLINE_UTIL _TYPE from_big_endian_##_TYPE(byte * buf) { \
	_TYPE beVal; \
	memcpy(&beVal, buf, sizeof(_TYPE)); \
	return _FROMBE(beVal); \
}

	WIIUSE_DECLARE_ENDIAN_CONVERSION_OPS(uint16_t, htons, ntohs)
	WIIUSE_DECLARE_ENDIAN_CONVERSION_OPS(uint32_t, htonl, ntohl)

#undef WIIUSE_DECLARE_ENDIAN_CONVERSION_OPS

#define WIIUSE_DECLARE_BUFFERING_OPS(_TYPE) \
INLINE_UTIL void buffer_big_endian_##_TYPE (byte ** buf, _TYPE val) { \
	to_big_endian_##_TYPE(*buf, val); \
	*buf += sizeof(_TYPE); \
} \
INLINE_UTIL _TYPE unbuffer_big_endian_##_TYPE (byte ** buf) { \
	byte * current = *buf; \
	*buf += sizeof(_TYPE); \
	return from_big_endian_##_TYPE(current); \
}

	WIIUSE_DECLARE_BUFFERING_OPS(uint8_t)
	WIIUSE_DECLARE_BUFFERING_OPS(uint16_t)
	WIIUSE_DECLARE_BUFFERING_OPS(uint32_t)

#undef WIIUSE_DECLARE_BUFFERING_OPS

#endif /* not in doxygen */

#ifdef __cplusplus
}
#endif
/** @} */

#endif /* WIIUSE_INTERNAL_H_INCLUDED */