xref: /btstack/platform/lwip/bnep_lwip.h (revision abb61bc22a5228e9b178c541f7c9a87dcafdb1f0)
1 /*
2  * Copyright (C) 2019 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
24  * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 /*
39  *  bnep_lwip.h
40  *  BNEP adapter for lwIP TCP/IP Network Stack
41  *
42  *  Adapter handles all BNEP events and forwards Ethernet frames between an active BNEP connection and the lwIP network stack
43  */
44 
45 #ifndef BNEP_LWIP_H
46 #define BNEP_LWIP_H
47 
48 #include <stdint.h>
49 #include "bluetooth.h"
50 #include "btstack_defines.h"
51 
52 #include "lwip/netif.h"
53 
54 #if defined __cplusplus
55 extern "C" {
56 #endif
57 
58 /**
59  * @brief Initialize BNEP Adapter
60  */
61 void bnep_lwip_init(void);
62 
63 /**
64  * @brief Register packet handler for BNEP events
65  */
66 void bnep_lwip_register_packet_handler(btstack_packet_handler_t handler);
67 
68 /**
69  * @brief Register BNEP service
70  * @brief Same as benp_register_service, but bnep lwip adapter handles all events
71  * @param service_uuid
72  * @Param max_frame_size
73  */
74 uint8_t bnep_lwip_register_service(uint16_t service_uuid, uint16_t max_frame_size);
75 
76 /**
77  * @brief Creates BNEP connection (channel) to a given server on a remote device with baseband address. A new baseband connection will be initiated if necessary.
78  * @param addr
79  * @param l2cap_psm
80  * @param uuid_src
81  * @param uuid_dest
82  */
83 uint8_t bnep_lwip_connect(bd_addr_t addr, uint16_t l2cap_psm, uint16_t uuid_src, uint16_t uuid_dest);
84 
85 /**
86  * @brief Get the Bluetooth lwIP network interface
87  */
88 struct netif *bnep_lwip_get_interface(void);
89 
90 #if defined __cplusplus
91 }
92 #endif
93 
94 #endif
95