include/net/bluetooth/mgmt.h

   1 /*
   2    BlueZ - Bluetooth protocol stack for Linux
   3
   4    Copyright (C) 2010  Nokia Corporation
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License version 2 as
   8    published by the Free Software Foundation;
   9
  10    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  11    OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  12    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
  13    IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) AND AUTHOR(S) BE LIABLE FOR ANY
  14    CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES
  15    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  16    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  17    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  18
  19    ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
  20    COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
  21    SOFTWARE IS DISCLAIMED.
  22 */
  23
  24 #define MGMT_INDEX_NONE                 0xFFFF
  25
  26 #define MGMT_STATUS_SUCCESS             0x00
  27 #define MGMT_STATUS_UNKNOWN_COMMAND     0x01
  28 #define MGMT_STATUS_NOT_CONNECTED       0x02
  29 #define MGMT_STATUS_FAILED              0x03
  30 #define MGMT_STATUS_CONNECT_FAILED      0x04
  31 #define MGMT_STATUS_AUTH_FAILED         0x05
  32 #define MGMT_STATUS_NOT_PAIRED          0x06
  33 #define MGMT_STATUS_NO_RESOURCES        0x07
  34 #define MGMT_STATUS_TIMEOUT             0x08
  35 #define MGMT_STATUS_ALREADY_CONNECTED   0x09
  36 #define MGMT_STATUS_BUSY                0x0a
  37 #define MGMT_STATUS_REJECTED            0x0b
  38 #define MGMT_STATUS_NOT_SUPPORTED       0x0c
  39 #define MGMT_STATUS_INVALID_PARAMS      0x0d
  40 #define MGMT_STATUS_DISCONNECTED        0x0e
  41 #define MGMT_STATUS_NOT_POWERED         0x0f
  42
  43 struct mgmt_hdr {
  44         __le16 opcode;
  45         __le16 index;
  46         __le16 len;
  47 } __packed;
  48
  49 #define MGMT_OP_READ_VERSION            0x0001
  50 struct mgmt_rp_read_version {
  51         __u8 version;
  52         __le16 revision;
  53 } __packed;
  54
  55 #define MGMT_OP_READ_INDEX_LIST         0x0003
  56 struct mgmt_rp_read_index_list {
  57         __le16 num_controllers;
  58         __le16 index[0];
  59 } __packed;
  60
  61 /* Reserve one extra byte for names in management messages so that they
  62  * are always guaranteed to be nul-terminated */
  63 #define MGMT_MAX_NAME_LENGTH            (HCI_MAX_NAME_LENGTH + 1)
  64 #define MGMT_MAX_SHORT_NAME_LENGTH      (10 + 1)
  65
  66 #define MGMT_SETTING_POWERED            0x00000001
  67 #define MGMT_SETTING_CONNECTABLE        0x00000002
  68 #define MGMT_SETTING_FAST_CONNECTABLE   0x00000004
  69 #define MGMT_SETTING_DISCOVERABLE       0x00000008
  70 #define MGMT_SETTING_PAIRABLE           0x00000010
  71 #define MGMT_SETTING_LINK_SECURITY      0x00000020
  72 #define MGMT_SETTING_SSP                0x00000040
  73 #define MGMT_SETTING_BREDR              0x00000080
  74 #define MGMT_SETTING_HS                 0x00000100
  75 #define MGMT_SETTING_LE                 0x00000200
  76
  77 #define MGMT_OP_READ_INFO               0x0004
  78 struct mgmt_rp_read_info {
  79         bdaddr_t bdaddr;
  80         __u8 version;
  81         __le16 manufacturer;
  82         __le32 supported_settings;
  83         __le32 current_settings;
  84         __u8 dev_class[3];
  85         __u8 name[MGMT_MAX_NAME_LENGTH];
  86         __u8 short_name[MGMT_MAX_SHORT_NAME_LENGTH];
  87 } __packed;
  88
  89 struct mgmt_mode {
  90         __u8 val;
  91 } __packed;
  92
  93 #define MGMT_OP_SET_POWERED             0x0005
  94
  95 #define MGMT_OP_SET_DISCOVERABLE        0x0006
  96 struct mgmt_cp_set_discoverable {
  97         __u8 val;
  98         __u16 timeout;
  99 } __packed;
 100
 101 #define MGMT_OP_SET_CONNECTABLE         0x0007
 102
 103 #define MGMT_OP_SET_FAST_CONNECTABLE    0x001F
 104
 105 #define MGMT_OP_SET_PAIRABLE            0x0008
 106
 107 #define MGMT_OP_ADD_UUID                0x0009
 108 struct mgmt_cp_add_uuid {
 109         __u8 uuid[16];
 110         __u8 svc_hint;
 111 } __packed;
 112
 113 #define MGMT_OP_REMOVE_UUID             0x000A
 114 struct mgmt_cp_remove_uuid {
 115         __u8 uuid[16];
 116 } __packed;
 117
 118 #define MGMT_OP_SET_DEV_CLASS           0x000B
 119 struct mgmt_cp_set_dev_class {
 120         __u8 major;
 121         __u8 minor;
 122 } __packed;
 123
 124 struct mgmt_link_key_info {
 125         bdaddr_t bdaddr;
 126         u8 type;
 127         u8 val[16];
 128         u8 pin_len;
 129 } __packed;
 130
 131 #define MGMT_OP_LOAD_LINK_KEYS          0x000D
 132 struct mgmt_cp_load_link_keys {
 133         __u8 debug_keys;
 134         __le16 key_count;
 135         struct mgmt_link_key_info keys[0];
 136 } __packed;
 137
 138 #define MGMT_OP_REMOVE_KEYS             0x000E
 139 struct mgmt_cp_remove_keys {
 140         bdaddr_t bdaddr;
 141         __u8 disconnect;
 142 } __packed;
 143 struct mgmt_rp_remove_keys {
 144         bdaddr_t bdaddr;
 145         __u8 status;
 146 };
 147
 148 #define MGMT_OP_DISCONNECT              0x000F
 149 struct mgmt_cp_disconnect {
 150         bdaddr_t bdaddr;
 151 } __packed;
 152 struct mgmt_rp_disconnect {
 153         bdaddr_t bdaddr;
 154         __u8 status;
 155 } __packed;
 156
 157 #define MGMT_ADDR_BREDR                 0x00
 158 #define MGMT_ADDR_LE_PUBLIC             0x01
 159 #define MGMT_ADDR_LE_RANDOM             0x02
 160 #define MGMT_ADDR_INVALID               0xff
 161
 162 struct mgmt_addr_info {
 163         bdaddr_t bdaddr;
 164         __u8 type;
 165 } __packed;
 166
 167 #define MGMT_OP_GET_CONNECTIONS         0x0010
 168 struct mgmt_rp_get_connections {
 169         __le16 conn_count;
 170         struct mgmt_addr_info addr[0];
 171 } __packed;
 172
 173 #define MGMT_OP_PIN_CODE_REPLY          0x0011
 174 struct mgmt_cp_pin_code_reply {
 175         bdaddr_t bdaddr;
 176         __u8 pin_len;
 177         __u8 pin_code[16];
 178 } __packed;
 179 struct mgmt_rp_pin_code_reply {
 180         bdaddr_t bdaddr;
 181         uint8_t status;
 182 } __packed;
 183
 184 #define MGMT_OP_PIN_CODE_NEG_REPLY      0x0012
 185 struct mgmt_cp_pin_code_neg_reply {
 186         bdaddr_t bdaddr;
 187 } __packed;
 188
 189 #define MGMT_OP_SET_IO_CAPABILITY       0x0013
 190 struct mgmt_cp_set_io_capability {
 191         __u8 io_capability;
 192 } __packed;
 193
 194 #define MGMT_OP_PAIR_DEVICE             0x0014
 195 struct mgmt_cp_pair_device {
 196         struct mgmt_addr_info addr;
 197         __u8 io_cap;
 198 } __packed;
 199 struct mgmt_rp_pair_device {
 200         struct mgmt_addr_info addr;
 201         __u8 status;
 202 } __packed;
 203
 204 #define MGMT_OP_USER_CONFIRM_REPLY      0x0015
 205 struct mgmt_cp_user_confirm_reply {
 206         bdaddr_t bdaddr;
 207 } __packed;
 208 struct mgmt_rp_user_confirm_reply {
 209         bdaddr_t bdaddr;
 210         __u8 status;
 211 } __packed;
 212
 213 #define MGMT_OP_USER_CONFIRM_NEG_REPLY  0x0016
 214
 215 #define MGMT_OP_SET_LOCAL_NAME          0x0017
 216 struct mgmt_cp_set_local_name {
 217         __u8 name[MGMT_MAX_NAME_LENGTH];
 218 } __packed;
 219
 220 #define MGMT_OP_READ_LOCAL_OOB_DATA     0x0018
 221 struct mgmt_rp_read_local_oob_data {
 222         __u8 hash[16];
 223         __u8 randomizer[16];
 224 } __packed;
 225
 226 #define MGMT_OP_ADD_REMOTE_OOB_DATA     0x0019
 227 struct mgmt_cp_add_remote_oob_data {
 228         bdaddr_t bdaddr;
 229         __u8 hash[16];
 230         __u8 randomizer[16];
 231 } __packed;
 232
 233 #define MGMT_OP_REMOVE_REMOTE_OOB_DATA  0x001A
 234 struct mgmt_cp_remove_remote_oob_data {
 235         bdaddr_t bdaddr;
 236 } __packed;
 237
 238 #define MGMT_OP_START_DISCOVERY         0x001B
 239 struct mgmt_cp_start_discovery {
 240         __u8 type;
 241 } __packed;
 242
 243 #define MGMT_OP_STOP_DISCOVERY          0x001C
 244
 245 #define MGMT_OP_BLOCK_DEVICE            0x001D
 246 struct mgmt_cp_block_device {
 247         bdaddr_t bdaddr;
 248 } __packed;
 249
 250 #define MGMT_OP_UNBLOCK_DEVICE          0x001E
 251 struct mgmt_cp_unblock_device {
 252         bdaddr_t bdaddr;
 253 } __packed;
 254
 255 #define MGMT_OP_USER_PASSKEY_REPLY      0x0020
 256 struct mgmt_cp_user_passkey_reply {
 257         bdaddr_t bdaddr;
 258         __le32 passkey;
 259 } __packed;
 260
 261 #define MGMT_OP_USER_PASSKEY_NEG_REPLY  0x0021
 262 struct mgmt_cp_user_passkey_neg_reply {
 263         bdaddr_t bdaddr;
 264 } __packed;
 265
 266 #define MGMT_EV_CMD_COMPLETE            0x0001
 267 struct mgmt_ev_cmd_complete {
 268         __le16 opcode;
 269         __u8 data[0];
 270 } __packed;
 271
 272 #define MGMT_EV_CMD_STATUS              0x0002
 273 struct mgmt_ev_cmd_status {
 274         __u8 status;
 275         __le16 opcode;
 276 } __packed;
 277
 278 #define MGMT_EV_CONTROLLER_ERROR        0x0003
 279 struct mgmt_ev_controller_error {
 280         __u8 error_code;
 281 } __packed;
 282
 283 #define MGMT_EV_INDEX_ADDED             0x0004
 284
 285 #define MGMT_EV_INDEX_REMOVED           0x0005
 286
 287 #define MGMT_EV_NEW_SETTINGS            0x0006
 288
 289 #define MGMT_EV_DISCOVERABLE            0x0007
 290
 291 #define MGMT_EV_CONNECTABLE             0x0008
 292
 293 #define MGMT_EV_PAIRABLE                0x0009
 294
 295 #define MGMT_EV_NEW_LINK_KEY            0x000A
 296 struct mgmt_ev_new_link_key {
 297         __u8 store_hint;
 298         struct mgmt_link_key_info key;
 299 } __packed;
 300
 301 #define MGMT_EV_CONNECTED               0x000B
 302
 303 #define MGMT_EV_DISCONNECTED            0x000C
 304
 305 #define MGMT_EV_CONNECT_FAILED          0x000D
 306 struct mgmt_ev_connect_failed {
 307         struct mgmt_addr_info addr;
 308         __u8 status;
 309 } __packed;
 310
 311 #define MGMT_EV_PIN_CODE_REQUEST        0x000E
 312 struct mgmt_ev_pin_code_request {
 313         bdaddr_t bdaddr;
 314         __u8 secure;
 315 } __packed;
 316
 317 #define MGMT_EV_USER_CONFIRM_REQUEST    0x000F
 318 struct mgmt_ev_user_confirm_request {
 319         bdaddr_t bdaddr;
 320         __u8 confirm_hint;
 321         __le32 value;
 322 } __packed;
 323
 324 #define MGMT_EV_AUTH_FAILED             0x0010
 325 struct mgmt_ev_auth_failed {
 326         bdaddr_t bdaddr;
 327         __u8 status;
 328 } __packed;
 329
 330 #define MGMT_EV_LOCAL_NAME_CHANGED      0x0011
 331 struct mgmt_ev_local_name_changed {
 332         __u8 name[MGMT_MAX_NAME_LENGTH];
 333 } __packed;
 334
 335 #define MGMT_EV_DEVICE_FOUND            0x0012
 336 struct mgmt_ev_device_found {
 337         struct mgmt_addr_info addr;
 338         __u8 dev_class[3];
 339         __s8 rssi;
 340         __u8 eir[HCI_MAX_EIR_LENGTH];
 341 } __packed;
 342
 343 #define MGMT_EV_REMOTE_NAME             0x0013
 344 struct mgmt_ev_remote_name {
 345         bdaddr_t bdaddr;
 346         __u8 name[MGMT_MAX_NAME_LENGTH];
 347 } __packed;
 348
 349 #define MGMT_EV_DISCOVERING             0x0014
 350
 351 #define MGMT_EV_DEVICE_BLOCKED          0x0015
 352 struct mgmt_ev_device_blocked {
 353         bdaddr_t bdaddr;
 354 } __packed;
 355
 356 #define MGMT_EV_DEVICE_UNBLOCKED        0x0016
 357 struct mgmt_ev_device_unblocked {
 358         bdaddr_t bdaddr;
 359 } __packed;
 360
 361 #define MGMT_EV_USER_PASSKEY_REQUEST    0x0017
 362 struct mgmt_ev_user_passkey_request {
 363         bdaddr_t bdaddr;
 364 } __packed;