phy_plme_cca.h 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  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 PHY_PLME_CCA_H_INCLUDED
  43. #define PHY_PLME_CCA_H_INCLUDED
  44. #include <stdint.h>
  45. #include "phy_common.h"
  46. /** @file
  47. * This file contains declarations of Clear Channel Assessment PHY routines and necessary types.
  48. *
  49. * @defgroup phy_cca PHY CCA API
  50. * @ingroup phy_15_4
  51. * @{
  52. * @brief Module to declare PHY Clear Channel Assessment API
  53. * @details The PHY CCA module declares Clear Channel Assessment PHY routines and necessary types according to
  54. * the PHY specification. More specifically, PHY CCA request plme_cca_req(), PHY CCA confirm
  55. * plme_cca_conf() primitives are declared. An additional primitive not covered by the standard is declared.
  56. * This is plme_cca() which is a synchronous version of plme_cca_req().
  57. */
  58. /**@brief PLME-CCA.confirm parameters
  59. *
  60. * @details The PLME-CCA.confirm primitive is generated by
  61. * the initiating PLME and issued to its next higher layer
  62. * in response to an PLME-CCA.request primitive.
  63. * In accordance with IEEE Std 802.15.4-2006, section 6.2.2.2.1
  64. */
  65. typedef struct
  66. {
  67. /** One of PHY_TRX_OFF, PHY_BUSY or PHY_IDLE. */
  68. phy_enum_t status;
  69. } plme_cca_conf_t;
  70. /**@brief PLME-CCA.request
  71. *
  72. * @details Request for clear channel assessment.
  73. * In accordance with IEEE Std 802.15.4-2006, section 6.2.2.1
  74. */
  75. void plme_cca_req(void);
  76. /**@brief PLME-CCA.confirm callback function, implemented by the next higher layer.
  77. *
  78. * @details The PLME-CCA.confirm primitive is generated by the PLME and issued
  79. * to its next higher layer in response to an PLME-CCA.request primitive.
  80. * In accordance with IEEE Std 802.15.4-2006, section 6.2.2.2
  81. *
  82. * @param[out] conf Pointer to PLME-CCA.confirm parameters
  83. */
  84. void plme_cca_conf(plme_cca_conf_t * conf);
  85. /**@brief Direct (synchronous) PLME-CCA.request
  86. *
  87. * @details Optional. Not covered by a standard.
  88. *
  89. * @return One of PHY_TRX_OFF, PHY_BUSY or PHY_IDLE,
  90. * or implementation defined error code in case of
  91. * unavailability of access to system resources.
  92. */
  93. phy_enum_t plme_cca(void);
  94. /** @} */
  95. #endif // PHY_PLME_CCA_H_INCLUDED