ble/protocol/advertise.h header reference
[Bluetooth Low Energy library module]

The source code of this header can be browsed online.

Description [link]

this header defines protocol data types for advertising.

Members [link]

Types [link]

Functions [link]

error_t ble_adv_connect_parse(const struct buffer_s *p, struct ble_adv_connect_s *conn)
void ble_adv_connect_set(struct buffer_s *p, const struct ble_adv_connect_s *params)
error_t ble_adv_data_append(struct buffer_s *p, const uint8_t type, const void *data, const uint8_t size)
error_t ble_adv_data_string_append(struct buffer_s *p, const uint8_t type, const char *s)
void ble_adv_direct_ind_set(struct buffer_s *p, const struct ble_addr_s *adva, const struct ble_addr_s *inita)
void ble_adv_ind_set(struct buffer_s *p, const struct ble_addr_s *adva)
void ble_adv_nonconn_ind_set(struct buffer_s *p, const struct ble_addr_s *adva)
void ble_adv_scan_ind_set(struct buffer_s *p, const struct ble_addr_s *adva)
void ble_adv_scan_req_set(struct buffer_s *p, const struct ble_addr_s *scana, const struct ble_addr_s *adva)
void ble_adv_scan_rsp_set(struct buffer_s *p, const struct ble_addr_s *adva)
void ble_advertise_packet_dump(const struct buffer_s *p)
void ble_advertise_packet_rxaddr_get(const struct buffer_s *p, struct ble_addr_s *addr)
void ble_advertise_packet_rxaddr_set(struct buffer_s *p, const struct ble_addr_s *addr)
void ble_advertise_packet_txaddr_get(const struct buffer_s *p, struct ble_addr_s *addr)
void ble_advertise_packet_txaddr_set(struct buffer_s *p, const struct ble_addr_s *addr)
enum ble_adv_type ble_advertise_packet_type_get(const struct buffer_s *p)
enum ble_sca_e ble_sca_from_accuracy(const struct dev_freq_s *freq)

Constants [link]

const uint16_t ble_sca_bc[8]
const uint16_t ble_sca_wc[8]

Variable [link]

const char * ble_adv_type_name[BLE_ADV_TYPE_LAST+1]

Members detail [link]

#define BLE_ADVERTISE_AA [link]

This macro is declared in ble/protocol/advertise.h source file, line 36.

#define BLE_ADVERTISE_CRCINIT [link]

This macro is declared in ble/protocol/advertise.h source file, line 37.

#define BLE_ADV_LEN_OFFSET [link]

This macro is declared in ble/protocol/advertise.h source file, line 74.

#define BLE_ADV_RXADD [link]

This macro is declared in ble/protocol/advertise.h source file, line 70.

#define BLE_ADV_RXADDR_OFFSET [link]

This macro is declared in ble/protocol/advertise.h source file, line 76.

#define BLE_ADV_TXADD [link]

This macro is declared in ble/protocol/advertise.h source file, line 69.

#define BLE_ADV_TXADDR_OFFSET [link]

This macro is declared in ble/protocol/advertise.h source file, line 75.

#define BLE_ADV_TYPE_MASK [link]

This macro is declared in ble/protocol/advertise.h source file, line 71.

#define BLE_ADV_TYPE_OFFSET [link]

This macro is declared in ble/protocol/advertise.h source file, line 73.

#define BLE_PROTOCOL_ADVERTISE_H_ [link]

This macro is declared in ble/protocol/advertise.h source file, line 21.

error_t ble_adv_connect_parse(const struct buffer_s p, struct ble_adv_connect_s conn) [link]

This function is declared in ble/protocol/advertise.h source file, line 248.

this function parses a CONNECT_REQ packet.

conn: Connection request parameters

struct ble_adv_connect_s [link]

This struct is declared in ble/protocol/advertise.h source file, line 44.

this struct contains all connection request's parameters.

Field	Description
struct ble_addr_s master;
struct ble_addr_s slave;
struct ble_conn_timing_param_s timing;
uint64_t channel_map;
uint32_t access_address;
uint32_t crc_init;
uint16_t win_offset;
uint8_t hop;
uint8_t sca;
uint8_t win_size;

void ble_adv_connect_set(struct buffer_s p, const struct ble_adv_connect_s params) [link]

This function is declared in ble/protocol/advertise.h source file, line 232.

this function initializes a CONNECT_REQ packet.

params: Connection request parameters

error_t ble_adv_data_append(struct buffer_s p, const uint8_t type, const void data, const uint8_t size) [link]

This function is declared in ble/protocol/advertise.h source file, line 240.

this function appends some AD PDU to ADV_IND or SCAN_RSP packet.

error_t ble_adv_data_string_append(struct buffer_s p, const uint8_t type, const char s) [link]

This function is declared in ble/protocol/advertise.h source file, line 258.

this function appends a string PDU to ADV_IND or SCAN_RSP packet.

void ble_adv_direct_ind_set(struct buffer_s p, const struct ble_addr_s adva, const struct ble_addr_s *inita) [link]

This function is declared in ble/protocol/advertise.h source file, line 190.

this function initializes an ADV_DIRECT_IND packet.

adva: Advertise packet source address
inita: Advertise packet target address

void ble_adv_ind_set(struct buffer_s p, const struct ble_addr_s adva) [link]

This function is declared in ble/protocol/advertise.h source file, line 180.

this function initializes an ADV_IND packet with no AD PDU.

adva: Advertise packet source address

void ble_adv_nonconn_ind_set(struct buffer_s p, const struct ble_addr_s adva) [link]

This function is declared in ble/protocol/advertise.h source file, line 198.

this function initializes an ADV_NONCONN_IND packet with no AD PDU.

adva: Advertise packet source address

void ble_adv_scan_ind_set(struct buffer_s p, const struct ble_addr_s adva) [link]

This function is declared in ble/protocol/advertise.h source file, line 224.

this function initializes an SCAN_IND packet.

adva: Packet source address

void ble_adv_scan_req_set(struct buffer_s p, const struct ble_addr_s scana, const struct ble_addr_s *adva) [link]

This function is declared in ble/protocol/advertise.h source file, line 208.

this function initializes an SCAN_REQ packet.

scana: Packet source address
adva: Packet target address

void ble_adv_scan_rsp_set(struct buffer_s p, const struct ble_addr_s adva) [link]

This function is declared in ble/protocol/advertise.h source file, line 216.

this function initializes an SCAN_RSP packet with no AD PDU.

adva: Packet source address

enum ble_adv_type [link]

This enum is declared in ble/protocol/advertise.h source file, line 59.

Protocol defined advertising packet types

Identifier	Description
BLE_ADV_IND
BLE_ADV_DIRECT_IND
BLE_ADV_NONCONN_IND
BLE_SCAN_REQ
BLE_SCAN_RSP
BLE_CONNECT_REQ
BLE_ADV_SCAN_IND
BLE_ADV_TYPE_LAST

const char * ble_adv_type_name[BLE_ADV_TYPE_LAST+1] [link]

This constant is declared in ble/protocol/advertise.h source file, line 80.

String table matching advertising type for pretty print

void ble_advertise_packet_dump(const struct buffer_s *p) [link]

This function is declared in ble/protocol/advertise.h source file, line 109.

this function printk() an advertise packet.

void ble_advertise_packet_rxaddr_get(const struct buffer_s p, struct ble_addr_s addr) [link]

This function is declared in ble/protocol/advertise.h source file, line 137.

this function retrieves advertise target address from payload

void ble_advertise_packet_rxaddr_set(struct buffer_s p, const struct ble_addr_s addr) [link]

This function is declared in ble/protocol/advertise.h source file, line 164.

this function sets advertise target address to payload

void ble_advertise_packet_txaddr_get(const struct buffer_s p, struct ble_addr_s addr) [link]

This function is declared in ble/protocol/advertise.h source file, line 125.

this function retrieves advertise source address from payload

void ble_advertise_packet_txaddr_set(struct buffer_s p, const struct ble_addr_s addr) [link]

This function is declared in ble/protocol/advertise.h source file, line 149.

this function sets advertise source address to payload

enum ble_adv_type ble_advertise_packet_type_get(const struct buffer_s *p) [link]

This function is declared in ble/protocol/advertise.h source file, line 116.

this function retrieves advertise packet type from payload.

const uint16_t ble_sca_bc[8] [link]

This constant is declared in ble/protocol/advertise.h source file, line 96.

Sleep clock accuracy best case PPM, indexed by SCA constant

enum ble_sca_e [link]

This enum is declared in ble/protocol/advertise.h source file, line 82.

Identifier	Description
BLE_SCA_251_500_PPM
BLE_SCA_151_250_PPM
BLE_SCA_101_150_PPM
BLE_SCA_76_100_PPM
BLE_SCA_51_75_PPM
BLE_SCA_31_50_PPM
BLE_SCA_21_30_PPM
BLE_SCA_0_20_PPM

enum ble_sca_e ble_sca_from_accuracy(const struct dev_freq_s *freq) [link]

This function is declared in ble/protocol/advertise.h source file, line 104.

this function computes a BLE sleep clock accuracy constant from libdevice timer accuracy.

const uint16_t ble_sca_wc[8] [link]

This constant is declared in ble/protocol/advertise.h source file, line 94.

Sleep clock accuracy worst case PPM, indexed by SCA constant

ble/protocol/advertise.h header reference [Bluetooth Low Energy library module]