1 //*****************************************************************************
2 //
3 //! @file am_apollo3_bt_support.h
4 //!
5 //! @brief Bluetooth support for the Apollo3 Blue Series SOC.
6 //
7 //*****************************************************************************
8 
9 //*****************************************************************************
10 //
11 // Copyright (c) 2024, Ambiq Micro, Inc.
12 // All rights reserved.
13 //
14 // Redistribution and use in source and binary forms, with or without
15 // modification, are permitted provided that the following conditions are met:
16 //
17 // 1. Redistributions of source code must retain the above copyright notice,
18 // this list of conditions and the following disclaimer.
19 //
20 // 2. Redistributions in binary form must reproduce the above copyright
21 // notice, this list of conditions and the following disclaimer in the
22 // documentation and/or other materials provided with the distribution.
23 //
24 // 3. Neither the name of the copyright holder nor the names of its
25 // contributors may be used to endorse or promote products derived from this
26 // software without specific prior written permission.
27 //
28 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
29 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
32 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 // POSSIBILITY OF SUCH DAMAGE.
39 //
40 //*****************************************************************************
41 
42 #ifndef AM_APOLLO3_BT_SUPPORT_H
43 #define AM_APOLLO3_BT_SUPPORT_H
44 
45 #ifdef __cplusplus
46 extern "C"
47 {
48 #endif
49 
50 // Tx power level in dBm.
51 typedef enum
52 {
53   TX_POWER_LEVEL_MINUS_10P0_dBm = 0x4,
54   TX_POWER_LEVEL_MINUS_5P0_dBm = 0x5,
55   TX_POWER_LEVEL_0P0_dBm = 0x8,
56   TX_POWER_LEVEL_PLUS_3P0_dBm = 0xF,
57   TX_POWER_LEVEL_INVALID = 0x10,
58 } txPowerLevel_t;
59 
60 //*****************************************************************************
61 //
62 //! @brief Initialize the Apollo3x BLE controller driver.
63 //!
64 //! @return status of BLE controller initialization.
65 //
66 //*****************************************************************************
67 uint32_t am_apollo3_bt_controller_init(void);
68 
69 //*****************************************************************************
70 //
71 //! @brief Deinitialize the Apollo3x BLE controller driver.
72 //!
73 //! @return status of BLE controller deinitialization.
74 //
75 //*****************************************************************************
76 uint32_t am_apollo3_bt_controller_deinit(void);
77 
78 //*****************************************************************************
79 //
80 //! @brief BLE ISR preprocessing.
81 //
82 //*****************************************************************************
83 void am_apollo3_bt_isr_pre(void);
84 
85 #ifdef __cplusplus
86 }
87 #endif
88 
89 #endif // AM_APOLLO3_BT_SUPPORT_H
90