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