PebbleOS
Loading...
Searching...
No Matches
Data Structures | Enumerations | Variables
Get bytes protocol

Get bytes endpoint messages. More...

Data Structures

struct  GetBytesHeader
 Header of every request and response. More...
 
struct  GetBytesFileHeader
 GET_BYTES_CMD_GET_FILE request. More...
 
struct  GetBytesFlashHeader
 GET_BYTES_CMD_GET_FLASH request. More...
 
struct  GetBytesRspObjectInfo
 GET_BYTES_CMD_OBJECT_INFO response. More...
 
struct  GetBytesRspObjectData
 GET_BYTES_CMD_OBJECT_DATA response. More...
 
struct  GetBytesErrorResponse
 Error response sent asynchronously. More...
 

Enumerations

enum  GetBytesCmd {
  GET_BYTES_CMD_GET_COREDUMP = 0 , GET_BYTES_CMD_OBJECT_INFO = 1 , GET_BYTES_CMD_OBJECT_DATA = 2 , GET_BYTES_CMD_GET_FILE = 3 ,
  GET_BYTES_CMD_GET_FLASH = 4 , GET_BYTES_CMD_GET_NEW_COREDUMP = 5
}
 Get bytes commands. More...
 

Variables

static const uint16_t GET_BYTES_ENDPOINT_ID = 9000
 Get bytes endpoint ID.
 

Detailed Description

Get bytes endpoint messages.


Data Structure Documentation

◆ GetBytesHeader

struct GetBytesHeader

Header of every request and response.

Data Fields
uint8_t cmd_id Command, a GetBytesCmd value.
uint8_t transaction_id Transaction ID chosen by the phone, echoed in responses.

◆ GetBytesFileHeader

struct GetBytesFileHeader
Data Fields
char filename[] NUL-terminated file name.
uint8_t filename_len Length of filename, excluding the terminating NUL.
GetBytesHeader hdr Header.

◆ GetBytesFlashHeader

struct GetBytesFlashHeader
Data Fields
GetBytesHeader hdr Header.
uint32_t len Length in bytes.
uint32_t start_addr Flash address.

◆ GetBytesRspObjectInfo

struct GetBytesRspObjectInfo
Data Fields
uint8_t error_code A GetBytesInfoErrorCode; data responses follow only for GET_BYTES_OK.
GetBytesHeader hdr Header.
uint32_t num_bytes Total object size in bytes, 0 on error.

◆ GetBytesRspObjectData

struct GetBytesRspObjectData
Data Fields
uint32_t byte_offset Offset of data in the object.
uint8_t data[] Object data.
GetBytesHeader hdr Header.

◆ GetBytesErrorResponse

struct GetBytesErrorResponse

Error response sent asynchronously.

Data Fields
GetBytesInfoErrorCode result Error code.
CommSession * session Session to reply on.
int8_t transaction_id Transaction ID of the request.

Enumeration Type Documentation

◆ GetBytesCmd

Get bytes commands.

Enumerator
GET_BYTES_CMD_GET_COREDUMP 

Request the most recent core dump; the request is a bare GetBytesHeader.

GET_BYTES_CMD_OBJECT_INFO 

Response with the object size or an error, see GetBytesRspObjectInfo.

GET_BYTES_CMD_OBJECT_DATA 

Response with object data, see GetBytesRspObjectData.

GET_BYTES_CMD_GET_FILE 

Request a file, see GetBytesFileHeader.

GET_BYTES_CMD_GET_FLASH 

Request a flash region, see GetBytesFlashHeader.

GET_BYTES_CMD_GET_NEW_COREDUMP 

Request the most recent core dump only if it has not been read yet.

Variable Documentation

◆ GET_BYTES_ENDPOINT_ID

const uint16_t GET_BYTES_ENDPOINT_ID = 9000
static

Get bytes endpoint ID.