sdc_hci_cmd_cb_write_authenticated_payload_timeout()

uint8_t sdc_hci_cmd_cb_write_authenticated_payload_timeout	(	const sdc_hci_cmd_cb_write_authenticated_payload_timeout_t *	p_params,
		sdc_hci_cmd_cb_write_authenticated_payload_timeout_return_t *	p_return )

#include <softdevice_controller/include/sdc_hci_cmd_controller_baseband.h>

Write Authenticated Payload Timeout.

The description below is extracted from Core_v6.3, Vol 4, Part E, Section 7.3.94

This command writes the Authenticated_Payload_Timeout (authenticatedPayloadTO, see [Vol 2] Part B, Appendix B and [Vol 6] Part B, Section 5.4 for the LE connection) parameter in the Controller for the specified Connection_Handle.

When the Connection_Handle identifies a BR/EDR ACL connection:

• If the connection is in Sniff mode, the Authenticated_Payload_Timeout shall be equal to or greater than Tsniff. • If the connection is in Sniff Subrating mode, the Authenticated_Payload_Timeout shall be equal to or greater than (max subrate)xTsniff. • If the connection is in Hold mode, the Authenticated_Payload_Timeout shall be equal to or greater than the holdTO value.

When the Connection_Handle identifies an LE ACL connection, the Authenticated_Payload_Timeout shall be equal to or greater than connInterval × connSubrateFactor × (1 + connPeripheralLatency).

When the Connection_Handle is associated with a BR/EDR ACL connection, the Link Manager will use this parameter to determine when to use the LMP ping sequence.

When the Connection_Handle is associated with an LE ACL connection, the Link Layer will use this parameter to determine when to use the LE ping sequence.

Errors:

See Section 4.5.2 for a list of error types and descriptions.

Type   Condition                                                           Error code
MC     Connection_Handle identifies a BR/EDR synchronous connection or     Command Disallowed
       an LE BIS or CIS.                                                   (0x0C)

Event(s) generated (unless masked away):

When the HCI_Write_Authenticated_Payload_Timeout command has completed, an HCI_Command_Complete event shall be generated.

Parameters

[in]	p_params	Input parameters.
[out]	p_return	Extra return parameters.

Return values

0	if success.

Returns

Returns value between 0x01-0xFF in case of error. See Vol 2, Part D, Error for a list of error codes and descriptions.