BF07_IntFn.h

#pragma once

// BF07_IntFn.h :


// FW documentation

/* SBX, BF10, BF20, BF07 common commands */
/* MID_MSGT_XXX_SBX_LED_CTRL=           0x00    / * LED control (WR/RD)         */ /* 0xF0 */
/* MID_MSGT_SBX_MIC_SEL=                0x01    / * MIC selector (WR/RD)            */ /* 0xF0 */
/* MID_MSGT_XXX_SBX_MIC_ATT=            0x02    / * MIC attenuation (WR/RD)     */ /* 0xF0, 0x00 */
/* MID_MSGT_XXX_SBX_MIC_COMP=           0x03    / * MIC compression (WR/RD)     */ /* 0xF0 */
/* MID_MSGT_XXX_SBX_MIC_THRS=           0x04    / * MIC noise threshold (WR/RD) */ /* 0xF0 */
/* MID_MSGT_SBX_MONO_SPK_SEL=           0x05    / * mono SPK selector (WR/RD)   */ /* 0xF0 */
/* MID_MSGT_XXX_SBX_STEREO_SEL=         0x06    / * stereo selector (WR/RD)     */ /* 0xF0, 0x00 */
/* MID_MSGT_SBX_MONO_SEL=               0x07    / * mono selector (WR/RD)       */ /* 0xF0 */
/* MID_MSGT_SBX_MONO_SPK_AMP=           0x08    / * mono speaker-amp (WR/RD)        */ /* 0xF0 */
/* MID_MSGT_XXX_SBX_MAN_XXX_SEL=        0x0A    / * manual XXX selectors (WR/RD)    */ /* 0xF0, 0x00 */
/* MID_MSGT_SBX_MONO_SIDETONE=          0x0B    / * mono sidetone (WR/RD)       */ /* 0xF0 */
/* MID_MSGT_SBX_HS_STATUS=              0x0C    / * HS status (WR/RD)           */ /* 0xF0 */
/* MID_MSGT_XXX_SBX_STEREO_SPK_MUTE=    0x0D    / * stereo SPK mute (WR/RD)     */ /* 0xF0, 0x00 */
/* MID_MSGT_XXX_SBX_KEY_STATUS=         0x0E    / * SBX-keys status (RD)            */ /* 0xF0, 0x00 */
/* MID_MSGT_XXX_SBX_HFREE_MIC_BUF_GAIN= 0x0F    / * handsfree MIC-buffer gain   */ /* 0xF0, 0x00 */
/* MID_MSGT_XXX_SBX_COM=                0x13    / * forward COM-data                */ /* 0xF0 */
/* MID_MSGT_SBX_A_POWER=                0x15    / * ANALOG-POWER control            */ /* 0xF0 */
/* MID_MSGT_SBX_TOUCH_DISABLE=          0x16    / * touch-disable control (WR/RD)*/ /* 0xF0 */


// BF07 internal definitions

/* MID_MSGT_XXX_SBX_STEREO_SEL */
#define BF07_MID_MSGT_XXX_SBX_STEREO_SEL_PARAM_LEN          0x02    // (1 byte for CMD and 1 byte for parameters)
#define BF07_MID_MSGT_XXX_SBX_STEREO_SEL_DEF_PARAMS         {MID_MSGT_XXX_SBX_STEREO_SEL, 0x7F} // init value for array of parameters, all VOID
// command doesn't check for response buffer length, so to be future-proof we need to reserve a bit more space until the command is improved
#define BF07_MID_MSGT_XXX_SBX_STEREO_SEL_RESPONSE_LEN       0x03+0x7F // (1 byte for CMD and 2 bytes for parameters + 128 bytes just in case)
#define BF07_MID_MSGT_XXX_SBX_STEREO_SEL_PARAM_LEN_RESP     0x01    // Reading current/init parameters requires only command code to be sent
#define BF07_MID_MSGT_XXX_SBX_STEREO_SEL_DEF_PARAMS_RESP    {MID_MSGT_XXX_SBX_STEREO_SEL}

// showing microphone signal on VU meter
#define BF07_VU_MIC_VOID            0x3F
#define BF07_VU_MIC_MASK            0x03

// VU meter scenario
#define BF07_VU_SPK_VOID            0x3F
#define BF07_VU_SPK_MASK            0x0C

// Microphone optimal distance
#define BF07_MIC_PREAMP_VOID        0xFF
#define BF07_ECHO_ATT_OFFSET_VOID   0xFF
#define BF07_MIC_FLAG_SET_INIT      0x80

// Echo control
#define BF07_EC_VOID                0x3F
#define BF07_EC_MASK                0x70        // also reading bit 6, echo detected?

// Internal functions ( for key emulation )
#define INT_FN_MUTE_HF_KEY          0x01
#define INT_FN_MUTE_HS_KEY          0x02
#define INT_FN_HOOK_KEY             0x03
#define INT_FN_HF_OVER_HS_KEY       0x04

// PTT LED controll - internally used
#define PTT_LED_VOID                0xFF


// BF07 internal functions

int intFn_BF07_SetMicOnVUState(TiproHidDevice *device, int nAddress, int nState, bool bSetInit = false);
int intFn_BF07_GetMicOnVUState(TiproHidDevice *device, int nAddress, int *nState, int *nInitState = nullptr);

int intFn_BF07_SetVUCScenario(TiproHidDevice *device, int nAddress, int nScenario, bool bSetInit = false);
int intFn_BF07_GetVUCScenario(TiproHidDevice *device, int nAddress, int *nScenario, int *nInitScenario = nullptr);

int intFn_BF07_SetMicrophoneLevel(TiproHidDevice *device, int nAddress, int nLevel, int nDevice = BF07_DEVICE_HANDSFREE_HANDSET, bool bSetInit = false);
int intFn_BF07_GetMicrophoneLevel(TiproHidDevice *device, int nAddress, int *nLevel, int nDevice = BF07_DEVICE_HANDSFREE, int *nInitLevel = nullptr);

int intFn_BF07_SetMicrophoneOptimalDistance(TiproHidDevice *device, int nAddress, int nDistance, int nDevice = BF07_DEVICE_HANDSFREE_HANDSET, bool bSetInit = false);
int intFn_BF07_GetMicrophoneOptimalDistance(TiproHidDevice *device, int nAddress, int *nDistance, int nDevice = BF07_DEVICE_HANDSFREE, int *nInitDistance = nullptr);

int intFn_BF07_SetMicrophoneCompression(TiproHidDevice *device, int nAddress, int nCompression, int nDevice = BF07_DEVICE_HANDSFREE_HANDSET, bool bSetInit = false);
int intFn_BF07_GetMicrophoneCompression(TiproHidDevice *device, int nAddress, int *nCompression, int nDevice = BF07_DEVICE_HANDSFREE, int *nInitCompression = nullptr);

int intFn_BF07_SetMicrophoneThreshold(TiproHidDevice *device, int nAddress, int nThreshold, int nDevice = BF07_DEVICE_HANDSFREE_HANDSET, bool bSetInit = false);
int intFn_BF07_GetMicrophoneThreshold(TiproHidDevice *device, int nAddress, int *nThreshold, int nDevice = BF07_DEVICE_HANDSFREE, int *nInitThreshold = nullptr);

int intFn_BF07_SetEcho(TiproHidDevice *device, int nAddress, int nMode, bool bSetInit = false);
int intFn_BF07_GetEcho(TiproHidDevice *device, int nAddress, int *nMode, int *nInitMode = nullptr);

int intFn_BF07_SetSidetone(TiproHidDevice *device, int nAddress, bool bOn, int nLevel = BF07_SIDETONE_ILLEGAL, bool bSetInit = false);
int intFn_BF07_SetSidetoneLevel(TiproHidDevice *device, int nAddress, int nLevel, bool bSetInit = false);
int intFn_BF07_GetSidetoneLevel(TiproHidDevice *device, int nAddress, int *nLevel, int *nInitLevel = nullptr);

int intFn_BF07_TouchDisable(TiproHidDevice *device, int nAddress, bool bDisable=true);

int intFn_BF07_EmulateKey(TiproHidDevice *device, int nAddress, int nKeyFn, bool bKeyPress=true);
int intFn_BF07_ReleaseEmulatedKeys(TiproHidDevice *device, int nAddress);

int intFn_BF07_SetPTTLed(TiproHidDevice *device, int nAddress, int nMode, int nTBlinkA = 0, int nTBlinkB = 0, bool bSetInit = false);
int intFn_BF07_GetPTTLed(TiproHidDevice *device, int nAddress, int *nMode, int *nTBlinkA = nullptr, int *nTBlinkB = nullptr);

/* TODO: Tasks 153, 155, 157 */
int intFn_BF07_SetHandsetSpeakerLevel(TiproHidDevice *device, int nAddress, int nLevel, bool bSetInit = false);
int intFn_BF07_GetHandsetSpeakerLevel(TiproHidDevice *device, int nAddress, int *nLevel, int *nInitLevel = nullptr);
int intFn_BF07_SetMonoSpeakerMode(TiproHidDevice *device, int nAddress, int nMode, bool bSetInit = false);
int intFn_BF07_GetMonoSpeakerMode(TiproHidDevice *device, int nAddress, int *nMode, int *nInitMode = nullptr);

// Internal functions from FW documentation
#if 0

// MID_MSGT_SBX_LED_CTRL 0x00, 0x00
// One simple command for "changing mode" of each LED
int intFn_BF07_SetLEDMode(TiproHidDevice *device, int nAddress, int nKey, int nMode);
int intFn_BF07_GetLEDMode(TiproHidDevice *device, int nAddress, int nKey, int *nMode);
// nMode =
#define BF07_KEYLED_MODE_OFF                0x00
#define BF07_KEYLED_MODE_ON                 0x01
#define BF07_KEYLED_MODE_BLINK              0x02
#define BF07_KEYLED_MODE_BLINK_INV          0x03
// for hardware with both RED and GREEN additional modes are defined
// combination of both is currently not allowed (but prepared for future)
#define BF07_KEYLED_2_MODE_ON               0x10
#define BF07_KEYLED_2_MODE_BLINK            0x20
#define BF07_KEYLED_2_MODE_BLINK_INV        0x30

// One command that can change all LEDs at once
int intFn_BF07_SetLEDStateEx(TiproHidDevice *device, int nAddress, int nMask, int nState, int nBlink);
int intFn_BF07_GetLEDStateEx(TiproHidDevice *device, int nAddress, int *nState, int *nBlink);

// nMask, nState, nBlink:
#define BF07_KEYLED_01                      0x0001
#define BF07_KEYLED_02                      0x0002
#define BF07_KEYLED_03                      0x0004
#define BF07_KEYLED_04                      0x0008
#define BF07_KEYLED_05                      0x0010
#define BF07_KEYLED_06                      0x0020
#define BF07_KEYLED_PTT                     0x0040

#define BF07_KEYLED_2_01                    0x0100
#define BF07_KEYLED_2_02                    0x0200
#define BF07_KEYLED_2_03                    0x0400
#define BF07_KEYLED_2_04                    0x0800
#define BF07_KEYLED_2_05                    0x1000
#define BF07_KEYLED_2_06                    0x2000

// Command for controlling PTT LED
int intFn_BF07_SetPTTLEDState(TiproHidDevice *device, int nAddress, int nMode);
int intFn_BF07_GetPTTLEDState(TiproHidDevice *device, int nAddress, int *nMode);

// Commands for setting blinking rate
int intFn_HIDSetSbxLEDBlinkSpeed(TiproHidDevice *device, int nAddress, int nTBlinkA, int nTBlinkB);
int intFn_HIDGetSbxLEDBlinkSpeed(TiproHidDevice *device, int nAddress, int *nTBlinkA, int *nTBlinkB);

// RFU: Commands for MIC, HS_STATUS LEDs
int intFn_BF07_SetMicLEDMode(TiproHidDevice *device, int nAddress, int nMode);
int intFn_BF07_GetMicLEDMode(TiproHidDevice *device, int nAddress, int *nMode);
int intFn_BF07_SetHSStatusLEDMode(TiproHidDevice *device, int nAddress, int nMode);
int intFn_BF07_GetHSStatusLEDMode(TiproHidDevice *device, int nAddress, int *nMode);

#endif