Go to the documentation of this file.
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_spi_master.h"
59 #define NFC3_CMD_WRITE_REGISTER 0x00
60 #define NFC3_CMD_WRITE_REGISTER_OR_MASK 0x01
61 #define NFC3_CMD_WRITE_REGISTER_AND_MASK 0x02
62 #define NFC3_CMD_WRITE_REGISTER_MULTIPLE 0x03
63 #define NFC3_CMD_READ_REGISTER 0x04
64 #define NFC3_CMD_READ_REGISTER_MULTIPLE 0x05
65 #define NFC3_CMD_WRITE_EEPROM 0x06
66 #define NFC3_CMD_READ_EEPROM 0x07
67 #define NFC3_CMD_WRITE_TX_DATA 0x08
68 #define NFC3_CMD_SEND_DATA 0x09
69 #define NFC3_CMD_READ_DATA 0x0A
70 #define NFC3_CMD_SWITCH_MODE 0x0B
71 #define NFC3_CMD_MIFARE_AUTHENTICATE 0x0C
72 #define NFC3_CMD_EPC_INVENTORY 0x0D
73 #define NFC3_CMD_EPC_RESUME_INVENTORY 0x0E
74 #define NFC3_CMD_EPC_RETRIEVE_INVENTORY_RESULT_SIZE 0x0F
75 #define NFC3_CMD_EPC_RETRIEVE_INVENTORY_RESULT 0x10
76 #define NFC3_CMD_LOAD_RF_CONFIG 0x11
77 #define NFC3_CMD_UPDATE_RF_CONFIG 0x12
78 #define NFC3_CMD_RETRIEVE_RF_CONFIG_SIZE 0x13
79 #define NFC3_CMD_RETRIEVE_RF_CONFIG 0x14
80 #define NFC3_CMD_RF_ON 0x16
81 #define NFC3_CMD_RF_OFF 0x17
82 #define NFC3_CMD_CONFIGURE_TESTBUS_DIGITAL 0x18
83 #define NFC3_CMD_CONFIGURE_TESTBUS_ANALOG 0x19
103 #define NFC3_REG_SYSTEM_CONFIG 0x00
104 #define NFC3_REG_IRQ_ENABLE 0x01
105 #define NFC3_REG_IRQ_STATUS 0x02
106 #define NFC3_REG_IRQ_CLEAR 0x03
107 #define NFC3_REG_TRANSCEIVER_CONFIG 0x04
108 #define NFC3_REG_PADCONFIG 0x05
109 #define NFC3_REG_PADOUT 0x07
110 #define NFC3_REG_TIMER0_STATUS 0x08
111 #define NFC3_REG_TIMER1_STATUS 0x09
112 #define NFC3_REG_TIMER2_STATUS 0x0A
113 #define NFC3_REG_TIMER0_RELOAD 0x0B
114 #define NFC3_REG_TIMER1_RELOAD 0x0C
115 #define NFC3_REG_TIMER2_RELOAD 0x0D
116 #define NFC3_REG_TIMER0_CONFIG 0x0E
117 #define NFC3_REG_TIMER1_CONFIG 0x0F
118 #define NFC3_REG_TIMER2_CONFIG 0x10
119 #define NFC3_REG_RX_WAIT_CONFIG 0x11
120 #define NFC3_REG_CRC_RX_CONFIG 0x12
121 #define NFC3_REG_RX_STATUS 0x13
122 #define NFC3_REG_TX_UNDERSHOOT_CONFIG 0x14
123 #define NFC3_REG_TX_OVERSHOOT_CONFIG 0x15
124 #define NFC3_REG_TX_DATA_MOD 0x16
125 #define NFC3_REG_TX_WAIT_CONFIG 0x17
126 #define NFC3_REG_TX_CONFIG 0x18
127 #define NFC3_REG_CRC_TX_CONFIG 0x19
128 #define NFC3_REG_SIGPRO_CONFIG 0x1A
129 #define NFC3_REG_SIGPRO_CM_CONFIG 0x1B
130 #define NFC3_REG_SIGPRO_RM_CONFIG 0x1C
131 #define NFC3_REG_RF_STATUS 0x1D
132 #define NFC3_REG_AGC_CONFIG 0x1E
133 #define NFC3_REG_AGC_VALUE 0x1F
134 #define NFC3_REG_RF_CONTROL_TX 0x20
135 #define NFC3_REG_RF_CONTROL_TX_CLK 0x21
136 #define NFC3_REG_RF_CONTROL_RX 0x22
137 #define NFC3_REG_LD_CONTROL 0x23
138 #define NFC3_REG_SYSTEM_STATUS 0x24
139 #define NFC3_REG_TEMP_CONTROL 0x25
140 #define NFC3_REG_CECK_CARD_RESULT 0x26
141 #define NFC3_REG_DPC_CONFIG 0x27
142 #define NFC3_REG_EMD_CONTROL 0x28
143 #define NFC3_REG_ANT_CONTROL 0x29
149 #define NFC3_EEPROM_DIE_ID 0x00
150 #define NFC3_EEPROM_PRODUCT_VERSION 0x10
151 #define NFC3_EEPROM_FIRMWARE_VERSION 0x12
152 #define NFC3_EEPROM_EEPROM_VERSION 0x14
153 #define NFC3_EEPROM_IDLE_IRQ_AFTER_BOOT 0x16
154 #define NFC3_EEPROM_TESTBUS_ENABLE 0x17
155 #define NFC3_EEPROM_XTAL_BOOT_TIME 0x18
156 #define NFC3_EEPROM_IRQ_PIN_CONFIG 0x1A
157 #define NFC3_EEPROM_MISO_PULLUP_ENABLE 0x1B
158 #define NFC3_EEPROM_PLL_DEFAULT_SETTING 0x1C
159 #define NFC3_EEPROM_PLL_DEFAULT_SETTING_ALM 0x24
160 #define NFC3_EEPROM_PLL_LOCK_SETTING 0x2C
161 #define NFC3_EEPROM_CLOCK_CONFIG 0x30
162 #define NFC3_EEPROM_MFC_AUTH_TIMEOUT 0x32
163 #define NFC3_EEPROM_LPCD_REFERENCE_VALUE 0x34
164 #define NFC3_EEPROM_LPCD_FIELD_ON_TIME 0x36
165 #define NFC3_EEPROM_LPCD_THRESHOLD 0x37
166 #define NFC3_EEPROM_LPCD_REFVAL_GPO_CONTROL 0x38
167 #define NFC3_EEPROM_LPCD_GPO_TOGGLE_BEFORE_FIELD_ON 0x39
168 #define NFC3_EEPROM_LPCD_GPO_TOGGLE_AFTER_FIELD_OFF 0x3A
169 #define NFC3_EEPROM_NFCLD_SENSITIVITY_VAL 0x3B
170 #define NFC3_EEPROM_FIELD_ON_CP_SETTLE_TIME 0x3C
171 #define NFC3_EEPROM_RF_DEBOUNCE_TIMEOUT 0x3F
172 #define NFC3_EEPROM_SENS_RES 0x40
173 #define NFC3_EEPROM_NFCID1 0x42
174 #define NFC3_EEPROM_SEL_RES 0x45
175 #define NFC3_EEPROM_FELICA_POLLING_RESPONSE 0x46
176 #define NFC3_EEPROM_RANDOMUID_ENABLE 0x51
177 #define NFC3_EEPROM_RANDOM_UID_ENABLE 0x58
178 #define NFC3_EEPROM_DPC_CONTROL 0x59
179 #define NFC3_EEPROM_DPC_TIME 0x5A
180 #define NFC3_EEPROM_DPC_XI 0x5C
181 #define NFC3_EEPROM_AGC_CONTROL 0x5D
182 #define NFC3_EEPROM_DPC_THRSH_HIGH 0x5F
183 #define NFC3_EEPROM_DPC_THRSH_LOW 0x7D
184 #define NFC3_EEPROM_DPC_DEBUG 0x7F
185 #define NFC3_EEPROM_DPC_AGC_SHIFT_VALUE 0x80
186 #define NFC3_EEPROM_DPC_AGC_GEAR_LUT_SIZE 0x81
187 #define NFC3_EEPROM_DPC_AGC_GEAR_LUT 0x82
188 #define NFC3_EEPROM_DPC_GUARD_FAST_MODE 0x91
189 #define NFC3_EEPROM_DPC_GUARD_SOF_DETECTED 0x93
190 #define NFC3_EEPROM_DPC_GUARD_FIELD_ON 0x95
191 #define NFC3_EEPROM_PCD_AWC_DRC_LUT_SIZE 0x97
192 #define NFC3_EEPROM_PCD_AWC_DRC_LUT 0x98
193 #define NFC3_EEPROM_MISC_CONFIG 0xE8
194 #define NFC3_EEPROM_DIGIDELAY_A_848_RW 0xE9
195 #define NFC3_EEPROM_DIGIDELAY_B_848_RW 0xEA
196 #define NFC3_EEPROM_DIGIDELAY_F_424_RW 0xEB
197 #define NFC3_EEPROM_DIGIDELAY_15693_RW_FASTHIGH 0xEC
198 #define NFC3_EEPROM_DIGIDELAY_18000_2_848 0xED
199 #define NFC3_EEPROM_DIGIDELAY_18000_4_848 0xEE
200 #define NFC3_EEPROM_TESTBUSMODE 0xF0
201 #define NFC3_EEPROM_TBSELECT 0xF1
202 #define NFC3_EEPROM_MAPTB1_TO_TB0 0xF2
203 #define NFC3_EEPROM_NUMPADSIGNALMAPS 0xF3
204 #define NFC3_EEPROM_PADSIGNALMAP 0xF4
205 #define NFC3_EEPROM_TBDAC1 0xF5
206 #define NFC3_EEPROM_TBDAC2 0xF6
224 #define NFC3_RX_IRQ_STAT (1<<0) // End of RF rececption IRQ
225 #define NFC3_TX_IRQ_STAT (1<<1) // End of RF transmission IRQ
226 #define NFC3_IDLE_IRQ_STAT (1<<2) // IDLE IRQ
227 #define NFC3_RFOFF_DET_IRQ_STAT (1<<6) // RF Field OFF detection IRQ
228 #define NFC3_RFON_DET_IRQ_STAT (1<<7) // RF Field ON detection IRQ
229 #define NFC3_TX_RFOFF_IRQ_STAT (1<<8) // RF Field OFF in PCD IRQ
230 #define NFC3_TX_RFON_IRQ_STAT (1<<9) // RF Field ON in PCD IRQ
231 #define NFC3_RX_SOF_DET_IRQ_STAT (1<<14) // RF SOF Detection IRQ
232 #define NFC3_GENERAL_ERROR_IRQ_STAT (1ul<<17) // General error IRQ
233 #define NFC3_LPCD_IRQ_STAT (1ul<<19) // LPCD Detection IRQ
250 #define NFC3_MAP_MIKROBUS( cfg, mikrobus ) \
251 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
252 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
253 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
254 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
255 cfg.aux = MIKROBUS( mikrobus, MIKROBUS_AN ); \
256 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
257 cfg.bsy = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
258 cfg.irq = MIKROBUS( mikrobus, MIKROBUS_INT )
uint8_t nfc3_read_card_uid(nfc3_t *ctx, uint8_t *data_out)
NFC 3 read card UID function.
digital_in_t aux
Definition: nfc3.h:275
err_t nfc3_mifare_block_read(nfc3_t *ctx, uint8_t *data_out, uint8_t blockno)
NFC 3 MIFARE block read function.
void nfc3_cfg_setup(nfc3_cfg_t *cfg)
NFC 3 configuration object setup function.
err_t nfc3_write_eeprom(nfc3_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
NFC 3 writing EEPROM function.
@ NFC3_TS_RECEIVING
Definition: nfc3.h:337
NFC 3 Click configuration object.
Definition: nfc3.h:292
err_t nfc3_read_reg(nfc3_t *ctx, uint8_t reg, uint32_t *data_out)
NFC 3 reading register function.
nfc3_transceive_stat_t nfc3_get_transceive_state(nfc3_t *ctx)
NFC 3 get TRANSCEIVE_STATE from RF_STATUS register function.
@ NFC3_OK
Definition: nfc3.h:321
pin_name_t sck
Definition: nfc3.h:297
err_t nfc3_generic_transfer(nfc3_t *ctx, uint8_t *data_in, uint8_t tx_len, uint8_t *data_out, uint8_t rx_len)
NFC 3 data reading function.
@ NFC3_TS_TRANSMITTING
Definition: nfc3.h:334
nfc3_transceive_stat_t
NFC 3 Click transceive status value data.
Definition: nfc3.h:331
digital_in_t bsy
Definition: nfc3.h:276
uint8_t nfc3_mifare_block_write_16(nfc3_t *ctx, uint8_t *data_in, uint8_t blockno)
NFC 3 MIFARE block write function.
pin_name_t bsy
Definition: nfc3.h:304
err_t nfc3_init(nfc3_t *ctx, nfc3_cfg_t *cfg)
NFC 3 initialization function.
uint16_t nfc3_rx_num_bytes_received(nfc3_t *ctx)
NFC 3 get number of received bytes function.
err_t nfc3_enable_rx_tx_crc(nfc3_t *ctx)
NFC 3 enable RX and TX CRC calculation function.
err_t nfc3_mifare_halt(nfc3_t *ctx)
NFC 3 MIFARE Halt function.
@ NFC3_TS_WAIT_RECEIVE
Definition: nfc3.h:335
err_t nfc3_write_reg_with_or_mask(nfc3_t *ctx, uint8_t reg, uint32_t data_in)
NFC 3 writing register function with OR mask.
err_t nfc3_read_firmware_version(nfc3_t *ctx, uint16_t *data_out)
NFC 3 reading firmware version function.
@ NFC3_TS_WAIT_TRANSMIT
Definition: nfc3.h:333
digital_out_t rst
Definition: nfc3.h:271
pin_name_t rst
Definition: nfc3.h:303
err_t nfc3_write_reg_with_and_mask(nfc3_t *ctx, uint8_t reg, uint32_t data_in)
NFC 3 writing register function with AND mask.
void nfc3_set_rst(nfc3_t *ctx, uint8_t state)
NFC 3 set RST pin function.
digital_in_t irq
Definition: nfc3.h:277
pin_name_t aux
Definition: nfc3.h:302
uint32_t spi_speed
Definition: nfc3.h:309
pin_name_t mosi
Definition: nfc3.h:296
nfc3_return_value_t
NFC 3 Click return value data.
Definition: nfc3.h:320
NFC 3 Click context object.
Definition: nfc3.h:268
uint8_t nfc3_get_bsy(nfc3_t *ctx)
NFC 3 get BSY pin function.
@ NFC3_TS_WAIT_FOR_DATA
Definition: nfc3.h:336
pin_name_t irq
Definition: nfc3.h:305
spi_master_mode_t spi_mode
Definition: nfc3.h:310
spi_master_chip_select_polarity_t cs_polarity
Definition: nfc3.h:311
uint8_t nfc3_get_aux(nfc3_t *ctx)
NFC 3 get AUX pin function.
spi_master_t spi
Definition: nfc3.h:281
void nfc3_reset(nfc3_t *ctx)
NFC 3 reset function.
uint8_t nfc3_get_irq(nfc3_t *ctx)
NFC 3 get IRQ pin function.
err_t nfc3_read_eeprom(nfc3_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
NFC 3 reading EEPROM function.
err_t nfc3_read_product_version(nfc3_t *ctx, uint16_t *data_out)
NFC 3 reading product version function.
err_t nfc3_send_data(nfc3_t *ctx, uint8_t *data_in, uint16_t len, uint8_t valid_bits)
NFC 3 send data function.
pin_name_t cs
Definition: nfc3.h:298
err_t nfc3_read_data(nfc3_t *ctx, uint8_t *data_out, uint16_t len)
NFC 3 read data function.
@ NFC3_ERROR
Definition: nfc3.h:322
@ NFC3_TS_IDLE
Definition: nfc3.h:332
pin_name_t miso
Definition: nfc3.h:295
err_t nfc3_read_eeprom_version(nfc3_t *ctx, uint16_t *data_out)
NFC 3 reading EEPROM version function.
@ NFC3_TS_RESERVED
Definition: nfc3.h:339
err_t nfc3_load_rf_config(nfc3_t *ctx, uint8_t tx_conf, uint8_t rx_conf)
NFC 3 load RF config function.
err_t nfc3_clear_rx_tx_crc(nfc3_t *ctx)
NFC 3 clear RX and TX CRC function.
uint8_t nfc3_activate_type_a(nfc3_t *ctx, uint8_t *data_out, uint8_t kind)
NFC 3 activate ISO/IEC 14443 type A and read card UID function.
pin_name_t chip_select
Definition: nfc3.h:283
err_t nfc3_write_reg(nfc3_t *ctx, uint8_t reg, uint32_t data_in)
NFC 3 writing register function.
err_t nfc3_generic_write(nfc3_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
NFC 3 data writing function.
@ NFC3_TS_LOOPBACK
Definition: nfc3.h:338