ant_key_manager.h 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. /**
  2. * Copyright (c) 2015 - 2020, Nordic Semiconductor ASA
  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. * 1. Redistributions of source code must retain the above copyright notice, this
  10. * list of conditions and the following disclaimer.
  11. *
  12. * 2. Redistributions in binary form, except as embedded into a Nordic
  13. * Semiconductor ASA integrated circuit in a product or a software update for
  14. * such product, must reproduce the above copyright notice, this list of
  15. * conditions and the following disclaimer in the documentation and/or other
  16. * materials provided with the distribution.
  17. *
  18. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  19. * contributors may be used to endorse or promote products derived from this
  20. * software without specific prior written permission.
  21. *
  22. * 4. This software, with or without modification, must only be used with a
  23. * Nordic Semiconductor ASA integrated circuit.
  24. *
  25. * 5. Any software provided in binary form under this license must not be reverse
  26. * engineered, decompiled, modified and/or disassembled.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  29. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  30. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  31. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  32. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  34. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  37. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38. *
  39. */
  40. #ifndef ANT_KEY_MANAGER_H__
  41. #define ANT_KEY_MANAGER_H__
  42. #include <stdint.h>
  43. #ifdef __cplusplus
  44. extern "C" {
  45. #endif
  46. /**
  47. * @file
  48. */
  49. /**
  50. * @defgroup ant_key_manager ANT key manager
  51. * @{
  52. * @ingroup ant_sdk_utils
  53. * @brief Module for registering common and custom ANT network keys.
  54. */
  55. /**@brief Function for registering a custom network key.
  56. *
  57. * @param[in] network_number Network key number.
  58. * @param[in] p_network_key Pointer to the custom ANT network key.
  59. *
  60. * @return A SoftDevice error code.
  61. */
  62. uint32_t ant_custom_key_set(uint8_t network_number, uint8_t * p_network_key);
  63. /**@brief Function for registering an ANT+ network key.
  64. *
  65. * The key must be defined by @ref ANT_PLUS_NETWORK_KEY.
  66. *
  67. * @note The ANT+ Network Key is available for ANT+ Adopters. Go to http://thisisant.com
  68. * to become an ANT+ Adopter and access the key.
  69. *
  70. * @param[in] network_number Network key number.
  71. *
  72. * @return A SoftDevice error code.
  73. */
  74. uint32_t ant_plus_key_set(uint8_t network_number);
  75. /**@brief Function for registering an ANT-FS network key.
  76. *
  77. * The key must be defined by @ref ANT_FS_NETWORK_KEY.
  78. *
  79. * @note The ANT+ Network Key is available for ANT+ Adopters. Go to http://thisisant.com
  80. * to become an ANT+ Adopter and access the key.
  81. *
  82. * @param[in] network_number Network key number.
  83. *
  84. * @return A SoftDevice error code.
  85. */
  86. uint32_t ant_fs_key_set(uint8_t network_number);
  87. /**
  88. * @}
  89. */
  90. #ifdef __cplusplus
  91. }
  92. #endif
  93. #endif // ANT_KEY_MANAGER_H__