JSAPI.h

Go to the documentation of this file.

#pragma once
#include <windows.h>


#ifdef __cplusplus
extern "C" {
#endif

#define GPS_EVENT_DEFAULT_NAME     L"JS_GPS_1HZ_SIGNAL"

#define DOCK_EVENT_NAME L"JS_DOCK_EVENT"

DWORD JSGetAmbientTemp(DWORD * pdwTemp);


typedef struct
{
    WORD Battery1_TotalCapacity;    // Total mAh capacity
    WORD Battery2_TotalCapacity;

    WORD Battery1_Voltage;          // Voltage in milli-Volts (mV)
    WORD Battery2_Voltage;

    INT16 Battery1_Current;         // Average battery current
    INT16 Battery2_Current;         // Average battery current

    WORD Battery_Interval;          // How often (ms) this information is refreshed

    INT16 Battery1_Temperature;     // Tenths degrees C
    INT16 Battery2_Temperature;

    BYTE Battery1_Percentage;       // Discharge and temperature compensated
    BYTE Battery2_Percentage;       // state if charge.  (100 == fully charged)

    BYTE Battery_Flags;             // Flags to indicate if batteries are
                                    // present or charging - see defines below
                                    // for corresponding bits

    BYTE Reserved;                  // To make the structure WORD aligned
} TK6000_BATTERY_INFO;

// TK6000 Battery_Flags defines
#define BATTERY_1_PRESENT   0x08
#define BATTERY_1_CHARGING  0x04
#define BATTERY_2_PRESENT   0x02
#define BATTERY_2_CHARGING  0x01


typedef struct
{
    // battery charge level (in percent) 0% means empty, 100% means full
    WORD Battery1_Percentage;
    WORD Battery2_Percentage;

    // battery voltage (in millivolts)
    WORD Battery1_Voltage;
    WORD Battery2_Voltage;

    // battery current flow (in milliamps) 
    //  negative current means it is discharging
    INT16 Battery1_Current;
    INT16 Battery2_Current;

    // battery temperature (in 0.1 degrees Celsius)
    INT16 Battery1_Temperature;
    INT16 Battery2_Temperature;

    // estimated Time To Full at current charge rate (in minutes)
    WORD Battery1_TimeToFull;
    WORD Battery2_TimeToFull;

    // estimated Time To Empty at the current discharge rate (in minutes)
    WORD Battery1_TimeToEmpty;
    WORD Battery2_TimeToEmpty;

    // battery status flags
    DWORD Battery_Flags;    //  Bits:
                            //   7-0: Reserved
                            //     8: External Power Present
                            //     9: Battery 1 Present
                            //    10: Battery 2 Present
                            //    11: External Power Connected
                            //    12: Battery 1 Connected
                            //    13: Battery 2 Connected
                            //    14: Battery 1 Charging
                            //    15: Battery 2 Charging
                            // 19-16: Reserved
                            //    20: Battery 1 BQ chip is communicating correctly
                            //    21: Battery 2 BQ chip is communicating correctly
                            // 24-22: Reserved
                            //    25: Battery 1 is OK to charge
                            //    26: Battery 2 is OK to charge
                            //    27: Battery 1 Charge Erorr - too hot, cold, or timed out
                            //    28: Battery 2 Charge Erorr - too hot, cold, or timed out
                            // 31-29: Reserved

} MESA_BATTERY_INFO;

// Mesa Battery Flag Defines
#define MESA_STATUS_EXT_POWER_PRESENT       0x00000100
#define MESA_STATUS_BAT1_PRESENT            0x00000200
#define MESA_STATUS_BAT2_PRESENT            0x00000400
#define MESA_STATUS_EXT_POWER_CONNECTED     0x00000800
#define MESA_STATUS_BAT1_CONNECTED          0x00001000
#define MESA_STATUS_BAT2_CONNECTED          0x00002000
#define MESA_STATUS_BAT1_CHARGING           0x00004000
#define MESA_STATUS_BAT2_CHARGING           0x00008000
#define MESA_STATUS_BAT1_BQ_OK              0x00100000
#define MESA_STATUS_BAT2_BQ_OK              0x00200000
#define MESA_STATUS_BAT1_OK_TO_CHARGE       0x02000000
#define MESA_STATUS_BAT2_OK_TO_CHARGE       0x04000000
#define MESA_STATUS_BAT1_CHARGE_ERROR       0x08000000
#define MESA_STATUS_BAT2_CHARGE_ERROR       0x10000000



typedef struct
{
    WORD  Battery_Voltage;      // Voltage in milli-Volts (mV)
    INT16 Battery_Current;      // Average battery current (positive is
                                // charging, negative is discharging)
    WORD  Battery_Interval;     // How often (ms) this information is refreshed
    INT16 Battery_Temperature;  // Tenths degrees C
    WORD  Battery_Capacity;     // mAh as entered by the user
    BYTE  Battery_Percentage;   // Percentage charged
    BYTE  Battery_Flags;        // Flags for chemistry, charging, and if the
                                //    battery is present - see defines below
                                //    for corresponding bits
} ALLEGRO_BATTERY_INFO;

// Battery_Flags defines
#define BATTERY_CHARGEKNOWN     0x10 // This is set if the charge percentage is
                                     // known.
#define BATTERY_PRESENT         0x08
#define BATTERY_CHARGING        0x04
#define BATTERY_ALKALINE        0x02 // This is set if an alkaline battery is installed
#define BATTERY_VEHICLEMODE     0x01 // This is set if in vehicle charge mode


#define ARCHER_BATTERY_INFO ALLEGRO_BATTERY_INFO

DWORD JSGetBatteryStatus(VOID * pBattInfo, DWORD * pdwSize);


DWORD JSGetDisplayType(DWORD * pdwDispType);


DWORD JSGetPlatformName(TCHAR * szDeviceString, DWORD * pdwLen);


#define BLUETOOTH_NOT_PRESENT   0
#define BLUETOOTH_921600        1
#define BLUETOOTH_115200        2

typedef struct
{
    DWORD dwBluetoothHardware;
    DWORD dwWiFiHardware;
} JS_RADIO_INFO;

typedef struct
{
    DWORD dwBluetoothHardware;
    DWORD dwWiFiHardware;
    DWORD dwCellHardware;
    DWORD dwGPSHardware;
} JS_EXP_RADIO_INFO;

DWORD JSGetRadioInfo(VOID * pRadioInfo, DWORD * pdwSize);


DWORD JSGetSerialNumber(TCHAR * szSerialString, DWORD * pdwLen);


#define PWR_SUSPEND             1
#define PWR_RESET               2
#define PWR_POWER_OFF           3
#define PWR_CLEAN_BOOT_ROOT     4
#define PWR_CLEAN_BOOT_STORAGE  5
#define PWR_CLEAN_BOOT_REGISTRY 6
#define PWR_CLEAN_BOOT_ALL      7

DWORD JSSetPower(DWORD dwPowerCode);

#define POWER_CURRENT   0
#define POWER_BATTERY   1
#define POWER_EXTERNAL  2

DWORD JSGetBacklightBrightness(DWORD * pdwLCDBright, DWORD dwPower);


DWORD JSSetBacklightBrightness(DWORD dwLCDBright, DWORD dwPower);


DWORD JSGetBacklightState(DWORD * pdwEnable);


DWORD JSSetBacklightState(DWORD dwEnable);


DWORD JSGetBluetoothOverrideState(DWORD * pdwEnable);


DWORD JSSetBluetoothOverrideState(DWORD dwEnable);


DWORD JSGetContrast(DWORD * pdwContrast);


DWORD JSSetContrast(DWORD dwContrast);


DWORD JSGetExpansionPower(DWORD * pdwOn);


DWORD JSSetExpansionPower(DWORD dwOn);


DWORD JSGetExp2GPIOWakeSource(DWORD * pdwEnable);


DWORD JSSetExp2GPIOWakeSource(DWORD dwEnable);

#define MESA_EXP_GPIO_0     0x00000001      //41  (1:9)
#define MESA_EXP_GPIO_1     0x00000002      //42  (1:10)
#define MESA_EXP_GPIO_2     0x00000004      //43  (1:11)
#define MESA_EXP_GPIO_3     0x00000008      //44  (1:12)
#define MESA_EXP_GPIO_4     0x00000010      //45  (1:13)
#define MESA_EXP_GPIO_5     0x00000020      //46  (1:14)
#define MESA_EXP_GPIO_6     0x00000040      //47  (1:15)
#define MESA_EXP_GPIO_7     0x00000080      //48  (1:16)
#define MESA_EXP_GPIO_8     0x00000100      //87  (2:23)
#define MESA_EXP_GPIO_9     0x00000200      //89  (2:25)
#define MESA_EXP_GPIO_10    0x00000400      //90  (2:26)
#define MESA_EXP_GPIO_11    0x00000800      //91  (2:27)
#define MESA_EXP_GPIO_12    0x00001000      //92  (2:28)
#define MESA_EXP_GPIO_13    0x00002000      //109 (3:13)
#define MESA_EXP_GPIO_14    0x00004000      //110 (3:14)
#define MESA_EXP_GPIO_15    0x00008000      //111 (3:15)
#define MESA_EXP_GPIO_16    0x00010000      //112 (3:16)

#define MESA_COM1_RXD   MESA_EXP_GPIO_0     //41  (1:9)
#define MESA_COM1_TXD   MESA_EXP_GPIO_1     //42  (1:10)
#define MESA_COM1_CTS   MESA_EXP_GPIO_2     //43  (1:11)
#define MESA_COM1_DCD   MESA_EXP_GPIO_3     //44  (1:12)
#define MESA_COM1_DSR   MESA_EXP_GPIO_4     //45  (1:13)
#define MESA_COM1_RI    MESA_EXP_GPIO_5     //46  (1:14)
#define MESA_COM1_DTR   MESA_EXP_GPIO_6     //47  (1:15)
#define MESA_COM1_RTS   MESA_EXP_GPIO_7     //48  (1:16)
#define MESA_GPIO_FLASH MESA_EXP_GPIO_8     //87  (2:23)
#define MESA_SPI_CLK    MESA_EXP_GPIO_9     //89  (2:25)
#define MESA_SPI_CSB    MESA_EXP_GPIO_10    //90  (2:26)
#define MESA_SPI_MOSI   MESA_EXP_GPIO_11    //91  (2:27)
#define MESA_SPI_MISO   MESA_EXP_GPIO_12    //92  (2:28)
#define MESA_COM3_RTS   MESA_EXP_GPIO_13    //109 (3:13)
#define MESA_COM3_RXD   MESA_EXP_GPIO_14    //110 (3:14)
#define MESA_COM3_TXD   MESA_EXP_GPIO_15    //111 (3:15)
#define MESA_COM3_CTS   MESA_EXP_GPIO_16    //112 (3:16)

#define MESA_COM1_MASK  0x000000FF
#define MESA_SPI_MASK   0x00001E00
#define MESA_COM3_MASK  0x0001E000
#define MESA_GPIO_MASK  0x0001FFFF

#define MESA_NUM_GPIO 17

// Pull defines for Mesa
#define GPIO_PULL_DEFAULT        0x0000
#define GPIO_PULL_NEITHER        0x8000
#define GPIO_PULL_DOWN           0xA000
#define GPIO_PULL_UP             0xC000
#define GPIO_PULL_MASK           0xE000

// Suspend defines for Mesa
#define GPIO_SUSPEND_INPUT       0x280
#define GPIO_SUSPEND_OUTPUT_LO   0x200
#define GPIO_SUSPEND_OUTPUT_HI   0x300
#define GPIO_SUSPEND_KEEPER      0x380
#define GPIO_SUSPEND_MASK        0x380

// IRQ edge defines for Mesa, Archer2, and Allegro2
#define EXP_IRQ_EDGE_RISE       0x0010
#define EXP_IRQ_EDGE_FALL       0x0020
#define EXP_IRQ_EDGE_BOTH       0x0030
#define EXP_IRQ_EDGE_NONE       0x0040
#define EXP_IRQ_EDGE_MASK       0x0070

// Pull defines for Archer2 and Allegro2
#define EXP_PULL_NONE                   0
#define EXP_PULL_KEEPER                 0x80    // Keeper will apply a pull in the same direction as it is being driven
#define EXP_PULL_DOWN_360K              0xC0
#define EXP_PULL_UP_100K                0xE0
#define EXP_PULL_UP_75K                 0xD0
#define EXP_PULL_UP_22K                 0xF0

// Suspend defines for Archer2 and Allegro2
#define EXP_SUSPEND_STATE_KEEPER        0   // Keep the same state it is in for suspend
#define EXP_SUSPEND_STATE_OUT_LOW       1   // Turn into GPIO mode and drive out low
#define EXP_SUSPEND_STATE_OUT_HIGH      2   // Turn into GPIO mode and drive out high
#define EXP_SUSPEND_STATE_IN_PNONE      3   // Turn into GPIO mode, input, no pullup or pulldown
#define EXP_SUSPEND_STATE_IN_PKEEP      4   // Turn into GPIO mode, input, using pull keeper
#define EXP_SUSPEND_STATE_IN_360K_PD    5   // Turn into GPIO mode, input, using 360K pull down
#define EXP_SUSPEND_STATE_IN_75K_PU     6   // Turn into GPIO mode, input, using 75K pull up
#define EXP_SUSPEND_STATE_IN_100K_PU    7   // Turn into GPIO mode, input, using 100K pull up
#define EXP_SUSPEND_STATE_IN_22K_PU     8   // Turn into GPIO mode, input, using 22K pull up

// Exp_GPIO_15 is the one and only GPIO that JSAPI can use to control
// interrupts and wake sources.  Others can be used with direct IOCTLs to the
// Expansion Driver.
#define EXP_GPIO_INTR_AND_WAKE  15


DWORD JSGetGPIO(DWORD * pdwGPIOLevel);


DWORD JSSetGPIO(DWORD dwGPIOLevel, DWORD dwMask);


DWORD JSGetGPIODirection(DWORD * pdwGPIODirection);


DWORD JSSetGPIODirection(DWORD dwGPIODirection, DWORD dwMask);


#define VK_OEM_F1  0xE9
#define VK_OEM_F2  0xEA
#define VK_OEM_F3  0xEB
#define VK_OEM_F4  0xEC
#define VK_OEM_F5  0xED
#define VK_OEM_F6  0xEE
#define VK_OEM_F7  0xEF
#define VK_OEM_F8  0xF0
#define VK_OEM_F9  0xF1
#define VK_OEM_F10 0xF2
#define VK_OEM_F11 0xF3
#define VK_OEM_F12 0xF4
#define JS_SHIME_MODE_NONE          0
#define JS_SHIME_MODE_FKEY          1
#define JS_SHIME_MODE_FKEY_LOCK     2

DWORD JSGetKeyboardCustomMode( DWORD *pdwKeyboardMode );


DWORD JSSetKeyboardCustomMode( DWORD dwKeyboardMode );


#define LED_OFF             0x00
#define LED_RED             0x01
#define LED_GREEN           0x02
#define LED_AMBER           0x03
#define LED_BLUE            0x04
#define LED_MESA_MASK       0x06

// JSAPI is considered "user" control
#define LED_A2_GREEN_USER   0x08        // If this bit is set, the Green LED is under USER control (otherwise, internal control)
#define LED_A2_BLUE_USER    0x10        // If this bit is set, the Blue LED is under USER control
#define LED_A2_GREEN_ON     LED_GREEN   // If this bit is set, and the Green LED is under USER control, then the green LED will be on
#define LED_A2_BLUE_ON      LED_BLUE    // If this bit is set, and the Blue LED is under USER control, then the blue LED will be on
#define LED_A2_BLUE_PRIOR   0x20        // If this bit is set, the Blue LED has priority over the green


DWORD JSGetLEDStatus(DWORD * pdwLEDStatus);


DWORD JSSetLEDStatus(DWORD dwLEDStatus);

DWORD JSSetLEDStatusEx(DWORD dwLEDStatus, DWORD dwMask);


DWORD JSGetPort(DWORD dwPortNumber, DWORD * pdwPortValue);


DWORD JSSetPort(DWORD dwPortNumber, DWORD dwPortValue);


// Processor speeds for use with JSGetProcessorSpeed() and JSSetProcessorSpeed()
 
#define PROC_SPEED_208          2
#define PROC_SPEED_312          3    
#define PROC_SPEED_416          4
#define PROC_SPEED_520          5   
#define PROC_SPEED_624          6     
#define PROC_SPEED_PERFORMANCE  97
#define PROC_SPEED_POWER_SAVE   98
#define PROC_SPEED_AUTO         99  
#define PROC_SPEED_AR2_760      760
#define PROC_SPEED_AR2_1000     1000

DWORD JSGetProcessorSpeed(DWORD * pdwProcSpeedCode);


DWORD JSSetProcessorSpeed(DWORD dwProcSpeedCode);

#define GPIO_BIT_RI_POWER 0x40000000

DWORD JSGetRingInPower(DWORD * pdwOn);


DWORD JSSetRingInPower(DWORD dwOn);


DWORD JSGetStickyKeyBrightness(DWORD * pdwKeyBright, DWORD dwPower);


DWORD JSSetStickyKeyBrightness(DWORD dwKeyBright, DWORD dwPower);


DWORD JSGetTouchScreenState(DWORD * pdwEnable);


DWORD JSSetTouchScreenState(DWORD dwEnable);


DWORD JSGetWifiPower(DWORD * pdwState);


DWORD JSSetWifiPower(DWORD dwState);


// Volume ID to be used with JSFormatVolume()
#define VOLUME_MDOC_USER 1

DWORD JSFormatVolume(DWORD dwVolumeId);

typedef struct
{
    BYTE slaveAddress;
    BYTE registerAddress;
    BYTE registerData;
} MESA_I2C_INFO;

typedef struct
{
    BYTE slaveAddress;
    WORD registerAddress;
    BYTE registerData;
} MESA_SCCB_INFO;

DWORD JSGetI2CRegister(VOID * pI2CInfo, DWORD dwSize);

DWORD JSSetI2CRegister(VOID * pI2CInfo, DWORD dwSize);

DWORD JSGetGPIOAltState(DWORD * pdwGPIOAltState);

DWORD JSSetGPIOAltState(DWORD dwGPIOAltState, DWORD dwMask);

DWORD JSGetGPIOPull(DWORD dwGPIO, DWORD * pdwGPIOPullDirection);

DWORD JSSetGPIOPull(DWORD dwGPIO, DWORD dwPullDirection);

DWORD JSGetGPIOSuspend(DWORD dwGPIO, DWORD * pdwSuspendState);

DWORD JSSetGPIOSuspend(DWORD dwGPIO, DWORD dwSuspendState);

DWORD JSGetExpIRQState(DWORD * pdwExpIRQState);

DWORD JSSetExpIRQState(DWORD dwExpIRQState);


typedef struct
{
        DWORD dwModulesPresent;
        TCHAR wszModelNumber[8];
        DWORD dwRamSize;
        DWORD dwStorageSize;
        WCHAR wszBoardRevision[16]; //Change to "wszBoardVersion" for consistency with sys info tree?
        WCHAR wszPICVersion[64];
        WCHAR wszBootloaderVersion[8];
        WCHAR wszOSVersion[64];
        WCHAR wszOSBuildNumber[64];
        DWORD dwLanguageCode;
} MESA_DEVICE_INFO;

typedef struct
{
        DWORD dwModulesPresent;
        TCHAR wszModelNumber[8];
        DWORD dwRamSize;
        DWORD dwStorageSize;
        WCHAR wszBoardRevision[16]; //Change to "wszBoardVersion" for consistency with sys info tree?
        WCHAR wszPICVersion[64];
        WCHAR wszBootloaderVersion[8];
        WCHAR wszOSVersion[64];
        WCHAR wszOSBuildNumber[64];
        DWORD dwLanguageCode;
    WCHAR wczPackageNumber[16];
} A2_JSAPI_DEVICE_INFO;


#define MODULES_PRESENT_BLUETOOTH       0x00000001
#define MODULES_PRESENT_WIFI            0x00000002
#define MODULES_PRESENT_GPS             0x00000004
#define MODULES_PRESENT_CAMERA          0x00000008
#define MODULES_PRESENT_GSM             0x00000010
#define MODULES_PRESENT_FLASH           0x00000020  // Should be set if CAMERA is set
#define MODULES_PRESENT_CDMA            0x00000040


DWORD JSGetDeviceInfo(VOID * pDeviceInfo, DWORD * pdwSize);

#define IRQ_EVENT_DEFAULT_NAME L"EXP_IRQ_EVENT"

DWORD JSInitInterrupt(DWORD dwTrigger);

DWORD JSStopInterrupt();

DWORD JSGetCellModemPower(DWORD * pdwPowerState);

DWORD JSSetCellModemPower(DWORD dwPowerState);

DWORD JSGetDockStatus(BOOL * pfDocked);


#ifdef __cplusplus
}
#endif

---