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
  45 struct mgmt_hdr {
  46         __le16 opcode;
  47         __le16 index;
  48         __le16 len;
  49 } __packed;
  50
  51 #define MGMT_ADDR_BREDR                 0x00
  52 #define MGMT_ADDR_LE_PUBLIC             0x01
  53 #define MGMT_ADDR_LE_RANDOM             0x02
  54 #define MGMT_ADDR_INVALID               0xff
  55
  56 struct mgmt_addr_info {
  57         bdaddr_t bdaddr;
  58         __u8 type;
  59 } __packed;
  60
  61 #define MGMT_OP_READ_VERSION            0x0001
  62 struct mgmt_rp_read_version {
  63         __u8 version;
  64         __le16 revision;
  65 } __packed;
  66
  67 #define MGMT_OP_READ_COMMANDS           0x0002
  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 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      (10 + 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 struct mgmt_rp_read_info {
  98         bdaddr_t bdaddr;
  99         __u8 version;
 100         __le16 manufacturer;
 101         __le32 supported_settings;
 102         __le32 current_settings;
 103         __u8 dev_class[3];
 104         __u8 name[MGMT_MAX_NAME_LENGTH];
 105         __u8 short_name[MGMT_MAX_SHORT_NAME_LENGTH];
 106 } __packed;
 107
 108 struct mgmt_mode {
 109         __u8 val;
 110 } __packed;
 111
 112 #define MGMT_OP_SET_POWERED             0x0005
 113
 114 #define MGMT_OP_SET_DISCOVERABLE        0x0006
 115 struct mgmt_cp_set_discoverable {
 116         __u8 val;
 117         __u16 timeout;
 118 } __packed;
 119
 120 #define MGMT_OP_SET_CONNECTABLE         0x0007
 121
 122 #define MGMT_OP_SET_FAST_CONNECTABLE    0x0008
 123
 124 #define MGMT_OP_SET_PAIRABLE            0x0009
 125
 126 #define MGMT_OP_SET_LINK_SECURITY       0x000A
 127
 128 #define MGMT_OP_SET_SSP                 0x000B
 129
 130 #define MGMT_OP_SET_HS                  0x000C
 131
 132 #define MGMT_OP_SET_LE                  0x000D
 133
 134 #define MGMT_OP_SET_DEV_CLASS           0x000E
 135 struct mgmt_cp_set_dev_class {
 136         __u8 major;
 137         __u8 minor;
 138 } __packed;
 139
 140 #define MGMT_OP_SET_LOCAL_NAME          0x000F
 141 struct mgmt_cp_set_local_name {
 142         __u8 name[MGMT_MAX_NAME_LENGTH];
 143 } __packed;
 144
 145 #define MGMT_OP_ADD_UUID                0x0010
 146 struct mgmt_cp_add_uuid {
 147         __u8 uuid[16];
 148         __u8 svc_hint;
 149 } __packed;
 150
 151 #define MGMT_OP_REMOVE_UUID             0x0011
 152 struct mgmt_cp_remove_uuid {
 153         __u8 uuid[16];
 154 } __packed;
 155
 156 struct mgmt_link_key_info {
 157         struct mgmt_addr_info addr;
 158         u8 type;
 159         u8 val[16];
 160         u8 pin_len;
 161 } __packed;
 162
 163 #define MGMT_OP_LOAD_LINK_KEYS          0x0012
 164 struct mgmt_cp_load_link_keys {
 165         __u8 debug_keys;
 166         __le16 key_count;
 167         struct mgmt_link_key_info keys[0];
 168 } __packed;
 169
 170 struct mgmt_ltk_info {
 171         struct mgmt_addr_info addr;
 172         __u8 authenticated;
 173         __u8 master;
 174         __u8 enc_size;
 175         __le16 ediv;
 176         __u8 rand[8];
 177         __u8 val[16];
 178 } __packed;
 179
 180 #define MGMT_OP_LOAD_LONG_TERM_KEYS     0x0013
 181 struct mgmt_cp_load_long_term_keys {
 182         __le16 key_count;
 183         struct mgmt_ltk_info keys[0];
 184 } __packed;
 185
 186 #define MGMT_OP_DISCONNECT              0x0014
 187 struct mgmt_cp_disconnect {
 188         struct mgmt_addr_info addr;
 189 } __packed;
 190 struct mgmt_rp_disconnect {
 191         struct mgmt_addr_info addr;
 192         __u8 status;
 193 } __packed;
 194
 195 #define MGMT_OP_GET_CONNECTIONS         0x0015
 196 struct mgmt_rp_get_connections {
 197         __le16 conn_count;
 198         struct mgmt_addr_info addr[0];
 199 } __packed;
 200
 201 #define MGMT_OP_PIN_CODE_REPLY          0x0016
 202 struct mgmt_cp_pin_code_reply {
 203         struct mgmt_addr_info addr;
 204         __u8 pin_len;
 205         __u8 pin_code[16];
 206 } __packed;
 207 struct mgmt_rp_pin_code_reply {
 208         struct mgmt_addr_info addr;
 209         uint8_t status;
 210 } __packed;
 211
 212 #define MGMT_OP_PIN_CODE_NEG_REPLY      0x0017
 213 struct mgmt_cp_pin_code_neg_reply {
 214         struct mgmt_addr_info addr;
 215 } __packed;
 216
 217 #define MGMT_OP_SET_IO_CAPABILITY       0x0018
 218 struct mgmt_cp_set_io_capability {
 219         __u8 io_capability;
 220 } __packed;
 221
 222 #define MGMT_OP_PAIR_DEVICE             0x0019
 223 struct mgmt_cp_pair_device {
 224         struct mgmt_addr_info addr;
 225         __u8 io_cap;
 226 } __packed;
 227 struct mgmt_rp_pair_device {
 228         struct mgmt_addr_info addr;
 229         __u8 status;
 230 } __packed;
 231
 232 #define MGMT_OP_CANCEL_PAIR_DEVICE      0x001A
 233
 234 #define MGMT_OP_UNPAIR_DEVICE           0x001B
 235 struct mgmt_cp_unpair_device {
 236         struct mgmt_addr_info addr;
 237         __u8 disconnect;
 238 } __packed;
 239 struct mgmt_rp_unpair_device {
 240         struct mgmt_addr_info addr;
 241         __u8 status;
 242 };
 243
 244 #define MGMT_OP_USER_CONFIRM_REPLY      0x001C
 245 struct mgmt_cp_user_confirm_reply {
 246         struct mgmt_addr_info addr;
 247 } __packed;
 248 struct mgmt_rp_user_confirm_reply {
 249         struct mgmt_addr_info addr;
 250         __u8 status;
 251 } __packed;
 252
 253 #define MGMT_OP_USER_CONFIRM_NEG_REPLY  0x001D
 254 struct mgmt_cp_user_confirm_neg_reply {
 255         struct mgmt_addr_info addr;
 256 } __packed;
 257
 258 #define MGMT_OP_USER_PASSKEY_REPLY      0x001E
 259 struct mgmt_cp_user_passkey_reply {
 260         struct mgmt_addr_info addr;
 261         __le32 passkey;
 262 } __packed;
 263 struct mgmt_rp_user_passkey_reply {
 264         struct mgmt_addr_info addr;
 265         __u8 status;
 266 } __packed;
 267
 268 #define MGMT_OP_USER_PASSKEY_NEG_REPLY  0x001F
 269 struct mgmt_cp_user_passkey_neg_reply {
 270         struct mgmt_addr_info addr;
 271 } __packed;
 272
 273 #define MGMT_OP_READ_LOCAL_OOB_DATA     0x0020
 274 struct mgmt_rp_read_local_oob_data {
 275         __u8 hash[16];
 276         __u8 randomizer[16];
 277 } __packed;
 278
 279 #define MGMT_OP_ADD_REMOTE_OOB_DATA     0x0021
 280 struct mgmt_cp_add_remote_oob_data {
 281         struct mgmt_addr_info addr;
 282         __u8 hash[16];
 283         __u8 randomizer[16];
 284 } __packed;
 285
 286 #define MGMT_OP_REMOVE_REMOTE_OOB_DATA  0x0022
 287 struct mgmt_cp_remove_remote_oob_data {
 288         struct mgmt_addr_info addr;
 289 } __packed;
 290
 291 #define MGMT_OP_START_DISCOVERY         0x0023
 292 struct mgmt_cp_start_discovery {
 293         __u8 type;
 294 } __packed;
 295
 296 #define MGMT_OP_STOP_DISCOVERY          0x0024
 297
 298 #define MGMT_OP_CONFIRM_NAME            0x0025
 299 struct mgmt_cp_confirm_name {
 300         struct mgmt_addr_info addr;
 301         __u8 name_known;
 302 } __packed;
 303 struct mgmt_rp_confirm_name {
 304         struct mgmt_addr_info addr;
 305         __u8 status;
 306 } __packed;
 307
 308 #define MGMT_OP_BLOCK_DEVICE            0x0026
 309 struct mgmt_cp_block_device {
 310         struct mgmt_addr_info addr;
 311 } __packed;
 312
 313 #define MGMT_OP_UNBLOCK_DEVICE          0x0027
 314 struct mgmt_cp_unblock_device {
 315         struct mgmt_addr_info addr;
 316 } __packed;
 317
 318 #define MGMT_EV_CMD_COMPLETE            0x0001
 319 struct mgmt_ev_cmd_complete {
 320         __le16 opcode;
 321         __u8 data[0];
 322 } __packed;
 323
 324 #define MGMT_EV_CMD_STATUS              0x0002
 325 struct mgmt_ev_cmd_status {
 326         __u8 status;
 327         __le16 opcode;
 328 } __packed;
 329
 330 #define MGMT_EV_CONTROLLER_ERROR        0x0003
 331 struct mgmt_ev_controller_error {
 332         __u8 error_code;
 333 } __packed;
 334
 335 #define MGMT_EV_INDEX_ADDED             0x0004
 336
 337 #define MGMT_EV_INDEX_REMOVED           0x0005
 338
 339 #define MGMT_EV_NEW_SETTINGS            0x0006
 340
 341 #define MGMT_EV_CLASS_OF_DEV_CHANGED    0x0007
 342 struct mgmt_ev_class_of_dev_changed {
 343         __u8 dev_class[3];
 344 };
 345
 346 #define MGMT_EV_LOCAL_NAME_CHANGED      0x0008
 347 struct mgmt_ev_local_name_changed {
 348         __u8 name[MGMT_MAX_NAME_LENGTH];
 349         __u8 short_name[MGMT_MAX_SHORT_NAME_LENGTH];
 350 } __packed;
 351
 352 #define MGMT_EV_NEW_LINK_KEY            0x0009
 353 struct mgmt_ev_new_link_key {
 354         __u8 store_hint;
 355         struct mgmt_link_key_info key;
 356 } __packed;
 357
 358 #define MGMT_EV_NEW_LONG_TERM_KEY       0x000A
 359 struct mgmt_ev_new_long_term_key {
 360         __u8 store_hint;
 361         struct mgmt_ltk_info key;
 362 } __packed;
 363
 364 #define MGMT_EV_DEVICE_CONNECTED        0x000B
 365 struct mgmt_ev_device_connected {
 366         struct mgmt_addr_info addr;
 367         __le16 eir_len;
 368         __u8 eir[0];
 369 } __packed;
 370
 371 #define MGMT_EV_DEVICE_DISCONNECTED     0x000C
 372
 373 #define MGMT_EV_CONNECT_FAILED          0x000D
 374 struct mgmt_ev_connect_failed {
 375         struct mgmt_addr_info addr;
 376         __u8 status;
 377 } __packed;
 378
 379 #define MGMT_EV_PIN_CODE_REQUEST        0x000E
 380 struct mgmt_ev_pin_code_request {
 381         struct mgmt_addr_info addr;
 382         __u8 secure;
 383 } __packed;
 384
 385 #define MGMT_EV_USER_CONFIRM_REQUEST    0x000F
 386 struct mgmt_ev_user_confirm_request {
 387         struct mgmt_addr_info addr;
 388         __u8 confirm_hint;
 389         __le32 value;
 390 } __packed;
 391
 392 #define MGMT_EV_USER_PASSKEY_REQUEST    0x0010
 393 struct mgmt_ev_user_passkey_request {
 394         struct mgmt_addr_info addr;
 395 } __packed;
 396
 397 #define MGMT_EV_AUTH_FAILED             0x0011
 398 struct mgmt_ev_auth_failed {
 399         struct mgmt_addr_info addr;
 400         __u8 status;
 401 } __packed;
 402
 403 #define MGMT_EV_DEVICE_FOUND            0x0012
 404 struct mgmt_ev_device_found {
 405         struct mgmt_addr_info addr;
 406         __s8 rssi;
 407         __u8 confirm_name;
 408         __le16 eir_len;
 409         __u8 eir[0];
 410 } __packed;
 411
 412 #define MGMT_EV_DISCOVERING             0x0013
 413
 414 #define MGMT_EV_DEVICE_BLOCKED          0x0014
 415 struct mgmt_ev_device_blocked {
 416         struct mgmt_addr_info addr;
 417 } __packed;
 418
 419 #define MGMT_EV_DEVICE_UNBLOCKED        0x0015
 420 struct mgmt_ev_device_unblocked {
 421         struct mgmt_addr_info addr;
 422 } __packed;
 423
 424 #define MGMT_EV_DEVICE_UNPAIRED         0x0016
 425 struct mgmt_ev_device_unpaired {
 426         struct mgmt_addr_info addr;
 427 } __packed;