hci_transport.h

00001 /*
00002  * Copyright (C) 2009-2012 by Matthias Ringwald
00003  *
00004  * Redistribution and use in source and binary forms, with or without
00005  * modification, are permitted provided that the following conditions
00006  * are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 3. Neither the name of the copyright holders nor the names of
00014  *    contributors may be used to endorse or promote products derived
00015  *    from this software without specific prior written permission.
00016  * 4. Any redistribution, use, or modification is done solely for
00017  *    personal benefit and not for any commercial purpose or for
00018  *    monetary gain.
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY MATTHIAS RINGWALD AND CONTRIBUTORS
00021  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00023  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
00024  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00025  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00026  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
00027  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
00028  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00029  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
00030  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00031  * SUCH DAMAGE.
00032  *
00033  * Please inquire about commercial licensing options at btstack@ringwald.ch
00034  *
00035  */
00036 
00037 /*
00038  *  hci_transport.h
00039  *
00040  *  HCI Transport API -- allows BT Daemon to use different transport protcols 
00041  *
00042  *  Created by Matthias Ringwald on 4/29/09.
00043  *
00044  */
00045 #pragma once
00046 
00047 #include <stdint.h>
00048 #include <btstack/run_loop.h>
00049 
00050 #if defined __cplusplus
00051 extern "C" {
00052 #endif
00053     
00054 /* HCI packet types */
00055 typedef struct {
00056     int    (*open)(void *transport_config);
00057     int    (*close)(void *transport_config);
00058     int    (*send_packet)(uint8_t packet_type, uint8_t *packet, int size);
00059     void   (*register_packet_handler)(void (*handler)(uint8_t packet_type, uint8_t *packet, uint16_t size));
00060     const char * (*get_transport_name)(void);
00061     // custom extension for UART transport implementations
00062     int    (*set_baudrate)(uint32_t baudrate);
00063     // support async transport layers, e.g. IRQ driven without buffers
00064     int    (*can_send_packet_now)(uint8_t packet_type);
00065 } hci_transport_t;
00066 
00067 typedef struct {
00068     const char *device_name;
00069     uint32_t   baudrate_init; // initial baud rate
00070     uint32_t   baudrate_main; // = 0: same as initial baudrate
00071     int   flowcontrol; // 
00072 } hci_uart_config_t;
00073 
00074 
00075 // inline various hci_transport_X.h files
00076 extern hci_transport_t * hci_transport_h4_instance(void);
00077 extern hci_transport_t * hci_transport_h4_dma_instance(void);
00078 extern hci_transport_t * hci_transport_h4_iphone_instance(void);
00079 extern hci_transport_t * hci_transport_h5_instance(void);
00080 extern hci_transport_t * hci_transport_usb_instance(void);
00081 
00082 // support for "enforece wake device" in h4 - used by iOS power management
00083 extern void hci_transport_h4_iphone_set_enforce_wake_device(char *path);
00084     
00085 #if defined __cplusplus
00086 }
00087 #endif
00088