src/protocol.h

   1 ///
   2 /// \file       protocol.h
   3 ///             USB Blackberry bulk protocol API constants
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2009, Net Direct Inc. (http://www.netdirect.ca/)
   8
   9     This program is free software; you can redistribute it and/or modify
  10     it under the terms of the GNU General Public License as published by
  11     the Free Software Foundation; either version 2 of the License, or
  12     (at your option) any later version.
  13
  14     This program is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  17
  18     See the GNU General Public License in the COPYING file at the
  19     root directory of this project for more details.
  20 */
  21
  22 #ifndef __BARRY_PROTOCOL_H__
  23 #define __BARRY_PROTOCOL_H__
  24
  25 // packet commands (Packet.command: has response codes too)
  26 #define SB_COMMAND_ECHO                 0x01
  27 #define SB_COMMAND_ECHO_REPLY           0x02
  28 #define SB_COMMAND_RESET                0x03
  29 #define SB_COMMAND_RESET_REPLY          0x04
  30 #define SB_COMMAND_FETCH_ATTRIBUTE      0x05
  31 #define SB_COMMAND_FETCHED_ATTRIBUTE    0x06
  32 #define SB_COMMAND_SELECT_MODE          0x07
  33 #define SB_COMMAND_MODE_SELECTED        0x08
  34 #define SB_COMMAND_OPEN_SOCKET          0x0a
  35 #define SB_COMMAND_CLOSE_SOCKET         0x0b
  36 #define SB_COMMAND_CLOSED_SOCKET        0x0c
  37 #define SB_COMMAND_PASSWORD_CHALLENGE   0x0e
  38 #define SB_COMMAND_PASSWORD             0x0f
  39 #define SB_COMMAND_OPENED_SOCKET        0x10
  40 #define SB_COMMAND_PASSWORD_FAILED      0x11
  41 #define SB_COMMAND_SEQUENCE_HANDSHAKE   0x13
  42 #define SB_COMMAND_DB_DATA              0x40
  43 #define SB_COMMAND_DB_FRAGMENTED        0x60
  44 #define SB_COMMAND_DB_DONE              0x41
  45
  46 // JavaLoader commands
  47 #define SB_COMMAND_JL_HELLO             0x64    // This could be a general ACK in both directions
  48 #define SB_COMMAND_JL_HELLO_ACK         0x65    // From device after host HELLO
  49 #define SB_COMMAND_JL_GOODBYE           0x8d
  50 #define SB_COMMAND_JL_SET_UNKNOWN1      0x70    // Initial sequence, 0
  51 #define SB_COMMAND_JL_SET_COD_FILENAME  0x80
  52 #define SB_COMMAND_JL_SET_COD_SIZE      0x67    // Always big endian
  53 #define SB_COMMAND_JL_SEND_DATA         0x68
  54 #define SB_COMMAND_JL_SET_TIME          0x7c
  55 #define SB_COMMAND_JL_GET_SCREENSHOT    0x87
  56 #define SB_COMMAND_JL_DEVICE_INFO       0x71
  57 #define SB_COMMAND_JL_OS_METRICS        0x78
  58 #define SB_COMMAND_JL_BOOTROM_METRICS   0x79
  59 #define SB_COMMAND_JL_GET_DIRECTORY     0x6d
  60 #define SB_COMMAND_JL_GET_DATA_ENTRY    0x6e    // Used for both DIR and SCREENSHOT
  61 #define SB_COMMAND_JL_GET_SUBDIR        0x7f
  62 #define SB_COMMAND_JL_GET_SUBDIR_ENTRY  0x7d
  63 #define SB_COMMAND_JL_ERASE             0x69
  64 #define SB_COMMAND_JL_FORCE_ERASE       0x7b
  65 #define SB_COMMAND_JL_UNKNOWN3          0x63
  66 #define SB_COMMAND_JL_GET_LOG           0x73
  67 #define SB_COMMAND_JL_GET_LOG_ENTRY     0x74
  68 #define SB_COMMAND_JL_CLEAR_LOG         0x88
  69 #define SB_COMMAND_JL_SAVE_MODULE       0x7e
  70 #define SB_COMMAND_JL_WIPE_APPS         0x6a
  71 #define SB_COMMAND_JL_WIPE_FS           0x6b
  72 #define SB_COMMAND_JL_LOG_STRACES       0x8e
  73 #define SB_COMMAND_JL_RESET_FACTORY     0x91
  74
  75 // JavaLoader response
  76 #define SB_COMMAND_JL_ACK               0x64
  77 #define SB_COMMAND_JL_READY             0x01
  78 #define SB_COMMAND_JL_RESET_REQUIRED    0x78    // Occurs after GOODBYE when handheld reset is required
  79 #define SB_COMMAND_JL_COD_IN_USE        0x6c    // Perhaps "BUSY" is also a good name?
  80 #define SB_COMMAND_JL_COD_NOT_FOUND     0x69
  81 #define SB_COMMAND_JL_NOT_SUPPORTED     0x71    // Occurs when device does not support a command
  82
  83 // JavaLoader data
  84 #define SB_DATA_JL_SUCCESS              0x64    // Device has accepted the data packet
  85 #define SB_DATA_JL_INVALID              0x68    // Device returns this code if the application isn't valid.
  86
  87
  88 // JavaDebug commands
  89 #define SB_COMMAND_JD_UNKNOWN01         0x53
  90 #define SB_COMMAND_JD_UNKNOWN02         0x01
  91 #define SB_COMMAND_JD_UNKNOWN03         0x6f
  92 #define SB_COMMAND_JD_UNKNOWN04         0x8a
  93 #define SB_COMMAND_JD_UNKNOWN05         0x90
  94 #define SB_COMMAND_JD_UNKNOWN06         0x44
  95 #define SB_COMMAND_JD_UNKNOWN07         0x45
  96 #define SB_COMMAND_JD_UNKNOWN08         0x54
  97 #define SB_COMMAND_JD_UNKNOWN09         0x33
  98 #define SB_COMMAND_JD_UNKNOWN10         0x46
  99
 100 #define SB_COMMAND_JD_UNKNOWN11         0x0e
 101 #define SB_COMMAND_JD_UNKNOWN12         0x50
 102 #define SB_COMMAND_JD_UNKNOWN13         0x0d
 103 #define SB_COMMAND_JD_UNKNOWN14         0x85
 104 #define SB_COMMAND_JD_UNKNOWN15         0x84
 105
 106 #define SB_COMMAND_JD_GET_MODULES_LIST  0x8d    // Get all Java modules list with their address and ID
 107 #define SB_COMMAND_JD_GET_THREADS_LIST  0x08    // Get all threads currently running in the virtual machine
 108 #define SB_COMMAND_JD_GET_CONSOLE_MSG   0x40    // Get console message
 109 #define SB_COMMAND_JD_GO                0x02    // Go
 110 #define SB_COMMAND_JD_GET_STATUS                0x06    // Get status
 111 #define SB_COMMAND_JD_SET_BREAKPOINT    0x21    // Set breakpoint
 112 #define SB_COMMAND_JD_RM_BREAKPOINT     0x22    // Remove breakpoint
 113
 114 // JavaDebug response
 115 #define SB_COMMAND_JD_GET_DATA_ENTRY    0x06
 116
 117
 118 // mode constants
 119 #define SB_MODE_REQUEST_SOCKET          0x00ff
 120
 121
 122 // object and attribute ID codes (for ZeroPacket::GetAttribute())
 123 // meanings for most of these are unknown
 124 #define SB_OBJECT_INITIAL_UNKNOWN               0x14
 125 #define         SB_ATTR_INITIAL_UNKNOWN         0x01
 126 #define SB_OBJECT_PROFILE                       0x08
 127 #define         SB_ATTR_PROFILE_DESC            0x02
 128 #define         SB_ATTR_PROFILE_PIN             0x04
 129 #define SB_OBJECT_SOCKET_UNKNOWN                0x04
 130
 131
 132 // param command parameters
 133 //#define SB_PARAM_DEFAULT              0xff
 134
 135
 136 // DB Operation Command
 137 #define SB_DBOP_SET_RECORD              0x41
 138 #define SB_DBOP_CLEAR_DATABASE          0x43
 139 #define SB_DBOP_GET_DBDB                0x4a
 140 #define SB_DBOP_OLD_GET_DBDB            0x4c
 141 #define SB_DBOP_GET_COUNT               0x4e
 142 #define SB_DBOP_GET_RECORDS             0x4f
 143 #define SB_DBOP_OLD_GET_RECORDS         0x42
 144 #define SB_DBOP_OLD_GET_RECORDS_REPLY   0x44
 145
 146 #define SB_DBOP_GET_RECORD_STATE_TABLE  0x53    // replies with 0x60, 0x41
 147 #define SB_DBOP_SET_RECORD_FLAGS        0x54    // replies with 0x41
 148                                                 // used to clear dirty flag
 149 #define SB_DBOP_GET_RECORD_BY_INDEX     0x46    // replies with 0x44
 150         // John's device uses 0x50, with a reply of 0x4f (!)
 151         // Then uses 0x55 as usual
 152         // Delete uses 0x50/0x4f to check as well, then uses 0x52 as
 153         // usual to do the actual delete.
 154 #define SB_DBOP_SET_RECORD_BY_INDEX     0x55    // replies with 0x41
 155 #define SB_DBOP_DELETE_RECORD_BY_INDEX  0x52    // intellisync does a GET(0x46)
 156                                                 // first, probably to make sure
 157                                                 // it has the right data and
 158                                                 // record
 159
 160 #endif
 161