NFC_ERROR_INVALID_NDEF_MESSAGE = NFC_ERROR_CLASS | 0x02, /**< Invalid NDEF message */
NFC_ERROR_INVALID_RECORD_TYPE = NFC_ERROR_CLASS | 0x03, /**< Invalid record type*/
NFC_ERROR_TIMED_OUT = TIZEN_ERROR_TIMED_OUT, /**< Timeout error, no answer */
- NFC_ERROR_DEVICE_BUSY = TIZEN_ERROR_RESOURCE_BUSY, /**< Previous opertion is not finished still busy */
+ NFC_ERROR_DEVICE_BUSY = TIZEN_ERROR_RESOURCE_BUSY, /**< Previous operation is not finished still busy */
NFC_ERROR_NO_DEVICE = NFC_ERROR_CLASS | 0x04, /**< no device */
NFC_ERROR_NOT_ACTIVATED = NFC_ERROR_CLASS | 0x05, /**< NFC is not activated */
NFC_ERROR_NOT_SUPPORTED = NFC_ERROR_CLASS | 0x06, /**< Not supported */
NFC_SE_TYPE_UICC = 0x02 /**< UICC type card emulation */
} nfc_se_type_e;
-
-
/**
- * @brief Enumerations for NFC AC(Alternative Carrior)
+ * @brief Enumerations for NFC AC(Alternative Carrier)
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*/
typedef enum {
NFC_AC_TYPE_BT = 0x00, /**< Bluetooth AC*/
NFC_AC_TYPE_WIFI, /**<Wifi AC*/
NFC_AC_TYPE_WIFI_DIRECT,/**<Wifi-direct AC*/
- NFC_AC_TYPE_UNKNOWN, /* No selected preferd AC */
+ NFC_AC_TYPE_UNKNOWN, /* No selected preferred AC */
} nfc_ac_type_e ;
/**
* @brief The handle to NFC p2p target
- * @ingroup CAPI_NETWORK_NFC_TAG_MODULE
+ * @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*/
typedef void *nfc_p2p_target_h;
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
* @param [in] activated The activation state
- * @param [in] user_data The user data passed from the callback registeration function
+ * @param [in] user_data The user data passed from the callback registration function
*
* @see nfc_manager_set_activation_changed_cb()
*/
* @param[in] value_size The data size in bytes
* @param[in] user_data The user data passed from the foreach function
*
- * @return @c true to continue with the next iteration of the loop, \n @c false to break outsp of the loop.
+ * @return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop.
* @pre nfc_tag_foreach_informations() invokes this callback.
*
* @see nfc_tag_foreach_informations()
/**
* @brief Called after nfc_mifare_authenticate_with_keyA() has completed
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
+ *
* @param [in] result The result of nfc_mifare_authenticate_with_keyA()
* @param [in] user_data The user data passed from nfc_mifare_authenticate_with_keyA()
+ *
* @see nfc_mifare_authenticate_with_keyA()
*/
typedef void (* nfc_mifare_authenticate_with_keyA_completed_cb)(nfc_error_e result, void *user_data);
/**
* @brief Called after nfc_mifare_authenticate_with_keyB() has completed
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
+ *
* @param [in] result The result of function call
* @param [in] user_data The user data passed from nfc_mifare_authenticate_with_keyB()
+ *
* @see nfc_mifare_authenticate_with_keyB()
*/
typedef void (* nfc_mifare_authenticate_with_keyB_completed_cb)(nfc_error_e result, void *user_data);
/**
* @brief Called after nfc_mifare_write_block() has completed
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
+ *
* @param [in] result The result of nfc_mifare_write_block()
* @param [in] user_data The user data passed from nfc_mifare_write_block()
+ *
* @see nfc_mifare_write_block()
*/
typedef void (* nfc_mifare_write_block_completed_cb)(nfc_error_e result, void *user_data);
/**
* @brief Called after nfc_mifare_write_page() has completed
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
+ *
* @param [in] result The result of function call
* @param [in] user_data The user data passed from nfc_mifare_write_page()
+ *
* @see nfc_mifare_write_page()
*/
typedef void (* nfc_mifare_write_page_completed_cb)(nfc_error_e result, void *user_data);
* @remarks @a buffer will be automatically destroyed when the callback function returns. (Do not release @a buffer.)
*
* @param [in] result The result of function call
- * @param [in] buffer Thre read buffer
+ * @param [in] buffer The read buffer
* @param [in] size The size of buffer in bytes
* @param [in] user_data The user data passed from nfc_mifare_read_block()
+ *
* @see nfc_mifare_read_block()
*/
typedef void (* nfc_mifare_read_block_completed_cb)(nfc_error_e result, unsigned char *buffer, int bufer_size, void *user_data);
* @param [in] buffer The read buffer
* @param [in] size The size of read buffer in bytes
* @param [in] user_data The user data passed from nfc_mifare_read_page()
+ *
* @see nfc_mifare_read_page()
*/
typedef void (* nfc_mifare_read_page_completed_cb)(nfc_error_e result, unsigned char *buffer, int bufer_size, void *user_data);
/**
* @brief Called after nfc_mifare_increment() has completed
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
+ *
* @param [in] result The result of nfc_mifare_increment()
* @param [in] user_data The user data passed from nfc_mifare_increment()
+ *
* @see nfc_mifare_increment()
*/
typedef void (* nfc_mifare_increment_completed_cb)(nfc_error_e result, void *user_data);
/**
* @brief Called after nfc_mifare_decrement() has completed
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
+ *
* @param [in] result The result of nfc_mifare_decrement()
* @param [in] user_data The user data passed from nfc_mifare_decrement()
+ *
* @see nfc_mifare_decrement()
*/
typedef void (* nfc_mifare_decrement_completed_cb)(nfc_error_e result, void *user_data);
/**
* @brief Called after nfc_mifare_transfer() has completed
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
+ *
* @param [in] result The result of nfc_mifare_transfer()
* @param [in] user_data The user data passed from nfc_mifare_transfer()
+ *
* @see nfc_mifare_transfer()
*/
typedef void (* nfc_mifare_transfer_completed_cb)(nfc_error_e result, void *user_data);
/**
* @brief Called after nfc_mifare_restore() has completed
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
+ *
* @param [in] result The result of nfc_mifare_restore()
* @param [in] user_data The user data passed from nfc_mifare_restore()
+ *
* @see nfc_mifare_restore()
*/
typedef void (* nfc_mifare_restore_completed_cb)(nfc_error_e result, void *user_data);
/**
* @brief Called when NFC peer-to-peer target appeared or disappeared
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
+ *
* @param [in] type The discovered type attached or detached
* @param [in] target The handle to p2p target
* @param [in] user_data The user data passed from nfc_manager_set_p2p_target_discovered_cb()
/**
* @brief Called when receiving Secure Element (SIM/UICC(Universal Integrated Circuit Card)) event.
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
+ *
* @param [in] event The Secure Element event
* @param [in] user_data The user data passed from nfc_manager_set_se_event_cb()
*
* @brief Called when receiving Secure Element(SIM/UICC(Universal Integrated Circuit Card)) transaction event data
* @remarks This event notifies , external reader trys to access secure element.
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
+ *
* @param [in] aid Application Id, specified in ISO/IEC 7816-4
* @param [in] aid_size The size of aid (5~16)
* @param [in] param The parameter list, specified in ISO/IEC 8825-1
/**
* @brief Called after nfc_p2p_send() has completed.
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
+ *
* @param [in] result The result of function call
* @param [in] user_data The user data passed from nfc_p2p_send()
*
* @remarks @a message will be automatically destroyed when the callback function returns. (Do not release @a message.)
*
* @param [in] target The handle to p2p target
- * @param [in] message The recevied message
+ * @param [in] message The received message
* @param [in] user_data The user data passed from nfc_p2p_set_recv_cb()
*
* @see nfc_p2p_set_data_received_cb()
*
* @remark To use the @a ac_data outside this function, copy the @a ac_data.
* @remark @a ac_data could be NULL, if nfc_p2p_connection_handover failed.
- * @remark If @a carrior is #NFC_AC_TYPE_BT, @ac_data should be converted to 'char *' type. This is bluetooth address information.
+ * @remark If @a carrier is #NFC_AC_TYPE_BT, @ac_data should be converted to 'char *' type. This is bluetooth address information.
*
* @param [in] result The result of function call
- * @param [in] carrior The type of Alternative Carrior
- * @param [in] ac_data The connected remote device AC(Alternative Carrior) information data
- * @param [in] ac_data_size The connected remote device AC(Alternative Carrior) information data size
+ * @param [in] carrier The type of Alternative Carrier
+ * @param [in] ac_data The connected remote device AC(Alternative Carrier) information data
+ * @param [in] ac_data_size The connected remote device AC(Alternative Carrier) information data size
* @param [in] user_data The user data passed from nfc_p2p_connection_handover()
*
* @see nfc_p2p_connection_handover()
* @remarks This function can executed Regardless of nfc_manager_initialize state.
*
* @return true on NFC supported, otherwise false
+ *
* @see nfc_manager_set_activation()
*/
bool nfc_manager_is_supported(void);
* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @retval #NFC_ERROR_ALREADY_ACTIVATED Already activated
* @retval #NFC_ERROR_ALREADY_DEACTIVATED Already deactivated
+ *
* @see nfc_manager_is_activated()
* @see nfc_activation_completed_cb()
*/
* @remarks This function can executed Regardless of nfc_manager_initialize state.
*
* @return true on NFC activated, otherwise false
+ *
* @see nfc_manager_set_activation()
*/
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_OPERATION_FAILED Operation fail
+ *
* @see nfc_manager_initialize_sync()
* @see nfc_manager_deinitialize()
*/
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_OPERATION_FAILED Operation fail
+ *
* @see nfc_manager_initialize()
* @see nfc_manager_deinitialize()
*/
/**
- * @brief Releases all the resource of the NFC Manager and disconnecst the session between an application and NFC Manager.
+ * @brief Releases all the resource of the NFC Manager and disconnect the session between an application and NFC Manager.
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_OPERATION_FAILED Operation fail
+ *
* @see nfc_manager_initialize()
*/
int nfc_manager_deinitialize(void);
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
+ *
* @see nfc_manager_unset_tag_discovered_cb()
* @see nfc_tag_discovered_cb()
*/
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
+ *
* @see nfc_manager_unset_ndef_discovered_cb()
* @see nfc_ndef_discovered_cb()
*/
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_INVALID_NDEF_MESSAGE The cached message does not exist
- *
*/
int nfc_manager_get_cached_message(nfc_ndef_message_h *ndef_message);
/**
* @brief Sets filter of target types.
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
- * @remarks Bit operator OR(|) can be used in the config parameter (like NFC_TAG_FILTER_ISO14443A_ENABLE | NFC_TAG_FILTER_ISO14443B_ENABLE)
+ * @remarks Bit operator OR(|) can be used in the configure parameter (like NFC_TAG_FILTER_ISO14443A_ENABLE | NFC_TAG_FILTER_ISO14443B_ENABLE)
* or you may choose "NFC_TAG_ALL_ENABLE" enum value to get all result.
* It prevent getting tag types from RF level.
* If the client api does call this function, default is always NFC_TAG_ALL_ENABLE.
*
* @remarks Bit operation OR(|) is used in return data\n
* The default value is NFC_TAG_FILTER_ALL_ENABLE
+ *
* @return The filter which is set #nfc_tag_filter_e
+ *
* @see nfc_manager_set_tag_filter()
*/
int nfc_manager_get_tag_filter(void);
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_NO_DEVICE There is no connected tag
- *
*/
int nfc_manager_get_connected_tag(nfc_tag_h *tag);
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_NO_DEVICE There is no connected target
- *
*/
int nfc_manager_get_connected_target(nfc_p2p_target_h *target);
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_OUT_OF_MEMORY Out of memory
+ *
* @see nfc_ndef_record_create_text()
* @see nfc_ndef_record_create_uri()
* @see nfc_ndef_record_create_mime()
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_OUT_OF_MEMORY Out of memory
+ *
* @see nfc_ndef_record_create()
* @see nfc_ndef_record_create_uri()
* @see nfc_ndef_record_create_mime()
* The record is created in this format\n
* - TNF : NFC_RECORD_TNF_WELL_KNOWN\n
* - type : "U"\n
- * - payload : procotol scheme + uri\n
+ * - payload : protocol scheme + uri\n
* Defined in Record Type Definition Technical Specifications.
*
* @param [out] record A handle to record
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_OUT_OF_MEMORY Out of memory
+ *
* @see nfc_ndef_record_create()
* @see nfc_ndef_record_create_text()
* @see nfc_ndef_record_create_mime()
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_OUT_OF_MEMORY Out of memory
+ *
* @see nfc_ndef_record_create()
* @see nfc_ndef_record_create_uri()
* @see nfc_ndef_record_create_text()
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
+ *
* @see nfc_ndef_record_create()
* @see nfc_ndef_record_create_text()
* @see nfc_ndef_record_create_uri()
* @param [in] record The handle to record
* @param [in] id The record ID
* @param [in] id_size The size of ID in bytes
+ *
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
+ *
* @see nfc_ndef_record_get_id()
*/
int nfc_ndef_record_set_id(nfc_ndef_record_h record, unsigned char *id, int id_size);
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
+ *
* @see nfc_ndef_record_set_id()
*/
int nfc_ndef_record_get_id(nfc_ndef_record_h record, unsigned char **id, int *size);
* @brief Gets record payload.
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*
- * @remarks This function gives you the pointer of pyaload that is contained by record\n
+ * @remarks This function gives you the pointer of payload that is contained by record\n
* Do not free the payload. it will be freed when @a record is destroyed by nfc_ndef_record_destroy().
*
* @param [in] record The handle to record
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_INVALID_RECORD_TYPE Invalid record type
+ *
* @see nfc_ndef_record_create_text()
*/
int nfc_ndef_record_get_text(nfc_ndef_record_h record, char **text);
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_INVALID_RECORD_TYPE Invalid record type
+ *
* @see nfc_ndef_record_create_text()
*/
int nfc_ndef_record_get_langcode(nfc_ndef_record_h record, char **lang_code);
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_INVALID_RECORD_TYPE Invalid record type
+ *
* @see nfc_ndef_record_create_text()
*/
int nfc_ndef_record_get_encode_type(nfc_ndef_record_h record, nfc_encode_type_e *encode);
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_INVALID_RECORD_TYPE Invalid record type
+ *
* @see nfc_ndef_record_create_uri()
*/
int nfc_ndef_record_get_uri(nfc_ndef_record_h record, char **uri);
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_INVALID_RECORD_TYPE Invalid record type
+ *
* @see nfc_ndef_record_create_mime()
*/
int nfc_ndef_record_get_mime_type(nfc_ndef_record_h record, char **mime_type);
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_OUT_OF_MEMORY Out of memory
+ *
* @see nfc_ndef_message_create_from_rawdata()
* @see nfc_ndef_message_destroy()
- *
*/
int nfc_ndef_message_create(nfc_ndef_message_h *ndef_message);
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_OUT_OF_MEMORY Out of memory
+ *
* @see nfc_ndef_message_create()
* @see nfc_ndef_message_destroy()
* @see nfc_ndef_message_get_rawdata()
- *
*/
int nfc_ndef_message_create_from_rawdata(nfc_ndef_message_h *ndef_message, const unsigned char *rawdata, int rawdata_size);
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
+ *
* @see nfc_ndef_message_create()
* @see nfc_ndef_message_create_from_rawdata()
*/
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
- *
*/
int nfc_ndef_message_get_record_count(nfc_ndef_message_h ndef_message, int *count);
* @brief Gets serial bytes array of NDEF message.
* @ingroup CAPI_NETWORK_NFC_NDEF_MESSAGE_MODULE
*
- * @remarks It gets copy of the rawdata bytes from NDEF message. @a rawdata must be released with free() by you.
+ * @remarks It gets copy of the bytes array from NDEF message. @a rawdata must be released with free() by you.
*
* @param [in] ndef_message The handle to NDEF message
- * @param [out] rawdata The bytes array of rawdata
- * @param [out] rawdata_size The size of rawdata in byte
+ * @param [out] rawdata The bytes array of bytes array
+ * @param [out] rawdata_size The size of bytes array in byte
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
+ *
* @see nfc_ndef_message_insert_record()
* @see nfc_ndef_message_remove_record()
*/
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_INVALID_NDEF_MESSAGE Invalid NDEF message
+ *
* @see nfc_ndef_message_append_record()
* @see nfc_ndef_message_remove_record()
*/
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_INVALID_NDEF_MESSAGE Invalid NDEF message
+ *
* @see nfc_ndef_message_append_record()
* @see nfc_ndef_message_insert_record()
*/
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
- *
*/
int nfc_ndef_message_get_record(nfc_ndef_message_h ndef_message, int index, nfc_ndef_record_h *record);
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
- *
*/
int nfc_tag_get_type(nfc_tag_h tag, nfc_tag_type_e *type);
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
- *
*/
int nfc_tag_get_maximum_ndef_size(nfc_tag_h tag, unsigned int *maximum_ndef_bytes_size);
* @brief Transceives the data of the raw format card.
* @details This function is the only way to access the raw format card (not formated),
each tag type requires own command to access tags. \n
- This function provides the low level access of tag operation and you require the knowlege of each tag technology.
+ This function provides the low level access of tag operation and you require the knowledge of each tag technology.
* @ingroup CAPI_NETWORK_NFC_TAG_MODULE
*
* @param [in] tag The handle to NFC tag
* @param [in] buffer The binary data for parameter or additional commands
* @param [in] buffer_size The size of buffer in bytes
* @param [in] callback The callback function to invoke after this function has completed\n It can be null if a notification is not required
-* @param [in] user_data The user data to be passed to the callback funcation
+* @param [in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
*
* @param [in] tag The handle to NFC tag
* @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback funcation
+ * @param [in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @param [in] tag The handle to NFC tag
* @param [in] msg The message will be write to the tag
* @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_dataa The user data to be passed to the callback funcation
+ * @param [in] user_dataa The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @param [in] key The key value that may need to format the tag
* @param [in] key_size The size of key in byte
* @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback funcation
+ * @param [in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @param[in] sector_index The index of sector to authenticate with key A, starting from 0
* @param[in] auth_key 6-byte authentication key
* @param[in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param[in] user_data The user data to be passed to the callback funcation
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @param [in] sector_index The index of sector to authenticate with key B, starting from 0
* @param [in] auth_key 6-byte authentication key
* @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback funcation
+ * @param [in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @param [in] tag The handle to NFC tag
* @param [in] block_index The block or starting page number
* @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback funcation
+ * @param [in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @param [in] tag The handle to NFC tag
* @param [in] page_index The index of page to read, starting from 0
* @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback funcation
+ * @param [in] user_data The user data to be passed to the callback function
*
*
* @return 0 on success, otherwise a negative error value.
* @param [in] buffer 16 bytes of data to write
* @param [in] buffer_size The size of buffer in bytes
* @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback funcation
+ * @param [in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
*
- * @post It invokes nfc_mifare_write_block_completed_cb() when it hase completed to write a block.
+ * @post It invokes nfc_mifare_write_block_completed_cb() when it has completed to write a block.
*
* @see nfc_mifare_write_page()
* @see nfc_mifare_read_block()
* @param [in] buffer 4 bytes of data to write
* @param [in] buffer_size The size of buffer in bytes
* @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback funcation
+ * @param [in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @param [in] block_index The index of block to decrease, starting from 0
* @param [in] value non-negative to decrement by
* @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback funcation
+ * @param [in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
/**
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
- * @brief Copys from the temporary block to the specified block.
+ * @brief Copy from the temporary block to the specified block.
* @remarks This function is only available for MIFARE classic
*
* @param [in] tag The handle to NFC tag
* @param [in] block_index The index of block to copy to, starting from 0
* @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback funcation
+ * @param [in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
/**
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
- * @brief Copys from a value block to the temporary block.
+ * @brief Copy from a value block to the temporary block.
* @remarks This function is only available for MIFARE classic
*
* @param [in] tag The handle to NFC tag
* @param [in] block_index The index of block to copy from, starting from 0
* @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback funcation
+ * @param [in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @param [in] tag The handle to NFC tag
* @param [in] message The message to send
* @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback funcation
+ * @param [in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
*
* @see nfc_p2p_send_completed_cb()
- * @see @see nfc_p2p_target_discovered_cb()
+ * @see nfc_p2p_target_discovered_cb()
*/
int nfc_p2p_send(nfc_p2p_target_h target, nfc_ndef_message_h message, nfc_p2p_send_completed_cb callback, void *user_data);
* @param [in] tag The handle to NFC tag
* @param [in] message The message to send
* @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback funcation
+ * @param [in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
*
* @see nfc_p2p_send_completed_cb()
- * @see @see nfc_p2p_target_discovered_cb()
+ * @see nfc_p2p_target_discovered_cb()
*/
int nfc_p2p_send_no_permission(nfc_p2p_target_h target, nfc_ndef_message_h message, nfc_p2p_send_completed_cb callback, void *user_data);
/**
- * @brief NFC Connetionhandover between NFC peer-to-peer target
+ * @brief NFC Connection handover between NFC peer-to-peer target
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*
* @param [in] target The handle to NFC device
- * @param [in] type Prepered Alternative Carrior
+ * @param [in] type Preferred Alternative Carrier
* @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
* @param [in] user_data The user data to be passed to the callback function
*
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
*
* @see nfc_p2p_connection_handover_completed_cb()
- * @see @see nfc_p2p_connection_handover_completed_cb()
-
*/
int nfc_p2p_connection_handover(nfc_p2p_target_h target , nfc_ac_type_e type, nfc_p2p_connection_handover_completed_cb callback, void *user_data);
-
-
/**
- * @brief Check available Alternative Carrior(AC) for NFC handover between NFC peer-to-peer target
+ * @brief Check available Alternative Carrier(AC) for NFC handover between NFC peer-to-peer target
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*
- * @param [in] carrior Alternative Carrior whan to be checked whether supported or not
+ * @param [in] carrier Alternative Carrier when to be checked whether supported or not
*
* @retval #true Supported
* @retval #false Not Supported
*
* @see nfc_p2p_is_supported_ac_type()
- *
*/
bool nfc_p2p_is_supported_ac_type( nfc_ac_type_e carrior);
projects / platform / core / api / nfc.git / commitdiff