qdf_debug_domain.h 2.3 KB

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