sys/netgraph7/bluetooth/include/ng_btsocket.h

   1 /*
   2  * ng_btsocket.h
   3  */
   4
   5 /*-
   6  * Copyright (c) 2001-2002 Maksim Yevmenkin <m_evmenkin@yahoo.com>
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  *
  30  * $Id: ng_btsocket.h,v 1.8 2003/04/26 22:32:10 max Exp $
  31  * $FreeBSD: src/sys/netgraph/bluetooth/include/ng_btsocket.h,v 1.8 2006/05/17 00:13:06 emax Exp $
  32  * $DragonFly: src/sys/netgraph7/bluetooth/include/ng_btsocket.h,v 1.2 2008/06/26 23:05:40 dillon Exp $
  33  */
  34
  35 #ifndef _NETGRAPH_BTSOCKET_H_
  36 #define _NETGRAPH_BTSOCKET_H_
  37
  38 #include <sys/ioccom.h>
  39
  40 /*
  41  * Bluetooth protocols
  42  */
  43
  44 #define BLUETOOTH_PROTO_HCI     134     /* HCI protocol number */
  45 #define BLUETOOTH_PROTO_L2CAP   135     /* L2CAP protocol number */
  46 #define BLUETOOTH_PROTO_RFCOMM  136     /* RFCOMM protocol number */
  47
  48 /*
  49  * Bluetooth version of struct sockaddr for raw HCI sockets
  50  */
  51
  52 struct sockaddr_hci {
  53         u_char          hci_len;        /* total length */
  54         u_char          hci_family;     /* address family */
  55         char            hci_node[32];   /* address (size == NG_NODESIZ ) */
  56 };
  57
  58 /* Raw HCI socket options */
  59 #define SOL_HCI_RAW             0x0802  /* socket options level */
  60
  61 #define SO_HCI_RAW_FILTER       1       /* get/set filter on socket */
  62 #define SO_HCI_RAW_DIRECTION    2       /* turn on/off direction info */
  63 #define SCM_HCI_RAW_DIRECTION   SO_HCI_RAW_DIRECTION /* cmsg_type  */
  64
  65 /*
  66  * Raw HCI socket filter.
  67  *
  68  * For packet mask use (1 << (HCI packet indicator - 1))
  69  * For event mask use (1 << (Event - 1))
  70  */
  71
  72 struct ng_btsocket_hci_raw_filter {
  73         bitstr_t        bit_decl(packet_mask, 32);
  74         bitstr_t        bit_decl(event_mask, (NG_HCI_EVENT_MASK_SIZE * 8));
  75 };
  76
  77 /*
  78  * Raw HCI sockets ioctl's
  79  */
  80
  81 /* Get state */
  82 struct ng_btsocket_hci_raw_node_state {
  83         ng_hci_node_state_ep    state;
  84 };
  85 #define SIOC_HCI_RAW_NODE_GET_STATE \
  86         _IOWR('b', NGM_HCI_NODE_GET_STATE, \
  87                 struct ng_btsocket_hci_raw_node_state)
  88
  89 /* Initialize */
  90 #define SIOC_HCI_RAW_NODE_INIT \
  91         _IO('b', NGM_HCI_NODE_INIT)
  92
  93 /* Get/Set debug level */
  94 struct ng_btsocket_hci_raw_node_debug {
  95         ng_hci_node_debug_ep    debug;
  96 };
  97 #define SIOC_HCI_RAW_NODE_GET_DEBUG \
  98         _IOWR('b', NGM_HCI_NODE_GET_DEBUG, \
  99                 struct ng_btsocket_hci_raw_node_debug)
 100 #define SIOC_HCI_RAW_NODE_SET_DEBUG \
 101         _IOWR('b', NGM_HCI_NODE_SET_DEBUG, \
 102                 struct ng_btsocket_hci_raw_node_debug)
 103
 104 /* Get buffer info */
 105 struct ng_btsocket_hci_raw_node_buffer {
 106         ng_hci_node_buffer_ep   buffer;
 107 };
 108 #define SIOC_HCI_RAW_NODE_GET_BUFFER \
 109         _IOWR('b', NGM_HCI_NODE_GET_BUFFER, \
 110                 struct ng_btsocket_hci_raw_node_buffer)
 111
 112 /* Get BD_ADDR */
 113 struct ng_btsocket_hci_raw_node_bdaddr {
 114         bdaddr_t        bdaddr;
 115 };
 116 #define SIOC_HCI_RAW_NODE_GET_BDADDR \
 117         _IOWR('b', NGM_HCI_NODE_GET_BDADDR, \
 118                 struct ng_btsocket_hci_raw_node_bdaddr)
 119
 120 /* Get features */
 121 struct ng_btsocket_hci_raw_node_features {
 122         u_int8_t        features[NG_HCI_FEATURES_SIZE];
 123 };
 124 #define SIOC_HCI_RAW_NODE_GET_FEATURES \
 125         _IOWR('b', NGM_HCI_NODE_GET_FEATURES, \
 126                 struct ng_btsocket_hci_raw_node_features)
 127
 128 /* Get stat */
 129 struct ng_btsocket_hci_raw_node_stat {
 130         ng_hci_node_stat_ep     stat;
 131 };
 132 #define SIOC_HCI_RAW_NODE_GET_STAT \
 133         _IOWR('b', NGM_HCI_NODE_GET_STAT, \
 134                 struct ng_btsocket_hci_raw_node_stat)
 135
 136 /* Reset stat */
 137 #define SIOC_HCI_RAW_NODE_RESET_STAT \
 138         _IO('b', NGM_HCI_NODE_RESET_STAT)
 139
 140 /* Flush neighbor cache */
 141 #define SIOC_HCI_RAW_NODE_FLUSH_NEIGHBOR_CACHE \
 142         _IO('b', NGM_HCI_NODE_FLUSH_NEIGHBOR_CACHE)
 143
 144 /* Get neighbor cache */
 145 struct ng_btsocket_hci_raw_node_neighbor_cache {
 146         u_int32_t                                num_entries;
 147         ng_hci_node_neighbor_cache_entry_ep     *entries;
 148 };
 149 #define SIOC_HCI_RAW_NODE_GET_NEIGHBOR_CACHE \
 150         _IOWR('b', NGM_HCI_NODE_GET_NEIGHBOR_CACHE, \
 151                 struct ng_btsocket_hci_raw_node_neighbor_cache)
 152
 153 /* Get connection list */
 154 struct ng_btsocket_hci_raw_con_list {
 155         u_int32_t                num_connections;
 156         ng_hci_node_con_ep      *connections;
 157 };
 158 #define SIOC_HCI_RAW_NODE_GET_CON_LIST \
 159         _IOWR('b', NGM_HCI_NODE_GET_CON_LIST, \
 160                 struct ng_btsocket_hci_raw_con_list)
 161
 162 /* Get/Set link policy settings mask */
 163 struct ng_btsocket_hci_raw_node_link_policy_mask {
 164         ng_hci_node_link_policy_mask_ep policy_mask;
 165 };
 166 #define SIOC_HCI_RAW_NODE_GET_LINK_POLICY_MASK \
 167         _IOWR('b', NGM_HCI_NODE_GET_LINK_POLICY_SETTINGS_MASK, \
 168                 struct ng_btsocket_hci_raw_node_link_policy_mask)
 169 #define SIOC_HCI_RAW_NODE_SET_LINK_POLICY_MASK \
 170         _IOWR('b', NGM_HCI_NODE_SET_LINK_POLICY_SETTINGS_MASK, \
 171                 struct ng_btsocket_hci_raw_node_link_policy_mask)
 172
 173 /* Get/Set packet mask */
 174 struct ng_btsocket_hci_raw_node_packet_mask {
 175         ng_hci_node_packet_mask_ep      packet_mask;
 176 };
 177 #define SIOC_HCI_RAW_NODE_GET_PACKET_MASK \
 178         _IOWR('b', NGM_HCI_NODE_GET_PACKET_MASK, \
 179                 struct ng_btsocket_hci_raw_node_packet_mask)
 180 #define SIOC_HCI_RAW_NODE_SET_PACKET_MASK \
 181         _IOWR('b', NGM_HCI_NODE_SET_PACKET_MASK, \
 182                 struct ng_btsocket_hci_raw_node_packet_mask)
 183
 184 /* Get/Set role switch */
 185 struct ng_btsocket_hci_raw_node_role_switch {
 186         ng_hci_node_role_switch_ep      role_switch;
 187 };
 188 #define SIOC_HCI_RAW_NODE_GET_ROLE_SWITCH \
 189         _IOWR('b', NGM_HCI_NODE_GET_ROLE_SWITCH, \
 190                 struct ng_btsocket_hci_raw_node_role_switch)
 191 #define SIOC_HCI_RAW_NODE_SET_ROLE_SWITCH \
 192         _IOWR('b', NGM_HCI_NODE_SET_ROLE_SWITCH, \
 193                 struct ng_btsocket_hci_raw_node_role_switch)
 194
 195 /* Get list of HCI node names */
 196 struct ng_btsocket_hci_raw_node_list_names {
 197         u_int32_t        num_names;
 198         struct nodeinfo *names;
 199 };
 200 #define SIOC_HCI_RAW_NODE_LIST_NAMES \
 201         _IOWR('b', NGM_HCI_NODE_LIST_NAMES, \
 202                 struct ng_btsocket_hci_raw_node_list_names)
 203
 204 /*
 205  * XXX FIXME: probably does not belong here
 206  * Bluetooth version of struct sockaddr for L2CAP sockets (RAW and SEQPACKET)
 207  */
 208
 209 struct sockaddr_l2cap {
 210         u_char          l2cap_len;      /* total length */
 211         u_char          l2cap_family;   /* address family */
 212         u_int16_t       l2cap_psm;      /* PSM (Protocol/Service Multiplexor) */
 213         bdaddr_t        l2cap_bdaddr;   /* address */
 214 };
 215
 216 /* L2CAP socket options */
 217 #define SOL_L2CAP               0x1609  /* socket option level */
 218
 219 #define SO_L2CAP_IMTU           1       /* get/set incoming MTU */
 220 #define SO_L2CAP_OMTU           2       /* get outgoing (peer incoming) MTU */
 221 #define SO_L2CAP_IFLOW          3       /* get incoming flow spec. */
 222 #define SO_L2CAP_OFLOW          4       /* get/set outgoing flow spec. */
 223 #define SO_L2CAP_FLUSH          5       /* get/set flush timeout */
 224
 225 /*
 226  * Raw L2CAP sockets ioctl's
 227  */
 228
 229 /* Ping */
 230 struct ng_btsocket_l2cap_raw_ping {
 231         u_int32_t                result;
 232         u_int32_t                echo_size;
 233         u_int8_t                *echo_data;
 234 };
 235 #define SIOC_L2CAP_L2CA_PING \
 236         _IOWR('b', NGM_L2CAP_L2CA_PING, \
 237                 struct ng_btsocket_l2cap_raw_ping)
 238
 239 /* Get info */
 240 struct ng_btsocket_l2cap_raw_get_info {
 241         u_int32_t                result;
 242         u_int32_t                info_type;
 243         u_int32_t                info_size;
 244         u_int8_t                *info_data;
 245 };
 246 #define SIOC_L2CAP_L2CA_GET_INFO \
 247         _IOWR('b', NGM_L2CAP_L2CA_GET_INFO, \
 248                 struct ng_btsocket_l2cap_raw_get_info)
 249
 250 /* Get flags */
 251 struct ng_btsocket_l2cap_raw_node_flags {
 252         ng_l2cap_node_flags_ep  flags;
 253 };
 254 #define SIOC_L2CAP_NODE_GET_FLAGS \
 255         _IOWR('b', NGM_L2CAP_NODE_GET_FLAGS, \
 256                 struct ng_btsocket_l2cap_raw_node_flags)
 257
 258 /* Get/Set debug level */
 259 struct ng_btsocket_l2cap_raw_node_debug {
 260         ng_l2cap_node_debug_ep  debug;
 261 };
 262 #define SIOC_L2CAP_NODE_GET_DEBUG \
 263         _IOWR('b', NGM_L2CAP_NODE_GET_DEBUG, \
 264                 struct ng_btsocket_l2cap_raw_node_debug)
 265 #define SIOC_L2CAP_NODE_SET_DEBUG \
 266         _IOWR('b', NGM_L2CAP_NODE_SET_DEBUG, \
 267                 struct ng_btsocket_l2cap_raw_node_debug)
 268
 269 /* Get connection list */
 270 struct ng_btsocket_l2cap_raw_con_list {
 271         u_int32_t                num_connections;
 272         ng_l2cap_node_con_ep    *connections;
 273 };
 274 #define SIOC_L2CAP_NODE_GET_CON_LIST \
 275         _IOWR('b', NGM_L2CAP_NODE_GET_CON_LIST, \
 276                 struct ng_btsocket_l2cap_raw_con_list)
 277
 278 /* Get channel list */
 279 struct ng_btsocket_l2cap_raw_chan_list {
 280         u_int32_t                num_channels;
 281         ng_l2cap_node_chan_ep   *channels;
 282 };
 283 #define SIOC_L2CAP_NODE_GET_CHAN_LIST \
 284         _IOWR('b', NGM_L2CAP_NODE_GET_CHAN_LIST, \
 285                 struct ng_btsocket_l2cap_raw_chan_list)
 286
 287 /* Get/Set auto disconnect timeout */
 288 struct ng_btsocket_l2cap_raw_auto_discon_timo
 289 {
 290         ng_l2cap_node_auto_discon_ep    timeout;
 291 };
 292 #define SIOC_L2CAP_NODE_GET_AUTO_DISCON_TIMO \
 293         _IOWR('b', NGM_L2CAP_NODE_GET_AUTO_DISCON_TIMO, \
 294                 struct ng_btsocket_l2cap_raw_auto_discon_timo)
 295 #define SIOC_L2CAP_NODE_SET_AUTO_DISCON_TIMO \
 296         _IOWR('b', NGM_L2CAP_NODE_SET_AUTO_DISCON_TIMO, \
 297                 struct ng_btsocket_l2cap_raw_auto_discon_timo)
 298
 299 /*
 300  * XXX FIXME: probably does not belong here
 301  * Bluetooth version of struct sockaddr for RFCOMM sockets (STREAM)
 302  */
 303
 304 struct sockaddr_rfcomm {
 305         u_char          rfcomm_len;     /* total length */
 306         u_char          rfcomm_family;  /* address family */
 307         bdaddr_t        rfcomm_bdaddr;  /* address */
 308         u_int8_t        rfcomm_channel; /* channel */
 309 };
 310
 311 /* Flow control information */
 312 struct ng_btsocket_rfcomm_fc_info {
 313         u_int8_t        lmodem;         /* modem signals (local) */
 314         u_int8_t        rmodem;         /* modem signals (remote) */
 315         u_int8_t        tx_cred;        /* TX credits */
 316         u_int8_t        rx_cred;        /* RX credits */
 317         u_int8_t        cfc;            /* credit flow control */
 318         u_int8_t        reserved;
 319 };
 320
 321 /* STREAM RFCOMM socket options */
 322 #define SOL_RFCOMM              0x0816  /* socket options level */
 323
 324 #define SO_RFCOMM_MTU           1       /* get channel MTU */
 325 #define SO_RFCOMM_FC_INFO       2       /* get flow control information */
 326
 327 /*
 328  * Netgraph node type name and cookie
 329  */
 330
 331 #define NG_BTSOCKET_HCI_RAW_NODE_TYPE   "btsock_hci_raw"
 332 #define NG_BTSOCKET_L2CAP_RAW_NODE_TYPE "btsock_l2c_raw"
 333 #define NG_BTSOCKET_L2CAP_NODE_TYPE     "btsock_l2c"
 334
 335 /*
 336  * Debug levels
 337  */
 338
 339 #define NG_BTSOCKET_ALERT_LEVEL 1
 340 #define NG_BTSOCKET_ERR_LEVEL   2
 341 #define NG_BTSOCKET_WARN_LEVEL  3
 342 #define NG_BTSOCKET_INFO_LEVEL  4
 343
 344 #endif /* _NETGRAPH_BTSOCKET_H_ */
 345