xref: /btstack/chipset/atwilc3000/btstack_chipset_atwilc3000.h (revision 2fca4dad957cd7b88f4657ed51e89c12615dda72)
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 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_atwilc3000.c
40  *
41  *  Adapter to use atwilc3000-based chipsets with BTstack
42  *
43  */
44 
45 #ifndef BTSTACK_CHIPSET_ATWILC3000_H
46 #define BTSTACK_CHIPSET_ATWILC3000_H
47 
48 #if defined __cplusplus
49 extern "C" {
50 #endif
51 
52 #include "btstack_chipset.h"
53 #include "btstack_uart.h"
54 #include "btstack_uart_block.h"
55 
56 #define HCI_DEFAULT_BAUDRATE 115200
57 
58 /**
59  * @brief get chipset instance
60  */
61 const btstack_chipset_t * btstack_chipset_atwilc3000_instance(void);
62 
63 /**
64  * @brief Download firmware via btstack_uart_t implementation
65  * @param uart_driver -- already initialized
66  * @param baudrate for firmware update
67  * @param flowcontrol after firmwware update
68  * @param done callback. 0 = Success
69  */
70 void btstack_chipset_atwilc3000_download_firmware_with_uart(const btstack_uart_t * uart_driver, uint32_t baudrate, int flowcontrol, const uint8_t * fw, uint32_t fw_size, void (*done)(int result));
71 
72 /**
73  * @brief Download firmware via btstack_uart_block_t implementation
74  * @param uart_driver -- already initialized
75  * @param baudrate for firmware update
76  * @param flowcontrol after firmwware update
77  * @param done callback. 0 = Success
78  * @deprecated please use btstack_chipset_atwilc3000_download_firmware_with_uart instead
79  */
80 void btstack_chipset_atwilc3000_download_firmware(const btstack_uart_block_t * uart_driver, uint32_t baudrate, int flowcontrol, const uint8_t * fw, uint32_t fw_size, void (*done)(int result));
81 
82 #if defined __cplusplus
83 }
84 #endif
85 
86 #endif // BTSTACK_CHIPSET_ATWILC3000_H
87