GAP LE Isochronous Channels Definition Exported Types

group GAP_LE_ISOC_DEF_Exported_Types

Enums

enum T_ISOCH_STATE

GAP LE Isochronous Channels CIS connection state.

Values:

enumerator ISOCH_STATE_IDLE: CIS idle.

enumerator ISOCH_STATE_CONNECTING: CIS connecting.

enumerator ISOCH_STATE_CONN: CIS connected.

enumerator ISOCH_STATE_DISCONNECTING: CIS disconnecting.

enumerator ISOCH_STATE_CONNECTING_CANCEL: Cancel CIS connecting.

enum T_ISOCH_ROLE

GAP LE Isochronous Channels CIS role.

Values:

enumerator ISOCH_ROLE_INITIATOR: CIS - Central role.

enumerator ISOCH_ROLE_ACCEPTOR: CIS - Peripheral role.

struct T_ISOCH_INFO

Definition of LE Isochronous Channels CIS connection handle.

Public Members

T_ISOCH_STATE state: CIS Connection state. T_ISOCH_STATE.

T_ISOCH_ROLE role: CIS role. T_ISOCH_STATE.

uint8_t data_path_flags: Specify which directions have been configured. LE Isochronous Channels Definition Data Path Direction Flag.

uint8_t data_path_adding_path: LE Isochronous Channels Definition Setup Data Path Data Path Direction Flag.

bool data_path_adding: Indicate whether data path is setup.

uint8_t data_path_removing_path: Specify which directions are to have the data path removed. LE Isochronous Channels Definition Data Path Direction Flag.

bool data_path_removing: Indicate whether data path is removing.

uint32_t cig_sync_delay

The maximum time, in microseconds, for transmission of PDUs of all CISes in a CIG event.

Range: 0x0000EA to 0x7FFFFF.

uint32_t cis_sync_delay

The maximum time, in microseconds, for transmission of PDUs of the specified CIS in a CIG event.

Range: 0x0000EA to 0x7FFFFF.

uint32_t transport_latency_m_to_s

The actual transport latency, in microseconds, from Central to Peripheral.

Range: 0x0000EA to 0x7FFFFF.

uint32_t transport_latency_s_to_m

The actual transport latency, in microseconds, from Peripheral to Central.

Range: 0x0000EA to 0x7FFFFF.

uint8_t phy_m_to_s: Indicate the PHY selected for packets from the Central to Peripheral. T_GAP_PHYS_TYPE.

uint8_t phy_s_to_m: Indicate the PHY selected for packets from the Peripheral to Central. T_GAP_PHYS_TYPE.

uint8_t nse: Maximum number of subevents in each isochronous event.

uint8_t bn_m_to_s: 0x00: No isochronous data from the Central to the Peripheral. 0x01 to 0x0F: The burst number for Central to Peripheral transmission.

uint8_t bn_s_to_m: 0x00: No isochronous data from the Peripheral to the Central. 0x01 to 0x0F: The burst number for Peripheral to Central transmission.

uint8_t ft_m_to_s

The flush timeout, in multiples of the ISO_Interval for the CIS, for each payload sent from the Central to the Peripheral.

Range: 0x01 to 0xFF.

uint8_t ft_s_to_m

The flush timeout, in multiples of the ISO_Interval for the CIS, for each payload sent from the Peripheral to the Central.

Range: 0x01 to 0xFF.

uint16_t max_pdu_m_to_s: Maximum size, in octets, of the payload from Central to Peripheral.

uint16_t max_pdu_s_to_m: Maximum size, in octets, of the payload from Peripheral to Central.

uint16_t iso_interval

The time between two consecutive CIS anchor points.

Range: 0x0004 to 0x0C80.
Time = N * 1.25 ms.
Time Range: 5 ms to 4 s.

bool acceptor_config_sdu_flag

Only used by ISOCH_ROLE_ACCEPTOR.

True: SDU parameters listed below are configured by the application. Check SDU length when ISOCH_ROLE_ACCEPTOR calls gap_iso_send_data.
False: Default value. SDU parameters listed below are not configured by the application. Do not check SDU length when ISOCH_ROLE_ACCEPTOR calls gap_iso_send_data.

uint32_t sdu_interval_m_to_s

Valid for ISOCH_ROLE_INITIATOR. Valid for ISOCH_ROLE_ACCEPTOR if acceptor_config_sdu_flag is True. The interval, in microseconds, between the start of consecutive SDUs from the Central’s Host for all the CISes in the CIG.

Range: 0x0000FF to 0x0FFFFF.

uint32_t sdu_interval_s_to_m

Valid for ISOCH_ROLE_INITIATOR. Valid for ISOCH_ROLE_ACCEPTOR if acceptor_config_sdu_flag is True. The interval, in microseconds, between the start of consecutive SDUs from the Peripheral’s Host for all the CISes in the CIG.

Range: 0x0000FF to 0x0FFFFF.

uint16_t max_sdu_m_to_s: Valid for ISOCH_ROLE_INITIATOR. Valid for ISOCH_ROLE_ACCEPTOR if acceptor_config_sdu_flag is True. Maximum size, in octets, of the payload from the Central’s Host.

uint16_t max_sdu_s_to_m: Valid for ISOCH_ROLE_INITIATOR. Valid for ISOCH_ROLE_ACCEPTOR if acceptor_config_sdu_flag is True. Maximum size, in octets, of the payload from the Peripheral’s Host.