1 //*****************************************************************************
2 //
3 //! @file am_util.h
4 //!
5 //! @brief Top Include for all of the utilities
6 //!
7 //! This file provides all the includes necessary to use the utilities.
8 //!
9 //
10 //! @defgroup utils utils
11 //! @{
12 //
13 //*****************************************************************************
14 
15 //*****************************************************************************
16 //
17 // Copyright (c) 2024, Ambiq Micro, Inc.
18 // All rights reserved.
19 //
20 // Redistribution and use in source and binary forms, with or without
21 // modification, are permitted provided that the following conditions are met:
22 //
23 // 1. Redistributions of source code must retain the above copyright notice,
24 // this list of conditions and the following disclaimer.
25 //
26 // 2. Redistributions in binary form must reproduce the above copyright
27 // notice, this list of conditions and the following disclaimer in the
28 // documentation and/or other materials provided with the distribution.
29 //
30 // 3. Neither the name of the copyright holder nor the names of its
31 // contributors may be used to endorse or promote products derived from this
32 // software without specific prior written permission.
33 //
34 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
35 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
36 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
38 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
39 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
40 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
41 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
42 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
43 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
44 // POSSIBILITY OF SUCH DAMAGE.
45 //
46 // This is part of revision stable-c1f95ddf60 of the AmbiqSuite Development Package.
47 //
48 //*****************************************************************************
49 #ifndef AM_UTIL_H
50 #define AM_UTIL_H
51 
52 //*****************************************************************************
53 //
54 // C99
55 //
56 //*****************************************************************************
57 #include <stdint.h>
58 #include <stdbool.h>
59 
60 //*****************************************************************************
61 //
62 // Utilities
63 //
64 //*****************************************************************************
65 #include "am_util_debug.h"
66 #include "am_util_delay.h"
67 #include "am_util_id.h"
68 #include "am_util_stdio.h"
69 #include "am_util_string.h"
70 #include "am_util_time.h"
71 
72 #if defined(AM_PART_APOLLO3_API)
73 #include "am_util_ble.h"
74 #include "am_util_regdump.h"
75 #elif defined(AM_PART_APOLLO4_API)
76 #include "am_util_ble_cooper.h"
77 #endif
78 
79 #if defined(AM_PART_APOLLO5_API)
80 #include "am_util_pmu.h"
81 #endif
82 
83 #endif  // AM_UTIL_H
84 
85 //*****************************************************************************
86 //
87 // End Doxygen group.
88 //! @}
89 //
90 //*****************************************************************************
91 
92