GAP Application command request encoders and command response decoders

GAP Application command request encoders and command response decoders. More...

Functions
uint32_t	ble_gap_address_get_req_enc (ble_gap_addr_t const *const p_address, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_address_get command request. More...
uint32_t	ble_gap_address_get_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_gap_addr_t *const p_address, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_address_get command. More...
uint32_t	ble_gap_address_set_req_enc (uint8_t addr_cycle_mode, ble_gap_addr_t const *const p_addr, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_address_set command request. More...
uint32_t	ble_gap_address_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_address_set command. More...
uint32_t	ble_gap_adv_data_set_req_enc (uint8_t const *const p_data, uint8_t dlen, uint8_t const *const p_sr_data, uint8_t srdlen, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_adv_data_set command request. More...
uint32_t	ble_gap_adv_data_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_adv_data_set command. More...
uint32_t	ble_gap_adv_start_req_enc (ble_gap_adv_params_t const *const p_adv_params, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_adv_start command request. More...
uint32_t	ble_gap_adv_start_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_adv_start command. More...
uint32_t	ble_gap_tx_power_set_req_enc (int8_t tx_power, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_tx_power_set command request. More...
uint32_t	ble_gap_tx_power_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_tx_power_set command. More...
uint32_t	ble_gap_appearance_get_req_enc (uint16_t const *const p_appearance, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_appearance_get command request. More...
uint32_t	ble_gap_appearance_get_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint16_t *const p_appearance, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_appearance_get command. More...
uint32_t	ble_gap_appearance_set_req_enc (uint16_t appearance, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_appearance_set command request. More...
uint32_t	ble_gap_appearance_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_appearance_set command. More...
uint32_t	ble_gap_device_name_get_req_enc (uint8_t const *const p_dev_name, uint16_t const *const p_dev_name_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_device_name_get command request. More...
uint32_t	ble_gap_device_name_get_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint8_t *const p_dev_name, uint16_t *const p_dev_name_len, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_device_name_get command. More...
uint32_t	ble_gap_device_name_set_req_enc (ble_gap_conn_sec_mode_t const *const p_write_perm, uint8_t const *const p_dev_name, uint16_t len, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_device_name_set command request. More...
uint32_t	ble_gap_device_name_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_device_name_set command. More...
uint32_t	ble_gap_ppcp_set_req_enc (ble_gap_conn_params_t const *const p_conn_params, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_ppcp_set command request. More...
uint32_t	ble_gap_ppcp_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_ppcp_set command. More...
uint32_t	ble_gap_conn_param_update_req_enc (uint16_t conn_handle, ble_gap_conn_params_t const *const p_conn_params, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_conn_param_update command request. More...
uint32_t	ble_gap_conn_param_update_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_conn_param_update command. More...
uint32_t	ble_gap_disconnect_req_enc (uint16_t conn_handle, uint8_t hci_status_code, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_disconnect command request. More...
uint32_t	ble_gap_disconnect_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_disconnect command. More...
uint32_t	ble_gap_rssi_stop_req_enc (uint16_t conn_handle, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_rssi_stop command request. More...
uint32_t	ble_gap_rssi_stop_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_rssi_stop command. More...
uint32_t	ble_gap_ppcp_get_req_enc (ble_gap_conn_params_t const *const p_conn_params, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_ppcp_get command request. More...
uint32_t	ble_gap_ppcp_get_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_gap_conn_params_t *const p_conn_params, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_ppcp_get command. More...
uint32_t	ble_gap_auth_key_reply_req_enc (uint16_t conn_handle, uint8_t key_type, uint8_t const *const p_key, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_auth_key_reply command request. More...
uint32_t	ble_gap_auth_key_reply_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_auth_key_reply command. More...
uint32_t	ble_gap_sec_info_reply_req_enc (uint16_t conn_handle, ble_gap_enc_info_t const *const p_enc_info, ble_gap_sign_info_t const *const p_sign_info, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_sec_info_reply command request. More...
uint32_t	ble_gap_sec_info_reply_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_sec_info_reply command. More...
uint32_t	ble_gap_sec_params_reply_req_enc (uint16_t conn_handle, uint8_t sec_status, ble_gap_sec_params_t const *const p_sec_params, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_sec_params_reply command request. More...
uint32_t	ble_gap_sec_params_reply_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_sec_params_reply command. More...
uint32_t	ble_gap_authenticate_req_enc (uint16_t conn_handle, ble_gap_sec_params_t const *const p_sec_params, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_authenticate command request. More...
uint32_t	ble_gap_authenticate_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_authenticate command. More...
uint32_t	ble_gap_adv_stop_req_enc (uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_adv_stop command request. More...
uint32_t	ble_gap_adv_stop_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_adv_stop command. More...
uint32_t	ble_gap_conn_sec_get_req_enc (uint16_t conn_handle, ble_gap_conn_sec_t const *const p_conn_sec, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_conn_sec_get command request. More...
uint32_t	ble_gap_conn_sec_get_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_gap_conn_sec_t **const pp_conn_sec, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_conn_sec_get command. More...
uint32_t	ble_gap_rssi_start_req_enc (uint16_t conn_handle, uint8_t *const p_buf, uint32_t *const p_buf_len)
	Encodes sd_ble_gap_rssi_start command request. More...
uint32_t	ble_gap_rssi_start_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
	Decodes response to sd_ble_gap_rssi_start command. More...

Detailed Description

GAP Application command request encoders and command response decoders.

Function Documentation

uint32_t ble_gap_address_get_req_enc	(	ble_gap_addr_t const *const	p_address,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_address_get command request.

See Also

0x71 - sd_ble_gap_address_get for packet format, ble_gap_address_get_rsp_dec for command response decoder.

Parameters

[in]	p_address	Pointer to address.
[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: Size of p_buf buffer. out: Length of encoded command packet.

Note

p_address will not be updated by the command request encoder. Updated values are set by ble_gap_address_get_rsp_dec.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_address_get_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_gap_addr_t *const	p_address,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_address_get command.

See Also

0x71 - sd_ble_gap_address_get for packet format, ble_gap_address_get_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_address	Pointer to address.
[out]	p_result_code	Command result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_address_set_req_enc	(	uint8_t	addr_cycle_mode,
		ble_gap_addr_t const *const	p_addr,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_address_set command request.

See Also

0x70 - sd_ble_gap_address_set for packet format, ble_gap_address_set_rsp_dec for command response decoder.

Parameters

[in]	addr_cycle_mode	Address cycle mode.
[in]	p_addr	Pointer to address structure.
[in,out]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: size of p_buf buffer. out: Length of encoded command packet.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_address_set_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_address_set command.

See Also

0x70 - sd_ble_gap_address_set for packet format, ble_gap_address_set_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_result_code	Command result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_adv_data_set_req_enc	(	uint8_t const *const	p_data,
		uint8_t	dlen,
		uint8_t const *const	p_sr_data,
		uint8_t	srdlen,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_adv_data_set command request.

See Also

0x72 - sd_ble_gap_adv_data_set for packet format, ble_gap_adv_data_set_rsp_dec for command response decoder.

Parameters

[in]	p_data	Raw data to be placed in advertisement packet. If NULL, no changes are made to the current advertisement packet data.
[in]	dlen	Data length for p_data. Max size: BLE_GAP_ADV_MAX_SIZE octets. Should be 0 if p_data is NULL, can be 0 if p_data is not NULL.
[in]	p_sr_data	Raw data to be placed in scan response packet. If NULL, no changes are made to the current scan response packet data.
[in]	srdlen	Data length for p_sr_data. Max size: BLE_GAP_ADV_MAX_SIZE octets. Should be 0 if p_sr_data is NULL, can be 0 if p_data is not NULL.
[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: Size of p_buf buffer. out: Length of encoded command packet.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_adv_data_set_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_adv_data_set command.

See Also

0x72 - sd_ble_gap_adv_data_set for packet format, ble_gap_adv_data_set_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_result_code	Command result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_adv_start_req_enc	(	ble_gap_adv_params_t const *const	p_adv_params,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_adv_start command request.

See Also

0x73 - sd_ble_gap_adv_start for packet format, ble_gap_adv_start_rsp_dec for command response decoder.

Parameters

[in]	p_adv_params	Pointer to advertising parameters structure.
[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: Size of p_buf buffer. out: Length of encoded command packet.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_adv_start_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_adv_start command.

See Also

0x73 - sd_ble_gap_adv_start for packet format, ble_gap_adv_start_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_result_code	Command result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_adv_stop_req_enc	(	uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_adv_stop command request.

See Also

0x74 - sd_ble_gap_adv_stop for packet format, ble_gap_adv_stop_rsp_dec for command response decoder.

Parameters

[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: size of p_buf buffer. out: Length of encoded command packet.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_adv_stop_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_adv_stop command.

See Also

0x74 - sd_ble_gap_adv_stop for packet format, ble_gap_adv_stop_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_result_code	Command response result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZE	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_appearance_get_req_enc	(	uint16_t const *const	p_appearance,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_appearance_get command request.

See Also

0x79 - sd_ble_gap_appearance_get for packet format, ble_gap_appearance_get_rsp_dec for command response decoder.

Parameters

[in]	p_appearance	Appearance (16-bit), see Bluetooth Appearance values
[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: Size of p_buf buffer. out: Length of encoded command packet.

Note

p_appearance will not be updated by the command request encoder. Updated values are set by ble_gap_appearance_get_rsp_dec.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_appearance_get_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		uint16_t *const	p_appearance,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_appearance_get command.

See Also

0x79 - sd_ble_gap_appearance_get for packet format, ble_gap_appearance_get_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_appearance	Appearance (16-bit), see Bluetooth Appearance values.
[out]	p_result_code	Command result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_appearance_set_req_enc	(	uint16_t	appearance,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_appearance_set command request.

See Also

0x78 - sd_ble_gap_appearance_set for packet format, ble_gap_appearance_set_rsp_dec for command response decoder.

Parameters

[in]	appearance	Appearance (16-bit), see Bluetooth Appearance values.
[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: Size of p_buf buffer. out: Length of encoded command packet.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_appearance_set_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_appearance_set command.

See Also

0x78 - sd_ble_gap_appearance_set for packet format, ble_gap_appearance_set_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_result_code	Command result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_auth_key_reply_req_enc	(	uint16_t	conn_handle,
		uint8_t	key_type,
		uint8_t const *const	p_key,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_auth_key_reply command request.

See Also

0x80 - sd_ble_gap_auth_key_reply for packet format, ble_gap_auth_key_reply_rsp_dec for command response decoder.

Parameters

[in]	conn_handle	Connection handle of the connection.
[in]	key_type	Key type which defines length of key data as defined for sd_ble_gap_auth_key_reply .
[in]	p_key	Pointer to a buffer which contains key
[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: size of p_buf buffer. out: Length of encoded command packet.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_PARAM	Encoding failure. Incorrect param provided (key_type).

uint32_t ble_gap_auth_key_reply_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_auth_key_reply command.

See Also

0x80 - sd_ble_gap_auth_key_reply for packet format, ble_gap_auth_key_reply_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_result_code	Command response result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZE	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_authenticate_req_enc	(	uint16_t	conn_handle,
		ble_gap_sec_params_t const *const	p_sec_params,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_authenticate command request.

See Also

0x7E - sd_ble_gap_authenticate for packet format, ble_gap_authenticate_rsp_dec for command response decoder.

Parameters

[in]	conn_handle	Connection handle of the connection.
[in]	p_sec_params	Pointer to a ble_gap_sec_params_t security parameters structure.
[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: size of p_buf buffer. out: Length of encoded command packet.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_authenticate_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_authenticate command.

See Also

0x7E - sd_ble_gap_authenticate for packet format, ble_gap_authenticate_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_result_code	Command response result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZE	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_conn_param_update_req_enc	(	uint16_t	conn_handle,
		ble_gap_conn_params_t const *const	p_conn_params,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_conn_param_update command request.

See Also

0x75 - sd_ble_gap_conn_param_update for packet format, ble_gap_conn_param_update_rsp_dec for command response decoder.

Parameters

[in]	conn_handle	Connection handle of the connection.
[in]	p_conn_params	Pointer to desired connection parameters..
[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: size of p_buf buffer. out: Length of encoded command packet.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_conn_param_update_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_conn_param_update command.

See Also

0x75 - sd_ble_gap_conn_param_update for packet format, ble_gap_conn_param_update_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_result_code	Command response result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZE	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_conn_sec_get_req_enc	(	uint16_t	conn_handle,
		ble_gap_conn_sec_t const *const	p_conn_sec,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_conn_sec_get command request.

See Also

0x82 - sd_ble_gap_conn_sec_get for packet format, ble_gap_conn_sec_get_rsp_dec for command response decoder.

Parameters

[in]	conn_handle	Connection handle of the connection.
[in]	p_conn_sec	Pointer to ble_gap_conn_sec_t which will be filled in response.
[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: size of p_buf buffer. out: Length of encoded command packet.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_conn_sec_get_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_gap_conn_sec_t **const	pp_conn_sec,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_conn_sec_get command.

See Also

0x82 - sd_ble_gap_conn_sec_get for packet format, ble_gap_conn_sec_get_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	pp_conn_sec	Pointer to pointer to ble_gap_conn_sec_t which will be filled by the decoded data (if present).
[out]	p_result_code	Command response result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZE	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_device_name_get_req_enc	(	uint8_t const *const	p_dev_name,
		uint16_t const *const	p_dev_name_len,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_device_name_get command request.

See Also

0x7D - sd_ble_gap_device_name_get for packet format, ble_gap_device_name_get_rsp_dec for command response decoder.

Parameters

[in]	p_dev_name	Pointer to an empty buffer where the UTF-8 non NULL-terminated string will be placed. Set to NULL to obtain the complete device name length.
[in]	p_dev_name_len	Length of the buffer pointed by p_dev_name.
[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: Size of p_buf buffer. out: Length of encoded command packet.

Note

p_dev_name and p_len will not be updated by the command request encoder. Updated values are set by ble_gap_device_name_get_rsp_dec.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_device_name_get_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		uint8_t *const	p_dev_name,
		uint16_t *const	p_dev_name_len,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_device_name_get command.

See Also

0x7D - sd_ble_gap_device_name_get for packet format, ble_gap_device_name_get_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_dev_name	Pointer to an empty buffer where the UTF-8 non NULL-terminated string will be placed.
[in,out]	p_dev_name_len	Length of the buffer pointed by p_dev_name, complete device name length on output.
[out]	p_result_code	Command result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_device_name_set_req_enc	(	ble_gap_conn_sec_mode_t const *const	p_write_perm,
		uint8_t const *const	p_dev_name,
		uint16_t	len,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_device_name_set command request.

See Also

0x7C - sd_ble_gap_device_name_set for packet format, ble_gap_device_name_set_rsp_dec for command response decoder.

Parameters

[in]	p_write_perm	Write permissions for the Device Name characteristic see ble_gap_conn_sec_mode_t.
[in]	p_dev_name	Pointer to a UTF-8 encoded, non NULL-terminated string.
[in]	len	Length of the UTF-8, non NULL-terminated string pointed to by p_dev_name in octets (must be smaller or equal than BLE_GAP_DEVNAME_MAX_LEN).
[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: Size of p_buf buffer. out: Length of encoded command packet.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_device_name_set_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_device_name_set command.

See Also

0x7C - sd_ble_gap_device_name_set for packet format, ble_gap_device_name_set_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_result_code	Command result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_disconnect_req_enc	(	uint16_t	conn_handle,
		uint8_t	hci_status_code,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_disconnect command request.

See Also

0x76 - sd_ble_gap_disconnect for packet format, ble_gap_disconnect_rsp_dec for command response decoder.

Parameters

[in]	conn_handle	Connection handle of the connection.
[in]	hci_status_code	HCI status code, see Bluetooth status codes.
[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: size of p_buf buffer. out: Length of encoded command packet.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_disconnect_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_disconnect command.

See Also

0x76 - sd_ble_gap_disconnect for packet format, ble_gap_disconnect_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_result_code	Command response result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZE	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_ppcp_get_req_enc	(	ble_gap_conn_params_t const *const	p_conn_params,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_ppcp_get command request.

See Also

0x7B - sd_ble_gap_ppcp_get for packet format, ble_gap_ppcp_get_rsp_dec for command response decoder.

Parameters

[in]	p_conn_params	Pointer to a ble_gap_conn_params_t structure where the parameters will be stored.
[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: size of p_buf buffer. out: Length of encoded command packet.

Note

p_conn_params will not be updated by the command request encoder. Updated values are set by ble_gap_ppcp_get_rsp_dec.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_ppcp_get_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_gap_conn_params_t *const	p_conn_params,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_ppcp_get command.

See Also

0x7B - sd_ble_gap_ppcp_get for packet format, ble_gap_ppcp_get_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_conn_params	Pointer to a ble_gap_conn_params_t structure where the parameters will be stored.
[out]	p_result_code	Command response result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZE	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_ppcp_set_req_enc	(	ble_gap_conn_params_t const *const	p_conn_params,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_ppcp_set command request.

See Also

0x7A - sd_ble_gap_ppcp_set for packet format, ble_gap_ppcp_set_rsp_dec for command response decoder.

Parameters

[in]	p_conn_params	Pointer to a ble_gap_conn_params_t structure with the desired parameters.
[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: Size of p_buf buffer. out: Length of encoded command packet.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_ppcp_set_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_ppcp_set command.

See Also

0x7A - sd_ble_gap_ppcp_set for packet format, ble_gap_ppcp_set_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_result_code	Command result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_rssi_start_req_enc	(	uint16_t	conn_handle,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_rssi_start command request.

See Also

0x83 - sd_ble_gap_rssi_start for packet format, ble_gap_rssi_start_rsp_dec for command response decoder.

Parameters

[in]	conn_handle	Connection handle of the connection.
[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: size of p_buf buffer. out: Length of encoded command packet.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_rssi_start_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_rssi_start command.

See Also

0x83 - sd_ble_gap_rssi_start for packet format, ble_gap_rssi_start_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_result_code	Command response result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZE	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_rssi_stop_req_enc	(	uint16_t	conn_handle,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_rssi_stop command request.

See Also

0x84 - sd_ble_gap_rssi_stop for packet format, ble_gap_rssi_stop_rsp_dec for command response decoder.

Parameters

[in]	conn_handle	Connection handle of the connection.
[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: size of p_buf buffer. out: Length of encoded command packet.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_rssi_stop_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_rssi_stop command.

See Also

0x84 - sd_ble_gap_rssi_stop for packet format, ble_gap_rssi_stop_rsp_dec for command response decoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_result_code	Command response result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZE	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_sec_info_reply_req_enc	(	uint16_t	conn_handle,
		ble_gap_enc_info_t const *const	p_enc_info,
		ble_gap_sign_info_t const *const	p_sign_info,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_sec_info_reply command request.

See Also

0x81 - sd_ble_gap_sec_info_reply for packet format, ble_gap_sec_info_reply_rsp_dec for command response decoder.

Parameters

[in]	conn_handle	Connection handle of the connection.
[in]	p_enc_info	Pointer to a ble_gap_enc_info_t encryption information structure.
[in]	p_sign_info	Pointer to a ble_gap_sign_info_t signing information structure.
[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: size of p_buf buffer. out: Length of encoded command packet.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_sec_info_reply_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_sec_info_reply command.

See Also

0x81 - sd_ble_gap_sec_info_reply for packet format, ble_gap_sec_info_reply_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_result_code	Command response result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZE	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_sec_params_reply_req_enc	(	uint16_t	conn_handle,
		uint8_t	sec_status,
		ble_gap_sec_params_t const *const	p_sec_params,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_sec_params_reply command request.

See Also

0x7F - sd_ble_gap_sec_params_reply for packet format, ble_gap_sec_params_reply_rsp_dec for command response decoder.

Parameters

[in]	conn_handle	Connection handle of the connection.
[in]	sec_status	Security status, see GAP Security status.
[in]	p_sec_params	Pointer to a ble_gap_sec_params_t security parameters structure.
[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: size of p_buf buffer. out: Length of encoded command packet.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_sec_params_reply_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_sec_params_reply command.

See Also

0x7F - sd_ble_gap_sec_params_reply for packet format, ble_gap_sec_params_reply_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_result_code	Command response result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZE	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.

uint32_t ble_gap_tx_power_set_req_enc	(	int8_t	tx_power,
		uint8_t *const	p_buf,
		uint32_t *const	p_buf_len
	)

Encodes sd_ble_gap_tx_power_set command request.

See Also

0x77 - sd_ble_gap_tx_power_set for packet format, ble_gap_tx_power_set_rsp_dec for command response decoder.

Parameters

[in]	tx_power	Radio transmit power in dBm (accepted values are -40, -30, -20, -16, -12, -8, -4, 0, and 4 dBm).
[in]	p_buf	Pointer to buffer where encoded data command will be returned.
[in,out]	p_buf_len	in: Size of p_buf buffer. out: Length of encoded command packet.

Return values

NRF_SUCCESS	Encoding success.
NRF_ERROR_NULL	Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Encoding failure. Incorrect buffer length.

uint32_t ble_gap_tx_power_set_rsp_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		uint32_t *const	p_result_code
	)

Decodes response to sd_ble_gap_tx_power_set command.

See Also

0x77 - sd_ble_gap_tx_power_set for packet format, ble_gap_tx_power_set_req_enc for command request encoder.

Parameters

[in]	p_buf	Pointer to beginning of command response packet.
[in]	packet_len	Length (in bytes) of response packet.
[out]	p_result_code	Command result code.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATA	Decoding failure. Decoded operation code does not match expected operation code.