mac_panid_conflict.h 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. /**
  2. * Copyright (c) 2016 - 2020 Nordic Semiconductor ASA and Luxoft Global Operations Gmbh.
  3. *
  4. * All Rights Reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without modification,
  7. * are permitted provided that the following conditions are met:
  8. *
  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, except as embedded into a Nordic
  14. * Semiconductor ASA integrated circuit in a product or a software update for
  15. * such product, must reproduce the above copyright notice, this list of
  16. * conditions and the following disclaimer in the documentation and/or other
  17. * materials provided with the distribution.
  18. *
  19. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  20. * contributors may be used to endorse or promote products derived from this
  21. * software without specific prior written permission.
  22. *
  23. * 4. This software, with or without modification, must only be used with a
  24. * Nordic Semiconductor ASA integrated circuit.
  25. *
  26. * 5. Any software provided in binary form under this license must not be reverse
  27. * engineered, decompiled, modified and/or disassembled.
  28. *
  29. *
  30. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  31. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  32. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  33. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  34. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  35. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  36. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  37. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  38. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  39. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40. *
  41. */
  42. #ifndef MAC_PANID_CONFLICT_H_INCLUDED
  43. #define MAC_PANID_CONFLICT_H_INCLUDED
  44. #if (CONFIG_PANID_CONFLICT_ENABLED == 1)
  45. #include "mac_common.h"
  46. /** @file
  47. * @defgroup mac_pan_id PAN ID Conflict API
  48. * @ingroup mac_15_4
  49. * @{
  50. * @brief Module for handling PAN ID conflicts.
  51. */
  52. /**
  53. * @brief A callback function used to notify Pan ID conflict detection algorithm about
  54. * a new beacon frame.
  55. *
  56. * @param p_beacon - pointer to beacon descriptor struct.
  57. */
  58. void mac_panid_conflict_beacon_notify_ind(const mac_beacon_ind_t * p_beacon);
  59. #if (CONFIG_PANID_CONFLICT_RESOLUTION_ENABLED == 1)
  60. /**@brief Callback function which handles end of Pan ID conflict cmd TX,
  61. * called by FP
  62. * @param[in] status Confirmation status to be raised
  63. */
  64. void mac_panid_conflict_cb(mac_status_t status);
  65. #endif
  66. /**@brief Indicates whether the pan id conflict was detected
  67. *
  68. * @return Result of pan id conflict detection
  69. */
  70. bool mac_panid_conflict_detected(void);
  71. /** @} */
  72. #endif
  73. #endif /* MAC_PANID_CONFLICT_H_INCLUDED */