xref: /btstack/src/hci_transport.h (revision 16ece13520cb8efcf94cb63eab58a3eda87f40a2)
1 /*
2  * Copyright (C) 2014 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 MATTHIAS
24  * RINGWALD 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  *  hci_transport.h
40  *
41  *  HCI Transport API -- allows BT Daemon to use different transport protcols
42  *
43  *  Created by Matthias Ringwald on 4/29/09.
44  *
45  */
46 #ifndef __HCI_TRANSPORT_H
47 #define __HCI_TRANSPORT_H
48 
49 #include <stdint.h>
50 #include "run_loop.h"
51 
52 #if defined __cplusplus
53 extern "C" {
54 #endif
55 
56 /* API_START */
57 
58 /* HCI packet types */
59 typedef struct {
60     int    (*open)(void *transport_config);
61     int    (*close)(void *transport_config);
62     int    (*send_packet)(uint8_t packet_type, uint8_t *packet, int size);
63     void   (*register_packet_handler)(void (*handler)(uint8_t packet_type, uint8_t *packet, uint16_t size));
64     const char * (*get_transport_name)(void);
65     // custom extension for UART transport implementations
66     int    (*set_baudrate)(uint32_t baudrate);
67     // support async transport layers, e.g. IRQ driven without buffers
68     int    (*can_send_packet_now)(uint8_t packet_type);
69 } hci_transport_t;
70 
71 typedef enum {
72     HCI_TRANSPORT_CONFIG_UART,
73     HCI_TRANSPORT_CONFIG_USB
74 } hci_transport_config_type_t;
75 
76 typedef struct {
77     hci_transport_config_type_t type;
78 } hci_transport_config_t;
79 
80 typedef struct {
81     hci_transport_config_type_t type; // == HCI_TRANSPORT_CONFIG_UART
82     uint32_t   baudrate_init; // initial baud rate
83     uint32_t   baudrate_main; // = 0: same as initial baudrate
84     int        flowcontrol;   //
85     const char *device_name;
86 } hci_transport_config_uart_t;
87 
88 
89 // inline various hci_transport_X.h files
90 
91 /*
92  * @brief
93  */
94 extern hci_transport_t * hci_transport_h4_posix_instance(void);
95 
96 /*
97  * @brief
98  */
99 extern hci_transport_t * hci_transport_h4_dma_instance(void);
100 
101 /*
102  * @brief
103  */
104 extern hci_transport_t * hci_transport_h4_iphone_instance(void);
105 
106 /*
107  * @brief
108  */
109 extern hci_transport_t * hci_transport_h4_wiced_instance();
110 
111 /*
112  * @brief
113  */
114 extern hci_transport_t * hci_transport_usb_instance(void);
115 
116 
117 /* API_END */
118 
119 // support for "enforece wake device" in h4 - used by iOS power management
120 extern void hci_transport_h4_iphone_set_enforce_wake_device(char *path);
121 
122 #if defined __cplusplus
123 }
124 #endif
125 
126 #endif // __HCI_TRANSPORT_H
127