nRF Connect SDK API 0.1.0
Loading...
Searching...
No Matches
record.h File Reference
#include <zephyr/types.h>

Go to the source code of this file.

Data Structures

struct  nfc_ndef_record_desc
 NDEF record descriptor. More...
 
struct  nfc_ndef_bin_payload_desc
 Binary data descriptor containing the payload for the record. More...
 

Macros

#define NDEF_RECORD_IL_MASK   0x08
 
#define NDEF_RECORD_TNF_MASK   0x07
 
#define NDEF_RECORD_SR_MASK   0x10
 
#define NDEF_RECORD_PAYLOAD_LEN_LONG_SIZE   4
 
#define NDEF_RECORD_PAYLOAD_LEN_SHORT_SIZE   1
 
#define NDEF_RECORD_ID_LEN_SIZE   1
 
#define NDEF_RECORD_LOCATION_MASK   (NDEF_LONE_RECORD)
 
#define NFC_NDEF_GENERIC_RECORD_DESC_DEF(name, tnf_arg, id_arg, id_len, type_arg, type_len, payload_constructor_arg, payload_descriptor_arg)
 Macro for creating and initializing an NFC NDEF record descriptor for a generic record.
 
#define NFC_NDEF_GENERIC_RECORD_DESC(name)   (name##_ndef_generic_record_desc)
 Macro for accessing the NFC NDEF record descriptor instance that you created with NFC_NDEF_GENERIC_RECORD_DESC_DEF.
 
#define NFC_NDEF_RECORD_BIN_DATA_DEF(name, tnf_arg, id_arg, id_len, type_arg, type_len, payload_arg, payload_len)
 Macro for creating and initializing an NFC NDEF record descriptor for a record with binary payload.
 
#define NFC_NDEF_RECORD_BIN_DATA(name)   (name##_nfc_ndef_bin_record_desc)
 Macro for accessing the NFC NDEF record descriptor instance that you created with NFC_NDEF_RECORD_BIN_DATA_DEF.
 
#define NFC_NDEF_BIN_PAYLOAD_DESC(name)   (name##_nfc_ndef_bin_payload_desc)
 Macro for accessing the binary data descriptor that contains the payload of the record that you created with NFC_NDEF_RECORD_BIN_DATA_DEF.
 

Typedefs

typedef int(* payload_constructor_t) (void *payload_descriptor, uint8_t *buffer, uint32_t *len)
 Payload constructor type.
 

Enumerations

enum  nfc_ndef_record_tnf {
  TNF_EMPTY = 0x00 , TNF_WELL_KNOWN = 0x01 , TNF_MEDIA_TYPE = 0x02 , TNF_ABSOLUTE_URI = 0x03 ,
  TNF_EXTERNAL_TYPE = 0x04 , TNF_UNKNOWN_TYPE = 0x05 , TNF_UNCHANGED = 0x06 , TNF_RESERVED = 0x07
}
 Type Name Format (TNF) Field Values. More...
 
enum  nfc_ndef_record_location { NDEF_FIRST_RECORD = 0x80 , NDEF_MIDDLE_RECORD = 0x00 , NDEF_LAST_RECORD = 0x40 , NDEF_LONE_RECORD = 0xC0 }
 Record position within the NDEF message. More...
 

Functions

int nfc_ndef_record_encode (struct nfc_ndef_record_desc const *ndef_record_desc, enum nfc_ndef_record_location const record_location, uint8_t *record_buffer, uint32_t *record_len)
 Encode an NDEF record.
 
int nfc_ndef_bin_payload_memcopy (struct nfc_ndef_bin_payload_desc *payload_descriptor, uint8_t *buffer, uint32_t *len)
 Construct the payload for an NFC NDEF record from binary data.