mgmt.h

Go to the documentation of this file.

/*
   BlueZ - Bluetooth protocol stack for Linux

   Copyright (C) 2010  Nokia Corporation
   Copyright (C) 2011-2012  Intel Corporation

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License version 2 as
   published by the Free Software Foundation;

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
   OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
   IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) AND AUTHOR(S) BE LIABLE FOR ANY
   CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES
   WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
   ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
   OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

   ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
   COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
   SOFTWARE IS DISCLAIMED.
*/

#define MGMT_INDEX_NONE         0xFFFF

#define MGMT_STATUS_SUCCESS     0x00
#define MGMT_STATUS_UNKNOWN_COMMAND 0x01
#define MGMT_STATUS_NOT_CONNECTED   0x02
#define MGMT_STATUS_FAILED      0x03
#define MGMT_STATUS_CONNECT_FAILED  0x04
#define MGMT_STATUS_AUTH_FAILED     0x05
#define MGMT_STATUS_NOT_PAIRED      0x06
#define MGMT_STATUS_NO_RESOURCES    0x07
#define MGMT_STATUS_TIMEOUT     0x08
#define MGMT_STATUS_ALREADY_CONNECTED   0x09
#define MGMT_STATUS_BUSY        0x0a
#define MGMT_STATUS_REJECTED        0x0b
#define MGMT_STATUS_NOT_SUPPORTED   0x0c
#define MGMT_STATUS_INVALID_PARAMS  0x0d
#define MGMT_STATUS_DISCONNECTED    0x0e
#define MGMT_STATUS_NOT_POWERED     0x0f
#define MGMT_STATUS_CANCELLED       0x10
#define MGMT_STATUS_INVALID_INDEX   0x11

struct mgmt_hdr {
    __le16  opcode;
    __le16  index;
    __le16  len;
} __packed;

struct mgmt_addr_info {
    bdaddr_t    bdaddr;
    __u8        type;
} __packed;
#define MGMT_ADDR_INFO_SIZE     7

#define MGMT_OP_READ_VERSION        0x0001
#define MGMT_READ_VERSION_SIZE      0
struct mgmt_rp_read_version {
    __u8    version;
    __le16  revision;
} __packed;

#define MGMT_OP_READ_COMMANDS       0x0002
#define MGMT_READ_COMMANDS_SIZE     0
struct mgmt_rp_read_commands {
    __le16  num_commands;
    __le16  num_events;
    __le16  opcodes[0];
} __packed;

#define MGMT_OP_READ_INDEX_LIST     0x0003
#define MGMT_READ_INDEX_LIST_SIZE   0
struct mgmt_rp_read_index_list {
    __le16  num_controllers;
    __le16  index[0];
} __packed;

/* Reserve one extra byte for names in management messages so that they
 * are always guaranteed to be nul-terminated */
#define MGMT_MAX_NAME_LENGTH        (HCI_MAX_NAME_LENGTH + 1)
#define MGMT_MAX_SHORT_NAME_LENGTH  (HCI_MAX_SHORT_NAME_LENGTH + 1)

#define MGMT_SETTING_POWERED        0x00000001
#define MGMT_SETTING_CONNECTABLE    0x00000002
#define MGMT_SETTING_FAST_CONNECTABLE   0x00000004
#define MGMT_SETTING_DISCOVERABLE   0x00000008
#define MGMT_SETTING_PAIRABLE       0x00000010
#define MGMT_SETTING_LINK_SECURITY  0x00000020
#define MGMT_SETTING_SSP        0x00000040
#define MGMT_SETTING_BREDR      0x00000080
#define MGMT_SETTING_HS         0x00000100
#define MGMT_SETTING_LE         0x00000200

#define MGMT_OP_READ_INFO       0x0004
#define MGMT_READ_INFO_SIZE     0
struct mgmt_rp_read_info {
    bdaddr_t    bdaddr;
    __u8        version;
    __le16      manufacturer;
    __le32      supported_settings;
    __le32      current_settings;
    __u8        dev_class[3];
    __u8        name[MGMT_MAX_NAME_LENGTH];
    __u8        short_name[MGMT_MAX_SHORT_NAME_LENGTH];
} __packed;

struct mgmt_mode {
    __u8 val;
} __packed;

#define MGMT_SETTING_SIZE       1

#define MGMT_OP_SET_POWERED     0x0005

#define MGMT_OP_SET_DISCOVERABLE    0x0006
struct mgmt_cp_set_discoverable {
    __u8    val;
    __le16  timeout;
} __packed;
#define MGMT_SET_DISCOVERABLE_SIZE  3

#define MGMT_OP_SET_CONNECTABLE     0x0007

#define MGMT_OP_SET_FAST_CONNECTABLE    0x0008

#define MGMT_OP_SET_PAIRABLE        0x0009

#define MGMT_OP_SET_LINK_SECURITY   0x000A

#define MGMT_OP_SET_SSP         0x000B

#define MGMT_OP_SET_HS          0x000C

#define MGMT_OP_SET_LE          0x000D
#define MGMT_OP_SET_DEV_CLASS       0x000E
struct mgmt_cp_set_dev_class {
    __u8    major;
    __u8    minor;
} __packed;
#define MGMT_SET_DEV_CLASS_SIZE     2

#define MGMT_OP_SET_LOCAL_NAME      0x000F
struct mgmt_cp_set_local_name {
    __u8    name[MGMT_MAX_NAME_LENGTH];
    __u8    short_name[MGMT_MAX_SHORT_NAME_LENGTH];
} __packed;
#define MGMT_SET_LOCAL_NAME_SIZE    260

#define MGMT_OP_ADD_UUID        0x0010
struct mgmt_cp_add_uuid {
    __u8    uuid[16];
    __u8    svc_hint;
} __packed;
#define MGMT_ADD_UUID_SIZE      17

#define MGMT_OP_REMOVE_UUID     0x0011
struct mgmt_cp_remove_uuid {
    __u8    uuid[16];
} __packed;
#define MGMT_REMOVE_UUID_SIZE       16

struct mgmt_link_key_info {
    struct mgmt_addr_info addr;
    __u8    type;
    __u8    val[16];
    __u8    pin_len;
} __packed;

#define MGMT_OP_LOAD_LINK_KEYS      0x0012
struct mgmt_cp_load_link_keys {
    __u8    debug_keys;
    __le16  key_count;
    struct  mgmt_link_key_info keys[0];
} __packed;
#define MGMT_LOAD_LINK_KEYS_SIZE    3

struct mgmt_ltk_info {
    struct mgmt_addr_info addr;
    __u8    authenticated;
    __u8    master;
    __u8    enc_size;
    __le16  ediv;
    __u8    rand[8];
    __u8    val[16];
} __packed;

#define MGMT_OP_LOAD_LONG_TERM_KEYS 0x0013
struct mgmt_cp_load_long_term_keys {
    __le16  key_count;
    struct  mgmt_ltk_info keys[0];
} __packed;
#define MGMT_LOAD_LONG_TERM_KEYS_SIZE   2

#define MGMT_OP_DISCONNECT      0x0014
struct mgmt_cp_disconnect {
    struct mgmt_addr_info addr;
} __packed;
#define MGMT_DISCONNECT_SIZE        MGMT_ADDR_INFO_SIZE
struct mgmt_rp_disconnect {
    struct mgmt_addr_info addr;
} __packed;

#define MGMT_OP_GET_CONNECTIONS     0x0015
#define MGMT_GET_CONNECTIONS_SIZE   0
struct mgmt_rp_get_connections {
    __le16 conn_count;
    struct mgmt_addr_info addr[0];
} __packed;

#define MGMT_OP_PIN_CODE_REPLY      0x0016
struct mgmt_cp_pin_code_reply {
    struct mgmt_addr_info addr;
    __u8    pin_len;
    __u8    pin_code[16];
} __packed;
#define MGMT_PIN_CODE_REPLY_SIZE    (MGMT_ADDR_INFO_SIZE + 17)
struct mgmt_rp_pin_code_reply {
    struct mgmt_addr_info addr;
} __packed;

#define MGMT_OP_PIN_CODE_NEG_REPLY  0x0017
struct mgmt_cp_pin_code_neg_reply {
    struct mgmt_addr_info addr;
} __packed;
#define MGMT_PIN_CODE_NEG_REPLY_SIZE    MGMT_ADDR_INFO_SIZE

#define MGMT_OP_SET_IO_CAPABILITY   0x0018
struct mgmt_cp_set_io_capability {
    __u8    io_capability;
} __packed;
#define MGMT_SET_IO_CAPABILITY_SIZE 1

#define MGMT_OP_PAIR_DEVICE     0x0019
struct mgmt_cp_pair_device {
    struct mgmt_addr_info addr;
    __u8    io_cap;
} __packed;
#define MGMT_PAIR_DEVICE_SIZE       (MGMT_ADDR_INFO_SIZE + 1)
struct mgmt_rp_pair_device {
    struct mgmt_addr_info addr;
} __packed;

#define MGMT_OP_CANCEL_PAIR_DEVICE  0x001A
#define MGMT_CANCEL_PAIR_DEVICE_SIZE    MGMT_ADDR_INFO_SIZE

#define MGMT_OP_UNPAIR_DEVICE       0x001B
struct mgmt_cp_unpair_device {
    struct mgmt_addr_info addr;
    __u8 disconnect;
} __packed;
#define MGMT_UNPAIR_DEVICE_SIZE     (MGMT_ADDR_INFO_SIZE + 1)
struct mgmt_rp_unpair_device {
    struct mgmt_addr_info addr;
};

#define MGMT_OP_USER_CONFIRM_REPLY  0x001C
struct mgmt_cp_user_confirm_reply {
    struct mgmt_addr_info addr;
} __packed;
#define MGMT_USER_CONFIRM_REPLY_SIZE    MGMT_ADDR_INFO_SIZE
struct mgmt_rp_user_confirm_reply {
    struct mgmt_addr_info addr;
} __packed;

#define MGMT_OP_USER_CONFIRM_NEG_REPLY  0x001D
struct mgmt_cp_user_confirm_neg_reply {
    struct mgmt_addr_info addr;
} __packed;
#define MGMT_USER_CONFIRM_NEG_REPLY_SIZE MGMT_ADDR_INFO_SIZE

#define MGMT_OP_USER_PASSKEY_REPLY  0x001E
struct mgmt_cp_user_passkey_reply {
    struct mgmt_addr_info addr;
    __le32  passkey;
} __packed;
#define MGMT_USER_PASSKEY_REPLY_SIZE    (MGMT_ADDR_INFO_SIZE + 4)
struct mgmt_rp_user_passkey_reply {
    struct mgmt_addr_info addr;
} __packed;

#define MGMT_OP_USER_PASSKEY_NEG_REPLY  0x001F
struct mgmt_cp_user_passkey_neg_reply {
    struct mgmt_addr_info addr;
} __packed;
#define MGMT_USER_PASSKEY_NEG_REPLY_SIZE MGMT_ADDR_INFO_SIZE

#define MGMT_OP_READ_LOCAL_OOB_DATA 0x0020
#define MGMT_READ_LOCAL_OOB_DATA_SIZE   0
struct mgmt_rp_read_local_oob_data {
    __u8    hash[16];
    __u8    randomizer[16];
} __packed;

#define MGMT_OP_ADD_REMOTE_OOB_DATA 0x0021
struct mgmt_cp_add_remote_oob_data {
    struct mgmt_addr_info addr;
    __u8    hash[16];
    __u8    randomizer[16];
} __packed;
#define MGMT_ADD_REMOTE_OOB_DATA_SIZE   (MGMT_ADDR_INFO_SIZE + 32)

#define MGMT_OP_REMOVE_REMOTE_OOB_DATA  0x0022
struct mgmt_cp_remove_remote_oob_data {
    struct mgmt_addr_info addr;
} __packed;
#define MGMT_REMOVE_REMOTE_OOB_DATA_SIZE MGMT_ADDR_INFO_SIZE

#define MGMT_OP_START_DISCOVERY     0x0023
struct mgmt_cp_start_discovery {
    __u8 type;
} __packed;
#define MGMT_START_DISCOVERY_SIZE   1

#define MGMT_OP_STOP_DISCOVERY      0x0024
struct mgmt_cp_stop_discovery {
    __u8 type;
} __packed;
#define MGMT_STOP_DISCOVERY_SIZE    1

#define MGMT_OP_CONFIRM_NAME        0x0025
struct mgmt_cp_confirm_name {
    struct mgmt_addr_info addr;
    __u8    name_known;
} __packed;
#define MGMT_CONFIRM_NAME_SIZE      (MGMT_ADDR_INFO_SIZE + 1)
struct mgmt_rp_confirm_name {
    struct mgmt_addr_info addr;
} __packed;

#define MGMT_OP_BLOCK_DEVICE        0x0026
struct mgmt_cp_block_device {
    struct mgmt_addr_info addr;
} __packed;
#define MGMT_BLOCK_DEVICE_SIZE      MGMT_ADDR_INFO_SIZE

#define MGMT_OP_UNBLOCK_DEVICE      0x0027
struct mgmt_cp_unblock_device {
    struct mgmt_addr_info addr;
} __packed;
#define MGMT_UNBLOCK_DEVICE_SIZE    MGMT_ADDR_INFO_SIZE

#define MGMT_OP_SET_DEVICE_ID       0x0028
struct mgmt_cp_set_device_id {
    __le16  source;
    __le16  vendor;
    __le16  product;
    __le16  version;
} __packed;
#define MGMT_SET_DEVICE_ID_SIZE     8

#define MGMT_EV_CMD_COMPLETE        0x0001
struct mgmt_ev_cmd_complete {
    __le16  opcode;
    __u8    status;
    __u8    data[0];
} __packed;

#define MGMT_EV_CMD_STATUS      0x0002
struct mgmt_ev_cmd_status {
    __le16  opcode;
    __u8    status;
} __packed;

#define MGMT_EV_CONTROLLER_ERROR    0x0003
struct mgmt_ev_controller_error {
    __u8    error_code;
} __packed;

#define MGMT_EV_INDEX_ADDED     0x0004

#define MGMT_EV_INDEX_REMOVED       0x0005

#define MGMT_EV_NEW_SETTINGS        0x0006

#define MGMT_EV_CLASS_OF_DEV_CHANGED    0x0007
struct mgmt_ev_class_of_dev_changed {
    __u8    dev_class[3];
};

#define MGMT_EV_LOCAL_NAME_CHANGED  0x0008
struct mgmt_ev_local_name_changed {
    __u8    name[MGMT_MAX_NAME_LENGTH];
    __u8    short_name[MGMT_MAX_SHORT_NAME_LENGTH];
} __packed;

#define MGMT_EV_NEW_LINK_KEY        0x0009
struct mgmt_ev_new_link_key {
    __u8    store_hint;
    struct mgmt_link_key_info key;
} __packed;

#define MGMT_EV_NEW_LONG_TERM_KEY   0x000A
struct mgmt_ev_new_long_term_key {
    __u8    store_hint;
    struct mgmt_ltk_info key;
} __packed;

#define MGMT_EV_DEVICE_CONNECTED    0x000B
struct mgmt_ev_device_connected {
    struct mgmt_addr_info addr;
    __le32  flags;
    __le16  eir_len;
    __u8    eir[0];
} __packed;

#define MGMT_DEV_DISCONN_UNKNOWN    0x00
#define MGMT_DEV_DISCONN_TIMEOUT    0x01
#define MGMT_DEV_DISCONN_LOCAL_HOST 0x02
#define MGMT_DEV_DISCONN_REMOTE     0x03

#define MGMT_EV_DEVICE_DISCONNECTED 0x000C
struct mgmt_ev_device_disconnected {
    struct mgmt_addr_info addr;
    __u8    reason;
} __packed;

#define MGMT_EV_CONNECT_FAILED      0x000D
struct mgmt_ev_connect_failed {
    struct mgmt_addr_info addr;
    __u8    status;
} __packed;

#define MGMT_EV_PIN_CODE_REQUEST    0x000E
struct mgmt_ev_pin_code_request {
    struct mgmt_addr_info addr;
    __u8    secure;
} __packed;

#define MGMT_EV_USER_CONFIRM_REQUEST    0x000F
struct mgmt_ev_user_confirm_request {
    struct mgmt_addr_info addr;
    __u8    confirm_hint;
    __le32  value;
} __packed;

#define MGMT_EV_USER_PASSKEY_REQUEST    0x0010
struct mgmt_ev_user_passkey_request {
    struct mgmt_addr_info addr;
} __packed;

#define MGMT_EV_AUTH_FAILED     0x0011
struct mgmt_ev_auth_failed {
    struct mgmt_addr_info addr;
    __u8    status;
} __packed;

#define MGMT_DEV_FOUND_CONFIRM_NAME    0x01
#define MGMT_DEV_FOUND_LEGACY_PAIRING  0x02

#define MGMT_EV_DEVICE_FOUND        0x0012
struct mgmt_ev_device_found {
    struct mgmt_addr_info addr;
    __s8    rssi;
    __le32  flags;
    __le16  eir_len;
    __u8    eir[0];
} __packed;

#define MGMT_EV_DISCOVERING     0x0013
struct mgmt_ev_discovering {
    __u8    type;
    __u8    discovering;
} __packed;

#define MGMT_EV_DEVICE_BLOCKED      0x0014
struct mgmt_ev_device_blocked {
    struct mgmt_addr_info addr;
} __packed;

#define MGMT_EV_DEVICE_UNBLOCKED    0x0015
struct mgmt_ev_device_unblocked {
    struct mgmt_addr_info addr;
} __packed;

#define MGMT_EV_DEVICE_UNPAIRED     0x0016
struct mgmt_ev_device_unpaired {
    struct mgmt_addr_info addr;
} __packed;

#define MGMT_EV_PASSKEY_NOTIFY      0x0017
struct mgmt_ev_passkey_notify {
    struct mgmt_addr_info addr;
    __le32  passkey;
    __u8    entered;
} __packed;