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 BTstack to use different transport interfaces 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 "btstack_uart_block.h" 51 #include "btstack_run_loop.h" 52 53 #if defined __cplusplus 54 extern "C" { 55 #endif 56 57 /* API_START */ 58 59 /* HCI packet types */ 60 typedef struct { 61 /** 62 * transport name 63 */ 64 const char * name; 65 66 /** 67 * init transport 68 * @param transport_config 69 */ 70 void (*init) (const void *transport_config); 71 72 /** 73 * open transport connection 74 */ 75 int (*open)(void); 76 77 /** 78 * close transport connection 79 */ 80 int (*close)(void); 81 82 /** 83 * register packet handler for HCI packets: ACL, SCO, and Events 84 */ 85 void (*register_packet_handler)(void (*handler)(uint8_t packet_type, uint8_t *packet, uint16_t size)); 86 87 /** 88 * support async transport layers, e.g. IRQ driven without buffers 89 */ 90 int (*can_send_packet_now)(uint8_t packet_type); 91 92 /** 93 * send packet 94 */ 95 int (*send_packet)(uint8_t packet_type, uint8_t *packet, int size); 96 97 /** 98 * extension for UART transport implementations 99 */ 100 int (*set_baudrate)(uint32_t baudrate); 101 102 /** 103 * extension for UART H5 on CSR: reset BCSP/H5 Link 104 */ 105 void (*reset_link)(void); 106 107 /** 108 * extension for USB transport implementations: config SCO connections 109 */ 110 void (*set_sco_config)(uint16_t voice_setting, int num_connections); 111 112 } hci_transport_t; 113 114 typedef enum { 115 HCI_TRANSPORT_CONFIG_UART, 116 HCI_TRANSPORT_CONFIG_USB 117 } hci_transport_config_type_t; 118 119 typedef struct { 120 hci_transport_config_type_t type; 121 } hci_transport_config_t; 122 123 typedef struct { 124 hci_transport_config_type_t type; // == HCI_TRANSPORT_CONFIG_UART 125 uint32_t baudrate_init; // initial baud rate 126 uint32_t baudrate_main; // = 0: same as initial baudrate 127 int flowcontrol; // 128 const char *device_name; 129 } hci_transport_config_uart_t; 130 131 132 // inline various hci_transport_X.h files 133 134 /* 135 * @brief Setup H4 instance with uart_driver 136 * @param uart_driver to use 137 */ 138 const hci_transport_t * hci_transport_h4_instance(const btstack_uart_block_t * uart_driver); 139 140 /* 141 * @brief Setup H5 instance with uart_driver 142 * @param uart_driver to use 143 */ 144 const hci_transport_t * hci_transport_h5_instance(const btstack_uart_block_t * uart_driver); 145 146 /* 147 * @brief Enable H5 Low Power Mode: enter sleep mode after x ms of inactivity 148 * @param inactivity_timeout_ms or 0 for off 149 */ 150 void hci_transport_h5_set_auto_sleep(uint16_t inactivity_timeout_ms); 151 152 /* 153 * @brief Enable BSCP mode H5, by enabling event parity 154 */ 155 void hci_transport_h5_enable_bcsp_mode(void); 156 157 /* 158 * @brief 159 */ 160 const hci_transport_t * hci_transport_usb_instance(void); 161 162 /** 163 * @brief Specify USB Bluetooth device via port numbers from root to device 164 */ 165 void hci_transport_usb_set_path(int len, uint8_t * port_numbers); 166 167 /* API_END */ 168 169 #if defined __cplusplus 170 } 171 #endif 172 173 #endif // __HCI_TRANSPORT_H 174