1 /*
2  * Copyright (c) 2019 - 2023, Nordic Semiconductor ASA
3  * All rights reserved.
4  *
5  * SPDX-License-Identifier: BSD-3-Clause
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice, this
11  *    list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
18  *    contributors may be used to endorse or promote products derived from this
19  *    software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  */
34 
35 #ifndef NRF_802154_DEBUG_LOG_H_
36 #define NRF_802154_DEBUG_LOG_H_
37 
38 #include "nrf_802154_config.h"
39 #include "nrf_802154_sl_log.h"
40 #include "nrf_802154_debug_log_codes.h"
41 
42 /**@brief Records log about entry to a function.
43  * @param verbosity     Verbosity level of the module in which log is recorded required to emit log.
44  */
45 #define nrf_802154_log_function_enter(verbosity) \
46     nrf_802154_sl_log_function_enter(verbosity)
47 
48 /**@brief Records log about exit from a function.
49  * @param verbosity     Verbosity level of the module in which log is recorded required to emit log.
50  */
51 #define nrf_802154_log_function_exit(verbosity) \
52     nrf_802154_sl_log_function_exit(verbosity)
53 
54 /**@brief Records log about event (with parameter) related to current module.
55  * @param verbosity         Verbosity level of the module in which log is recorded required to emit log.
56  * @param local_event_id    Event identifier whose meaning is defined within scope of the module
57  *                          in which log is recorded. Possible values 0...63
58  * @param param_u16         Additional parameter to be logged with event. Meaning
59  *                          of the parameter is defined by the module in which
60  *                          the log is recorded and event_id.
61  */
62 #define nrf_802154_log_local_event(verbosity, local_event_id, param_u16) \
63     nrf_802154_sl_log_local_event(verbosity, local_event_id, param_u16)
64 
65 /**@brief Records log about event (with parameter) related to global resource.
66  * @param verbosity         Verbosity level of the module in which log is recorded required to emit log.
67  * @param global_event_id   Event identifier whose meaning is defined globally. Possible values 0...63
68  * @param param_u16         Additional parameter to be logged with event. Meaning
69  *                          of the parameter is defined by value of global_event_id.
70  */
71 #define nrf_802154_log_global_event(verbosity, global_event_id, param_u16) \
72     nrf_802154_sl_log_global_event(verbosity, global_event_id, param_u16)
73 
74 #endif /* NRF_802154_DEBUG_LOG_H_ */
75