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 "btstack_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 /** 61 * transport name 62 */ 63 const char * name; 64 65 /** 66 * init transport 67 * @param transport_config 68 */ 69 void (*init) (const void *transport_config); 70 71 /** 72 * open transport connection 73 */ 74 int (*open)(void); 75 76 /** 77 * close transport connection 78 */ 79 int (*close)(void); 80 81 /** 82 * register packet handler for HCI packets: ACL, SCO, and Events 83 */ 84 void (*register_packet_handler)(void (*handler)(uint8_t packet_type, uint8_t *packet, uint16_t size)); 85 86 /** 87 * support async transport layers, e.g. IRQ driven without buffers 88 */ 89 int (*can_send_packet_now)(uint8_t packet_type); 90 91 /** 92 * send packet 93 */ 94 int (*send_packet)(uint8_t packet_type, uint8_t *packet, int size); 95 96 /** 97 * extension for UART transport implementations 98 */ 99 int (*set_baudrate)(uint32_t baudrate); 100 101 } hci_transport_t; 102 103 typedef enum { 104 HCI_TRANSPORT_CONFIG_UART, 105 HCI_TRANSPORT_CONFIG_USB 106 } hci_transport_config_type_t; 107 108 typedef struct { 109 hci_transport_config_type_t type; 110 } hci_transport_config_t; 111 112 typedef struct { 113 hci_transport_config_type_t type; // == HCI_TRANSPORT_CONFIG_UART 114 uint32_t baudrate_init; // initial baud rate 115 uint32_t baudrate_main; // = 0: same as initial baudrate 116 int flowcontrol; // 117 const char *device_name; 118 } hci_transport_config_uart_t; 119 120 121 // inline various hci_transport_X.h files 122 123 /* 124 * @brief 125 */ 126 extern const hci_transport_t * hci_transport_h4_instance(void); 127 128 /* 129 * @brief 130 */ 131 extern const hci_transport_t * hci_transport_usb_instance(void); 132 133 134 /* API_END */ 135 136 #if defined __cplusplus 137 } 138 #endif 139 140 #endif // __HCI_TRANSPORT_H 141