nfc_ndef_msg.h 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197
  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 NFC_NDEF_MSG_H__
  41. #define NFC_NDEF_MSG_H__
  42. #include "nfc_ndef_record.h"
  43. #ifdef __cplusplus
  44. extern "C" {
  45. #endif
  46. /**@file
  47. *
  48. * @defgroup nfc_ndef_msg Custom NDEF messages
  49. * @{
  50. * @ingroup nfc_modules
  51. *
  52. * @brief Generation of NFC NDEF messages for the NFC tag.
  53. *
  54. */
  55. #define TYPE_4_TAG 4U ///< Type 4 Tag identifier.
  56. #define NLEN_FIELD_SIZE 2U ///< Size of NLEN field, used to encode NDEF message for Type 4 Tag.
  57. /**
  58. * @brief NDEF message descriptor.
  59. */
  60. typedef struct {
  61. nfc_ndef_record_desc_t ** pp_record; ///< Pointer to an array of pointers to NDEF record descriptors.
  62. uint32_t max_record_count; ///< Number of elements in the allocated pp_record array, which defines the maximum number of records within the NDEF message.
  63. uint32_t record_count; ///< Number of records in the NDEF message.
  64. } nfc_ndef_msg_desc_t;
  65. /**
  66. * @brief Function for encoding an NDEF message.
  67. *
  68. * This function encodes an NDEF message according to the provided message descriptor.
  69. *
  70. * @note The way of encoding an NDEF message may vary depending on tag's platform, which
  71. * can be chosen with @ref NFC_NDEF_MSG_TAG_TYPE in @c sdk_config.h.
  72. *
  73. * @param[in] p_ndef_msg_desc Pointer to the message descriptor.
  74. * @param[out] p_msg_buffer Pointer to the message destination. If NULL, function will
  75. * calculate the expected size of the message.
  76. * @param[in,out] p_msg_len Size of the available memory for the message as input. Size of
  77. * the generated message as output.
  78. *
  79. * @return Return value from @ref nfc_ndef_record_encode.
  80. */
  81. ret_code_t nfc_ndef_msg_encode(nfc_ndef_msg_desc_t const * p_ndef_msg_desc,
  82. uint8_t * p_msg_buffer,
  83. uint32_t * const p_msg_len);
  84. /**
  85. * @brief Function for clearing an NDEF message.
  86. *
  87. * This function clears an NDEF message descriptor, thus empties the NDEF message.
  88. *
  89. * @param[in,out] p_msg Pointer to the message descriptor.
  90. */
  91. void nfc_ndef_msg_clear( nfc_ndef_msg_desc_t * p_msg);
  92. /**
  93. * @brief Function for adding a record to an NDEF message.
  94. *
  95. * @param[in] p_record Pointer to the record descriptor.
  96. * @param[in,out] p_msg Pointer to the message descriptor.
  97. *
  98. * @retval NRF_SUCCESS If the record was added successfully.
  99. * @retval NRF_ERROR_NO_MEM If the message already contains the maximum number of records and the operation is not allowed.
  100. */
  101. ret_code_t nfc_ndef_msg_record_add(nfc_ndef_msg_desc_t * const p_msg,
  102. nfc_ndef_record_desc_t * const p_record);
  103. /**@brief Macro for creating and initializing an NFC NDEF message descriptor.
  104. *
  105. * This macro creates and initializes an instance of type @ref nfc_ndef_msg_desc_t
  106. * and an array of pointers to record descriptors (@ref nfc_ndef_record_desc_t) used
  107. * by the message.
  108. *
  109. * Use the macro @ref NFC_NDEF_MSG to access the NDEF message descriptor instance.
  110. *
  111. * @note The message descriptor is declared as automatic variable, which implies that
  112. * the NDEF message encoding must be done in the same variable scope.
  113. *
  114. * @param[in] NAME Name of the related instance.
  115. * @param[in] MAX_RECORD_CNT Maximal count of records in the message.
  116. */
  117. #define NFC_NDEF_MSG_DEF(NAME, MAX_RECORD_CNT) \
  118. nfc_ndef_record_desc_t * NAME##_nfc_ndef_p_record_desc_array[MAX_RECORD_CNT]; \
  119. nfc_ndef_msg_desc_t NAME##_nfc_ndef_msg_desc = \
  120. { \
  121. .pp_record = NAME##_nfc_ndef_p_record_desc_array, \
  122. .max_record_count = MAX_RECORD_CNT, \
  123. .record_count = 0 \
  124. }
  125. /** @brief Macro for accessing the NFC NDEF message descriptor instance
  126. * that you created with @ref NFC_NDEF_MSG_DEF.
  127. */
  128. #define NFC_NDEF_MSG(NAME) (NAME##_nfc_ndef_msg_desc)
  129. /**
  130. * @brief Macro for creating and initializing an NFC NDEF record descriptor with an encapsulated NDEF message.
  131. * This macro creates and initializes a static instance of type
  132. * @ref nfc_ndef_record_desc_t that contains an encapsulated NDEF message as
  133. * payload. @ref nfc_ndef_msg_encode is used as payload constructor to encode
  134. * the message. The encoded message is then used as payload for the record.
  135. *
  136. * Use the macro @ref NFC_NDEF_NESTED_NDEF_MSG_RECORD to access the NDEF record descriptor instance.
  137. *
  138. * @note The message descriptor is declared as automatic variable, which implies that
  139. * the NDEF message encoding must be done in the same variable scope.
  140. *
  141. * @param[in] NAME Name of the created record descriptor instance.
  142. * @param[in] TNF Type Name Format (TNF) value for the record.
  143. * @param[in] P_ID Pointer to the ID string.
  144. * @param[in] ID_LEN Length of the ID string.
  145. * @param[in] P_TYPE Pointer to the type string.
  146. * @param[in] TYPE_LEN Length of the type string.
  147. * @param[in] P_NESTED_MESSAGE Pointer to the message descriptor to encapsulate
  148. * as the record's payload.
  149. */
  150. #define NFC_NDEF_NESTED_NDEF_MSG_RECORD_DEF( NAME, \
  151. TNF, \
  152. P_ID, \
  153. ID_LEN, \
  154. P_TYPE, \
  155. TYPE_LEN, \
  156. P_NESTED_MESSAGE ) \
  157. nfc_ndef_record_desc_t NAME##_ndef_record_nested_desc = \
  158. { \
  159. .tnf = TNF, \
  160. \
  161. .id_length = ID_LEN, \
  162. .p_id = P_ID, \
  163. \
  164. .type_length = TYPE_LEN, \
  165. .p_type = P_TYPE, \
  166. \
  167. .payload_constructor = (p_payload_constructor_t)(nfc_ndef_msg_encode), \
  168. .p_payload_descriptor = (void*) (P_NESTED_MESSAGE) \
  169. }
  170. /** @brief Macro for accessing the NFC NDEF record descriptor instance
  171. * that you created with @ref NFC_NDEF_NESTED_NDEF_MSG_RECORD_DEF.
  172. */
  173. #define NFC_NDEF_NESTED_NDEF_MSG_RECORD(NAME) (NAME##_ndef_record_nested_desc)
  174. /**
  175. * @}
  176. */
  177. #ifdef __cplusplus
  178. }
  179. #endif
  180. #endif