include/net/bluetooth/mgmt.h

   1 /*
   2    BlueZ - Bluetooth protocol stack for Linux
   3
   4    Copyright (C) 2010  Nokia Corporation
   5    Copyright (C) 2011-2012  Intel Corporation
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License version 2 as
   9    published by the Free Software Foundation;
  10
  11    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  12    OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  13    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
  14    IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) AND AUTHOR(S) BE LIABLE FOR ANY
  15    CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES
  16    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  17    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  18    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  19
  20    ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
  21    COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
  22    SOFTWARE IS DISCLAIMED.
  23 */
  24
  25 #define MGMT_INDEX_NONE                 0xFFFF
  26
  27 #define MGMT_STATUS_SUCCESS             0x00
  28 #define MGMT_STATUS_UNKNOWN_COMMAND     0x01
  29 #define MGMT_STATUS_NOT_CONNECTED       0x02
  30 #define MGMT_STATUS_FAILED              0x03
  31 #define MGMT_STATUS_CONNECT_FAILED      0x04
  32 #define MGMT_STATUS_AUTH_FAILED         0x05
  33 #define MGMT_STATUS_NOT_PAIRED          0x06
  34 #define MGMT_STATUS_NO_RESOURCES        0x07
  35 #define MGMT_STATUS_TIMEOUT             0x08
  36 #define MGMT_STATUS_ALREADY_CONNECTED   0x09
  37 #define MGMT_STATUS_BUSY                0x0a
  38 #define MGMT_STATUS_REJECTED            0x0b
  39 #define MGMT_STATUS_NOT_SUPPORTED       0x0c
  40 #define MGMT_STATUS_INVALID_PARAMS      0x0d
  41 #define MGMT_STATUS_DISCONNECTED        0x0e
  42 #define MGMT_STATUS_NOT_POWERED         0x0f
  43 #define MGMT_STATUS_CANCELLED           0x10
  44 #define MGMT_STATUS_INVALID_INDEX       0x11
  45 #define MGMT_STATUS_RFKILLED            0x12
  46
  47 struct mgmt_hdr {
  48         __le16  opcode;
  49         __le16  index;
  50         __le16  len;
  51 } __packed;
  52
  53 struct mgmt_addr_info {
  54         bdaddr_t        bdaddr;
  55         __u8            type;
  56 } __packed;
  57 #define MGMT_ADDR_INFO_SIZE             7
  58
  59 #define MGMT_OP_READ_VERSION            0x0001
  60 #define MGMT_READ_VERSION_SIZE          0
  61 struct mgmt_rp_read_version {
  62         __u8    version;
  63         __le16  revision;
  64 } __packed;
  65
  66 #define MGMT_OP_READ_COMMANDS           0x0002
  67 #define MGMT_READ_COMMANDS_SIZE         0
  68 struct mgmt_rp_read_commands {
  69         __le16  num_commands;
  70         __le16  num_events;
  71         __le16  opcodes[0];
  72 } __packed;
  73
  74 #define MGMT_OP_READ_INDEX_LIST         0x0003
  75 #define MGMT_READ_INDEX_LIST_SIZE       0
  76 struct mgmt_rp_read_index_list {
  77         __le16  num_controllers;
  78         __le16  index[0];
  79 } __packed;
  80
  81 /* Reserve one extra byte for names in management messages so that they
  82  * are always guaranteed to be nul-terminated */
  83 #define MGMT_MAX_NAME_LENGTH            (HCI_MAX_NAME_LENGTH + 1)
  84 #define MGMT_MAX_SHORT_NAME_LENGTH      (HCI_MAX_SHORT_NAME_LENGTH + 1)
  85
  86 #define MGMT_SETTING_POWERED            0x00000001
  87 #define MGMT_SETTING_CONNECTABLE        0x00000002
  88 #define MGMT_SETTING_FAST_CONNECTABLE   0x00000004
  89 #define MGMT_SETTING_DISCOVERABLE       0x00000008
  90 #define MGMT_SETTING_PAIRABLE           0x00000010
  91 #define MGMT_SETTING_LINK_SECURITY      0x00000020
  92 #define MGMT_SETTING_SSP                0x00000040
  93 #define MGMT_SETTING_BREDR              0x00000080
  94 #define MGMT_SETTING_HS                 0x00000100
  95 #define MGMT_SETTING_LE                 0x00000200
  96
  97 #define MGMT_OP_READ_INFO               0x0004
  98 #define MGMT_READ_INFO_SIZE             0
  99 struct mgmt_rp_read_info {
 100         bdaddr_t        bdaddr;
 101         __u8            version;
 102         __le16          manufacturer;
 103         __le32          supported_settings;
 104         __le32          current_settings;
 105         __u8            dev_class[3];
 106         __u8            name[MGMT_MAX_NAME_LENGTH];
 107         __u8            short_name[MGMT_MAX_SHORT_NAME_LENGTH];
 108 } __packed;
 109
 110 struct mgmt_mode {
 111         __u8 val;
 112 } __packed;
 113
 114 #define MGMT_SETTING_SIZE               1
 115
 116 #define MGMT_OP_SET_POWERED             0x0005
 117
 118 #define MGMT_OP_SET_DISCOVERABLE        0x0006
 119 struct mgmt_cp_set_discoverable {
 120         __u8    val;
 121         __le16  timeout;
 122 } __packed;
 123 #define MGMT_SET_DISCOVERABLE_SIZE      3
 124
 125 #define MGMT_OP_SET_CONNECTABLE         0x0007
 126
 127 #define MGMT_OP_SET_FAST_CONNECTABLE    0x0008
 128
 129 #define MGMT_OP_SET_PAIRABLE            0x0009
 130
 131 #define MGMT_OP_SET_LINK_SECURITY       0x000A
 132
 133 #define MGMT_OP_SET_SSP                 0x000B
 134
 135 #define MGMT_OP_SET_HS                  0x000C
 136
 137 #define MGMT_OP_SET_LE                  0x000D
 138 #define MGMT_OP_SET_DEV_CLASS           0x000E
 139 struct mgmt_cp_set_dev_class {
 140         __u8    major;
 141         __u8    minor;
 142 } __packed;
 143 #define MGMT_SET_DEV_CLASS_SIZE         2
 144
 145 #define MGMT_OP_SET_LOCAL_NAME          0x000F
 146 struct mgmt_cp_set_local_name {
 147         __u8    name[MGMT_MAX_NAME_LENGTH];
 148         __u8    short_name[MGMT_MAX_SHORT_NAME_LENGTH];
 149 } __packed;
 150 #define MGMT_SET_LOCAL_NAME_SIZE        260
 151
 152 #define MGMT_OP_ADD_UUID                0x0010
 153 struct mgmt_cp_add_uuid {
 154         __u8    uuid[16];
 155         __u8    svc_hint;
 156 } __packed;
 157 #define MGMT_ADD_UUID_SIZE              17
 158
 159 #define MGMT_OP_REMOVE_UUID             0x0011
 160 struct mgmt_cp_remove_uuid {
 161         __u8    uuid[16];
 162 } __packed;
 163 #define MGMT_REMOVE_UUID_SIZE           16
 164
 165 struct mgmt_link_key_info {
 166         struct mgmt_addr_info addr;
 167         __u8    type;
 168         __u8    val[16];
 169         __u8    pin_len;
 170 } __packed;
 171
 172 #define MGMT_OP_LOAD_LINK_KEYS          0x0012
 173 struct mgmt_cp_load_link_keys {
 174         __u8    debug_keys;
 175         __le16  key_count;
 176         struct  mgmt_link_key_info keys[0];
 177 } __packed;
 178 #define MGMT_LOAD_LINK_KEYS_SIZE        3
 179
 180 struct mgmt_ltk_info {
 181         struct mgmt_addr_info addr;
 182         __u8    authenticated;
 183         __u8    master;
 184         __u8    enc_size;
 185         __le16  ediv;
 186         __u8    rand[8];
 187         __u8    val[16];
 188 } __packed;
 189
 190 #define MGMT_OP_LOAD_LONG_TERM_KEYS     0x0013
 191 struct mgmt_cp_load_long_term_keys {
 192         __le16  key_count;
 193         struct  mgmt_ltk_info keys[0];
 194 } __packed;
 195 #define MGMT_LOAD_LONG_TERM_KEYS_SIZE   2
 196
 197 #define MGMT_OP_DISCONNECT              0x0014
 198 struct mgmt_cp_disconnect {
 199         struct mgmt_addr_info addr;
 200 } __packed;
 201 #define MGMT_DISCONNECT_SIZE            MGMT_ADDR_INFO_SIZE
 202 struct mgmt_rp_disconnect {
 203         struct mgmt_addr_info addr;
 204 } __packed;
 205
 206 #define MGMT_OP_GET_CONNECTIONS         0x0015
 207 #define MGMT_GET_CONNECTIONS_SIZE       0
 208 struct mgmt_rp_get_connections {
 209         __le16 conn_count;
 210         struct mgmt_addr_info addr[0];
 211 } __packed;
 212
 213 #define MGMT_OP_PIN_CODE_REPLY          0x0016
 214 struct mgmt_cp_pin_code_reply {
 215         struct mgmt_addr_info addr;
 216         __u8    pin_len;
 217         __u8    pin_code[16];
 218 } __packed;
 219 #define MGMT_PIN_CODE_REPLY_SIZE        (MGMT_ADDR_INFO_SIZE + 17)
 220 struct mgmt_rp_pin_code_reply {
 221         struct mgmt_addr_info addr;
 222 } __packed;
 223
 224 #define MGMT_OP_PIN_CODE_NEG_REPLY      0x0017
 225 struct mgmt_cp_pin_code_neg_reply {
 226         struct mgmt_addr_info addr;
 227 } __packed;
 228 #define MGMT_PIN_CODE_NEG_REPLY_SIZE    MGMT_ADDR_INFO_SIZE
 229
 230 #define MGMT_OP_SET_IO_CAPABILITY       0x0018
 231 struct mgmt_cp_set_io_capability {
 232         __u8    io_capability;
 233 } __packed;
 234 #define MGMT_SET_IO_CAPABILITY_SIZE     1
 235
 236 #define MGMT_OP_PAIR_DEVICE             0x0019
 237 struct mgmt_cp_pair_device {
 238         struct mgmt_addr_info addr;
 239         __u8    io_cap;
 240 } __packed;
 241 #define MGMT_PAIR_DEVICE_SIZE           (MGMT_ADDR_INFO_SIZE + 1)
 242 struct mgmt_rp_pair_device {
 243         struct mgmt_addr_info addr;
 244 } __packed;
 245
 246 #define MGMT_OP_CANCEL_PAIR_DEVICE      0x001A
 247 #define MGMT_CANCEL_PAIR_DEVICE_SIZE    MGMT_ADDR_INFO_SIZE
 248
 249 #define MGMT_OP_UNPAIR_DEVICE           0x001B
 250 struct mgmt_cp_unpair_device {
 251         struct mgmt_addr_info addr;
 252         __u8 disconnect;
 253 } __packed;
 254 #define MGMT_UNPAIR_DEVICE_SIZE         (MGMT_ADDR_INFO_SIZE + 1)
 255 struct mgmt_rp_unpair_device {
 256         struct mgmt_addr_info addr;
 257 };
 258
 259 #define MGMT_OP_USER_CONFIRM_REPLY      0x001C
 260 struct mgmt_cp_user_confirm_reply {
 261         struct mgmt_addr_info addr;
 262 } __packed;
 263 #define MGMT_USER_CONFIRM_REPLY_SIZE    MGMT_ADDR_INFO_SIZE
 264 struct mgmt_rp_user_confirm_reply {
 265         struct mgmt_addr_info addr;
 266 } __packed;
 267
 268 #define MGMT_OP_USER_CONFIRM_NEG_REPLY  0x001D
 269 struct mgmt_cp_user_confirm_neg_reply {
 270         struct mgmt_addr_info addr;
 271 } __packed;
 272 #define MGMT_USER_CONFIRM_NEG_REPLY_SIZE MGMT_ADDR_INFO_SIZE
 273
 274 #define MGMT_OP_USER_PASSKEY_REPLY      0x001E
 275 struct mgmt_cp_user_passkey_reply {
 276         struct mgmt_addr_info addr;
 277         __le32  passkey;
 278 } __packed;
 279 #define MGMT_USER_PASSKEY_REPLY_SIZE    (MGMT_ADDR_INFO_SIZE + 4)
 280 struct mgmt_rp_user_passkey_reply {
 281         struct mgmt_addr_info addr;
 282 } __packed;
 283
 284 #define MGMT_OP_USER_PASSKEY_NEG_REPLY  0x001F
 285 struct mgmt_cp_user_passkey_neg_reply {
 286         struct mgmt_addr_info addr;
 287 } __packed;
 288 #define MGMT_USER_PASSKEY_NEG_REPLY_SIZE MGMT_ADDR_INFO_SIZE
 289
 290 #define MGMT_OP_READ_LOCAL_OOB_DATA     0x0020
 291 #define MGMT_READ_LOCAL_OOB_DATA_SIZE   0
 292 struct mgmt_rp_read_local_oob_data {
 293         __u8    hash[16];
 294         __u8    randomizer[16];
 295 } __packed;
 296
 297 #define MGMT_OP_ADD_REMOTE_OOB_DATA     0x0021
 298 struct mgmt_cp_add_remote_oob_data {
 299         struct mgmt_addr_info addr;
 300         __u8    hash[16];
 301         __u8    randomizer[16];
 302 } __packed;
 303 #define MGMT_ADD_REMOTE_OOB_DATA_SIZE   (MGMT_ADDR_INFO_SIZE + 32)
 304
 305 #define MGMT_OP_REMOVE_REMOTE_OOB_DATA  0x0022
 306 struct mgmt_cp_remove_remote_oob_data {
 307         struct mgmt_addr_info addr;
 308 } __packed;
 309 #define MGMT_REMOVE_REMOTE_OOB_DATA_SIZE MGMT_ADDR_INFO_SIZE
 310
 311 #define MGMT_OP_START_DISCOVERY         0x0023
 312 struct mgmt_cp_start_discovery {
 313         __u8 type;
 314 } __packed;
 315 #define MGMT_START_DISCOVERY_SIZE       1
 316
 317 #define MGMT_OP_STOP_DISCOVERY          0x0024
 318 struct mgmt_cp_stop_discovery {
 319         __u8 type;
 320 } __packed;
 321 #define MGMT_STOP_DISCOVERY_SIZE        1
 322
 323 #define MGMT_OP_CONFIRM_NAME            0x0025
 324 struct mgmt_cp_confirm_name {
 325         struct mgmt_addr_info addr;
 326         __u8    name_known;
 327 } __packed;
 328 #define MGMT_CONFIRM_NAME_SIZE          (MGMT_ADDR_INFO_SIZE + 1)
 329 struct mgmt_rp_confirm_name {
 330         struct mgmt_addr_info addr;
 331 } __packed;
 332
 333 #define MGMT_OP_BLOCK_DEVICE            0x0026
 334 struct mgmt_cp_block_device {
 335         struct mgmt_addr_info addr;
 336 } __packed;
 337 #define MGMT_BLOCK_DEVICE_SIZE          MGMT_ADDR_INFO_SIZE
 338
 339 #define MGMT_OP_UNBLOCK_DEVICE          0x0027
 340 struct mgmt_cp_unblock_device {
 341         struct mgmt_addr_info addr;
 342 } __packed;
 343 #define MGMT_UNBLOCK_DEVICE_SIZE        MGMT_ADDR_INFO_SIZE
 344
 345 #define MGMT_OP_SET_DEVICE_ID           0x0028
 346 struct mgmt_cp_set_device_id {
 347         __le16  source;
 348         __le16  vendor;
 349         __le16  product;
 350         __le16  version;
 351 } __packed;
 352 #define MGMT_SET_DEVICE_ID_SIZE         8
 353
 354 #define MGMT_EV_CMD_COMPLETE            0x0001
 355 struct mgmt_ev_cmd_complete {
 356         __le16  opcode;
 357         __u8    status;
 358         __u8    data[0];
 359 } __packed;
 360
 361 #define MGMT_EV_CMD_STATUS              0x0002
 362 struct mgmt_ev_cmd_status {
 363         __le16  opcode;
 364         __u8    status;
 365 } __packed;
 366
 367 #define MGMT_EV_CONTROLLER_ERROR        0x0003
 368 struct mgmt_ev_controller_error {
 369         __u8    error_code;
 370 } __packed;
 371
 372 #define MGMT_EV_INDEX_ADDED             0x0004
 373
 374 #define MGMT_EV_INDEX_REMOVED           0x0005
 375
 376 #define MGMT_EV_NEW_SETTINGS            0x0006
 377
 378 #define MGMT_EV_CLASS_OF_DEV_CHANGED    0x0007
 379 struct mgmt_ev_class_of_dev_changed {
 380         __u8    dev_class[3];
 381 };
 382
 383 #define MGMT_EV_LOCAL_NAME_CHANGED      0x0008
 384 struct mgmt_ev_local_name_changed {
 385         __u8    name[MGMT_MAX_NAME_LENGTH];
 386         __u8    short_name[MGMT_MAX_SHORT_NAME_LENGTH];
 387 } __packed;
 388
 389 #define MGMT_EV_NEW_LINK_KEY            0x0009
 390 struct mgmt_ev_new_link_key {
 391         __u8    store_hint;
 392         struct mgmt_link_key_info key;
 393 } __packed;
 394
 395 #define MGMT_EV_NEW_LONG_TERM_KEY       0x000A
 396 struct mgmt_ev_new_long_term_key {
 397         __u8    store_hint;
 398         struct mgmt_ltk_info key;
 399 } __packed;
 400
 401 #define MGMT_EV_DEVICE_CONNECTED        0x000B
 402 struct mgmt_ev_device_connected {
 403         struct mgmt_addr_info addr;
 404         __le32  flags;
 405         __le16  eir_len;
 406         __u8    eir[0];
 407 } __packed;
 408
 409 #define MGMT_DEV_DISCONN_UNKNOWN        0x00
 410 #define MGMT_DEV_DISCONN_TIMEOUT        0x01
 411 #define MGMT_DEV_DISCONN_LOCAL_HOST     0x02
 412 #define MGMT_DEV_DISCONN_REMOTE         0x03
 413
 414 #define MGMT_EV_DEVICE_DISCONNECTED     0x000C
 415 struct mgmt_ev_device_disconnected {
 416         struct mgmt_addr_info addr;
 417         __u8    reason;
 418 } __packed;
 419
 420 #define MGMT_EV_CONNECT_FAILED          0x000D
 421 struct mgmt_ev_connect_failed {
 422         struct mgmt_addr_info addr;
 423         __u8    status;
 424 } __packed;
 425
 426 #define MGMT_EV_PIN_CODE_REQUEST        0x000E
 427 struct mgmt_ev_pin_code_request {
 428         struct mgmt_addr_info addr;
 429         __u8    secure;
 430 } __packed;
 431
 432 #define MGMT_EV_USER_CONFIRM_REQUEST    0x000F
 433 struct mgmt_ev_user_confirm_request {
 434         struct mgmt_addr_info addr;
 435         __u8    confirm_hint;
 436         __le32  value;
 437 } __packed;
 438
 439 #define MGMT_EV_USER_PASSKEY_REQUEST    0x0010
 440 struct mgmt_ev_user_passkey_request {
 441         struct mgmt_addr_info addr;
 442 } __packed;
 443
 444 #define MGMT_EV_AUTH_FAILED             0x0011
 445 struct mgmt_ev_auth_failed {
 446         struct mgmt_addr_info addr;
 447         __u8    status;
 448 } __packed;
 449
 450 #define MGMT_DEV_FOUND_CONFIRM_NAME    0x01
 451 #define MGMT_DEV_FOUND_LEGACY_PAIRING  0x02
 452
 453 #define MGMT_EV_DEVICE_FOUND            0x0012
 454 struct mgmt_ev_device_found {
 455         struct mgmt_addr_info addr;
 456         __s8    rssi;
 457         __le32  flags;
 458         __le16  eir_len;
 459         __u8    eir[0];
 460 } __packed;
 461
 462 #define MGMT_EV_DISCOVERING             0x0013
 463 struct mgmt_ev_discovering {
 464         __u8    type;
 465         __u8    discovering;
 466 } __packed;
 467
 468 #define MGMT_EV_DEVICE_BLOCKED          0x0014
 469 struct mgmt_ev_device_blocked {
 470         struct mgmt_addr_info addr;
 471 } __packed;
 472
 473 #define MGMT_EV_DEVICE_UNBLOCKED        0x0015
 474 struct mgmt_ev_device_unblocked {
 475         struct mgmt_addr_info addr;
 476 } __packed;
 477
 478 #define MGMT_EV_DEVICE_UNPAIRED         0x0016
 479 struct mgmt_ev_device_unpaired {
 480         struct mgmt_addr_info addr;
 481 } __packed;
 482
 483 #define MGMT_EV_PASSKEY_NOTIFY          0x0017
 484 struct mgmt_ev_passkey_notify {
 485         struct mgmt_addr_info addr;
 486         __le32  passkey;
 487         __u8    entered;
 488 } __packed;