nRF51 SDK: Defines related to serialized BLE commands.

| nRF51 SDK

- Home
- Related Pages
- API Reference
- Data Structures

All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Macros | Enumerations
Defines related to serialized BLE commands.
BLE Libraries

Defines for serialized BLE commands. More...

## Macros

#define | RPC_PKT_TYPE_POS 0
#define | RPC_PKT_OP_CODE_POS 1
#define | RPC_CMD_OP_CODE_POS 0
#define | RPC_CMD_DATA_POS 1
#define | RPC_CMD_RESP_PKT_TYPE_POS 0
#define | RPC_CMD_RESP_OP_CODE_POS 1
#define | RPC_CMD_RESP_STATUS_POS 2
#define | RPC_DTM_CMD_OP_CODE_POS 0
#define | RPC_DTM_DATA_POS 1
#define | RPC_DTM_RESP_OP_CODE_POS 1
#define | RPC_DTM_RESP_STATUS_POS 2
#define | RPC_BLE_FIELD_LEN 1
#define | RPC_BLE_FIELD_PRESENT 0x01
#define | RPC_BLE_FIELD_NOT_PRESENT 0x00
#define | RPC_ERR_CODE_SIZE 4
#define | BLE_PKT_TYPE_SIZE 1
#define | BLE_OP_CODE_SIZE 1
#define | RPC_BLE_CMD_RESP_PKT_MIN_SIZE 6
#define | RPC_BLE_PKT_MAX_SIZE 596

## Enumerations

enum | ble_rpc_pkt_type_t { BLE_RPC_PKT_CMD, BLE_RPC_PKT_RESP, BLE_RPC_PKT_EVT, BLE_RPC_PKT_DTM_CMD, BLE_RPC_PKT_DTM_RESP, BLE_RPC_PKT_TYPE_MAX }
| The types of packets. More...

## Detailed Description

Defines for serialized BLE commands.

## Macro Definition Documentation

#define BLE_OP_CODE_SIZE 1

Operation code field size in bytes.

#define BLE_PKT_TYPE_SIZE 1

Packet type (ble_rpc_pkt_type_t) field size in bytes.

#define RPC_BLE_CMD_RESP_PKT_MIN_SIZE 6

Minimum length of a command response.

#define RPC_BLE_FIELD_LEN 1

Optional field length size in bytes.

#define RPC_BLE_FIELD_NOT_PRESENT 0x00

Value to indicate that an optional field is not encoded in the serialized packet.

#define RPC_BLE_FIELD_PRESENT 0x01

Value to indicate that an optional field is encoded in the serialized packet, e.g. white list.

#define RPC_BLE_PKT_MAX_SIZE 596

Maximum size for a BLE packet on the HCI Transport layer. This value is the hci_mem_pool buffer size minus the HCI Transport size.

Note
  This value must be aligned with TX_BUF_SIZE in hci_mem_pool_internal.h.

#define RPC_CMD_DATA_POS 1

Position of the data in the command buffer.

#define RPC_CMD_OP_CODE_POS 0

Position of the Op Code in the command buffer.

#define RPC_CMD_RESP_OP_CODE_POS 1

Position of the Op Code in the command response buffer.

#define RPC_CMD_RESP_PKT_TYPE_POS 0

Position of Packet type in the command response buffer.

#define RPC_CMD_RESP_STATUS_POS 2

Position of the status field in the command response buffer.

#define RPC_DTM_CMD_OP_CODE_POS 0

Position of the Op Code in the DTM command buffer.

#define RPC_DTM_DATA_POS 1

Position of the data in the DTM command buffer.

#define RPC_DTM_RESP_OP_CODE_POS 1

Position of the Op Code in the DTM command response buffer.

#define RPC_DTM_RESP_STATUS_POS 2

Position of the status field in the DTM command response buffer.

#define RPC_ERR_CODE_SIZE 4

BLE API err_code size in bytes.

#define RPC_PKT_OP_CODE_POS 1

Position of Op Code in the serialized packet buffer.

#define RPC_PKT_TYPE_POS 0

Position of Packet type in the serialized packet buffer.

## Enumeration Type Documentation

enum ble_rpc_pkt_type_t

The types of packets.

Enumerator
BLE_RPC_PKT_CMD | Command packet type.
BLE_RPC_PKT_RESP | Command Response packet type.
BLE_RPC_PKT_EVT | Event packet type.
BLE_RPC_PKT_DTM_CMD | DTM Command packet type.
BLE_RPC_PKT_DTM_RESP | DTM Response packet type.
BLE_RPC_PKT_TYPE_MAX | Upper bound.