xref: /btstack/chipset/cc256x/btstack_chipset_cc256x.h (revision 63efc2ed25a3692dad1b29e6e36412095760bc03)
1 /*
2  * Copyright (C) 2009-2012 by Matthias Ringwald
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 MATTHIAS RINGWALD 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 [email protected]
34  *
35  */
36 
37 /*
38  *  btstack_chipset_cc256x.c
39  *
40  *  Adapter to use cc256x-based chipsets with BTstack
41  */
42 
43 #ifndef BTSTACK_CHIPSET_CC256X_H
44 #define BTSTACK_CHIPSET_CC256X_H
45 
46 #if defined __cplusplus
47 extern "C" {
48 #endif
49 
50 #include <stdint.h>
51 #include "btstack_chipset.h"
52 
53 /**
54  * Configure output power before HCI POWER_ON
55  */
56 void btstack_chipset_cc256x_set_power(int16_t power_in_dB);
57 
58 /**
59  * Configure output power for specific modulation before HCI POWER_ON using explicit power vector
60  * @see https://processors.wiki.ti.com/index.php/CC256x_VS_HCI_Commands#HCI_VS_DRPb_Set_Power_Vector_.280xFD82.29
61  * @note data is not copied, pointer has to stay valid
62  * @note overrides setting from btstack_chipset_cc256x_set_power
63  * @param modulation_type 0=GFSK, 1=EDR2, 2= EDR3
64  * @param power_vector array of 16 uint8_t values as explained on TI wiki
65  */
66 void btstack_chipset_cc256x_set_power_vector(uint8_t modulation_type, const uint8_t * power_vector);
67 
68 /**
69  * Get chipset instance for CC256x series
70  */
71 const btstack_chipset_t * btstack_chipset_cc256x_instance(void);
72 
73 /**
74  * Get LMP Subversion of compile-time init script
75  */
76 uint16_t btstack_chipset_cc256x_lmp_subversion(void);
77 
78 /**
79  * Set init script to use for next power up
80  *
81  * Note: Only needed when switching between different add-ons (BLE, AVRP, ANT+)
82  * Note: Not supported by MSP430 "init script at 0x10000" workaround
83  *
84  * @param init_script_size or 0 for default script
85  */
86 void btstack_chipset_cc256x_set_init_script(uint8_t * data, uint32_t size);
87 
88 #if defined __cplusplus
89 }
90 #endif
91 
92 #endif // BTSTACK_CHIPSET_CC256X_H
93