Manual Pages  — BLUETOOTH

struct bt_devinfo
{
        char            devname[HCI_DEVNAME_SIZE];

        uint32_t        state;

        bdaddr_t        bdaddr;
        uint16_t        _reserved0;

        uint8_t         features[HCI_DEVFEATURES_SIZE];

        /* buffer info */
        uint16_t        _reserved1;
        uint16_t        cmd_free;
        uint16_t        sco_size;
        uint16_t        sco_pkts;
        uint16_t        sco_free;
        uint16_t        acl_size;
        uint16_t        acl_pkts;
        uint16_t        acl_free;

        /* stats */
        uint32_t        cmd_sent;
        uint32_t        evnt_recv;
        uint32_t        acl_recv;
        uint32_t        acl_sent;
        uint32_t        sco_recv;
        uint32_t        sco_sent;
        uint32_t        bytes_recv;
        uint32_t        bytes_sent;

        /* misc/specific */
        uint16_t        link_policy_info;
        uint16_t        packet_type_info;
        uint16_t        role_switch_info;
        uint16_t        debug;

        uint8_t         _padding[20];
};

The bt_devclose() closes the passed HCI socket handle s, previously obtained with bt_devopen(3).

The bt_devsend() function sends a Bluetooth HCI command with the given opcode to the provided socket s, previously obtained with bt_devopen(3). The opcode parameter is expected to be in the host byte order. The param and plen parameters specify command parameters. The bt_devsend() function does not modify the HCI filter on the provided socket s. The function returns 0 on success, or -1 if an error occurred.

The bt_devrecv() function receives one Bluetooth HCI packet from the socket s, previously obtained with bt_devopen(3). The packet is placed into the provided buffer buf of size size. The to parameter specifies receive timeout in seconds. Infinite timeout can be specified by passing negative value in the to parameter. The bt_devrecv() function does not modify the HCI filter on the provided socket s. The function returns total number of bytes received, or -1 if an error occurred.

The bt_devreq() function makes a Bluetooth HCI request to the socket s, previously obtained with bt_devopen(3). The function will send the specified command and will wait for the specified event, or timeout to seconds to occur. The bt_devreq structure is defined as follows

struct bt_devreq
{
        uint16_t        opcode;
        uint8_t         event;
        void            *cparam;
        size_t          clen;
        void            *rparam;
        size_t          rlen;
};

The opcode field specifies the command and is expected to be in the host byte order. The cparam and clen fields specify command parameters data and command parameters data size respectively. The event field specifies which Bluetooth HCI event ID the function should wait for, otherwise it should be set to zero. The HCI Command Complete and Command Status events are enabled by default. The rparam and rlen parameters specify buffer and buffer size respectively where return parameters should be placed. The bt_devreq() function temporarily modifies filter on the provided HCI socket s. The function returns 0 on success, or -1 if an error occurred.

The bt_devfilter() controls the local HCI filter associated with the socket s, previously obtained with bt_devopen(3). Filtering can be done on packet types, i.e. ACL, SCO or HCI, command and event packets, and, in addition, on HCI event IDs. Before applying the new filter (if provided) the function will try to obtain the current filter from the socket s and place it into the old parameter (if provided). The function returns 0 on success, or -1 if an error occurred.

The bt_devfilter_pkt_set(), bt_devfilter_pkt_clr() and bt_devfilter_pkt_tst() functions can be used to modify and test the HCI filter filter. The type parameter specifies HCI packet type.

The bt_devfilter_evt_set(), bt_devfilter_evt_clr() and bt_devfilter_evt_tst() functions can be used to modify and test the HCI event filter filter. The event parameter specifies HCI event ID.

The bt_devinquiry() function performs Bluetooth inquiry. The devname parameter specifies which local Bluetooth device should perform an inquiry. If not specified, i.e. NULL, then first available device will be used. The length parameters specifies the total length of an inquiry in seconds. If not specified, i.e. 0, default value will be used. The num_rsp parameter specifies the number of responses that can be received before the inquiry is halted. If not specified, i.e. 0, default value will be used. The ii parameter specifies where to place inquiry results. On success, the function will return total number of inquiry results, will allocate, using calloc(3), buffer to store all the inquiry results and will return pointer to the allocated buffer in the ii parameter. It is up to the caller of the function to dispose of the buffer using free(3) call. The function returns -1 if an error has occurred. The bt_devinquiry structure is defined as follows

struct bt_devinquiry {
        bdaddr_t        bdaddr;
        uint8_t         pscan_rep_mode;
        uint8_t         pscan_period_mode;
        uint8_t         dev_class[3];
        uint16_t        clock_offset;
        int8_t          rssi;
        uint8_t         data[240];
};

The bt_devremote_name() function performs Bluetooth Remote Name Request procedure to obtain the user-friendly name of another Bluetooth unit. The devname parameter specifies which local Bluetooth device should perform the request. If not specified ( NULL), the first available device is used. The remote parameter specifies the Bluetooth BD_ADDR of the remote device to query. The to parameter specifies response timeout in seconds. If not specified (0), the default value is taken from the net.bluetooth.hci.command_timeout sysctl(8) value. The clk_off, ps_rep_mode, and ps_mode parameters specify Clock_Offset, Page_Scan_Repetition_Mode, and Page_Scan_Mode fields of HCI_Remote_Name_Request respectively. On success, the function returns a pointer to dynamically allocated NUL-terminated string or NULL if an error occurred. It is up to the caller to release returned string using free(3).

The bt_devremote_name_gen() function is a shortcut to bt_devremote_name() that passes generic defaults for to, clk_off, ps_rep_mode, and ps_mode parameters.

The bdaddr_same(), bdaddr_any(), and bdaddr_copy() are handy shorthand Bluetooth address utility functions. The bdaddr_same() function will test if two provided BD_ADDRs are the same. The bdaddr_any() function will test if provided BD_ADDR is ANY BD_ADDR. The bdaddr_copy() function will copy provided src BD_ADDR into provided dst BD_ADDR.

The variable h_errno can have the following values:

HOST_NOT_FOUND
	No such host is known.
NO_RECOVERY	Some unexpected server failure was encountered. This is a non-recoverable error.

The bt_getprotoent(), bt_getprotobyname() and bt_getprotobynumber() return NULL on EOF or error.