091d0a43122e4a0a92bd6d0492adb0cc501b37fb
[dragonfly.git] / sys / netgraph7 / bluetooth / include / ng_h4.h
1 /*
2  * ng_h4.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_h4.h,v 1.1 2002/11/24 19:47:05 max Exp $
31  * $FreeBSD: src/sys/netgraph/bluetooth/include/ng_h4.h,v 1.5 2005/01/07 01:45:43 imp Exp $
32  * $DragonFly: src/sys/netgraph7/bluetooth/include/ng_h4.h,v 1.2 2008/06/26 23:05:40 dillon Exp $
33  * 
34  * Based on:
35  * ---------
36  *
37  * FreeBSD: src/sys/netgraph/ng_tty.h
38  * Author: Archie Cobbs <archie@freebsd.org>
39  */
40
41 /*
42  * This file contains everything that application needs to know about
43  * Bluetooth HCI UART transport layer as per chapter H4 of the Bluetooth
44  * Specification Book v1.1.
45  *
46  * This file can be included by both kernel and userland applications.
47  */
48
49 #ifndef _NETGRAPH_H4_H_
50 #define _NETGRAPH_H4_H_
51
52 /**************************************************************************
53  **************************************************************************
54  **     Netgraph node hook name, type name and type cookie and commands
55  **************************************************************************
56  **************************************************************************/
57
58 /* Hook name */
59 #define NG_H4_HOOK              "hook"
60
61 /* Node type name and magic cookie */
62 #define NG_H4_NODE_TYPE         "h4"
63 #define NGM_H4_COOKIE           1013899512
64
65 /* Node states */
66 #define NG_H4_W4_PKT_IND        1       /* Waiting for packet indicator */
67 #define NG_H4_W4_PKT_HDR        2       /* Waiting for packet header */
68 #define NG_H4_W4_PKT_DATA       3       /* Waiting for packet data */
69
70 /* Debug levels */
71 #define NG_H4_ALERT_LEVEL       1
72 #define NG_H4_ERR_LEVEL         2
73 #define NG_H4_WARN_LEVEL        3
74 #define NG_H4_INFO_LEVEL        4
75
76 /**************************************************************************
77  **************************************************************************
78  **                    H4 node command/event parameters
79  **************************************************************************
80  **************************************************************************/
81
82 /* Reset node */
83 #define NGM_H4_NODE_RESET       1
84
85 /* Get node state (see states above) */
86 #define NGM_H4_NODE_GET_STATE   2
87 typedef u_int16_t       ng_h4_node_state_ep;
88
89 /* Get/Set node debug level (see levels above) */
90 #define NGM_H4_NODE_GET_DEBUG   3
91 #define NGM_H4_NODE_SET_DEBUG   4
92 typedef u_int16_t       ng_h4_node_debug_ep;
93
94 /* Get/Set max queue length for the node */
95 #define NGM_H4_NODE_GET_QLEN    5
96 #define NGM_H4_NODE_SET_QLEN    6
97 typedef int32_t         ng_h4_node_qlen_ep;
98
99 /* Get node statistic */
100 #define NGM_H4_NODE_GET_STAT    7
101 typedef struct {
102         u_int32_t       pckts_recv; /* # of packets received */
103         u_int32_t       bytes_recv; /* # of bytes received */
104         u_int32_t       pckts_sent; /* # of packets sent */
105         u_int32_t       bytes_sent; /* # of bytes sent */
106         u_int32_t       oerrors;    /* # of output errors */
107         u_int32_t       ierrors;    /* # of input errors */
108 } ng_h4_node_stat_ep;
109
110 /* Reset node statistic */
111 #define NGM_H4_NODE_RESET_STAT  8
112
113 #endif /* _NETGRAPH_H4_H_ */
114