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