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