ant_channel_config.h 3.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  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_CHANNEL_CONFIG_H__
  41. #define ANT_CHANNEL_CONFIG_H__
  42. /** @file
  43. *
  44. * @defgroup ant_channel_config ANT channel configuration
  45. * @{
  46. * @ingroup ant_sdk_utils
  47. * @brief ANT channel configuration module.
  48. */
  49. #include <stdint.h>
  50. #include "sdk_config.h"
  51. #ifndef NRF_SDH_ANT_ENCRYPTED_CHANNELS
  52. #error Undefined NRF_SDH_ANT_ENCRYPTED_CHANNELS. It should be defined in sdk_config.h file.
  53. #elif NRF_SDH_ANT_ENCRYPTED_CHANNELS > 0
  54. #include "ant_encrypt_config.h"
  55. #endif
  56. #ifdef __cplusplus
  57. extern "C" {
  58. #endif
  59. /**@brief ANT channel configuration structure. */
  60. typedef struct
  61. {
  62. uint8_t channel_number; ///< Assigned channel number.
  63. uint8_t channel_type; ///< Channel type (see Assign Channel Parameters in ant_parameters.h: @ref ant_parameters).
  64. uint8_t ext_assign; ///< Extended assign (see Ext. Assign Channel Parameters in ant_parameters.h: @ref ant_parameters).
  65. uint8_t rf_freq; ///< Radio frequency offset from 2400 MHz (for example, 2466 MHz, rf_freq = 66).
  66. uint8_t transmission_type; ///< Transmission type.
  67. uint8_t device_type; ///< Device type.
  68. uint16_t device_number; ///< Device number.
  69. uint16_t channel_period; ///< The period in 32 kHz counts.
  70. uint8_t network_number; ///< Network number denoting the network key.
  71. #if NRF_SDH_ANT_ENCRYPTED_CHANNELS > 0
  72. ant_encrypt_channel_settings_t * p_crypto_settings; ///< Pointer to cryptographic settings, NULL if this configuration have to be omitted.
  73. #endif
  74. } ant_channel_config_t;
  75. /**@brief Function for configuring the ANT channel.
  76. *
  77. * @param[in] p_config Pointer to the channel configuration structure.
  78. *
  79. * @retval NRF_SUCCESS If the channel was successfully configured. Otherwise, an error code is returned.
  80. */
  81. uint32_t ant_channel_init(ant_channel_config_t const * p_config);
  82. #ifdef __cplusplus
  83. }
  84. #endif
  85. #endif // ANT_CHANNEL_CONFIG_H__
  86. /** @} */