Junzhe Zou | 26abf77 | 2017-07-05 10:36:43 -0700 | [diff] [blame] | 1 | /* Copyright (c) 2017, The Linux Foundation. All rights reserved. |
Junzhe Zou | 263a87d | 2017-06-08 16:06:25 -0700 | [diff] [blame] | 2 | * |
| 3 | * This program is free software; you can redistribute it and/or modify |
| 4 | * it under the terms of the GNU General Public License version 2 and |
| 5 | * only version 2 as published by the Free Software Foundation. |
| 6 | * |
| 7 | * This program is distributed in the hope that it will be useful, |
| 8 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 9 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 10 | * GNU General Public License for more details. |
| 11 | */ |
| 12 | |
| 13 | #ifndef _CAM_DEBUG_UTIL_H_ |
| 14 | #define _CAM_DEBUG_UTIL_H_ |
| 15 | |
Jigarkumar Zala | cbb5a38 | 2017-07-17 19:06:42 -0700 | [diff] [blame^] | 16 | #define CAM_CDM (1 << 0) |
| 17 | #define CAM_CORE (1 << 1) |
| 18 | #define CAM_CPAS (1 << 2) |
| 19 | #define CAM_ISP (1 << 3) |
| 20 | #define CAM_CRM (1 << 4) |
| 21 | #define CAM_SENSOR (1 << 5) |
| 22 | #define CAM_SMMU (1 << 6) |
| 23 | #define CAM_SYNC (1 << 7) |
| 24 | #define CAM_ICP (1 << 8) |
| 25 | #define CAM_JPEG (1 << 9) |
| 26 | #define CAM_FD (1 << 10) |
| 27 | #define CAM_LRME (1 << 11) |
| 28 | #define CAM_FLASH (1 << 12) |
| 29 | #define CAM_ACTUATOR (1 << 13) |
| 30 | #define CAM_CCI (1 << 14) |
| 31 | #define CAM_CSIPHY (1 << 15) |
| 32 | #define CAM_EEPROM (1 << 16) |
Junzhe Zou | 263a87d | 2017-06-08 16:06:25 -0700 | [diff] [blame] | 33 | |
Jigarkumar Zala | ddcb9d3 | 2017-06-23 16:21:33 -0700 | [diff] [blame] | 34 | #define STR_BUFFER_MAX_LENGTH 1024 |
Junzhe Zou | 263a87d | 2017-06-08 16:06:25 -0700 | [diff] [blame] | 35 | |
Jigarkumar Zala | ddcb9d3 | 2017-06-23 16:21:33 -0700 | [diff] [blame] | 36 | enum cam_debug_level { |
| 37 | CAM_LEVEL_INFO, |
| 38 | CAM_LEVEL_WARN, |
| 39 | CAM_LEVEL_ERR, |
| 40 | CAM_LEVEL_DBG, |
| 41 | }; |
Junzhe Zou | 263a87d | 2017-06-08 16:06:25 -0700 | [diff] [blame] | 42 | |
Jigarkumar Zala | ddcb9d3 | 2017-06-23 16:21:33 -0700 | [diff] [blame] | 43 | /* |
| 44 | * cam_debug_log() |
| 45 | * |
Jigarkumar Zala | 0fbb1d9 | 2017-07-11 18:55:58 -0700 | [diff] [blame] | 46 | * @brief : Get the Module name from module ID and print |
| 47 | * respective debug logs |
Jigarkumar Zala | ddcb9d3 | 2017-06-23 16:21:33 -0700 | [diff] [blame] | 48 | * |
| 49 | * @module_id : Respective Module ID which is calling this function |
| 50 | * @dbg_level : Debug level from cam_module_debug_level enum entries |
Jigarkumar Zala | 0fbb1d9 | 2017-07-11 18:55:58 -0700 | [diff] [blame] | 51 | * @func : Function which is calling to print logs |
| 52 | * @line : Line number associated with the function which is calling |
Jigarkumar Zala | ddcb9d3 | 2017-06-23 16:21:33 -0700 | [diff] [blame] | 53 | * to print log |
Jigarkumar Zala | 0fbb1d9 | 2017-07-11 18:55:58 -0700 | [diff] [blame] | 54 | * @fmt : Formatted string which needs to be print in the log |
Jigarkumar Zala | ddcb9d3 | 2017-06-23 16:21:33 -0700 | [diff] [blame] | 55 | * |
| 56 | */ |
| 57 | void cam_debug_log(unsigned int module_id, enum cam_debug_level dbg_level, |
| 58 | const char *func, const int line, const char *fmt, ...); |
Junzhe Zou | 263a87d | 2017-06-08 16:06:25 -0700 | [diff] [blame] | 59 | |
Jigarkumar Zala | ddcb9d3 | 2017-06-23 16:21:33 -0700 | [diff] [blame] | 60 | /* |
Jigarkumar Zala | 0fbb1d9 | 2017-07-11 18:55:58 -0700 | [diff] [blame] | 61 | * cam_get_module_name() |
| 62 | * |
| 63 | * @brief : Get the module name from module ID |
| 64 | * |
| 65 | * @module_id : Module ID which is using this function |
| 66 | */ |
| 67 | const char *cam_get_module_name(unsigned int module_id); |
| 68 | |
| 69 | /* |
Jigarkumar Zala | ddcb9d3 | 2017-06-23 16:21:33 -0700 | [diff] [blame] | 70 | * CAM_ERR |
Jigarkumar Zala | 0fbb1d9 | 2017-07-11 18:55:58 -0700 | [diff] [blame] | 71 | * @brief : This Macro will print error logs |
Jigarkumar Zala | ddcb9d3 | 2017-06-23 16:21:33 -0700 | [diff] [blame] | 72 | * |
| 73 | * @__module : Respective module id which is been calling this Macro |
Jigarkumar Zala | 0fbb1d9 | 2017-07-11 18:55:58 -0700 | [diff] [blame] | 74 | * @fmt : Formatted string which needs to be print in log |
| 75 | * @args : Arguments which needs to be print in log |
Jigarkumar Zala | ddcb9d3 | 2017-06-23 16:21:33 -0700 | [diff] [blame] | 76 | */ |
| 77 | #define CAM_ERR(__module, fmt, args...) \ |
Jigarkumar Zala | 0fbb1d9 | 2017-07-11 18:55:58 -0700 | [diff] [blame] | 78 | cam_debug_log(__module, CAM_LEVEL_ERR, __func__, __LINE__, fmt, ##args) |
Jigarkumar Zala | ddcb9d3 | 2017-06-23 16:21:33 -0700 | [diff] [blame] | 79 | |
| 80 | /* |
| 81 | * CAM_WARN |
Jigarkumar Zala | 0fbb1d9 | 2017-07-11 18:55:58 -0700 | [diff] [blame] | 82 | * @brief : This Macro will print warning logs |
Jigarkumar Zala | ddcb9d3 | 2017-06-23 16:21:33 -0700 | [diff] [blame] | 83 | * |
| 84 | * @__module : Respective module id which is been calling this Macro |
| 85 | * @fmt : Formatted string which needs to be print in log |
| 86 | * @args : Arguments which needs to be print in log |
| 87 | */ |
| 88 | #define CAM_WARN(__module, fmt, args...) \ |
Jigarkumar Zala | 0fbb1d9 | 2017-07-11 18:55:58 -0700 | [diff] [blame] | 89 | cam_debug_log(__module, CAM_LEVEL_WARN, __func__, __LINE__, fmt, ##args) |
Jigarkumar Zala | ddcb9d3 | 2017-06-23 16:21:33 -0700 | [diff] [blame] | 90 | |
| 91 | /* |
| 92 | * CAM_INFO |
Jigarkumar Zala | 0fbb1d9 | 2017-07-11 18:55:58 -0700 | [diff] [blame] | 93 | * @brief : This Macro will print Information logs |
Jigarkumar Zala | ddcb9d3 | 2017-06-23 16:21:33 -0700 | [diff] [blame] | 94 | * |
| 95 | * @__module : Respective module id which is been calling this Macro |
| 96 | * @fmt : Formatted string which needs to be print in log |
| 97 | * @args : Arguments which needs to be print in log |
| 98 | */ |
| 99 | #define CAM_INFO(__module, fmt, args...) \ |
Jigarkumar Zala | 0fbb1d9 | 2017-07-11 18:55:58 -0700 | [diff] [blame] | 100 | cam_debug_log(__module, CAM_LEVEL_INFO, __func__, __LINE__, fmt, ##args) |
Jigarkumar Zala | ddcb9d3 | 2017-06-23 16:21:33 -0700 | [diff] [blame] | 101 | |
| 102 | /* |
| 103 | * CAM_DBG |
| 104 | * @brief : This Macro will print debug logs when enabled using GROUP |
| 105 | * |
| 106 | * @__module : Respective module id which is been calling this Macro |
| 107 | * @fmt : Formatted string which needs to be print in log |
| 108 | * @args : Arguments which needs to be print in log |
| 109 | */ |
| 110 | #define CAM_DBG(__module, fmt, args...) \ |
Jigarkumar Zala | 0fbb1d9 | 2017-07-11 18:55:58 -0700 | [diff] [blame] | 111 | cam_debug_log(__module, CAM_LEVEL_DBG, __func__, __LINE__, fmt, ##args) |
| 112 | |
| 113 | /* |
| 114 | * CAM_ERR_RATE_LIMIT |
| 115 | * @brief : This Macro will prevent error print logs with ratelimit |
| 116 | */ |
| 117 | #define CAM_ERR_RATE_LIMIT(__module, fmt, args...) \ |
| 118 | pr_err_ratelimited("CAM_ERR: %s: %s: %d\n" fmt, \ |
| 119 | cam_get_module_name(__module), __func__, __LINE__, ##args) |
Junzhe Zou | 263a87d | 2017-06-08 16:06:25 -0700 | [diff] [blame] | 120 | |
| 121 | #endif /* _CAM_DEBUG_UTIL_H_ */ |