xref: /dragonfly/sys/netgraph7/bluetooth/l2cap/ng_l2cap_var.h (revision 805c8e8e4093ceca2e27510ad3a66d4de8060a55)
1 /*
2  * ng_l2cap_var.h
3  */
4 
5 /*-
6  * Copyright (c) 2001 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_l2cap_var.h,v 1.2 2003/04/28 21:44:59 max Exp $
31  * $FreeBSD: src/sys/netgraph/bluetooth/l2cap/ng_l2cap_var.h,v 1.6 2005/01/07 01:45:43 imp Exp $
32  */
33 
34 #ifndef _NETGRAPH_L2CAP_VAR_H_
35 #define _NETGRAPH_L2CAP_VAR_H_
36 
37 /* MALLOC decalation */
38 #ifdef NG_SEPARATE_MALLOC
39 #ifdef MALLOC_DECLARE
40 MALLOC_DECLARE(M_NETGRAPH_L2CAP);
41 #endif
42 #else
43 #define M_NETGRAPH_L2CAP M_NETGRAPH
44 #endif /* NG_SEPARATE_MALLOC */
45 
46 /* Debug */
47 #define   NG_L2CAP_ALERT      if (l2cap->debug >= NG_L2CAP_ALERT_LEVEL) kprintf
48 #define   NG_L2CAP_ERR        if (l2cap->debug >= NG_L2CAP_ERR_LEVEL)   kprintf
49 #define   NG_L2CAP_WARN       if (l2cap->debug >= NG_L2CAP_WARN_LEVEL)  kprintf
50 #define   NG_L2CAP_INFO       if (l2cap->debug >= NG_L2CAP_INFO_LEVEL)  kprintf
51 
52 /* Wrapper around m_pullup */
53 #define NG_L2CAP_M_PULLUP(m, s) \
54           do { \
55                     if ((m)->m_len < (s)) \
56                               (m) = m_pullup((m), (s)); \
57                     if ((m) == NULL) \
58                               NG_L2CAP_ALERT("%s: %s - m_pullup(%zd) failed\n", \
59                                         __func__, NG_NODE_NAME(l2cap->node), (s)); \
60           } while (0)
61 
62 /*
63  * L2CAP signaling command ident's are assigned relative to the connection,
64  * because there is only one signaling channel (cid == 0x01) for every
65  * connection. So up to 254 (0xff - 0x01) L2CAP commands can be pending at the
66  * same time for the same connection.
67  */
68 
69 #define NG_L2CAP_NULL_IDENT   0x00        /* DO NOT USE THIS IDENT */
70 #define NG_L2CAP_FIRST_IDENT  0x01        /* dynamically alloc. (start) */
71 #define NG_L2CAP_LAST_IDENT   0xff        /* dynamically alloc. (end) */
72 
73 /*
74  * L2CAP (Node private)
75  */
76 
77 struct ng_l2cap_con;
78 struct ng_l2cap_chan;
79 
80 typedef struct ng_l2cap {
81           node_p                                  node;         /* node ptr */
82 
83           ng_l2cap_node_debug_ep                  debug;        /* debug level */
84           ng_l2cap_node_flags_ep                  flags;        /* L2CAP node flags */
85           ng_l2cap_node_auto_discon_ep  discon_timo;  /* auto discon. timeout */
86 
87           u_int16_t                     pkt_size;     /* max. ACL packet size */
88           u_int16_t                     num_pkts;     /* out queue size */
89           bdaddr_t                      bdaddr;       /* unit BDADDR */
90 
91           hook_p                                  hci;          /* HCI downstream hook */
92           hook_p                                  l2c;          /* L2CAP upstream hook */
93           hook_p                                  ctl;          /* control hook */
94 
95           LIST_HEAD(, ng_l2cap_con)     con_list;     /* ACL connections */
96 
97           u_int16_t                     cid;          /* last allocated CID */
98           LIST_HEAD(, ng_l2cap_chan)    chan_list;    /* L2CAP channels */
99 } ng_l2cap_t;
100 typedef ng_l2cap_t *                              ng_l2cap_p;
101 
102 /*
103  * L2CAP connection descriptor
104  */
105 
106 struct ng_l2cap_cmd;
107 
108 typedef struct ng_l2cap_con {
109           ng_l2cap_p                               l2cap;      /* pointer to L2CAP */
110 
111           u_int16_t                      state;      /* ACL connection state */
112           u_int16_t                      flags;      /* ACL connection flags */
113 
114           int32_t                                  refcnt;     /* reference count */
115 
116           bdaddr_t                       remote;     /* remote unit address */
117           u_int16_t                      con_handle; /* ACL connection handle */
118           struct callout                           con_timo;   /* connection timeout */
119 
120           u_int8_t                       ident;      /* last allocated ident */
121           TAILQ_HEAD(, ng_l2cap_cmd)     cmd_list;   /* pending L2CAP cmds */
122 
123           struct mbuf                             *tx_pkt;     /* xmitted L2CAP packet */
124           int                                      pending;    /* num. of pending pkts */
125 
126           struct mbuf                             *rx_pkt;     /* received L2CAP packet */
127           int                                      rx_pkt_len; /* packet len. so far */
128 
129           LIST_ENTRY(ng_l2cap_con)       next;       /* link */
130 } ng_l2cap_con_t;
131 typedef ng_l2cap_con_t *                ng_l2cap_con_p;
132 
133 /*
134  * L2CAP channel descriptor
135  */
136 
137 typedef struct ng_l2cap_chan {
138           ng_l2cap_con_p                          con;        /* pointer to connection */
139 
140           u_int16_t                     state;      /* channel state */
141 
142           u_int8_t                      cfg_state;  /* configuration state */
143 #define NG_L2CAP_CFG_IN                           (1 << 0)    /* incoming cfg path done */
144 #define NG_L2CAP_CFG_OUT                (1 << 1)    /* outgoing cfg path done */
145 #define NG_L2CAP_CFG_BOTH               (NG_L2CAP_CFG_IN|NG_L2CAP_CFG_OUT)
146 
147           u_int8_t                      ident;      /* last L2CAP req. ident */
148 
149           u_int16_t                     psm;        /* channel PSM */
150           u_int16_t                     scid;       /* source channel ID */
151           u_int16_t                     dcid;       /* destination channel ID */
152 
153           u_int16_t                     imtu;       /* incoming channel MTU */
154           ng_l2cap_flow_t                         iflow;      /* incoming flow control */
155 
156           u_int16_t                     omtu;       /* outgoing channel MTU */
157           ng_l2cap_flow_t                         oflow;      /* outgoing flow control */
158 
159           u_int16_t                     flush_timo; /* flush timeout */
160           u_int16_t                     link_timo;  /* link timeout */
161 
162           LIST_ENTRY(ng_l2cap_chan)     next;       /* link */
163 } ng_l2cap_chan_t;
164 typedef ng_l2cap_chan_t *               ng_l2cap_chan_p;
165 
166 /*
167  * L2CAP command descriptor
168  */
169 
170 typedef struct ng_l2cap_cmd {
171           ng_l2cap_con_p                           con;       /* L2CAP connection */
172           ng_l2cap_chan_p                          ch;        /* L2CAP channel */
173 
174           u_int16_t                                flags;     /* command flags */
175 #define NG_L2CAP_CMD_PENDING             (1 << 0)   /* command is pending */
176 
177           u_int8_t                       code;      /* L2CAP command opcode */
178           u_int8_t                       ident;     /* L2CAP command ident */
179           u_int32_t                      token;     /* L2CA message token */
180 
181           struct callout                           timo;      /* RTX/ERTX timeout */
182 
183           struct mbuf                             *aux;       /* optional data */
184 
185           TAILQ_ENTRY(ng_l2cap_cmd)      next;      /* link */
186 } ng_l2cap_cmd_t;
187 typedef ng_l2cap_cmd_t *                ng_l2cap_cmd_p;
188 
189 #endif /* ndef _NETGRAPH_L2CAP_VAR_H_ */
190 
191