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