qdf_debug_domain.h 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. /*
  2. * Copyright (c) 2017 The Linux Foundation. All rights reserved.
  3. * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
  4. *
  5. * Permission to use, copy, modify, and/or distribute this software for
  6. * any purpose with or without fee is hereby granted, provided that the
  7. * above copyright notice and this permission notice appear in all
  8. * copies.
  9. *
  10. * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
  11. * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
  12. * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
  13. * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  14. * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  15. * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  16. * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  17. * PERFORMANCE OF THIS SOFTWARE.
  18. */
  19. /**
  20. * DOC: qdf_debug_domain
  21. * QCA driver framework (QDF) debug domain APIs. Debug domains are used to track
  22. * resource allocations across different driver states, particularly for runtime
  23. * leak detection.
  24. */
  25. #ifndef __QDF_DEBUG_DOMAIN_H
  26. #define __QDF_DEBUG_DOMAIN_H
  27. #include "qdf_types.h"
  28. /**
  29. * enum qdf_debug_domain - debug domains for tracking resource allocations
  30. * @QDF_DEBUG_DOMAIN_INIT: The default debug domain, tied to driver load
  31. * @QDF_DEBUG_DOMAIN_ACTIVE: The active debug domain, tied some "running" state
  32. * @QDF_DEBUG_DOMAIN_COUNT: The number of debug domains for iterating, etc.
  33. */
  34. enum qdf_debug_domain {
  35. QDF_DEBUG_DOMAIN_INIT,
  36. QDF_DEBUG_DOMAIN_ACTIVE,
  37. /* keep last */
  38. QDF_DEBUG_DOMAIN_COUNT,
  39. };
  40. /**
  41. * qdf_debug_domain_get() - Get the current debug domain
  42. *
  43. * Return: the current debug domain
  44. */
  45. enum qdf_debug_domain qdf_debug_domain_get(void);
  46. /**
  47. * qdf_debug_domain_set() - Set the current debug domain
  48. * @domain: the domain to change to
  49. *
  50. * Return: None
  51. */
  52. void qdf_debug_domain_set(enum qdf_debug_domain domain);
  53. /**
  54. * qdf_debug_domain_name() - Get the human readable name of a debug domain
  55. * @domain: The domain to return the name of
  56. *
  57. * Return: name of the given domain
  58. */
  59. const char *qdf_debug_domain_name(enum qdf_debug_domain domain);
  60. /**
  61. * qdf_debug_domain_valid() - bounds checks the given domain
  62. * @domain: the domain to validate
  63. *
  64. * Return: true is the given domain is a valid debug domain
  65. */
  66. bool qdf_debug_domain_valid(enum qdf_debug_domain domain);
  67. #endif /* __QDF_DEBUG_DOMAIN_H */