1 /****************************************************************************** 2 * 3 * Copyright (C) 2009-2014 Broadcom Corporation 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); 6 * you may not use this file except in compliance with the License. 7 * You may obtain a copy of the License at: 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 * 17 ******************************************************************************/ 18 19 20 /****************************************************************************** 21 * 22 * This file contains the Near Field Communication (NFC) Reader/Writer mode 23 * related internal function / definitions. 24 * 25 ******************************************************************************/ 26 27 #ifndef RW_INT_H_ 28 #define RW_INT_H_ 29 30 #include "tags_defs.h" 31 #include "tags_int.h" 32 #include "rw_api.h" 33 34 /* Proprietary definitions for HR0 and HR1 */ 35 #define RW_T1T_HR0_HI_NIB 0xF0 /* HI NIB Tag */ 36 #define RW_T1T_IS_JEWEL64 0x20 /* Jewel 64 Tag */ 37 #define RW_T1T_IS_JEWEL 0x00 /* Jewel Tag */ 38 #define RW_T1T_IS_TOPAZ 0x10 /* TOPAZ Tag */ 39 #define RW_T1T_IS_TOPAZ96 0x11 /* TOPAZ96 Tag */ 40 #define RW_T1T_IS_TOPAZ512 0x12 /* TOPAZ512 Tag */ 41 #define RW_T1T_HR1_MIN 0x49 /* Supports dynamic commands on static tag if HR1 > 0x49 */ 42 43 #define RW_T1T_MAX_MEM_TLVS 0x05 /* Maximum supported Memory control TLVS in the tag */ 44 #define RW_T1T_MAX_LOCK_TLVS 0x05 /* Maximum supported Lock control TLVS in the tag */ 45 #define RW_T1T_MAX_LOCK_BYTES 0x1E /* Maximum supported dynamic lock bytes */ 46 47 /* State of the Tag as interpreted by RW */ 48 #define RW_T1_TAG_ATTRB_UNKNOWN 0x00 /* TAG State is unknown to RW */ 49 #define RW_T1_TAG_ATTRB_INITIALIZED 0x01 /* TAG is in INITIALIZED state */ 50 #define RW_T1_TAG_ATTRB_INITIALIZED_NDEF 0x02 /* TAG is in INITIALIZED state and has NDEF tlv with len=0 */ 51 #define RW_T1_TAG_ATTRB_READ_ONLY 0x03 /* TAG is in READ ONLY state */ 52 #define RW_T1_TAG_ATTRB_READ_WRITE 0x04 /* TAG is in READ WRITE state */ 53 54 #define RW_T1T_LOCK_NOT_UPDATED 0x00 /* Lock not yet set as part of SET TAG RO op */ 55 #define RW_T1T_LOCK_UPDATE_INITIATED 0x01 /* Sent command to set the Lock bytes */ 56 #define RW_T1T_LOCK_UPDATED 0x02 /* Lock bytes are set */ 57 typedef UINT8 tRW_T1T_LOCK_STATUS; 58 59 /* States */ 60 #define RW_T1T_STATE_NOT_ACTIVATED 0x00 /* Tag not activated and or response not received for RID */ 61 #define RW_T1T_STATE_IDLE 0x01 /* T1 Tag activated and ready to perform rw operation on Tag*/ 62 #define RW_T1T_STATE_READ 0x02 /* waiting rsp for read command sent to tag */ 63 #define RW_T1T_STATE_WRITE 0x03 /* waiting rsp for write command sent to tag */ 64 #define RW_T1T_STATE_TLV_DETECT 0x04 /* performing TLV detection procedure */ 65 #define RW_T1T_STATE_READ_NDEF 0x05 /* performing read NDEF procedure */ 66 #define RW_T1T_STATE_WRITE_NDEF 0x06 /* performing update NDEF procedure */ 67 #define RW_T1T_STATE_SET_TAG_RO 0x07 /* Setting Tag as read only tag */ 68 #define RW_T1T_STATE_CHECK_PRESENCE 0x08 /* Check if Tag is still present */ 69 #define RW_T1T_STATE_FORMAT_TAG 0x09 /* Format T1 Tag */ 70 71 /* Sub states */ 72 #define RW_T1T_SUBSTATE_NONE 0x00 /* Default substate */ 73 74 /* Sub states in RW_T1T_STATE_TLV_DETECT state */ 75 #define RW_T1T_SUBSTATE_WAIT_TLV_DETECT 0x01 /* waiting for the detection of a tlv in a tag */ 76 #define RW_T1T_SUBSTATE_WAIT_FIND_LEN_FIELD_LEN 0x02 /* waiting for finding the len field is 1 or 3 bytes long */ 77 #define RW_T1T_SUBSTATE_WAIT_READ_TLV_LEN0 0x03 /* waiting for extracting len field value */ 78 #define RW_T1T_SUBSTATE_WAIT_READ_TLV_LEN1 0x04 /* waiting for extracting len field value */ 79 #define RW_T1T_SUBSTATE_WAIT_READ_TLV_VALUE 0x05 /* waiting for extracting value field in the TLV */ 80 #define RW_T1T_SUBSTATE_WAIT_READ_LOCKS 0x06 /* waiting for reading dynamic locks in the TLV */ 81 82 /* Sub states in RW_T1T_STATE_WRITE_NDEF state */ 83 #define RW_T1T_SUBSTATE_WAIT_READ_NDEF_BLOCK 0x07 /* waiting for response of reading a block that will be partially updated */ 84 #define RW_T1T_SUBSTATE_WAIT_INVALIDATE_NDEF 0x08 /* waiting for response of invalidating NDEF Msg */ 85 #define RW_T1T_SUBSTATE_WAIT_NDEF_WRITE 0x09 /* waiting for response of writing a part of NDEF Msg */ 86 #define RW_T1T_SUBSTATE_WAIT_NDEF_UPDATED 0x0A /* waiting for response of writing last part of NDEF Msg */ 87 #define RW_T1T_SUBSTATE_WAIT_VALIDATE_NDEF 0x0B /* waiting for response of validating NDEF Msg */ 88 89 /* Sub states in RW_T1T_STATE_SET_TAG_RO state */ 90 #define RW_T1T_SUBSTATE_WAIT_SET_CC_RWA_RO 0x0C /* waiting for response of setting CC-RWA to read only */ 91 #define RW_T1T_SUBSTATE_WAIT_SET_ST_LOCK_BITS 0x0D /* waiting for response of setting all static lock bits */ 92 #define RW_T1T_SUBSTATE_WAIT_SET_DYN_LOCK_BITS 0x0E /* waiting for response of setting all dynamic lock bits */ 93 94 /* Sub states in RW_T1T_STATE_FORMAT_TAG state */ 95 #define RW_T1T_SUBSTATE_WAIT_SET_CC 0x0F /* waiting for response to format/set capability container */ 96 #define RW_T1T_SUBSTATE_WAIT_SET_NULL_NDEF 0x10 /* waiting for response to format/set NULL NDEF */ 97 98 99 typedef struct 100 { 101 UINT16 offset; /* Offset of the lock byte in the Tag */ 102 UINT8 num_bits; /* Number of lock bits in the lock byte */ 103 UINT8 bytes_locked_per_bit; /* No. of tag bytes gets locked by a bit in this byte */ 104 } tRW_T1T_LOCK_INFO; 105 106 typedef struct 107 { 108 UINT16 offset; /* Reserved bytes offset taken from Memory control TLV */ 109 UINT8 num_bytes; /* Number of reserved bytes as per the TLV */ 110 }tRW_T1T_RES_INFO; 111 112 typedef struct 113 { 114 UINT8 tlv_index; /* Index of Lock control tlv that points to this address*/ 115 UINT8 byte_index; /* Index of Lock byte pointed by the TLV */ 116 UINT8 lock_byte; /* Value in the lock byte */ 117 tRW_T1T_LOCK_STATUS lock_status; /* Indicates if it is modifed to set tag as Read only */ 118 BOOLEAN b_lock_read; /* Is the lock byte is already read from tag */ 119 } tRW_T1T_LOCK; 120 121 typedef struct 122 { 123 UINT8 addr; /* ADD/ADD8/ADDS field value */ 124 UINT8 op_code; /* Command sent */ 125 UINT8 rsp_len; /* expected length of the response */ 126 UINT8 pend_retx_rsp; /* Number of pending rsps to retransmission on prev cmd */ 127 } tRW_T1T_PREV_CMD_RSP_INFO; 128 129 #if (defined (RW_NDEF_INCLUDED) && (RW_NDEF_INCLUDED == TRUE)) 130 #define T1T_BUFFER_SIZE T1T_STATIC_SIZE /* Buffer 0-E block, for easier tlv operation */ 131 #else 132 #define T1T_BUFFER_SIZE T1T_UID_LEN /* Buffer UID */ 133 #endif 134 135 /* RW Type 1 Tag control blocks */ 136 typedef struct 137 { 138 UINT8 hr[T1T_HR_LEN]; /* Header ROM byte 0 - 0x1y,Header ROM byte 1 - 0x00 */ 139 UINT8 mem[T1T_SEGMENT_SIZE]; /* Tag contents of block 0 or from block 0-E */ 140 tT1T_CMD_RSP_INFO *p_cmd_rsp_info; /* Pointer to Command rsp info of last sent command */ 141 UINT8 state; /* Current state of RW module */ 142 UINT8 tag_attribute; /* Present state of the Tag as interpreted by RW */ 143 BT_HDR *p_cur_cmd_buf; /* Buffer to hold cur sent command for retransmission */ 144 UINT8 addr; /* ADD/ADD8/ADDS value */ 145 tRW_T1T_PREV_CMD_RSP_INFO prev_cmd_rsp_info; /* Information about previous sent command if retx */ 146 TIMER_LIST_ENT timer; /* timer to set timelimit for the response to command */ 147 BOOLEAN b_update; /* Tag header updated */ 148 BOOLEAN b_rseg; /* Segment 0 read from tag */ 149 BOOLEAN b_hard_lock; /* Hard lock the tag as part of config tag to Read only */ 150 #if (defined (RW_NDEF_INCLUDED) && (RW_NDEF_INCLUDED == TRUE)) 151 UINT8 segment; /* Current Tag segment */ 152 UINT8 substate; /* Current substate of RW module */ 153 UINT16 work_offset; /* Working byte offset */ 154 UINT8 ndef_first_block[T1T_BLOCK_SIZE]; /* Buffer for ndef first block */ 155 UINT8 ndef_final_block[T1T_BLOCK_SIZE]; /* Buffer for ndef last block */ 156 UINT8 *p_ndef_buffer; /* Buffer to store ndef message */ 157 UINT16 new_ndef_msg_len; /* Lenght of new updating NDEF Message */ 158 UINT8 block_read; /* Last read Block */ 159 UINT8 write_byte; /* Index of last written byte */ 160 UINT8 tlv_detect; /* TLV type under detection */ 161 UINT16 ndef_msg_offset; /* The offset on Tag where first NDEF message is present*/ 162 UINT16 ndef_msg_len; /* Lenght of NDEF Message */ 163 UINT16 max_ndef_msg_len; /* Maximum size of NDEF that can be written on the tag */ 164 UINT16 ndef_header_offset; /* The offset on Tag where first NDEF tlv is present */ 165 UINT8 ndef_block_written; /* Last block where NDEF bytes are written */ 166 UINT8 num_ndef_finalblock; /* Block number where NDEF's last byte will be present */ 167 UINT8 num_lock_tlvs; /* Number of lcok tlvs detected in the tag */ 168 tRW_T1T_LOCK_INFO lock_tlv[RW_T1T_MAX_LOCK_TLVS]; /* Information retrieved from lock control tlv */ 169 UINT8 num_lockbytes; /* Number of dynamic lock bytes present in the tag */ 170 tRW_T1T_LOCK lockbyte[RW_T1T_MAX_LOCK_BYTES]; /* Dynamic Lock byte information */ 171 UINT8 num_mem_tlvs; /* Number of memory tlvs detected in the tag */ 172 tRW_T1T_RES_INFO mem_tlv[RW_T1T_MAX_MEM_TLVS]; /* Information retrieved from mem tlv */ 173 UINT8 attr_seg; /* Tag segment for which attributes are prepared */ 174 UINT8 lock_attr_seg; /* Tag segment for which lock attributes are prepared */ 175 UINT8 attr[T1T_BLOCKS_PER_SEGMENT]; /* byte information - Reserved/lock/otp or data */ 176 UINT8 lock_attr[T1T_BLOCKS_PER_SEGMENT]; /* byte information - read only or read write */ 177 #endif 178 } tRW_T1T_CB; 179 180 /* Mifare Ultalight/ Ultralight Family blank tag version block settings */ 181 #define T2T_MIFARE_VERSION_BLOCK 0x04 /* Block where version number of the tag is stored */ 182 #define T2T_MIFARE_ULTRALIGHT_VER_NO 0xFFFF /* Blank Ultralight tag - Block 4 (byte 0, byte 1) */ 183 #define T2T_MIFARE_ULTRALIGHT_FAMILY_VER_NO 0x0200 /* Blank Ultralight family tag - Block 4 (byte 0, byte 1) */ 184 185 /* Infineon my-d move / my-d blank tag uid block settings */ 186 #define T2T_INFINEON_VERSION_BLOCK 0x00 187 #define T2T_INFINEON_MYD_MOVE_LEAN 0x0570 188 #define T2T_INFINEON_MYD_MOVE 0x0530 189 190 #define T2T_BRCM_VERSION_BLOCK 0x00 191 #define T2T_BRCM_STATIC_MEM 0x2E01 192 #define T2T_BRCM_DYNAMIC_MEM 0x2E02 193 194 #define T2T_NDEF_NOT_DETECTED 0x00 195 #define T2T_NDEF_DETECTED 0x01 196 #define T2T_NDEF_READ 0x02 197 198 #define T2T_MAX_NDEF_OFFSET 128 /* Max offset of an NDEF message in a T2 tag */ 199 #define T2T_MAX_RESERVED_BYTES_IN_TAG 0x64 200 #define T2T_MAX_LOCK_BYTES_IN_TAG 0x64 201 202 #define RW_T2T_MAX_MEM_TLVS 0x05 /* Maximum supported Memory control TLVS in the tag */ 203 #define RW_T2T_MAX_LOCK_TLVS 0x05 /* Maximum supported Lock control TLVS in the tag */ 204 #define RW_T2T_MAX_LOCK_BYTES 0x1E /* Maximum supported dynamic lock bytes */ 205 #define RW_T2T_SEGMENT_BYTES 128 206 #define RW_T2T_SEGMENT_SIZE 16 207 208 #define RW_T2T_LOCK_NOT_UPDATED 0x00 /* Lock not yet set as part of SET TAG RO op */ 209 #define RW_T2T_LOCK_UPDATE_INITIATED 0x01 /* Sent command to set the Lock bytes */ 210 #define RW_T2T_LOCK_UPDATED 0x02 /* Lock bytes are set */ 211 typedef UINT8 tRW_T2T_LOCK_STATUS; 212 213 214 /* States */ 215 #define RW_T2T_STATE_NOT_ACTIVATED 0x00 /* Tag not activated */ 216 #define RW_T2T_STATE_IDLE 0x01 /* T1 Tag activated and ready to perform rw operation on Tag*/ 217 #define RW_T2T_STATE_READ 0x02 /* waiting response for read command sent to tag */ 218 #define RW_T2T_STATE_WRITE 0x03 /* waiting response for write command sent to tag */ 219 #define RW_T2T_STATE_SELECT_SECTOR 0x04 /* Waiting response for sector select command */ 220 #define RW_T2T_STATE_DETECT_TLV 0x05 /* Detecting Lock/Memory/NDEF/Proprietary TLV in the Tag */ 221 #define RW_T2T_STATE_READ_NDEF 0x06 /* Performing NDEF Read procedure */ 222 #define RW_T2T_STATE_WRITE_NDEF 0x07 /* Performing NDEF Write procedure */ 223 #define RW_T2T_STATE_SET_TAG_RO 0x08 /* Setting Tag as Read only tag */ 224 #define RW_T2T_STATE_CHECK_PRESENCE 0x09 /* Check if Tag is still present */ 225 #define RW_T2T_STATE_FORMAT_TAG 0x0A /* Format the tag */ 226 #define RW_T2T_STATE_HALT 0x0B /* Tag is in HALT State */ 227 228 /* rw_t2t_read/rw_t2t_write takes care of sector change if the block to read/write is in a different sector 229 * Next Substate should be assigned to control variable 'substate' before calling these function for State Machine to 230 * move back to the particular substate after Sector change is completed and read/write command is sent on new sector */ 231 232 /* Sub states */ 233 #define RW_T2T_SUBSTATE_NONE 0x00 234 235 /* Sub states in RW_T2T_STATE_SELECT_SECTOR state */ 236 #define RW_T2T_SUBSTATE_WAIT_SELECT_SECTOR_SUPPORT 0x01 /* waiting for response of sector select CMD 1 */ 237 #define RW_T2T_SUBSTATE_WAIT_SELECT_SECTOR 0x02 /* waiting for response of sector select CMD 2 */ 238 239 /* Sub states in RW_T1T_STATE_DETECT_XXX state */ 240 #define RW_T2T_SUBSTATE_WAIT_READ_CC 0x03 /* waiting for the detection of a tlv in a tag */ 241 #define RW_T2T_SUBSTATE_WAIT_TLV_DETECT 0x04 /* waiting for the detection of a tlv in a tag */ 242 #define RW_T2T_SUBSTATE_WAIT_FIND_LEN_FIELD_LEN 0x05 /* waiting for finding the len field is 1 or 3 bytes long */ 243 #define RW_T2T_SUBSTATE_WAIT_READ_TLV_LEN0 0x06 /* waiting for extracting len field value */ 244 #define RW_T2T_SUBSTATE_WAIT_READ_TLV_LEN1 0x07 /* waiting for extracting len field value */ 245 #define RW_T2T_SUBSTATE_WAIT_READ_TLV_VALUE 0x08 /* waiting for extracting value field in the TLV */ 246 #define RW_T2T_SUBSTATE_WAIT_READ_LOCKS 0x09 /* waiting for reading dynamic locks in the TLV */ 247 248 /* Sub states in RW_T2T_STATE_WRITE_NDEF state */ 249 #define RW_T2T_SUBSTATE_WAIT_READ_NDEF_FIRST_BLOCK 0x0A /* waiting for rsp to reading the block where NDEF starts */ 250 #define RW_T2T_SUBSTATE_WAIT_READ_NDEF_LAST_BLOCK 0x0B /* waiting for rsp to reading block where new NDEF Msg ends */ 251 #define RW_T2T_SUBSTATE_WAIT_READ_TERM_TLV_BLOCK 0x0C /* waiting for rsp to reading block where Trm tlv gets added*/ 252 #define RW_T2T_SUBSTATE_WAIT_READ_NDEF_NEXT_BLOCK 0x0D /* waiting for rsp to reading block where nxt NDEF write */ 253 #define RW_T2T_SUBSTATE_WAIT_WRITE_NDEF_NEXT_BLOCK 0x0E /* waiting for rsp to writting NDEF block */ 254 #define RW_T2T_SUBSTATE_WAIT_WRITE_NDEF_LAST_BLOCK 0x0F /* waiting for rsp to last NDEF block write cmd */ 255 #define RW_T2T_SUBSTATE_WAIT_READ_NDEF_LEN_BLOCK 0x10 /* waiting for rsp to reading NDEF len field block */ 256 #define RW_T2T_SUBSTATE_WAIT_WRITE_NDEF_LEN_BLOCK 0x11 /* waiting for rsp of updating first NDEF len field block */ 257 #define RW_T2T_SUBSTATE_WAIT_WRITE_NDEF_LEN_NEXT_BLOCK 0x12 /* waiting for rsp of updating next NDEF len field block */ 258 #define RW_T2T_SUBSTATE_WAIT_WRITE_TERM_TLV_CMPLT 0x13 /* waiting for rsp to writing to Terminator tlv */ 259 260 /* Sub states in RW_T2T_STATE_FORMAT_TAG state */ 261 #define RW_T2T_SUBSTATE_WAIT_READ_VERSION_INFO 0x14 262 #define RW_T2T_SUBSTATE_WAIT_SET_CC 0x15 /* waiting for response to format/set capability container */ 263 #define RW_T2T_SUBSTATE_WAIT_SET_LOCK_TLV 0x16 264 #define RW_T2T_SUBSTATE_WAIT_SET_NULL_NDEF 0x17 /* waiting for response to format/set NULL NDEF */ 265 266 /* Sub states in RW_T2T_STATE_SET_TAG_RO state */ 267 #define RW_T2T_SUBSTATE_WAIT_SET_CC_RO 0x19 /* waiting for response to set CC3 to RO */ 268 #define RW_T2T_SUBSTATE_WAIT_READ_DYN_LOCK_BYTE_BLOCK 0x1A /* waiting for response to read dynamic lock bytes block */ 269 #define RW_T2T_SUBSTATE_WAIT_SET_DYN_LOCK_BITS 0x1B /* waiting for response to set dynamic lock bits */ 270 #define RW_T2T_SUBSTATE_WAIT_SET_ST_LOCK_BITS 0x1C /* waiting for response to set static lock bits */ 271 272 typedef struct 273 { 274 UINT16 offset; /* Offset of the lock byte in the Tag */ 275 UINT8 num_bits; /* Number of lock bits in the lock byte */ 276 UINT8 bytes_locked_per_bit; /* No. of tag bytes gets locked by a bit in this byte */ 277 } tRW_T2T_LOCK_INFO; 278 279 typedef struct 280 { 281 UINT16 offset; /* Reserved bytes offset taken from Memory control TLV */ 282 UINT8 num_bytes; /* Number of reserved bytes as per the TLV */ 283 }tRW_T2T_RES_INFO; 284 285 typedef struct 286 { 287 UINT8 tlv_index; /* Index of Lock control tlv that points to this address */ 288 UINT8 byte_index; /* Index of Lock byte pointed by the TLV */ 289 UINT8 lock_byte; /* Value in the lock byte */ 290 tRW_T2T_LOCK_STATUS lock_status; /* Indicates if it is modifed to set tag as Read only */ 291 BOOLEAN b_lock_read; /* Is the lock byte is already read from tag */ 292 } tRW_T2T_LOCK; 293 294 /* RW Type 2 Tag control block */ 295 typedef struct 296 { 297 UINT8 state; /* Reader/writer state */ 298 UINT8 substate; /* Reader/write substate in NDEF write state */ 299 UINT8 prev_substate; /* Substate of the tag before moving to different sector */ 300 UINT8 sector; /* Sector number that is selected */ 301 UINT8 select_sector; /* Sector number that is expected to get selected */ 302 UINT8 tag_hdr[T2T_READ_DATA_LEN]; /* T2T Header blocks */ 303 UINT8 tag_data[T2T_READ_DATA_LEN]; /* T2T Block 4 - 7 data */ 304 UINT8 ndef_status; /* The current status of NDEF Write operation */ 305 UINT16 block_read; /* Read block */ 306 UINT16 block_written; /* Written block */ 307 tT2T_CMD_RSP_INFO *p_cmd_rsp_info; /* Pointer to Command rsp info of last sent command */ 308 BT_HDR *p_cur_cmd_buf; /* Copy of current command, for retx/send after sector change */ 309 BT_HDR *p_sec_cmd_buf; /* Copy of command, to send after sector change */ 310 TIMER_LIST_ENT t2_timer; /* timeout for each API call */ 311 BOOLEAN b_read_hdr; /* Tag header read from tag */ 312 BOOLEAN b_read_data; /* Tag data block read from tag */ 313 BOOLEAN b_hard_lock; /* Hard lock the tag as part of config tag to Read only */ 314 BOOLEAN check_tag_halt; /* Resent command after NACK rsp to find tag is in HALT State */ 315 #if (defined (RW_NDEF_INCLUDED) && (RW_NDEF_INCLUDED == TRUE)) 316 BOOLEAN skip_dyn_locks; /* Skip reading dynamic lock bytes from the tag */ 317 UINT8 found_tlv; /* The Tlv found while searching a particular TLV */ 318 UINT8 tlv_detect; /* TLV type under detection */ 319 UINT8 num_lock_tlvs; /* Number of lcok tlvs detected in the tag */ 320 UINT8 attr_seg; /* Tag segment for which attributes are prepared */ 321 UINT8 lock_attr_seg; /* Tag segment for which lock attributes are prepared */ 322 UINT8 segment; /* Current operating segment */ 323 UINT8 ndef_final_block[T2T_BLOCK_SIZE]; /* Buffer for ndef last block */ 324 UINT8 num_mem_tlvs; /* Number of memory tlvs detected in the tag */ 325 UINT8 num_lockbytes; /* Number of dynamic lock bytes present in the tag */ 326 UINT8 attr[RW_T2T_SEGMENT_SIZE]; /* byte information - Reserved/lock/otp or data */ 327 UINT8 lock_attr[RW_T2T_SEGMENT_SIZE]; /* byte information - read only or read write */ 328 UINT8 tlv_value[3]; /* Read value field of TLV */ 329 UINT8 ndef_first_block[T2T_BLOCK_LEN]; /* NDEF TLV Header block */ 330 UINT8 ndef_read_block[T2T_BLOCK_LEN]; /* Buffer to hold read before write block */ 331 UINT8 ndef_last_block[T2T_BLOCK_LEN]; /* Terminator TLV block after NDEF Write operation */ 332 UINT8 terminator_tlv_block[T2T_BLOCK_LEN];/* Terminator TLV Block */ 333 UINT16 ndef_last_block_num; /* Block where last byte of updating ndef message will exist */ 334 UINT16 ndef_read_block_num; /* Block read during NDEF Write to avoid overwritting res bytes */ 335 UINT16 bytes_count; /* No. of bytes remaining to collect during tlv detect */ 336 UINT16 terminator_byte_index; /* The offset of the tag where terminator tlv may be added */ 337 UINT16 work_offset; /* Working byte offset */ 338 UINT16 ndef_header_offset; 339 UINT16 ndef_msg_offset; /* Offset on Tag where first NDEF message is present */ 340 UINT16 ndef_msg_len; /* Lenght of NDEF Message */ 341 UINT16 max_ndef_msg_len; /* Maximum size of NDEF that can be written on the tag */ 342 UINT16 new_ndef_msg_len; /* Lenght of new updating NDEF Message */ 343 UINT16 ndef_write_block; 344 UINT16 prop_msg_len; /* Proprietary tlv length */ 345 UINT8 *p_new_ndef_buffer; /* Pointer to updating NDEF Message */ 346 UINT8 *p_ndef_buffer; /* Pointer to NDEF Message */ 347 tRW_T2T_LOCK_INFO lock_tlv[RW_T2T_MAX_LOCK_TLVS]; /* Information retrieved from lock control tlv */ 348 tRW_T2T_LOCK lockbyte[RW_T2T_MAX_LOCK_BYTES]; /* Dynamic Lock byte information */ 349 tRW_T2T_RES_INFO mem_tlv[RW_T2T_MAX_MEM_TLVS]; /* Information retrieved from mem tlv */ 350 #endif 351 } tRW_T2T_CB; 352 353 /* Type 3 Tag control block */ 354 typedef UINT8 tRW_T3T_RW_STATE; 355 356 typedef struct 357 { 358 tNFC_STATUS status; 359 UINT8 version; /* Ver: peer version */ 360 UINT8 nbr; /* NBr: number of blocks that can be read using one Check command */ 361 UINT8 nbw; /* Nbw: number of blocks that can be written using one Update command */ 362 UINT16 nmaxb; /* Nmaxb: maximum number of blocks available for NDEF data */ 363 UINT8 writef; /* WriteFlag: 00h if writing data finished; 0Fh if writing data in progress */ 364 UINT8 rwflag; /* RWFlag: 00h NDEF is read-only; 01h if read/write available */ 365 UINT32 ln; /* Ln: actual size of stored NDEF data (in bytes) */ 366 } tRW_T3T_DETECT; 367 368 /* RW_T3T control block flags */ 369 #define RW_T3T_FL_IS_FINAL_NDEF_SEGMENT 0x01 /* The final command for completing the NDEF read/write */ 370 #define RW_T3T_FL_W4_PRESENCE_CHECK_POLL_RSP 0x02 /* Waiting for POLL response for presence check */ 371 #define RW_T3T_FL_W4_GET_SC_POLL_RSP 0x04 /* Waiting for POLL response for RW_T3tGetSystemCodes */ 372 #define RW_T3T_FL_W4_NDEF_DETECT_POLL_RSP 0x08 /* Waiting for POLL response for RW_T3tDetectNDef */ 373 #define RW_T3T_FL_W4_FMT_FELICA_LITE_POLL_RSP 0x10 /* Waiting for POLL response for RW_T3tFormat */ 374 #define RW_T3T_FL_W4_SRO_FELICA_LITE_POLL_RSP 0x20 /* Waiting for POLL response for RW_T3tSetReadOnly */ 375 376 typedef struct 377 { 378 UINT32 cur_tout; /* Current command timeout */ 379 /* check timeout is check_tout_a + n * check_tout_b; X is T/t3t * 4^E */ 380 UINT32 check_tout_a; /* Check command timeout (A+1)*X */ 381 UINT32 check_tout_b; /* Check command timeout (B+1)*X */ 382 /* update timeout is update_tout_a + n * update_tout_b; X is T/t3t * 4^E */ 383 UINT32 update_tout_a; /* Update command timeout (A+1)*X */ 384 UINT32 update_tout_b; /* Update command timeout (B+1)*X */ 385 tRW_T3T_RW_STATE rw_state; /* Reader/writer state */ 386 UINT8 rw_substate; 387 UINT8 cur_cmd; /* Current command being executed */ 388 BT_HDR *p_cur_cmd_buf; /* Copy of current command, for retransmission */ 389 TIMER_LIST_ENT timer; /* timeout for waiting for response */ 390 TIMER_LIST_ENT poll_timer; /* timeout for waiting for response */ 391 392 tRW_T3T_DETECT ndef_attrib; /* T3T NDEF attribute information */ 393 394 UINT32 ndef_msg_len; /* Length of ndef message to send */ 395 UINT32 ndef_msg_bytes_sent; /* Length of ndef message sent so far */ 396 UINT8 *ndef_msg; /* Buffer for outgoing NDEF message */ 397 UINT32 ndef_rx_readlen; /* Number of bytes read in current CHECK command */ 398 UINT32 ndef_rx_offset; /* Length of ndef message read so far */ 399 400 UINT8 num_system_codes; /* System codes detected */ 401 UINT16 system_codes[T3T_MAX_SYSTEM_CODES]; 402 403 UINT8 peer_nfcid2[NCI_NFCID2_LEN]; 404 UINT8 cur_poll_rc; /* RC used in current POLL command */ 405 406 UINT8 flags; /* Flags see RW_T3T_FL_* */ 407 } tRW_T3T_CB; 408 409 410 /* 411 ** Type 4 Tag 412 */ 413 414 /* Max data size using a single ReadBinary. 2 bytes are for status bytes */ 415 #define RW_T4T_MAX_DATA_PER_READ (NFC_RW_POOL_BUF_SIZE - BT_HDR_SIZE - NCI_DATA_HDR_SIZE - T4T_RSP_STATUS_WORDS_SIZE) 416 417 /* Max data size using a single UpdateBinary. 6 bytes are for CLA, INS, P1, P2, Lc */ 418 #define RW_T4T_MAX_DATA_PER_WRITE (NFC_RW_POOL_BUF_SIZE - BT_HDR_SIZE - NCI_MSG_OFFSET_SIZE - NCI_DATA_HDR_SIZE - T4T_CMD_MAX_HDR_SIZE) 419 420 421 422 /* Mandatory NDEF file control */ 423 typedef struct 424 { 425 UINT16 file_id; /* File Identifier */ 426 UINT16 max_file_size; /* Max NDEF file size */ 427 UINT8 read_access; /* read access condition */ 428 UINT8 write_access; /* write access condition */ 429 } tRW_T4T_NDEF_FC; 430 431 /* Capability Container */ 432 typedef struct 433 { 434 UINT16 cclen; /* the size of this capability container */ 435 UINT8 version; /* the mapping specification version */ 436 UINT16 max_le; /* the max data size by a single ReadBinary */ 437 UINT16 max_lc; /* the max data size by a single UpdateBinary */ 438 tRW_T4T_NDEF_FC ndef_fc; /* Mandatory NDEF file control */ 439 } tRW_T4T_CC; 440 441 typedef UINT8 tRW_T4T_RW_STATE; 442 typedef UINT8 tRW_T4T_RW_SUBSTATE; 443 444 /* Type 4 Tag Control Block */ 445 typedef struct 446 { 447 tRW_T4T_RW_STATE state; /* main state */ 448 tRW_T4T_RW_SUBSTATE sub_state; /* sub state */ 449 UINT8 version; /* currently effective version */ 450 TIMER_LIST_ENT timer; /* timeout for each API call */ 451 452 UINT16 ndef_length; /* length of NDEF data */ 453 UINT8 *p_update_data; /* pointer of data to update */ 454 UINT16 rw_length; /* remaining bytes to read/write */ 455 UINT16 rw_offset; /* remaining offset to read/write */ 456 BT_HDR *p_data_to_free; /* GKI buffet to delete after done */ 457 458 tRW_T4T_CC cc_file; /* Capability Container File */ 459 460 #define RW_T4T_NDEF_STATUS_NDEF_DETECTED 0x01 /* NDEF has been detected */ 461 #define RW_T4T_NDEF_STATUS_NDEF_READ_ONLY 0x02 /* NDEF file is read-only */ 462 463 UINT8 ndef_status; /* bitmap for NDEF status */ 464 UINT8 channel; /* channel id: used for read-binary */ 465 466 UINT16 max_read_size; /* max reading size per a command */ 467 UINT16 max_update_size; /* max updating size per a command */ 468 UINT16 card_size; 469 UINT8 card_type; 470 } tRW_T4T_CB; 471 472 /* RW retransmission statistics */ 473 #if (defined (RW_STATS_INCLUDED) && (RW_STATS_INCLUDED == TRUE)) 474 typedef struct 475 { 476 UINT32 start_tick; /* System tick count at activation */ 477 UINT32 bytes_sent; /* Total bytes sent since activation */ 478 UINT32 bytes_received; /* Total bytes received since activation */ 479 UINT32 num_ops; /* Number of operations since activation */ 480 UINT32 num_retries; /* Number of retranmissions since activation */ 481 UINT32 num_crc; /* Number of crc failures */ 482 UINT32 num_trans_err; /* Number of transmission error notifications */ 483 UINT32 num_fail; /* Number of aborts (failures after retries) */ 484 } tRW_STATS; 485 #endif /* RW_STATS_INCLUDED */ 486 487 /* ISO 15693 RW Control Block */ 488 typedef UINT8 tRW_I93_RW_STATE; 489 typedef UINT8 tRW_I93_RW_SUBSTATE; 490 491 #define RW_I93_FLAG_READ_ONLY 0x01 /* tag is read-only */ 492 #define RW_I93_FLAG_READ_MULTI_BLOCK 0x02 /* tag supports read multi block */ 493 #define RW_I93_FLAG_RESET_DSFID 0x04 /* need to reset DSFID for formatting */ 494 #define RW_I93_FLAG_RESET_AFI 0x08 /* need to reset AFI for formatting */ 495 #define RW_I93_FLAG_16BIT_NUM_BLOCK 0x10 /* use 2 bytes for number of blocks */ 496 497 #define RW_I93_TLV_DETECT_STATE_TYPE 0x01 /* searching for type */ 498 #define RW_I93_TLV_DETECT_STATE_LENGTH_1 0x02 /* searching for the first byte of length */ 499 #define RW_I93_TLV_DETECT_STATE_LENGTH_2 0x03 /* searching for the second byte of length */ 500 #define RW_I93_TLV_DETECT_STATE_LENGTH_3 0x04 /* searching for the third byte of length */ 501 #define RW_I93_TLV_DETECT_STATE_VALUE 0x05 /* reading value field */ 502 503 enum 504 { 505 RW_I93_ICODE_SLI, /* ICODE SLI, SLIX */ 506 RW_I93_ICODE_SLI_S, /* ICODE SLI-S, SLIX-S */ 507 RW_I93_ICODE_SLI_L, /* ICODE SLI-L, SLIX-L */ 508 RW_I93_TAG_IT_HF_I_PLUS_INLAY, /* Tag-it HF-I Plus Inlay */ 509 RW_I93_TAG_IT_HF_I_PLUS_CHIP, /* Tag-it HF-I Plus Chip */ 510 RW_I93_TAG_IT_HF_I_STD_CHIP_INLAY, /* Tag-it HF-I Standard Chip/Inlyas */ 511 RW_I93_TAG_IT_HF_I_PRO_CHIP_INLAY, /* Tag-it HF-I Pro Chip/Inlyas */ 512 RW_I93_STM_LRI1K, /* STM LRI1K */ 513 RW_I93_STM_LRI2K, /* STM LRI2K */ 514 RW_I93_STM_LRIS2K, /* STM LRIS2K */ 515 RW_I93_STM_LRIS64K, /* STM LRIS64K */ 516 RW_I93_STM_M24LR64_R, /* STM M24LR64-R */ 517 RW_I93_STM_M24LR04E_R, /* STM M24LR04E-R */ 518 RW_I93_STM_M24LR16E_R, /* STM M24LR16E-R */ 519 RW_I93_STM_M24LR64E_R, /* STM M24LR64E-R */ 520 RW_I93_UNKNOWN_PRODUCT /* Unknwon product version */ 521 }; 522 523 typedef struct 524 { 525 tRW_I93_RW_STATE state; /* main state */ 526 tRW_I93_RW_SUBSTATE sub_state; /* sub state */ 527 TIMER_LIST_ENT timer; /* timeout for each sent command */ 528 UINT8 sent_cmd; /* last sent command */ 529 UINT8 retry_count; /* number of retry */ 530 BT_HDR *p_retry_cmd; /* buffer to store cmd sent last */ 531 532 UINT8 info_flags; /* information flags */ 533 UINT8 uid[I93_UID_BYTE_LEN]; /* UID of currently activated */ 534 UINT8 dsfid; /* DSFID if I93_INFO_FLAG_DSFID */ 535 UINT8 afi; /* AFI if I93_INFO_FLAG_AFI */ 536 UINT8 block_size; /* block size of tag, in bytes */ 537 UINT16 num_block; /* number of blocks in tag */ 538 UINT8 ic_reference; /* IC Reference of tag */ 539 UINT8 product_version; /* tag product version */ 540 541 UINT8 intl_flags; /* flags for internal information */ 542 543 UINT8 tlv_detect_state; /* TLV detecting state */ 544 UINT8 tlv_type; /* currently detected type */ 545 UINT16 tlv_length; /* currently detected length */ 546 547 UINT16 ndef_tlv_start_offset; /* offset of first byte of NDEF TLV */ 548 UINT16 ndef_tlv_last_offset; /* offset of last byte of NDEF TLV */ 549 UINT16 max_ndef_length; /* max NDEF length the tag contains */ 550 UINT16 ndef_length; /* length of NDEF data */ 551 552 UINT8 *p_update_data; /* pointer of data to update */ 553 UINT16 rw_length; /* bytes to read/write */ 554 UINT16 rw_offset; /* offset to read/write */ 555 } tRW_I93_CB; 556 557 /* RW memory control blocks */ 558 typedef union 559 { 560 tRW_T1T_CB t1t; 561 tRW_T2T_CB t2t; 562 tRW_T3T_CB t3t; 563 tRW_T4T_CB t4t; 564 tRW_I93_CB i93; 565 } tRW_TCB; 566 567 /* RW control blocks */ 568 typedef struct 569 { 570 tRW_TCB tcb; 571 tRW_CBACK *p_cback; 572 UINT32 cur_retry; /* Retry count for the current operation */ 573 #if (defined (RW_STATS_INCLUDED) && (RW_STATS_INCLUDED == TRUE)) 574 tRW_STATS stats; 575 #endif /* RW_STATS_INCLUDED */ 576 UINT8 trace_level; 577 } tRW_CB; 578 579 580 /***************************************************************************** 581 ** EXTERNAL FUNCTION DECLARATIONS 582 *****************************************************************************/ 583 584 #ifdef __cplusplus 585 extern "C" { 586 #endif 587 588 /* Global NFC data */ 589 #if NFC_DYNAMIC_MEMORY == FALSE 590 NFC_API extern tRW_CB rw_cb; 591 #else 592 NFC_API extern tRW_CB *rw_cb_ptr; 593 #define rw_cb (*rw_cb_ptr) 594 #endif 595 596 /* from .c */ 597 598 #if (defined (RW_NDEF_INCLUDED) && (RW_NDEF_INCLUDED == TRUE)) 599 extern tRW_EVENT rw_t1t_handle_rsp (const tT1T_CMD_RSP_INFO * p_info, BOOLEAN *p_notify, UINT8 *p_data, tNFC_STATUS *p_status); 600 extern tRW_EVENT rw_t1t_info_to_event (const tT1T_CMD_RSP_INFO * p_info); 601 #else 602 #define rw_t1t_handle_rsp(p, a, b, c) t1t_info_to_evt (p) 603 #define rw_t1t_info_to_event(p) t1t_info_to_evt (p) 604 #endif 605 606 extern void rw_init (void); 607 extern tNFC_STATUS rw_t1t_select (UINT8 hr[T1T_HR_LEN], UINT8 uid[T1T_CMD_UID_LEN]); 608 extern tNFC_STATUS rw_t1t_send_dyn_cmd (UINT8 opcode, UINT8 add, UINT8 *p_dat); 609 extern tNFC_STATUS rw_t1t_send_static_cmd (UINT8 opcode, UINT8 add, UINT8 dat); 610 extern void rw_t1t_process_timeout (TIMER_LIST_ENT *p_tle); 611 extern void rw_t1t_handle_op_complete (void); 612 613 #if (defined (RW_NDEF_INCLUDED) && (RW_NDEF_INCLUDED == TRUE)) 614 extern tRW_EVENT rw_t2t_info_to_event (const tT2T_CMD_RSP_INFO *p_info); 615 extern void rw_t2t_handle_rsp (UINT8 *p_data); 616 #else 617 #define rw_t2t_info_to_event(p) t2t_info_to_evt (p) 618 #define rw_t2t_handle_rsp(p) 619 #endif 620 621 extern tNFC_STATUS rw_t2t_sector_change (UINT8 sector); 622 extern tNFC_STATUS rw_t2t_read (UINT16 block); 623 extern tNFC_STATUS rw_t2t_write (UINT16 block, UINT8 *p_write_data); 624 extern void rw_t2t_process_timeout (TIMER_LIST_ENT *p_tle); 625 extern tNFC_STATUS rw_t2t_select (void); 626 void rw_t2t_handle_op_complete (void); 627 628 extern void rw_t3t_process_timeout (TIMER_LIST_ENT *p_tle); 629 extern tNFC_STATUS rw_t3t_select (UINT8 peer_nfcid2[NCI_RF_F_UID_LEN], UINT8 mrti_check, UINT8 mrti_update); 630 void rw_t3t_handle_nci_poll_ntf (UINT8 nci_status, UINT8 num_responses, UINT8 sensf_res_buf_size, UINT8 *p_sensf_res_buf); 631 632 extern tNFC_STATUS rw_t4t_select (void); 633 extern void rw_t4t_process_timeout (TIMER_LIST_ENT *p_tle); 634 635 extern tNFC_STATUS rw_i93_select (UINT8 *p_uid); 636 extern void rw_i93_process_timeout (TIMER_LIST_ENT *p_tle); 637 638 #if (defined (RW_STATS_INCLUDED) && (RW_STATS_INCLUDED == TRUE)) 639 /* Internal fcns for statistics (from rw_main.c) */ 640 void rw_main_reset_stats (void); 641 void rw_main_update_tx_stats (UINT32 bytes_tx, BOOLEAN is_retry); 642 void rw_main_update_rx_stats (UINT32 bytes_rx); 643 void rw_main_update_crc_error_stats (void); 644 void rw_main_update_trans_error_stats (void); 645 void rw_main_update_fail_stats (void); 646 void rw_main_log_stats (void); 647 #endif /* RW_STATS_INCLUDED */ 648 649 #ifdef __cplusplus 650 } 651 #endif 652 653 #endif /* RW_INT_H_ */ 654