xref: /btstack/chipset/nxp/btstack_chipset_nxp.h (revision a57c424f361dd8f37049d3e9a01e55fa1d77444c)
1 /*
2  * Copyright (C) 2023 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  *  btstack_chipset_nxp
40  *
41  *  Adapter to use NXP/Marvel-based chipsets with BTstack
42  */
43 
44 #ifndef BTSTACK_CHIPSET_MARVEL_H
45 #define BTSTACK_CHIPSET_MARVEL_H
46 
47 #if defined __cplusplus
48 extern "C" {
49 #endif
50 
51 #include "bluetooth.h"
52 #include "btstack_chipset.h"
53 #include "btstack_uart.h"
54 #include <stdint.h>
55 
56 /**
57  * @brief Set path to firmware file for Controller with v1 bootloader, e.g. 88W8997
58  * @note used for systems with HAVE_POSIX_FILE_IO
59  * @param path
60  */
61 void btstack_chipset_nxp_set_v1_firmware_path(const char * firmware_path);
62 
63 /**
64  * @brieft Provide firmware as data
65  * @note used for systems without HAVE_POSIX_FILE_IO
66  * @param fw_data
67  * @param fw_size
68  */
69 void btstack_chipset_nxp_set_firmware(const uint8_t * fw_data, uint32_t fw_size);
70 
71 /**
72 * @brief Download firmware via uart_driver
73 * @param uart_driver -- already initialized
74 * @param callback. 0 = Success
75 */
76 void btstack_chipset_nxp_download_firmware_with_uart(const btstack_uart_t *uart_driver, void (*callback)(uint8_t status));
77 
78 /**
79  * @brief Get baudrate after firmware download
80  * @note iw612 with current firmware is set to 3mbps instead of 115200. to be called after firmware download complete
81  */
82 uint32_t btstack_chipset_nxp_get_initial_baudrate(void);
83 
84 /**
85  * Get chipset instance for NXP chipsets
86  */
87 const btstack_chipset_t *btstack_chipset_nxp_instance(void);
88 
89 #if defined __cplusplus
90 }
91 #endif
92 
93 #endif  // BTSTACK_CHIPSET_NXP_H
94