xref: /btstack/src/btstack_control.h (revision af3c1ffe4cfe13a87f9b14ce6dfb14e882ab3b69)
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  *  bt_control.h
40  *
41  *  BT Control API -- allows BT Daemon to initialize and control differnt hardware
42  *
43  *  Created by Matthias Ringwald on 5/19/09.
44  *
45  */
46 
47 #ifndef __BT_CONTROL_H
48 #define __BT_CONTROL_H
49 
50 #include <stdint.h>
51 #include "utils.h"
52 
53 #if defined __cplusplus
54 extern "C" {
55 #endif
56 
57 typedef enum {
58     POWER_WILL_SLEEP = 1,
59     POWER_WILL_WAKE_UP
60 } POWER_NOTIFICATION_t;
61 
62 typedef struct {
63     int          (*on)   (void *config);  // <-- turn BT module on and configure
64     int          (*off)  (void *config);  // <-- turn BT module off
65     int          (*sleep)(void *config);  // <-- put BT module to sleep    - only to be called after ON
66     int          (*wake) (void *config);  // <-- wake BT module from sleep - only to be called after SLEEP
67     int          (*valid)(void *config);  // <-- test if hardware can be supported
68     const char * (*name) (void *config);  // <-- return hardware name
69 
70     /** support for UART baud rate changes - cmd has to be stored in hci_cmd_buffer
71      * @return have command
72      */
73     int          (*baudrate_cmd)(void * config, uint32_t baudrate, uint8_t *hci_cmd_buffer);
74 
75     /** support custom init sequences after RESET command - cmd has to be stored in hci_cmd_buffer
76       * @return have command
77       */
78     int          (*next_cmd)(void *config, uint8_t * hci_cmd_buffer);
79 
80     void         (*register_for_power_notifications)(void (*cb)(POWER_NOTIFICATION_t event));
81 
82     void         (*hw_error)(void);
83 
84     /** support for vendor-specific way to set BD ADDR - cmd has to be stored in hci_cmd_buffer
85      * @return have command
86      */
87     int          (*set_bd_addr_cmd)(void * config, bd_addr_t addr, uint8_t *hci_cmd_buffer);
88 
89 } bt_control_t;
90 
91 #if defined __cplusplus
92 }
93 #endif
94 
95 #endif // __BT_CONTROL_H
96