xref: /btstack/src/btstack_chipset.h (revision 0af2bb27be58ba90331690e10c3930d4a2d95b12)
1 /*
2  * Copyright (C) 2016 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  *  btstack_chipset.h
40  *
41  *  Chipset Driver - implements custom chipset initializtion and support proprietary extensions
42  *  to set UART baud rate, Bluetooth Address, and similar.
43  */
44 
45 #ifndef __BTSTACK_CHIPSET_H
46 #define __BTSTACK_CHIPSET_H
47 
48 #include <stdint.h>
49 #include "btstack_util.h"
50 
51 #if defined __cplusplus
52 extern "C" {
53 #endif
54 
55 typedef enum {
56   BTSTACK_CHIPSET_DONE = 0,
57   BTSTACK_CHIPSET_VALID_COMMAND,
58   BTSTACK_CHIPSET_WARMSTART_REQUIRED,
59 } btstack_chipset_result_t;
60 
61 typedef struct {
62     /**
63      * chipset driver name
64      */
65     const char * name;
66 
67     /**
68      * init driver
69      * allows to reset init script index
70      * @param config
71      */
72     void (*init)(void * config);
73 
74     /**
75      * support custom init sequences after RESET command
76      * @param  hci_cmd_buffer to store generated command
77      * @return result see btstack_chipset_result_t
78      */
79     btstack_chipset_result_t (*next_cmd)(uint8_t * hci_cmd_buffer);
80 
81     /**
82      * provide UART Baud Rate change command.
83      * @param baudrate
84      * @param hci_cmd_buffer to store generated command
85      */
86     void (*baudrate_cmd)(uint32_t baudrate, uint8_t *hci_cmd_buffer);
87 
88     /** provide Set BD Addr command
89      * @param baudrate
90      * @param hci_cmd_buffer to store generated command
91      */
92     void (*set_bd_addr_cmd)(void * config, bd_addr_t addr, uint8_t *hci_cmd_buffer);
93 
94 
95 } btstack_chipset_t;
96 
97 #if defined __cplusplus
98 }
99 #endif
100 
101 #endif // __BTSTACK_CHIPSET_H
102