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