xref: /btstack/src/hci_transport_h5.h (revision 2fca4dad957cd7b88f4657ed51e89c12615dda72)
1 /*
2  * Copyright (C) 2021 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  * @title HCI Transport H5
40  *
41  */
42 
43 #ifndef HCI_TRANSPORT_H5_H
44 #define HCI_TRANSPORT_H5_H
45 
46 #include "hci_transport.h"
47 #include "btstack_uart.h"
48 
49 #if defined __cplusplus
50 extern "C" {
51 #endif
52 
53 /* API_START */
54 
55 /*
56  * @brief Setup H5 instance with btstack_uart implementation that supports SLIP frames
57  * @param uart_driver to use
58  */
59 const hci_transport_t * hci_transport_h5_instance(const btstack_uart_t * uart_driver);
60 
61 /*
62  * @brief Enable H5 Low Power Mode: enter sleep mode after x ms of inactivity
63  * @param inactivity_timeout_ms or 0 for off
64  */
65 void hci_transport_h5_set_auto_sleep(uint16_t inactivity_timeout_ms);
66 
67 /*
68  * @brief Enable BSCP mode H5, by enabling event parity
69  * @deprecated Parity can be enabled in UART driver configuration
70  */
71 void hci_transport_h5_enable_bcsp_mode(void);
72 
73 /* API_END */
74 
75 #if defined __cplusplus
76 }
77 #endif
78 
79 #endif // HCI_TRANSPORT_H5_H
80