xref: /btstack/chipset/realtek/btstack_chipset_realtek.h (revision 7977fdca7a60f6946fdc0b9f5c6f90dad622b901)
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_realtek
40  *
41  *  Adapter to use Realtek-based chipsets with BTstack
42  */
43 
44 #ifndef BTSTACK_CHIPSET_REALTEK_H
45 #define BTSTACK_CHIPSET_REALTEK_H
46 
47 #if defined __cplusplus
48 extern "C" {
49 #endif
50 
51 #include "bluetooth.h"
52 #include "btstack_chipset.h"
53 #include <stdint.h>
54 
55 /**
56  * @brief Set path to firmware file
57  * @param path
58  */
59 void btstack_chipset_realtek_set_firmware_file_path(const char *path);
60 
61 /**
62  * @brief Set path to firmware folder
63  * @param path
64  */
65 void btstack_chipset_realtek_set_firmware_folder_path(const char *path);
66 
67 /**
68  * @brief Set path to config file
69  * @param path
70  */
71 void btstack_chipset_realtek_set_config_file_path(const char *path);
72 
73 /**
74  * @brief Set path to config folder
75  * @param path
76  */
77 void btstack_chipset_realtek_set_config_folder_path(const char *path);
78 
79 /**
80  * @brief Set product id
81  * @param id
82  */
83 void btstack_chipset_realtek_set_product_id(uint16_t id);
84 
85 /**
86  * @brief Get num USB Controllers
87  * @return num controllers
88  */
89 uint16_t btstack_chipset_realtek_get_num_usb_controllers(void);
90 
91 /**
92  * @brief Get Vendor/Product ID for Controller with index
93  * @param index
94  * @param out_vendor_id
95  * @param out_product_id
96  */
97 void btstack_chipset_realtek_get_vendor_product_id(uint16_t index, uint16_t * out_vendor_id, uint16_t * out_product_id);
98 
99 /**
100  * Get chipset instance for REALTEK chipsets
101  */
102 const btstack_chipset_t *btstack_chipset_realtek_instance(void);
103 
104 #if defined __cplusplus
105 }
106 #endif
107 
108 #endif  // BTSTACK_CHIPSET_REALTEK_H
109