Tizen HAL API  1.0
Nfc

The Nfc provides functions to enable and disable the NFC interface.

Required Header

#include <hal-nfc.h>

Overview

The Nfc provides to get/put backend and enable/disable Nfc interface.

For more information on the Nfc features and the macros, see HAL Nfc programming guides and tutorials.

Typedefs

typedef enum
_net_nfc_message_service_e 
net_nfc_message_service_e
 Enumeration for different types of NFC service messages.
typedef enum _client_state_e net_nfc_client_state_e
 Enumeration for different states of NFC clients.
typedef enum
_net_nfc_launch_popup_check_e 
net_nfc_launch_popup_check_e
 Enumeration for different types of launch popup checks.
typedef enum
_net_nfc_launch_popup_state_e 
net_nfc_launch_popup_state_e
 Enumeration for different states of launch popup selection.
typedef enum _net_nfc_privilege_e net_nfc_privilege_e
 Enumeration for different types of NFC privileges.
typedef enum
_net_nfc_discovery_mode_e 
net_nfc_discovery_mode_e
 Enumeration for different types of discovery modes.
typedef enum
_net_nfc_secure_element_type_e 
net_nfc_secure_element_type_e
 Enumeration for different types of secure element (SE) types.
typedef enum
_net_nfc_secure_element_state_e 
net_nfc_secure_element_state_e
 Enumeration for different states of secure element (SE).
typedef enum
_net_nfc_secure_element_mode_e 
net_nfc_secure_element_mode_e
 Enumeration for different modes of secure element (SE).
typedef enum
_net_nfc_connection_type_e 
net_nfc_connection_type_e
 Enumeration for different types of NFC connection types.
typedef enum _llcp_event_e net_nfc_llcp_event_e
 Enumeration for different types of LLCP events.
typedef struct _net_nfc_data_s * net_nfc_data_h
 Handle for data structure.
typedef struct
_net_nfc_ndef_record_s
net_nfc_ndef_record_h
 Handle for NDEF record structure.
typedef struct
_net_nfc_ndef_message_s
net_nfc_ndef_message_h
 Handle for NDEF message structure.
typedef struct
_net_nfc_target_info_s
net_nfc_target_info_h
 Handle for NFC target information structure.
typedef struct
_net_nfc_llcp_config_info_s
net_nfc_llcp_config_info_h
 Handle for LLCP configuration information structure.
typedef struct
_net_nfc_llcp_socket_option_s
net_nfc_llcp_socket_option_h
 Handle for LLCP socket option structure.
typedef struct
_net_nfc_target_handle_s
net_nfc_target_handle_h
 Handle for NFC target handle structure.
typedef struct
_net_nfc_connection_handover_info_s
net_nfc_connection_handover_info_h
 Handle for connection handover information structure.
typedef uint8_t net_nfc_sap_t
 Typedef for Service Access Point (SAP) type.
typedef uint32_t net_nfc_llcp_socket_t
 Typedef for LLCP socket type.
typedef void(* net_nfc_llcp_socket_cb )(net_nfc_llcp_message_e message, int result, void *data, void *user_data, void *trans_data)
 Callback function for LLCP socket events.
typedef void(* net_nfc_target_detection_listener_cb )(void *data, void *user_param)
 Callback function for target detection events.
typedef void(* net_nfc_se_transaction_listener_cb )(void *data, void *user_param)
 Callback function for secure element (SE) transaction events.
typedef void(* net_nfc_llcp_event_listener_cb )(void *data, void *user_param)
 Callback function for LLCP event events.
typedef void(* net_nfc_hce_apdu_listener_cb )(void *data, void *user_param)
 Callback function for HCE APDU events.
typedef struct _net_nfc_data_t net_nfc_data_s
 Structure for NFC data containing a buffer and its length.
typedef struct
_net_nfc_internal_data_t 
net_nfc_internal_data_s
 Structure for NFC internal data containing a buffer and its length.
typedef struct
_net_nfc_target_handle_s 
net_nfc_target_handle_s
 Structure for NFC target handle containing connection information.
typedef struct
_net_nfc_current_target_info_s 
net_nfc_current_target_info_s
 Structure for current NFC target information containing handle and other details.
typedef struct
_net_nfc_llcp_config_info_s 
net_nfc_llcp_config_info_s
 Structure for LLCP configuration information containing various parameters.
typedef struct
_net_nfc_llcp_socket_option_s 
net_nfc_llcp_socket_option_s
 Structure for LLCP socket option containing various parameters.
typedef struct
_net_nfc_llcp_internal_socket_s 
net_nfc_llcp_internal_socket_s
 Structure for internal LLCP socket containing various parameters.
typedef struct
_net_nfc_ndef_record_s 
net_nfc_ndef_record_s
 Structure for NDEF record containing various fields.
typedef struct
_net_nfc_ndef_message_s 
net_nfc_ndef_message_s
 Structure for NDEF message containing records.
typedef struct _net_nfc_tag_info_s net_nfc_tag_info_s
 Structure for NFC tag information containing key-value pairs.
typedef struct
_net_nfc_target_info_s 
net_nfc_target_info_s
 Structure for NFC target information containing various details.
typedef struct
_net_nfc_se_event_info_s 
net_nfc_se_event_info_s
 Structure for secure element event information containing AID and parameter.
typedef struct
_net_nfc_transceive_info_s 
net_nfc_transceive_info_s
 Structure for transceive information containing device type and data.
typedef struct
_net_nfc_connection_handover_info_s 
net_nfc_connection_handover_info_s
 Structure for connection handover information containing type and data.
typedef struct
_net_nfc_request_msg_t 
net_nfc_request_msg_t
 Structure for NFC request message containing various parameters.
typedef struct
_net_nfc_request_target_detected_t 
net_nfc_request_target_detected_t
 Structure for NFC request target detected containing various parameters.
typedef struct
_net_nfc_request_se_event_t 
net_nfc_request_se_event_t
 Structure for NFC request secure element event containing various parameters.
typedef struct
_net_nfc_request_llcp_msg_t 
net_nfc_request_llcp_msg_t
 Structure for NFC request LLCP message containing various parameters.
typedef struct
_net_nfc_request_hce_apdu_t 
net_nfc_request_hce_apdu_t
 Structure for NFC request HCE APDU containing various parameters.
typedef struct
_net_nfc_request_listen_socket_t 
net_nfc_request_listen_socket_t
 Structure for NFC request listen socket containing various parameters.
typedef struct
_net_nfc_request_receive_socket_t 
net_nfc_request_receive_socket_t
 Structure for NFC request receive socket containing various parameters.
typedef struct
_net_nfc_request_receive_from_socket_t 
net_nfc_request_receive_from_socket_t
 Structure for NFC request receive from socket containing various parameters.
typedef struct
_net_nfc_stack_information_s 
net_nfc_stack_information_s
 Structure for NFC stack information containing various parameters.
typedef struct
_secure_element_info_s 
net_nfc_secure_element_info_s
 Structure for secure element information containing various parameters.
typedef struct
_hal_backend_nfc_funcs 
hal_backend_nfc_funcs
 Structure for nfc functions.

Data Structure Documentation

struct _net_nfc_data_t

Structure for NFC data containing a buffer and its length.

This structure defines an NFC data structure containing a buffer and its length.

Since:
HAL_MODULE_NFC 1.0

Data Fields

uint8_t * buffer
uint32_t length

Field Documentation

Buffer array.

Length of the buffer.

struct _net_nfc_internal_data_t

Structure for NFC internal data containing a buffer and its length.

This structure defines an NFC data structure containing a buffer and its length.

Since:
HAL_MODULE_NFC 1.0

Data Fields

uint32_t length
uint8_t buffer [0]

Field Documentation

Buffer array.

Length of the buffer.

struct _net_nfc_target_handle_s

Structure for NFC target handle containing connection information.

This structure defines an NFC target handle structure containing connection information.

Since:
HAL_MODULE_NFC 1.0

Data Fields

uint32_t connection_id
net_nfc_connection_type_e connection_type
net_nfc_target_type_e target_type
net_nfc_llcp_app_protocol_e app_type

Field Documentation

Connection ID.

struct _net_nfc_current_target_info_s

Structure for current NFC target information containing handle and other details.

This structure defines a current NFC target information structure containing handle and other details.

Since:
HAL_MODULE_NFC 1.0

Data Fields

net_nfc_target_handle_shandle
uint32_t devType
int number_of_keys
net_nfc_data_s target_info_values

Field Documentation

struct _net_nfc_llcp_config_info_s

Structure for LLCP configuration information containing various parameters.

This structure defines an LLCP configuration information structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Data Fields

uint16_t miu
uint16_t wks
uint8_t lto
uint8_t option

Field Documentation

Link Time Out.

Maximum Information Unit.

Well-Known Services.

struct _net_nfc_llcp_socket_option_s

Structure for LLCP socket option containing various parameters.

This structure defines an LLCP socket option structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Data Fields

uint16_t miu
uint8_t rw
net_nfc_socket_type_e type

Field Documentation

Maximum Information Unit.

Receive Window Size.

struct _net_nfc_llcp_internal_socket_s

Structure for internal LLCP socket containing various parameters.

This structure defines an internal LLCP socket structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Data Fields

uint16_t miu
uint8_t rw
net_nfc_socket_type_e type
net_nfc_llcp_socket_t oal_socket
net_nfc_llcp_socket_t client_socket
net_nfc_sap_t sap
uint8_t * service_name
net_nfc_target_handle_sdevice_id
net_nfc_llcp_socket_cb cb
bool close_requested
void * register_param

Field Documentation

Maximum Information Unit.

Receive Window Size.

struct _net_nfc_ndef_record_s

Structure for NDEF record containing various fields.

This structure defines an NDEF record structure containing various fields.

Since:
HAL_MODULE_NFC 1.0

Data Fields

uint8_t MB:1
uint8_t ME:1
uint8_t CF:1
uint8_t SR:1
uint8_t IL:1
uint8_t TNF:3
net_nfc_data_s type_s
net_nfc_data_s id_s
net_nfc_data_s payload_s
struct _net_nfc_ndef_record_snext

Field Documentation

Chunk Flag bit.

ID Length Present bit.

Message Begin bit.

Message End bit.

Pointer to next record.

Short Record bit.

Type Name Format bits.

struct _net_nfc_ndef_message_s

Structure for NDEF message containing records.

This structure defines an NDEF message structure containing records.

Since:
HAL_MODULE_NFC 1.0

Data Fields

uint32_t recordCount
net_nfc_ndef_record_srecords

Field Documentation

Number of records.

struct _net_nfc_tag_info_s

Structure for NFC tag information containing key-value pairs.

This structure defines an NFC tag information structure containing key-value pairs.

Since:
HAL_MODULE_NFC 1.0

Data Fields

char * key
net_nfc_data_h value

Field Documentation

struct _net_nfc_target_info_s

Structure for NFC target information containing various details.

This structure defines an NFC target information structure containing various details.

Since:
HAL_MODULE_NFC 1.0

Data Fields

net_nfc_target_handle_shandle
net_nfc_target_type_e devType
uint8_t is_ndef_supported
uint8_t ndef_card_state
uint32_t max_data_size
uint32_t actual_data_size
int number_of_keys
net_nfc_tag_info_stag_info_list
char ** keylist
net_nfc_data_s raw_data

Field Documentation

Actual data size.

NDEF support flag.

Maximum data size.

NDEF card state.

struct _net_nfc_se_event_info_s

Structure for secure element event information containing AID and parameter.

This structure defines a secure element event information structure containing AID and parameter.

Since:
HAL_MODULE_NFC 1.0

Data Fields

net_nfc_data_s aid
net_nfc_data_s param

Field Documentation

struct _net_nfc_transceive_info_s

Structure for transceive information containing device type and data.

This structure defines a transceive information structure containing device type and data.

Since:
HAL_MODULE_NFC 1.0

Data Fields

uint32_t dev_type
net_nfc_data_s trans_data

Field Documentation

Device type.

struct _net_nfc_connection_handover_info_s

Structure for connection handover information containing type and data.

This structure defines a connection handover information structure containing type and data.

Since:
HAL_MODULE_NFC 1.0

Data Fields

net_nfc_conn_handover_carrier_type_e type
net_nfc_data_s data

Field Documentation

struct _net_nfc_request_msg_t

Structure for NFC request message containing various parameters.

This structure defines an NFC request message structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Data Fields

uint32_t length
uint32_t request_type
uint32_t client_fd
uint32_t flags
void * user_param

Field Documentation

Client file descriptor.

Length of the message.

Request type.

User parameter.

struct _net_nfc_request_target_detected_t

Structure for NFC request target detected containing various parameters.

This structure defines an NFC request target detected structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Data Fields

uint32_t length
uint32_t request_type
uint32_t client_fd
uint32_t flags
void * user_param
net_nfc_target_handle_shandle
uint32_t dev_type
int number_of_keys
net_nfc_internal_data_s target_info_values

Field Documentation

Client file descriptor.

Length of the message.

struct _net_nfc_request_se_event_t

Structure for NFC request secure element event containing various parameters.

This structure defines an NFC request secure element event structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Data Fields

uint32_t length
uint32_t request_type
uint32_t client_fd
uint32_t flags
void * user_param
net_nfc_data_s aid
net_nfc_data_s param

Field Documentation

Client file descriptor.

Length of the message.

struct _net_nfc_request_llcp_msg_t

Structure for NFC request LLCP message containing various parameters.

This structure defines an NFC request LLCP message structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Data Fields

uint32_t length
uint32_t request_type
uint32_t client_fd
uint32_t flags
void * user_param
uint32_t result
net_nfc_llcp_socket_t llcp_socket

Field Documentation

Client file descriptor.

Length of the message.

struct _net_nfc_request_hce_apdu_t

Structure for NFC request HCE APDU containing various parameters.

This structure defines an NFC request HCE APDU structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Data Fields

uint32_t length
uint32_t request_type
uint32_t client_fd
uint32_t flags
void * user_param
net_nfc_data_s apdu

Field Documentation

Client file descriptor.

Length of the message.

struct _net_nfc_request_listen_socket_t

Structure for NFC request listen socket containing various parameters.

This structure defines an NFC request listen socket structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Data Fields

uint32_t length
uint32_t request_type
uint32_t client_fd
uint32_t flags
void * user_param
uint32_t result
net_nfc_target_handle_shandle
net_nfc_llcp_socket_t client_socket
uint16_t miu
uint8_t rw
net_nfc_socket_type_e type
net_nfc_llcp_socket_t oal_socket
net_nfc_sap_t sap
void * trans_param
net_nfc_internal_data_s service_name

Field Documentation

Client file descriptor.

Length of the message.

Maximum Information Unit.

Receive Window Size.

Transaction parameter.

struct _net_nfc_request_receive_socket_t

Structure for NFC request receive socket containing various parameters.

This structure defines an NFC request receive socket structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Data Fields

uint32_t length
uint32_t request_type
uint32_t client_fd
uint32_t flags
void * user_param
uint32_t result
net_nfc_target_handle_shandle
net_nfc_llcp_socket_t client_socket
net_nfc_llcp_socket_t oal_socket
size_t req_length
void * trans_param
net_nfc_internal_data_s data

Field Documentation

Client file descriptor.

Length of the message.

Transaction parameter.

struct _net_nfc_request_receive_from_socket_t

Structure for NFC request receive from socket containing various parameters.

This structure defines an NFC request receive from socket structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Data Fields

uint32_t length
uint32_t request_type
uint32_t client_fd
uint32_t flags
void * user_param
uint32_t result
net_nfc_target_handle_shandle
net_nfc_llcp_socket_t client_socket
net_nfc_llcp_socket_t oal_socket
size_t req_length
net_nfc_sap_t sap
void * trans_param
net_nfc_internal_data_s data

Field Documentation

Client file descriptor.

Length of the message.

struct _net_nfc_stack_information_s

Structure for NFC stack information containing various parameters.

This structure defines an NFC stack information structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Data Fields

uint32_t net_nfc_supported_target_type
uint32_t net_nfc_fw_version

Field Documentation

struct _secure_element_info_s

Structure for secure element information containing various parameters.

This structure defines a secure element information structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Data Fields

net_nfc_target_handle_shandle
net_nfc_secure_element_type_e secure_element_type
net_nfc_secure_element_state_e secure_element_state

Field Documentation

struct _hal_backend_nfc_funcs

Structure for nfc functions.

Since:
HAL_MODULE_NFC 1.0

Data Fields

int(* start )(void)
int(* stop )(void)
int(* register_listener )(net_nfc_target_detection_listener_cb target_detection_listener, net_nfc_se_transaction_listener_cb se_transaction_listener, net_nfc_llcp_event_listener_cb llcp_event_listener, net_nfc_hce_apdu_listener_cb hce_apdu_listener)
int(* unregister_listener )(void)
int(* get_firmware_version )(net_nfc_data_s **data)
int(* support_nfc )(void)
int(* check_firmware_version )(void)
int(* update_firmware )(void)
int(* get_stack_information )(net_nfc_stack_information_s *stack_info)
int(* configure_discovery )(net_nfc_discovery_mode_e mode, net_nfc_event_filter_e config)
int(* check_target_presence )(net_nfc_target_handle_s *handle)
int(* connect )(net_nfc_target_handle_s *handle)
int(* disconnect )(net_nfc_target_handle_s *handle)
int(* check_ndef )(net_nfc_target_handle_s *handle, uint8_t *ndef_card_state, int *max_data_size, int *real_data_size)
int(* read_ndef )(net_nfc_target_handle_s *handle, net_nfc_data_s **data)
int(* write_ndef )(net_nfc_target_handle_s *handle, net_nfc_data_s *data)
int(* make_read_only_ndef )(net_nfc_target_handle_s *handle)
int(* format_ndef )(net_nfc_target_handle_s *handle, net_nfc_data_s *secure_key)
int(* transceive )(net_nfc_target_handle_s *handle, net_nfc_transceive_info_s *info, net_nfc_data_s **data)
int(* exception_handler )(void)
int(* is_ready )(void)
int(* llcp_config )(net_nfc_llcp_config_info_s *config)
int(* llcp_check_llcp )(net_nfc_target_handle_s *handle)
int(* llcp_activate_llcp )(net_nfc_target_handle_s *handle)
int(* llcp_create_socket )(net_nfc_llcp_socket_t *socket, net_nfc_socket_type_e type, uint16_t miu, uint8_t rw, void *user_param)
int(* llcp_bind )(net_nfc_llcp_socket_t socket, uint8_t service_access_point)
int(* llcp_listen )(net_nfc_target_handle_s *handle, uint8_t *service_access_name, net_nfc_llcp_socket_t socket, void *user_param)
int(* llcp_accept )(net_nfc_llcp_socket_t socket, void *user_param)
int(* llcp_connect_by_url )(net_nfc_target_handle_s *handle, net_nfc_llcp_socket_t socket, uint8_t *service_access_name, void *user_param)
int(* llcp_connect )(net_nfc_target_handle_s *handle, net_nfc_llcp_socket_t socket, uint8_t service_access_point, void *user_param)
int(* llcp_disconnect )(net_nfc_target_handle_s *handle, net_nfc_llcp_socket_t socket, void *user_param)
int(* llcp_socket_close )(net_nfc_llcp_socket_t socket)
int(* llcp_recv )(net_nfc_target_handle_s *handle, net_nfc_llcp_socket_t socket, net_nfc_data_s *data, void *user_param)
int(* llcp_send )(net_nfc_target_handle_s *handle, net_nfc_llcp_socket_t socket, net_nfc_data_s *data, void *user_param)
int(* llcp_recv_from )(net_nfc_target_handle_s *handle, net_nfc_llcp_socket_t socket, net_nfc_data_s *data, void *user_param)
int(* llcp_send_to )(net_nfc_target_handle_s *handle, net_nfc_llcp_socket_t socket, net_nfc_data_s *data, uint8_t service_access_point, void *user_param)
int(* llcp_reject )(net_nfc_target_handle_s *handle, net_nfc_llcp_socket_t socket)
int(* llcp_get_remote_config )(net_nfc_target_handle_s *handle, net_nfc_llcp_config_info_s *config)
int(* llcp_get_remote_socket_info )(net_nfc_target_handle_s *handle, net_nfc_llcp_socket_t socket, net_nfc_llcp_socket_option_s *option)
int(* secure_element_open )(net_nfc_secure_element_type_e element_type, net_nfc_target_handle_s **handle)
int(* secure_element_get_atr )(net_nfc_target_handle_s *handle, net_nfc_data_s **atr)
int(* secure_element_send_apdu )(net_nfc_target_handle_s *handle, net_nfc_data_s *command, net_nfc_data_s **response)
int(* secure_element_close )(net_nfc_target_handle_s *handle)
int(* get_secure_element_list )(net_nfc_secure_element_info_s *list, int *count)
int(* set_secure_element_mode )(net_nfc_secure_element_type_e element_type, net_nfc_secure_element_mode_e mode)
int(* test_mode_on )(void)
int(* test_mode_off )(void)
int(* hce_response_apdu )(net_nfc_target_handle_s *handle, net_nfc_data_s *response)
int(* secure_element_route_aid )(net_nfc_data_s *aid, net_nfc_se_type_e se_type, int power)
int(* secure_element_unroute_aid )(net_nfc_data_s *aid)
int(* secure_element_commit_routing )(void)
int(* secure_element_set_default_route )(net_nfc_se_type_e switch_on, net_nfc_se_type_e switch_off, net_nfc_se_type_e battery_off)
int(* secure_element_clear_aid_table )(void)
int(* secure_element_get_aid_table_size )(int *table_size)
int(* secure_element_set_route_entry )(net_nfc_se_entry_type_e type, net_nfc_se_tech_protocol_type_e value, net_nfc_se_type_e route, int power)
int(* secure_element_clear_routing_entry )(net_nfc_se_entry_type_e type)
int(* secure_element_set_listen_tech_mask )(net_nfc_se_tech_protocol_type_e screen_state)

Field Documentation

Updates the firmware of the NFC module

int(* _hal_backend_nfc_funcs::check_ndef)(net_nfc_target_handle_s *handle, uint8_t *ndef_card_state, int *max_data_size, int *real_data_size)

Reads an NDEF message

Checks whether a target is present

Disconnects from a target

Checks whether an NDEF message is supported

Checks whether the NFC module is ready

Transceives data with a target

Checks whether the NFC module is supported

Sets the mode of a secure element

Configures the discovery mode and settings

Routes an AID to a secure element

Configures LLCP settings

Connects using a URL

int(* _hal_backend_nfc_funcs::llcp_bind)(net_nfc_llcp_socket_t socket, uint8_t service_access_point)

Listens on a socket

Checks whether LLCP is supported

int(* _hal_backend_nfc_funcs::llcp_connect)(net_nfc_target_handle_s *handle, net_nfc_llcp_socket_t socket, uint8_t service_access_point, void *user_param)

Disconnects from a socket

int(* _hal_backend_nfc_funcs::llcp_connect_by_url)(net_nfc_target_handle_s *handle, net_nfc_llcp_socket_t socket, uint8_t *service_access_name, void *user_param)

Connects using a service access point

int(* _hal_backend_nfc_funcs::llcp_create_socket)(net_nfc_llcp_socket_t *socket, net_nfc_socket_type_e type, uint16_t miu, uint8_t rw, void *user_param)

Binds a socket

Closes a socket

Gets the remote socket information

int(* _hal_backend_nfc_funcs::llcp_listen)(net_nfc_target_handle_s *handle, uint8_t *service_access_name, net_nfc_llcp_socket_t socket, void *user_param)

Accepts a connection request

Sends data on a socket

Sends data on a socket

Gets the remote LLCP configuration

Receives data on a socket

int(* _hal_backend_nfc_funcs::llcp_send_to)(net_nfc_target_handle_s *handle, net_nfc_llcp_socket_t socket, net_nfc_data_s *data, uint8_t service_access_point, void *user_param)

Rejects a connection request

Receives data on a socket

Writes an NDEF message

Unregisters the registered listener

Gets the size of the AID table

Sets the technology mask for listening

Gets the list of secure elements

Sets the default route for different states

Sets a routing entry

Sends an APDU command to a secure element

Gets the ATR information of a secure element

Unroutes an AID from a secure element

Closes a secure element

< Starts the NFC module Stops the NFC module

Registers listeners for specific events

Checks the firmware version of the NFC module

Sends a response APDU in HCE mode

Disables test mode

Gets the firmware version of the NFC module

Gets the stack information of the NFC module

Makes an NDEF message read-only


Typedef Documentation

Structure for nfc functions.

Since:
HAL_MODULE_NFC 1.0

Enumeration for different states of NFC clients.

This enumeration defines different states of NFC clients that can be encountered.

Since:
HAL_MODULE_NFC 1.0

Handle for connection handover information structure.

This typedef defines a handle for a connection handover information structure.

Since:
HAL_MODULE_NFC 1.0

Structure for connection handover information containing type and data.

This structure defines a connection handover information structure containing type and data.

Since:
HAL_MODULE_NFC 1.0

Enumeration for different types of NFC connection types.

This enumeration defines different types of NFC connection types that can be used in NFC communication.

Since:
HAL_MODULE_NFC 1.0

Structure for current NFC target information containing handle and other details.

This structure defines a current NFC target information structure containing handle and other details.

Since:
HAL_MODULE_NFC 1.0
typedef struct _net_nfc_data_s* net_nfc_data_h

Handle for data structure.

This typedef defines a handle for a data structure.

Since:
HAL_MODULE_NFC 1.0

Structure for NFC data containing a buffer and its length.

This structure defines an NFC data structure containing a buffer and its length.

Since:
HAL_MODULE_NFC 1.0

Enumeration for different types of discovery modes.

This enumeration defines different types of discovery modes that can be used in NFC communication.

Since:
HAL_MODULE_NFC 1.0
typedef void(* net_nfc_hce_apdu_listener_cb)(void *data, void *user_param)

Callback function for HCE APDU events.

This typedef defines a callback function for HCE APDU events.

Since:
HAL_MODULE_NFC 1.0
Parameters:
[in]dataThe data associated with the event.
[in]user_paramThe user parameter passed to the callback function.

Structure for NFC internal data containing a buffer and its length.

This structure defines an NFC data structure containing a buffer and its length.

Since:
HAL_MODULE_NFC 1.0

Enumeration for different types of launch popup checks.

This enumeration defines different types of launch popup checks that can be used in NFC communication.

Since:
HAL_MODULE_NFC 1.0

Enumeration for different states of launch popup selection.

This enumeration defines different states of launch popup selection that can be encountered.

Since:
HAL_MODULE_NFC 1.0

Handle for LLCP configuration information structure.

This typedef defines a handle for an LLCP configuration information structure.

Since:
HAL_MODULE_NFC 1.0

Structure for LLCP configuration information containing various parameters.

This structure defines an LLCP configuration information structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Enumeration for different types of LLCP events.

This enumeration defines different types of LLCP events that can be received.

Since:
HAL_MODULE_NFC 1.0
typedef void(* net_nfc_llcp_event_listener_cb)(void *data, void *user_param)

Callback function for LLCP event events.

This typedef defines a callback function for LLCP event events.

Since:
HAL_MODULE_NFC 1.0
Parameters:
[in]dataThe data associated with the event.
[in]user_paramThe user parameter passed to the callback function.

Structure for internal LLCP socket containing various parameters.

This structure defines an internal LLCP socket structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0
typedef void(* net_nfc_llcp_socket_cb)(net_nfc_llcp_message_e message, int result, void *data, void *user_data, void *trans_data)

Callback function for LLCP socket events.

This typedef defines a callback function for LLCP socket events.

Since:
HAL_MODULE_NFC 1.0
Parameters:
[in]messageThe type of LLCP message.
[in]resultThe result of the operation.
[in]dataThe data associated with the message.
[in]user_dataThe user data passed to the callback function.
[in]trans_dataThe transaction data associated with the message.

Handle for LLCP socket option structure.

This typedef defines a handle for an LLCP socket option structure.

Since:
HAL_MODULE_NFC 1.0

Structure for LLCP socket option containing various parameters.

This structure defines an LLCP socket option structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0
typedef uint32_t net_nfc_llcp_socket_t

Typedef for LLCP socket type.

This typedef defines a type for LLCP socket.

Since:
HAL_MODULE_NFC 1.0

Enumeration for different types of NFC service messages.

This enumeration defines different types of NFC service messages that can be received.

Since:
HAL_MODULE_NFC 1.0

Handle for NDEF message structure.

This typedef defines a handle for an NDEF message structure.

Since:
HAL_MODULE_NFC 1.0

Structure for NDEF message containing records.

This structure defines an NDEF message structure containing records.

Since:
HAL_MODULE_NFC 1.0

Handle for NDEF record structure.

This typedef defines a handle for an NDEF record structure.

Since:
HAL_MODULE_NFC 1.0

Structure for NDEF record containing various fields.

This structure defines an NDEF record structure containing various fields.

Since:
HAL_MODULE_NFC 1.0

Enumeration for different types of NFC privileges.

This enumeration defines different types of NFC privileges that can be used in NFC communication.

Since:
HAL_MODULE_NFC 1.0

Structure for NFC request HCE APDU containing various parameters.

This structure defines an NFC request HCE APDU structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Structure for NFC request listen socket containing various parameters.

This structure defines an NFC request listen socket structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Structure for NFC request LLCP message containing various parameters.

This structure defines an NFC request LLCP message structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Structure for NFC request message containing various parameters.

This structure defines an NFC request message structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Structure for NFC request receive from socket containing various parameters.

This structure defines an NFC request receive from socket structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Structure for NFC request receive socket containing various parameters.

This structure defines an NFC request receive socket structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Structure for NFC request secure element event containing various parameters.

This structure defines an NFC request secure element event structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Structure for NFC request target detected containing various parameters.

This structure defines an NFC request target detected structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0
typedef uint8_t net_nfc_sap_t

Typedef for Service Access Point (SAP) type.

This typedef defines a type for Service Access Point (SAP).

Since:
HAL_MODULE_NFC 1.0

Structure for secure element event information containing AID and parameter.

This structure defines a secure element event information structure containing AID and parameter.

Since:
HAL_MODULE_NFC 1.0
typedef void(* net_nfc_se_transaction_listener_cb)(void *data, void *user_param)

Callback function for secure element (SE) transaction events.

This typedef defines a callback function for secure element (SE) transaction events.

Since:
HAL_MODULE_NFC 1.0
Parameters:
[in]dataThe data associated with the event.
[in]user_paramThe user parameter passed to the callback function.

Structure for secure element information containing various parameters.

This structure defines a secure element information structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Enumeration for different modes of secure element (SE).

This enumeration defines different modes of secure element (SE) that can be used in NFC communication.

Since:
HAL_MODULE_NFC 1.0

Enumeration for different states of secure element (SE).

This enumeration defines different states of secure element (SE) that can be encountered.

Since:
HAL_MODULE_NFC 1.0

Enumeration for different types of secure element (SE) types.

This enumeration defines different types of secure element (SE) types that can be used in NFC communication.

Since:
HAL_MODULE_NFC 1.0

Structure for NFC stack information containing various parameters.

This structure defines an NFC stack information structure containing various parameters.

Since:
HAL_MODULE_NFC 1.0

Structure for NFC tag information containing key-value pairs.

This structure defines an NFC tag information structure containing key-value pairs.

Since:
HAL_MODULE_NFC 1.0
typedef void(* net_nfc_target_detection_listener_cb)(void *data, void *user_param)

Callback function for target detection events.

This typedef defines a callback function for target detection events.

Since:
HAL_MODULE_NFC 1.0
Parameters:
[in]dataThe data associated with the event.
[in]user_paramThe user parameter passed to the callback function.

Handle for NFC target handle structure.

This typedef defines a handle for an NFC target handle structure.

Since:
HAL_MODULE_NFC 1.0

Structure for NFC target handle containing connection information.

This structure defines an NFC target handle structure containing connection information.

Since:
HAL_MODULE_NFC 1.0

Handle for NFC target information structure.

This typedef defines a handle for an NFC target information structure.

Since:
HAL_MODULE_NFC 1.0

Structure for NFC target information containing various details.

This structure defines an NFC target information structure containing various details.

Since:
HAL_MODULE_NFC 1.0

Structure for transceive information containing device type and data.

This structure defines a transceive information structure containing device type and data.

Since:
HAL_MODULE_NFC 1.0

Enumeration Type Documentation

Enumeration for different states of NFC clients.

This enumeration defines different states of NFC clients that can be encountered.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_CLIENT_INACTIVE_STATE 

Inactive state of NFC client.

NET_NFC_CLIENT_ACTIVE_STATE 

Active state of NFC client.

Enumeration for different types of LLCP events.

This enumeration defines different types of LLCP events that can be received.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_LLCP_EVENT_SOCKET_ACCEPTED 

LLCP socket accepted event type.

NET_NFC_LLCP_EVENT_SOCKET_ERROR 

LLCP socket error event type.

NET_NFC_LLCP_EVENT_DEACTIVATED 

LLCP deactivated event type.

Enumeration for different types of NFC connection types.

This enumeration defines different types of NFC connection types that can be used in NFC communication.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_TAG_CONNECTION 

Tag connection type.

NET_NFC_P2P_CONNECTION_TARGET 

Peer-to-peer connection target type.

NET_NFC_P2P_CONNECTION_INITIATOR 

Peer-to-peer connection initiator type.

NET_NFC_SE_CONNECTION 

Secure element connection type.

Enumeration for different types of discovery modes.

This enumeration defines different types of discovery modes that can be used in NFC communication.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_DISCOVERY_MODE_STOP 

Stop discovery mode.

NET_NFC_DISCOVERY_MODE_CONFIG_POLLING 

Configure polling mode.

NET_NFC_DISCOVERY_MODE_CONFIG_LISTENING 

Configure listening mode.

NET_NFC_DISCOVERY_MODE_CONFIG_P2P 

Configure peer-to-peer mode.

NET_NFC_DISCOVERY_MODE_CONFIG_ALL 

Configure all modes.

NET_NFC_DISCOVERY_MODE_CONFIG_DEFAULT 

Configure default modes.

NET_NFC_DISCOVERY_MODE_CONFIG 

Configure modes.

NET_NFC_DISCOVERY_MODE_START_LISTENING 

Start listening mode.

NET_NFC_DISCOVERY_MODE_START_POLLING 

Start polling mode.

NET_NFC_DISCOVERY_MODE_START_ALL 

Start all modes.

NET_NFC_DISCOVERY_MODE_START_DEFAULT 

Start default modes.

NET_NFC_DISCOVERY_MODE_START 

Start modes.

NET_NFC_DISCOVERY_MODE_RESUME 

Resume modes.

Enumeration for different types of launch popup checks.

This enumeration defines different types of launch popup checks that can be used in NFC communication.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_CHECK_FOREGROUND 

Check foreground.

NET_NFC_NO_CHECK_FOREGROUND 

No check foreground.

Enumeration for different states of launch popup selection.

This enumeration defines different states of launch popup selection that can be encountered.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_LAUNCH_APP_SELECT 

Launch app select.

NET_NFC_NO_LAUNCH_APP_SELECT 

No launch app select.

Enumeration for different types of NFC service messages.

This enumeration defines different types of NFC service messages that can be received.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_MESSAGE_SERVICE_RESET 

Reset NFC service message type.

NET_NFC_MESSAGE_SERVICE_INIT 

Initialize NFC service message type.

NET_NFC_MESSAGE_SERVICE_ACTIVATE 

Activate NFC service message type.

NET_NFC_MESSAGE_SERVICE_DEACTIVATE 

Deactivate NFC service message type.

NET_NFC_MESSAGE_SERVICE_DEINIT 

Deinitialize NFC service message type.

NET_NFC_MESSAGE_SERVICE_STANDALONE_TARGET_DETECTED 

Standalone target detected message type.

NET_NFC_MESSAGE_SERVICE_SE 

Secure element message type.

NET_NFC_MESSAGE_SERVICE_TERMINATION 

Termination message type.

NET_NFC_MESSAGE_SERVICE_SLAVE_TARGET_DETECTED 

Slave target detected message type.

NET_NFC_MESSAGE_SERVICE_SLAVE_ESE_DETECTED 

Secure element detected message type.

NET_NFC_MESSAGE_SERVICE_RESTART_POLLING_LOOP 

Restart polling loop message type.

NET_NFC_MESSAGE_SERVICE_LLCP_LISTEN 

LLCP listen message type.

NET_NFC_MESSAGE_SERVICE_LLCP_INCOMING 

LLCP incoming message type.

NET_NFC_MESSAGE_SERVICE_LLCP_ACCEPT 

LLCP accept message type.

NET_NFC_MESSAGE_SERVICE_LLCP_REJECT 

LLCP reject message type.

NET_NFC_MESSAGE_SERVICE_LLCP_SEND 

LLCP send message type.

NET_NFC_MESSAGE_SERVICE_LLCP_SEND_TO 

LLCP send to message type.

NET_NFC_MESSAGE_SERVICE_LLCP_RECEIVE 

LLCP receive message type.

NET_NFC_MESSAGE_SERVICE_LLCP_RECEIVE_FROM 

LLCP receive from message type.

NET_NFC_MESSAGE_SERVICE_LLCP_CONNECT 

LLCP connect message type.

NET_NFC_MESSAGE_SERVICE_LLCP_CONNECT_SAP 

LLCP connect SAP message type.

NET_NFC_MESSAGE_SERVICE_LLCP_DISCONNECT 

LLCP disconnect message type.

NET_NFC_MESSAGE_SERVICE_LLCP_DEACTIVATED 

LLCP deactivated message type.

NET_NFC_MESSAGE_SERVICE_LLCP_SOCKET_ERROR 

LLCP socket error message type.

NET_NFC_MESSAGE_SERVICE_LLCP_SOCKET_ACCEPTED_ERROR 

LLCP socket accepted error message type.

NET_NFC_MESSAGE_SERVICE_CHANGE_CLIENT_STATE 

Change client state message type.

NET_NFC_MESSAGE_SERVICE_WATCH_DOG 

Watchdog message type.

NET_NFC_MESSAGE_SERVICE_CLEANER 

Cleaner message type.

NET_NFC_MESSAGE_SERVICE_SET_LAUNCH_STATE 

Set launch state message type.

Enumeration for different types of NFC privileges.

This enumeration defines different types of NFC privileges that can be used in NFC communication.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_PRIVILEGE_NFC 

NFC privilege.

NET_NFC_PRIVILEGE_NFC_ADMIN 

NFC admin privilege.

NET_NFC_PRIVILEGE_NFC_TAG 

NFC tag privilege.

NET_NFC_PRIVILEGE_NFC_P2P 

NFC peer-to-peer privilege.

NET_NFC_PRIVILEGE_NFC_CARD_EMUL 

NFC card emulation privilege.

Enumeration for different modes of secure element (SE).

This enumeration defines different modes of secure element (SE) that can be used in NFC communication.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_SECURE_ELEMENT_WIRED_MODE 

Enables wired mode communication. This mode shall be applied to eSE.

NET_NFC_SECURE_ELEMENT_VIRTUAL_MODE 

Enables virtual mode communication. This can be applied to UICC as well as eSE.

NET_NFC_SECURE_ELEMENT_OFF_MODE 

Inactivates SE. This means, put SE in inactive state.

Enumeration for different states of secure element (SE).

This enumeration defines different states of secure element (SE) that can be encountered.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_SECURE_ELEMENT_INACTIVE_STATE 

Inactive state of SE.

NET_NFC_SECURE_ELEMENT_ACTIVE_STATE 

Active state of SE.

Enumeration for different types of secure element (SE) types.

This enumeration defines different types of secure element (SE) types that can be used in NFC communication.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_SECURE_ELEMENT_TYPE_INVALID 

Indicates SE type is invalid.

NET_NFC_SECURE_ELEMENT_TYPE_ESE 

Indicates SE type is SmartMX.

NET_NFC_SECURE_ELEMENT_TYPE_UICC 

Indicates SE type is UICC.

NET_NFC_SECURE_ELEMENT_TYPE_SDCARD 

Indicates SE type is SDCARD.

NET_NFC_SECURE_ELEMENT_TYPE_HCE 

Indicates SE type is HCE.

NET_NFC_SECURE_ELEMENT_TYPE_UNKNOWN 

Indicates SE type is unknown.

Enumeration for different types of connection handover carriers.

This enumeration defines different types of connection handover carriers that can be used in NFC communication.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_CONN_HANDOVER_CARRIER_BT 

Bluetooth carrier.

NET_NFC_CONN_HANDOVER_CARRIER_WIFI_WPS 

Wi-Fi Protected Setup carrier.

NET_NFC_CONN_HANDOVER_CARRIER_WIFI_P2P 

Wi-Fi Peer-to-Peer carrier.

NET_NFC_CONN_HANDOVER_CARRIER_BT_LE 

Bluetooth Low Energy carrier.

NET_NFC_CONN_HANDOVER_CARRIER_UNKNOWN 

Unknown carrier.

Structure for nfc error.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_OK 

Status is OK

NET_NFC_UNKNOWN_ERROR 

Unknown error

NET_NFC_ALLOC_FAIL 

Memory allocation is failed

NET_NFC_THREAD_CREATE_FAIL 

Thread creation is failed

NET_NFC_INVALID_STATE 

State of NFC-Manager or nfc-stack is not normal

NET_NFC_IPC_FAIL 

Communication with ipc is failed. (from client to server)

NET_NFC_OUT_OF_BOUND 

Index is out of bound

NET_NFC_NULL_PARAMETER 

Unexpected NULL parameter is received

NET_NFC_BUFFER_TOO_SMALL 

Requested buffer is too small to store data, this error should be received

NET_NFC_ALREADY_INITIALIZED 

You tried to initialized again without de-init

NET_NFC_COMMUNICATE_WITH_CONTROLLER_FAILED 

Communication with Controller Chipset is failed this is Fatal Error

NET_NFC_RF_TIMEOUT 

Timeout is raised while communicate with a tag

NET_NFC_RF_ERROR 

Unexpected package is received from target, you may receive this error comes by the low level RF communication fault

NET_NFC_NOT_INITIALIZED 

Application tries to request without initialization

NET_NFC_NOT_SUPPORTED 

Request information or command is not supported in current connected target

NET_NFC_ALREADY_REGISTERED 

Requested SAP number is already used by other socket or data is already appended or registered

NET_NFC_NOT_ALLOWED_OPERATION 

Requested Operation is not allowed in the situation in critical time (such as write data on target)

NET_NFC_BUSY 

Previous operation is not finished. don't worry to get this message, most of request will be executed in the serial queue

NET_NFC_INVALID_HANDLE 

Requested Device in not valid device

NET_NFC_TAG_READ_FAILED 

Tag reading is failed because of unexpected chunk data is received or error ack is received

NET_NFC_TAG_WRITE_FAILED 

When you try to write on read only tag or error ack is received

NET_NFC_NO_NDEF_SUPPORT 

Tag is not supported NDEF format for tag is not formatted for NDEF

NET_NFC_NO_NDEF_MESSAGE 

No data is received after NDEF reading

NET_NFC_INVALID_FORMAT 

Received data is not readable or it has illegal values or format

NET_NFC_INSUFFICIENT_STORAGE 

The connected tag does not have enough information

NET_NFC_OPERATION_FAIL 

The remote target returned error while doing a operation

NET_NFC_NOT_CONNECTED 

remote is not connected correctly. This can be happened when the RF does not have enough strength

NET_NFC_NO_DATA_FOUND 

Requested data is not found in the list or properties

NET_NFC_SECURITY_FAIL 

Authentication is failed while communication with nfc-manager server

NET_NFC_TARGET_IS_MOVED_AWAY 

Target is lost while doing a operation

NET_NFC_NOT_REGISTERED 

Target is already formatted removal is requested but requested data is not registered

NET_NFC_INVALID_PARAM 

removal is requested but requested data is not registered

NET_NFC_PERMISSION_DENIED 

privilege check is failed

NET_NFC_NOT_ACTIVATED 

Application tries to request without activation

NET_NFC_DATA_CONFLICTED 

Data is conflicted with another one

NET_NFC_NDEF_TYPE_LENGTH_IS_NOT_OK 

Illegal ndef record type length

NET_NFC_NDEF_PAYLOAD_LENGTH_IS_NOT_OK 

Illegal ndef record payload length

NET_NFC_NDEF_ID_LENGTH_IS_NOT_OK 

Illegal ndef record id length

NET_NFC_NDEF_RECORD_IS_NOT_EXPECTED_TYPE 

Parameter record is not expected record. for example, try to URI from text record

NET_NFC_NDEF_BUF_END_WITHOUT_ME 

NDEF messages is terminated without ME flag

NET_NFC_DEVICE_DOES_NOT_SUPPORT_NFC 

Current device does not support NFC feature or this manager does not found plugin library

NET_NFC_LLCP_INVALID_SOCKET 

socket is not valid socket

NET_NFC_LLCP_SOCKET_DISCONNECTED 

socket is disconnected

NET_NFC_LLCP_SOCKET_FRAME_REJECTED 

send data is rejected from remote side

NET_NFC_P2P_SEND_FAIL 

P2P data send fail

Enumeration for different event filters for NFC events.

This enumeration defines different event filters that can be used to control which NFC events are received.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_ALL_DISABLE 

Disable all NFC events.

NET_NFC_ISO14443A_ENABLE 

Enable ISO/IEC 14443 Type A events.

NET_NFC_ISO14443B_ENABLE 

Enable ISO/IEC 14443 Type B events.

NET_NFC_ISO15693_ENABLE 

Enable ISO/IEC 15693 events.

NET_NFC_FELICA_ENABLE 

Enable Felica events.

NET_NFC_JEWEL_ENABLE 

Enable Jewel events.

NET_NFC_IP_ENABLE 

Enable NFC-IP events.

NET_NFC_ALL_ENABLE 

Enable all NFC events.

Enumeration for different types of application protocols supported by LLCP.

This enumeration defines different types of application protocols that can be used in LLCP communication.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_SNEP 

SNEP (Simple NDEF Exchange Protocol) application protocol.

NET_NFC_NPP 

NPP (NFC Data Exchange Format) application protocol.

Enumeration for different types of LLCP messages.

This enumeration defines different types of LLCP messages that can be received.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_MESSAGE_LLCP_LISTEN 

LLCP listen message type.

NET_NFC_MESSAGE_LLCP_ACCEPTED 

LLCP accepted message type.

NET_NFC_MESSAGE_LLCP_CONNECT 

LLCP connect message type.

NET_NFC_MESSAGE_LLCP_CONNECT_SAP 

LLCP connect SAP message type.

NET_NFC_MESSAGE_LLCP_SEND 

LLCP send message type.

NET_NFC_MESSAGE_LLCP_SEND_TO 

LLCP send to message type.

NET_NFC_MESSAGE_LLCP_RECEIVE 

LLCP receive message type.

NET_NFC_MESSAGE_LLCP_RECEIVE_FROM 

LLCP receive from message type.

NET_NFC_MESSAGE_LLCP_DISCONNECT 

LLCP disconnect message type.

NET_NFC_MESSAGE_LLCP_ERROR 

LLCP error message type.

NET_NFC_MESSAGE_LLCP_CONNECT_REQ 

LLCP connect request message type.

NET_NFC_MESSAGE_LLCP_ACCEPT 

LLCP accept message type.

NET_NFC_MESSAGE_LLCP_REJECT 

LLCP reject message type.

NET_NFC_MESSAGE_LLCP_REJECTED 

LLCP rejected message type.

NET_NFC_MESSAGE_LLCP_CLOSE 

LLCP close message type.

Enumeration for different types of NFC messages.

This enumeration defines different types of NFC messages that can be received.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_MESSAGE_TRANSCEIVE 

Transceive message type.

NET_NFC_MESSAGE_READ_NDEF 

Read NDEF message type.

NET_NFC_MESSAGE_WRITE_NDEF 

Write NDEF message type.

NET_NFC_MESSAGE_MAKE_READ_ONLY_NDEF 

Make read-only NDEF message type.

NET_NFC_MESSAGE_IS_TAG_CONNECTED 

Check if tag is connected message type.

NET_NFC_MESSAGE_GET_CURRENT_TAG_INFO 

Get current tag information message type.

NET_NFC_MESSAGE_GET_CURRENT_TARGET_HANDLE 

Get current target handle message type.

NET_NFC_MESSAGE_TAG_DISCOVERED 

Tag discovered message type.

NET_NFC_MESSAGE_NOTIFY 

Notify message type.

NET_NFC_MESSAGE_TAG_DETACHED 

Tag detached message type.

NET_NFC_MESSAGE_LLCP_DISCOVERED 

LLCP discovered message type.

NET_NFC_MESSAGE_P2P_DETACHED 

P2P detached message type.

NET_NFC_MESSAGE_LLCP_CONFIG 

LLCP configuration message type.

NET_NFC_MESSAGE_P2P_DISCOVERED 

P2P discovered message type.

NET_NFC_MESSAGE_P2P_SEND 

P2P send message type.

NET_NFC_MESSAGE_P2P_RECEIVE 

P2P receive message type.

NET_NFC_MESSAGE_SE_START_TRANSACTION 

Secure element start transaction message type.

NET_NFC_MESSAGE_SE_END_TRANSACTION 

Secure element end transaction message type.

NET_NFC_MESSAGE_SE_TYPE_TRANSACTION 

Secure element type transaction message type.

NET_NFC_MESSAGE_SE_CONNECTIVITY 

Secure element connectivity message type.

NET_NFC_MESSAGE_SE_FIELD_ON 

Secure element field on message type.

NET_NFC_MESSAGE_SE_FIELD_OFF 

Secure element field off message type.

NET_NFC_MESSAGE_SE_TYPE_CHANGED 

Secure element type changed message type.

NET_NFC_MESSAGE_SE_CARD_EMULATION_CHANGED 

Secure element card emulation changed message type.

NET_NFC_MESSAGE_CONNECTION_HANDOVER 

Connection handover message type.

NET_NFC_MESSAGE_SET_SE 

Set secure element message type.

NET_NFC_MESSAGE_GET_SE 

Get secure element message type.

NET_NFC_MESSAGE_OPEN_INTERNAL_SE 

Open internal secure element message type.

NET_NFC_MESSAGE_CLOSE_INTERNAL_SE 

Close internal secure element message type.

NET_NFC_MESSAGE_SEND_APDU_SE 

Send APDU to secure element message type.

NET_NFC_MESSAGE_GET_ATR_SE 

Get ATR from secure element message type.

NET_NFC_GET_SERVER_STATE 

Get server state message type.

NET_NFC_MESSAGE_INIT 

Initialize NFC message type.

NET_NFC_MESSAGE_DEINIT 

Deinitialize NFC message type.

NET_NFC_MESSAGE_GET_FIRMWARE_VERSION 

Get firmware version message type.

NET_NFC_MESSAGE_SNEP_START_SERVER 

Start SNEP server message type.

NET_NFC_MESSAGE_SNEP_START_CLIENT 

Start SNEP client message type.

NET_NFC_MESSAGE_SNEP_REQUEST 

SNEP request message type.

NET_NFC_MESSAGE_SNEP_STOP_SERVICE 

Stop SNEP service message type.

NET_NFC_MESSAGE_SNEP_REGISTER_SERVER 

Register SNEP server message type.

NET_NFC_MESSAGE_SNEP_UNREGISTER_SERVER 

Unregister SNEP server message type.

NET_NFC_MESSAGE_CONNECT 

Connect message type.

NET_NFC_MESSAGE_DISCONNECT 

Disconnect message type.

NET_NFC_MESSAGE_SET_CARD_EMULATION 

Set card emulation message type.

NET_NFC_MESSAGE_ROUTING_HOST_EMU_ACTIVATED 

Routing host emulation activated message type.

NET_NFC_MESSAGE_ROUTING_HOST_EMU_DEACTIVATED 

Routing host emulation deactivated message type.

NET_NFC_MESSAGE_ROUTING_HOST_EMU_DATA 

Routing host emulation data message type.

Enumeration for different states of NFC NDEF cards.

This enumeration defines different states of NFC NDEF cards that can be encountered.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_NDEF_CARD_INVALID 

The card is not NFC forum specified tag. The ndef format will be needed.

NET_NFC_NDEF_CARD_INITIALISED 

The card is NFC forum specified tag, but It has no actual data. So, the ndef write will be needed.

NET_NFC_NDEF_CARD_READ_WRITE 

The card is NFC forum specified tag. The ndef read and write will be allowed.

NET_NFC_NDEF_CARD_READ_ONLY 

The card is NFC forum specified tag, but only the ndef read will be allowed.

Enumeration for different types of NFC records.

This enumeration defines different types of NFC records that can be encountered.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_RECORD_EMPTY 

Empty record type.

NET_NFC_RECORD_WELL_KNOWN_TYPE 

Well-known type record.

NET_NFC_RECORD_MIME_TYPE 

Media type record (e.g., image/jpeg).

NET_NFC_RECORD_URI 

URI record (e.g., http://example.com).

NET_NFC_RECORD_EXTERNAL_RTD 

External RTD record.

NET_NFC_RECORD_UNKNOWN 

Unknown record type.

NET_NFC_RECORD_UNCHANGED 

Unchanged record type.

Enumeration for different types of URI schemes.

This enumeration defines different types of URI schemes that can be used in NFC communication.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_SCHEMA_FULL_URI 

Protocol is specified by payload.

NET_NFC_SCHEMA_HTTP_WWW 

http://www.

NET_NFC_SCHEMA_HTTPS_WWW 

https://www.

NET_NFC_SCHEMA_HTTP 

http://

NET_NFC_SCHEMA_HTTPS 

https://

NET_NFC_SCHEMA_TEL 

tel:

NET_NFC_SCHEMA_MAILTO 

mailto:

NET_NFC_SCHEMA_FTP_ANONYMOUS 

ftp://anonymous:anonymous@

NET_NFC_SCHEMA_FTP_FTP 

ftp://ftp.

NET_NFC_SCHEMA_FTPS 

ftps://

NET_NFC_SCHEMA_SFTP 

sftp://

NET_NFC_SCHEMA_SMB 

smb://

NET_NFC_SCHEMA_NFS 

nfs://

NET_NFC_SCHEMA_FTP 

ftp://

NET_NFC_SCHEMA_DAV 

dav://

NET_NFC_SCHEMA_NEWS 

news://

NET_NFC_SCHEMA_TELNET 

telnet://

NET_NFC_SCHEMA_IMAP 

imap:

NET_NFC_SCHEMA_RTSP 

rtsp://

NET_NFC_SCHEMA_URN 

urn:

NET_NFC_SCHEMA_POP 

pop:

NET_NFC_SCHEMA_SIP 

sip:

NET_NFC_SCHEMA_SIPS 

sips:

NET_NFC_SCHEMA_TFTP 

tftp:

NET_NFC_SCHEMA_BTSPP 

btspp://

NET_NFC_SCHEMA_BTL2CAP 

btl2cap://

NET_NFC_SCHEMA_BTGOEP 

btgoep://

NET_NFC_SCHEMA_TCPOBEX 

tcpobex://

NET_NFC_SCHEMA_IRDAOBEX 

irdaobex://

NET_NFC_SCHEMA_FILE 

file://

NET_NFC_SCHEMA_URN_EPC_ID 

urn:epc:id:

NET_NFC_SCHEMA_URN_EPC_TAG 

urn:epc:tag:

NET_NFC_SCHEMA_URN_EPC_PAT 

urn:epc:pat:

NET_NFC_SCHEMA_URN_EPC_RAW 

urn:epc:raw:

NET_NFC_SCHEMA_URN_EPC 

urn:epc:

NET_NFC_SCHEMA_URN_NFC 

urn:epc:nfc:

Enumeration for different types of screen state types.

This enumeration defines different types of screen state types that can be used in NFC communication.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_SCREEN_INVALID 

Indicates screen state is invalid.

NET_NFC_SCREEN_OFF 

Screen is off.

NET_NFC_SCREEN_ON_LOCK 

Screen is on but locked.

NET_NFC_SCREEN_ON_UNLOCK 

Screen is on and unlocked.

Enumeration for different types of SE entry types.

This enumeration defines different types of SE entry types that can be used in NFC communication.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_SE_INVALID_ENTRY 

Indicates SE entry type is invalid.

NET_NFC_SE_TECH_ENTRY 

Technology entry type.

NET_NFC_SE_PROTOCOL_ENTRY 

Protocol entry type.

NET_NFC_SE_AID_ENTRY 

Application Identifier (AID) entry type.

Enumeration for different types of SE technology and protocol types.

This enumeration defines different types of SE technology and protocol types that can be used in NFC communication.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_SE_INVALID_TECH_PROTO 

Indicates SE technology and protocol type is invalid.

NET_NFC_SE_TECH_A_ISODEP 

Type A / ISO-DEP.

NET_NFC_SE_TECH_B_NFCDEP 

Type B / NFC-DEP.

NET_NFC_SE_TECH_A_B_ISO_NFC_DEP 

Type A/B / ISO-DEP/NFC-DEP.

NET_NFC_SE_TECH_F 

Type F.

Enumeration for different types of Secure Element (SE) types.

This enumeration defines different types of Secure Element (SE) types that can be used in NFC communication.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_SE_TYPE_NONE 

Invalid SE type.

NET_NFC_SE_TYPE_ESE 

Embedded Secure Element (eSE).

NET_NFC_SE_TYPE_UICC 

Universal Integrated Circuit Card (UICC).

NET_NFC_SE_TYPE_SDCARD 

SDCard.

NET_NFC_SE_TYPE_HCE 

Host Card Emulation (HCE).

Enumeration for different types of socket types in LLCP.

This enumeration defines different types of socket types that can be used in LLCP communication.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_LLCP_SOCKET_TYPE_CONNECTIONORIENTED 

Connection-oriented socket type.

NET_NFC_LLCP_SOCKET_TYPE_CONNECTIONLESS 

Connectionless socket type.

Enumeration for different types of NFC target types.

This enumeration defines different types of NFC targets that can be detected.

Since:
HAL_MODULE_NFC 1.0
Enumerator:
NET_NFC_UNKNOWN_TARGET 

Unknown target type.

NET_NFC_GENERIC_PICC 

Generic PICC (Proximity Coupling Device) target type.

NET_NFC_ISO14443_A_PICC 

ISO/IEC 14443 Type A PICC target type.

NET_NFC_ISO14443_4A_PICC 

ISO/IEC 14443 Part 4 Type A PICC target type.

NET_NFC_ISO14443_3A_PICC 

ISO/IEC 14443 Part 3 Type A PICC target type.

NET_NFC_MIFARE_MINI_PICC 

Mifare Mini PICC target type.

NET_NFC_MIFARE_1K_PICC 

Mifare 1k PICC target type.

NET_NFC_MIFARE_4K_PICC 

Mifare 4k PICC target type.

NET_NFC_MIFARE_ULTRA_PICC 

Mifare Ultra PICC target type.

NET_NFC_MIFARE_DESFIRE_PICC 

Mifare Desfire PICC target type.

NET_NFC_ISO14443_B_PICC 

ISO/IEC 14443 Type B PICC target type.

NET_NFC_ISO14443_4B_PICC 

ISO/IEC 14443 Part 4 Type B PICC target type.

NET_NFC_ISO14443_BPRIME_PICC 

ISO/IEC 14443 Prime Type B PICC target type.

NET_NFC_FELICA_PICC 

Felica PICC target type.

NET_NFC_JEWEL_PICC 

Jewel PICC target type.

NET_NFC_ISO15693_PICC 

ISO/IEC 15693 PICC target type.

NET_NFC_BARCODE_128_PICC 

Barcode 128 PICC target type.

NET_NFC_BARCODE_256_PICC 

Barcode 256 PICC target type.

NET_NFC_NFCIP1_TARGET 

NFC-IP1 target type.

NET_NFC_NFCIP1_INITIATOR 

NFC-IP1 initiator type.