xref: /aosp_15_r20/external/pigweed/pw_interrupt/public/pw_interrupt/context.h (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1 // Copyright 2020 The Pigweed Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4 // use this file except in compliance with the License. You may obtain a copy of
5 // the License at
6 //
7 //     https://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 // License for the specific language governing permissions and limitations under
13 // the License.
14 #pragma once
15 
16 namespace pw::interrupt {
17 
18 /// @brief Checks if the currently executing code is within an interrupt service
19 /// routine handling an interrupt request (IRQ) or non-maskable interrupt (NMI).
20 ///
21 /// @returns `true` if the the currently executing code is in an interrupt
22 /// context. `false` if not.
23 bool InInterruptContext();
24 
25 }  // namespace pw::interrupt
26 
27 // The backend can opt to include an inlined implementation of the following:
28 //   bool InInterruptContext();
29 #if __has_include("pw_interrupt_backend/context_inline.h")
30 #include "pw_interrupt_backend/context_inline.h"
31 #endif  // __has_include("pw_interrupt_backend/context_inline.h")
32