BLE_API  v2.1.3
BLE DTM Definition

Macros

#define ENABLE_LAB_TEST_TOOL_SUPPORTS   ENABLE_DEF
 BLE DTM Command for Lab Test Tool. More...
 
#define LE_TEST_SETUP   0
 BLE DTM Command Definition. More...
 
#define LE_RECEIVER_TEST   1
 
#define LE_TRANSMITTER_TEST   2
 
#define LE_TEST_END   3
 
#define LE_TEST_SETUP_RESET   0
 BLE DTM "Test Setup" Command Parameter Definition. More...
 
#define LE_TEST_SETUP_SET_UPPER   1
 
#define LE_TEST_SETUP_SET_PHY   2
 
#define LE_TEST_SETUP_SELECT_MODULATION   3
 
#define LE_TEST_SETUP_READ_SUPPORTED   4
 
#define LE_TEST_SETUP_READ_MAX   5
 
#define LE_PHY_1M   1
 BLE DTM "Test Setup" Command Parameter - PHY Definition. More...
 
#define LE_PHY_2M   2
 
#define LE_PHY_LE_CODED_S8   3
 
#define LE_PHY_LE_CODED_S2   4
 
#define LE_PACKET_REPORTING_EVENT   0x8000
 BLE DTM Packet Reporting Event Definition. More...
 
#define LE_TEST_STATUS_EVENT_SUCCESS   0x0000
 BLE DTM Status Event Definition. More...
 
#define LE_TEST_STATUS_EVENT_ERROR   0x0001
 
#define DTM_PKT_PRBS9   0x00
 BLE DTM Packet Type Definition. More...
 
#define DTM_PKT_0X0F   0x01
 
#define DTM_PKT_0X55   0x02
 
#define DTM_PKT_0XFF   0x03
 
#define DTM_VENDORSPECIFIC_TX_RANDOM_CH_DISABLE   1
 BLE DTMVendor Specific Command Definition. More...
 
#define DTM_VENDORSPECIFIC_TX_RANDOM_CH_ENABLE   2
 
#define DTM_VENDORSPECIFIC_TX_PACKAGE_NUMBER_UNLIMITED   3
 
#define DTM_VENDORSPECIFIC_TX_PACKAGE_NUMBER_BY_USER   4
 
#define DTM_VENDORSPECIFIC_TX_POWER_SELECT   5
 
#define DTM_VENDORSPECIFIC_RX_GET_RSSI   6
 
#define DTM_VENDORSPECIFIC_TX_POWER_SELECT_MORE_OPTION   7
 
#define DTM_VENDORSPECIFIC_GO_SLEEP_MODE   20
 
#define DTM_VENDORSPECIFIC_GO_DEEP_SLEEP_MODE   21
 
#define DTM_VENDORSPECIFIC_GO_TXRF_CONTINUOUS_MODE   22
 
#define DTM_VENDORSPECIFIC_GO_TXRF_DTM_MODE   23
 
#define BLEDTM_SUCCESS   0x00
 
#define BLEDTM_ERROR_ILLEGAL_CHANNEL   0x01
 
#define BLEDTM_ERROR_INVALID_STATE   0x02
 
#define BLEDTM_ERROR_ILLEGAL_LENGTH   0x03
 
#define BLEDTM_ERROR_ILLEGAL_CONFIGURATION   0x04
 
#define BLEDTM_ERROR_UNINITIALIZED   0x05
 

Typedefs

typedef uint8_t BleDtmStatus
 Return codes from bledtm_cmd().
 

Detailed Description

DTM Definitions.

Macro Definition Documentation

◆ BLEDTM_ERROR_ILLEGAL_CHANNEL

#define BLEDTM_ERROR_ILLEGAL_CHANNEL   0x01

Physical channel number must be in the range 0..39.

◆ BLEDTM_ERROR_ILLEGAL_CONFIGURATION

#define BLEDTM_ERROR_ILLEGAL_CONFIGURATION   0x04

Parameter out of range (legal range is function dependent).

◆ BLEDTM_ERROR_ILLEGAL_LENGTH

#define BLEDTM_ERROR_ILLEGAL_LENGTH   0x03

Payload size must be in the range 0..37.

◆ BLEDTM_ERROR_INVALID_STATE

#define BLEDTM_ERROR_INVALID_STATE   0x02

Sequencing error: Command is not valid now.

◆ BLEDTM_ERROR_UNINITIALIZED

#define BLEDTM_ERROR_UNINITIALIZED   0x05

DTM module has not been initialized by the application.

◆ BLEDTM_SUCCESS

#define BLEDTM_SUCCESS   0x00

Indicate that the DTM function completed with success.

◆ DTM_PKT_0X0F

#define DTM_PKT_0X0F   0x01

Bit pattern 11110000 (LSB is the leftmost bit).

◆ DTM_PKT_0X55

#define DTM_PKT_0X55   0x02

Bit pattern 10101010 (LSB is the leftmost bit).

◆ DTM_PKT_0XFF

#define DTM_PKT_0XFF   0x03

Bit pattern 11111111 (Used only for coded PHY).

◆ DTM_PKT_PRBS9

#define DTM_PKT_PRBS9   0x00

BLE DTM Packet Type Definition.

Bit pattern PRBS9.

◆ DTM_VENDORSPECIFIC_GO_DEEP_SLEEP_MODE

#define DTM_VENDORSPECIFIC_GO_DEEP_SLEEP_MODE   21

Phy enter deep sleep mode.

◆ DTM_VENDORSPECIFIC_GO_SLEEP_MODE

#define DTM_VENDORSPECIFIC_GO_SLEEP_MODE   20

Phy enter sleep mode.

◆ DTM_VENDORSPECIFIC_GO_TXRF_CONTINUOUS_MODE

#define DTM_VENDORSPECIFIC_GO_TXRF_CONTINUOUS_MODE   22

TX output single tone mode.

◆ DTM_VENDORSPECIFIC_GO_TXRF_DTM_MODE

#define DTM_VENDORSPECIFIC_GO_TXRF_DTM_MODE   23

TX output DTM normal mode.

◆ DTM_VENDORSPECIFIC_RX_GET_RSSI

#define DTM_VENDORSPECIFIC_RX_GET_RSSI   6

RX need print RSSI value.

◆ DTM_VENDORSPECIFIC_TX_PACKAGE_NUMBER_BY_USER

#define DTM_VENDORSPECIFIC_TX_PACKAGE_NUMBER_BY_USER   4

TX package number by user.

◆ DTM_VENDORSPECIFIC_TX_PACKAGE_NUMBER_UNLIMITED

#define DTM_VENDORSPECIFIC_TX_PACKAGE_NUMBER_UNLIMITED   3

TX package number unlimited.

◆ DTM_VENDORSPECIFIC_TX_POWER_SELECT

#define DTM_VENDORSPECIFIC_TX_POWER_SELECT   5

TX power select 0,4,8 and 10dBm.

◆ DTM_VENDORSPECIFIC_TX_POWER_SELECT_MORE_OPTION

#define DTM_VENDORSPECIFIC_TX_POWER_SELECT_MORE_OPTION   7

TX power select 0.5dB Step.

◆ DTM_VENDORSPECIFIC_TX_RANDOM_CH_DISABLE

#define DTM_VENDORSPECIFIC_TX_RANDOM_CH_DISABLE   1

BLE DTMVendor Specific Command Definition.

TX Random Channel disable.

◆ DTM_VENDORSPECIFIC_TX_RANDOM_CH_ENABLE

#define DTM_VENDORSPECIFIC_TX_RANDOM_CH_ENABLE   2

TX Random CH enable.

◆ ENABLE_LAB_TEST_TOOL_SUPPORTS

#define ENABLE_LAB_TEST_TOOL_SUPPORTS   ENABLE_DEF

BLE DTM Command for Lab Test Tool.

ENABLE_DEF or DISABLE_DEF

◆ LE_PACKET_REPORTING_EVENT

#define LE_PACKET_REPORTING_EVENT   0x8000

BLE DTM Packet Reporting Event Definition.

DTM Packet reporting event, returned by the device to the tester.

◆ LE_PHY_1M

#define LE_PHY_1M   1

BLE DTM "Test Setup" Command Parameter - PHY Definition.

DTM command parameter: Set PHY for future packets to use 1MBit PHY.

◆ LE_PHY_2M

#define LE_PHY_2M   2

DTM command parameter: Set PHY for future packets to use 2MBit PHY.

◆ LE_PHY_LE_CODED_S2

#define LE_PHY_LE_CODED_S2   4

DTM command parameter: Set PHY for future packets to use coded PHY with S=2

◆ LE_PHY_LE_CODED_S8

#define LE_PHY_LE_CODED_S8   3

DTM command parameter: Set PHY for future packets to use coded PHY with S=8.

◆ LE_RECEIVER_TEST

#define LE_RECEIVER_TEST   1

DTM command: Start receive test.

◆ LE_TEST_END

#define LE_TEST_END   3

DTM command: End test and send packet report.

◆ LE_TEST_SETUP

#define LE_TEST_SETUP   0

BLE DTM Command Definition.

DTM command: Set PHY or modulation, configure upper two bits of length, request matrix of supported features or request max values of parameters.

◆ LE_TEST_SETUP_READ_MAX

#define LE_TEST_SETUP_READ_MAX   5

DTM command parameter: Read the max supported time and length for packets.

◆ LE_TEST_SETUP_READ_SUPPORTED

#define LE_TEST_SETUP_READ_SUPPORTED   4

DTM command parameter: Read the supported test case features.

◆ LE_TEST_SETUP_RESET

#define LE_TEST_SETUP_RESET   0

BLE DTM "Test Setup" Command Parameter Definition.

DTM command parameter: Stop TX/RX, reset the packet length upper bits and set the PHY to 1Mbit.

◆ LE_TEST_SETUP_SELECT_MODULATION

#define LE_TEST_SETUP_SELECT_MODULATION   3

DTM command parameter: Select standard or stable modulation index. Stable modulation index is not supported.

◆ LE_TEST_SETUP_SET_PHY

#define LE_TEST_SETUP_SET_PHY   2

DTM command parameter: Select the PHY to be used for packets.

◆ LE_TEST_SETUP_SET_UPPER

#define LE_TEST_SETUP_SET_UPPER   1

DTM command parameter: Set the upper two bits of the length field.

◆ LE_TEST_STATUS_EVENT_ERROR

#define LE_TEST_STATUS_EVENT_ERROR   0x0001

DTM event status error.

◆ LE_TEST_STATUS_EVENT_SUCCESS

#define LE_TEST_STATUS_EVENT_SUCCESS   0x0000

BLE DTM Status Event Definition.

DTM event status success.

◆ LE_TRANSMITTER_TEST

#define LE_TRANSMITTER_TEST   2

DTM command: Start transmission test.