riot_sys::bindgen

Function ble_hs_hci_read_chan_map

Source
pub unsafe extern "C" fn ble_hs_hci_read_chan_map(
    conn_handle: u16,
    out_chan_map: *mut u8,
) -> c_int
Expand description

Queries the controller for the channel map used with the specified connection. The channel map is represented as an array of five bytes, with each bit corresponding to an individual channel. The array is interpreted as little-endian, such that: map[0] & 0x01 –> Channel 0. map[0] & 0x02 –> Channel 1. … map[1] & 0x01 –> Channel 8.

As there are 37 channels, only the first 37 bits get written.

If a bit is 1, the corresponding channel is used. Otherwise, the channel is unused.

@param conn_handle The handle of the connection whose channel map is being read. @param out_chan_map On success, the retrieved channel map gets written here. This buffer must have a size >= 5 bytes.

@return 0 on success; A BLE host HCI return code if the controller rejected the request; A BLE host core return code on unexpected error.