summaryrefslogtreecommitdiffstats
path: root/bta/include/bta_pan_api.h
blob: 2b72d6aedd48e39474a7b2b11daf123ce73b5396 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
/*****************************************************************************
**
**  Name:           bta_pan_api.h
**
**  Description:    This is the public interface file for the Personal
**                  Area Networking (PAN) subsystem of BTA, Widcomm's 
**                  Bluetooth application layer for mobile phones.
**
**  Copyright (c) 2004, Widcomm Inc., All Rights Reserved.
**  Widcomm Bluetooth Core. Proprietary and confidential.
**
*****************************************************************************/
#ifndef BTA_PAN_API_H
#define BTA_PAN_API_H

#include "bta_api.h"
#include "pan_api.h"

/*****************************************************************************
**  Constants and data types
*****************************************************************************/
#define BTA_PAN_SUCCESS          0
#define BTA_PAN_FAIL             1

typedef UINT8 tBTA_PAN_STATUS;


/* PAN Callback events */
#define BTA_PAN_ENABLE_EVT       0       /* PAN service is enabled. */
#define BTA_PAN_SET_ROLE_EVT     1       /* PAN roles registered */
#define BTA_PAN_OPENING_EVT      2       /* Connection is being opened. */
#define BTA_PAN_OPEN_EVT         3       /* Connection has been opened. */
#define BTA_PAN_CLOSE_EVT        4       /* Connection has been closed. */

typedef UINT8 tBTA_PAN_EVT;


/* pan roles */
#define BTA_PAN_ROLE_PANU        PAN_ROLE_CLIENT
#define BTA_PAN_ROLE_GN          PAN_ROLE_GN_SERVER
#define BTA_PAN_ROLE_NAP         PAN_ROLE_NAP_SERVER


typedef UINT8   tBTA_PAN_ROLE;

/*  information regarding PAN roles */
typedef struct
{
    char *p_srv_name;  /* service name for the PAN role */
    UINT8 app_id;      /* application id */
    tBTA_SEC sec_mask; /* security setting for the role */

} tBTA_PAN_ROLE_INFO;


/* Event associated with BTA_PAN_SET_ROLE_EVT */
typedef struct
{
    tBTA_PAN_STATUS status;     /* status of set role event */
    tBTA_PAN_ROLE   role;       /* PAN roles successfully registered */
} tBTA_PAN_SET_ROLE;

/* Event associated with BTA_PAN_OPENING_EVT */
typedef struct
{
    BD_ADDR         bd_addr;    /* BD address of peer device. */
    UINT16          handle;     /* Handle associated with this connection. */

} tBTA_PAN_OPENING;


/* Event associated with BTA_PAN_OPEN_EVT */
typedef struct
{
    BD_ADDR         bd_addr;    /* BD address of peer device. */
    UINT16          handle;     /* Handle associated with this connection. */
    tBTA_PAN_STATUS status;     /* status of open event */
    tBTA_PAN_ROLE   local_role; /* Local device PAN role for the connection */
    tBTA_PAN_ROLE   peer_role;  /* Peer device PAN role for the connection */

} tBTA_PAN_OPEN;

/* Event associated with BTA_PAN_CLOSE_EVT */
typedef struct
{
    UINT16          handle;     /* Handle associated with the connection. */
} tBTA_PAN_CLOSE;

/* Union of all PAN callback structures */
typedef union
{
    tBTA_PAN_SET_ROLE   set_role;   /* set_role event */
    tBTA_PAN_OPEN       open;       /* Connection has been opened. */
    tBTA_PAN_OPENING    opening;    /* Connection being opened */
    tBTA_PAN_CLOSE      close;      /* Connection has been closed. */
} tBTA_PAN;

/* Number of PAN connections */
#ifndef BTA_PAN_NUM_CONN
#define BTA_PAN_NUM_CONN         4
#endif

/* PAN callback */
typedef void (tBTA_PAN_CBACK)(tBTA_PAN_EVT event, tBTA_PAN *p_data);

/*****************************************************************************
**  External Function Declarations
*****************************************************************************/
#ifdef __cplusplus
extern "C"
{
#endif

/*******************************************************************************
**
** Function         BTA_PanEnable
**
** Description      Enable PAN service.  This function must be
**                  called before any other functions in the PAN API are called.
**                  When the enable operation is complete the callback function
**                  will be called with a BTA_PAN_ENABLE_EVT. 
**
** Returns          void
**
*******************************************************************************/
BTA_API extern void BTA_PanEnable(tBTA_PAN_CBACK p_cback);

/*******************************************************************************
**
** Function         BTA_PanDisable
**
** Description      Disable PAN service.                   
**
** Returns          void
**
*******************************************************************************/
BTA_API extern void BTA_PanDisable(void);


/*******************************************************************************
**
** Function         BTA_PanSetRole
**
** Description      Sets PAN roles. When the enable operation is complete
**                  the callback function will be called with a BTA_PAN_SET_ROLE_EVT. 
**                  
** Returns          void
**
*******************************************************************************/
BTA_API void BTA_PanSetRole(tBTA_PAN_ROLE role, tBTA_PAN_ROLE_INFO *p_user_info, tBTA_PAN_ROLE_INFO *p_gn_info,
                                        tBTA_PAN_ROLE_INFO *p_nap_info);


/*******************************************************************************
**
** Function         BTA_PanOpen
**
** Description      Opens a connection to a peer device.
**                  When connection is open callback function is called
**                  with a BTA_PAN_OPEN_EVT. 
**                  
**
** Returns          void
**
*******************************************************************************/
BTA_API void BTA_PanOpen(BD_ADDR bd_addr, tBTA_PAN_ROLE    local_role, tBTA_PAN_ROLE  peer_role);



/*******************************************************************************
**
** Function         BTA_PanClose
**
** Description      Close a PAN  connection to a peer device. 
**                  
**
** Returns          void
**
*******************************************************************************/
BTA_API extern void BTA_PanClose(UINT16 handle);


#ifdef __cplusplus
}
#endif

#endif /* BTA_PAN_API_H */